inteligr8/alfresco-transform-core
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-transform-core.git synced 2025-07-31 17:38:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

MNT-24883 adding source file name to transform options

Browse Source 
Added source file name to transform options if exist in nodeService. It will be used in ATS to maintain consistency in transform for filenames.
This commit is contained in:
bsayan2
2025-06-17 14:13:41 +05:30
committed by GitHub
parent b800c86a7c
commit 81c47c2b04
12 changed files with 706 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
model/src/main/java/org/alfresco/transform/common/RequestParamMap.java
View File

@@ -26,6 +26,7 @@ import org.alfresco.transform.config.CoreVersionDecorator;
/**
* Request parameters and transform options used in the core transformers.
*/
@SuppressWarnings("PMD.ConstantsInInterface")
public interface RequestParamMap
{
// html parameter names
@@ -72,6 +73,9 @@ public interface RequestParamMap
// Html parameter names for the transform config
String HTML_COLLAPSE = "collapseHtml";
// source file name for the libre transform options
String SOURCE_FILENAME = "sourceFilename";
// Parameters interpreted by the TransformController
String DIRECT_ACCESS_URL = "directAccessUrl";

14
model/src/main/java/org/alfresco/transform/config/CoreFunction.java
View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Model
* %%
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* Copyright (C) 2005 - 2025 Alfresco Software Limited
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
@@ -21,14 +21,13 @@
*/
package org.alfresco.transform.config;
import org.apache.maven.artifact.versioning.ComparableVersion;
import static org.alfresco.transform.config.CoreFunction.Constants.NO_UPPER_VERSION;
import static org.alfresco.transform.config.CoreFunction.Constants.NO_VERSION;
import org.apache.maven.artifact.versioning.ComparableVersion;
/**
* Provides a mapping between a transform {@code coreVersion} and functionality (such as the use of Direct Access URLs)
* supported in that version of the {@code alfresco-transform-base}, so that clients know if they may use it.
* Provides a mapping between a transform {@code coreVersion} and functionality (such as the use of Direct Access URLs) supported in that version of the {@code alfresco-transform-base}, so that clients know if they may use it.
*/
public enum CoreFunction
{
@@ -41,7 +40,10 @@ public enum CoreFunction
/** Original way to talk to a T-Engine **/
// The toValue really should be null rather than "9999" but gives us an upper test value
HTTP(null, "99999");
HTTP(null, "99999"),
/** Additional transform option to preserve original file name **/
SOURCE_FILENAME("5.1.8", null);
private final ComparableVersion fromVersion;
private final ComparableVersion toVersion;

136
model/src/main/java/org/alfresco/transform/config/CoreVersionDecorator.java
View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Model
* %%
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* Copyright (C) 2005 - 2025 Alfresco Software Limited
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
@@ -21,7 +21,12 @@
*/
package org.alfresco.transform.config;
import org.apache.maven.artifact.versioning.ComparableVersion;
import static java.util.function.Predicate.not;
import static org.alfresco.transform.common.RequestParamMap.DIRECT_ACCESS_URL;
import static org.alfresco.transform.common.RequestParamMap.SOURCE_FILENAME;
import static org.alfresco.transform.config.CoreFunction.Constants.NO_VERSION;
import static org.alfresco.transform.config.CoreFunction.newComparableVersion;
import java.util.HashMap;
import java.util.HashSet;
@@ -31,31 +36,28 @@ import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
import static java.util.function.Predicate.not;
import static org.alfresco.transform.config.CoreFunction.Constants.NO_VERSION;
import static org.alfresco.transform.config.CoreFunction.newComparableVersion;
import static org.alfresco.transform.common.RequestParamMap.DIRECT_ACCESS_URL;
import org.apache.maven.artifact.versioning.ComparableVersion;
/**
* <p>Class sets or clears the {@code coreVersion} property of {@link Transformer}s in a {@link TransformConfig}<p/>
* <p>
* Class sets or clears the {@code coreVersion} property of {@link Transformer}s in a {@link TransformConfig}
* <p/>
*
* <p>Since alfresco-transform-core 5.2.7, the config returned by T-Engines and T-Router via their
* {@code "/transform/config"} endpoint has been decorated with an {@code coreVersion} element, indicating what core
* functionality is provided by each transformer as a result of extending the {@code TransformController} in
* the {@code alfresco-transform-base}. This is automatically added, so need not be specified by the T-Engine developer.
* It was originally added to indicate that it was possible to use Direct Access URLs (DAU).</p>
* <p>
* Since alfresco-transform-core 5.2.7, the config returned by T-Engines and T-Router via their {@code "/transform/config"} endpoint has been decorated with an {@code coreVersion} element, indicating what core functionality is provided by each transformer as a result of extending the {@code TransformController} in the {@code alfresco-transform-base}. This is automatically added, so need not be specified by the T-Engine developer. It was originally added to indicate that it was possible to use Direct Access URLs (DAU).
* </p>
*
* <p>This class provides methods to sets or clear the field with the version number of the
* {@code alfresco-transform-base}. No value indicates 5.2.6 or earlier.</p>
* <p>
* This class provides methods to sets or clear the field with the version number of the {@code alfresco-transform-base}. No value indicates 5.2.6 or earlier.
* </p>
*
* <p>To allow older and newer version of the Repository, T-Router and T-Engines to work together, this field is only
* returned if requested by a client that also knows about the field. An optional {@code "configVersion"} parameter
* has been added to the endpoint. The config for T-Engines need only add the field to single-step-transforms. When
* configs are combined it is then possible to add this field to pipeline and failover transforms by using the lowest
* core value of any step transform.</p>
* <p>
* To allow older and newer version of the Repository, T-Router and T-Engines to work together, this field is only returned if requested by a client that also knows about the field. An optional {@code "configVersion"} parameter has been added to the endpoint. The config for T-Engines need only add the field to single-step-transforms. When configs are combined it is then possible to add this field to pipeline and failover transforms by using the lowest core value of any step transform.
* </p>
*
* <p>If the field is not requested in the T-Router or the all-in-one transformer endpoint, it may need to be stripped
* from the {@link TransformConfig} as some of the T-Engines may have supplied it.</p>
* <p>
* If the field is not requested in the T-Router or the all-in-one transformer endpoint, it may need to be stripped from the {@link TransformConfig} as some of the T-Engines may have supplied it.
* </p>
*
* @see CoreFunction
*/
@@ -63,12 +65,12 @@ public class CoreVersionDecorator
{
public static final int CONFIG_VERSION_INCLUDES_CORE_VERSION = 2;
private static final Set<TransformOption> DIRECT_ACCESS_URL_TRANSFORM_OPTIONS =
Set.of(new TransformOptionValue(false, DIRECT_ACCESS_URL));
private static final Set<TransformOption> DIRECT_ACCESS_URL_TRANSFORM_OPTIONS = Set.of(new TransformOptionValue(false, DIRECT_ACCESS_URL));
private static final Set<TransformOption> SOURCE_FILENAME_TRANSFORM_OPTIONS = Set.of(new TransformOptionValue(false, SOURCE_FILENAME));
/**
* Returns a new {@link TransformConfig} that includes or excludes the {@code coreVersion} field and
* associated elements like directAccessUrl.
* Returns a new {@link TransformConfig} that includes or excludes the {@code coreVersion} field and associated elements like directAccessUrl.
*/
public static TransformConfig setOrClearCoreVersion(TransformConfig transformConfig, int configVersion)
{
@@ -78,25 +80,25 @@ public class CoreVersionDecorator
transformConfig = TransformConfig.builder()
// We may need to create new Transformers as we must not change the original.
.withTransformers(transformConfig.getTransformers().stream()
.map(transformer -> {
if (( includeCoreVersion && transformer.getCoreVersion() == null) ||
(!includeCoreVersion && transformer.getCoreVersion() != null))
{
transformer = Transformer.builder()
.withCoreVersion(includeCoreVersion ? transformer.getCoreVersion() : null)
.withTransformOptions(setOrClearCoreTransformOptions(
includeCoreVersion ? transformer.getCoreVersion() : null,
transformer.getTransformOptions()))
// Original values
.withTransformerName(transformer.getTransformerName())
.withTransformerPipeline(transformer.getTransformerPipeline())
.withTransformerFailover(transformer.getTransformerFailover())
.withSupportedSourceAndTargetList(transformer.getSupportedSourceAndTargetList())
.build();
}
return transformer;
})
.collect(Collectors.toList()))
.map(transformer -> {
if ((includeCoreVersion && transformer.getCoreVersion() == null) ||
(!includeCoreVersion && transformer.getCoreVersion() != null))
{
transformer = Transformer.builder()
.withCoreVersion(includeCoreVersion ? transformer.getCoreVersion() : null)
.withTransformOptions(setOrClearCoreTransformOptions(
includeCoreVersion ? transformer.getCoreVersion() : null,
transformer.getTransformOptions()))
// Original values
.withTransformerName(transformer.getTransformerName())
.withTransformerPipeline(transformer.getTransformerPipeline())
.withTransformerFailover(transformer.getTransformerFailover())
.withSupportedSourceAndTargetList(transformer.getSupportedSourceAndTargetList())
.build();
}
return transformer;
})
.collect(Collectors.toList()))
.withTransformOptions(transformOptions)
// Original values
.withRemoveTransformers(transformConfig.getRemoveTransformers())
@@ -106,6 +108,7 @@ public class CoreVersionDecorator
.withSupportedDefaults(transformConfig.getSupportedDefaults())
.build();
addOrRemoveDirectAccessUrlOption(transformConfig.getTransformOptions(), transformConfig.getTransformers());
addOrRemoveSourceFileNameOption(transformConfig.getTransformOptions(), transformConfig.getTransformers());
return transformConfig;
}
@@ -113,19 +116,20 @@ public class CoreVersionDecorator
{
List<Transformer> transformers = transformConfig.getTransformers();
transformers.stream()
.filter(CoreVersionDecorator::isSingleStep)
.forEach(transformer -> {
.filter(CoreVersionDecorator::isSingleStep)
.forEach(transformer -> {
transformer.setCoreVersion(coreVersion);
transformer.setTransformOptions(setOrClearCoreTransformOptions(coreVersion, transformer.getTransformOptions()));
});
addOrRemoveDirectAccessUrlOption(transformConfig.getTransformOptions(), transformers);
addOrRemoveSourceFileNameOption(transformConfig.getTransformOptions(), transformers);
}
/**
* The list of {@code transformers} must not contain forward references
*/
*/
public static void setCoreVersionOnMultiStepTransformers(Map<String, Set<TransformOption>> transformOptions,
List<Transformer> transformers)
List<Transformer> transformers)
{
Map<String, Transformer> transformersByName = transformers.stream()
.collect(Collectors.toMap(Transformer::getTransformerName, Function.identity()));
@@ -137,8 +141,8 @@ public class CoreVersionDecorator
// Create a list of step transformers
List<String> namesOfStepTransformers = transformer.getTransformerFailover().isEmpty()
? transformer.getTransformerPipeline().stream()
.map(TransformStep::getTransformerName)
.collect(Collectors.toList())
.map(TransformStep::getTransformerName)
.collect(Collectors.toList())
: transformer.getTransformerFailover();
// Set the coreVersion to the lowest step transformer value
@@ -149,9 +153,10 @@ public class CoreVersionDecorator
String coreVersion = NO_VERSION.equals(minCoreVersion) ? null : minCoreVersion.toString();
transformer.setCoreVersion(coreVersion);
transformer.setTransformOptions(setOrClearCoreTransformOptions(transformer.getCoreVersion(),
transformer.getTransformOptions()));
transformer.getTransformOptions()));
});
addOrRemoveDirectAccessUrlOption(transformOptions, transformers);
addOrRemoveSourceFileNameOption(transformOptions, transformers);
}
private static Set<String> setOrClearCoreTransformOptions(String coreVersion, Set<String> transformerTransformOptions)
@@ -168,15 +173,24 @@ public class CoreVersionDecorator
{
transformerTransformOptions.remove(DIRECT_ACCESS_URL);
}
if (CoreFunction.SOURCE_FILENAME.isSupported(coreVersion))
{
// Add SOURCE_FILENAME to a copy of this Transformer's transform options.
transformerTransformOptions.add(SOURCE_FILENAME);
}
else
{
transformerTransformOptions.remove(SOURCE_FILENAME);
}
return transformerTransformOptions;
}
private static void addOrRemoveDirectAccessUrlOption(Map<String, Set<TransformOption>> transformOptions,
List<Transformer> transformers)
List<Transformer> transformers)
{
if (transformers.stream()
.anyMatch(transformer -> CoreFunction.DIRECT_ACCESS_URL.isSupported(transformer.getCoreVersion())))
.anyMatch(transformer -> CoreFunction.DIRECT_ACCESS_URL.isSupported(transformer.getCoreVersion())))
{
transformOptions.put(DIRECT_ACCESS_URL, DIRECT_ACCESS_URL_TRANSFORM_OPTIONS);
}
@@ -186,9 +200,23 @@ public class CoreVersionDecorator
}
}
private static void addOrRemoveSourceFileNameOption(Map<String, Set<TransformOption>> transformOptions,
List<Transformer> transformers)
{
if (transformers.stream()
.anyMatch(transformer -> CoreFunction.SOURCE_FILENAME.isSupported(transformer.getCoreVersion())))
{
transformOptions.put(SOURCE_FILENAME, SOURCE_FILENAME_TRANSFORM_OPTIONS);
}
else
{
transformOptions.remove(SOURCE_FILENAME);
}
}
private static boolean isSingleStep(Transformer transformer)
{
return (transformer.getTransformerFailover() == null || transformer.getTransformerFailover().isEmpty()) &&
(transformer.getTransformerPipeline() == null || transformer.getTransformerPipeline().isEmpty());
(transformer.getTransformerPipeline() == null || transformer.getTransformerPipeline().isEmpty());
}
}

