Merge pull request #250 from bci-oss/#249_validate_namespace_of_custom_units

[#249] Validate namespace of units not specified in the unit catalog

Author: atextor

core/sds-aspect-meta-model-java/src/main/java/io/openmanufacturing/sds/metamodel/loader/AspectModelLoader.java

@@ -13,11 +13,14 @@
 
 package io.openmanufacturing.sds.metamodel.loader;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
 
 import org.apache.jena.rdf.model.Model;
+import org.apache.jena.rdf.model.Resource;
+import org.apache.jena.rdf.model.Statement;
 import org.apache.jena.rdf.model.StmtIterator;
 import org.apache.jena.vocabulary.RDF;
 import org.slf4j.Logger;
@@ -29,6 +32,7 @@
 import io.openmanufacturing.sds.aspectmodel.UnsupportedVersionException;
 import io.openmanufacturing.sds.aspectmodel.resolver.AspectModelResolver;
 import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidModelException;
+import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidNamespaceException;
 import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidRootElementCountException;
 import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidVersionException;
 import io.openmanufacturing.sds.aspectmodel.resolver.services.VersionedModel;
@@ -73,9 +77,12 @@ private static Try<Aspect> load( final VersionedModel versionedModel ) {
       final BAMM bamm = new BAMM( metaModelVersion.get() );
       final StmtIterator iterator = model.listStatements( null, RDF.type, bamm.Aspect() );
       try {
+         validateNamespaceOfCustomUnits( bamm, versionedModel.getRawModel() );
          final ModelElementFactory modelElementFactory = new ModelElementFactory( metaModelVersion.get(), model );
          final Aspect aspect = modelElementFactory.create( Aspect.class, iterator.nextStatement().getSubject() );
          return Try.success( aspect );
+      } catch ( final InvalidNamespaceException exception ) {
+         return Try.failure( exception );
       } catch ( final RuntimeException exception ) {
          return Try.failure( new InvalidModelException( "Could not load Aspect model, please make sure the model is valid", exception ) );
       }
@@ -114,6 +121,21 @@ public static Try<Aspect> fromVersionedModel( final VersionedModel versionedMode
             } );
    }
 
