Merge branch 'development' into renovate/org.springframework.boot-spring-boot-starter-actuator-3.x

Author: ThomasJejkal

.github/dependabot.yml

@@ -18,7 +18,7 @@ jobs:
       matrix:
 #        os: [ubuntu-latest, windows-latest, macos-latest]
         os: [ubuntu-latest]
-        jdk: [17]
+        jdk: [17, 21]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repo
@@ -42,15 +42,8 @@ jobs:
         run: mkdir -p /tmp/mapping-service/{schemas}
       - name: Clean
         run: ./gradlew clean
-#      - if: matrix.os == 'windows-latest'
-#        name: Test with Gradle on Windows
-#        run: ./gradlew build -DapplicationProperties="src\test\resources\test-config\application-test-windows.properties"
       - if: matrix.os != 'windows-latest'
         name: Test with Gradle on ${{ matrix.os }}
         run: ./gradlew build -DapplicationProperties="src/test/resources/test-config/application-test.properties"
       - name: Generate report
         run: ./gradlew jacocoTestReport
-#      - name: Codecov
-#        uses: codecov/codecov-action@v1
-#        with:
-#          files: ./build/reports/jacoco/test/jacocoTestReport.xml

.github/issue-branch.yml

@@ -0,0 +1,22 @@
+name: Publish mapping-plugin-core to the Maven Central Repository
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Java
+        uses: actions/setup-java@v4.7.0
+        with:
+          java-version: 17
+          distribution: 'zulu' # openjdk
+      - name: Publish package
+        run: ./gradlew -Prelease publishToSonatype closeAndReleaseSonatypeStagingRepository
+        env:
+           ORG_GRADLE_PROJECT_sonatypeUsername : ${{ secrets.OSSRH_USERNAME }}
+           ORG_GRADLE_PROJECT_sonatypePassword : ${{ secrets.OSSRH_PASSWORD }}
+           ORG_GRADLE_PROJECT_signingKey : ${{ secrets.SIGNING_KEY }}
+           ORG_GRADLE_PROJECT_signingPassword : ${{ secrets.SIGNING_SECRET }}
+           

.github/workflows/CI.yml

@@ -22,11 +22,24 @@ Dependencies that are needed to build and are not being downloaded via gradle:
 
 `./gradlew build`
 
+The build can be further customized via different build profiles. Available profiles are: 
+
+* default - Default build including tests. Used by default.
+* minimal - Minimal build without tests for fast local builds
+* deploy - Full build including tests, packaging of mapping-plugin-core, and 
+           deployment to maven-central. This build profile is supposed to be 
+           used inside a CI environment, as it requires further configuration, 
+           i.e., credentials for deployment.
+
+The different build profiles can be activated via: 
+
+`./gradlew build -PbuildProfile=minimal`
+
 ### Python Location
 
-The mapping-service supports plugins running Python code. To provide basic testing for this feature, some tests require configured Python in order to be executed.
+The mapping-service supports plugins running Python code. To provide basic testing for this feature, some tests require configured Python in order to be executable.
 While at runtime, the Python executable is configured in application.properties, at build time the Python location may differ depending on the build environment.
