Merge pull request #171 from dice-group/develop

fixed deployment and some glitches in javadoc html

.github/workflows/ci.yml

@@ -39,6 +39,7 @@ jobs:
       - run: sed -i "s/\$VERSION/$(cat version.log)/g" mkdocs.yml
       - run: sed -i "s/\$RELEASE_VERSION/${{ env.RELEASE_VERSION }}/g" mkdocs.yml
       - run: mkdocs build -d site/$(cat version.log)
+      - run: mvn install -Dmaven.test.skip=true
       - run: mvn javadoc:javadoc
       - run: sed -i "s/\$VERSION/$(cat version.log)/g" .github/pages/latest.html
       - run: sed -i "s/\$VERSION/$(cat version.log)/g" .github/pages/javadoc-latest.html
@@ -68,10 +69,9 @@ jobs:
           publish_dir: .github/pages/
           keep_files: true
           destination_dir: ./docs/
-      - run: mvn install -Dmaven.test.skip=true
       - run: mkdir iguana
-      - run: cp target/start.sh iguana/
-      - run: cp target/iguana-${{ env.RELEASE_VERSION }}-shaded.jar iguana/iguana-${{ env.RELEASE_VERSION }}.jar
+      - run: cp target/start-iguana.sh iguana/
+      - run: cp target/iguana-${{ env.RELEASE_VERSION }}.jar iguana/iguana-${{ env.RELEASE_VERSION }}.jar
       - run: cp example-suite.yml iguana/
       - run: zip -r iguana-${{ env.RELEASE_VERSION }}.zip iguana/
       - name: Create Release
@@ -84,7 +84,7 @@ jobs:
           release_name: version ${{ env.RELEASE_VERSION }}
           draft: false
           prerelease: false
-          body_path: CHANGELOG.md
+          body: ""
       - uses: actions/upload-release-asset@v1.0.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -94,6 +94,6 @@ jobs:
           asset_name: iguana-${{ env.RELEASE_VERSION }}.zip
           asset_content_type: application/zip
       - name: Publish package
