Merge pull request #386 from jenkinsci/fix/benalvo/version-check

Fix CheckmarxInstaller to update version from file for 'latest' or empty input

Author: cx-ben-alvo

src/main/java/com/checkmarx/jenkins/tools/CheckmarxInstaller.java

@@ -56,34 +56,43 @@ public class CheckmarxInstaller extends ToolInstaller {
     public static final String cliDefaultVersion = "2.3.18";
     private static final String cliVersionFileName = "cli.version";
     @Getter
-    private final String version;
+    private String version;
     @Getter
     private final Long updatePolicyIntervalHours;
     private CxLoggerAdapter log;
 
     @DataBoundConstructor
     public CheckmarxInstaller(String label, String version, Long updatePolicyIntervalHours) {
         super(label);
-        this.version = "latest".equalsIgnoreCase(version.trim()) || version.isEmpty() ? readCLILatestVersionFromVersionFile() : version;
+        this.version = version;
         this.updatePolicyIntervalHours = updatePolicyIntervalHours;
     }
 
     @Override
     public FilePath performInstallation(ToolInstallation toolInstallation, Node node, TaskListener taskListener) throws IOException, InterruptedException {
         log = new CxLoggerAdapter(taskListener.getLogger());
-
+        String versionToInstall = getVersionNumber();
         FilePath expected = preferredLocation(toolInstallation, node);
 
         if (isUpToDate(expected, log)) {
             log.info("Checkmarx installation is UP-TO-DATE");
             return expected;
         }
-        log.info("Installing Checkmarx AST CLI tool (version '" + fixEmptyAndTrim(version) + "')");
 
-        return installCheckmarxCliAsSingleBinary(expected, node, taskListener);
+        log.info("Installing Checkmarx AST CLI tool (version '{}')", fixEmptyAndTrim(versionToInstall));
+
+        return installCheckmarxCliAsSingleBinary(versionToInstall, expected, node, taskListener);
+    }
+
+    public String getVersionNumber() {
+        if ("latest".equalsIgnoreCase(version.trim()) || version.isEmpty()) {
+            return readCLILatestVersionFromVersionFile();
+        } else {
+            return version;
+        }
     }
 
-    private String readCLILatestVersionFromVersionFile() {
+    public String readCLILatestVersionFromVersionFile() {
         try {
             Path versionFilePath = findVersionFilePath().orElseThrow(() -> new ToolDetectionException("Could not find version file"));
             String fileVersion = Files.readString(versionFilePath.resolve(cliVersionFileName)).trim();
@@ -130,7 +139,7 @@ private boolean isUpToDate(FilePath expectedLocation, CxLoggerAdapter log) throw
         return timestampDifference < updateInterval;
     }
 
-    private FilePath installCheckmarxCliAsSingleBinary(FilePath expected, Node node, TaskListener log) throws IOException, InterruptedException {
+    private FilePath installCheckmarxCliAsSingleBinary(String version, FilePath expected, Node node, TaskListener log) throws IOException, InterruptedException {
         final VirtualChannel nodeChannel = node.getChannel();
         if (nodeChannel == null) {
             throw new IOException(format("Node '%s' is offline", node.getDisplayName()));

src/test/java/com/checkmarx/jenkins/unit/tools/CheckmarxInstallerTest.java

@@ -97,7 +97,7 @@ public void testInstallerDescriptorDisplayName() {
     @Test
     public void testConstructorWithNullValues() {
         CheckmarxInstaller installer = new CheckmarxInstaller(null, "", null);
-        assertNotEquals("", installer.getVersion());
+        assertNotEquals("", installer.getVersionNumber());
         assertNull(installer.getUpdatePolicyIntervalHours());
     }
 
@@ -111,14 +111,13 @@ public void testConstructorWithEmptyLabel() {
     @Test
     public void testConstructorWithLatestVersion() {
         CheckmarxInstaller installer = new CheckmarxInstaller("", "latest ", 24L);
-        assertNotEquals("latest ", installer.getVersion());
+        assertEquals("latest ", installer.getVersion());
         assertEquals(Long.valueOf(24L), installer.getUpdatePolicyIntervalHours());
     }
 
     @Test
     public void testValidateEqualsCLIDefaultVersionAndCLIVersionFile() {
-        CheckmarxInstaller installer = new CheckmarxInstaller("", "latest", 24L);
-        assertEquals(CheckmarxInstaller.cliDefaultVersion, installer.getVersion());
+        assertEquals(CheckmarxInstaller.cliDefaultVersion, installer.readCLILatestVersionFromVersionFile());
     }
 
     @Test(expected = Exception.class)

src/test/java/com/checkmarx/jenkins/unit/tools/internal/DownloadServiceTest.java

@@ -78,7 +78,7 @@ public void testGetDownloadUrlForCli_withLatestVersion() throws IOException {
         CheckmarxInstaller installer = new CheckmarxInstaller("test", "latest", 24L);
         Platform platform = Platform.LINUX;
 
-        URL actualUrl = DownloadService.getDownloadUrlForCli(installer.getVersion(), platform);
+        URL actualUrl = DownloadService.getDownloadUrlForCli(installer.getVersionNumber(), platform);
         assertNotNull(actualUrl);
     }