+   private static void validateNamespaceOfCustomUnits( final BAMM bamm, final Model rawModel ) {
+      final List<String> customUnitsWithBammNamespace = new ArrayList<>();
+      rawModel.listStatements( null, RDF.type, bamm.Unit() )
+            .mapWith( Statement::getSubject )
+            .filterKeep( subject -> subject.getNameSpace().equals( bamm.getNamespace() ) )
+            .mapWith( Resource::getLocalName )
+            .forEach( customUnitsWithBammNamespace::add );
+
+      if ( !customUnitsWithBammNamespace.isEmpty() ) {
+         throw new InvalidNamespaceException(
+               String.format( "Aspect model contains unit(s) %s not specified in the unit catalog but referred with bamm namespace",
+                     customUnitsWithBammNamespace ) );
+      }
+   }
+
    private static List<Try<AspectModelUrn>> getUrns( final VersionedModel migratedModel, final KnownVersion version ) {
       final BAMM bamm = new BAMM( version );
       return migratedModel.getModel().listStatements( null, RDF.type, bamm.Aspect() ).mapWith( statement ->

core/sds-aspect-meta-model-resolver/src/main/java/io/openmanufacturing/sds/aspectmodel/resolver/exceptions/InvalidNamespaceException.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package io.openmanufacturing.sds.aspectmodel.resolver.exceptions;
+
+import java.io.Serial;
+
+/**
+ * An exception indicating that usage of the given namespace is invalid.
+ */
+public final class InvalidNamespaceException extends RuntimeException {
+
+   @Serial
+   private static final long serialVersionUID = -1075433954587137319L;
+
+   /**
+    * Creates an instance of the exception.
+    * @param message The detailed message of the problem.
+    * @param cause The cause of the problem.
+    */
+   public InvalidNamespaceException( final String message, final Throwable cause ) {
+      super( message, cause );
+   }
+
+   /**
+    * Creates an instance of the exception.
+    * @param message The detailed message of the problem.
+    */
+   public InvalidNamespaceException( final String message ) {
+      super( message );
+   }
+
+}

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/validation/services/AspectModelValidator.java

@@ -47,6 +47,7 @@
 import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
 import io.openmanufacturing.sds.aspectmodel.UnsupportedVersionException;
 import io.openmanufacturing.sds.aspectmodel.resolver.ModelResolutionException;
+import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidNamespaceException;
 import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidRootElementCountException;
 import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.InvalidVersionException;
 import io.openmanufacturing.sds.aspectmodel.resolver.exceptions.ParserException;
@@ -193,9 +194,9 @@ public List<Violation> validateElement( final Resource element ) {
    /**
     * Validates an Aspect Model that is provided as a {@link Try} of a {@link VersionedModel} that can
     * contain either a syntactically valid (but semantically invalid) Aspect model, or a
-    * {@link RiotException} if a parser error occured.
+    * {@link RiotException} if a parser error occurred.
     *
-    * @param versionedModel The Aspect Model or the corresonding parser error
+    * @param versionedModel The Aspect Model or the corresponding parser error
     * @return Either a {@link ValidationReport.ValidReport} if the model is syntactically correct and conforms to the
     *       Aspect Meta Model semantics or a {@link ValidationReport.InvalidReport} that provides a number of
     *       {@link ValidationError}s that describe all validation violations.
@@ -219,13 +220,7 @@ public ValidationReport validate( final Try<VersionedModel> versionedModel ) {
                      // The SHACL validation succeeded. But to catch false positives, also try to load the model
                      final Try<Aspect> aspects = AspectModelLoader.fromVersionedModel( model );
                      if ( aspects.isFailure() && !(aspects.getCause() instanceof InvalidRootElementCountException) ) {
-                        return new ValidationReportBuilder()
-                              .withValidationErrors( List.of( new ValidationError.Processing(
-                                    "Validation succeeded, but an error was found while processing the model. "
-                                          + "This indicates an error in the model validation; please consider reporting this issue including the model "
-                                          + "at https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/issues -- "
-                                          + buildCauseMessage( aspects.getCause() ) ) ) )
-                              .buildInvalidReport();
+                        return getInvalidReport( aspects.getCause() );
                      }
                      return new ValidationReportBuilder().buildValidReport();
                   }
@@ -240,7 +235,24 @@ public ValidationReport validate( final Try<VersionedModel> versionedModel ) {
       ).get();
    }
 
-   private String buildCauseMessage( final Throwable throwable ) {
+   private static ValidationReport getInvalidReport( final Throwable cause ) {
+      final String errorMessage;
+
+      if ( cause instanceof InvalidNamespaceException ) {
+         errorMessage = buildCauseMessage( cause );
+      } else {
+         errorMessage = "Validation succeeded, but an error was found while processing the model. "
+               + "This indicates an error in the model validation; please consider reporting this issue including the model "
+               + "at https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/issues -- "
+               + buildCauseMessage( cause );
+      }
+
+      return new ValidationReportBuilder()
+            .withValidationErrors( List.of( new ValidationError.Processing( errorMessage ) ) )
+            .buildInvalidReport();
+   }
+
+   private static String buildCauseMessage( final Throwable throwable ) {
       final StringBuilder builder = new StringBuilder();
       Throwable t = throwable;
       while ( t != null ) {

core/sds-aspect-model-validator/src/test/java/io/openmanufacturing/sds/aspectmodel/validation/services/AspectModelValidatorTest.java

@@ -224,6 +224,24 @@ public void testNonTurtleFile( final KnownVersion metaModelVersion ) {
       assertThat( violation.message() ).contains( "Not implemented (formulae, graph literals)" );
    }
 
+   /**
+    * Verify that validation of the given aspect model containing a unit not specified in the unit catalog
+    * and referred with bamm namespace fails.
+    */
+   @ParameterizedTest
+   @MethodSource( value = "allVersions" )
+   public void testAspectWithBammNamespaceForCustomUnit( final KnownVersion metaModelVersion ) {
+      final Try<VersionedModel> invalidAspectModel = TestResources
+            .getModel( InvalidTestAspect.ASPECT_WITH_BAMM_NAMESPACE_FOR_CUSTOM_UNIT, metaModelVersion );
+
+      final ValidationReport report = service.validate( invalidAspectModel );
+      assertThat( report.conforms() ).isFalse();
+
+      final Collection<? extends ValidationError> errors = report.getValidationErrors();
+      assertThat( errors ).hasSize( 1 );
+      assertThat( report.getValidationErrors().iterator().next() ).isOfAnyClassIn( ValidationError.Processing.class );
+   }
+
    @ParameterizedTest
    @MethodSource( value = "allVersions" )
    public void testAspectWithInvalidMetaModelVersion( final KnownVersion metaModelVersion ) {

core/sds-test-aspect-models/src/main/java/io/openmanufacturing/sds/test/InvalidTestAspect.java

@@ -21,6 +21,7 @@ public enum InvalidTestAspect implements TestModel {
    ASPECT_MISSING_PROPERTIES,
    ASPECT_WITH_FALSE_POSITIVE_VALIDATION,
    ASPECT_WITH_INVALID_VERSION,
+   ASPECT_WITH_BAMM_NAMESPACE_FOR_CUSTOM_UNIT,
    ASPECT_WITH_RECURSIVE_PROPERTY,
    INVALID_SYNTAX,
    MISSING_ASPECT_DECLARATION,

core/sds-test-aspect-models/src/main/resources/invalid/bamm_1_0_0/io.openmanufacturing.test/1.0.0/AspectWithBammNamespaceForCustomUnit.ttl

@@ -0,0 +1,37 @@
+# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH
+#
+# See the AUTHORS file(s) distributed with this work for additional
+# information regarding authorship.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+# SPDX-License-Identifier: MPL-2.0
+
+@prefix : <urn:bamm:io.openmanufacturing:aspect-model:AspectWithBammNamespaceForCustomUnit:1.0.0#> .
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:1.0.0#> .
+@prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:1.0.0#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix unit: <urn:bamm:io.openmanufacturing:unit:1.0.0#> .
+
+:AspectWithBammNamespaceForCustomUnit a bamm:Aspect ;
+   bamm:name "AspectWithCustomUnit" ;
+   bamm:properties ( :testProperty ) ;
+   bamm:operations ( ) .
+
+:testProperty a bamm:Property ;
+   bamm:name "testProperty" ;
+   bamm:characteristic :TestQuantifiable .
+
+:TestQuantifiable a bamm-c:Quantifiable ;
+   bamm:name "TestQuantifiable" ;
+   bamm:dataType xsd:int ;
+   bamm-c:unit bamm:normLitrePerMinute .
+
+bamm:normLitrePerMinute a unit:Unit ;
+   bamm:name "normLitrePerMinute" ;
+   bamm:preferredName "norm litre per minute"@en ;
+   unit:quantityKind unit:volumeFlowRate ;
+   unit:symbol "nl/min" .
+

core/sds-test-aspect-models/src/main/resources/invalid/bamm_2_0_0/io.openmanufacturing.test/1.0.0/AspectWithBammNamespaceForCustomUnit.ttl

@@ -0,0 +1,32 @@
+# Copyright (c) 2022 Robert Bosch Manufacturing Solutions GmbH
+#
+# See the AUTHORS file(s) distributed with this work for additional
+# information regarding authorship.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+# SPDX-License-Identifier: MPL-2.0
+
+@prefix : <urn:bamm:io.openmanufacturing.test:1.0.0#> .
+@prefix bamm: <urn:bamm:io.openmanufacturing:meta-model:2.0.0#> .
+@prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:2.0.0#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix unit: <urn:bamm:io.openmanufacturing:unit:2.0.0#> .
+
+:AspectWithBammNamespaceForCustomUnit a bamm:Aspect ;
+   bamm:properties ( :testProperty ) ;
+   bamm:operations ( ) .
+
+:testProperty a bamm:Property ;
+   bamm:characteristic :TestQuantifiable .
+
+:TestQuantifiable a bamm-c:Quantifiable ;
+   bamm:dataType xsd:int ;
+   bamm-c:unit bamm:normLitrePerMinute .
+
+bamm:normLitrePerMinute a bamm:Unit ;
+   bamm:preferredName "norm litre per minute"@en ;
+   bamm:quantityKind unit:volumeFlowRate ;
+   bamm:symbol "nl/min" .