Improve error reporting for invalid cps path query
[cps.git] / cps-rest / src / test / groovy / org / onap / cps / rest / exceptions / CpsRestExceptionHandlerSpec.groovy
index e427c60..89b6b89 100644 (file)
@@ -1,6 +1,8 @@
 /*
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2020 Pantheon.tech
+ *  Copyright (C) 2021 Nordix Foundation
+ *  Modifications Copyright (C) 2021 Bell Canada.
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
 package org.onap.cps.rest.exceptions
 
 import groovy.json.JsonSlurper
+import org.modelmapper.ModelMapper
 import org.onap.cps.api.CpsAdminService
+import org.onap.cps.api.CpsDataService
+import org.onap.cps.api.CpsModuleService
+import org.onap.cps.api.CpsQueryService
+import org.onap.cps.rest.controller.RestControllerSpecification
 import org.onap.cps.spi.exceptions.AnchorAlreadyDefinedException
 import org.onap.cps.spi.exceptions.CpsException
+import org.onap.cps.spi.exceptions.CpsPathException
+import org.onap.cps.spi.exceptions.DataInUseException
 import org.onap.cps.spi.exceptions.DataValidationException
-import org.onap.cps.spi.exceptions.NotFoundInDataspaceException
 import org.onap.cps.spi.exceptions.ModelValidationException
-import org.onap.cps.rest.controller.CpsRestController
+import org.onap.cps.spi.exceptions.NotFoundInDataspaceException
 import org.onap.cps.spi.exceptions.SchemaSetAlreadyDefinedException
+import org.onap.cps.spi.exceptions.SchemaSetInUseException
+import org.spockframework.spring.SpringBean
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
+import org.springframework.test.web.servlet.MockMvc
 import spock.lang.Shared
-import spock.lang.Specification
 import spock.lang.Unroll
 
 import static org.springframework.http.HttpStatus.BAD_REQUEST
+import static org.springframework.http.HttpStatus.CONFLICT
 import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR
 import static org.springframework.http.HttpStatus.NOT_FOUND
+import static org.springframework.http.HttpStatus.UNAUTHORIZED
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
-import static org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup
 
-class CpsRestExceptionHandlerSpec extends Specification {
+@WebMvcTest
+class CpsRestExceptionHandlerSpec extends RestControllerSpecification {
+
+    @SpringBean
+    CpsAdminService mockCpsAdminService = Mock()
+
+    @SpringBean
+    CpsModuleService mockCpsModuleService = Mock()
+
+    @SpringBean
+    CpsDataService mockCpsDataService = Mock()
+
+    @SpringBean
+    CpsQueryService mockCpsQueryService = Mock()
+
+    @SpringBean
+    ModelMapper modelMapper = Mock()
+
+    @Autowired
+    MockMvc mvc
+
+    @Value('${rest.api.cps-base-path}')
+    def basePath
 
     @Shared
     def errorMessage = 'some error message'
@@ -49,14 +85,6 @@ class CpsRestExceptionHandlerSpec extends Specification {
     @Shared
     def existingObjectName = 'MyAdminObject'
 
-    def cpsRestController = new CpsRestController()
-    def mockCpsAdminService = Mock(CpsAdminService.class)
-    def objectUnderTest = new CpsRestExceptionHandler()
-    def mockMvc = standaloneSetup(cpsRestController).setControllerAdvice(objectUnderTest).build()
-
-    def setup() {
-        cpsRestController.cpsAdminService = mockCpsAdminService
-    }
 
     def 'Get request with runtime exception returns HTTP Status Internal Server Error'() {
 
@@ -121,7 +149,42 @@ class CpsRestExceptionHandlerSpec extends Specification {
 
         where: 'the following exceptions are thrown'
             exceptionThrown << [new ModelValidationException(errorMessage, errorDetails, null),
-                                new DataValidationException(errorMessage, errorDetails, null)]
+                                new DataValidationException(errorMessage, errorDetails, null),
+                                new CpsPathException(errorMessage,errorDetails)]
+    }
+
+    @Unroll
+    def 'Delete request with a #exceptionThrown.class.simpleName returns HTTP Status Conflict'() {
+
+        when: 'CPS validation exception is thrown by the service'
+            setupTestException(exceptionThrown)
+            def response = performTestRequest()
+
+        then: 'an HTTP Conflict response is returned with correct message and details'
+            assertTestResponse(response, CONFLICT, exceptionThrown.getMessage(), exceptionThrown.getDetails())
+
+        where: 'the following exceptions are thrown'
+            exceptionThrown << [new DataInUseException(dataspaceName, existingObjectName),
+                                new SchemaSetInUseException(dataspaceName, existingObjectName)]
+    }
+
+    def 'Get request without authentication is not authorized'() {
+        when: 'request is sent without authentication'
+            def response =
+                    mvc.perform(get("$basePath/v1/dataspaces/dataspace-name/anchors")).andReturn().response
+        then: 'HTTP Unauthorized status code is returned'
+            assert UNAUTHORIZED.value() == response.status
+    }
+
+    def 'Get request with invalid authentication is not authorized'() {
+        when: 'request is sent with invalid authentication'
+            def response =
+                    mvc.perform(
+                            get("$basePath/v1/dataspaces/dataspace-name/anchors")
+                                    .header("Authorization", 'Basic invalid auth'))
+                            .andReturn().response
+        then: 'HTTP Unauthorized status code is returned'
+            assert UNAUTHORIZED.value() == response.status
     }
 
     /*
@@ -134,15 +197,18 @@ class CpsRestExceptionHandlerSpec extends Specification {
     }
 
     def performTestRequest() {
-        return mockMvc.perform(get('/v1/dataspaces/dataspace-name/anchors')).andReturn().response
+        return mvc.perform(
+                get("$basePath/v1/dataspaces/dataspace-name/anchors")
+                        .header("Authorization", getAuthorizationHeader()))
+                .andReturn().response
     }
 
-    void assertTestResponse(response, expectedStatus, expectedErrorMessage, expectedErrorDetails) {
+    void assertTestResponse(response, expectedStatus,
+                            expectedErrorMessage, expectedErrorDetails) {
         assert response.status == expectedStatus.value()
         def content = new JsonSlurper().parseText(response.contentAsString)
         assert content['status'] == expectedStatus.toString()
         assert content['message'] == expectedErrorMessage
         assert expectedErrorDetails == null || content['details'] == expectedErrorDetails
     }
-
 }