Merge remote-tracking branch 'remotes/origin/master' into ck/#12-coverage4scala

# Conflicts:
#	.travis/build.sh
#	build.gradle

Author: ckittl

.travis.yml

@@ -1,35 +1,38 @@
-plugins{
+plugins {
 	id "com.jfrog.artifactory" version "4.9.7"
 	id 'groovy' // groovy support
 	id 'java' // java support
 	id 'scala' // scala support
 	id 'maven-publish' // publish to a maven repo (local or mvn central, has to be defined)
 	id 'pmd' // code check, working on source code
 	id 'com.github.spotbugs' version '2.0.0' // code check, working on byte code
-	id 'com.diffplug.gradle.spotless' version '3.24.2'// code format
+	id 'com.diffplug.gradle.spotless' version '3.28.1'// code format
 	id "de.undercouch.download" version "3.4.3" // downloads plugin
 	id 'jacoco' // java code coverage plugin
-	id "org.sonarqube" version "2.7.1" // sonarqube
+	id "org.sonarqube" version "2.8" // sonarqube
 	id 'org.scoverage' version '4.0.1' // Code coverage plugin for scala
 }
 
 ext {
-//version (changing these should be considered thoroughly!)
-	unitsOfMeasurementVersion = '1.0.8'
-	javaVersion = JavaVersion.VERSION_11
+	//version (changing these should be considered thoroughly!)
+	javaVersion = JavaVersion.VERSION_1_8
 
+	unitsOfMeasurementVersion = '1.0.10'
 	scalaVersion = '2.13'
-	tscfgVersion = '0.9.9'
+	tscfgVersion = '0.9.96'
 	slf4jVersion = '1.7.26'
 
 	scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
 
+group = 'com.github.ie3-institute'
+description = 'simbench4ie3'
+version = '1.0-SNAPSHOT'
+
+apply from: scriptsLocation + 'tests.gradle'
 apply from: scriptsLocation + 'pmd.gradle'
 apply from: scriptsLocation + 'spotbugs.gradle'
-apply from: scriptsLocation + 'sonarqube.gradle' // sonarqube config
 apply from: scriptsLocation + 'spotless.gradle'
-apply from: scriptsLocation + 'tests.gradle' // tasks for tests
 apply from: scriptsLocation + 'checkJavaVersion.gradle'
 apply from: scriptsLocation + 'tscfg.gradle' // config tasks
 apply from: scriptsLocation + 'jacoco.gradle' // jacoco java code coverage
@@ -38,45 +41,52 @@ apply from: scriptsLocation + 'scoverage.gradle'
 repositories {
 	jcenter() //searches in bintray's repository 'jCenter', which contains Maven Central
 	maven { url 'https://www.jitpack.io' } // allows github repos as dependencies
+
+	// sonatype snapshots repo // todo remove
+	maven { url 'https://oss.sonatype.org/service/local/repositories/snapshots/content' }
 }
 
 dependencies {
+	/* PowerSystemDataModel */
+	compile ('com.github.ie3-institute:PowerSystemDataModel:1.1-SNAPSHOT') {
+		/* Exclude nested logging and ie³ related dependencies */
+		exclude group: 'org.slf4j', module: 'slf4j-api'
+		exclude group: 'com.github.ie3-institute'
+	}
+
 	/* util functions */
-	compile ('com.github.ie3-institute:PowerSystemUtils:1.3+') {
+	compile ('com.github.ie3-institute:PowerSystemUtils:1.3.1') {
 		/* Exclude nested logging and ie³ related dependencies */
-		exclude group: 'org.slf4j'
+		exclude group: 'org.slf4j', module: 'slf4j-api'
 		exclude group: 'com.github.ie3-institute'
 	}
 
+	compile 'org.codehaus.groovy:groovy:3.0.3'
+
+	compile "tec.uom:uom-se:$unitsOfMeasurementVersion"
+
 	// logging
-	compile "org.slf4j:slf4j-api:${slf4jVersion}"  // slf4j wrapper
-	compile 'com.lmax:disruptor:3.4.2' // async logging
 	compile 'org.apache.logging.log4j:log4j-api:+' // log4j
 	compile 'org.apache.logging.log4j:log4j-core:+' // log4j
 	compile 'org.apache.logging.log4j:log4j-slf4j-impl:+' // log4j -> slf4j
 
 	compile "com.typesafe.scala-logging:scala-logging_${scalaVersion}:+" // akka scala logging
 	compile "org.slf4j:log4j-over-slf4j:${slf4jVersion}" // slf4j -> log4j
 
-	// testing
-	testCompile 'org.spockframework:spock-core:1.3-groovy-+'
-
-	compile 'javax.measure:unit-api:+'
-	compile "tec.uom:uom-se:$unitsOfMeasurementVersion" // quantities
-
 	// NEW scala libs //
 	// CORE Scala //
 	compile "org.scala-lang:scala-library:${scalaVersion}+"
 
 	// TEST Scala //
 	testCompile "org.scalatest:scalatest_${scalaVersion}:3.0.8"
 	testRuntime "org.pegdown:pegdown:1.6.0" // HTML report for scalatest
+	compile 'org.mockito:mockito-core:+' // mocking framework
 	scoverage "org.scoverage:scalac-scoverage-plugin_${scalaVersion}:1.4.1"
 	scoverage "org.scoverage:scalac-scoverage-runtime_${scalaVersion}:1.4.1"
 
 	// config //
 	implementation 'com.typesafe:config:+'
-	compile "com.github.carueda:tscfg:v${tscfgVersion}"
+	compile "com.github.carueda:tscfg_2.13:${tscfgVersion}"
 
 	// cmd args parser //
 	compile "com.github.scopt:scopt_${scalaVersion}:+"
@@ -89,61 +99,6 @@ wrapper {
 	gradleVersion = '6.0.1'
 }
 
-group = 'edu.ie3'
-version = '0.1-SNAPSHOT'
-description = 'simbench4ie3'
-sourceCompatibility = javaVersion
-targetCompatibility = javaVersion
-
-task sourcesJar(type: Jar) {
-	getArchiveClassifier().set('sources')
-	from(sourceSets.main.allSource)
-}
-
-task javadocJar(type: Jar) {
-	getArchiveClassifier().set('javadoc')
-	from(javadoc.destinationDir)
-}
-
-if (project.hasProperty('user') && project.hasProperty('password')) {
-	artifactory {
-		contextUrl = "https://simona.ie3.e-technik.tu-dortmund.de/artifactory"
-		publish {
-			repository {
-				repoKey = 'libs-snapshot-local'
-				username = project.getProperty('user')
-				password = project.getProperty('password')
-				maven = true
-			}
-			defaults {
-				publications('mavenJava')
-			}
-		}
-	}
-}
-
-publishing {
-	publications {
-		mavenJava(MavenPublication) {
-			artifactId = 'simbench4ie3'
-			from components.java
-			artifact sourcesJar
-			artifact javadocJar
-			versionMapping {
-				usage('java-api') {
-					fromResolutionOf('runtimeClasspath')
-				}
-				usage('java-runtime') {
-					fromResolutionResult()
-				}
-			}
-		}
-	}
-	repositories {
-		maven {
-			def releasesRepoUrl = "$buildDir/repos/releases"
-			def snapshotsRepoUrl = "$buildDir/repos/snapshots"
-			url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
-		}
-	}
+tasks.withType(JavaCompile) {
+	options.encoding = 'UTF-8'
 }

.travis/build.sh

@@ -8,7 +8,7 @@ tasks.register("checkJavaVersion") {
 		def foundVersion = JavaVersion.current()
 		if (foundVersion != javaVersion)
 			throw new IllegalStateException("Wrong Java version: required is "
-					+ javaVersion + ", but found " + foundVersion)
+			+ javaVersion + ", but found " + foundVersion)
 	}
 }
 compileJava.dependsOn(checkJavaVersion)

Jenkinsfile

@@ -30,18 +30,21 @@ jacocoTestReport {
 	// what to exclude from coverage report (files that should not be analyzed!)
 	// UI, "noise", generated classes, platform classes, etc.
 	def excludes = [
-			'scala/**/*.*', // exclude scala source files
-			'groovy/**/*.*', // exclude groovy source files
-			'**/**Test**.**', // exclude unit tests files
-			'**/**IT**.**' // exclude integration tests files
+		'scala/**/*.*',
+		// exclude scala source files
+		'groovy/**/*.*',
+		// exclude groovy source files
+		'**/**Test**.**',
+		// exclude unit tests files
+		'**/**IT**.**' // exclude integration tests files
 	]
 
 	getClassDirectories().setFrom(fileTree(
 			dir: "$buildDir/classes/",
 			excludes: excludes
-	))
+			))
 
-//	sourceSets sourceSets.main
+	//	sourceSets sourceSets.main
 	executionData allTests // include integration tests in jacoco reports
 }
 

build.gradle

@@ -5,19 +5,25 @@ sonarqube {
 		property 'sonar.projectName', 'simbench4ie3' // project name
 		property 'sonar.verbose', 'true' // verbose mode
 		property 'sonar.sourceEncoding', 'UTF-8' // encoding
-		property 'sonar.sources', ['src/main/resources', 'src/main/scala'] // src dirs
-		property "sonar.tests", ['src/test/resources', 'src/test/scala', 'src/test/groovy'] // test src dirs
-
+		property 'sonar.sources', [
+			'src/main/resources',
+			'src/main/scala'] // src dirs
+		property "sonar.tests", [
+			'src/test/resources',
+			'src/test/scala',
+			'src/test/groovy'] // test src dirs
 		// reports stuff (for all languages)
-		property 'sonar.junit.reportPaths', ['build/test-results/allTests'] // Comma-delimited list of paths to Surefire XML-format reports.
-
+		property 'sonar.junit.reportPaths', [
+			'build/test-results/allTests'] // Comma-delimited list of paths to Surefire XML-format reports.
 		// unit tests reports dirs
-		property "sonar.coverage.jacoco.xmlReportsPath", ["build/reports/jacoco/test/jacocoTestReport.xml"] // Comma-separated list of paths to JaCoCo (jacoco.xml) report files.
+		property "sonar.coverage.jacoco.xmlReportsPath", [
+			"build/reports/jacoco/test/jacocoTestReport.xml"] // Comma-separated list of paths to JaCoCo (jacoco.xml) report files.
 		// scapegoat report dir
 		//property "sonar.scala.scapegoat.reportPaths", ["build/reports/scapegoat/src/scapegoat-scalastyle.xml", "build/reports/scapegoat/testsrc/scapegoat-scalastyle.xml"] // Comma-delimited list of paths to Scapegoat reports in the Scalastyle format
 		// spotbugs report dir
-		property "sonar.java.spotbugs.reportPaths", ["build/reports/spotbugs/main.xml","build/reports/spotbugs/test.xml"] // Comma-delimited list of paths to reports from SpotBugs
-
+		property "sonar.java.spotbugs.reportPaths", [
+			"build/reports/spotbugs/main.xml",
+			"build/reports/spotbugs/test.xml"] // Comma-delimited list of paths to reports from SpotBugs
 		// scala specific stuff
 		//property 'sonar.scala.coverage.reportPaths', ''//todo enable when scoverage gradle plugin is available for scala 2.13
 

gradle/scripts/checkJavaVersion.gradle

@@ -1,21 +1,40 @@
 // spotless is a code formatter
 
 spotless {
+	def ie3LicHead = '/*\n' +
+			' * © $YEAR. TU Dortmund University,\n' +
+			' * Institute of Energy Systems, Energy Efficiency and Energy Economics,\n' +
+			' * Research group Distribution grid planning and operation\n' +
+			'*/'
 
 	//sets a license header, removes unused imports and formats conforming to the google java format
 	java {
 		removeUnusedImports() // removes any unused imports
 		googleJavaFormat()
-		licenseHeader '/*\n' +
-				' * © $YEAR. TU Dortmund University,\n' +
-				' * Institute of Energy Systems, Energy Efficiency and Energy Economics,\n' +
-				' * Research group Distribution grid planning and operation\n' +
-				' */\n\n'
+		licenseHeader ie3LicHead
 	}
+
 	//sets a license header, removes unused imports and formats conforming to the scala fmt formatter
 	scala {
 		scalafmt()
 	}
+
+	/* cf. https://github.com/diffplug/spotless/tree/master/plugin-gradle */
+	groovy {
+		licenseHeader ie3LicHead
+		excludeJava() // excludes all Java sources within the Groovy source dirs from formatting
+		paddedCell() // Avoid cyclic ambiguities
+		// the Groovy Eclipse formatter extends the Java Eclipse formatter,
+		// so it formats Java files by default (unless `excludeJava` is used).
+		greclipse()
+	}
+
+	groovyGradle {
+		// same as groovy, but for .gradle (defaults to '*.gradle')
+		target '*.gradle', 'gradle/scripts/*.gradle'
+		greclipse()
+	}
+
 	// removes unnecessary whitespace, indents with tabs and ends on new line for gradle, md and gitignore files and config-XMLs
 	format 'misc', {
 		target '**/*.gradle', '**/*.md', '**/.gitignore', 'configs/**'

gradle/scripts/jacoco.gradle

@@ -1,14 +1,13 @@
-test {
-	// by default we don't want to run integration tests
-	filter {
-		excludeTestsMatching '*IT'
-	}
-}
-
 // Task to run scala tests, as Scala tests are not picked up by gradle by default
 task spec(dependsOn: ['testClasses'], type: JavaExec) {
 	main = 'org.scalatest.tools.Runner'
-	args = ['-R', 'build/classes/scala/test', '-h', 'build/reports/tests/scalatest', '-oD']
+	args = [
+		'-R',
+		'build/classes/scala/test',
+		'-h',
+		'build/reports/tests/scalatest',
+		'-oD'
+	]
 	classpath = sourceSets.test.runtimeClasspath
 }
 build.dependsOn spec
@@ -21,16 +20,9 @@ task integrationTest(type: Test) {
 	}
 	mustRunAfter test
 }
-integrationTest.dependsOn(test)
 
 task allTests(type: Test) {
 	description 'executes all tests'
-	filter {
-		includeTestsMatching '*Test*.*'
-		includeTestsMatching '*IT'
-	}
-	mustRunAfter test
 	mustRunAfter spec
 }
-allTests.dependsOn(test)
 allTests.dependsOn(spec)