Merge for version 3.0.0

.circleci/config.yml

@@ -0,0 +1,36 @@
+version: 2
+jobs:
+  build:
+
+    working_directory: ~/repo
+
+    docker:
+    - image: circleci/openjdk:8-jdk
+
+    steps:
+
+    - checkout
+
+    - run:
+        name: Clean & install
+        command: ./gradlew clean build -x test --no-daemon -s
+
+    - run:
+        name: Tests
+        command: ./gradlew test -s
+
+    - store_test_results:
+        path: build/test-results
+
+    - run:
+        name: Collect artifacts
+        command: |
+          mkdir -p artifacts/libs
+          mkdir -p artifacts/schema
+          cp -pR build/libs/* artifacts/libs || true
+          cp -pR build/resources/main/scenarioo-schemas/*.xsd artifacts/schema || true
+          cp -pR LICENSE.txt artifacts/
+
+    - store_artifacts:
+        path: artifacts
+        destination: /

README.md

@@ -6,11 +6,13 @@ Scenarioo Writer API for Java to generate Scenarioo Documentations - http://www.
 ## Usage
 Scenarioo-Java is available on maven central: Include the latest version as a dependency in your favorite 
 dependency management system:
-`compile 'org.scenarioo:scenarioo-java:2.1.1'`
+`implementation 'org.scenarioo:scenarioo-java:3.0.0'`
+
+Notice that at least Java 8 is required for version 3.0.0 of the writer library
 
 You will find more information in our [usage guide](docs/usage.md).
 
 
 ## Development
 Refer to our 
-[Release new API](docs/release-new-api.md) documentation for more information how to build and release scenarioo-java.
+[Release new API](docs/release-new-api.md) documentation for more information how to build and release scenarioo-java.

build.gradle

@@ -1,114 +1,137 @@
 /* scenarioo-api
  * Copyright (C) 2014, scenarioo.org Development Team
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * As a special exception, the copyright holders of this library give you 
- * permission to link this library with independent modules, according 
+ * As a special exception, the copyright holders of this library give you
+ * permission to link this library with independent modules, according
  * to the GNU General Public License with "Classpath" exception as provided
  * in the LICENSE file that accompanied this code.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 
 group = 'org.scenarioo'
-version = '2.1.2-SNAPSHOT'
+version = '3.0.0-RC1'
 
 apply plugin: 'eclipse'
 apply plugin: 'java'
-apply plugin: 'maven'
+apply plugin: 'maven-publish'
 apply plugin: 'signing'
 
-sourceCompatibility=1.6
-targetCompatibility=1.6
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 dependencies {
-    compile 'org.apache.commons:commons-lang3:3.0.1'
-    compile 'commons-io:commons-io:1.3.2'
-    compile 'commons-codec:commons-codec:1.2'
-    compile 'log4j:log4j:1.2.17'
-    testCompile 'junit:junit:4.11'
+    implementation 'org.apache.commons:commons-lang3:3.0.1'
+    implementation 'commons-io:commons-io:1.3.2'
+    implementation 'commons-codec:commons-codec:1.2'
+    implementation 'org.slf4j:slf4j-api:1.7.31'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.3.2'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.3.2'
+
+    //These libraries are no longer provided in Java 9+, thus we need to add them manually
+    implementation 'javax.xml.bind:jaxb-api:2.3.1'
+    implementation 'com.sun.xml.bind:jaxb-core:2.3.0.1'
+    implementation 'com.sun.xml.bind:jaxb-impl:2.3.2'
 }
 
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
+}
 
 task javadocJar(type: Jar) {
-    classifier = 'javadoc'
+    archiveClassifier.set('javadoc')
     from javadoc
 }
 
 task sourcesJar(type: Jar) {
-    classifier = 'sources'
+    archiveClassifier.set('sources')
     from sourceSets.main.allSource
 }
 
 artifacts {
     archives javadocJar, sourcesJar
 }
 
-signing {
-    sign configurations.archives
-}
-
 tasks.withType(Javadoc) {
     options.addStringOption('Xdoclint:none', '-quiet')
 }
 
-uploadArchives {
-    repositories {
-        mavenDeployer {
-            beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
-
-            repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
-                authentication(userName: ossrhUsername, password: ossrhPassword)
-            }
-
-            snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
-                authentication(userName: ossrhUsername, password: ossrhPassword)
-            }
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+            from components.java
+            artifact sourcesJar
+            artifact javadocJar
 
-            pom.project {
-                name 'Scenarioo java'
-                packaging 'jar'
-                description 'Scenarioo Writer library for Java to generate Scenarioo Documentation http://www.scenarioo.org'
-                url 'http://www.scenarioo.org'
+            pom {
+                name = 'Scenarioo Java'
+                packaging = 'jar'
+                description = 'Scenarioo Writer library for Java to generate Scenarioo Documentation http://www.scenarioo.org'
+                url = 'http://www.scenarioo.org'
 
                 scm {
-                    connection 'https://github.com/scenarioo/scenarioo-java.git'
-                    developerConnection 'https://github.com/scenarioo/scenarioo-java.git'
-                    url 'https://github.com/scenarioo/scenarioo-java.git'
+                    connection = 'https://github.com/scenarioo/scenarioo-java.git'
+                    developerConnection = 'https://github.com/scenarioo/scenarioo-java.git'
+                    url = 'https://github.com/scenarioo/scenarioo-java.git'
                 }
 
                 licenses {
                     license {
-                        name 'GNU GENERAL PUBLIC LICENCE with linking exception'
-                        url 'https://github.com/scenarioo/scenarioo-java/blob/develop/LICENSE.txt'
+                        name = 'GNU GENERAL PUBLIC LICENCE with linking exception'
+                        url = 'https://github.com/scenarioo/scenarioo-java/blob/develop/LICENSE.txt'
                     }
                 }
 
                 developers {
                     developer {
-                        id 'scenarioo'
-                        name 'Scenarioo'
-                        email '[email protected]'
+                        id = 'scenarioo'
+                        name = 'Scenarioo'
+                        email = '[email protected]'
                     }
                 }
             }
         }
     }
+
+    repositories {
+        maven {
+            if (version.contains("SNAPSHOT")) {
+                url "https://oss.sonatype.org/content/repositories/snapshots/"
+            } else {
+                url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
+            }
+            credentials {
+                username ossrhUsername
+                password ossrhPassword
+            }
+        }
+    }
+}
+
+if (ossrhPassword) {
+    signing {
+        sign publishing.publications.mavenJava
+    }
 }
 
 task generateSchema(type: JavaExec) {
@@ -118,10 +141,9 @@ task generateSchema(type: JavaExec) {
 
 jar.dependsOn generateSchema
 
-// Prevent Eclipse "Gradle -> Refresh All" to execute cleanEclipseJdt,
-// because it would delete our version of the org.eclipse.jdt.ui.prefs file.
-cleanEclipse.dependsOn = cleanEclipse.taskDependencies.values - cleanEclipseJdt
+wrapper {
+    distributionType = Wrapper.DistributionType.ALL
+    gradleVersion = "6.7.1"
+}
+
 
-task wrapper(type: Wrapper) {
-    gradleVersion = '3.3'
-}

docs/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Scenarioo Writer Library for Java Release Notes
+
+## Version 3.0.0
+
+### Upgrade to Java 8
+
+* [#725 - Migrate to JUnit 5](https://github.com/scenarioo/scenarioo-java/issues/20)
+
+With version 3, the Java Writer Library needs at least Java 8 to run.
+
+### Readiness for Java 11
+
+* [#22 - Runtime errors when using the writer with Java 11](https://github.com/scenarioo/scenarioo-java/issues/22)
+
+Java 11 does not include Java EE libraries anymore. Since scenarioo-java relies on JAXB for writing the XML files, 
+we need to provide the dependencies out of the box. Users of Java 11+ should switch to this version, if they don't want 
+to supply the missing dependencies themselves.
+
+
+### Improvements to the details interface
+
+* [#1 - Improve details interface & API documentation](https://github.com/scenarioo/scenarioo-java/issues/1)
+
+The possibility to add details via the API has been improved by a few more method overloads. For more details see the [Details class](https://github.com/scenarioo/scenarioo-java/blob/develop/src/main/java/org/scenarioo/model/docu/entities/generic/Details.java)

docs/release-new-api.md

@@ -8,20 +8,18 @@ The `scenarioo-java` repository has two branches: `develop` for developing the n
 
 Precondition: Before considering a release, make sure that the new version is well tested. If you are not 100% sure about the quality of the code, make a release candidate first and test it well in a realistic environment.
 
-## Release to master branch
-
-1. Finalize the code in the `develop` branch of `scenarioo-java` by setting the correct version number in the `build.gradle` file. This version number must not exist yet in mavem central. Remove `SNAPSHOT` from the version number and add `-RCx` for release candidates where `x` is the RC number.
-2. Make sure the build runs on the `develop` branch by running `./gradlew clean build`. Then commit to `develop`.
-3. Now checkout the `master` branch and merge `develop` into it, commit.
-4. Still on the `master` branch, add a tag with the release version number and push the tag.
-5. Checkout `develop` again, change the version in `build.gradle` to the next `x.y.z-SNAPSHOT` version and commit. `x.y` corresponds to the last release version and `z` is incremented by one compared to the last release.
-
-## Release to maven repository
-
-1. Checkout the `master` branch tag that contains the release you just made.
-2. Follow the steps [Publish release to maven central](upload-to-maven-central.md).
-3. Change the version used in the webapplication (repository 'scenarioo' on appropriate branch) to use the newer version and commit.
-
-## Write release notes
-
-Write release notes for the new release on GitHub ([here](https://github.com/scenarioo/scenarioo-java/releases))
+1. Finalize the code in the `develop` branch of `scenarioo-java` by setting the correct version number in the `build.gradle` file. This version number must not exist yet in mavem central. Remove `SNAPSHOT` from the version number and add `-RCx` for release candidates where `x` is the RC number for further release candidate testing.
+2. You have to manually [Publish the signed snapshot to maven central](upload-to-maven-central.md)) this is currently not automated.
+3. Make sure the changelog.md is updated for the new version
+
+## Final Release to master branch
+
+1. Precondition: see Prepare Release above.
+2. Set the final version number in develop or release branch (without `-SNAPSHOT` or `-RC`) in `build.gradle` and merge it to the develop branch (or the release branch).
+3. You have to manually [Publish the signed release to maven central](upload-to-maven-central.md)) this is currently not automated.
+4. Promote the final release to maven central: http://central.sonatype.org/pages/releasing-the-deployment.html
+5. Add a tag with the release version number to the commit where you set that version number and push the tag.
+6. **Write Release Notes** for the new release on GitHub ([here](https://github.com/scenarioo/scenarioo-java/releases))
+7. Merge the release branch to master.
+8. **IMPORTANT - Increase Version to next snapshot version on Develop Branch:** Checkout `develop` again, change the version in `build.gradle` to the next `x.y.z-SNAPSHOT` version and commit. `x.y` corresponds to the last release version and `z` is incremented by one compared to the last release.
+9. **Switch Scenarioo Viewer Webapp to newest version:** Go to repo `scenarioo` and change the version of the writer library used to the newest version and commit and push (--> PR to next release branch or to develop).

docs/upload-to-maven-central.md

@@ -1,19 +1,25 @@
 # Upload to maven central
+
 ## Snapshot
-1. You will need to specify the following properties in your gradle.properties located in your gradle home directory:
 
-```
-signing.keyId=BDCAAE60
-signing.password=#private key goes here#
-signing.secretKeyRingFile=#secret key file goes here#
-ossrhUsername=scenarioo
-ossrhPassword=#sonatype password goes here#
-```
+1. You will need to specify the following properties in your `gradle.properties` located in your gradle home directory:
+
+   ```
+   signing.keyId=BDCAAE60
+   signing.password=#private key goes here#
+   signing.secretKeyRingFile=#secret key file goes here#
+   ossrhUsername=scenarioo
+   ossrhPassword=#sonatype password goes here#
+   ```
+The credentials can be found in the internal MS Teams Channel.
 
-2. Change the version appropriately in the build.gradle
-3. `gradlew clean uploadArchives`
+
+2. Change the version appropriately in the `build.gradle`
+3. `gradlew clean publish`
+4.  Promote build to maven central: http://central.sonatype.org/pages/releasing-the-deployment.html  
+    Please note, we're using the old server https://oss.sonatype.org.
 
 ## Releases
-Same steps as for snapshot releases and
-4. Promote build to maven central:
-http://central.sonatype.org/pages/releasing-the-deployment.html
+
+Same steps as for snapshot releases and then promote build to maven central:
+http://central.sonatype.org/pages/releasing-the-deployment.html

docs/usage.md

@@ -66,4 +66,4 @@ Capture step data from UI tests using one of three strategies
 
 ## More ...
 
-* Just study the [Examples](http://scenarioo.org/docs/examples.html), there are a lot of comments in the code, that should help you a lot!
+* Just study the [Examples in the Docu](http://scenarioo.org/docs/master/examples.html), there are a lot of comments in the code, that should help you a lot!

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Sat Feb 11 10:28:39 CET 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip