Merge branch 'development' into wip-upgrade-apache-commons

Author: GGoetzelmann

.github/workflows/gradle.yml

@@ -7,7 +7,7 @@ on:
   push:
     branches: [ main, development ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, development ]
 
 env:
     # JDK version used for building jar file
@@ -22,9 +22,9 @@ jobs:
         jdk: [ 17 ]
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
     - name: Set up OpenJDK version ...
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v4
       with:
         distribution: 'zulu' 
         java-version: ${{ matrix.jdk }}

README.md

@@ -33,4 +33,4 @@ Now it should be possible to right click on the project and choose "Run as" -> "
 
 ## License
 
-The WEB Server is licensed under the Apache License, Version 2.0.
+The WAP Server is licensed under the Apache License, Version 2.0.

build.gradle

@@ -94,6 +94,7 @@ dependencies {
 
     implementation "org.apache.jena:jena-commonsrdf:4.10.0"
     implementation "org.apache.thrift:libthrift:0.18.1"
+
     implementation "org.apache.commons:commons-rdf-jsonld-java:0.5.0"
     implementation "com.github.java-json-tools:json-schema-validator:2.2.8"
 
@@ -116,6 +117,7 @@ dependencies {
     testImplementation "io.rest-assured:rest-assured"
     testImplementation "io.rest-assured:spring-mock-mvc"
     testImplementation "io.rest-assured:rest-assured"
+    testImplementation "io.specto:hoverfly-java-junit5:0.17.1"
 
     //Java 11 Support
     testImplementation "org.mockito:mockito-inline:4.10.0"

pom.xml

@@ -109,7 +109,7 @@
             <groupId>org.apache.jena</groupId>
             <artifactId>apache-jena-libs</artifactId>
             <type>pom</type>
-            <version>3.7.0</version>
+            <version>3.8.0</version>
         </dependency>
         <dependency>
             <groupId>org.thymeleaf</groupId>
@@ -133,13 +133,13 @@
         <dependency>
             <groupId>org.apache.jena</groupId>
             <artifactId>jena-fuseki</artifactId>
-            <version>3.7.0</version>
+            <version>3.8.0</version>
             <type>pom</type>
         </dependency>
         <dependency>
             <groupId>org.apache.jena</groupId>
             <artifactId>jena-fuseki-embedded</artifactId>
-            <version>3.7.0</version>
+            <version>3.8.0</version>
         </dependency>
         <dependency>
             <groupId>com.github.java-json-tools</groupId>
@@ -181,6 +181,13 @@
             <artifactId>spring-mock-mvc</artifactId>
             <scope>test</scope>
         </dependency>
+	<!-- https://mvnrepository.com/artifact/io.specto/hoverfly-java-junit5 -->
+	<dependency>
+	    <groupId>io.specto</groupId>
+	    <artifactId>hoverfly-java-junit5</artifactId>
+	    <version>0.17.1</version>
+	    <scope>test</scope>
+	</dependency>    
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-collections4</artifactId>

src/main/java/edu/kit/scc/dem/wapsrv/model/formats/JsonLdFormatter.java

@@ -132,13 +132,10 @@ public String format(AnnotationList annoList) {
 
     @Override
     public String format(FormattableObject obj) {
-        // To be able to create correct JSON-LD, we cannot rely on the database output generated.
-        // At least when using Jena, the actual state. This might change with different backends,
-        // but not break the behavior. It might only not be necessary.
-        final String nquadsString = obj.toString(Format.NQUADS);
+        final String jsonldString = obj.toString(Format.JSON_LD);
         // Get the frame as JSON-LD string
         final String frameString = profileRegistry.getFrameString(obj.getType());
-        final String jsonLdWithBlankNodeIds = applyProfiles(nquadsString, frameString);
+        final String jsonLdWithBlankNodeIds = applyProfiles(jsonldString, frameString);
         // Details why this step is necessary is found within the method
         return removeBlankNodeIds(jsonLdWithBlankNodeIds);
     }
@@ -204,12 +201,12 @@ private String removeBlankNodeIds(String jsonLdWithBlankNodeIds) {
     private String applyProfiles(String jsonLd, String frameString) {
         try {
             final Object frameObject = frameString == null ? null : JsonUtils.fromString(frameString);
-            Object jsonObject = JsonLdProcessor.fromRDF(jsonLd);
+            Object jsonObject = JsonUtils.fromString(jsonLd);
             // Use precreated options with in memory profiles
             JsonLdOptions optionsWithContexts = profileRegistry.getJsonLdOptions();
             Map<String, Object> framed = null;
             if (frameObject != null) {
-                final JsonLdOptions options = new JsonLdOptions();
+                final JsonLdOptions options = profileRegistry.getJsonLdOptions();
                 options.format = JsonLdConsts.APPLICATION_NQUADS;
                 options.setCompactArrays(true);
                 framed = JsonLdProcessor.frame(jsonObject, frameObject, options);

src/main/java/edu/kit/scc/dem/wapsrv/repository/jena/JenaRdfBackend.java

@@ -10,6 +10,7 @@
 import org.apache.jena.query.DatasetFactory;
 import org.apache.jena.riot.Lang;
 import org.apache.jena.riot.RDFDataMgr;
+import org.apache.jena.riot.RDFFormat;
 import org.apache.jena.riot.RiotException;
 import org.apache.jena.sys.JenaSystem;
 import org.slf4j.Logger;
@@ -69,6 +70,11 @@ public String getOutput(Dataset dataset, Format format) throws WapException {
       }
       Graph graph = JenaCommonsRDF.toJena(dataset.getGraph());
       StringWriter writer = new StringWriter();
+      //Specifying format option to match behaviour of jsonld-java. Likely to break on dependency change / jena upgrade. See https://jena.apache.org/documentation/io/rdf-output.html#json-ld
+      if(format == Format.JSON_LD) {
+         RDFDataMgr.write(writer, graph, RDFFormat.JSONLD_EXPAND_PRETTY);
+         return writer.toString();
+      }
       RDFDataMgr.write(writer, graph, lang);
       // StringWriters do not have to be closed!
       return writer.toString();

src/main/resources/testdata/annotations/example101_special_character_escaping.jsonld

@@ -0,0 +1,10 @@
+{
+  "@context": "http://www.w3.org/ns/anno.jsonld",
+  "type": "Annotation",
+  "body":  {
+    "type": "TextualBody",
+    "value": "{\"text\":\"Hello \\\"world\\\"!\"}",
+    "purpose": "tagging"
+  },
+  "target": "http://example.com/page1"
+}

src/test/java/edu/kit/scc/dem/wapsrv/controller/AnnotationControllerTest.java

@@ -4,6 +4,8 @@
 import static org.mockito.Mockito.when;
 import java.util.Iterator;
 import java.util.List;
+import io.specto.hoverfly.junit5.HoverflyExtension;
+import io.specto.hoverfly.junit5.api.HoverflySimulate;
 import org.apache.commons.rdf.api.BlankNodeOrIRI;
 import org.apache.commons.rdf.api.Dataset;
 import org.apache.commons.rdf.api.IRI;
@@ -48,6 +50,8 @@
 @SpringBootTest(
       classes = {AnnotationController.class, WapServerConfig.class, JsonLdProfileRegistry.class, FormatRegistry.class,
             JsonLdFormatter.class, AnnotationServiceMock.class, TurtleFormatter.class, EtagFactory.class})
+@ExtendWith(HoverflyExtension.class)
+@HoverflySimulate(source = @HoverflySimulate.Source(value = "w3c_simulation.json", type = HoverflySimulate.SourceType.DEFAULT_PATH))
 @ActiveProfiles("test")
 class AnnotationControllerTest extends BasicWapControllerTest {
    @Autowired

src/test/java/edu/kit/scc/dem/wapsrv/controller/ContainerControllerTest.java

@@ -6,6 +6,8 @@
 import java.util.List;
 import java.util.Properties;
 import java.util.Set;
+import io.specto.hoverfly.junit5.HoverflyExtension;
+import io.specto.hoverfly.junit5.api.HoverflySimulate;
 import org.apache.commons.rdf.api.BlankNodeOrIRI;
 import org.apache.commons.rdf.api.Dataset;
 import org.apache.commons.rdf.api.IRI;
@@ -56,6 +58,8 @@
 @SpringBootTest(
       classes = {ContainerController.class, WapServerConfig.class, JsonLdProfileRegistry.class, FormatRegistry.class,
             JsonLdFormatter.class, ContainerServiceMock.class, TurtleFormatter.class, EtagFactory.class})
+@ExtendWith(HoverflyExtension.class)
+@HoverflySimulate(source = @HoverflySimulate.Source(value = "w3c_simulation.json", type = HoverflySimulate.SourceType.DEFAULT_PATH))
 @ActiveProfiles("test")
 class ContainerControllerTest extends BasicWapControllerTest {
    @Autowired

src/test/java/edu/kit/scc/dem/wapsrv/controller/PageControllerTest.java

@@ -3,6 +3,8 @@
 import static edu.kit.scc.dem.wapsrv.controller.ControllerTestHelper.checkException;
 import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.Mockito.when;
+import io.specto.hoverfly.junit5.HoverflyExtension;
+import io.specto.hoverfly.junit5.api.HoverflySimulate;
 import org.apache.commons.rdf.api.Dataset;
 import org.eclipse.jetty.http.HttpMethod;
 import org.junit.jupiter.api.Test;
@@ -41,6 +43,8 @@
 @ExtendWith(SpringExtension.class)
 @SpringBootTest(classes = {PageController.class, WapServerConfig.class, JsonLdProfileRegistry.class,
       FormatRegistry.class, JsonLdFormatter.class, ContainerServiceMock.class, TurtleFormatter.class})
+@ExtendWith(HoverflyExtension.class)
+@HoverflySimulate(source = @HoverflySimulate.Source(value = "w3c_simulation.json", type = HoverflySimulate.SourceType.DEFAULT_PATH))
 @ActiveProfiles("test")
 class PageControllerTest extends BasicWapControllerTest {
    @Autowired