122
model/src/main/java/org/alfresco/transform/registry/TransformRegistryHelper.java
View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Model
* %%
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* Copyright (C) 2005 - 2025 Alfresco Software Limited
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
@@ -21,10 +21,14 @@
*/
package org.alfresco.transform.registry;
import org.alfresco.transform.exceptions.TransformException;
import org.alfresco.transform.config.TransformOption;
import org.alfresco.transform.config.TransformOptionGroup;
import org.alfresco.transform.config.TransformOptionValue;
import static java.util.Collections.emptyList;
import static java.util.Collections.emptyMap;
import static java.util.Collections.emptySet;
import static java.util.Map.Entry;
import static org.springframework.http.HttpStatus.BAD_REQUEST;
import static org.alfresco.transform.common.RequestParamMap.*;
import java.util.ArrayList;
import java.util.HashMap;
@@ -34,23 +38,19 @@ import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
import static java.util.Collections.emptyList;
import static java.util.Collections.emptyMap;
import static java.util.Collections.emptySet;
import static java.util.Map.Entry;
import static org.alfresco.transform.common.RequestParamMap.SOURCE_ENCODING;
import static org.alfresco.transform.common.RequestParamMap.TIMEOUT;
import static org.springframework.http.HttpStatus.BAD_REQUEST;
import org.alfresco.transform.config.TransformOption;
import org.alfresco.transform.config.TransformOptionGroup;
import org.alfresco.transform.config.TransformOptionValue;
import org.alfresco.transform.exceptions.TransformException;
class TransformRegistryHelper
{
private TransformRegistryHelper()
{
}
{}
static Set<TransformOption> lookupTransformOptions(final Set<String> transformOptionNames,
final Map<String, Set<TransformOption>> transformOptions, final String readFrom,
final Consumer<String> logError)
final Map<String, Set<TransformOption>> transformOptions, final String readFrom,
final Consumer<String> logError)
{
if (transformOptionNames == null)
{
@@ -64,22 +64,20 @@ class TransformRegistryHelper
if (oneSetOfTransformOptions == null)
{
logError.accept("transformOptions in " + readFrom + " with the name " + name +
" does not exist. Ignored");
" does not exist. Ignored");
continue;
}
options.add(new TransformOptionGroup(false, oneSetOfTransformOptions));
}
return options.size() == 1 ?
((TransformOptionGroup) options.iterator().next()).getTransformOptions() :
options;
return options.size() == 1 ? ((TransformOptionGroup) options.iterator().next()).getTransformOptions() : options;
}
// Returns transformers in increasing supported size order, where lower priority transformers for the same size have
// been discarded.
static List<SupportedTransform> retrieveTransformListBySize(final TransformCache data,
final String sourceMimetype, final String targetMimetype,
Map<String, String> actualOptions, String renditionName)
final String sourceMimetype, final String targetMimetype,
Map<String, String> actualOptions, String renditionName)
{
if (actualOptions == null)
{
@@ -91,26 +89,27 @@ class TransformRegistryHelper
}
final List<SupportedTransform> cachedTransformList = renditionName == null
? null
: data.retrieveCached(renditionName, sourceMimetype);
? null
: data.retrieveCached(renditionName, sourceMimetype);
if (cachedTransformList != null)
{
return cachedTransformList;
}
// The transformOptions sometimes contains sourceEncoding and timeout, even though they should not be used
// The transformOptions sometimes contains sourceEncoding / timeout / file name, even though they should not be used
// to select a transformer. Would like to change this, but cannot as we need to support all ACS repo versions.
if (actualOptions.containsKey(SOURCE_ENCODING) || actualOptions.containsKey(TIMEOUT))
if (actualOptions.containsKey(SOURCE_ENCODING) || actualOptions.containsKey(TIMEOUT) || actualOptions.containsKey(SOURCE_FILENAME))
{
actualOptions = new HashMap<>(actualOptions);
actualOptions.remove(SOURCE_ENCODING);
actualOptions.remove(TIMEOUT);
actualOptions.remove(SOURCE_FILENAME);
}
final List<SupportedTransform> builtTransformList = buildTransformList(data,
sourceMimetype,
targetMimetype,
actualOptions);
sourceMimetype,
targetMimetype,
actualOptions);
if (renditionName != null)
{
@@ -121,17 +120,17 @@ class TransformRegistryHelper
}
private static List<SupportedTransform> buildTransformList(
final TransformCache data, final String sourceMimetype, final String targetMimetype,
final Map<String, String> actualOptions)
final TransformCache data, final String sourceMimetype, final String targetMimetype,
final Map<String, String> actualOptions)
{
if (sourceMimetype == null)
{
throw new TransformException(BAD_REQUEST, "Null value provided for sourceMimetype, please provide a value");
throw new TransformException(BAD_REQUEST, "Null value provided for sourceMimetype, please provide a value");
}
if (targetMimetype == null)
{
throw new TransformException(BAD_REQUEST, "Null value provided for targetMimetype, please provide a value");
throw new TransformException(BAD_REQUEST, "Null value provided for targetMimetype, please provide a value");
}
final Map<String, List<SupportedTransform>> targetMap = data.retrieveTransforms(sourceMimetype);
@@ -141,7 +140,7 @@ class TransformRegistryHelper
for (SupportedTransform supportedTransform : supportedTransformList)
{
final Map<String, Boolean> possibleTransformOptions = gatherPossibleTransformOptions(
supportedTransform.getTransformOptions(), actualOptions);
supportedTransform.getTransformOptions(), actualOptions);
if (optionsMatch(possibleTransformOptions, actualOptions))
{
@@ -154,8 +153,8 @@ class TransformRegistryHelper
// Add newTransform to the transformListBySize in increasing size order and discards
// lower priority (numerically higher) transforms with a smaller or equal size.
private static void addToSupportedTransformList(
final List<SupportedTransform> transformListBySize,
final SupportedTransform newTransform)
final List<SupportedTransform> transformListBySize,
final SupportedTransform newTransform)
{
if (transformListBySize.isEmpty())
{
@@ -211,7 +210,7 @@ class TransformRegistryHelper
{
if (comparePriority < 0)
{
if (i+1 < transformListBySize.size())
if (i + 1 < transformListBySize.size())
{
// Look at the next element as size is higher but the priority is lower.
continue;
@@ -248,7 +247,7 @@ class TransformRegistryHelper
// 1) the same priority but support a smaller size
// 2) those with a lower priority and a smaller size
if ((comparePriority == 0 && compareMaxSize >= 0) ||
(comparePriority > 0 && compareMaxSize >= 0))
(comparePriority > 0 && compareMaxSize >= 0))
{
transformListBySize.remove(i);
}
@@ -260,32 +259,29 @@ class TransformRegistryHelper
}
private static Map<String, Boolean> gatherPossibleTransformOptions(
final TransformOptionGroup transformOptionGroup, final Map<String, String> actualOptions)
final TransformOptionGroup transformOptionGroup, final Map<String, String> actualOptions)
{
final Map<String, Boolean> possibleTransformOptions = new HashMap<>();
addToPossibleTransformOptions(possibleTransformOptions, transformOptionGroup, true,
actualOptions);
actualOptions);
return possibleTransformOptions;
}
/**
* Flatten out the transform options by adding them to the supplied possibleTransformOptions.</p>
* Flatten out the transform options by adding them to the supplied possibleTransformOptions.
* </p>
*
* If possible discards options in the supplied transformOptionGroup if the group is optional and the actualOptions
* don't provide any of the options in the group. Or to put it another way:<p/>
* If possible discards options in the supplied transformOptionGroup if the group is optional and the actualOptions don't provide any of the options in the group. Or to put it another way:
* <p/>
*
* It adds individual transform options from the transformOptionGroup to possibleTransformOptions if the group is
* required or if the actualOptions include individual options from the group. As a result it is possible that none
* of the group are added if it is optional. It is also possible to add individual transform options that are
* themselves required but not in the actualOptions. In this the optionsMatch method will return false.
* It adds individual transform options from the transformOptionGroup to possibleTransformOptions if the group is required or if the actualOptions include individual options from the group. As a result it is possible that none of the group are added if it is optional. It is also possible to add individual transform options that are themselves required but not in the actualOptions. In this the optionsMatch method will return false.
*
* @return true if any options were added. Used by nested call parents to determine if an option was added from a
* nested sub group.
* @return true if any options were added. Used by nested call parents to determine if an option was added from a nested sub group.
*/
static boolean addToPossibleTransformOptions(
final Map<String, Boolean> possibleTransformOptions,
final TransformOptionGroup transformOptionGroup, final Boolean parentGroupRequired,
final Map<String, String> actualOptions)
final Map<String, Boolean> possibleTransformOptions,
final TransformOptionGroup transformOptionGroup, final Boolean parentGroupRequired,
final Map<String, String> actualOptions)
{
boolean added = false;
boolean required = false;
@@ -302,8 +298,8 @@ class TransformRegistryHelper
if (transformOption instanceof TransformOptionGroup)
{
added = addToPossibleTransformOptions(possibleTransformOptions,
(TransformOptionGroup) transformOption, transformOptionGroupRequired,
actualOptions);
(TransformOptionGroup) transformOption, transformOptionGroupRequired,
actualOptions);
required |= added;
}
else
@@ -340,15 +336,15 @@ class TransformRegistryHelper
}
static boolean optionsMatch(final Map<String, Boolean> transformOptions,
final Map<String, String> actualOptions)
final Map<String, String> actualOptions)
{
// Check all required transformOptions are supplied
final boolean supported = transformOptions
.entrySet()
.stream()
.filter(Entry::getValue)// filter by the required status
.map(Entry::getKey)// map to the option name
.allMatch(actualOptions::containsKey);
.entrySet()
.stream()
.filter(Entry::getValue)// filter by the required status
.map(Entry::getKey)// map to the option name
.allMatch(actualOptions::containsKey);
if (!supported)
{
@@ -357,8 +353,8 @@ class TransformRegistryHelper
// Check there are no extra unused actualOptions
return actualOptions
.keySet()
.stream()
.allMatch(transformOptions::containsKey);
.keySet()
.stream()
.allMatch(transformOptions::containsKey);
}
}

140
model/src/test/java/org/alfresco/transform/config/CoreVersionDecoratorTest.java
View File

@@ -21,8 +21,14 @@
*/
package org.alfresco.transform.config;
import com.google.common.collect.ImmutableList;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;
import static org.alfresco.transform.common.RequestParamMap.*;
import static org.alfresco.transform.config.CoreFunction.standardizeCoreVersion;
import static org.alfresco.transform.config.CoreVersionDecorator.CONFIG_VERSION_INCLUDES_CORE_VERSION;
import static org.alfresco.transform.config.CoreVersionDecorator.setCoreVersionOnMultiStepTransformers;
import static org.alfresco.transform.config.CoreVersionDecorator.setCoreVersionOnSingleStepTransformers;
import static org.alfresco.transform.config.CoreVersionDecorator.setOrClearCoreVersion;
import java.util.HashMap;
import java.util.HashSet;
@@ -30,14 +36,8 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
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.config.CoreFunction.standardizeCoreVersion;
import static org.alfresco.transform.config.CoreVersionDecorator.CONFIG_VERSION_INCLUDES_CORE_VERSION;
import static org.alfresco.transform.config.CoreVersionDecorator.setCoreVersionOnMultiStepTransformers;
import static org.alfresco.transform.config.CoreVersionDecorator.setCoreVersionOnSingleStepTransformers;
import static org.alfresco.transform.config.CoreVersionDecorator.setOrClearCoreVersion;
import static org.junit.jupiter.api.Assertions.*;
import com.google.common.collect.ImmutableList;
import org.junit.jupiter.api.Test;
class CoreVersionDecoratorTest
{
@@ -47,17 +47,27 @@ class CoreVersionDecoratorTest
public static final Set<TransformOption> SOME_OPTIONS = Set.of(new TransformOptionValue(false, "someOption"));
private static final Set<TransformOption> DIRECT_ACCESS_URL_OPTION = Set.of(new TransformOptionValue(false, DIRECT_ACCESS_URL));
private static final Set<TransformOption> SOURCE_FILENAME_OPTION = Set.of(new TransformOptionValue(false, SOURCE_FILENAME));
private final Map<String, Set<TransformOption>> TRANSFORM_OPTIONS_WITHOUT_DIRECT_ACCESS_URL = new HashMap<>();
private final Map<String, Set<TransformOption>> TRANSFORM_OPTIONS_WITH_DIRECT_ACCESS_URL = new HashMap<>();
private final Map<String, Set<TransformOption>> TRANSFORM_OPTIONS_WITHOUT_SOURCE_FILENAME = new HashMap<>();
private final Map<String, Set<TransformOption>> TRANSFORM_OPTIONS_WITH_SOURCE_FILENAME = new HashMap<>();
{
TRANSFORM_OPTIONS_WITHOUT_DIRECT_ACCESS_URL.put(SOME_NAME, SOME_OPTIONS);
TRANSFORM_OPTIONS_WITH_DIRECT_ACCESS_URL.put(SOME_NAME, SOME_OPTIONS);
TRANSFORM_OPTIONS_WITH_DIRECT_ACCESS_URL.put(DIRECT_ACCESS_URL, DIRECT_ACCESS_URL_OPTION);
TRANSFORM_OPTIONS_WITHOUT_SOURCE_FILENAME.put(SOME_NAME, SOME_OPTIONS);
TRANSFORM_OPTIONS_WITHOUT_SOURCE_FILENAME.put(DIRECT_ACCESS_URL, DIRECT_ACCESS_URL_OPTION);
TRANSFORM_OPTIONS_WITH_SOURCE_FILENAME.put(SOME_NAME, SOME_OPTIONS);
TRANSFORM_OPTIONS_WITH_SOURCE_FILENAME.put(DIRECT_ACCESS_URL, DIRECT_ACCESS_URL_OPTION);
TRANSFORM_OPTIONS_WITH_SOURCE_FILENAME.put(SOURCE_FILENAME, SOURCE_FILENAME_OPTION);
}
private TransformConfig newTransformConfig(String version1, String version2, String version3, String version4, String version5,
boolean hasDirectAccessUrls, boolean multiStepHaveDirectAccessUrls)
boolean hasDirectAccessUrls, boolean multiStepHaveDirectAccessUrls)
{
HashSet<String> transformOptions1 = new HashSet<>();
HashSet<String> transformOptions2 = new HashSet<>(transformOptions1);
@@ -151,7 +161,7 @@ class CoreVersionDecoratorTest
decoratedSingleStepTransformConfig.getTransformers());
assertEquals(newTransformConfig("2.1", "2.2", "1.2.3", "2.1", "1.2.3",
false, false), decoratedSingleStepTransformConfig);
// Some source T-Engines are pre coreVersion
decoratedSingleStepTransformConfig = newTransformConfig(
"2.1", null, null, null, null,
@@ -188,7 +198,7 @@ class CoreVersionDecoratorTest
setOrClearCoreVersion(transformConfigWithCoreVersion, CONFIG_VERSION_INCLUDES_CORE_VERSION));
assertEquals(newTransformConfig("2.1", "2.2", "1.2.3", "2.1", "1.2.3",
false, false),
setOrClearCoreVersion(transformConfigWithCoreVersion, CONFIG_VERSION_INCLUDES_CORE_VERSION+100));
setOrClearCoreVersion(transformConfigWithCoreVersion, CONFIG_VERSION_INCLUDES_CORE_VERSION + 100));
// Some source T-Engines are pre coreVersion
TransformConfig transformConfigWithoutCoreVersion = newTransformConfig(
@@ -223,4 +233,106 @@ class CoreVersionDecoratorTest
assertEquals("2", standardizeCoreVersion("2"));
assertEquals("2.5.7", standardizeCoreVersion("2.5.7-A-SNAPSHOT"));
}
}
private TransformConfig newTransformConfigForSourceFileName(String version1, String version2, String version3, String version4, String version5,
boolean hasSourceFilename, boolean multiStepHaveSourceFilename)
{
HashSet<String> transformOptions1 = new HashSet<>();
HashSet<String> transformOptions2 = new HashSet<>(transformOptions1);
transformOptions2.add(SOME_NAME);
HashSet<String> transformOptions3 = new HashSet<>(transformOptions1);
HashSet<String> transformOptions4 = new HashSet<>(transformOptions1);
transformOptions4.addAll(transformOptions2);
HashSet<String> transformOptions5 = new HashSet<>(transformOptions1);
transformOptions5.addAll(transformOptions2);
transformOptions5.addAll(transformOptions3);
transformOptions1.add(DIRECT_ACCESS_URL);
transformOptions2.add(DIRECT_ACCESS_URL);
transformOptions3.add(DIRECT_ACCESS_URL);
transformOptions4.add(DIRECT_ACCESS_URL);
transformOptions5.add(DIRECT_ACCESS_URL);
if (hasSourceFilename)
{
transformOptions1.add(SOURCE_FILENAME);
transformOptions2.add(SOURCE_FILENAME);
transformOptions3.add(SOURCE_FILENAME);
}
if (multiStepHaveSourceFilename)
{
transformOptions4.add(SOURCE_FILENAME);
transformOptions5.add(SOURCE_FILENAME);
}
return TransformConfig.builder()
.withTransformOptions(hasSourceFilename ? TRANSFORM_OPTIONS_WITH_SOURCE_FILENAME : TRANSFORM_OPTIONS_WITHOUT_SOURCE_FILENAME)
.withTransformers(ImmutableList.of(
Transformer.builder()
.withTransformerName("transformer1")
.withCoreVersion(version1)
.withTransformOptions(transformOptions1)
.build(),
Transformer.builder()
.withTransformerName("transformer2")
.withCoreVersion(version2)
.withTransformOptions(transformOptions2)
.build(),
Transformer.builder()
.withTransformerName("transformer3")
.withCoreVersion(version3)
.withTransformOptions(transformOptions3)
.build(),
Transformer.builder()
.withTransformerName("pipeline4")
.withCoreVersion(version4)
.withTransformerPipeline(List.of(
new TransformStep("transformer1", "mimetype/c"),
new TransformStep("transformer2", null)))
.withTransformOptions(transformOptions4)
.build(),
Transformer.builder()
.withTransformerName("failover5")
.withCoreVersion(version5)
.withTransformerFailover(List.of("transformer1", "transformer2", "transformer3"))
.withTransformOptions(transformOptions5)
.build()))
.build();
}
@Test
void setCoreVersionWithSourceFileNameOptionTest()
{
String sourceFileName = SOURCE_FILENAME;
// Create transform config with no SOURCE_FILENAME option
String sourceFileNameSupport = "5.1.8";
TransformConfig transformConfig = newTransformConfigForSourceFileName(
sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport,
sourceFileNameSupport, sourceFileNameSupport,
false, false);
// Add SOURCE_FILENAME to all single step transformers
setCoreVersionOnSingleStepTransformers(transformConfig, sourceFileNameSupport);
// Check that SOURCE_FILENAME is present in all single step transformers' options
assertEquals(newTransformConfigForSourceFileName("4.0.0", "4.0.0", "4.0.0", "4.0.0", "4.0.0",
false, false),
setOrClearCoreVersion(
newTransformConfigForSourceFileName("4.0.0", "4.0.0", "4.0.0", "4.0.0", "4.0.0",
false, false),
CONFIG_VERSION_INCLUDES_CORE_VERSION));
// Supported version: SOURCE_FILENAME should be present
assertEquals(newTransformConfigForSourceFileName(sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport,
true, true),
setOrClearCoreVersion(
newTransformConfigForSourceFileName(sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport, sourceFileNameSupport, true, true),
CONFIG_VERSION_INCLUDES_CORE_VERSION));
}
}