Merge pull request #50 from kaklakariada/refactoring

Migrate to Junit 5

Author: kaklakariada

.github/workflows/gradle.yml

@@ -39,13 +39,6 @@ jobs:
     - name: Build with Gradle
       run: ./gradlew clean build --info --warning-mode all
 
-    - name: Publish Test Report for Java ${{ matrix.java }}
-      uses: scacap/action-surefire-report@v1
-      if: always()
-      with:
-        report_paths: '**/build/test-results/*/TEST-*.xml'
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-
     - name: Sonar analysis
       if: ${{ env.DEFAULT_JAVA == matrix.java && env.SONAR_TOKEN != null }}
       run: |

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * [#29](https://github.com/kaklakariada/fritzbox-java-api/issues/29) Add support for login via Pbkdf2 challenge-response (propsed by [@linnex81](https://github.com/linnex81))
 
+### Refactoring
+
+* [#50](https://github.com/kaklakariada/fritzbox-java-api/pull/50) Migrate to Junit 5
+
 ## [1.6.0] - 2021-12-04
 
 ### Added

README.md

@@ -52,21 +52,33 @@ See [CHANGELOG.md](CHANGELOG.md).
 
 ### Run sample program
 
-1. Copy file `application.properties.template` to `application.properties` and enter settings for your device.
+1. Create file `application.properties` with the following content and enter settings for your device:
+
+    ``` properties
+    fritzbox.url = https://fritz.box
+    fritzbox.username = user
+    fritzbox.password = secret
+    ```
 2. Run example class [`TestDriver`](https://github.com/kaklakariada/fritzbox-java-api/blob/master/src/main/java/com/github/kaklakariada/fritzbox/TestDriver.java).
 
 ## Development
 
 ### Generate / update license header
 
 ```bash
-$ ./gradlew licenseFormat
+./gradlew licenseFormat
 ```
 
 ### Check if dependencies are up-to-date
 
 ```bash
-$ ./gradlew dependencyUpdates
+./gradlew dependencyUpdates
+```
+
+### Check dependencies for vulnerabilities
+
+```bash
+./gradlew ossIndexAudit
 ```
 
 ### Building
@@ -93,7 +105,7 @@ Install to local maven repository:
 3. Run the following command:
 
     ```bash
-    $ ./gradlew clean check build publish closeAndReleaseRepository --info
+    ./gradlew clean check build publish closeAndReleaseRepository --info
     ```
 
 4. Create a new [release](https://github.com/kaklakariada/fritzbox-java-api/releases) on GitHub.

application.properties.template

@@ -7,10 +7,7 @@ plugins {
     id "org.sonarqube" version "3.4.0.2513"
     id "io.codearte.nexus-staging" version "0.30.0"
     id "com.github.ben-manes.versions" version "0.42.0"
-}
-
-repositories {
-    mavenCentral()
+    id "org.sonatype.gradle.plugins.scan" version "2.3.0"
 }
 
 group 'com.github.kaklakariada'
@@ -35,6 +32,7 @@ tasks.withType(JavaCompile) {
 }
 
 test {
+    useJUnitPlatform()
     if(logger.infoEnabled) {
         testLogging.showStandardStreams = true
     }
@@ -48,7 +46,7 @@ dependencies {
 
     runtimeOnly 'ch.qos.logback:logback-classic:1.2.11'
 
-    testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.0'
     testImplementation 'org.mockito:mockito-core:4.6.1'
     testImplementation 'org.assertj:assertj-core:3.23.1'
 }
@@ -72,7 +70,7 @@ def getOptionalProperty(String name) {
     if(project.hasProperty(name)) {
         return project.property(name)
     }
-    logger.info("Project property '${name}' not available. Please it to ~/.gradle/gradle.properties")
+    logger.info("Project property '${name}' not available. Please add it to ~/.gradle/gradle.properties")
     return null
 }
 
@@ -144,3 +142,12 @@ tasks.named("dependencyUpdates").configure {
     isNonStable(it.candidate.version) && !isNonStable(it.currentVersion)
   }
 }
+
+ossIndexAudit {
+    allConfigurations = false
+    useCache = true
+    excludeVulnerabilityIds = []
+    printBanner = false
+}
+
+rootProject.tasks["build"].dependsOn(tasks["ossIndexAudit"])

build.gradle

@@ -1 +1,7 @@
 rootProject.name='fritzbox-java-api'
+
+dependencyResolutionManagement {
+    repositories {
+        mavenCentral()
+    }
+}

settings.gradle

@@ -17,36 +17,35 @@
  */
 package com.github.kaklakariada.fritzbox.helper;
 
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-public class StringHelperTest {
+class StringHelperTest {
 
     @Test
-    public void isIntegerNumberTest() {
-        assertFalse("Test null", StringHelper.isIntegerNumber(null));
-        assertFalse("Test empty", StringHelper.isIntegerNumber(""));
-        assertFalse("Test blank", StringHelper.isIntegerNumber(" "));
-        assertTrue("Test numeric enclosed by blank", StringHelper.isIntegerNumber(" 1 "));
-        assertFalse("Test numeric enclosing blank", StringHelper.isIntegerNumber("1 1"));
-        assertTrue("Test Unicode", StringHelper.isIntegerNumber("\u0967\u0968\u0969"));
-        assertTrue("Test Integer", StringHelper.isIntegerNumber("1"));
-        assertFalse("Test Double", StringHelper.isIntegerNumber("1.1"));
-        assertFalse("Test Double", StringHelper.isIntegerNumber("1.1D"));
+    void isIntegerNumberTest() {
+        assertFalse(StringHelper.isIntegerNumber(null), "Test null");
+        assertFalse(StringHelper.isIntegerNumber(""), "Test empty");
+        assertFalse(StringHelper.isIntegerNumber(" "), "Test blank");
+        assertTrue(StringHelper.isIntegerNumber(" 1 "), "Test numeric enclosed by blank");
+        assertFalse(StringHelper.isIntegerNumber("1 1"), "Test numeric enclosing blank");
+        assertTrue(StringHelper.isIntegerNumber("\u0967\u0968\u0969"), "Test Unicode");
+        assertTrue(StringHelper.isIntegerNumber("1"), "Test Integer");
+        assertFalse(StringHelper.isIntegerNumber("1.1"), "Test Double");
+        assertFalse(StringHelper.isIntegerNumber("1.1D"), "Test Double");
     }
 
     @Test
-    public void isNumericTest() {
-        assertFalse("Test null", StringHelper.isNumeric(null));
-        assertFalse("Test empty", StringHelper.isNumeric(""));
-        assertFalse("Test blank", StringHelper.isNumeric(""));
-        assertFalse("Test numeric blank", StringHelper.isNumeric(" 1 "));
-        assertTrue("Test Unicode", StringHelper.isNumeric("\u0967\u0968\u0969"));
-        assertTrue("Test empty", StringHelper.isNumeric("1"));
-        assertFalse("Test Double", StringHelper.isNumeric("1.1"));
-        assertFalse("Test Double", StringHelper.isNumeric("1.1D"));
+    void isNumericTest() {
+        assertFalse(StringHelper.isNumeric(null), "Test null");
+        assertFalse(StringHelper.isNumeric(""), "Test empty");
+        assertFalse(StringHelper.isNumeric(""), "Test blank");
+        assertFalse(StringHelper.isNumeric(" 1 "), "Test numeric blank");
+        assertTrue(StringHelper.isNumeric("\u0967\u0968\u0969"), "Test Unicode");
+        assertTrue(StringHelper.isNumeric("1"), "Test empty");
+        assertFalse(StringHelper.isNumeric("1.1"), "Test Double");
+        assertFalse(StringHelper.isNumeric("1.1D"), "Test Double");
     }
-
 }

src/test/java/com/github/kaklakariada/fritzbox/helper/StringHelperTest.java

@@ -19,16 +19,16 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-public class ChallengeResponseTest {
+class ChallengeResponseTest {
     @Test
-    public void md5() {
+    void md5() {
         assertThat(ChallengeResponse.getAlgorithm("challenge")).isInstanceOf(Md5LoginChallengeResponse.class);
     }
 
     @Test
-    public void pbkdf3() {
+    void pbkdf3() {
         assertThat(ChallengeResponse.getAlgorithm("2$challenge")).isInstanceOf(Pbkdf2ChallengeResponse.class);
     }
 }

src/test/java/com/github/kaklakariada/fritzbox/login/ChallengeResponseTest.java

@@ -17,13 +17,13 @@
  */
 package com.github.kaklakariada.fritzbox.login;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-public class Md5LoginChallengeResponseTest {
+class Md5LoginChallengeResponseTest {
     @Test
-    public void test() {
+    void test() {
         final String response = new Md5LoginChallengeResponse(new Md5Service()).calculateResponse("challenge",
                 "password");
         assertEquals("challenge-086fa48e27e8826c94437d10380e11ba", response);

src/test/java/com/github/kaklakariada/fritzbox/login/Md5LoginChallengeResponseTest.java

@@ -17,32 +17,32 @@
  */
 package com.github.kaklakariada.fritzbox.login;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 /**
  * Unit test for {@link Md5Service}
  */
-public class Md5ServiceTest {
+class Md5ServiceTest {
 
     @Test
-    public void testMd5EmptyString() {
+    void testMd5EmptyString() {
         assertMd5Sum("", "d41d8cd98f00b204e9800998ecf8427e");
     }
 
     @Test
-    public void testMd5Test() {
+    void testMd5Test() {
         assertMd5Sum("test", "c8059e2ec7419f590e79d7f1b774bfe6");
     }
 
     @Test
-    public void testMd5Umlauts() {
+    void testMd5Umlauts() {
         assertMd5Sum("1234567z-äbc", "9e224a41eeefa284df7bb0f26c2913e2");
     }
 
     @Test
-    public void testMd5SpecialChars() {
+    void testMd5SpecialChars() {
         assertMd5Sum("!\"§$%&/()=?ßüäöÜÄÖ-.,;:_`´+*#'<>≤|", "ad44a7cb10a95cb0c4d7ae90b0ff118a");
     }