-        run: mvn --batch-mode deploy
+        run: mvn --batch-mode deploy -Dmaven.test.skip=true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,33 +1,237 @@
+**/javadoc/*
+**/.idea/*
+deptree.txt
+tmp_ser
+
+**/queryInstances/*
+
+# Created by https://www.toptal.com/developers/gitignore/api/java,maven,intellij,eclipse
+# Edit at https://www.toptal.com/developers/gitignore?templates=java,maven,intellij,eclipse
+
+### Eclipse ###
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# CDT- autotools
+.autotools
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Annotation Processing
+.apt_generated/
+.apt_generated_test/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+
+# Uncomment this line if you wish to ignore the project description file.
+# Typically, this file would be tracked if it contains build/dependency configurations:
+#.project
+
+### Eclipse Patch ###
+# Spring Boot Tooling
+.sts4-cache/
+
+### Intellij ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Java ###
+# Compiled class file
 *.class
-.classpath
-.project
-.settings
-target
 
-#bin
-#cache
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
 
 # Package Files #
-#*.jar
+*.jar
 *.war
+*.nar
 *.ear
+*.zip
+*.tar.gz
+*.rar
 
-#Idea files
-.idea/*
-*.iml
-*.log
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
 
+### Maven ###
+target/
+pom.xml.tag
 pom.xml.releaseBackup
 pom.xml.versionsBackup
+pom.xml.next
 release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+# Eclipse m2e generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# End of https://www.toptal.com/developers/gitignore/api/java,maven,intellij,eclipse
 
-deptree.txt
-tmp_ser
 
-queryInstances
-iguana.commons/bin/
-iguana.corecontroller/bin/
-iguana.taskprocessor/bin/
-iguana.datagenerator/bin/
-iguana.webcontroller/bin/
-iguana.resultprocessor/bin/

iguana.commons/src/main/java/org/aksw/iguana/commons/streams/Streams.java

@@ -43,7 +43,7 @@ static public ByteArrayOutputStream inputStream2String(InputStream inputStream)
      *
      * @param inputStream the stream to read from
      * @param startTime   a time when the computation started
-     * @param timeout     delta from startTime when the computation must be completed. Otherwise, a TimeoutException may be thrown. Timeout check is deactivated if timeout is < 0.
+     * @param timeout     delta from startTime when the computation must be completed. Otherwise, a TimeoutException may be thrown. Timeout check is deactivated if timeout is &lt; 0.
      * @return the content of inputStream as a string.
      * @throws IOException      from {@link InputStream#read()}
      * @throws TimeoutException Maybe thrown any time after if startTime + timeout is exceeded

iguana.corecontroller/pom.xml

@@ -8,7 +8,7 @@
   <artifactId>iguana.corecontroller</artifactId>
 
   <name>Iguanas Core Controller</name>
-  <description>The Controller of Iguanas Core Module. Handeling the messaging and is coordinating the ResultProcessor as well as the dataGenerator. Will be communicating with the Web Controller Module.</description>
+  <description>The Controller of Iguanas Core Module. Handling the messaging and is coordinating the ResultProcessor as well as the dataGenerator. Will be communicating with the Web Controller Module.</description>
 	<licenses>
 		<license>
 			<name>AGPLv3 or later</name>
@@ -142,6 +142,7 @@
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
 				<artifactId>exec-maven-plugin</artifactId>
+				<version>1.5.0</version>
 			</plugin>
 			<plugin>
 				<artifactId>maven-dependency-plugin</artifactId>
@@ -178,8 +179,8 @@
 				<artifactId>maven-shade-plugin</artifactId>
 				<version>2.4.3</version>
 				<configuration>
-					<finalName>iguana-${version}</finalName>
-					<outputDirectory>./target</outputDirectory>
+					<finalName>iguana-${revision}</finalName>
+					<outputDirectory>${project.parent.basedir}/target</outputDirectory>
 				</configuration>
 				<executions>
 					<execution>

iguana.corecontroller/src/main/java/org/aksw/iguana/cc/config/IguanaConfig.java

@@ -23,7 +23,7 @@
 
 /**
  * Gets either a JSON or YAML configuration file using a json schema and will generate
- * a SuiteID and ExperimentIDs as well as TaskIDs for it.</br>
+ * a SuiteID and ExperimentIDs as well as TaskIDs for it.<br/>
  * Afterwards it will start the taskProcessor with all specified tasks
  * <br/><br/>
  * The following order holds

iguana.corecontroller/src/main/java/org/aksw/iguana/cc/worker/impl/CLIWorker.java

@@ -20,9 +20,9 @@
 /**
  * Worker to execute a query again a CLI process, the connection.service will be the command to execute the query against.
  *
- * command may look like the following<br></br>
+ * command may look like the following<br><br/>
  * cliprocess.sh $QUERY$ $USER$ $PASSWORD$
- * </br>
+ * <br/>
  * whereas $QUERY$ will be exchanged with the actual query as well as user and password.
  * Further on it is possible to encode the query using $ENCODEDQUERY$ instead of $QUERY$
  *

iguana.corecontroller/src/main/java/org/aksw/iguana/cc/worker/impl/HttpGetWorker.java

@@ -17,7 +17,7 @@
 
 /**
  * HTTP Get Worker.
- * Uses HTTP Get to execute a Query.</br></br>
+ * Uses HTTP Get to execute a Query.<br/><br/>
  * if the parameter type was not set it will use 'query' as the parameter as default, otherwise it will use the provided parameter
  */
 @Shorthand("HttpGetWorker")

iguana.corecontroller/src/main/java/org/aksw/iguana/cc/worker/impl/HttpPostWorker.java

@@ -14,8 +14,8 @@
 /**
  * HTTP Post worker.
  * Uses HTTP posts to execute a query.
- * </br></br>
- * Sends the query in plain as POST data if parameter type was not set, otherwise uses json as follows:</br>
+ * <br/><br/>
+ * Sends the query in plain as POST data if parameter type was not set, otherwise uses json as follows:<br/>
  * {PARAMETER: QUERY}
  */
 @Shorthand("HttpPostWorker")

iguana.resultprocessor/src/main/java/org/aksw/iguana/rp/metrics/AbstractMetric.java

@@ -87,7 +87,7 @@ public void setMetaData(Properties metaData){
 
 
 	/**
-	 * Will return the Properties Object with the associated key: EXTRA_META_KEY</br>
+	 * Will return the Properties Object with the associated key: EXTRA_META_KEY<br/>
 	 * if this key does not exists: recv will be returned
 	 *
 	 * @param recv