-By default, '/usr/bin/python' is assumed as Python location. If you are using a different Python installation, e.g., under Windows or MacOS, you may either modify 
+By default, '/usr/bin/python3' is assumed as Python location. If you are using a different Python installation, e.g., under Windows or MacOS, you may either modify 
 'build.gradle' (look out for pythonExecutable) or you provide the Python executable as command line argument, e.g.,
 
 ```
@@ -43,10 +56,15 @@ and modify it according to your needs. Espacially the following properties (at t
 | spring.datasource.url | The path points to the location of the database in which your configured mappings are stored. For production use it is not recommended to use the pre-configured H2 database!    | jdbc:h2:file:/tmp/mapping-service/database   |
 | mapping-service.pythonExecutable | The path to your local Python executable. The default uses the pythonExecutable system property provided via -DpythonExecutable= or  file:///usr/bin/python3 if no such system property is provided. | ${pythonExecutable:'file:///usr/bin/python3'}  |
 | mapping-service.pluginLocation | The local folder from where plugins are loaded. The folder will be created on startup if it does not exist. | None  |
+| mapping-service.codeLocation | The local folder where plugins can checkout code from GitHub. For Python-based plugins, also the virtual env is created in this folder. The folder will be created on startup if it does not exist. | None  |
 | mapping-service.mappingSchemasLocation | The local folder where the mapping files are stored. The folder will be created on startup if it does not exist. | None  |
 | mapping-service.jobOutput | The local folder where asynchronous mapping execution job outputs are stored. The folder will be created on startup if it does not exist. | None  |
 | mapping-service.packagesToScan | Packages scanned for mapping plugins in addition to plugins located in mapping-service.pluginLocation. Typically, this property has not the be changed. | edu.kit.datamanager.mappingservice.plugins.impl  |
 | mapping-service.executionTimeout | The timeout in seconds a plugin process, i.e., Python of Shell, may take before it is assumed to be stale. | 30 |
+| mapping-service.authEnabled | Defines if authentication is enabled or not. If enabled, additional keycloak configuration is required. | false |
+| mapping-service.mappingAdminRole | Defines the user role which must be present to be able to administrate the mapping service, i.e., add or remove mappings. | MAPPING_ADMIN |
+| management.metrics.export.prometheus.enabled | Enables or disabled capturing of prometheus metrics. | true |
+| management.endpoint.metrics.enabled | Enables or disabled the metrics actuator endpoint. This is only needed, if metrics are captured at all. | true |
 
 ## Starting the Mapping-Service
 

.github/workflows/publish-plugin-core.yml

@@ -34,12 +34,17 @@ configurations {
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
 
-if (System.getProperty('profile') == 'minimal') {
-    println 'Using minimal profile for building ' + project.getName()
+def buildPofile = project.findProperty("buildProfile") ?: "complete"
+
+if (buildPofile == "minimal") {
+    println 'Using minimal profile (no tests) for building ' + project.getName()
     apply from: 'gradle/profile-minimal.gradle'   
-} else {
-    println 'Using default profile executing all tests for building ' + project.getName()
-    apply from: 'gradle/profile-complete.gradle'
+} else if (buildPofile == "deploy") {
+    println 'Using release profile for building ' + project.getName()
+    apply from: 'gradle/profile-deploy.gradle'
+}else {
+    println 'Using default profile (all tests) for building ' + project.getName()
+    apply from: 'gradle/profile-default.gradle'
 }
 
 repositories {
@@ -68,7 +73,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
 
     // monitoring
-    implementation 'io.micronaut.micrometer:micronaut-micrometer-registry-prometheus:5.8.0'
+    implementation 'io.micronaut.micrometer:micronaut-micrometer-registry-prometheus:5.10.2'
     implementation 'org.springframework.boot:spring-boot-starter-actuator:3.4.5'
 
      // springdoc
@@ -122,10 +127,12 @@ dependencies {
     asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor:3.0.3'
 }
 
+//customization of java compile task
 tasks.withType(JavaCompile) {
     options.compilerArgs += ['-Xlint:unchecked']
 }
 
+//test configuration
 test {
     outputs.dir snippetsDir
     finalizedBy jacocoTestReport
@@ -138,24 +145,19 @@ test {
     testLogging.showStandardStreams = true
 }
 
+//jacoco configuration
 jacoco {
     toolVersion = "0.8.13"
 }
 
-jacocoTestReport{
-    dependsOn test
-    reports {
-        xml.required = true
-        html.required = true
-    }
-}
-
+//asciidoctor configuration, i.e., snippet dir
 asciidoctor {
     inputs.dir snippetsDir
     configurations 'asciidoctorExt'
     dependsOn test
 }
 
+//generation task of boot jar
 bootJar {
     dependsOn asciidoctor
     //dependsOn 'buildPluginJar'
@@ -168,50 +170,36 @@ bootJar {
     manifest {
         attributes 'Main-Class': 'org.springframework.boot.loader.launch.PropertiesLauncher'
     }
-   //exclude '**/plugins/impl/**'
-
-   // from('build/libs/default-plugins-1.1.2-SNAPSHOT.jar') {
-   //     into('BOOT-INF/lib/plugins' )
-   //  }
     launchScript()
 }
 
-if (project.hasProperty('release')) {
-    println 'Using \'release\' profile for building ' + project.getName()
-    apply from: 'gradle/profile-deploy.gradle'
-}
-
+//add build info into manifest
 springBoot {    
     buildInfo()
 }
 
+//properties made available for bootRun task execution
 bootRun {
     systemProperty "spring.config.location", "file:$projectDir/"
     systemProperty "pythonLocation", pythonExecutable
 }
 
+//define how a new version is tagged and where version information may come from
 release {
     tagTemplate = 'v${version}'
+    versionPropertyFile = 'gradle.properties'
+    versionProperties   = ['version', 'mainversion']
 }
 
+//Do not generate entire project jar
 tasks.named("jar") {
     enabled = false
 }
 
-//task buildPluginJar(type: Jar) {
-//  description = 'Bundeling plugin core classes'
-//    archiveFileName.set("plugin-core-${version}.jar")
-//    from sourceSets.main.output
-//   include '**/configuration/ApplicationProperties.class', 
-//            '**/exception.BadExitCodeException.class', 
-//            '**/plugins/AbstractPythonMappingPlugin.class', 
-//            '**/plugins/IMappingPlugin.class', 
-//            '**/plugins/MappingPluginException.class', 
-//            '**/plugins/MappingPluginState.class', 
-//            '**/util/PythonRunnerUtil.class', 
-//            '**/util/ShellRunnerUtil.class'
-//    includeEmptyDirs false
-//}
+// Disable generation of Gradle module metadata (.module file)
+tasks.withType(GenerateModuleMetadata).configureEach {
+    enabled = false
+}
 
 // task for printing project name.
 // should be the last task inside file