inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-09-17 14:21:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

REPO-5549 Fix: Local transformer names must exist and be unique docli… (#264)

Browse Source 
* REPO-5549 Fix: Local transformer names must exist and be unique doclib Read from ... when overriding a Local transform.

* Problem was that there were two conflicting pieces of code in play in the LocalTransformRegistry.register method. One that checked for duplicate T-Engine names and the other that allowed transforms to be overridden if they had the same name.
* The code checking for duplicate names needed an extra clause to only look at T-Engines (they have a T-Engine url associated with them).
* The code that overrode transforms then worked, but still had issues as the supported source to target mimetypes, priorities and max sizes were not cleared.
* It turned out to be simpler to split the original LocalTransformRegistry.register method into two. Extracting a new method into CombinedConfig.removeOverriddenOrInvalidTransformers that discarded invalid or overridden config before the list of supported source to target mimetypes was created rather than try to fix them up later. This is why there appear to be quite a few changes.
* More extensive unit tests were also added.
This commit is contained in:
Alan Davis
2021-01-29 20:04:55 +00:00
committed by GitHub
parent 2b1f63e07f
commit a903d9ec44
14 changed files with 635 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

196
repository/src/test/java/org/alfresco/transform/client/registry/LocalTransformServiceRegistryConfigTest.java
View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2020 Alfresco Software Limited
* Copyright (C) 2005 - 2021 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
@@ -28,7 +28,9 @@ package org.alfresco.transform.client.registry;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.content.transform.AbstractLocalTransform;
import org.alfresco.repo.content.transform.LocalCombinedConfig;
import org.alfresco.repo.content.transform.LocalPipelineTransform;
import org.alfresco.repo.content.transform.LocalTransformImpl;
import org.alfresco.repo.content.transform.LocalTransformServiceRegistry;
import org.alfresco.repo.content.transform.TransformerDebug;
import org.alfresco.transform.client.model.config.SupportedSourceAndTarget;
@@ -50,11 +52,15 @@ import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
/**
* Extends the {@link TransformServiceRegistryConfigTest} (used to test the config received from the Transform Service)
@@ -63,10 +69,15 @@ import static org.junit.Assert.assertTrue;
*/
public class LocalTransformServiceRegistryConfigTest extends TransformServiceRegistryConfigTest
{
public static final String HARD_CODED_VALUE = "hard coded value";
private class TestLocalTransformServiceRegistry extends LocalTransformServiceRegistry
{
private boolean mockSuccessReadingConfig = true;
LocalData dummyData = new LocalData();
private List<String> errorsLogged = new ArrayList<>();
private boolean resetBaseUrl = true;
private int tEngineCount = 0;
public synchronized boolean getMockSuccessReadingConfig()
{
@@ -79,11 +90,25 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
this.mockSuccessReadingConfig = mockSuccessReadingConfig;
}
@Override
protected String getBaseUrlIfTesting(String name, String baseUrl)
public void setResetBaseUrl(boolean resetBaseUrl)
{
return baseUrl == null
this.resetBaseUrl = resetBaseUrl;
}
@Override
// As we are mocking, baseUrl is always null, so this method sets it so we don't get errors.
// It looks for the alfresco global property or system property with a localTransform. prefix,
// just like the normal code.
// If setResetBaseUrl(false) is called, the baseUrl remains null
// If we are using transforms called "t-engine" only the first one has its baseUrl set - does not use properties.
public String getBaseUrlIfTesting(String name, String baseUrl)
{
boolean isTEngine = "t-engine".equals(name);
tEngineCount += isTEngine ? 1 : 0;
return baseUrl == null && resetBaseUrl && !isTEngine
? getProperty(LOCAL_TRANSFORM +name+URL, null)
: isTEngine && tEngineCount == 1
? HARD_CODED_VALUE
: baseUrl;
}
@@ -103,6 +128,13 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
return dummyData;
}
@Override
protected void logError(String msg)
{
errorsLogged.add(msg);
super.logError(msg);
}
public Data assertDataChanged(Data prevData, String msg)
{
// If the data changes, there has been a read
@@ -119,6 +151,20 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
assertEquals("The configuration data should be the same: "+msg, getData(), data);
return getData();
}
public void assertErrorLogged(String pattern)
{
Pattern p = Pattern.compile(pattern);
for (String msg : errorsLogged)
{
Matcher matcher = p.matcher(msg);
if (matcher.matches())
{
return;
}
}
fail("Did not find error message that matches "+pattern);
}
}
private static Log log = LogFactory.getLog(LocalTransformServiceRegistry.class);
@@ -209,11 +255,12 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
/**
* Loads localTransforms from the LOCAL_TRANSFORM_SERVICE_CONFIG config file.
* @param path
*/
private void retrieveLocalTransformList()
private void retrieveLocalTransformList(String path)
{
CombinedConfig combinedConfig = new CombinedConfig(log);
combinedConfig.addLocalConfig(LOCAL_TRANSFORM_SERVICE_CONFIG);
CombinedConfig combinedConfig = new LocalCombinedConfig(log);
combinedConfig.addLocalConfig(path);
combinedConfig.register(registry);
mapOfTransformOptions = combinedConfig.combinedTransformOptions;
transformerList = combinedConfig.combinedTransformers;
@@ -339,16 +386,10 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
internalTestJsonConfig(64, 70);
}
@Test
public void testReadWriteJson() throws IOException
{
// Override super method so it passes, as there is nothing more to be gained for LocalTransforms.
}
@Test
public void testReadJsonConfig()
{
retrieveLocalTransformList();
retrieveLocalTransformList(LOCAL_TRANSFORM_SERVICE_CONFIG);
// Assert expected size of the transformers.
assertNotNull("Transformer list is null.", transformerList);
@@ -451,7 +492,7 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
@Test
public void testReadTransformProperties()
{
retrieveLocalTransformList();
retrieveLocalTransformList(LOCAL_TRANSFORM_SERVICE_CONFIG);
assertNotNull("Transformer list is null.", transformerList);
for (CombinedConfig.TransformAndItsOrigin t : transformerList)
@@ -480,6 +521,7 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
}
@Test
// Simulates the reading of config which changes over time and sometimes T-Engines fail to reply.
public void testAdditionAndRemovalOfTEngines() throws Exception
{
CronExpression origCronExpression = registry.getCronExpression();
@@ -543,9 +585,10 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
}
@Test
// Checks that only options expected by individual transforms in the pipeline are actually passed to the transform.
public void testStripExtraOptions()
{
retrieveLocalTransformList();
retrieveLocalTransformList(LOCAL_TRANSFORM_SERVICE_CONFIG);
Map<String, String> actualOptions = Map.of(
"autoOrient", "true",
@@ -570,9 +613,10 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
}
@Test
// Checks that the correct transformer is selected based on priority
public void testPriority()
{
retrieveLocalTransformList();
retrieveLocalTransformList(LOCAL_TRANSFORM_SERVICE_CONFIG);
assertEquals("pdfrenderer",
((AbstractLocalTransform)registry.getLocalTransform("source", -1,
@@ -586,4 +630,122 @@ public class LocalTransformServiceRegistryConfigTest extends TransformServiceReg
((AbstractLocalTransform)registry.getLocalTransform("source", -1,
"target3", Collections.emptyMap(), null)).getName());
}
@Test
public void testNoName()
{
retrieveLocalTransformList("alfresco/local-transform-service-config-no-name-test.json");
registry.assertErrorLogged("Local transformer names may not be null.*no-name-test.*");
}
@Test
public void testPipelineAndFailover()
{
retrieveLocalTransformList("alfresco/local-transform-service-config-pipeline-and-failover-test.json");
registry.assertErrorLogged("Transformer .* cannot have pipeline and failover sections.*pipeline-and-failover.*");
}
@Test
public void testTEngineDuplicateNames()
{
retrieveLocalTransformList("alfresco/local-transform-service-config-dup-name-test.json");
registry.assertErrorLogged("Local T-Engine transformer .* must be a unique name.*dup-name.*");
}
@Test
public void testTEngineNoBaseUrls()
{
registry.setResetBaseUrl(false);
retrieveLocalTransformList("alfresco/local-transform-service-config-no-base-url-test.json");
registry.assertErrorLogged("Local T-Engine transformer .* must have its baseUrl set .*no-base-url.*");
}
@Test
public void testPipelineMissingStepTransform()
{
retrieveLocalTransformList("alfresco/transform-service-config-pipeline-missing-step-test.json");
registry.assertErrorLogged("Transformer .* ignored as step transforms do not exist.*pipeline-missing-step.*");
}
@Test
public void testFailoverMissingStepTransform()
{
retrieveLocalTransformList("alfresco/transform-service-config-failover-missing-step-test.json");
registry.assertErrorLogged("Transformer .* ignored as step transforms do not exist.*failover-missing-step.*");
}
@Test
public void testOverrideTEngine()
{
// This json file contains two transformers with the same name.
// * The second one should override the first which has different supported source mimetypes, target mimetypes
// and max sizes. It also has different transform options.
// * There is special code in getBaseUrlIfTesting mocking up the baseUrl just for the first one. It should be
// copied to the second one.
retrieveLocalTransformList("alfresco/local-transform-service-config-override-test.json");
assertNotNull("Should still be supported",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", 1000,
"text/html", Collections.emptyMap(), null)));
assertNotNull("Increased max size be supported",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", 2000,
"text/html", Collections.emptyMap(), null)));
assertNull("Increased max size is now 2000",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", 3000,
"text/html", Collections.emptyMap(), null)));
assertNotNull("Should have been added",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", -1,
"application/pdf", Collections.emptyMap(), null)));
assertNull("Should have been removed",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", -1,
"text/tab-separated-values", Collections.emptyMap(), null)));
assertNotNull("options1 should still exist, even if not used", mapOfTransformOptions.get("options1"));
assertNotNull("options2 should exist", mapOfTransformOptions.get("options2"));
Map<String, String> actualOptions = Map.of(
"width", "100",
"height", "50");
assertNull("width from options1 is no longer used, so should find no transformer",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", -1,
"application/pdf", actualOptions, null)));
actualOptions = Map.of(
"page", "100",
"height", "50");
assertNotNull("Both options are in options2, so should we should find the transformer",
((AbstractLocalTransform)registry.getLocalTransform("text/csv", -1,
"application/pdf", actualOptions, null)));
LocalTransformImpl localTransform = (LocalTransformImpl)
registry.getLocalTransform("text/csv", -1,
"application/pdf", Collections.emptyMap(), null);
assertEquals("Should only have 2 options", 2,
localTransform.getTransformsTransformOptionNames().size());
assertTrue("The baseUrl should have been copied", localTransform.remoteTransformerClientConfigured());
}
@Test
public void testOverrideTEngineWithPipeline()
{
// This json file contains two transformers with the same name, plus two others libreoffice and pdfrenderer
// * The first transform which should be overridden has a baseUrl as it talks to a T-Engine and has 5
// supported source to target mimetypes.
// * The second one should override the first with a pipeline of libreoffice and pdfrenderer but only has 1
// supported source to target mimetype. It should not have a baseUrl as it will not talk to a T-Engine.
// THIS IS WHAT IS BASICALLY DIFFERENT TO testOverrideTEngine, resulting in a LocalPipelineTransform rather
// rather than a LocalTransformImpl.
// * There is special code in getBaseUrlIfTesting mocking up the baseUrl just for the first one. It should be
// copied to the second one.
retrieveLocalTransformList("alfresco/local-transform-service-config-override-with-pipeline-test.json");
LocalPipelineTransform pipelineTransform = (LocalPipelineTransform) registry.getLocalTransform("text/csv",
-1,"image/png", Collections.emptyMap(), null);
assertNotNull("Should supported csv to png", pipelineTransform);
}
}