diff --git a/engines/aio/src/main/resources/templates/transformForm.html b/engines/aio/src/main/resources/templates/transformForm.html deleted file mode 100644 index 725470e0..00000000 --- a/engines/aio/src/main/resources/templates/transformForm.html +++ /dev/null @@ -1,131 +0,0 @@ - - - -
-

All in One Transformer Test Transformation

-
-
- Log entries -
-
-

Tika Test Transformations

-
- - - - - - - - - - - - -
file *
sourceMimetype *
targetMimetype *
sourceExtension
targetExtension *
timeout
testDelay
targetEncoding
includeContents (archive) *
notExtractBookmarksText
-
-
-
-

LibreOffice Test Transformation

-
- - - - - - - - - - -
file *
sourceMimetype *
targetMimetype *
sourceExtension
targetExtension *
timeout
testDelay
-
-
-
-

Alfresco PDF Renderer Test Transformation

-
- - - - - - - - - - - - - - - - - -
file *
sourceMimetype *
targetMimetype *
sourceExtension
targetExtension *
timeout
testDelay
page
width
height
allowPdfEnlargement
maintainPdfAspectRatio
-
-
-
-

Miscellaneous Transformers Test Transformation

-
- - - - - - - - - - - - - - -
file *
sourceMimetype *
targetMimetype *
sourceExtension
targetExtension *
timeout
testDelay
sourceEncoding
targetEncoding
-
-
- -
-

