Merge pull request #401 from mathworks/2.16.0-SNAPSHOT-Qualification

Merge 2.16.0 snapshot qualification to dev_main

Author: Vahila

CONFIGDOC.md

@@ -18,42 +18,46 @@ To follow the steps in this example:
 
 * MATLAB and the plugin for MATLAB must be installed on your Jenkins server. For information on how to install a plugin in Jenkins, see [Managing Plugins](https://jenkins.io/doc/book/managing/plugins/).
 * The Times Table App project must be under source control. For example, you can create a new repository for the project using your GitHub® account. For more information, see [Use Source Control with Projects](https://www.mathworks.com/help/matlab/matlab_prog/use-source-control-with-projects.html).
-* The [Cobertura](https://plugins.jenkins.io/cobertura) and [JUnit](https://plugins.jenkins.io/junit) plugins must be installed. These plugins are required to publish the artifacts using post-build actions. 
+* The [coverage](https://plugins.jenkins.io/coverage/) and [JUnit](https://plugins.jenkins.io/junit) plugins must be installed. These plugins are required to publish the artifacts using post-build actions. 
 
 ## Create a Freestyle Project to Run MATLAB Tests
 Create a new project and configure it by following these steps:
 1. In your Jenkins interface, select **New Item** on the left. A new page opens where you can choose the type of your project. Enter a project name, and then click **Freestyle project**. To confirm your choices, click **OK**.
 
-![create_project](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/8aa314b3-60fc-4534-bd49-223617ca0542)
+![create_project](https://github.com/user-attachments/assets/cedd846b-4460-43d7-9278-253c7ee7260e)
 
 2. On the project configuration page, in the **Source Code Management** section, specify the repository that hosts your tests.
 
-![source_control](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/5befa3c5-6924-4abb-bc34-25ff3328ee47)
+![source_control](https://github.com/user-attachments/assets/3b888ed9-b521-4c3c-a932-ad5f9de563c3)
 
-3. In the **Build Environment** section, select **Use MATLAB version** and specify the MATLAB version you want to use in the build. If your preferred MATLAB version is not listed under **Use MATLAB version**, enter the full path to its root folder in the **MATLAB root** box. 
+3. In the **Environment** section, select **Use MATLAB version** and specify the MATLAB version you want to use in the build. If your preferred MATLAB version is not listed under **Use MATLAB version**, enter the full path to its root folder in the **MATLAB root** box. 
 
-![build_environment](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/c77220c0-a521-41ad-b0e4-76a6f0afce28)
+![environment](https://github.com/user-attachments/assets/00598e0c-468d-465b-b334-5c7ed750ee3f)
 
 4. In the **Build Steps** section, select **Add build step > Run MATLAB Tests**. Then, specify the artifacts to generate in the project workspace. In this example, the plugin generates test results in JUnit-style XML format and code coverage results in Cobertura XML format. Furthermore, to generate the coverage results, the plugin uses only the code in the `source` folder located in the root of the repository. For more information about the build steps provided by the plugin, see [Plugin Configuration Guide](../CONFIGDOC.md).
 
-![run_matlab_tests](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/2ef326b7-9b39-4068-83b9-011cebd52506)
+![run_matlab_tests](https://github.com/user-attachments/assets/b6b7b811-d998-4fb9-bbf8-5de624bb5bd6)
 
-5. In the **Post-build Actions** section, add two post-build actions to publish the JUnit-style test results and the Cobertura code coverage results. For each artifact, provide the path to the report.
+5. In the **Post-build Actions** section, add the **Publish JUnit test result report** post-build action to publish the test results in JUnit-style XML format. Specify the path to the test report in the **Test report XMLs** box.
 
-![post_build](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/d584a290-de93-4a9f-8061-00bc2a435c12)
+![post_build_junit](https://github.com/user-attachments/assets/82b4c99a-59c3-41e4-946d-555fb9315f35)
 
-6. Click **Save** to save the project configuration settings. You can access and modify your settings at a later stage by selecting **Configure** in the project interface, which displays the project name at the upper-left corner of the page.
+6. In the **Post-build Actions** section, add the **Record code coverage results** post-build action to publish the code coverage results in Cobertura XML format. Select `Cobertura Coverage Reports` from the **Coverage Parser** list and specify the path to the coverage report in the **Report File Pattern** box.
+
+![post_build_cobertura](https://github.com/user-attachments/assets/5af14bb9-f12e-4942-a3ad-957eec4a057b)
+
+7. Click **Save** to save the project configuration settings. You can access and modify your settings at a later stage by selecting **Configure** in the project interface, which displays the project name at the upper-left corner of the page.
 
 ## Run Tests and Inspect Artifacts
-To build your freestyle project, select **Build Now** in the project interface. Jenkins triggers a build, assigns it a number under **Build History**, and runs the build. In this example, the build succeeds because all the tests in the Times Table App project pass.
+To build your freestyle project, select **Build Now** in the project interface. Jenkins triggers a build, assigns it a number under **Builds**, and runs the build. In this example, the build succeeds because all the tests in the Times Table App project pass.
 
 Navigate to the project workspace by selecting **Workspace** in the project interface. The generated artifacts are in the `matlabTestArtifacts` folder of the workspace.
 
-![workspace](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/5195fb71-6f4f-4261-82c0-501ab953a079)
+![workspace](https://github.com/user-attachments/assets/1c1ff1f8-99b7-475f-8278-180ab0185833)
 
 Select **Status** in the project interface. You can access the published artifacts by clicking the **Latest Test Result** and **Coverage Report** links. For example, click the **Latest Test Result** link to view the published JUnit-style test results. On the test results page, click the **(root)** link in the **All Tests** table. The table expands and lists information for each of the test classes within the Times Table App project.  
 
-![test_results](https://github.com/mathworks/jenkins-matlab-plugin/assets/48831250/2dc5142d-b844-436c-8e9e-8f7b90c7b69e)
+![test_results](https://github.com/user-attachments/assets/51cc73aa-cf8b-455a-b210-7ecfbb772a72)
 
 ## See Also
 * [Plugin Configuration Guide](../CONFIGDOC.md)<br/>

examples/Run-MATLAB-Tests.md

@@ -286,4 +286,4 @@
 			</plugins>
 		</pluginManagement>
 	</build>
-</project>
+</project>

pom.xml

@@ -64,13 +64,7 @@ public void buildEnvVars(EnvVars env) {
         if (home == null) {
             return;
         }
-        FilePath matlabHome = new FilePath(new File(home));
-        FilePath matlabBin = new FilePath(matlabHome, "bin");
-        env.put("PATH+matlabroot", matlabBin.getRemote());
-        FilePath matlabBatchFolder = matlabHome.getParent();
-        if (matlabBatchFolder != null) {
-            env.put("PATH+matlabbatch", matlabBatchFolder.getRemote());
-        }
+        env.put("PATH+matlabroot", home + "/bin");
     }
 
     public static MatlabInstallation[] getAll() {

src/main/java/com/mathworks/ci/MatlabInstallation.java

@@ -201,11 +201,6 @@ public void setUp(Context context, Run<?, ?> build, FilePath workspace, Launcher
         if (matlabBinDir == null) {
             throw new MatlabNotFoundError(Message.getValue("matlab.not.found.error"));
         }
-        // Add matlab-batch executable in path
-        FilePath batchExecutable = getNthParentFilePath(matlabExecutablePath, 3);
-        if (batchExecutable != null && batchExecutable.exists()) {
-            context.env("PATH+matlabbatch", batchExecutable.getRemote());
-        }
 
         // Add "matlabroot" without bin as env variable which will be available across
         // the build.
@@ -221,19 +216,4 @@ private String getNodeSpecificExecutable(Launcher launcher) {
         return (launcher.isUnix()) ? "/bin/matlab" : "\\bin\\matlab.exe";
     }
 
-    public static FilePath getNthParentFilePath(FilePath path, int levels) {
-        if (path == null || levels < 0) {
-            return null;
-        }
-
-        FilePath currentPath = path;
-        for (int i = 0; i < levels; i++) {
-            if (currentPath == null) {
-                return null;
-            }
-            currentPath = currentPath.getParent();
-        }
-        return currentPath;
-    }
-
 }

src/main/java/com/mathworks/ci/UseMatlabVersionBuildWrapper.java

@@ -40,24 +40,14 @@ public static void addMatlabToEnvPathFromAxis(Computer cmp, TaskListener listene
             return;
         }
 
-        FilePath matlabRoot = getNodeSpecificHome(name,
-                cmp.getNode(), listener, env);
+        FilePath matlabRoot = getNodeSpecificHome(name, cmp.getNode(), listener, env);
 
-        FilePath toolHome = matlabRoot.getParent();
-        if (toolHome == null) {
-            return;
-        }
-        if (matlabRoot != null && toolHome.exists()) {
-            env.put("PATH+matlabbatch", toolHome.getRemote());
-        }
-
-        String matlabExecutablePath = getNodeSpecificHome(name,
-                cmp.getNode(), listener, env).getRemote() + ((Boolean.TRUE.equals(cmp.isUnix())) ? "/bin" : "\\bin");
-        env.put("PATH+matlabroot", matlabExecutablePath);
+        FilePath matlabBin = new FilePath(matlabRoot, "bin");
+        env.put("PATH+matlabroot", matlabBin.getRemote());
 
         // Specify which MATLAB was added to path.
         listener.getLogger().println(
-                "\n" + String.format(Message.getValue("matlab.added.to.path.from"), matlabExecutablePath) + "\n");
+                "\n" + String.format(Message.getValue("matlab.added.to.path.from"), matlabBin.getRemote()) + "\n");
     }
 
     public static FilePath getNodeSpecificHome(String instName, Node node, TaskListener listener, EnvVars env)

src/main/java/com/mathworks/ci/Utilities.java

@@ -1,7 +1,7 @@
 package com.mathworks.ci.tools;
 
 /**
- * Copyright 2024, The MathWorks, Inc.
+ * Copyright 2024-2025, The MathWorks, Inc.
  */
 
 import com.mathworks.ci.MatlabInstallation;
@@ -49,7 +49,7 @@ public MatlabInstaller(String id) {
     }
 
     public String getRelease() {
-        return this.release.trim();
+        return this.release;
     }
 
     @DataBoundSetter
@@ -75,10 +75,12 @@ public FilePath performInstallation(ToolInstallation tool, Node node, TaskListen
         String extension = "";
         String[] systemProperties = getSystemProperties(node);
         FilePath matlabRoot;
+        MatlabRelease release = parseRelease(this.getRelease());
+
         if (systemProperties[0].toLowerCase().contains("os x")) {
-            matlabRoot = new FilePath(toolRoot, this.getRelease() + ".app");
+            matlabRoot = new FilePath(toolRoot, release.name + ".app");
         } else {
-            matlabRoot = new FilePath(toolRoot, this.getRelease());
+            matlabRoot = new FilePath(toolRoot, release.name);
         }
         String platform = getPlatform(systemProperties[0], systemProperties[1]);
         if (platform == "win64") {
@@ -90,21 +92,24 @@ public FilePath performInstallation(ToolInstallation tool, Node node, TaskListen
 
         // Download mpm and matlab-batch to temp directory
         FilePath mpm = fetchMpm(platform, tempDir);
-        FilePath matlabBatch = fetchMatlabBatch(platform, tempDir);
+        FilePath tempMatlabBatch = fetchMatlabBatch(platform, tempDir);
 
         // Install with mpm
-        mpmInstall(mpm, this.getRelease(), this.getProducts(), matlabRoot, node, log);
+        mpmInstall(mpm, release, this.getProducts(), matlabRoot, node, log);
 
         // Copy downloaded matlab-batch to tool directory
-        matlabBatch.copyTo(new FilePath(toolRoot, "matlab-batch" + extension));
+        FilePath matlabBin = new FilePath(matlabRoot, "bin");
+        FilePath matlabBatchBin = new FilePath(matlabBin, "matlab-batch" + extension);
+        tempMatlabBatch.copyTo(matlabBatchBin);
+        matlabBatchBin.chmod(0777);
 
         // Delete temp directory
         tempDir.deleteRecursive();
 
         return matlabRoot;
     }
 
-    private void mpmInstall(FilePath mpmPath, String release, String products, FilePath destination, Node node,
+    private void mpmInstall(FilePath mpmPath, MatlabRelease release, String products, FilePath destination, Node node,
             TaskListener log)
             throws IOException, InterruptedException {
         makeDir(destination);
@@ -114,7 +119,10 @@ private void mpmInstall(FilePath mpmPath, String release, String products, FileP
         ArgumentListBuilder args = new ArgumentListBuilder();
         args.add(mpmPath.getRemote());
         args.add("install");
-        appendReleaseToArguments(release, args, log);
+        args.add("--release=" + release.name);
+        if (release.isPrerelease) {
+            args.add("--release-status=Prerelease");
+        }
         args.add("--destination=" + destination.getRemote());
         addMatlabProductsToArgs(args, products);
 
@@ -144,29 +152,29 @@ private void makeDir(FilePath path) throws IOException, InterruptedException {
         }
     }
 
-    private void appendReleaseToArguments(String release, ArgumentListBuilder args, TaskListener log) {
-        String trimmedRelease = release.trim();
-        String actualRelease = trimmedRelease;
+    private MatlabRelease parseRelease(String release) throws InstallationFailedException {
+        String name = release.trim();
+        boolean isPrerelease = false;
 
-        if (trimmedRelease.equalsIgnoreCase("latest") || trimmedRelease.equalsIgnoreCase(
-                "latest-including-prerelease")) {
-            String releaseInfoUrl = Message.getValue("matlab.release.info.url") + trimmedRelease;
-            String releaseVersion = null;
+        if (name.equalsIgnoreCase("latest") || name.equalsIgnoreCase("latest-including-prerelease")) {
+            String releaseInfoUrl = Message.getValue("matlab.release.info.url") + name;
             try {
-                releaseVersion = IOUtils.toString(new URL(releaseInfoUrl),
-                        StandardCharsets.UTF_8).trim();
+                name = IOUtils.toString(new URL(releaseInfoUrl), StandardCharsets.UTF_8).trim();
             } catch (IOException e) {
-                log.getLogger().println("Failed to fetch release version: " + e.getMessage());
+                throw new InstallationFailedException("Failed to fetch release version: " + e.getMessage());
             }
 
-            if (releaseVersion != null && releaseVersion.contains("prerelease")) {
-                actualRelease = releaseVersion.replace("prerelease", "");
-                args.add("--release-status=Prerelease");
-            } else {
-                actualRelease = releaseVersion;
+            if (name.contains("prerelease")) {
+                name = name.replace("prerelease", "");
+                isPrerelease = true;
             }
         }
-        args.add("--release=" + actualRelease);
+
+        if (name.startsWith("r")) {
+            name = name.replaceFirst("r", "R");
+        }
+
+        return new MatlabRelease(name, isPrerelease);
     }
 
     private FilePath fetchMpm(String platform, FilePath destination)
@@ -223,7 +231,6 @@ private FilePath fetchMatlabBatch(String platform, FilePath destination)
         FilePath matlabBatchPath = new FilePath(destination, "matlab-batch" + extension);
         try {
             matlabBatchPath.copyFrom(matlabBatchUrl.openStream());
-            matlabBatchPath.chmod(0777);
         } catch (IOException | InterruptedException e) {
             throw new InstallationFailedException("Unable to setup matlab-batch.");
         }

src/main/java/com/mathworks/ci/tools/MatlabInstaller.java

@@ -0,0 +1,15 @@
+package com.mathworks.ci.tools;
+
+/**
+ * Copyright 2025, The MathWorks, Inc.
+ */
+
+public class MatlabRelease {
+    public String name;
+    public boolean isPrerelease;
+
+    public MatlabRelease(String name, boolean isPrerelease) {
+        this.name = name;
+        this.isPrerelease = isPrerelease;
+    }
+}

src/main/java/com/mathworks/ci/tools/MatlabRelease.java

@@ -14,9 +14,4 @@
     <strong>Example:</strong> latest <br>
     <strong>Example:</strong> R2023bU4 <br>
   </p>
-  <p>
-    <strong>Note:</strong>  The plugin does not install dependencies on a Linux platform. If you are using a Linux platform,
-    verify that the required software is available before installing products using MATLAB Package Manager. For more information, see
-    <a href="https://in.mathworks.com/help/install/ug/get-mpm-os-command-line.html">Get MATLAB Package Manager.</a>
-  </p>
-</div>
+</div>