Show available fixes in violation reports

Author: atextor

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

@@ -54,6 +54,7 @@
 import io.openmanufacturing.sds.aspectmodel.shacl.constraint.PatternConstraint;
 import io.openmanufacturing.sds.aspectmodel.shacl.constraint.SparqlConstraint;
 import io.openmanufacturing.sds.aspectmodel.shacl.constraint.XoneConstraint;
+import io.openmanufacturing.sds.aspectmodel.shacl.fix.Fix;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.ClassTypeViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.ClosedViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.DatatypeViolation;
@@ -130,6 +131,12 @@ protected String processSemanticViolations( final List<Violation> violations ) {
                builder.append( String.format( "  context-property: %s%n", violation.shortUri( property.getURI() ) ) );
                builder.append( String.format( "  context-property-full: %s%n", property.getURI() ) );
             } );
+            if ( violation.fixes().size() > 0 ) {
+               builder.append( String.format( "  possible-fixes:%n" ) );
+               for ( final Fix fix : violation.fixes() ) {
+                  builder.append( String.format( "  - %s%n", fix.description() ) );
+               }
+            }
 
             for ( final String line : violation.accept( this ).split( "\n" ) ) {
                builder.append( String.format( "  %s%n", line ) );

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

@@ -18,6 +18,7 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
+import io.openmanufacturing.sds.aspectmodel.shacl.fix.Fix;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.InvalidSyntaxViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.ProcessingViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.Violation;
@@ -70,7 +71,12 @@ protected String processSemanticViolations( final List<Violation> violations ) {
     */
    @Override
    public String visit( final Violation violation ) {
-      return violation.message();
+      final StringBuilder builder = new StringBuilder();
+      builder.append( violation.message() );
+      for ( final Fix possibleFix : violation.fixes() ) {
+         builder.append( String.format( "%n  > Possible fix: %s", possibleFix.description() ) );
+      }
+      return builder.toString();
    }
 
    /**

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

@@ -31,6 +31,8 @@
 
 import io.openmanufacturing.sds.aspectmetamodel.KnownVersion;
 import io.openmanufacturing.sds.aspectmodel.resolver.services.VersionedModel;
+import io.openmanufacturing.sds.aspectmodel.shacl.fix.Fix;
+import io.openmanufacturing.sds.aspectmodel.shacl.violation.DatatypeViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.InvalidSyntaxViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.MinCountViolation;
 import io.openmanufacturing.sds.aspectmodel.shacl.violation.ProcessingViolation;
@@ -115,6 +117,19 @@ public void testValidateInvalidTestAspectModel( final InvalidTestAspect testMode
       assertThat( violations ).isNotEmpty();
    }
 
+   @ParameterizedTest
+   @MethodSource( "versionsStartingWith2_0_0" )
+   public void testGetFixForInvalidTestAspectModel( final KnownVersion metaModelVersion ) {
+      final TestModel testModel = InvalidTestAspect.INVALID_PREFERRED_NAME_DATATYPE;
+      final Try<VersionedModel> invalidAspectModel = TestResources.getModel( testModel, metaModelVersion );
+      final List<Violation> violations = service.get( metaModelVersion ).validateModel( invalidAspectModel );
+      assertThat( violations ).isNotEmpty();
+      final DatatypeViolation violation = (DatatypeViolation) violations.get( 0 );
+      assertThat( violation.fixes() ).isNotEmpty();
+      final Fix fix = violation.fixes().get( 0 );
+      assertThat( fix.description() ).isEqualTo( "Add default @en language tag to value" );
+   }
+
    private static Stream<Arguments> invalidTestModels() {
       return Arrays.stream( InvalidTestAspect.values() )
             .flatMap( testModel -> KnownVersion.getVersions().stream().flatMap( metaModelVersion -> {