Merge pull request #765 from bci-oss/764-process-invalid-literal-values

atextor · web-flow · commit c215cdcee8c3 · 2025-05-23T06:58:53.000+02:00
Report invalid scalar values like syntax errors
diff --git a/core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/aspectmodel/ValueParsingException.java b/core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/aspectmodel/ValueParsingException.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2025 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 org.eclipse.esmf.aspectmodel;
+
+public class ValueParsingException extends RuntimeException {
+   private final String type;
+   private final Object value;
+   private long line;
+   private long column;
+
+   public ValueParsingException( final String type, final Object value ) {
+      this.type = type;
+      this.value = value;
+   }
+
+   public ValueParsingException( final String type, final Object value, final Throwable cause ) {
+      super( cause );
+      this.type = type;
+      this.value = value;
+   }
+
+   public String getType() {
+      return type;
+   }
+
+   public Object getValue() {
+      return value;
+   }
+
+   public ValueParsingException setLine( final long line ) {
+      this.line = line;
+      return this;
+   }
+
+   public ValueParsingException setColumn( final long column ) {
+      this.column = column;
+      return this;
+   }
+
+   public long getLine() {
+      return line;
+   }
+
+   public long getColumn() {
+      return column;
+   }
+}
diff --git a/core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/datatype/SammXsdType.java b/core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/datatype/SammXsdType.java
diff --git a/core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/vocabulary/SAMM.java b/core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/vocabulary/SAMM.java
@@ -12,11 +12,8 @@
  */
 package org.eclipse.esmf.metamodel.vocabulary;
 
-import java.util.List;
-
 import org.eclipse.esmf.samm.KnownVersion;
 
-import com.google.common.collect.ImmutableList;
 import org.apache.jena.rdf.model.Property;
 import org.apache.jena.rdf.model.Resource;
 
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/exceptions/ParserException.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/exceptions/ParserException.java
@@ -13,15 +13,77 @@
 
 package org.eclipse.esmf.aspectmodel.resolver.exceptions;
 
