Upgraded json-schema-validator to v2.0.0

Author: costas80

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

@@ -24,8 +24,12 @@
 import com.gitb.vs.ValidateRequest;
 import com.gitb.vs.ValidationResponse;
 import com.networknt.schema.*;
+import com.networknt.schema.Error;
+import com.networknt.schema.dialect.Dialects;
 import com.networknt.schema.i18n.ResourceBundleMessageSource;
-import com.networknt.schema.serialization.JsonNodeReader;
+import com.networknt.schema.path.PathType;
+import com.networknt.schema.serialization.DefaultNodeReader;
+import com.networknt.schema.serialization.NodeReader;
 import com.networknt.schema.utils.JsonNodes;
 import eu.europa.ec.itb.json.DomainConfig;
 import eu.europa.ec.itb.validation.commons.*;
@@ -35,7 +39,7 @@
 import eu.europa.ec.itb.validation.plugin.PluginManager;
 import eu.europa.ec.itb.validation.plugin.ValidationPlugin;
 import org.apache.commons.io.FileUtils;
-import org.apache.commons.lang3.Strings;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.tuple.Pair;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -311,29 +315,24 @@ private void addBranchErrors(List<Message> aggregatedMessages, List<Message> bra
      * @param path The schema path.
      * @return The parsed schema and JSON node reader to use.
      */
-    private Pair<JsonSchema, JsonNodeReader> readSchema(Path path) {
+    private Pair<Schema, NodeReader> readSchema(Path path) {
         try {
             var jsonNode = objectMapper.readTree(path.toFile());
-            var jsonSchemaVersion = JsonSchemaFactory.checkVersion(SpecVersionDetector.detect(jsonNode));
-            var metaSchema = jsonSchemaVersion.getInstance();
-            /*
-             * The schema factory is created per validation. This is done to avoid caching of schemas across validations that
-             * may be remotely loaded or schemas that are user-provided. In addition, it allows us to treat schemas that
-             * may use different specification versions.
-             */
             var jsonReader = getJsonReader();
-            var schemaFactory = JsonSchemaFactory.builder()
-                    .schemaLoaders(schemaLoaders -> schemaLoaders.add(new LocalSchemaResolver(specs.getDomainConfig(), localSchemaCache)))
-                    .metaSchema(metaSchema)
-                    .defaultMetaSchemaIri(metaSchema.getIri())
-                    .jsonNodeReader(jsonReader)
-                    .build();
-            var schemaConfig = SchemaValidatorsConfig.builder()
+            var registryConfig = SchemaRegistryConfig.builder()
+                    .cacheRefs(false)
                     .pathType(PathType.JSON_POINTER)
                     .locale(specs.getLocalisationHelper().getLocale())
                     .messageSource(new ResourceBundleMessageSource("i18n/jsv-messages"))
                     .build();
-            return Pair.of(schemaFactory.getSchema(jsonNode, schemaConfig), jsonReader);
+            var registry = SchemaRegistry.builder()
+                    .defaultDialectId(Dialects.getDraft202012().getId())
+                    .schemaRegistryConfig(registryConfig)
+                    .schemaCacheEnabled(false)
+                    .nodeReader(jsonReader)
+                    .resourceLoaders(builder -> builder.add(new LocalSchemaResolver(specs.getDomainConfig(), localSchemaCache)))
+                    .build();
+            return Pair.of(registry.getSchema(jsonNode), jsonReader);
         } catch (IOException e) {
             throw new ValidatorException("validator.label.exception.failedToParseJSONSchema", e, e.getMessage());
         }
@@ -344,20 +343,20 @@ private Pair<JsonSchema, JsonNodeReader> readSchema(Path path) {
      *
      * @return The reader.
      */
-    private JsonNodeReader getJsonReader() {
-        var jsonReaderBuilder = JsonNodeReader.builder();
+    private NodeReader getJsonReader() {
+        var jsonReaderBuilder = DefaultNodeReader.builder();
         if (!specs.isLocationAsPointer()) {
             jsonReaderBuilder = jsonReaderBuilder.locationAware();
         }
         return jsonReaderBuilder.build();
     }
 
-    private Function<ValidationMessage, String> getLocationMapper() {
+    private Function<Error, String> getLocationMapper() {
         if (specs.isLocationAsPointer()) {
             return msg -> msg.getInstanceLocation().toString();
         } else {
             return msg -> {
-                var nodeLocation = JsonNodes.tokenLocationOf(msg.getInstanceNode());
+                var nodeLocation = JsonNodes.tokenStreamLocationOf(msg.getInstanceNode());
                 int lineNumber = 0;
                 if (nodeLocation != null && nodeLocation.getLineNr() > 0) {
                     lineNumber = nodeLocation.getLineNr();
@@ -376,18 +375,30 @@ private Function<ValidationMessage, String> getLocationMapper() {
     private List<Message> validateAgainstSchema(File schemaFile) {
         var schemaInfo = readSchema(schemaFile.toPath());
         var locationMapper = getLocationMapper();
-        return schemaInfo.getLeft().validate(getContentNode(schemaInfo.getRight())).stream().map(message -> new Message(Strings.CS.removeStart(message.getMessage(), "[] "), locationMapper.apply(message))).toList();
+        return schemaInfo.getLeft().validate(getContentNode(schemaInfo.getRight())).stream().map(error -> {
+            String pathPrefix = null;
+            if (error.getInstanceLocation() != null) {
+                pathPrefix = error.getInstanceLocation().toString();
+            } else if (error.getSchemaLocation() != null) {
+                pathPrefix = error.getSchemaLocation().toString();
+            }
+            if (StringUtils.isNotEmpty(pathPrefix)) {
+                return new Message("["+pathPrefix+"] "+error.getMessage(), locationMapper.apply(error));
+            } else {
+                return new Message(error.getMessage(), locationMapper.apply(error));
+            }
+        }).toList();
     }
 
     /**
      * Parse the JSON node for the provided input file.
      *
      * @return The JSON node.
      */
-    private JsonNode getContentNode(JsonNodeReader reader) {
+    private JsonNode getContentNode(NodeReader reader) {
         if (contentNode == null) {
             if (reader == null) {
-                reader = JsonNodeReader.builder().build();
+                reader = DefaultNodeReader.builder().build();
             }
             try (var input = Files.newInputStream(specs.getInputFileToUse().toPath())) {
                 contentNode = reader.readTree(input, specs.isYaml()?InputFormat.YAML:InputFormat.JSON);

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

@@ -17,8 +17,8 @@
 
 import com.networknt.schema.AbsoluteIri;
 import com.networknt.schema.resource.InputStreamSource;
-import com.networknt.schema.resource.SchemaLoader;
-import com.networknt.schema.resource.UriSchemaLoader;
+import com.networknt.schema.resource.IriResourceLoader;
+import com.networknt.schema.resource.ResourceLoader;
 import eu.europa.ec.itb.json.DomainConfig;
 import org.apache.commons.lang3.Strings;
 import org.slf4j.Logger;
@@ -29,11 +29,10 @@
 /**
  * Custom schema resolver that loads schemas defined as local references.
  */
-public class LocalSchemaResolver implements SchemaLoader {
+public class LocalSchemaResolver implements ResourceLoader {
 
     private static final Logger LOG = LoggerFactory.getLogger(LocalSchemaResolver.class);
 
-    private final UriSchemaLoader uriSchemaLoader = new UriSchemaLoader();
     private final DomainConfig domain;
     private final LocalSchemaCache localSchemaCache;
 
@@ -55,15 +54,16 @@ public LocalSchemaResolver(DomainConfig domain, LocalSchemaCache localSchemaCach
      * @return The resolved schema or null if none could be resolved from the configured shared schema references.
      */
     @Override
-    public InputStreamSource getSchema(AbsoluteIri absoluteIri) {
+    public InputStreamSource getResource(AbsoluteIri absoluteIri) {
         String idToCheck = Strings.CS.appendIfMissing(absoluteIri.toString(), "#");
         var schema = localSchemaCache.getSchemaForId(domain, idToCheck);
         if (schema.isEmpty()) {
             LOG.debug("Schema with URI {} not found locally. Looking up remotely.", absoluteIri);
-            return uriSchemaLoader.getSchema(absoluteIri);
+            return IriResourceLoader.getInstance().getResource(absoluteIri);
         } else {
             LOG.debug("Schema with URI {} found locally.", absoluteIri);
             return () -> Files.newInputStream(schema.get());
         }
     }
+
 }

jsonvalidator-common/src/main/resources/i18n/jsv-messages.properties

@@ -1,70 +1,73 @@
-$ref = [{0}] Error with referenced schema.
-const = [{0}] Expected value ''{1}''.
-contains=[{0}] No element was found passing these validations: {2}
-dependencies = [{0}] Error with dependencies {1}.
-dependentRequired = [{0}] Property ''{1}'' is missing which is required because ''{2}'' is present.
-dependentSchemas = [{0}] Error with dependent schemas {1}.
-enum = [{0}] Unexpected value found. Valid values are {1}.
-format = [{0}] Value does not match the {1} pattern {2}
-id = [{0}] ''{1}'' is an invalid segment for URI {2}
-maxItems = [{0}] The size of the array must be at most {1}.
-minItems = [{0}] The size of the array must be at least {1}.
-maxLength = [{0}] The value''s length must be at most {1}.
-minLength = [{0}] The value''s length must be at least {1}.
-maxProperties = [{0}] The number of defined properties must be at most {1}.
-minProperties = [{0}] The number of defined properties must be at least {1}.
-maximum = [{0}] Value must be less than or equal to {1}.
-minimum = [{0}] Value must be greater than or equal to {1}.
-exclusiveMaximum = [{0}] Value must be less than {1}.
-exclusiveMinimum = [{0}] Value must be greater than {1}.
-multipleOf = [{0}] Value must be a multiple of {1}.
-pattern = [{0}] Value does not match the regex pattern {1}.
-patternProperties = [{0}] The object does not match defined property patterns.
-prefixItems = [{0}] No validator found at this index.
-properties = [{0}] The object has an error in its defined properties.
-readOnly = [{0}] Property is readonly and cannot be changed.
-required = [{0}] Missing required property ''{1}''.
-type = [{0}] Expected {2} but found {1}.
-unionType = [{0}] Expected {2} but found {1}.
-uniqueItems = [{0}] The items in the array must be unique.
-contains.max = [{0}] Must contain fewer than {1} element(s) that pass these validations: {2}
-contains.min = [{0}] Must contain at least {1} element(s) that pass these validations: {2}
-maxContains = [{0}] Must be a non-negative integer in {1}.
-minContains = [{0}] Must be a non-negative integer in {1}.
-minContainsVsMaxContains = [{0}] minContains must less than or equal to maxContains in {1}.
-writeOnly = [{0}] Write-only field that cannot appear in the data.
-contentEncoding = [{0}] Does not match content encoding {1}.
+$ref = Error with referenced schema.
+const = Expected value ''{0}''.
+contains=No element was found passing these validations: {1}
+dependencies = Error with dependencies {0}.
+dependentRequired = Property ''{0}'' is missing which is required because ''{1}'' is present.
+dependentSchemas = Error with dependent schemas {0}.
+enum = Unexpected value found. Valid values are {0}.
+format = Value does not match the {0} pattern {1}
+id = ''{0}'' is an invalid segment for URI {1}
+maxItems = The size of the array must be at most {0}.
+minItems = The size of the array must be at least {0}.
+maxLength = The value''s length must be at most {0}.
+minLength = The value''s length must be at least {0}.
+maxProperties = The number of defined properties must be at most {0}.
+minProperties = The number of defined properties must be at least {0}.
+maximum = Value must be less than or equal to {0}.
+minimum = Value must be greater than or equal to {0}.
+exclusiveMaximum = Value must be less than {0}.
+exclusiveMinimum = Value must be greater than {0}.
+multipleOf = Value must be a multiple of {0}.
+pattern = Value does not match the regex pattern {0}.
+patternProperties = The object does not match defined property patterns.
+prefixItems = No validator found at this index.
+properties = The object has an error in its defined properties.
+readOnly = Property is readonly and cannot be changed.
+required = Missing required property ''{0}''.
+type = Expected {1} but found {0}.
+unionType = Expected {1} but found {0}.
+uniqueItems = The items in the array must be unique.
+contains.max = Must contain fewer than {0} element(s) that pass these validations: {1}
+contains.min = Must contain at least {0} element(s) that pass these validations: {1}
+maxContains = Must be a non-negative integer in {0}.
+minContains = Must be a non-negative integer in {0}.
+minContainsVsMaxContains = minContains must less than or equal to maxContains in {0}.
+writeOnly = Write-only field that cannot appear in the data.
+contentEncoding = Does not match content encoding {0}.
 contentMediaType = {0} is not a content media type.
-additionalProperties = [{0}] Property ''{1}'' not defined in the schema and additional properties are not allowed.
-allOf = [{0}] Node must be valid for all its defined schemas {1}.
-anyOf = [{0}] Node must be valid for any of its defined schemas {1}.
-oneOf = [{0}] Node must be valid for only one of its defined schemas, but it was valid for {1} schemas.
-oneOf.indexes = [{0}] Node must be valid for only one of its defined schemas, but it was valid for {1} schemas with indexes ''{2}''.
-false = [{0}] Considered by default as invalid.
-items = [{0}] Index ''{1}'' is not defined in the schema and additional items are not allowed.
-not = [{0}] Node must not be valid for the schema {1}.
-notAllowed = [{0}] Property ''{1}'' is not allowed here.
-propertyNames = [{0}] Property name ''{1}'' is invalid: {2}
-unevaluatedProperties = [{0}] Property ''{1}'' must not be unevaluated.
-unevaluatedItems=[{0}] Item at index {1} must not be unevaluated or must match the schema for unevaluated items.
-additionalItems = [{0}] Index ''{1}'' is not defined in the schema and additional items are not allowed.
-format.date = [{0}] Value does not match the {1} pattern (must be a valid RFC 3339 full-date).
-format.date-time = [{0}] Value does not match the {1} pattern (must be a valid RFC 3339 date-time).
-format.duration = [{0}] Value does not match the {1} pattern (must be a valid ISO 8601 duration).
-format.email = [{0}] Value does not match the {1} pattern (must be a valid RFC 5321 Mailbox).
-format.ipv4 = [{0}] Value does not match the {1} pattern (must be a valid RFC 2673 IP address).
-format.ipv6 = [{0}] Value does not match the {1} pattern (must be a valid RFC 4291 IP address).
-format.idn-email = [{0}] Value does not match the {1} pattern (must be a valid RFC 6531 Mailbox).
-format.idn-hostname = [{0}] Value does not match the {1} pattern (must be a valid RFC 5890 internationalized hostname).
-format.iri = [{0}] Value does not match the {1} pattern (must be a valid RFC 3987 IRI).
-format.iri-reference = [{0}] Value does not match the {1} pattern (must be a valid RFC 3987 IRI-reference).
-format.uri = [{0}] Value does not match the {1} pattern (must be a valid RFC 3986 URI).
-format.uri-reference = [{0}] Value does not match the {1} pattern (must be a valid RFC 3986 URI-reference).
-format.uri-template = [{0}] Value does not match the {1} pattern (must be a valid RFC 6570 URI Template).
-format.uuid = [{0}] Value does not match the {1} pattern (must be a valid RFC 4122 UUID).
-format.regex = [{0}] Value does not match the {1} pattern (must be a valid ECMA-262 regular expression).
-format.time = [{0}] Value does not match the {1} pattern (must be a valid RFC 3339 time).
-format.hostname = [{0}] Value does not match the {1} pattern (must be a valid RFC 1123 host name).
-format.json-pointer = [{0}] Value does not match the {1} pattern (must be a valid RFC 6901 JSON Pointer).
-format.relative-json-pointer = [{0}] Value does not match the {1} pattern (must be a valid IETF Relative JSON Pointer).
-format.unknown = [{0}] has an unknown format ''{1}''.
+additionalProperties = Property ''{0}'' not defined in the schema and additional properties are not allowed.
+allOf = Node must be valid for all its defined schemas {0}.
+anyOf = Node must be valid for any of its defined schemas {0}.
+oneOf = Node must be valid for only one of its defined schemas, but it was valid for {0} schemas.
+oneOf.indexes = Node must be valid for only one of its defined schemas, but it was valid for {0} schemas with indexes ''{1}''.
+false = Considered by default as invalid.
+items = Index ''{0}'' is not defined in the schema and additional items are not allowed.
+not = Node must not be valid for the schema {0}.
+notAllowed = Property ''{0}'' is not allowed here.
+propertyNames = Property name ''{0}'' is invalid: {1}
+unevaluatedProperties = Property ''{0}'' must not be unevaluated.
+unevaluatedItems=Item at index {0} must not be unevaluated or must match the schema for unevaluated items.
+additionalItems = Index ''{0}'' is not defined in the schema and additional items are not allowed.
+format.date = Value does not match the {0} pattern (must be a valid RFC 3339 full-date).
+format.date-time = Value does not match the {0} pattern (must be a valid RFC 3339 date-time).
+format.duration = Value does not match the {0} pattern (must be a valid ISO 8601 duration).
+format.email = Value does not match the {0} pattern (must be a valid RFC 5321 Mailbox).
+format.ipv4 = Value does not match the {0} pattern (must be a valid RFC 2673 IP address).
+format.ipv6 = Value does not match the {0} pattern (must be a valid RFC 4291 IP address).
+format.idn-email = Value does not match the {0} pattern (must be a valid RFC 6531 Mailbox).
+format.idn-hostname = Value does not match the {0} pattern (must be a valid RFC 5890 internationalized hostname).
+format.iri = Value does not match the {0} pattern (must be a valid RFC 3987 IRI).
+format.iri-reference = Value does not match the {0} pattern (must be a valid RFC 3987 IRI-reference).
+format.uri = Value does not match the {0} pattern (must be a valid RFC 3986 URI).
+format.uri-reference = Value does not match the {0} pattern (must be a valid RFC 3986 URI-reference).
+format.uri-template = Value does not match the {0} pattern (must be a valid RFC 6570 URI Template).
+format.uuid = Value does not match the {0} pattern (must be a valid RFC 4122 UUID).
+format.regex = Value does not match the {0} pattern (must be a valid ECMA-262 regular expression).
+format.time = Value does not match the {0} pattern (must be a valid RFC 3339 time).
+format.hostname = Value does not match the {0} pattern (must be a valid RFC 1123 host name).
+format.json-pointer = Value does not match the {0} pattern (must be a valid RFC 6901 JSON Pointer).
+format.relative-json-pointer = Value does not match the {0} pattern (must be a valid IETF Relative JSON Pointer).
+format.unknown = has an unknown format ''{0}''.
+discriminator.missing_discriminating_value = Required property ''{0}'' for discriminator not found.
+discriminator.anyOf.no_match_found = No matching schema found for discriminator value ''{0}''.
+discriminator.oneOf.no_match_found = No matching schema found for discriminator value ''{0}''.