Merge pull request #183 from mathworks/3.0.0-Qualification

abhargav-mw · web-flow · commit 44508dc9e3ed · 2021-02-03T11:43:28.000+05:30
Get changes from 3.0.0 qualification
diff --git a/CONFIGDOC.md b/CONFIGDOC.md
diff --git a/examples/Run-MATLAB-Tests.md b/examples/Run-MATLAB-Tests.md
@@ -4,9 +4,9 @@ This example shows how to run a suite of MATLAB&reg; unit tests with Jenkins&tra
 
 * Configure Jenkins to run a freestyle project including MATLAB tests.
 * Interface Jenkins with a remote repository that contains the tests.
-* Build the freestyle project and examine the generated test artifacts.
+* Build the freestyle project and examine the generated artifacts.
 
-The freestyle project runs the tests in the Times Table App MATLAB project (which requires R2019a or later). You can create a working copy of the project files and open the project in MATLAB by running this statement in the Command Window: 
+The freestyle project runs the tests in the Times Table App MATLAB project (which requires R2019a or later). You can create a working copy of the project files and open the project in MATLAB by running this statement in the Command Window.
 
 ```
 matlab.project.example.timesTable
@@ -17,62 +17,58 @@ For more information about the Times Table App example project, see [Explore an
 ## Prerequisites
 Running the tests in this example requires you to interface Jenkins with MATLAB as well as a remote repository.
 
-* To run MATLAB tests and generate test artifacts, you must install the MATLAB plugin. For information on how to install a plugin in Jenkins, see [Managing Plugins](https://jenkins.io/doc/book/managing/plugins/).
+* To run MATLAB tests and generate artifacts, you must install the plugin for MATLAB. For information on how to install a plugin in Jenkins, see [Managing Plugins](https://jenkins.io/doc/book/managing/plugins/).
 * Jenkins runs the tests in a branch of the remote repository that is specified by a URL. To follow the build steps in this example, the Times Table App project must be under Git&trade; source control. For example, you can create a new repository for the project using your GitHub&reg; account. For more information, see [Use Source Control with Projects](https://www.mathworks.com/help/matlab/matlab_prog/use-source-control-with-projects.html).
-* To publish the test artifacts using post-build actions, relevant plugins must be installed on Jenkins. For example, the [Cobertura plugin](https://plugins.jenkins.io/cobertura) integrates Cobertura coverage reports to Jenkins, and [JUnit plugin](https://plugins.jenkins.io/junit) publishes JUnit-format test results. 
+* To publish the artifacts using post-build actions, relevant plugins must be installed on Jenkins. For example, the [Cobertura plugin](https://plugins.jenkins.io/cobertura) integrates Cobertura coverage reports to Jenkins, and [JUnit plugin](https://plugins.jenkins.io/junit) publishes JUnit-format test results. 
 
 ## Configure Jenkins 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, then click **Freestyle project**. To confirm your choices, click **OK**.
 
-![create_project](https://user-images.githubusercontent.com/48831250/94477040-50aee880-019f-11eb-9484-1d4ecf60ed92.png)
+![create_project](https://user-images.githubusercontent.com/48831250/105080784-520e6480-5a5f-11eb-9218-4d43013e2850.png)
 
 2. In the configuration window of your Jenkins project, navigate to the **Source Code Management** section and click **Git**. This option enables Jenkins to interface with a remote repository.
 
-![git](https://user-images.githubusercontent.com/48831250/94477376-cb780380-019f-11eb-8297-1c3a4874fe0e.png)
-
-
 3. Navigate to the main page of the GitHub repository that hosts your tests. Click **Code** and copy the web URL to your clipboard.
 
 ![clipboard](https://user-images.githubusercontent.com/48831250/94478137-dd0ddb00-01a0-11eb-9e55-d8004863c5e7.png)
 
 
-4. In the Jenkins interface, paste the URL into the **Repository URL** box of the **Source Code Management** section. You also can specify the branch to build in the **Branch Specifier** box.
+4. In the project configuration window, paste the URL into the **Repository URL** box of the **Source Code Management** section. You also can specify the branch to build in the **Branch Specifier** box.
 
 ![source_control](https://user-images.githubusercontent.com/48831250/94478391-37a73700-01a1-11eb-9f89-a5a71413baf0.png)
 
 
-5. In the **Build Environment** section of Jenkins, select **Use MATLAB Version**. Then, enter the full path to the MATLAB root folder in the **MATLAB root** box. Jenkins uses MATLAB at the specified location to run the tests. 
-
-![build_environment](https://user-images.githubusercontent.com/48831250/94478737-ad130780-01a1-11eb-89d8-1ef43c34fab0.png)
+5. In the **Build Environment** section, select **Use MATLAB version** and specify the MATLAB version you want to use in the build. If your desired MATLAB version is not listed under **Use MATLAB version**, enter the full path to its root folder in the **MATLAB root** box. 
 
-6. In the **Build** section of Jenkins, select **Add build step > Run MATLAB Tests**. Then, select your desired test artifacts to be generated in the project workspace. The plugin in this example is configured to generate Cobertura code coverage and JUnit test result reports. Furthermore, the coverage report is generated only for the code in the `source` folder located in the root of your repository. For more information on how to configure the plugin, see [Plugin Configuration Guide](../CONFIGDOC.md).
+![build_environment](https://user-images.githubusercontent.com/48831250/105091260-943ea280-5a6d-11eb-8d11-48747df7ec32.png)
 
-![run_matlab_tests](https://user-images.githubusercontent.com/48831250/94479048-2f9bc700-01a2-11eb-9ff6-4ab1df99d1b9.png)
+6. In the **Build** section, select **Add build step > Run MATLAB Tests**. Then, select your desired artifacts to be generated in the project workspace. The plugin in this example is configured to generate Cobertura code coverage and JUnit test result reports. Furthermore, the coverage report is generated only for the code in the `source` folder located in the root of your repository. For more information on how to configure the plugin, see [Plugin Configuration Guide](../CONFIGDOC.md).
 
-7. In the **Post-build Actions** section of Jenkins, add two post-build actions to publish the Cobertura code coverage and JUnit test result reports. For each report, provide the path to the report file.
+![run_matlab_tests](https://user-images.githubusercontent.com/48831250/105909903-2149a480-5ff6-11eb-81f1-c3b44e9b17d1.png)
 
-![post_build](https://user-images.githubusercontent.com/48831250/94479293-96b97b80-01a2-11eb-97ff-44a321bce0e9.png)
+7. In the **Post-build Actions** section, add two post-build actions to publish the Cobertura code coverage and JUnit test result reports. For each report, provide the path to the report file.
 
+![post_build](https://user-images.githubusercontent.com/48831250/105082096-14aad680-5a61-11eb-9868-68d018199f9d.png)
 
 8. 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.
 
-## Run Tests and Inspect Test Artifacts
-To build your Jenkins project and run the tests specified in the repository, click **Build Now** in the project interface, which displays the project name at the top-left of the page. Jenkins triggers a build, assigns it a number under **Build History**, and runs the build. If the build is successful, a blue circle icon appears next to the build number. If the build fails, Jenkins adds a red circle icon. In this example, the build passes because all of the tests specified in the Times Table App project pass.
+## Run Tests and Inspect Artifacts
+To build your freestyle project, click **Build Now** in the project interface, which displays the project name at the top-left of the page. Jenkins triggers a build, assigns it a number under **Build History**, and runs the build. If the build is successful, a blue circle icon appears next to the build number. If the build fails, Jenkins adds a red circle icon. In this example, the build passes because all of the tests in the Times Table App project pass.
 
-![build_1](https://user-images.githubusercontent.com/48831250/94481160-4db6f680-01a5-11eb-83eb-75027a009321.png)
+![build_1](https://user-images.githubusercontent.com/48831250/105084788-dca59280-5a64-11eb-858d-664a5727a947.png)
 
-Navigate to the project workspace by clicking the **Workspace** icon in the project interface. In this example, the generated test artifacts are in the `matlabTestArtifacts` folder of the workspace.
+Navigate to the project workspace by clicking the **Workspace** icon in the project interface. In this example, the generated artifacts are in the `matlabTestArtifacts` folder of the workspace.
 
-![workspace](https://user-images.githubusercontent.com/48831250/94481319-88209380-01a5-11eb-8681-440ea84b59d9.png)
+![workspace](https://user-images.githubusercontent.com/48831250/105085419-b46a6380-5a65-11eb-8d46-747dd23291bf.png)
 
 Access the published Cobertura code coverage report by opening the **Coverage Report** link in the project interface.
 
-![cobertura_report](https://user-images.githubusercontent.com/48831250/94481556-e2b9ef80-01a5-11eb-86f2-1679ae63f407.png)
+![cobertura_report](https://user-images.githubusercontent.com/48831250/105085331-9ac91c00-5a65-11eb-9628-efbf70520489.png)
 
 To view the published JUnit test results, open the **Latest Test Result** link in the project interface. In the new page, open the link in the **All Tests** table. The table expands and lists information for each of the test classes within the Times Table App project.  
 
-![junit_report](https://user-images.githubusercontent.com/48831250/94481735-33c9e380-01a6-11eb-9106-d96cfd7676ae.png)
+![junit_report](https://user-images.githubusercontent.com/48831250/105088211-956dd080-5a69-11eb-931c-aef201eb9dbe.png)
 
 ## See Also
 [MathWorks Blogs: Developer Zone – Continuous Integration](https://blogs.mathworks.com/developer/category/continuous-integration/)<br/>
diff --git a/src/main/resources/com/mathworks/ci/MatlabInstallationAxis/config.jelly b/src/main/resources/com/mathworks/ci/MatlabInstallationAxis/config.jelly
@@ -17,7 +17,7 @@
         </j:when>
     </j:choose>
 
-    <f:entry  help="">
+    <f:entry>
         <j:forEach var="installation" items="${descriptor.installations}">
             <f:checkbox name="values" json="${installation.name}" checked="${instance.values.contains(installation.name)}" title="${installation.name}" />
             <st:nbsp/>
diff --git a/src/main/resources/com/mathworks/ci/MatlabInstallationAxis/help.html b/src/main/resources/com/mathworks/ci/MatlabInstallationAxis/help.html
@@ -0,0 +1,9 @@
+<div>
+    <p>
+        Use this list to add MATLAB versions as axis values to your matrix configuration. The list includes the names of all MATLAB versions that have been registered as a tool in Jenkins.<br>
+        In each build iteration, the plugin prepends one of the selected versions to the PATH environment variable and invokes it to perform the build.
+    </p>
+    <p><br>
+        <b>Note:</b> In multi-configuration projects, the values specified by <b>Use MATLAB version</b> take precedence over the values specified by the <b>MATLAB</b> axis.
+    </p>
+</div>
diff --git a/src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-selectByFolder.html b/src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-selectByFolder.html
@@ -0,0 +1,7 @@
+<div>
+<br>
+Specify the location of folders used to select test suite elements, relative to the project root folder. To generate a test suite, the plugin uses only the tests in the specified folders and their subfolders.
+<br>
+Paste the test folder path in the text box. To add more folders, click <b>Add folder.</b>
+<br>
+</div>
diff --git a/src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-selectByTag.html b/src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-selectByTag.html
@@ -0,0 +1,5 @@
+<div>
+<br>
+Specify the test tag used to select test suite elements. To generate a suite, the plugin uses only the test elements with the specified tag.
+<br>
+</div>
diff --git a/src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-sourceFolder.html b/src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-sourceFolder.html
@@ -1,4 +1,4 @@
 <div>
     <p>Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.</p>
-    <p>Paste the source folder path in the <b>File path</b> box. To add more folders, click <b>Add folder</b>.</p>
+    <p>Paste the source folder path in the <b>Folder path</b> box. To add more folders, click <b>Add folder</b>.</p>
 </div>
diff --git a/src/main/resources/com/mathworks/ci/UseMatlabVersionBuildWrapper/help-matlabRootFolder.html b/src/main/resources/com/mathworks/ci/UseMatlabVersionBuildWrapper/help-matlabRootFolder.html
@@ -1,8 +1,9 @@
 <div>
-  Enter the full path to the MATLAB root folder, which is returned by the <i><b>matlabroot</b></i> function. The specified directory will be prepended to the PATH environment variable, and the specified MATLAB version will be used to perform the build.
-  You must not leave this field blank if no MATLAB directory exists on the path. If you leave the field blank, then the system tries to use the MATLAB directory closest to the top of the system path. <br><br><br>Example:<br><br><i><b><u>Windows:</u></b></i><br> C:\Program Files\MATLAB\R2019a <br>
-  <i><b><u>Linux:</u></b></i><br> /usr/local/MATLAB/R2019a <br>
-  <i><b><u>Mac:</u></b></i><br> /Applications/MATLAB_R2019a.app <br>
+  Enter the full path to the MATLAB root folder, which is returned by the <b>matlabroot</b> function. The plugin prepends the folder to the PATH environment variable and uses the specified MATLAB version to perform the build.
+  You must not leave this box blank if no MATLAB folder exists on the path. If you leave it blank, the plugin attempts to use the topmost MATLAB folder on the system path.
+  <br><br><br>Here are examples of the root folder path on different platforms:<br><br><b>Windows:</b><br> C:\Program Files\MATLAB\R2020b <br>
+  <b>Linux:</b><br> /usr/local/MATLAB/R2020b <br>
+  <b>macOS:</b><br> /Applications/MATLAB_R2020b.app <br>
   <p>
   <b>Note:</b> If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.</p>
-</div>
+</div>
diff --git a/src/main/resources/com/mathworks/ci/UseMatlabVersionBuildWrapper/help.html b/src/main/resources/com/mathworks/ci/UseMatlabVersionBuildWrapper/help.html
@@ -1,7 +1,7 @@
 <div>
     <p>
         Use this list to specify the MATLAB version for the build. The plugin prepends your specified MATLAB to the PATH environment variable and uses it to perform the build. <br>
-        The list includes the names of all MATLAB versions that have been registered as a tool in <u>Jenkins</u>. Select one of the tools, or select <b>Custom…</b> if you want to specify a different version. When you select <b>Custom…</b>, you must enter the full path to the desired MATLAB root folder in the <b>MATLAB root</b> box.
+        The list includes the names of all MATLAB versions that have been registered as a tool in Jenkins. Select one of the tools, or select <b>Custom</b> if you want to specify a different version. When you select <b>Custom</b>, you must enter the full path to the desired MATLAB root folder in the <b>MATLAB root</b> box.
     </p>
     <p><br>
         <b>Note:</b> In multi-configuration projects, the value specified by <b>Use MATLAB version</b> takes precedence over the values specified by the <b>MATLAB</b> axis.
diff --git a/src/test/java/com/mathworks/ci/RunMatlabTestsBuilderTest.java b/src/test/java/com/mathworks/ci/RunMatlabTestsBuilderTest.java
@@ -303,7 +303,7 @@ public void verifySourceFolderDefaultState() throws Exception {
 
      @Test
      public void verifySelectByFolderDefaultState() throws Exception {
-         this.buildWrapper.setMatlabRootFolder(getMatlabroot("R2017a"));
+         this.buildWrapper.setMatlabBuildWrapperContent(new MatlabBuildWrapperContent(Message.getValue("matlab.custom.location"), getMatlabroot("R2017a")));
          project.getBuildWrappersList().add(this.buildWrapper);
          project.getBuildersList().add(this.testBuilder);
          HtmlPage page = jenkins.createWebClient().goTo("job/test0/configure");
@@ -321,7 +321,7 @@ public void verifySelectByFolderDefaultState() throws Exception {
 
       @Test
       public void verifySelectByTagDefaultState() throws Exception {
-          this.buildWrapper.setMatlabRootFolder(getMatlabroot("R2017a"));
+          this.buildWrapper.setMatlabBuildWrapperContent(new MatlabBuildWrapperContent(Message.getValue("matlab.custom.location"), getMatlabroot("R2017a")));
           project.getBuildWrappersList().add(this.buildWrapper);
           project.getBuildersList().add(this.testBuilder);
           HtmlPage page = jenkins.createWebClient().goTo("job/test0/configure");

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<div>
 +<br>
 +Specify the location of folders used to select test suite elements, relative to the project root folder. To generate a test suite, the plugin uses only the tests in the specified folders and their subfolders.
 +<br>
 +Paste the test folder path in the text box. To add more folders, click <b>Add folder.</b>
 +<br>
 +</div>