Fix #19, cleanup of MappingService and controller code, harmonization of responses and their documentation, improved determination of result type and including this into the response to the client, fixed tests according to all changes

Author: ThomasJejkal

.gitignore

@@ -4,6 +4,7 @@
 #!gradle/wrapper/gradle-wrapper.jar
 #!**/src/main/**/build/
 #!**/src/test/**/build/
+lib/
 #
 #### Spring boot ###
 **/application.properties

build.gradle

@@ -36,7 +36,7 @@ repositories {
 ext {
     set('snippetsDir', file('build/generated-snippets'))
     applicationProperties = System.getProperty('applicationProperties', './src/test/resources/test-config/application-test.properties')
-    pythonLocation = System.getProperty('pythonLocation', 'file:///usr/bin/python3')
+    pythonLocation = System.getProperty('pythonLocation', 'file:///c:/python310/python.exe')
 }
 
 dependencies {

src/main/java/edu/kit/datamanager/mappingservice/impl/MappingService.java

@@ -53,16 +53,17 @@ public interface IMappingAdministrationController {
             + "the mapping identifier and mapping type, and the mapping document, which defines the rules for the mapping applied by the given mapping type. ",
             responses = {
                 @ApiResponse(responseCode = "201", description = "CREATED is returned only if the record has been validated, persisted and the mapping document was successfully validated and stored.", content = @Content(schema = @Schema(implementation = MappingRecord.class))),
-                @ApiResponse(responseCode = "400", description = "BAD_REQUEST is returned if the provided mapping record or the mapping document is invalid."),
-                @ApiResponse(responseCode = "409", description = "CONFLICT is returned, if there is already a mapping for the provided mapping id.")})
+                @ApiResponse(responseCode = "400", description = "BAD_REQUEST is returned if the provided mapping record or the mapping document are invalid."),
+                @ApiResponse(responseCode = "409", description = "CONFLICT is returned, if there is already a mapping for the provided mapping id."),
+                @ApiResponse(responseCode = "500", description = "INTERNAL_SERVER_ERROR is returned, an unexpected exception occured while persisting the mapping.")})
 
     @RequestMapping(path = "", method = RequestMethod.POST, consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
     @ResponseBody
     ResponseEntity<MappingRecord> createMapping(
             @Parameter(description = "JSON representation of the mapping record.", required = true) @RequestPart(name = "record") final MultipartFile record,
             @Parameter(description = "The mapping document associated with the record. "
                     + "The format of the document is defined by the mapping type, which is given by the mappingType attribute of the mapping record.", required = true) @RequestPart(name = "document") final MultipartFile document,
-            final HttpServletRequest request,
+            final WebRequest request,
             final HttpServletResponse response,
             final UriComponentsBuilder uriBuilder) throws URISyntaxException;
 
@@ -73,17 +74,17 @@ ResponseEntity<MappingRecord> createMapping(
                 @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned if no record for the provided identifier was found.")})
     @RequestMapping(value = {"/{mappingId}"}, method = {RequestMethod.GET}, produces = {"application/vnd.datamanager.mapping-record+json"})
     @ResponseBody
-    ResponseEntity<MappingRecord> getMappingById(
+    ResponseEntity getMappingById(
             @Parameter(description = "The mapping identifier.", required = true) @PathVariable(value = "mappingId") String mappingId,
-            Pageable pgbl,
             WebRequest wr,
             HttpServletResponse hsr);
 
     @Operation(summary = "Get the mapping document associated with a given mapping identifier.", description = "Obtain a single mapping document identified by the mapping identifier. "
             + "Depending on a user's role, accessing a specific record may be allowed or forbidden. ",
             responses = {
-                @ApiResponse(responseCode = "200", description = "OK and the mapping document are returned if the mapping exists and the user has sufficient permission."),
-                @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned, if no record for the provided identifier was found.")})
+                @ApiResponse(responseCode = "200", description = "OK and the mapping document are returned if the mapping exists and the user has sufficient permission.", content = @Content(schema = @Schema(implementation = MappingRecord.class))),
+                @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned, if no record for the provided identifier was found."),
+                @ApiResponse(responseCode = "500", description = "INTERNAL_SERVER_ERROR is returned, if the mapping document could not be read from the local file system.")})
 
     @RequestMapping(value = {"/{mappingId}"}, method = {RequestMethod.GET})
     @ResponseBody
@@ -110,8 +111,9 @@ ResponseEntity<List<MappingRecord>> getMappings(
     @Operation(summary = "Update a mapping record.", description = "Apply an update to the mapping record and/or the mapping document identified by provided identifier and/or its ",
             responses = {
                 @ApiResponse(responseCode = "200", description = "OK is returned in case of a successful update, e.g. the record (if provided) was in the correct format and the document (if provided) matches the provided schema id. The updated record is returned in the response.", content = @Content(schema = @Schema(implementation = MappingRecord.class))),
-                @ApiResponse(responseCode = "400", description = "BAD_REQUEST is returned if the provided metadata record is invalid or if the validation using the provided schema failed."),
-                @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned if no record for the provided identifier was found.")})
+                @ApiResponse(responseCode = "400", description = "BAD_REQUEST is returned if the provided mapping record is invalid."),
+                @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned if no record for the provided identifier was found."),
+                @ApiResponse(responseCode = "500", description = "INTERNAL_SERVER_ERROR is returned if the mapping could not be persisted for unknown reasons.")})
     @RequestMapping(value = "/{mappingId}", method = RequestMethod.PUT, consumes = {MediaType.MULTIPART_FORM_DATA_VALUE}, produces = {"application/json"})
     @Parameters({
         @Parameter(name = "If-Match", description = "ETag of the current mapping record. Please use quotation marks!", required = true, in = ParameterIn.HEADER)})

src/main/java/edu/kit/datamanager/mappingservice/rest/IMappingAdministrationController.java

@@ -13,14 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package edu.kit.datamanager.mappingservice.rest;
 
-import edu.kit.datamanager.mappingservice.domain.MappingRecord;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import org.springframework.http.MediaType;
@@ -39,28 +35,28 @@
  * @author maximilianiKIT
  */
 @ApiResponses(value = {
-        @ApiResponse(responseCode = "401", description = "UNAUTHORIZED is returned if authorization in required but was not provided."),
-        @ApiResponse(responseCode = "403", description = "FORBIDDEN is returned if the caller has no sufficient privileges.")})
+    @ApiResponse(responseCode = "401", description = "UNAUTHORIZED is returned if authorization in required but was not provided."),
+    @ApiResponse(responseCode = "403", description = "FORBIDDEN is returned if the caller has no sufficient privileges.")})
 public interface IMappingExecutionController {
 
-    @Operation(summary = "Map a document with an existing mapping.", description = "This endpoint allows the mapping of documents via a file upload. " +
-            "The prerequisite for this is a mapping that has already been created in advance via the \"/api/v1/mapping\" endpoint or the GUI. " +
-            "The identifier of this mapping must then be passed to this endpoint as parameters together with the document to be mapped.", responses = {
-            @ApiResponse(responseCode = "200", description = "OK is returned if the mapping was successful. " +
-                    "The result will also be returned in the response.", content = @Content(schema = @Schema(implementation = MappingRecord.class))),
-            @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned if no mapping for mappingID could be found."),
-            @ApiResponse(responseCode = "400", description = "BAD_REQUEST is returned if a parameter is missing or the mapping could not be performed with the provided input. It is "
-                    + "expected that a mapping plugin accepts a well defined input and produces results for proper inputs. Therefore, only a faulty input "
-                    + "document should be the reason for a mapper to fail."),
-            @ApiResponse(responseCode = "500", description = "INTERNAL_SERVER_ERROR is returned the mapping returned successfully, but the mapping result "
-                    + "is not accessible. This is expected to be an error in the mapping implementation and should be fixed in there.")})
+    @Operation(summary = "Map a document with an existing mapping.", description = "This endpoint allows the mapping of documents via a file upload. "
+            + "The prerequisite for this is a mapping that has already been created in advance via the \"/api/v1/mappingAdministration\" endpoint or the GUI. "
+            + "The identifier of this mapping must then be passed to this endpoint as parameters together with the document to be mapped.", responses = {
+                @ApiResponse(responseCode = "200", description = "OK is returned if the mapping was successful. "
+                        + "The result will also be returned in the response."),
+                @ApiResponse(responseCode = "404", description = "NOT_FOUND is returned if no mapping for mappingID could be found."),
+                @ApiResponse(responseCode = "400", description = "BAD_REQUEST is returned if a parameter is missing or the mapping could not be performed with the provided input. It is "
+                        + "expected that a mapping plugin accepts a well defined input and produces results for proper inputs. Therefore, only a faulty input "
+                        + "document should be the reason for a mapper to fail."),
+                @ApiResponse(responseCode = "500", description = "INTERNAL_SERVER_ERROR is returned the mapping returned successfully, but the mapping result "
+                        + "is not accessible. This is expected to be an error in the mapping implementation and should be fixed in there.")})
 
     @RequestMapping(value = {"/{mappingID}"}, method = {RequestMethod.POST}, consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
     @ResponseBody
     ResponseEntity mapDocument(
             @Parameter(description = "The document to be mapped.", required = true) @RequestPart(name = "document") final MultipartFile document,
-            @Parameter(description = "The mappingID of the already defined mapping schema.", required = true) @PathVariable(value = "mappingID") String mappingID,
+            @Parameter(description = "The mappingID of the already defined mapping.", required = true) @PathVariable(value = "mappingID") String mappingID,
             final HttpServletRequest request,
             final HttpServletResponse response,
             final UriComponentsBuilder uriBuilder) throws URISyntaxException;
-}
+}