Merge pull request #207 from bci-oss/199-load-model-upon-validation

Load model on successful validation to prevent false positives

Author: atextor

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

@@ -77,7 +77,7 @@ private static Try<Aspect> load( final VersionedModel versionedModel ) {
          final Aspect aspect = modelElementFactory.create( Aspect.class, iterator.nextStatement().getSubject() );
          return Try.success( aspect );
       } catch ( final RuntimeException exception ) {
-         return Try.failure( new InvalidModelException( "Could not load Aspect model, please make sure the model is valid.", exception ) );
+         return Try.failure( new InvalidModelException( "Could not load Aspect model, please make sure the model is valid", exception ) );
       }
    }
 

core/sds-aspect-model-validator/pom.xml

@@ -74,6 +74,10 @@
             <artifactId>sds-test-resources</artifactId>
             <scope>test</scope>
         </dependency>
+       <dependency>
+          <groupId>io.openmanufacturing</groupId>
+          <artifactId>sds-aspect-meta-model-java</artifactId>
+       </dependency>
     </dependencies>
 
     <build>

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/validation/report/ValidationError.java

@@ -124,7 +124,7 @@ public static class Processing extends ValidationError {
 
       @Override
       public String toString() {
-         return "The Aspect Model could not be validated: " + message;
+         return "An error occured while trying to validate the Aspect Model: " + message;
       }
 
       @Override

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

@@ -2,7 +2,7 @@
  * Copyright (c) 2021 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
- * information regarding authorship. 
+ * 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
@@ -13,12 +13,15 @@
 
 package io.openmanufacturing.sds.aspectmodel.validation.services;
 
-import static io.vavr.API.*;
+import static io.vavr.API.$;
+import static io.vavr.API.Case;
+import static io.vavr.API.Match;
 import static io.vavr.Predicates.instanceOf;
 
 import java.io.FileNotFoundException;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.List;
 import java.util.Optional;
 
 import org.apache.jena.query.ARQ;
@@ -46,6 +49,8 @@
 import io.openmanufacturing.sds.aspectmodel.validation.report.ValidationError;
 import io.openmanufacturing.sds.aspectmodel.validation.report.ValidationReport;
 import io.openmanufacturing.sds.aspectmodel.validation.report.ValidationReportBuilder;
+import io.openmanufacturing.sds.metamodel.Aspect;
+import io.openmanufacturing.sds.metamodel.loader.AspectModelLoader;
 import io.vavr.control.Try;
 
 /**
@@ -114,31 +119,55 @@ public ValidationReport validate( final Try<VersionedModel> versionedModel ) {
          final Model dataModel = model.getModel();
 
          final Try<KnownVersion> metaModelVersion = KnownVersion
-               .fromVersionString( model.getVersion().toString() ).map( Try::success )
+               .fromVersionString( model.getVersion().toString() )
+               .map( Try::success )
                .orElse( Try.failure( new UnsupportedVersionException( model.getVersion() ) ) );
 
          return metaModelVersion
                .flatMap( aspectMetaModelResourceResolver::loadShapesModel ).map( shapesModel -> {
                   final Resource report = ValidationUtil.validateModel( dataModel, shapesModel, true );
 
                   if ( report.getProperty( SH.conforms ).getObject().asLiteral().getBoolean() ) {
+                     // 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() ) {
+                        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 new ValidationReportBuilder().buildValidReport();
                   }
 
-                  return new ValidationReportBuilder().withValidationErrors( buildSemanticValidationErrors(
-                        report ) ).buildInvalidReport();
+                  return new ValidationReportBuilder()
+                        .withValidationErrors( buildSemanticValidationErrors( report ) )
+                        .buildInvalidReport();
                } );
       } ).recover( failure -> Match( failure ).of(
             riotExceptionHandler, invalidVersionExceptionHandler, unsupportedVersionExceptionHandler,
             modelResolutionExceptionHandler )
       ).get();
    }
 
+   private String buildCauseMessage( final Throwable throwable ) {
+      final StringBuilder builder = new StringBuilder();
+      Throwable t = throwable;
+      while ( t != null ) {
+         builder.append( t.getMessage() );
+         builder.append( ": " );
+         t = t.getCause();
+      }
+      return builder.toString();
+   }
+
    private String getValidationResultField( final Resource validationResultResource, final Property property ) {
       return Optional.ofNullable( validationResultResource.getProperty( property ) )
-                     .map( Statement::getObject )
-                     .map( RDFNode::toString )
-                     .orElse( "" );
+            .map( Statement::getObject )
+            .map( RDFNode::toString )
+            .orElse( "" );
    }
 
    private Collection<ValidationError.Semantic> buildSemanticValidationErrors( final Resource report ) {
@@ -155,4 +184,8 @@ private Collection<ValidationError.Semantic> buildSemanticValidationErrors( fina
       }
       return semanticValidationErrors;
    }
+
+   private Collection<ValidationError.Processing> buildLoadingFailureError( final String errorMessage ) {
+      return List.of( new ValidationError.Processing( errorMessage ) );
+   }
 }

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

@@ -60,6 +60,25 @@ public void testValidAspect( final KnownVersion metaModelVersion ) {
       assertThat( result.getValidationErrors() ).hasSize( 0 );
    }
 
+   /**
+    * Test for a model that passes validation via BAMM's SHACL shapes but is actually invalid and can not be loaded using
+    * {@link io.openmanufacturing.sds.metamodel.loader.AspectModelLoader#fromVersionedModel(VersionedModel)}.
+    * This method and the corresponding test model should be removed once
+    * <a href="https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/issues/173">BAMM-173</a> has been addressed
+    * @param metaModelVersion the meta model version
+    */
+   @ParameterizedTest
+   @MethodSource( value = "versionsStartingWith2_0_0" )
+   public void testFalsePositiveValidation( final KnownVersion metaModelVersion ) {
+      final TestModel testModel = InvalidTestAspect.ASPECT_WITH_FALSE_POSITIVE_VALIDATION;
+      final Try<VersionedModel> aspectModel = TestResources.getModel( testModel, metaModelVersion );
+      final ValidationReport result = service.validate( aspectModel );
+
+      System.out.println( result.getValidationErrors().iterator().next() );
+      assertThat( result.conforms() ).isFalse();
+      assertThat( result.getValidationErrors().iterator().next() ).isOfAnyClassIn( ValidationError.Processing.class );
+   }
+
    @ParameterizedTest
    @EnumSource( value = TestAspect.class, mode = EnumSource.Mode.EXCLUDE, names = {
          "ASPECT_WITH_CONSTRAINTS",

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

@@ -2,7 +2,7 @@
  * Copyright (c) 2021 Robert Bosch Manufacturing Solutions GmbH
  *
  * See the AUTHORS file(s) distributed with this work for additional
- * information regarding authorship. 
+ * 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
@@ -19,8 +19,9 @@ public enum InvalidTestAspect implements TestModel {
    ACTUALLY_JSON,
    ASPECT_MISSING_NAME_AND_PROPERTIES,
    ASPECT_MISSING_PROPERTIES,
-   ASPECT_WITH_RECURSIVE_PROPERTY,
+   ASPECT_WITH_FALSE_POSITIVE_VALIDATION,
    ASPECT_WITH_INVALID_VERSION,
+   ASPECT_WITH_RECURSIVE_PROPERTY,
    INVALID_SYNTAX,
    MISSING_ASPECT_DECLARATION;
 

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

@@ -21,7 +21,6 @@ public enum TestAspect implements TestModel {
    ASPECT_WITHOUT_PROPERTIES_AND_OPERATIONS,
    ASPECT_WITHOUT_SEE_ATTRIBUTE,
    ASPECT_WITH_ABSTRACT_ENTITY,
-   ASPECT_WITH_COLLECTION_WITH_ABSTRACT_ENTITY,
    ASPECT_WITH_ABSTRACT_SINGLE_ENTITY,
    ASPECT_WITH_ALL_BASE_ATTRIBUTES,
    ASPECT_WITH_BINARY,
@@ -38,6 +37,7 @@ public enum TestAspect implements TestModel {
    ASPECT_WITH_COLLECTION_AND_SIMPLE_ELEMENT_CHARACTERISTIC,
    ASPECT_WITH_COLLECTION_OF_SIMPLE_TYPE,
    ASPECT_WITH_COLLECTION_WITHOUT_SEE_ATTRIBUTE,
+   ASPECT_WITH_COLLECTION_WITH_ABSTRACT_ENTITY,
    ASPECT_WITH_COLLECTION_WITH_ELEMENT_CHARACTERISTIC,
    ASPECT_WITH_COLLECTION_WITH_ELEMENT_CONSTRAINT,
    ASPECT_WITH_COLLECTION_WITH_MULTIPLE_SEE_ATTRIBUTES,
@@ -70,7 +70,6 @@ public enum TestAspect implements TestModel {
    ASPECT_WITH_ENGLISH_AND_GERMAN_DESCRIPTION,
    ASPECT_WITH_ENGLISH_DESCRIPTION,
    ASPECT_WITH_ENTITY,
-   ASPECT_WITH_ENTITY_WITHOUT_PROPERTY,
    ASPECT_WITH_ENTITY_COLLECTION,
    ASPECT_WITH_ENTITY_ENUMERATION,
    ASPECT_WITH_ENTITY_ENUMERATION_AND_LANG_STRING,
@@ -82,14 +81,15 @@ public enum TestAspect implements TestModel {
    ASPECT_WITH_ENTITY_INSTANCE_WITH_SCALAR_LIST_PROPERTY,
    ASPECT_WITH_ENTITY_INSTANCE_WITH_SCALAR_PROPERTIES,
    ASPECT_WITH_ENTITY_LIST,
+   ASPECT_WITH_ENTITY_WITHOUT_PROPERTY,
    ASPECT_WITH_ENTITY_WITH_MULTIPLE_PROPERTIES,
-   ASPECT_WITH_ENUM_AND_OPTIONAL_ENUM_PROPERTIES,
    ASPECT_WITH_ENUMERATION,
    ASPECT_WITH_ENUMERATION_WITHOUT_SCALAR_VARIABLE,
    ASPECT_WITH_ENUMERATION_WITHOUT_SEE_ATTRIBUTE,
    ASPECT_WITH_ENUMERATION_WITH_MULTIPLE_SEE_ATTRIBUTES,
    ASPECT_WITH_ENUMERATION_WITH_SCALAR_VARIABLE,
    ASPECT_WITH_ENUMERATION_WITH_SEE_ATTRIBUTE,
+   ASPECT_WITH_ENUM_AND_OPTIONAL_ENUM_PROPERTIES,
    ASPECT_WITH_ENUM_HAVING_NESTED_ENTITIES,
    ASPECT_WITH_ERROR_COLLECTION,
    ASPECT_WITH_EVENT,
@@ -104,11 +104,11 @@ public enum TestAspect implements TestModel {
    ASPECT_WITH_LANGUAGE_CONSTRAINT,
    ASPECT_WITH_LENGTH_CONSTRAINT,
    ASPECT_WITH_LIST,
-   ASPECT_WITH_LIST_WITH_LENGTH_CONSTRAINT,
    ASPECT_WITH_LIST_AND_ADDITIONAL_PROPERTY,
    ASPECT_WITH_LIST_AND_ELEMENT_CHARACTERISTIC,
    ASPECT_WITH_LIST_AND_ELEMENT_CONSTRAINT,
    ASPECT_WITH_LIST_ENTITY_ENUMERATION,
+   ASPECT_WITH_LIST_WITH_LENGTH_CONSTRAINT,
    ASPECT_WITH_MEASUREMENT,
    ASPECT_WITH_MEASUREMENT_WITH_UNIT,
    ASPECT_WITH_MULTIPLE_COLLECTIONS_OF_SIMPLE_TYPE,
@@ -132,19 +132,19 @@ public enum TestAspect implements TestModel {
    ASPECT_WITH_OPTIONAL_PROPERTIES_WITH_ENTITY,
    ASPECT_WITH_OPTIONAL_PROPERTY,
    ASPECT_WITH_OPTIONAL_PROPERTY_WITH_PAYLOAD_NAME,
-   ASPECT_WITH_PROPERTY_WITH_PAYLOAD_NAME,
    ASPECT_WITH_PREFERRED_NAMES,
    ASPECT_WITH_PROPERTY,
    ASPECT_WITH_PROPERTY_WITH_ALL_BASE_ATTRIBUTES,
    ASPECT_WITH_PROPERTY_WITH_DESCRIPTIONS,
+   ASPECT_WITH_PROPERTY_WITH_PAYLOAD_NAME,
    ASPECT_WITH_PROPERTY_WITH_PREFERRED_NAMES,
    ASPECT_WITH_PROPERTY_WITH_SEE,
    ASPECT_WITH_QUANTIFIABLE_AND_UNIT,
    ASPECT_WITH_QUANTIFIABLE_WITHOUT_UNIT,
    ASPECT_WITH_QUANTIFIABLE_WITH_UNIT,
    ASPECT_WITH_RANGE_CONSTRAINT,
-   ASPECT_WITH_RANGE_CONSTRAINT_ON_CONSTRAINED_NUMERIC_TYPE,
    ASPECT_WITH_RANGE_CONSTRAINT_INCL_BOUND_DEFINITION_PROPERTIES,
+   ASPECT_WITH_RANGE_CONSTRAINT_ON_CONSTRAINED_NUMERIC_TYPE,
    ASPECT_WITH_RANGE_CONSTRAINT_WITHOUT_MIN_MAX_DOUBLE_VALUE,
    ASPECT_WITH_RANGE_CONSTRAINT_WITHOUT_MIN_MAX_INTEGER_VALUE,
    ASPECT_WITH_RANGE_CONSTRAINT_WITH_BOUND_DEFINITION_ATTRIBUTES,

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

@@ -0,0 +1,37 @@
+# Copyright (c) 2021 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
+
+# This model reproduces the problem reported in
+# https://github.com/OpenManufacturingPlatform/sds-sdk/issues/139
+# and
+# https://github.com/OpenManufacturingPlatform/sds-sdk/issues/198
+
+@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#> .
+
+:AspectWithFalsePositiveValidation a bamm:Aspect ;
+   bamm:preferredName "Test Aspect"@en ;
+   bamm:description "This is a test description"@en ;
+   bamm:properties ( :testProperty ) ;
+   bamm:operations ( ) .
+
+:testProperty a bamm:Property ;
+  bamm:characteristic [
+    a bamm-c:SingleEntity ;
+    bamm:dataType :Quantity ;
+  ] ;
+  bamm:exampleValue "invalid"^^:Quantity .
+
+:Quantity a bamm:Entity ;
+  bamm:properties ( ) .