Incorporate new error reporting .

Author: RaMisess

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

@@ -13,9 +13,7 @@
 
 package io.openmanufacturing.sds.aspectmodel.validation.services;
 
-import static io.vavr.API.$;
-import static io.vavr.API.Case;
-import static io.vavr.API.Match;
+import static io.vavr.API.*;
 import static io.vavr.Predicates.instanceOf;
 
 import java.io.FileNotFoundException;
@@ -165,8 +163,14 @@ public List<Violation> validateModel( final Try<VersionedModel> versionedModel )
             .flatMap( element -> shaclValidator.validateElement( element ).stream() )
             .toList();
 
-      // The SHACL validation succeeded. But to catch false positives, also try to load the model
       if ( result.isEmpty() ) {
+         // The SHACL validation succeeded, check for cycles in the model.
+         final List<Violation> cycleDetectionReport = new ModelCycleDetector().validateModel( model );
+         if ( !cycleDetectionReport.isEmpty() ) {
+            return cycleDetectionReport;
+         }
+
+         // 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 List.of( new ProcessingViolation(
@@ -216,7 +220,7 @@ public ValidationReport validate( final Try<VersionedModel> versionedModel ) {
                   final Resource report = ValidationUtil.validateModel( dataModel, shapesModel, false );
 
                   if ( report.getProperty( SH.conforms ).getObject().asLiteral().getBoolean() ) {
-                     // The SHACL validation succeeded. But to catch false positives, also try to load the model
+                     // 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()

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

@@ -39,9 +39,8 @@
 
 import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
 import io.openmanufacturing.sds.aspectmodel.resolver.services.VersionedModel;
-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.aspectmodel.shacl.violation.ProcessingViolation;
+import io.openmanufacturing.sds.aspectmodel.shacl.violation.Violation;
 import io.openmanufacturing.sds.aspectmodel.vocabulary.BAMM;
 
 /**
@@ -72,12 +71,12 @@ public class ModelCycleDetector {
    private BAMM bamm;
    private Model model;
 
-   List<ValidationError.Semantic> cycleReports = new ArrayList<>();
+   List<Violation> cycleDetectionReport = new ArrayList<>();
 
-   public ValidationReport validateModel( final VersionedModel versionedModel ) {
+   public List<Violation> validateModel( final VersionedModel versionedModel ) {
       discovered.clear();
       finished.clear();
-      cycleReports.clear();
+      cycleDetectionReport.clear();
 
       model = versionedModel.getModel();
       final Optional<KnownVersion> metaModelVersion = KnownVersion.fromVersionString( versionedModel.getVersion().toString() );
@@ -98,10 +97,8 @@ public ValidationReport validateModel( final VersionedModel versionedModel ) {
             }
          }
       }
-      
-      return cycleReports.isEmpty() ?
-            new ValidationReport.ValidReport() :
-            new ValidationReportBuilder().withValidationErrors( cycleReports ).buildInvalidReport();
+
+      return cycleDetectionReport;
    }
 
    private void depthFirstTraversal( final Resource currentProperty, final BiConsumer<String, Set<String>> cycleHandler ) {
@@ -188,7 +185,7 @@ private void reportCycle( final String backEdgePropertyName, final Set<String> c
    }
 
    private void reportCycle( final String cyclePath ) {
-      cycleReports.add( new ValidationError.Semantic( String.format( ERR_CYCLE_DETECTED, cyclePath ), "", "", "ERROR", "" ) );
+      cycleDetectionReport.add( new ProcessingViolation( String.format( ERR_CYCLE_DETECTED, cyclePath ), null ) );
    }
 
    private void initializeQuery( final KnownVersion metaModelVersion ) {

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

@@ -15,6 +15,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
@@ -260,4 +261,36 @@ public void testValidationWithMultipleAspects( final KnownVersion metaModelVersi
       final List<Violation> violations = service.get( metaModelVersion ).validateModel( model );
       assertThat( violations ).isEmpty();
    }
+
+   @ParameterizedTest
+   @MethodSource( value = "allVersions" )
+   void testCycleDetection( final KnownVersion metaModelVersion ) {
+      final Try<VersionedModel> versionedModel = TestResources.getModel( TestAspect.MODEL_WITH_CYCLES, metaModelVersion );
+      final List<Violation> report = service.get( metaModelVersion ).validateModel( versionedModel );
+      report.forEach( System.out::println );
+      assertThat( report.size() ).isEqualTo( 6 );
+      assertThat( report ).containsAll( cycles(
+            ":a -> :b -> :a",
+            ":e -> :f -> :g -> :e",
+            ":h -> :h",
+            ":h -> :i -> :h",
+            ":l -> :l",
+            // TimeSeries are handled differently between v1 and v2 meta models.
+            metaModelVersion.isOlderThan( KnownVersion.BAMM_2_0_0 ) ? ":n -> :refinedValue -> :n" : ":n -> :NTimeSeriesEntity|bamm-e:value -> :n" ) );
+   }
+
+   @ParameterizedTest
+   @MethodSource( value = "allVersions" )
+   void testCycleDetectionWithCycleBreakers( final KnownVersion metaModelVersion ) {
+      final Try<VersionedModel> versionedModel = TestResources.getModel( TestAspect.MODEL_WITH_BROKEN_CYCLES, metaModelVersion );
+      final List<Violation> report = service.get( metaModelVersion ).validateModel( versionedModel );
+      report.forEach( System.out::println );
+      assertThat( report.isEmpty() ).isTrue();
+   }
+
+   private List<Violation> cycles( final String... cycles ) {
+      final List<Violation> errors = new ArrayList<>();
+      Arrays.stream( cycles ).forEach( cycle -> errors.add( new ProcessingViolation( String.format( ModelCycleDetector.ERR_CYCLE_DETECTED, cycle ), null ) ) );
+      return errors;
+   }
 }

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

@@ -15,7 +15,7 @@
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
 
 :ModelWithBrokenCycles a bamm:Aspect ;
-   bamm:name "" ;
+   bamm:name "ModelWithBrokenCycles" ;
    bamm:properties ( :a :e :h ) ;
    bamm:operations ( ) .
 

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

@@ -160,10 +160,13 @@
    bamm:name "NTimeSeries" ;
    bamm:dataType :NTimeSeriesEntity .
 
-:NTimeSeriesEntity a bamm:Entity ;
+:NTimeSeriesEntity bamm:refines bamm-e:TimeSeriesEntity ;
    bamm:name "NTimeSeriesEntity" ;
-   bamm:extends bamm-e:TimeSeriesEntity ;
-   bamm:properties ( [ bamm:extends bamm-e:value ; bamm:characteristic :oCharacteristic ] ) .
+   bamm:properties ( :refinedValue ) .
+
+:refinedValue bamm:refines bamm-e:value ;
+   bamm:name "refinedValue" ;
+   bamm:characteristic :oCharacteristic .
 
 :oCharacteristic a bamm:Characteristic;
    bamm:name "mCharacteristic" ;