ImageMagick Test Transformation

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
file *
sourceMimetype *
targetMimetype *
sourceExtension
targetExtension *
timeout
testDelay
startPage
endPage
alphaRemove
autoOrient
cropGravity
cropWidth
cropHeight
cropPercentage
cropXOffset
cropYOffset
thumbnail
resizeWidth
resizeHeight
resizePercentage
allowEnlargement
maintainAspectRatio
-
-
- - diff --git a/engines/aio/src/test/java/org/alfresco/transform/aio/AIOControllerHttpRequestTest.java b/engines/aio/src/test/java/org/alfresco/transform/aio/AIOControllerHttpRequestTest.java index 7108a01f..bc74896e 100644 --- a/engines/aio/src/test/java/org/alfresco/transform/aio/AIOControllerHttpRequestTest.java +++ b/engines/aio/src/test/java/org/alfresco/transform/aio/AIOControllerHttpRequestTest.java @@ -36,7 +36,7 @@ public class AIOControllerHttpRequestTest extends AbstractHttpRequestTest @Override protected String getTransformerName() { - return "All in One Transformer"; + return "0060-AllInOne"; } @Override diff --git a/engines/base/README.md b/engines/base/README.md index e791fcf3..2d21c21d 100644 --- a/engines/base/README.md +++ b/engines/base/README.md @@ -13,13 +13,13 @@ For more details on build a custom T-Engine, please refer to the current docs in A transformer project is expected to provide the following files: ~~~ -src/main/resources/templates/transformForm.html +src/main/resources/templates/test.html src/main/java/org/alfresco/transformer/Controller.java src/main/java/org/alfresco/transformer/Application.java ~~~ -* transformForm.html - A simple test page using [thymeleaf](http://www.thymeleaf.org) that gathers request - parameters so they may be used to test the transformer. +* test.html - A simple test page using [thymeleaf](http://www.thymeleaf.org) that gathers request + parameters, so they may be used to test the transformer. ~~~ @@ -42,7 +42,7 @@ src/main/java/org/alfresco/transformer/Application.java
- Log entries + Log
diff --git a/engines/base/src/main/java/org/alfresco/transform/base/TransformController.java b/engines/base/src/main/java/org/alfresco/transform/base/TransformController.java index dd729e46..7b542c35 100644 --- a/engines/base/src/main/java/org/alfresco/transform/base/TransformController.java +++ b/engines/base/src/main/java/org/alfresco/transform/base/TransformController.java @@ -26,20 +26,20 @@ */ package org.alfresco.transform.base; +import org.alfresco.transform.base.clients.AlfrescoSharedFileStoreClient; import org.alfresco.transform.base.fs.FileManager; +import org.alfresco.transform.base.logging.LogEntry; +import org.alfresco.transform.base.model.FileRefResponse; import org.alfresco.transform.base.probes.ProbeTestTransform; import org.alfresco.transform.base.util.OutputStreamLengthRecorder; -import org.alfresco.transform.common.TransformerDebug; import org.alfresco.transform.client.model.InternalContext; import org.alfresco.transform.client.model.TransformReply; import org.alfresco.transform.client.model.TransformRequest; -import org.alfresco.transform.messages.TransformRequestValidator; -import org.alfresco.transform.config.TransformConfig; -import org.alfresco.transform.registry.TransformServiceRegistry; import org.alfresco.transform.common.TransformException; -import org.alfresco.transform.base.clients.AlfrescoSharedFileStoreClient; -import org.alfresco.transform.base.logging.LogEntry; -import org.alfresco.transform.base.model.FileRefResponse; +import org.alfresco.transform.common.TransformerDebug; +import org.alfresco.transform.config.TransformConfig; +import org.alfresco.transform.messages.TransformRequestValidator; +import org.alfresco.transform.registry.TransformServiceRegistry; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.TypeMismatchException; @@ -86,24 +86,28 @@ import java.util.concurrent.atomic.AtomicInteger; import static java.text.MessageFormat.format; import static java.util.stream.Collectors.joining; -import static org.alfresco.transform.base.fs.FileManager.createTargetFile; -import static org.alfresco.transform.common.RequestParamMap.TARGET_ENCODING; -import static org.alfresco.transform.config.CoreVersionDecorator.setOrClearCoreVersion; -import static org.alfresco.transform.common.RequestParamMap.DIRECT_ACCESS_URL; -import static org.alfresco.transform.common.RequestParamMap.CONFIG_VERSION; -import static org.alfresco.transform.common.RequestParamMap.CONFIG_VERSION_DEFAULT; -import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_TRANSFORM; -import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_TRANSFORM_CONFIG; import static org.alfresco.transform.base.fs.FileManager.TempFileProvider.createTempFile; -import static org.alfresco.transform.base.fs.FileManager.getDirectAccessUrlInputStream; +import static org.alfresco.transform.base.fs.FileManager.createTargetFile; import static org.alfresco.transform.base.fs.FileManager.deleteFile; +import static org.alfresco.transform.base.fs.FileManager.getDirectAccessUrlInputStream; import static org.alfresco.transform.base.fs.FileManager.getFilenameFromContentDisposition; import static org.alfresco.transform.base.fs.FileManager.save; +import static org.alfresco.transform.common.RequestParamMap.CONFIG_VERSION; +import static org.alfresco.transform.common.RequestParamMap.CONFIG_VERSION_DEFAULT; +import static org.alfresco.transform.common.RequestParamMap.DIRECT_ACCESS_URL; +import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_ERROR; +import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_LOG; +import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_ROOT; +import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_TRANSFORM; +import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_TRANSFORM_CONFIG; +import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_TEST; import static org.alfresco.transform.common.RequestParamMap.FILE; import static org.alfresco.transform.common.RequestParamMap.SOURCE_ENCODING; import static org.alfresco.transform.common.RequestParamMap.SOURCE_EXTENSION; import static org.alfresco.transform.common.RequestParamMap.SOURCE_MIMETYPE; +import static org.alfresco.transform.common.RequestParamMap.TARGET_ENCODING; import static org.alfresco.transform.common.RequestParamMap.TARGET_MIMETYPE; +import static org.alfresco.transform.config.CoreVersionDecorator.setOrClearCoreVersion; import static org.springframework.http.HttpStatus.BAD_REQUEST; import static org.springframework.http.HttpStatus.CREATED; import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR; @@ -221,16 +225,16 @@ public class TransformController /** * Test UI page to perform a transform. */ - @GetMapping("/") - public String transformForm(Model model) + @GetMapping(ENDPOINT_ROOT) + public String test(Model model) { - return "transformForm"; + return "test"; } /** * Test UI error page. */ - @GetMapping("/error") + @GetMapping(ENDPOINT_ERROR) public String error() { return "error"; // the name of the template @@ -239,7 +243,7 @@ public class TransformController /** * Test UI log page. */ - @GetMapping("/log") + @GetMapping(ENDPOINT_LOG) String log(Model model) { model.addAttribute("title", transformEngine.getTransformEngineName() + " Log Entries"); @@ -281,6 +285,46 @@ public class TransformController return new ResponseEntity<>(transformConfig, OK); } + @PostMapping(value = ENDPOINT_TEST, consumes = MULTIPART_FORM_DATA_VALUE) + public StreamingResponseBody test(HttpServletRequest request, + @RequestParam(value = FILE, required = false) MultipartFile sourceMultipartFile, + @RequestParam(value = SOURCE_MIMETYPE, required = false) String sourceMimetype, + @RequestParam(value = TARGET_MIMETYPE, required = false) String targetMimetype, + @RequestParam Map origRequestParameters) + { + Map requestParameters = new HashMap<>(); + sourceMimetype = overrideMimetypeFromExtension(origRequestParameters, SOURCE_MIMETYPE, sourceMimetype); + targetMimetype = overrideMimetypeFromExtension(origRequestParameters, TARGET_MIMETYPE, targetMimetype); + origRequestParameters.forEach((name, value) -> + { + if (name.startsWith("value") == false) + { + if (name.startsWith("name")) + { + String suffix = name.substring("name".length()); + name = value; + value = origRequestParameters.get("value" + suffix); + } + if (name != null && !name.isBlank() && value != null && !value.isBlank()) + { + requestParameters.put(name, value); + } + } + }); + return transform(request, sourceMultipartFile, sourceMimetype, targetMimetype, requestParameters); + } + + private String overrideMimetypeFromExtension(Map origRequestParameters, String name, String value) + { + String override = origRequestParameters.remove("_"+ name); + if (override != null && !override.isBlank()) + { + value = override; + origRequestParameters.put(name, value); + } + return value; + } + @PostMapping(value = ENDPOINT_TRANSFORM, consumes = MULTIPART_FORM_DATA_VALUE) public StreamingResponseBody transform(HttpServletRequest request, @RequestParam(value = FILE, required = false) MultipartFile sourceMultipartFile, diff --git a/engines/base/src/main/java/org/alfresco/transform/base/fs/FileManager.java b/engines/base/src/main/java/org/alfresco/transform/base/fs/FileManager.java index c3d5aed0..213a292d 100644 --- a/engines/base/src/main/java/org/alfresco/transform/base/fs/FileManager.java +++ b/engines/base/src/main/java/org/alfresco/transform/base/fs/FileManager.java @@ -235,10 +235,14 @@ public class FileManager { return new URL(directUrl).openStream(); } - catch (IOException e) + catch (IllegalArgumentException e) { throw new TransformException(BAD_REQUEST.value(), "Direct Access Url is invalid.", e); } + catch (IOException e) + { + throw new TransformException(BAD_REQUEST.value(), "Direct Access Url not found.", e); + } } public static void copyFileToOutputStream(File targetFile, OutputStream outputStream) diff --git a/engines/base/src/main/resources/templates/error.html b/engines/base/src/main/resources/templates/error.html index 54b0facd..a0001012 100644 --- a/engines/base/src/main/resources/templates/error.html +++ b/engines/base/src/main/resources/templates/error.html @@ -6,16 +6,20 @@

Error Page

-

-

+

+ +


- Test Transformation - Log entries + Test + Log + Ready + Live + Config
diff --git a/engines/base/src/main/resources/templates/log.html b/engines/base/src/main/resources/templates/log.html index ee973306..135bb6bd 100644 --- a/engines/base/src/main/resources/templates/log.html +++ b/engines/base/src/main/resources/templates/log.html @@ -35,8 +35,11 @@

- Test Transformation - Transformer Config + Test + Log + Ready + Live + Config
diff --git a/engines/base/src/main/resources/templates/test.html b/engines/base/src/main/resources/templates/test.html new file mode 100644 index 00000000..dad40d26 --- /dev/null +++ b/engines/base/src/main/resources/templates/test.html @@ -0,0 +1,204 @@ + + +
+

Test Transformations

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
file
Direct Url
sourceMimetype
targetMimetype
timeout
+
+
+
+ Test + Log + Ready + Live + Config +
+ + diff --git a/engines/base/src/test/java/org/alfresco/transform/base/AbstractHttpRequestTest.java b/engines/base/src/test/java/org/alfresco/transform/base/AbstractHttpRequestTest.java index c6e8ae15..7acf1a34 100644 --- a/engines/base/src/test/java/org/alfresco/transform/base/AbstractHttpRequestTest.java +++ b/engines/base/src/test/java/org/alfresco/transform/base/AbstractHttpRequestTest.java @@ -35,6 +35,7 @@ import static org.springframework.test.util.AssertionErrors.assertTrue; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.web.client.TestRestTemplate; import org.springframework.boot.web.server.LocalServerPort; import org.springframework.http.HttpEntity; @@ -46,6 +47,7 @@ import org.springframework.util.LinkedMultiValueMap; * Super class for testing controllers with a server. Includes tests for the Controller itself. * Note: Currently uses json rather than HTML as json is returned by this spring boot test harness. */ +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes={org.alfresco.transform.base.Application.class}) public abstract class AbstractHttpRequestTest { @LocalServerPort @@ -63,7 +65,7 @@ public abstract class AbstractHttpRequestTest { String result = restTemplate.getForObject("http://localhost:" + port + "/", String.class); - String title = getTransformerName() + ' ' + "Test Transformation"; + String title = "Test Transformation"; assertTrue("\"" + title + "\" should be part of the page title", result.contains(title)); } @@ -84,8 +86,7 @@ public abstract class AbstractHttpRequestTest String.class); String title = getTransformerName() + ' ' + "Error Page"; - assertTrue("\"" + title + "\" should be part of the page title", - result.contains("Error Page")); + assertTrue("\"" + title + "\" should be part of the page title", result.contains("Error Page")); } @Test @@ -99,12 +100,6 @@ public abstract class AbstractHttpRequestTest parameters); } - @Test - public void noTargetExtensionError() - { - assertMissingParameter("targetExtension"); - } - private void assertMissingParameter(String name) { assertTransformError(true, diff --git a/engines/base/src/test/java/org/alfresco/transform/base/AbstractTransformControllerTest.java b/engines/base/src/test/java/org/alfresco/transform/base/AbstractTransformControllerTest.java index d51e4ca0..0dee3aca 100644 --- a/engines/base/src/test/java/org/alfresco/transform/base/AbstractTransformControllerTest.java +++ b/engines/base/src/test/java/org/alfresco/transform/base/AbstractTransformControllerTest.java @@ -80,6 +80,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.boot.test.mock.mockito.SpyBean; import org.springframework.core.io.ClassPathResource; @@ -98,6 +99,7 @@ import com.google.common.collect.ImmutableSet; /** * Super class for testing controllers without a server. Includes tests for the Controller itself. */ +//@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes={org.alfresco.transform.base.config.WebApplicationConfig.class}) public abstract class AbstractTransformControllerTest { @TempDir // added as part of ATS-702 to allow test resources to be read from the imported jar files to prevent test resource duplication diff --git a/engines/imagemagick/src/main/resources/templates/transformForm.html b/engines/imagemagick/src/main/resources/templates/transformForm.html deleted file mode 100644 index 3ced2d95..00000000 --- a/engines/imagemagick/src/main/resources/templates/transformForm.html +++ /dev/null @@ -1,43 +0,0 @@ - - - -
-

ImageMagick Test Transformation

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
file *
targetExtension *
timeout
testDelay
startPage
endPage
alphaRemove
autoOrient
cropGravity
North, NorthEast...Center
cropWidth
cropHeight
cropPercentage
cropXOffset
cropYOffset
thumbnail
resizeWidth
resizeHeight
resizePercentage
allowEnlargement
maintainAspectRatio
-
-
- -
- Log entries -
- - - diff --git a/engines/imagemagick/src/test/java/org/alfresco/transform/imagemagick/ImageMagickHttpRequestTest.java b/engines/imagemagick/src/test/java/org/alfresco/transform/imagemagick/ImageMagickHttpRequestTest.java index 7e0a0392..bd864200 100644 --- a/engines/imagemagick/src/test/java/org/alfresco/transform/imagemagick/ImageMagickHttpRequestTest.java +++ b/engines/imagemagick/src/test/java/org/alfresco/transform/imagemagick/ImageMagickHttpRequestTest.java @@ -38,7 +38,7 @@ public class ImageMagickHttpRequestTest extends AbstractHttpRequestTest @Override protected String getTransformerName() { - return "ImageMagick"; + return "0030-ImageMagick"; } @Override diff --git a/engines/libreoffice/src/main/resources/templates/transformForm.html b/engines/libreoffice/src/main/resources/templates/transformForm.html deleted file mode 100644 index 7d2dac1a..00000000 --- a/engines/libreoffice/src/main/resources/templates/transformForm.html +++ /dev/null @@ -1,25 +0,0 @@ - - - -
-

LibreOffice Test Transformation

-
- - - - - - - - - -
file *
sourceMimetype *
targetMimetype
targetExtension *
timeout
testDelay
-
-
- -
- Log entries -
- - - diff --git a/engines/libreoffice/src/test/java/org/alfresco/transform/libreoffice/LibreOfficeHttpRequestTest.java b/engines/libreoffice/src/test/java/org/alfresco/transform/libreoffice/LibreOfficeHttpRequestTest.java index d8ba9d0f..be9f7387 100644 --- a/engines/libreoffice/src/test/java/org/alfresco/transform/libreoffice/LibreOfficeHttpRequestTest.java +++ b/engines/libreoffice/src/test/java/org/alfresco/transform/libreoffice/LibreOfficeHttpRequestTest.java @@ -38,7 +38,7 @@ public class LibreOfficeHttpRequestTest extends AbstractHttpRequestTest @Override protected String getTransformerName() { - return "LibreOffice"; + return "0020-LibreOffice"; } @Override diff --git a/engines/misc/src/main/resources/templates/transformForm.html b/engines/misc/src/main/resources/templates/transformForm.html deleted file mode 100644 index 59097697..00000000 --- a/engines/misc/src/main/resources/templates/transformForm.html +++ /dev/null @@ -1,29 +0,0 @@ - - - -
-

Miscellaneous Transformers Test Transformation

-
- - - - - - - - - - - - - -
file *
sourceExtension *
targetExtension *
sourceMimetype *
targetMimetype *
sourceEncoding *
targetEncoding *
timeout
testDelay
-
-
- -
- Log entries -
- - - diff --git a/engines/misc/src/test/java/org/alfresco/transform/misc/MiscTransformerHttpRequestTest.java b/engines/misc/src/test/java/org/alfresco/transform/misc/MiscTransformerHttpRequestTest.java index 739f8104..23cf6eef 100644 --- a/engines/misc/src/test/java/org/alfresco/transform/misc/MiscTransformerHttpRequestTest.java +++ b/engines/misc/src/test/java/org/alfresco/transform/misc/MiscTransformerHttpRequestTest.java @@ -38,7 +38,7 @@ public class MiscTransformerHttpRequestTest extends AbstractHttpRequestTest @Override protected String getTransformerName() { - return "Miscellaneous Transformers"; + return "0050-Misc"; } @Override diff --git a/engines/pdfrenderer/src/main/resources/templates/transformForm.html b/engines/pdfrenderer/src/main/resources/templates/transformForm.html deleted file mode 100644 index 250adbf1..00000000 --- a/engines/pdfrenderer/src/main/resources/templates/transformForm.html +++ /dev/null @@ -1,30 +0,0 @@ - - - -
-

Alfresco PDF Renderer Test Transformation

-
- - - - - - - - - - - - - - -
file *
targetExtension *
timeout
testDelay
page
width
height
allowPdfEnlargement
maintainPdfAspectRatio
-
-
- -
- Log entries -
- - - diff --git a/engines/pdfrenderer/src/test/java/org/alfresco/transform/pdfrenderer/AlfrescoPdfRendererHttpRequestTest.java b/engines/pdfrenderer/src/test/java/org/alfresco/transform/pdfrenderer/AlfrescoPdfRendererHttpRequestTest.java index 0a97a767..8a6613dd 100644 --- a/engines/pdfrenderer/src/test/java/org/alfresco/transform/pdfrenderer/AlfrescoPdfRendererHttpRequestTest.java +++ b/engines/pdfrenderer/src/test/java/org/alfresco/transform/pdfrenderer/AlfrescoPdfRendererHttpRequestTest.java @@ -39,7 +39,7 @@ public class AlfrescoPdfRendererHttpRequestTest extends AbstractHttpRequestTest @Override protected String getTransformerName() { - return "Alfresco PDF Renderer"; + return "0040-PdfRenderer"; } @Override diff --git a/engines/tika/src/main/resources/templates/transformForm.html b/engines/tika/src/main/resources/templates/transformForm.html deleted file mode 100644 index 6d47ff5f..00000000 --- a/engines/tika/src/main/resources/templates/transformForm.html +++ /dev/null @@ -1,28 +0,0 @@ - - - -
-

Tika Test Transformations

-
- - - - - - - - - - - - -
file *
Direct Url
sourceMimetype *
targetExtension *
targetMimetype *
targetEncoding *
includeContents (archive) *
timeout
testDelay
notExtractBookmarksText
-
-
- -
- Log entries -
- - - diff --git a/engines/tika/src/test/java/org/alfresco/transform/tika/TikaHttpRequestTest.java b/engines/tika/src/test/java/org/alfresco/transform/tika/TikaHttpRequestTest.java index 360c1385..37e2456d 100644 --- a/engines/tika/src/test/java/org/alfresco/transform/tika/TikaHttpRequestTest.java +++ b/engines/tika/src/test/java/org/alfresco/transform/tika/TikaHttpRequestTest.java @@ -34,13 +34,12 @@ import org.springframework.util.LinkedMultiValueMap; /** * Tests TikaController with a server test harness. */ -@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) public class TikaHttpRequestTest extends AbstractHttpRequestTest { @Override protected String getTransformerName() { - return "Tika"; + return "0010-Tika"; } @Override diff --git a/model/src/main/java/org/alfresco/transform/common/RequestParamMap.java b/model/src/main/java/org/alfresco/transform/common/RequestParamMap.java index dc487527..07b9d1a1 100644 --- a/model/src/main/java/org/alfresco/transform/common/RequestParamMap.java +++ b/model/src/main/java/org/alfresco/transform/common/RequestParamMap.java @@ -77,8 +77,10 @@ public interface RequestParamMap // Endpoints String ENDPOINT_TRANSFORM = "/transform"; + String ENDPOINT_TEST = "/test"; String ENDPOINT_TRANSFORM_CONFIG = "/transform/config"; String ENDPOINT_TRANSFORM_CONFIG_LATEST = ENDPOINT_TRANSFORM_CONFIG + "?" + CONFIG_VERSION + "=" + CONFIG_VERSION_LATEST; - String ENDPOINT_TRANSFORM_LOG = "/log"; - String ENDPOINT_TRANSFORM_TEST = "/"; + String ENDPOINT_ERROR = "/error"; + String ENDPOINT_LOG = "/log"; + String ENDPOINT_ROOT = "/"; }