[ITB-578] Localisation support for non-UI APIs

Author: costas80

jsonvalidator-common/src/main/java/eu/europa/ec/itb/json/ApplicationConfig.java

@@ -18,14 +18,15 @@
 public class ApplicationConfig extends eu.europa.ec.itb.validation.commons.config.ApplicationConfig {
 
     private Set<String> acceptedSchemaExtensions;
-    private Map<String, String> defaultLabels = new HashMap<>();
+    private final Map<String, String> defaultLabels = new HashMap<>();
     private Set<String> acceptedMimeTypes;
     private String defaultContentToValidateDescription;
     private String defaultEmbeddingMethodDescription;
     private String defaultExternalSchemasDescription;
     private String defaultExternalSchemaCombinationApproachDescription;
     private String defaultValidationTypeDescription;
     private String defaultLocationAsPointerDescription;
+    private String defaultLocaleDescription;
     private Map<String, String> branchErrorMessages;
     private Set<String> branchErrorMessageValues;
 
@@ -169,6 +170,20 @@ public void setDefaultExternalSchemaCombinationApproachDescription(String defaul
         this.defaultExternalSchemaCombinationApproachDescription = defaultExternalSchemaCombinationApproachDescription;
     }
 
+    /**
+     * @return The default web service input description for the locale to use.
+     */
+    public String getDefaultLocaleDescription() {
+        return defaultLocaleDescription;
+    }
+
+    /**
+     * @param defaultLocaleDescription The default web service input description for the locale to use.
+     */
+    public void setDefaultLocaleDescription(String defaultLocaleDescription) {
+        this.defaultLocaleDescription = defaultLocaleDescription;
+    }
+
     /**
      * Initialise the configuration.
      */
@@ -182,6 +197,7 @@ public void init() {
         defaultLabels.put(ValidationConstants.INPUT_VALIDATION_TYPE, defaultValidationTypeDescription);
         defaultLabels.put(ValidationConstants.INPUT_LOCATION_AS_POINTER, defaultLocationAsPointerDescription);
         defaultLabels.put(ValidationConstants.INPUT_EXTERNAL_SCHEMA_COMBINATION_APPROACH, defaultExternalSchemaCombinationApproachDescription);
+        defaultLabels.put(ValidationConstants.INPUT_LOCALE, defaultLocaleDescription);
         // Branch error messages.
         branchErrorMessageValues = new HashSet<>(getBranchErrorMessages().values());
     }

jsonvalidator-common/src/main/java/eu/europa/ec/itb/json/validation/ValidationConstants.java

@@ -21,4 +21,7 @@ public class ValidationConstants {
     public static String INPUT_EXTERNAL_SCHEMA_COMBINATION_APPROACH = "externalSchemaCombinationApproach";
     /** Whether the validated content should be added to the TAR report. */
     public static String INPUT_ADD_INPUT_TO_REPORT = "addInputToReport";
+    /** The locale string to consider. */
+    public static String INPUT_LOCALE = "locale";
+
 }

jsonvalidator-common/src/main/resources/application.properties

@@ -41,6 +41,7 @@ validator.defaultValidationTypeDescription = The type of validation to perform (
 validator.defaultExternalSchemasDescription = A list of maps that defines external schemas to consider in addition to any preconfigured ones. Each map item corresponds to a schema file and defines the following keys: 'content' (the schema content to consider, see 'contentToValidate' for its semantics), 'embeddingMethod' (the way to consider the 'content' value).
 validator.defaultLocationAsPointerDescription = Whether or not the location reported for returned errors will be a JSON pointer (default false). False will return the line number in the input.
 validator.defaultSchemaCombinationApproachDescription = The way to combine externally provided schemas in case multiple are defined ('allOf', 'anyOf', 'oneOf'). Default is 'allOf'.
+validator.defaultLocaleDescription = Locale (language code) to use for reporting of results. If the provided locale is not supported by the validator the default locale will be used instead (e.g. "fr", "fr_FR").
 # Special engine messages for branch reporting.
 validator.branchErrorMessages.anyOf = At least one of the following sets of problems must be resolved.
 validator.branchErrorMessages.oneOf = Exactly one of the following sets of problems must be resolved.

jsonvalidator-jar/src/main/java/eu/europa/ec/itb/json/standalone/ValidationRunner.java

@@ -6,23 +6,21 @@
 import eu.europa.ec.itb.json.validation.JSONValidator;
 import eu.europa.ec.itb.validation.commons.FileInfo;
 import eu.europa.ec.itb.validation.commons.LocalisationHelper;
+import eu.europa.ec.itb.validation.commons.Utils;
 import eu.europa.ec.itb.validation.commons.artifact.ValidationArtifactCombinationApproach;
 import eu.europa.ec.itb.validation.commons.error.ValidatorException;
 import eu.europa.ec.itb.validation.commons.jar.BaseValidationRunner;
 import eu.europa.ec.itb.validation.commons.jar.FileReport;
 import eu.europa.ec.itb.validation.commons.jar.ValidationInput;
 import eu.europa.ec.itb.validation.commons.report.ReportGeneratorBean;
-import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.LocaleUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Component;
 
-import javax.annotation.PostConstruct;
 import java.io.File;
 import java.io.IOException;
-import java.net.MalformedURLException;
-import java.net.URL;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -42,6 +40,7 @@ public class ValidationRunner extends BaseValidationRunner<DomainConfig> {
     private static final String FLAG__INPUT = "-input";
     private static final String FLAG__SCHEMA = "-schema";
     private static final String FLAG__SCHEMA_COMBINATION = "-combination";
+    private static final String FLAG__LOCALE = "-locale";
     private static final ValidationArtifactCombinationApproach DEFAULT_COMBINATION_APPROACH = ValidationArtifactCombinationApproach.ALL;
 
     @Autowired
@@ -65,6 +64,7 @@ protected void bootstrapInternal(String[] args, File parentFolder) {
         List<FileInfo> externalSchemaFileInfo = new ArrayList<>();
         boolean noReports = false;
         String validationType = null;
+        String locale = null;
         ValidationArtifactCombinationApproach externalSchemaCombinationApproach = DEFAULT_COMBINATION_APPROACH;
         try {
             int i = 0;
@@ -89,6 +89,10 @@ protected void bootstrapInternal(String[] args, File parentFolder) {
                     if (args.length > i + 1) {
                         externalSchemaCombinationApproach = ValidationArtifactCombinationApproach.byName(args[++i]);
                     }
+                } else if (FLAG__LOCALE.equalsIgnoreCase(args[i])) {
+                    if (args.length > i+1) {
+                        locale = args[++i];
+                    }
                 }
                 i++;
             }
@@ -119,10 +123,11 @@ protected void bootstrapInternal(String[] args, File parentFolder) {
             StringBuilder summary = new StringBuilder();
             summary.append("\n");
             int i = 0;
+            var localiser = new LocalisationHelper(domainConfig, Utils.getSupportedLocale(LocaleUtils.toLocale(locale), domainConfig));
             for (ValidationInput input: inputs) {
                 LOGGER_FEEDBACK.info(String.format("\nValidating %s of %s ...", i+1, inputs.size()));
                 try {
-                    JSONValidator validator = ctx.getBean(JSONValidator.class, input.getInputFile(), validationType, externalSchemaFileInfo, externalSchemaCombinationApproach, domainConfig, new LocalisationHelper(domainConfig, Locale.ENGLISH), false);
+                    JSONValidator validator = ctx.getBean(JSONValidator.class, input.getInputFile(), validationType, externalSchemaFileInfo, externalSchemaCombinationApproach, domainConfig, localiser, false);
                     TAR report = validator.validate();
                     if (report == null) {
                         summary.append("\nNo validation report was produced.\n");
@@ -142,7 +147,7 @@ protected void bootstrapInternal(String[] args, File parentFolder) {
                                 // Create PDF report
                                 File pdfReportFile = new File(xmlReportFile.getParentFile(), "report."+i+".pdf");
                                 Files.deleteIfExists(pdfReportFile.toPath());
-                                reportGenerator.writeReport(xmlReportFile, pdfReportFile, new LocalisationHelper(domainConfig, Locale.ENGLISH));
+                                reportGenerator.writeReport(xmlReportFile, pdfReportFile, localiser);
                                 summary.append("- Detailed reports in [").append(xmlReportFile.getAbsolutePath()).append("] and [").append(pdfReportFile.getAbsolutePath()).append("] \n");
                             } else if (report.getCounters() != null && (report.getCounters().getNrOfAssertions().longValue() + report.getCounters().getNrOfErrors().longValue() + report.getCounters().getNrOfWarnings().longValue()) <= domainConfig.getMaximumReportsForXmlOutput()) {
                                 summary.append("- Detailed report in [").append(xmlReportFile.getAbsolutePath()).append("] (PDF report skipped due to large number of report items) \n");
@@ -152,7 +157,7 @@ protected void bootstrapInternal(String[] args, File parentFolder) {
                         }
                     }
                 } catch (ValidatorException e) {
-                    LOGGER_FEEDBACK.info("\nAn error occurred while executing the validation: "+e.getMessageForDisplay(new LocalisationHelper(domainConfig, Locale.ENGLISH)));
+                    LOGGER_FEEDBACK.info("\nAn error occurred while executing the validation: "+e.getMessageForDisplay(localiser));
                     LOGGER.error("An error occurred while executing the validation: "+e.getMessageForLog(), e);
                     break;
 
@@ -207,7 +212,7 @@ private File getContent(String contentPath, File parentFolder) throws IOExceptio
     private void printUsage(boolean requireType) {
         StringBuilder usageMessage = new StringBuilder();
         StringBuilder parametersMessage = new StringBuilder();
-        usageMessage.append("\nExpected usage: java -jar validator.jar ").append(FLAG__INPUT).append(" FILE_OR_URI_1 ... [").append(FLAG__INPUT).append(" FILE_OR_URI_N] [").append(FLAG__NO_REPORTS).append("]");
+        usageMessage.append("\nExpected usage: java -jar validator.jar ").append(FLAG__INPUT).append(" FILE_OR_URI_1 ... [").append(FLAG__INPUT).append(" FILE_OR_URI_N] [").append(FLAG__NO_REPORTS).append("] [").append(FLAG__LOCALE).append(" LOCALE]");
         if (requireType) {
             usageMessage.append(" [").append(FLAG__VALIDATION_TYPE).append(" VALIDATION_TYPE]");
             parametersMessage.append("\n").append(PAD).append(PAD).append("- VALIDATION_TYPE is the type of validation to perform, one of [").append(String.join("|", domainConfig.getType())).append("].");
@@ -222,6 +227,7 @@ private void printUsage(boolean requireType) {
         }
         usageMessage.append("\n").append(PAD).append("Where:");
         usageMessage.append("\n").append(PAD).append(PAD).append("- FILE_OR_URI_X is the full file path or URI to the content to validate.");
+        usageMessage.append("\n").append(PAD).append(PAD).append("- LOCALE is the language code to consider for reporting of results. If the provided locale is not supported by the validator the default locale will be used instead (e.g. 'fr', 'fr_FR').");
         usageMessage.append(parametersMessage);
         usageMessage.append("\n\nThe summary of each validation will be printed and the detailed reports produced in the current directory (as \"report.X.xml\" and \"report.X.pdf\").");
         System.out.println(usageMessage);

jsonvalidator-service/src/main/java/eu/europa/ec/itb/json/gitb/ValidationServiceImpl.java

@@ -11,11 +11,12 @@
 import eu.europa.ec.itb.validation.commons.FileInfo;
 import eu.europa.ec.itb.validation.commons.LocalisationHelper;
 import eu.europa.ec.itb.validation.commons.Utils;
-import eu.europa.ec.itb.validation.commons.error.ValidatorException;
 import eu.europa.ec.itb.validation.commons.artifact.ExternalArtifactSupport;
 import eu.europa.ec.itb.validation.commons.artifact.TypedValidationArtifactInfo;
 import eu.europa.ec.itb.validation.commons.artifact.ValidationArtifactCombinationApproach;
+import eu.europa.ec.itb.validation.commons.error.ValidatorException;
 import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.LocaleUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
@@ -27,10 +28,8 @@
 import javax.annotation.Resource;
 import javax.jws.WebParam;
 import javax.xml.ws.WebServiceContext;
-
 import java.io.File;
 import java.util.List;
-import java.util.Locale;
 
 /**
  * Spring component that realises the validation SOAP service.
@@ -87,6 +86,7 @@ public GetModuleDefinitionResponse getModuleDefinition(@WebParam(name = "GetModu
         }
         response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_LOCATION_AS_POINTER, "boolean", UsageEnumeration.O, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_LOCATION_AS_POINTER)));
         response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_ADD_INPUT_TO_REPORT, "boolean", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_ADD_INPUT_TO_REPORT)));
+        response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_LOCALE, "string", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_LOCALE)));
         return response;
     }
 
@@ -117,6 +117,7 @@ private boolean definesTypeWithExternalSchemas() {
     public ValidationResponse validate(@WebParam(name = "ValidateRequest", targetNamespace = "http://www.gitb.com/vs/v1/", partName = "parameters") ValidateRequest validateRequest) {
     	MDC.put("domain", domainConfig.getDomain());
     	File tempFolderPath = fileManager.createTemporaryFolderPath();
+        var localiser = new LocalisationHelper(domainConfig, Utils.getSupportedLocale(LocaleUtils.toLocale(getInputAsString(validateRequest, ValidationConstants.INPUT_LOCALE, null)), domainConfig));
     	try {
 			// Validation of the input data
 			ValueEmbeddingEnumeration contentEmbeddingMethod = inputHelper.validateContentEmbeddingMethod(validateRequest, ValidationConstants.INPUT_EMBEDDING_METHOD);
@@ -128,15 +129,15 @@ public ValidationResponse validate(@WebParam(name = "ValidateRequest", targetNam
             ValidationArtifactCombinationApproach externalSchemaCombinationApproach = validateExternalSchemaCombinationApproach(validateRequest, validationType);
             ValidationResponse result = new ValidationResponse();
 			// Execute validation
-            JSONValidator validator = ctx.getBean(JSONValidator.class, contentToValidate, validationType, externalSchemas, externalSchemaCombinationApproach, domainConfig, new LocalisationHelper(domainConfig, Locale.ENGLISH), locationAsPointer, addInputToReport);
+            JSONValidator validator = ctx.getBean(JSONValidator.class, contentToValidate, validationType, externalSchemas, externalSchemaCombinationApproach, domainConfig, localiser, locationAsPointer, addInputToReport);
 			result.setReport(validator.validate());
 			return result;
         } catch (ValidatorException e) {
             logger.error(e.getMessageForLog(), e);
-            throw new ValidatorException(e.getMessageForDisplay(new LocalisationHelper(Locale.ENGLISH)), true);
+            throw new ValidatorException(e.getMessageForDisplay(localiser), true);
 		} catch (Exception e) {
 			logger.error("Unexpected error", e);
-            var message = new LocalisationHelper(Locale.ENGLISH).localise(ValidatorException.MESSAGE_DEFAULT);
+            var message = localiser.localise(ValidatorException.MESSAGE_DEFAULT);
             throw new ValidatorException(message, e, true, (Object[]) null);
 		} finally {
     	    // Cleanup.
@@ -184,6 +185,22 @@ private boolean getInputAsBoolean(ValidateRequest validateRequest, String inputN
         return defaultIfMissing;
     }
 
+    /**
+     * Get the provided (optional) input as a string value.
+     *
+     * @param validateRequest The input parameters.
+     * @param inputName The name of the input to look for.
+     * @param defaultIfMissing The default value to use if the input is not provided.
+     * @return The value to use.
+     */
+    private String getInputAsString(ValidateRequest validateRequest, String inputName, String defaultIfMissing) {
+        List<AnyContent> input = Utils.getInputFor(validateRequest, inputName);
+        if (!input.isEmpty()) {
+            return input.get(0).getValue();
+        }
+        return defaultIfMissing;
+    }
+
     /**
      * @return The web service context.
      */

jsonvalidator-service/src/test/java/eu/europa/ec/itb/json/gitb/ValidationServiceImplTest.java

@@ -34,15 +34,16 @@ void testGetModuleDefinition() {
                 ValidationConstants.INPUT_EMBEDDING_METHOD, "Description of INPUT_EMBEDDING_METHOD",
                 ValidationConstants.INPUT_VALIDATION_TYPE, "Description of INPUT_VALIDATION_TYPE",
                 ValidationConstants.INPUT_LOCATION_AS_POINTER, "Description of INPUT_LOCATION_AS_POINTER",
-                ValidationConstants.INPUT_ADD_INPUT_TO_REPORT, "Description of INPUT_ADD_INPUT_TO_REPORT"
+                ValidationConstants.INPUT_ADD_INPUT_TO_REPORT, "Description of INPUT_ADD_INPUT_TO_REPORT",
+                ValidationConstants.INPUT_LOCALE, "Description of INPUT_LOCALE"
         )).when(domainConfig).getWebServiceDescription();
         var service = new ValidationServiceImpl(domainConfig);
         var result = service.getModuleDefinition(new Void());
         assertNotNull(result);
         assertNotNull(result.getModule());
         assertEquals("service1", result.getModule().getId());
         assertNotNull(result.getModule().getInputs());
-        assertEquals(5, result.getModule().getInputs().getParam().size());
+        assertEquals(6, result.getModule().getInputs().getParam().size());
         assertEquals(ValidationConstants.INPUT_CONTENT, result.getModule().getInputs().getParam().get(0).getName());
         assertEquals("Description of INPUT_CONTENT", result.getModule().getInputs().getParam().get(0).getDesc());
         assertEquals(UsageEnumeration.R, result.getModule().getInputs().getParam().get(0).getUse());
@@ -57,6 +58,8 @@ void testGetModuleDefinition() {
         assertEquals(UsageEnumeration.O, result.getModule().getInputs().getParam().get(3).getUse());
         assertEquals("Description of INPUT_ADD_INPUT_TO_REPORT", result.getModule().getInputs().getParam().get(4).getDesc());
         assertEquals(UsageEnumeration.O, result.getModule().getInputs().getParam().get(4).getUse());
+        assertEquals("Description of INPUT_LOCALE", result.getModule().getInputs().getParam().get(5).getDesc());
+        assertEquals(UsageEnumeration.O, result.getModule().getInputs().getParam().get(5).getUse());
     }
 
 }