Merge branch 'main' into 609-display-copyright-license-in-provided-ttl-file

Author: Yauhenikapl

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/datatype/CurieType.java

@@ -28,11 +28,15 @@
  * Represents the samm:curie datatype itself. For the class that represents a Curie value, see {@link Curie}.
  */
 public class CurieType implements SammType<Curie> {
+   public static final CurieType INSTANCE = new CurieType();
    public static final String CURIE_REGEX = "[a-zA-Z]*:[a-zA-Z]+";
    private final Function<String, Curie> parser = Curie::new;
    private final Function<Curie, String> unparser = Curie::value;
    private final Predicate<String> lexicalValidator = value -> value.matches( CURIE_REGEX );
 
+   private CurieType() {
+   }
+
    @Override
    public Optional<Curie> parseTyped( final String lexicalForm ) {
       try {

core/esmf-aspect-meta-model-interface/src/main/java/org/eclipse/esmf/metamodel/datatype/SammXsdType.java

@@ -250,7 +250,7 @@ private SammXsdType( final Resource dataTypeResource, final XSSimpleType xstype,
                G_YEAR, G_MONTH, G_YEAR_MONTH, G_DAY, G_MONTH_DAY, DURATION, YEAR_MONTH_DURATION, DAY_TIME_DURATION,
                BYTE, SHORT, INT, LONG, UNSIGNED_BYTE, UNSIGNED_SHORT, UNSIGNED_INT, UNSIGNED_LONG,
                POSITIVE_INTEGER, NON_NEGATIVE_INTEGER, NEGATIVE_INTEGER, NON_POSITIVE_INTEGER, HEX_BINARY,
-               BASE64_BINARY, ANY_URI, RDFLangString.rdfLangString, new CurieType() );
+               BASE64_BINARY, ANY_URI, RDFLangString.rdfLangString, CurieType.INSTANCE );
 
    public static void setChecking( final boolean checking ) {
       SammXsdType.checking = checking;

core/esmf-aspect-model-aas-generator/src/test/java/org/eclipse/esmf/aspectmodel/aas/AspectModelAasGeneratorTest.java

@@ -21,7 +21,6 @@
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.Set;
-
 import javax.xml.XMLConstants;
 import javax.xml.transform.stream.StreamSource;
 import javax.xml.validation.Schema;

core/esmf-aspect-model-document-generators/pom.xml

@@ -137,6 +137,14 @@
          <artifactId>esmf-aspect-model-java-core</artifactId>
          <scope>test</scope>
       </dependency>
+      <dependency>
+         <groupId>org.eclipse.esmf</groupId>
+         <artifactId>esmf-aspect-model-java-generator</artifactId>
+         <version>${project.version}</version>
+         <classifier>tests</classifier>
+         <type>test-jar</type>
+         <scope>test</scope>
+      </dependency>
       <dependency>
          <groupId>io.swagger.parser.v3</groupId>
          <artifactId>swagger-parser</artifactId>

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/json/AspectModelJsonPayloadGenerator.java

@@ -19,13 +19,16 @@
 import java.math.BigInteger;
 import java.math.MathContext;
 import java.math.RoundingMode;
+import java.nio.charset.StandardCharsets;
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Base64;
 import java.util.Date;
 import java.util.GregorianCalendar;
 import java.util.HashMap;
+import java.util.HexFormat;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Locale;
@@ -227,7 +230,7 @@ private boolean isConstrainedCollection( final Characteristic characteristic ) {
          return false;
       }
       final Trait trait = characteristic.as( Trait.class );
-      return trait.getBaseCharacteristic().is( Collection.class ) && ( !trait.getConstraints().isEmpty() );
+      return trait.getBaseCharacteristic().is( Collection.class ) && (!trait.getConstraints().isEmpty());
    }
 
    private Map<String, Object> transformAbstractEntityProperty( final BasicProperty property, final boolean useModelExampleValue ) {
@@ -296,7 +299,7 @@ private Object getExampleValueOrElseRandom( final BasicProperty property, final
 
       Optional<Characteristic> elementCharacteristics = Optional.empty();
       if ( characteristic.is( Collection.class ) ) {
-         elementCharacteristics = ( (Collection) characteristic ).getElementCharacteristic();
+         elementCharacteristics = ((Collection) characteristic).getElementCharacteristic();
       }
       final Characteristic effectiveCharacteristics = elementCharacteristics.orElse( characteristic );
 
@@ -306,7 +309,7 @@ private Object getExampleValueOrElseRandom( final BasicProperty property, final
 
       return property.getExampleValue()
             .map( exampleValue -> exampleValue.as( ScalarValue.class ).getValue() )
-            .map( value -> value instanceof Curie ? ( (Curie) value ).value() : value )
+            .map( value -> value instanceof Curie ? ((Curie) value).value() : value )
             .orElseGet( () -> generateExampleValue( effectiveCharacteristics ) );
    }
 
@@ -432,7 +435,7 @@ private Type getDataType( final Characteristic characteristic ) {
       private Object generateExampleValue( final Characteristic characteristic ) {
          final Type dataType = getDataType( characteristic );
 
-         if ( !( dataType.is( Scalar.class ) ) ) {
+         if ( !(dataType.is( Scalar.class )) ) {
             throw new IllegalArgumentException( "Example values can only be generated for scalar types." );
          }
 
@@ -452,6 +455,9 @@ private Object generateExampleValue( final Characteristic characteristic ) {
          if ( Duration.class.equals( exampleValueType ) ) {
             return DatatypeFactory.newDefaultInstance().newDuration( defaultEasyRandom.nextLong() );
          }
+         if ( byte[].class.equals( exampleValueType ) ) {
+            return getBinaryRandomValue( dataType );
+         }
 
          if ( characteristic.is( Trait.class ) ) {
             final Optional<Object> traitExampleValue = generateExampleValueForTrait( characteristic.as( Trait.class ), exampleValueType,
@@ -487,6 +493,13 @@ private Optional<Object> generateExampleValueForTrait( final Trait trait, final
          return Optional.empty();
       }
 
+      private Object getBinaryRandomValue( final Type dataType ) {
+         final byte[] value = defaultEasyRandom.nextObject( String.class ).getBytes( StandardCharsets.UTF_8 );
+         return dataType.getUrn().equals( XSD.base64Binary.getURI() )
+               ? Base64.getEncoder().encodeToString( value )
+               : HexFormat.of().formatHex( value );
+      }
+
       private Object getGregorianRandomValue( final Type dataType ) {
          final XMLGregorianCalendar randomCalendar = DatatypeFactory.newDefaultInstance()
                .newXMLGregorianCalendar( new GregorianCalendar() );
@@ -574,7 +587,7 @@ private Number generateForNumericTypeInRange( final java.lang.reflect.Type value
 
       // narrowing conversion from BigDecimal to double
       private double safelyNarrowDown( final Number bound ) {
-         if ( !( BigDecimal.class.equals( bound.getClass() ) ) ) {
+         if ( !(BigDecimal.class.equals( bound.getClass() )) ) {
             return bound.doubleValue();
          }
 
@@ -583,7 +596,7 @@ private double safelyNarrowDown( final Number bound ) {
          // Example: xsd:unsignedLong has a max. value of 18446744073709551615; when converting it to double
          // it will get represented as 1.8446744073709552E16, thereby exceeding the upper bound.
          // Therefore we need to take care of always rounding down when narrowing to double.
-         final BigDecimal narrowed = ( (BigDecimal) bound ).round( new MathContext( 15, RoundingMode.DOWN ) );
+         final BigDecimal narrowed = ((BigDecimal) bound).round( new MathContext( 15, RoundingMode.DOWN ) );
          return narrowed.doubleValue();
       }
 

core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/json/AspectModelJsonPayloadGeneratorTest.java

@@ -13,15 +13,19 @@
 package org.eclipse.esmf.aspectmodel.generator.json;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatCode;
 
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.Serial;
 import java.math.BigDecimal;
 import java.math.BigInteger;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Iterator;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
@@ -32,6 +36,7 @@
 import java.util.stream.DoubleStream;
 import java.util.stream.IntStream;
 import java.util.stream.LongStream;
+import java.util.stream.Stream;
 import javax.xml.datatype.DatatypeConfigurationException;
 import javax.xml.datatype.DatatypeFactory;
 
@@ -76,6 +81,10 @@
 import org.eclipse.esmf.aspectmodel.generator.json.testclasses.NestedEntity;
 import org.eclipse.esmf.aspectmodel.generator.json.testclasses.TestEntityWithSimpleTypes;
 import org.eclipse.esmf.aspectmodel.jackson.AspectModelJacksonModule;
+import org.eclipse.esmf.aspectmodel.java.JavaCodeGenerationConfig;
+import org.eclipse.esmf.aspectmodel.java.JavaCodeGenerationConfigBuilder;
+import org.eclipse.esmf.aspectmodel.java.QualifiedName;
+import org.eclipse.esmf.aspectmodel.java.pojo.AspectModelJavaGenerator;
 import org.eclipse.esmf.aspectmodel.loader.MetaModelBaseAttributes;
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.metamodel.Aspect;
@@ -99,7 +108,9 @@
 import org.eclipse.esmf.test.TestAspect;
 import org.eclipse.esmf.test.TestModel;
 import org.eclipse.esmf.test.TestResources;
+import org.eclipse.esmf.test.shared.compiler.JavaCompiler;
 
+import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
@@ -116,9 +127,11 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.EnumSource;
 import org.junit.jupiter.params.provider.MethodSource;
 
 public class AspectModelJsonPayloadGeneratorTest {
+   private static final String PACKAGE = "org.eclipse.esmf.test.generatedtestclasses";
    private static DatatypeFactory datatypeFactory;
 
    @BeforeAll
@@ -130,6 +143,51 @@ static void setup() {
       }
    }
 
+   @ParameterizedTest
+   @EnumSource( value = TestAspect.class, mode = EnumSource.Mode.EXCLUDE, names = {
+         "MODEL_WITH_BROKEN_CYCLES"
+   } )
+   public void testDeserializationForGeneratedJson( final TestAspect testAspect ) throws IOException, InterruptedException {
+      final Aspect aspect = TestResources.load( testAspect ).aspect();
+      final JavaCompiler.CompilationResult compilationResult = compile( aspect );
+
+      final Class<?> aspectClass = compilationResult.compilationUnits().entrySet().stream()
+            .filter( entry -> entry.getKey().getClassName().equals( aspect.getName() ) )
+            .map( Map.Entry::getValue )
+            .findFirst()
+            .orElseThrow();
+      assertThatCode( () -> {
+         final String payload = new AspectModelJsonPayloadGenerator( aspect ).generateJson();
+         final ObjectMapper mapper = objectMapper();
+         mapper.setTypeFactory( mapper.getTypeFactory().withClassLoader( compilationResult.classLoader() ) );
+         mapper.readValue( payload, aspectClass );
+      } ).doesNotThrowAnyException();
+   }
+
+   private JavaCompiler.CompilationResult compile( final Aspect aspect ) {
+      final JavaCodeGenerationConfig config = JavaCodeGenerationConfigBuilder.builder()
+            .packageName( PACKAGE )
+            .enableJacksonAnnotations( true )
+            .executeLibraryMacros( false )
+            .build();
+      final AspectModelJavaGenerator codeGenerator = new AspectModelJavaGenerator( aspect, config );
+      final Map<QualifiedName, ByteArrayOutputStream> outputs = new LinkedHashMap<>();
+      codeGenerator.generate( name -> outputs.computeIfAbsent( name, name2 -> new ByteArrayOutputStream() ) );
+
+      final Map<QualifiedName, String> sources = new LinkedHashMap<>();
+      final List<QualifiedName> loadOrder = new ArrayList<>();
+      for ( final Map.Entry<QualifiedName, ByteArrayOutputStream> entry : outputs.entrySet() ) {
+         loadOrder.add( entry.getKey() );
+         sources.put( entry.getKey(), entry.getValue().toString( StandardCharsets.UTF_8 ) );
+      }
+
+      final List<String> referencedClasses = Stream
+            .concat( codeGenerator.getConfig().importTracker().getUsedImports().stream(),
+                  codeGenerator.getConfig().importTracker().getUsedStaticImports().stream() )
+            .collect( Collectors.toList() );
+      return JavaCompiler.compile( loadOrder, sources, referencedClasses );
+   }
+
    @Test
    public void testGenerateJsonForAspectWithCollectionOfEntities() throws IOException {
       final String generatedJson = generateJsonForModel( TestAspect.ASPECT_WITH_ENTITY_LIST );
@@ -613,14 +671,19 @@ private void assertTestEntityWithSimpleTypes( final TestEntityWithSimpleTypes te
       assertThat( testEntityWithSimpleTypes.getTestString() ).isEqualTo( "Example Value Test" );
    }
 
-   private <T> T parseJson( final String json, final Class<T> targetClass ) throws IOException {
+   private ObjectMapper objectMapper() {
       final ObjectMapper mapper = new ObjectMapper();
       mapper.registerModule( new JavaTimeModule() );
       mapper.registerModule( new Jdk8Module() );
       mapper.registerModule( new AspectModelJacksonModule() );
+      mapper.configure( JsonParser.Feature.INCLUDE_SOURCE_IN_LOCATION, true );
       mapper.configure( SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false );
       mapper.configure( SerializationFeature.FAIL_ON_EMPTY_BEANS, false );
-      return mapper.readValue( json, targetClass );
+      return mapper;
+   }
+
+   private <T> T parseJson( final String json, final Class<T> targetClass ) throws IOException {
+      return objectMapper().readValue( json, targetClass );
    }
 
    // combination of all numeric meta model types with various range types

core/esmf-aspect-model-jackson/src/main/java/org/eclipse/esmf/aspectmodel/jackson/AspectModelJacksonModule.java

@@ -15,6 +15,7 @@
 
 import javax.xml.datatype.XMLGregorianCalendar;
 
+import org.eclipse.esmf.metamodel.datatype.Curie;
 import org.eclipse.esmf.metamodel.datatype.LangString;
 
 import com.fasterxml.jackson.databind.module.SimpleModule;
@@ -32,7 +33,9 @@ public AspectModelJacksonModule() {
       addDeserializer( byte[].class, HexBinaryDeserializer.INSTANCE );
       addSerializer( byte[].class, Base64BinarySerializer.INSTANCE );
       addDeserializer( byte[].class, Base64BinaryDeserializer.INSTANCE );
-      addDeserializer( LangString.class, LangStringDeserializer.INSTANCE );
       addSerializer( LangString.class, LangStringSerializer.INSTANCE );
+      addDeserializer( LangString.class, LangStringDeserializer.INSTANCE );
+      addSerializer( Curie.class, CurieSerializer.INSTANCE );
+      addDeserializer( Curie.class, CurieDeserializer.INSTANCE );
    }
 }

core/esmf-aspect-model-jackson/src/main/java/org/eclipse/esmf/aspectmodel/jackson/CurieDeserializer.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2024 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.jackson;
+
+import java.io.IOException;
+import java.io.Serial;
+import java.util.Optional;
+
+import org.eclipse.esmf.metamodel.datatype.Curie;
+import org.eclipse.esmf.metamodel.datatype.CurieType;
+
+import com.fasterxml.jackson.core.JacksonException;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonTokenId;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+
+public class CurieDeserializer extends StdDeserializer<Curie> {
+   @Serial
+   private static final long serialVersionUID = 1285377288430239636L;
+   public static final CurieDeserializer INSTANCE = new CurieDeserializer();
+
+   private CurieDeserializer() {
+      super( Curie.class );
+   }
+
+   @Override
+   public Curie deserialize( final JsonParser parser, final DeserializationContext context ) throws IOException, JacksonException {
+      if ( parser.currentTokenId() == JsonTokenId.ID_STRING ) {
+         final Optional<Curie> value = CurieType.INSTANCE.parseTyped( parser.getText() );
+         if ( value.isPresent() ) {
+            return value.get();
+         }
+      }
+
+      return (Curie) context.handleUnexpectedToken( Curie.class, parser );
+   }
+}

core/esmf-aspect-model-jackson/src/main/java/org/eclipse/esmf/aspectmodel/jackson/CurieSerializer.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2024 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.jackson;
+
+import java.io.IOException;
+import java.io.Serial;
+
+import org.eclipse.esmf.metamodel.datatype.Curie;
+import org.eclipse.esmf.metamodel.datatype.CurieType;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+
+public class CurieSerializer extends StdSerializer<Curie> {
+   @Serial
+   private static final long serialVersionUID = -6772194217411185019L;
+   public static final CurieSerializer INSTANCE = new CurieSerializer();
+
+   private CurieSerializer() {
+      super( Curie.class );
+   }
+
+   @Override
+   public void serialize( final Curie value, final JsonGenerator generator, final SerializerProvider provider ) throws IOException {
+      generator.writeString( CurieType.INSTANCE.unparseTyped( value ) );
+   }
+}