Started working on separate release of plugin-core jar

Author: ThomasJejkal

README.md

@@ -48,17 +48,6 @@ and modify it according to your needs. Espacially the following properties (at t
 | 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 |
 
-## Creating Mapping Plugins
-
-There are some sample plugins available at 'edu.kit.datamanager.mappingservice.plugins.impl'. You may add your plugins to the same package and they will be available
-for your mapping-service instance (as long as you kept 'mapping-service.packagesToScan' unchanged). 
-
-Optionally, you may also develop plugins in an own repository.
-However, in order to do so you'll have to build the mapping-service once and you should provide 'build/libs/mapping-service-<VERSION>-plain.jar' at 
-as build time dependency to have the mapping plugin interface available. After building and packaging your plugin, you can copy the resulting jar file 
-to 'mapping-service.pluginLocation' to make the plugin available in your mapping-service instance.
-
-
 ## Starting the Mapping-Service
 
 The executable jar of the mapping-service is located at 'build/libs/mapping-service-<VERSION>.jar' You should copy it to some dedicated folder, 

build.gradle

@@ -10,6 +10,10 @@ plugins {
     id 'java'
     id 'application'
     id 'jacoco'
+    // plugins for release and publishing to maven repo
+    id "signing"
+    id "io.github.gradle-nexus.publish-plugin" version "2.0.0"
+    id 'maven-publish'
 }
 
 description = 'Generic mapping service supporting different mapping implementations.'
@@ -164,14 +168,19 @@ bootJar {
     manifest {
         attributes 'Main-Class': 'org.springframework.boot.loader.launch.PropertiesLauncher'
     }
-    exclude '**/plugins/impl/**'
+   //exclude '**/plugins/impl/**'
 
-    from('build/libs/default-plugins-1.1.2-SNAPSHOT.jar') {
-        into('BOOT-INF/lib/plugins' )
-     }
+   // 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'
+}
+
 springBoot {    
     buildInfo()
 }
@@ -185,11 +194,23 @@ release {
     tagTemplate = 'v${version}'
 }
 
+tasks.named("jar") {
+	enabled = false
+}
+
 task buildPluginJar(type: Jar) {
- description = 'Bundeling only plugin classes'
- archiveFileName.set("default-plugins-${version}.jar")
- from sourceSets.main.output
- include '**/plugins/impl/*.class'
+    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
 }
 
 // task for printing project name.

gradle/profile-deploy.gradle

@@ -14,6 +14,44 @@
  * limitations under the License.
  */
 
+
+// Main jar with only selected classes
+task selectedClassesJar(type: Jar) {
+    archiveClassifier = ''
+    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'
+}
+
+// Sources jar
+task sourcesJar(type: Jar) {
+    archiveClassifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+// Javadoc jar
+task javadocJar(type: Jar) {
+    archiveClassifier = 'javadoc'
+    from javadoc
+}
+
+////////////////////////////////////////////////////////////////////////////////
+//for java plugin
+//see https://docs.gradle.org/current/userguide/java_plugin.html
+////////////////////////////////////////////////////////////////////////////////
+java {
+    //package JavaDoc as part of publication
+    withJavadocJar()
+    //package Sources as part of publication
+    withSourcesJar()
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 //for plugin net.researchgate.release 
 //see https://github.com/researchgate/gradle-release
@@ -25,4 +63,98 @@ release {
     versionPropertyFile = 'gradle.properties'
     //set possible properties which may contain the version
     versionProperties = ['version', 'mainversion']
+    git {
+        //branch from where to release (default: main)
+        requireBranch.set('main')
+    }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+//for javadoc task
+//see https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html
+////////////////////////////////////////////////////////////////////////////////
+javadoc {
+    if(JavaVersion.current().isJava9Compatible()) {
+        options.addBooleanOption('html5', true)
+    }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+//for plugin io.github.gradle-nexus.publish-plugin
+//see https://github.com/gradle-nexus/publish-plugin
+////////////////////////////////////////////////////////////////////////////////
+nexusPublishing {
+    repositories {
+        sonatype()
+    }
+}
+////////////////////////////////////////////////////////////////////////////////
+//for plugin maven-publish/io.github.gradle-nexus.publish-plugin
+//see https://docs.gradle.org/current/userguide/publishing_maven.html
+////////////////////////////////////////////////////////////////////////////////
+publishing {
+    publications {
+        //define publication identity, e.g. maven, which will be used
+        //by the signing plugin, e.g. sign publishing.publications.maven
+         mavenJava(MavenPublication) {
+            artifact selectedClassesJar
+            artifact sourcesJar
+            artifact javadocJar
+
+            groupId = "edu.kit.datamanager"
+            artifactId = "mapping-plugin-core"
+            version = project.version
+
+            pom {
+                name = project['name']
+                description = project['description']
+                url = 'http://datamanager.kit.edu'
+                licenses {
+                    license {
+                        name = 'The Apache License, Version 2.0'
+                        url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                    }
+                }
+                developers {
+                    developer {
+                        id = 'Jejkal'
+                        name = 'Thomas Jejkal'
+                        email = 'webmaster@datamanager.kit.edu'
+                    }
+                }
+                scm {
+                    connection = 'scm:git:github.com/kit-data-manager/service-base'
+                    developerConnection = 'scm:git:github.com/kit-data-manager/service-base'
+                    url = 'https://github.com/kit-data-manager/service-base'
+                }
+            }         
+        }
+    }
+}
+////////////////////////////////////////////////////////////////////////////////
+//for plugin signing
+//see https://docs.gradle.org/current/userguide/signing_plugin.html
+////////////////////////////////////////////////////////////////////////////////
+signing {
+    //make signing required unless for SNAPSHOT releases or if signing is explicitly skipped
+    required { !project.version.endsWith("-SNAPSHOT") && !project.hasProperty("skipSigning") }
+   
+    //look for property 'signingKey'
+    if (project.findProperty("signingKey")) {
+        //If required, read a sub-key specified by its ID in property signingKeyId
+        //def signingKeyId = findProperty("signingKeyId")
+        //read property 'signingKey'
+        def signingKey = findProperty("signingKey")
+        //read property 'signingPassword'
+        def signingPassword = findProperty("signingPassword")   
+        //Select to use in-memory ascii-armored keys
+        useInMemoryPgpKeys(signingKey, signingPassword)
+        //Only if also using signingKeyId
+        //useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
+
+        //Apply signing to publication identity 'publishing.publications.maven'
+        sign publishing.publications.maven
+    }else {
+        println 'WARNING: No property \'signingKey\' found. Artifact signing will be skipped.'
+    }
 }

src/main/java/edu/kit/datamanager/mappingservice/impl/JobManager.java

@@ -62,7 +62,7 @@ public CompletableFuture<? extends JobStatus> getJob(String jobId) {
      * Remove the job with the provided id. Keep in mind, that removing the job
      * from the JobManager won't remove job outputs.
      *
-     * @param The job's id.
+     * @param jobId The job's id.
      */
     public void removeJob(String jobId) {
         mapOfJobs.remove(jobId);

src/main/java/edu/kit/datamanager/mappingservice/util/ShellRunnerUtil.java

@@ -22,10 +22,8 @@
 import org.slf4j.LoggerFactory;
 
 import java.io.*;
-import java.util.List;
 import java.util.Scanner;
 import java.util.concurrent.*;
-import java.util.stream.Collectors;
 
 /**
  * Utility class for running shell scripts.

src/test/java/edu/kit/datamanager/mappingservice/python/util/PythonUtilsTest.java

@@ -125,7 +125,7 @@ public void testRun_3args_withNoOutputStreams() {
             PythonRunnerUtil.runPythonScript(scriptLocation, null, null, arguments);
             fail("Expected MappingPluginException");
         } catch (MappingPluginException e) {
-            assertEquals(MappingPluginState.StateEnum.UNKNOWN_ERROR, e.getMappingPluginState().getState());
+            assertEquals(MappingPluginState.StateEnum.INVALID_INPUT, e.getMappingPluginState().getState());
         }
     }
 }