+import java.util.Optional;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.apache.jena.riot.RiotException;
+
+/**
+ * Represents the context information of a parser (syntax) error: The location, source document and description
+ */
 public class ParserException extends RuntimeException {
+   /**
+    * The pattern to parse {@link RiotException}'s messages.
+    * RiotException's message looks like this:
+    * [line: 17, col: 2 ] Triples not terminated by DOT
+    */
+   private static final Pattern PATTERN = Pattern.compile( "\\[ *line: *(\\d+), *col: *(\\d+) *] *(.*)" );
    private final String sourceDocument;
+   private final long line;
+   private final long column;
+
+   /**
+    * Constructor: Parse a RiotException
+    *
+    * @param exception the cause
+    * @param sourceDocument the source document
+    */
+   public ParserException( final RiotException exception, final String sourceDocument ) {
+      super( getRiotMessage( exception.getMessage() ).orElse( "Syntax error: " + exception.getMessage() ), exception );
+      this.sourceDocument = sourceDocument;
+      final Matcher matcher = PATTERN.matcher( exception.getMessage() );
+      if ( matcher.find() ) {
+         line = Long.parseLong( matcher.group( 1 ) );
+         column = Long.parseLong( matcher.group( 2 ) );
+      } else {
+         line = -1;
+         column = -1;
+      }
+   }
 
-   public ParserException( final Throwable cause, final String sourceDocument ) {
-      super( cause.getMessage(), cause );
+   /**
+    * Constructor: Create a parser exception when the problem location is already known
+    *
+    * @param line the line of the parser problem
+    * @param column the column of the parser problem
+    * @param message the message
+    * @param sourceDocument the source document
+    */
+   public ParserException( final long line, final long column, final String message, final String sourceDocument ) {
+      super( message );
       this.sourceDocument = sourceDocument;
+      this.line = line;
+      this.column = column;
+   }
+
+   private static Optional<String> getRiotMessage( final String riotMessage ) {
+      final Matcher matcher = PATTERN.matcher( riotMessage );
+      if ( matcher.find() ) {
+         return Optional.of( matcher.group( 3 ) );
+      }
+      return Optional.empty();
    }
 
    public String getSourceDocument() {
       return sourceDocument;
    }
+
+   public long getLine() {
+      return line;
+   }
+
+   public long getColumn() {
+      return column;
+   }
 }
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/modelfile/ModelFiles.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/modelfile/ModelFiles.java
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/parser/TurtleParserProfile.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/parser/TurtleParserProfile.java
@@ -13,6 +13,8 @@
 
 package org.eclipse.esmf.aspectmodel.resolver.parser;
 
+import org.eclipse.esmf.aspectmodel.ValueParsingException;
+
 import org.apache.jena.datatypes.RDFDatatype;
 import org.apache.jena.graph.Graph;
 import org.apache.jena.graph.Node;
@@ -44,9 +46,15 @@ public String getBaseURI() {
 
    @Override
    public Node create( final Node currentGraph, final Token token ) {
-      final Node node = parserProfile.create( currentGraph, token );
-      TokenRegistry.put( node, new SmartToken( token ) );
-      return node;
+      try {
+         final Node node = parserProfile.create( currentGraph, token );
+         TokenRegistry.put( node, new SmartToken( token ) );
+         return node;
+      } catch ( final ValueParsingException exception ) {
+         exception.setLine( token.getLine() );
+         exception.setColumn( token.getColumn() );
+         throw exception;
+      }
    }
 
    @Override
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/services/TurtleLoader.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/resolver/services/TurtleLoader.java
@@ -23,6 +23,7 @@
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 
+import org.eclipse.esmf.aspectmodel.ValueParsingException;
 import org.eclipse.esmf.aspectmodel.resolver.exceptions.ParserException;
 import org.eclipse.esmf.aspectmodel.resolver.parser.ReaderRiotTurtle;
 import org.eclipse.esmf.metamodel.datatype.SammXsdType;
@@ -100,12 +101,9 @@ public static Try<Model> loadTurtle( @Nullable final String modelContent ) {
                .lang( Lang.TURTLE )
                .toModel();
          return Try.success( streamModel );
-      } catch ( final IllegalArgumentException exception ) {
-         LOG.error( "Invalid value encountered in Aspect Model.", exception );
-         final String incorrectDataTypeDefinitionMessage = "%s is not a valid value for the defined data type.";
-         final String formattedErrorMessage = String
-               .format( incorrectDataTypeDefinitionMessage, exception.getMessage() );
-         return Try.failure( new IllegalArgumentException( formattedErrorMessage ) );
+      } catch ( final ValueParsingException exception ) {
+         return Try.failure( new ParserException( exception.getLine(), exception.getColumn(),
+               "'%s' is no valid value for type %s".formatted( exception.getValue(), exception.getType() ), modelContent ) );
       } catch ( final IOException exception ) {
          return Try.failure( exception );
       } catch ( final RiotException exception ) {
diff --git a/core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/loader/AspectModelLoaderTest.java b/core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/loader/AspectModelLoaderTest.java
@@ -26,6 +26,7 @@
 import org.eclipse.esmf.aspectmodel.AspectLoadingException;
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.aspectmodel.resolver.exceptions.ModelResolutionException;
+import org.eclipse.esmf.aspectmodel.resolver.exceptions.ParserException;
 import org.eclipse.esmf.metamodel.AbstractEntity;
 import org.eclipse.esmf.metamodel.AspectModel;
 import org.eclipse.esmf.metamodel.ComplexType;
@@ -70,6 +71,16 @@ void testFileWithInvalidEncoding() {
             .hasMessageContaining( "Encountered invalid encoding" );
    }
 
+   @Test
+   void testAspectModelWithInvalidUri() {
+      assertThatThrownBy( () -> TestResources.load( InvalidTestAspect.INVALID_URI ) )
+            .isInstanceOfSatisfying( ParserException.class, parserException -> {
+               assertThat( parserException.getMessage() ).contains( "invalid with spaces" );
+               assertThat( parserException.getLine() ).isNotEqualTo( -1 ).isNotEqualTo( 0 );
+               assertThat( parserException.getColumn() ).isNotEqualTo( -1 ).isNotEqualTo( 0 );
+            } );
+   }
+
    @Test
    void testOfAbstractEntityCyclomaticCreation() {
       final Map<String, ComplexType> entities =
diff --git a/core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/resolver/services/TurtleLoaderTest.java b/core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/resolver/services/TurtleLoaderTest.java
@@ -43,7 +43,7 @@ void turtleLoaderFailsWithNullPointerIfPrefixIsNotDefined() {
          final Try<Model> tryModel = TurtleLoader.loadTurtle( new ByteArrayInputStream( MODEL.getBytes( StandardCharsets.UTF_8 ) ) );
          assertThat( tryModel.isFailure() ).isTrue();
          assertThat( tryModel.getCause() ).isInstanceOfSatisfying( ParserException.class, parserException -> {
-            assertThat( parserException.getMessage() ).contains( "[line: 2, col: 13] Undefined prefix: aPrefix" );
+            assertThat( parserException.getMessage() ).contains( "Undefined prefix: aPrefix" );
          } );
       } ).doesNotThrowAnyException();
    }
diff --git a/core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/validation/services/AspectModelValidator.java b/core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/validation/services/AspectModelValidator.java
@@ -16,8 +16,6 @@
 import java.io.File;
 import java.util.List;
 import java.util.function.Supplier;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.aspectmodel.resolver.exceptions.ParserException;
@@ -80,18 +78,9 @@ public Either<List<Violation>, AspectModel> loadModel( final Supplier<AspectMode
          model = aspectModelSupplier.get();
          return Either.right( model );
       } catch ( final ParserException exception ) { // Syntax error
-         // RiotException's message looks like this:
-         // [line: 17, col: 2 ] Triples not terminated by DOT
-         final Pattern pattern = Pattern.compile( "\\[ *line: *(\\d+), *col: *(\\d+) *] *(.*)" );
-         final Matcher matcher = pattern.matcher( exception.getMessage() );
-         if ( matcher.find() ) {
-            final long line = Long.parseLong( matcher.group( 1 ) );
-            final long column = Long.parseLong( matcher.group( 2 ) );
-            final String message = matcher.group( 3 );
-            return Either.left( List.of( new InvalidSyntaxViolation( message, exception.getSourceDocument(), line, column ) ) );
-         }
-         return Either.left(
-               List.of( new InvalidSyntaxViolation( "Syntax error: " + exception.getMessage(), exception.getSourceDocument(), -1, -1 ) ) );
+         return Either.left( List.of(
+               new InvalidSyntaxViolation( exception.getMessage(), exception.getSourceDocument(), exception.getLine(),
+                     exception.getColumn() ) ) );
       } catch ( final Exception exception ) { // Any other exception, e.g., resolution exception
          return Either.left( List.of( new ProcessingViolation( exception.getMessage(), exception ) ) );
       }
diff --git a/core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/validation/services/ModelCycleDetector.java b/core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/validation/services/ModelCycleDetector.java
@@ -21,12 +21,14 @@
 import java.util.Set;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.shacl.violation.ProcessingViolation;
 import org.eclipse.esmf.aspectmodel.shacl.violation.Violation;
 import org.eclipse.esmf.metamodel.vocabulary.SAMM;
 import org.eclipse.esmf.metamodel.vocabulary.SammNs;
-import org.eclipse.esmf.samm.KnownVersion;
+import org.eclipse.esmf.metamodel.vocabulary.SimpleRdfNamespace;
 
 import org.apache.jena.query.Query;
 import org.apache.jena.query.QueryExecution;
@@ -58,12 +60,6 @@ public class ModelCycleDetector {
          "The Aspect Model contains a cycle which includes following properties: %s. Please remove any cycles that do not allow a finite "
                + "json payload.";
 
-   private static final String PREFIXES = """
-         prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:%1$s#>
-         prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:%1$s#>
-         prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
-         """;
-
    final Set<String> discovered = new LinkedHashSet<>();
    final Set<String> discoveredOptionals = new HashSet<>();
    final Set<String> finished = new HashSet<>();
@@ -186,7 +182,7 @@ private Resource resolvePropertyReference( final Resource propertyNode ) {
 
    private boolean isOptionalProperty( final Resource propertyNode ) {
       final Statement optional = propertyNode.getProperty( samm.optional() );
-      return (optional != null) && optional.getBoolean();
+      return ( optional != null ) && optional.getBoolean();
    }
 
    private String getUniqueName( final Resource property ) {
@@ -223,7 +219,11 @@ private void reportCycle( final String cyclePath ) {
 
    @SuppressWarnings( "checkstyle:LineLength" )
    private void initializeQuery() {
-      final String currentVersionPrefixes = PREFIXES.formatted( KnownVersion.getLatest().toVersionString() );
+      final String currentVersionPrefixes =
+            Stream.of( SammNs.SAMM, SammNs.SAMMC, new SimpleRdfNamespace( "rdf", RDF.uri ) )
+                  .map( ns -> "prefix %s: <%s>".formatted( ns.getShortForm(), ns.getNamespace() ) )
+                  .collect( Collectors.joining( "\n" ) );
+
       //noinspection LongLine
       final String queryString = String.format( """
                   %s select ?reachableProperty ?viaEither
diff --git a/core/esmf-aspect-model-validator/src/test/java/org/eclipse/esmf/aspectmodel/validation/services/AspectModelValidatorTest.java b/core/esmf-aspect-model-validator/src/test/java/org/eclipse/esmf/aspectmodel/validation/services/AspectModelValidatorTest.java
@@ -44,7 +44,6 @@
 import org.junit.jupiter.params.provider.EnumSource;
 
 class AspectModelValidatorTest {
-   // One specific validator instance for each meta model version
    AspectModelValidator service = new AspectModelValidator();
 
    @ParameterizedTest
@@ -207,6 +206,15 @@ void testLoadWithValidation() {
       assertThat( model.isRight() ).isTrue();
    }
 
+   @Test
+   void testValidateInvalidLiteralValue() {
+      final Either<List<Violation>, AspectModel> result = service.loadModel( () -> TestResources.load( InvalidTestAspect.INVALID_URI ) );
+      assertThat( result.isLeft() ).isTrue();
+      final List<Violation> violations = result.getLeft();
+      assertThat( violations ).hasSize( 1 );
+      assertThat( violations.getFirst().message() ).contains( "is no valid value for type" );
+   }
+
    private List<Violation> cycles( final String... cycles ) {
       final List<Violation> errors = new ArrayList<>();
       Arrays.stream( cycles ).forEach(
diff --git a/core/esmf-test-aspect-models/src/main/java/org/eclipse/esmf/test/InvalidTestAspect.java b/core/esmf-test-aspect-models/src/main/java/org/eclipse/esmf/test/InvalidTestAspect.java
@@ -28,6 +28,7 @@ public enum InvalidTestAspect implements TestModel {
    INVALID_EXAMPLE_VALUE_DATATYPE,
    INVALID_PREFERRED_NAME_DATATYPE,
    INVALID_CHARACTERISTIC_DATATYPE,
+   INVALID_URI,
    RANGE_CONSTRAINT_WITH_WRONG_TYPE,
    MODEL_WITH_CYCLES,
 
diff --git a/core/esmf-test-aspect-models/src/main/resources/invalid/org.eclipse.esmf.test/1.0.0/InvalidUri.ttl b/core/esmf-test-aspect-models/src/main/resources/invalid/org.eclipse.esmf.test/1.0.0/InvalidUri.ttl

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ void turtleLoaderFailsWithNullPointerIfPrefixIsNotDefined() {`
`43`	`43`	`final Try<Model> tryModel = TurtleLoader.loadTurtle( new ByteArrayInputStream( MODEL.getBytes( StandardCharsets.UTF_8 ) ) );`
`44`	`44`	`assertThat( tryModel.isFailure() ).isTrue();`
`45`	`45`	`assertThat( tryModel.getCause() ).isInstanceOfSatisfying( ParserException.class, parserException -> {`
`46`		`- assertThat( parserException.getMessage() ).contains( "[line: 2, col: 13] Undefined prefix: aPrefix" );`
	`46`	`+ assertThat( parserException.getMessage() ).contains( "Undefined prefix: aPrefix" );`
`47`	`47`	`} );`
`48`	`48`	`} ).doesNotThrowAnyException();`
`49`	`49`	`}`