Improving a bit the coverage

Author: jabrena

.sdkmanrc

@@ -0,0 +1 @@
+java=11.0.27-tem

README.md

@@ -89,7 +89,10 @@ The following examples illustrate the CLI usage.
 If you want to contribute to this project you can create a fork and a pull request. The project is built with Gradle, so you can import it as Gradle project within Eclipse or IntelliJ IDEA (or any other IDE supporting Gradle).
 
 ```bash
+sdk env install
 ./gradlew clean build
+./gradlew clean build jacocoTestReport
+jwebserver -p 9000 -d "$(pwd)/build/reports/"
 ./gradlew clean build snapshot
 java -jar build/libs/context-mapper-cli-0.1.0-SNAPSHOT.jar
 ```

build.gradle

@@ -7,10 +7,12 @@ plugins {
     id 'nebula.release' version '19.0.10'
 }
 
-group 'org.contextmapper'
+group = 'org.contextmapper'
 
-sourceCompatibility = '11'
-targetCompatibility = '11'
+java {
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+}
 
 repositories {
     mavenCentral()
@@ -25,16 +27,13 @@ dependencies {
     testImplementation "org.assertj:assertj-core:${assertJVersion}"
     testImplementation "org.mockito:mockito-core:${mockitoVersion}"
     testImplementation "org.mockito:mockito-junit-jupiter:${mockitoVersion}"
-    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${jUnitVersion}"
 }
 
 application {
-    mainClassName = 'org.contextmapper.cli.ContextMapperCLI'
-    applicationName = 'context-mapper-cli'
-}
-startScripts {
+    mainClass = 'org.contextmapper.cli.ContextMapperCLI'
     applicationName = 'cm'
 }
+
 jar {
     manifest {
         attributes (
@@ -56,14 +55,12 @@ if (!project.hasProperty('signing.secretKeyRingFile')) {
 }
 
 test {
-    useJUnitPlatform()
-
     testLogging {
-        showExceptions true
-        exceptionFormat "full"
+        showExceptions = true
+        exceptionFormat = "full"
 
-        showCauses true
-        showStackTraces true
+        showCauses = true
+        showStackTraces = true
     }
 }
 
@@ -152,14 +149,22 @@ signing {
     sign(publishing.publications)
 }
 
+testing {
+    suites {
+        test(JvmTestSuite) {
+            useJUnitJupiter(jUnitVersion)
+        }
+    }
+}
+
 tasks.withType(GenerateModuleMetadata) {
     enabled = false
 }
 
-tasks.withType(CreateStartScripts).each { task ->
-    task.doLast {
-        String text = task.windowsScript.text
+tasks.withType(CreateStartScripts).configureEach {
+    doLast {
+        String text = windowsScript.text
         text = text.replaceFirst(/(set CLASSPATH=%APP_HOME%\\lib\\).*/, { "${it[1]}*" })
-        task.windowsScript.write text
+        windowsScript.text = text
     }
 }

gradle.properties

@@ -3,7 +3,7 @@ ossSnapshotRepository=https://oss.sonatype.org/content/repositories/snapshots/
 ossReleaseStagingRepository=https://oss.sonatype.org/service/local/staging/deploy/maven2/
 
 # dependency versions
-jUnitVersion=5.9.1
+jUnitVersion=5.12.2
 assertJVersion=3.27.3
 mockitoVersion=3.9.0
 

src/main/java/org/contextmapper/cli/ContextMapperCLI.java

@@ -1,58 +1,50 @@
-/*
- * Copyright 2021 The Context Mapper Project Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 package org.contextmapper.cli;
 
 import org.contextmapper.cli.commands.GenerateCommand;
 import org.contextmapper.cli.commands.ValidateCommand;
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
+import java.util.function.Supplier;
 
-@Command(name = "cm", mixinStandardHelpOptions = true, versionProvider = VersionProvider.class,
-        description = "Context Mapper CLI",
-        subcommands = {
-                ValidateCommand.class,
-                GenerateCommand.class
-        })
+@Command(
+    name = "cm", 
+    versionProvider = VersionProvider.class,
+    description = "Context Mapper CLI",
+    subcommands = {
+        ValidateCommand.class,
+        GenerateCommand.class
+    },
+    mixinStandardHelpOptions = true,
+    usageHelpAutoWidth = true)
 public class ContextMapperCLI implements Runnable {
 
     private static final int REQUIRED_JAVA_VERSION = 11;
-
-    public static void main(String[] args) {
-        if (Runtime.version().feature() < REQUIRED_JAVA_VERSION) {
-            System.err.printf("Invalid Java version '%s' (>=%s is required).%n", Runtime.version().feature(), REQUIRED_JAVA_VERSION);
-            System.exit(1);
-        }
-        int exitCode = new CommandLine(new ContextMapperCLI()).execute(args);
-        System.exit(exitCode);
-    }
+    static Supplier<Integer> javaVersionSupplier = () -> Runtime.version().feature();
 
     @Override
     public void run() {
-        // This is executed if no subcommand is specified.
-        // Picocli will show the help message by default if mixinStandardHelpOptions = true and no subcommand is given.
-        // We can add a custom message here if needed, or rely on Picocli's default behavior.
         System.out.println("Context Mapper CLI. Use 'cm --help' for usage information.");
     }
 
-}
+    static void checkJavaVersion(Runnable exiter) {
+        int currentVersion = javaVersionSupplier.get();
+        if (currentVersion < REQUIRED_JAVA_VERSION) {
+            System.err.printf("Invalid Java version '%s' (>=%s is required).%n", currentVersion, REQUIRED_JAVA_VERSION);
+            exiter.run();
+        }
+    }
 
-class VersionProvider implements CommandLine.IVersionProvider {
-    @Override
-    public String[] getVersion() throws Exception {
-        String implVersion = ContextMapperCLI.class.getPackage().getImplementationVersion();
-        return new String[]{"Context Mapper CLI " + (implVersion != null ? "v" + implVersion : "DEVELOPMENT VERSION")};
+    private static void checkJavaVersion() {
+        checkJavaVersion(() -> System.exit(1));
+    }
+
+    static int runCLI(String[] args) {
+        return new CommandLine(new ContextMapperCLI()).execute(args);
+    }
+
+    public static void main(String[] args) {
+        checkJavaVersion();
+        int exitCode = runCLI(args);
+        System.exit(exitCode);
     }
 }

src/main/java/org/contextmapper/cli/VersionProvider.java

@@ -0,0 +1,23 @@
+package org.contextmapper.cli;
+
+import java.util.Objects;
+
+import picocli.CommandLine.IVersionProvider;
+
+class VersionProvider implements IVersionProvider {
+
+    @Override
+    public String[] getVersion() throws Exception {
+        Package programPackage = getPackageToInspect();
+        String implVersion = null;
+        if (Objects.nonNull(programPackage)) {
+            implVersion = programPackage.getImplementationVersion();
+        }
+        return new String[]{"Context Mapper CLI " + (implVersion != null ? "v" + implVersion : "DEVELOPMENT VERSION")};
+    }
+
+    //Refactored to help the testing process
+    protected Package getPackageToInspect() {
+        return ContextMapperCLI.class.getPackage();
+    }
+}

src/main/java/org/contextmapper/cli/commands/GenerateCommand.java

@@ -1,18 +1,3 @@
-/*
- * Copyright 2021 The Context Mapper Project Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 package org.contextmapper.cli.commands;
 
 import org.contextmapper.dsl.cml.CMLResource;

src/main/java/org/contextmapper/cli/commands/ValidateCommand.java

@@ -1,18 +1,3 @@
-/*
- * Copyright 2021 The Context Mapper Project Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 package org.contextmapper.cli.commands;
 
 import org.contextmapper.dsl.cml.CMLResource;

src/test/java/org/contextmapper/cli/ContextMapperCLITest.java

@@ -106,4 +106,22 @@ void main_WhenCalledWithInvalidSubcommand_ThenPrintsErrorAndUsage() {
         assertThat(exitCode).isNotEqualTo(0);
         assertThat(errContent.toString()).contains("Unmatched argument at index 0: 'invalid-command'");
     }
+
+    @Test
+    @DisplayName("runCLI() should return 0 and print help when called with --help option")
+    void runCLI_WhenCalledWithHelpOption_ThenReturnsZeroAndPrintsHelp() {
+        // Given
+        String[] args = {"--help"};
+
+        // When
+        int exitCode = ContextMapperCLI.runCLI(args);
+
+        // Then
+        assertThat(exitCode).isEqualTo(0);
+        assertThat(outContent.toString())
+            .contains("Usage: cm [-hV] [COMMAND]")
+            .contains("Commands:")
+            .contains("validate  Validates a CML file.")
+            .contains("generate  Generates output from a CML file.");
+    }
 }

src/test/java/org/contextmapper/cli/VersionProviderTest.java

@@ -0,0 +1,72 @@
+package org.contextmapper.cli;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mockito;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ExtendWith(MockitoExtension.class)
+class VersionProviderTest {
+
+    static class TestableVersionProvider extends VersionProvider {
+        private final Package mockPackage;
+
+        TestableVersionProvider(Package mockPackage) {
+            this.mockPackage = mockPackage;
+        }
+
+        @Override
+        protected Package getPackageToInspect() {
+            return mockPackage;
+        }
+    }
+
+    @Test
+    void getVersion_whenImplVersionIsPresent_returnsVersionString() throws Exception {
+        // Arrange
+        String expectedVersion = "1.2.3";
+        Package mockPackage = Mockito.mock(Package.class);
+        Mockito.when(mockPackage.getImplementationVersion()).thenReturn(expectedVersion);
+        VersionProvider versionProvider = new TestableVersionProvider(mockPackage);
+
+        // Act
+        String[] version = versionProvider.getVersion();
+
+        // Assert
+        assertThat(version).isNotNull()
+                           .hasSize(1)
+                           .containsExactly("Context Mapper CLI v" + expectedVersion);
+    }
+
+    @Test
+    void getVersion_whenImplVersionIsNull_returnsDevelopmentVersionString() throws Exception {
+        // Arrange
+        Package mockPackage = Mockito.mock(Package.class);
+        Mockito.when(mockPackage.getImplementationVersion()).thenReturn(null);
+        VersionProvider versionProvider = new TestableVersionProvider(mockPackage);
+
+        // Act
+        String[] version = versionProvider.getVersion();
+
+        // Assert
+        assertThat(version).isNotNull()
+                           .hasSize(1)
+                           .containsExactly("Context Mapper CLI DEVELOPMENT VERSION");
+    }
+
+    @Test
+    void getVersion_whenPackageIsNull_returnsDevelopmentVersionString() throws Exception {
+        // Arrange
+        VersionProvider versionProvider = new TestableVersionProvider(null);
+
+        // Act
+        String[] version = versionProvider.getVersion();
+
+        // Assert
+        assertThat(version).isNotNull()
+                           .hasSize(1)
+                           .containsExactly("Context Mapper CLI DEVELOPMENT VERSION");
+    }
+}