Development branch for v2.0.0

.github/workflows/codeql-analysis.yml

@@ -1,14 +1,4 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
+# CodeQL code analysis
 name: "CodeQL"
 
 on:
@@ -40,8 +30,7 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
+    - name: Initialize CodeQL tools for scanning
       uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
@@ -52,19 +41,23 @@ jobs:
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+    #- name: Autobuild
+    #  uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
+    - name: Set up openJDK version
+      uses: actions/setup-java@v3
+      with:
+        java-version: 17
+        distribution: 'zulu'  # =openJDK
+    - name: Grant execute permission for gradlew
+      run: chmod +x gradlew
+    - name: Validate Gradle wrapper
+      uses: gradle/wrapper-validation-action@v1
+    - name: Build (no tests)
+      uses: gradle/gradle-build-action@v2
+      with:
+        gradle-home-cache-cleanup: true
+        arguments: clean build -x test
 
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v2

.github/workflows/gradle.yml

@@ -5,9 +5,14 @@ name: Build and Test
 
 on:
   push:
-    branches: [ master, main ]
+    branches:
+      - master
+      - main
   pull_request:
-    branches: [ master, main ]
+    branches:
+      - master
+      - main
+      - 'dev**'
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
@@ -21,7 +26,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest, macOS-latest, windows-latest]
-        jdk: [ 11, 17 ]  # (open)JDK releases
+        jdk: [ 17 ]  # (open)JDK releases
 
     steps:
     - uses: actions/checkout@v4

build.gradle

@@ -1,12 +1,12 @@
 plugins {
     // Spring boot & dependency management:
     // https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/htmlsingle/
-    id 'org.springframework.boot' version '2.7.15'
+    id 'org.springframework.boot' version '3.1.5'
     // https://docs.spring.io/dependency-management-plugin/docs/current-SNAPSHOT/reference/html/
     id "io.spring.dependency-management" version "1.1.3"
     // Lombok generates getter and setter and more. https://projectlombok.org/
     // check for new versions here: https://plugins.gradle.org/plugin/io.freefair.lombok
-    id "io.freefair.lombok" version "8.3"
+    id "io.freefair.lombok" version "8.4"
     // Release tagging with `./gradlew release`
     // Check for new versions here: https://plugins.gradle.org/plugin/net.researchgate.release
     // Usage: https://github.com/researchgate/gradle-release
@@ -19,21 +19,19 @@ plugins {
     id 'jacoco'
     // Adds coveralls task for CI to send results to the coveralls service.
     id "com.github.kt3k.coveralls" version "2.12.2"
-    //id "com.github.kt3k.coveralls" version "2.12.0" 
     id "org.owasp.dependencycheck" version "8.4.0"
-    id 'org.asciidoctor.jvm.convert' version '3.3.2'
     // include build and git information via Spring Actuator
     id "com.gorylenko.gradle-git-properties" version "2.4.1"
 }
 
 lombok {
     // check here for new versions: https://projectlombok.org/download
-    version = '1.18.22'
+    version = '1.18.30'
 }
 
 jacoco {
     // check here for new versions: https://www.jacoco.org/jacoco/
-    toolVersion = "0.8.7"
+    toolVersion = "0.8.11"
 }
 
 archivesBaseName = 'TypedPIDMaker'
@@ -51,16 +49,16 @@ repositories {
 }
 
 ext {
-    springDocVersion  = '1.7.0'
+    springDocVersion  = '2.2.0'
 }
 
 dependencies {
     // Due to the spring boot gradle plugin, we can omit versions in org.springframework.*
     // dependencies. It will automatically choose the fitting ones.
-    implementation("edu.kit.datamanager:service-base:1.1.1")
-    implementation("edu.kit.datamanager:repo-core:1.1.2")
+    implementation("edu.kit.datamanager:service-base:1.2.0")
+    implementation("edu.kit.datamanager:repo-core:1.2.1")
     // com.google.common, LoadingCache
-    implementation("com.google.guava:guava:32.1.2-jre")
+    implementation("com.google.guava:guava:32.1.3-jre")
     // Required by Spring/Javers at runtime
     implementation 'com.google.code.gson:gson:2.10.1'
 
@@ -79,9 +77,8 @@ dependencies {
     // @EnableJPARepositories
     implementation "org.springframework.boot:spring-boot-starter-data-jpa"
     // springdoc / openapi / swagger
-    implementation "org.springdoc:springdoc-openapi-ui:${springDocVersion}"
-    implementation "org.springdoc:springdoc-openapi-data-rest:${springDocVersion}"
-    implementation "org.springdoc:springdoc-openapi-webmvc-core:${springDocVersion}"
+    implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:${springDocVersion}"
+    implementation "org.springdoc:springdoc-openapi-starter-webmvc-api:${springDocVersion}"
     // spring + elasticsearch communication
     implementation "org.springframework.data:spring-data-elasticsearch"
 
@@ -102,6 +99,8 @@ dependencies {
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")
     testImplementation("org.springframework.security:spring-security-test")
+
+    testImplementation("com.jayway.jsonpath:json-path:2.8.0")
 }
 
 application {
@@ -121,12 +120,6 @@ bootJar {
         attributes 'Main-Class': 'org.springframework.boot.loader.PropertiesLauncher'
     }
 
-    // Include documentation to be available on runtime.
-    dependsOn asciidoctor
-    from ("${asciidoctor.outputDir}/html5") {
-        into 'static/docs'
-    }
-
     // Make the Typed PID Maker executable without `java -jar`
     // by adding a launch script into the jar file.
     // Works only on unix platforms.
@@ -190,9 +183,12 @@ jacocoTestReport {
         //exclude some classes/package from code coverage report
         classDirectories.setFrom(files(classDirectories.files.collect {
                     fileTree(dir: it, exclude: [\
-            'edu/kit/datamanager/collection/configuration/**', \
-            'edu/kit/datamanager/collection/filters/**', \
-            'edu/kit/datamanager/collection/Application*'
+            'edu/kit/datamanager/pit/configuration/**', \
+            'edu/kit/datamanager/pit/web/converter/**', \
+            'edu/kit/datamanager/pit/web/ExtendedErrorAttributes**', \
+            'edu/kit/datamanager/pit/web/UncontrolledExceptionHandler**', \
+            'edu/kit/datamanager/pit/common/**', \
+            'edu/kit/datamanager/pit/Application*'
                         ])
                 }))
     }
@@ -209,3 +205,8 @@ release {
         requireBranch.set("master")
     }
 }
+
+tasks.withType(Jar).all { duplicatesStrategy(DuplicatesStrategy.EXCLUDE) }
+tasks.withType(Tar).all { duplicatesStrategy(DuplicatesStrategy.EXCLUDE) }
+tasks.withType(Copy).all { duplicatesStrategy(DuplicatesStrategy.EXCLUDE) }
+tasks.withType(Zip).all { duplicatesStrategy(DuplicatesStrategy.EXCLUDE) }

config/application.properties

@@ -1,4 +1,8 @@
-### General Spring Boot Settings (do not change!) ###
+### General Spring Boot Settings ###
+# When to include "message" attribute in HTTP responses on uncatched exceptions.
+server.error.include-message: always
+springdoc.show-actuator=true
+# Do __not__ change these settings below:
 spring.main.allow-bean-definition-overriding=true
 spring.data.rest.detection-strategy:annotated
 #####################################################
@@ -89,9 +93,16 @@ spring.autoconfigure.exclude=org.keycloak.adapters.springboot.KeycloakAutoConfig
 
 # enables search endpoint at /api/v1/search
 repo.search.enabled: false
+repo.search.index: *
 management.health.elasticsearch.enabled: false
+
+# TO BE REMOVED!
 repo.search.url: http://localhost:9200
-repo.search.index: *
+# Soon will be:
+#spring.elasticsearch.uris=http://localhost:9200
+#spring.elasticsearch.username=user
+#spring.elasticsearch.password=secret
+#spring.elasticsearch.socket-timeout=10s
 
 #################
 ### Messaging ###
@@ -126,17 +137,13 @@ pit.pidsystem.handle.baseURI = http://hdl.handle.net/
 # - IN_MEMORY (default, sandboxed, non-permanent PIDs, for short testing / demonstration only),
 # - LOCAL (sandboxed, uses local database, no public PIDs!, for long term testing or special use-cases),
 # - HANDLE_PROTOCOL (recommended, for real FAIR Digital Objects),
-# - HANDLE_REST (deprecated, for legacy prefixes)
 pit.pidsystem.implementation = LOCAL
 # If you chose IN_MEMORY, no further configuration is required.
+# If you chose LOCAL, no further configuration is required.
 # If you chose HANDLE_PROTOCOL, you need to set up your prefix and its key/certificate:
 #pit.pidsystem.handle-protocol.credentials.handleIdentifierPrefix = 21.T11981  # prefix string
 #pit.pidsystem.handle-protocol.credentials.userHandle = 21.T11981/USER01  # user PID
 #pit.pidsystem.handle-protocol.credentials.privateKeyPath = test_prefix_data/21.T11981_USER01_300_privkey.bin  # private key/certificate file
-# If you chose HANDLE_REST, you need to add credentials and the prefix:
-#pit.pidsystem.handle.userName = 21.T11981/USER01
-#pit.pidsystem.handle.userPassword = ...
-#pit.pidsystem.handle.generatorPrefix = 21.T11981
 
 ### Base URL for the DTR used. ###
 # Currently, we support the DTRs of GWDG/ePIC. Currently known instances: