From eb4815f8f844e61ef0a05c550bf8a3dcf22fb2b6 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Mon, 3 Mar 2025 16:41:20 -0500 Subject: [PATCH 01/16] Update CONFIGDOC.md --- CONFIGDOC.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 63c23977..d7c54fd7 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -20,6 +20,9 @@ When you define an automated pipeline of tasks in Jenkins™, whether in the - [Use the `runMATLABTests` Step](#use-the-runmatlabtests-step) - [Use the `runMATLABCommand` Step](#use-the-runmatlabcommand-step) - [Use MATLAB in Matrix Build](#use-matlab-in-matrix-build) +- [Access Visualized MATLAB Build and Test Results](#access-visualized-matlab-build-and-test-results) + - [Access Visualized Build Results](#access-visualized-build-results) + - [Access Visualized Test Results](#access-visualized-test-results) - [Register MATLAB as Jenkins Tool](#register-matlab-as-jenkins-tool) - [Register Preinstalled MATLAB Version](#register-preinstalled-matlab-version) - [Automatically Install MATLAB Using MATLAB Package Manager](#automatically-install-matlab-using-matlab-package-manager) @@ -78,9 +81,7 @@ You can specify build options for your MATLAB build by first selecting **Build o MATLAB exits with exit code 0 if the specified tasks run without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the step to fail. -Starting in R2024a, you can view the results of running a MATLAB build in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page. - -![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4) +You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [Access Visualized Build Results](#access-visualized-build-results). #### Run MATLAB Tests The **Run MATLAB Tests** build step lets you run MATLAB and Simulink tests and generate artifacts, such as test results in JUnit-style XML format and code coverage results in Cobertura XML format. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your build does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders. @@ -283,7 +284,7 @@ node { } ``` -Starting in R2024a, you can view the results of running a MATLAB build in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page. +You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [Access Visualized Build Results](#access-visualized-build-results). ### Use the `runMATLABTests` Step Use the `runMATLABTests` step in your pipeline to run MATLAB and Simulink tests and generate test and coverage artifacts. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your pipeline does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders. @@ -442,7 +443,7 @@ pipeline { } ``` -You can also invoke MATLAB as a Jenkins tool when you perform a matrix build in your pipeline project. This example uses three MATLAB versions (specified in an `axis` block using their tool names) to run a set of MATLAB commands and tests. For more information about using tools in pipeline projects, see [Use MATLAB as a Tool in Pipeline Project](#use-matlab-as-a-tool-in-pipeline-project). +You can also invoke MATLAB as a Jenkins tool when you perform a matrix build in your pipeline project. This example uses three MATLAB versions (specified in an `axis` block using their tool names) to run a set of MATLAB commands and tests. For more information about using tools in pipeline projects, see [Use MATLAB as a Tool in Pipeline Project](#use-matlab-as-a-tool-in-pipeline-project). ```groovy // Declarative Pipeline @@ -479,6 +480,16 @@ pipeline { } ``` +## Access Visualized MATLAB Build and Test Results +You can access the results of running a MATLAB build and the results of running MATLAB and Simulink tests directly from your Jenkins interface. + +### Access Visualized Build Results +Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or `runMATLABBuild` step, you can view the MATLAB build results in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page. + +![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4) + +### Access Visualized Test Results + ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From 9e8d44e0fc0efed2cc6c3c4e2875a64e522fa761 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Mon, 3 Mar 2025 16:51:15 -0500 Subject: [PATCH 02/16] Update CONFIGDOC.md --- CONFIGDOC.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index d7c54fd7..cc44411e 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -112,13 +112,15 @@ To generate test and coverage artifacts, select options in the **Generate Test A ![run_matlab_tests_artifacts](https://github.com/user-attachments/assets/d38bb240-5a24-4313-9585-8692c82525f5) -The **Run MATLAB Tests** build step produces a MATLAB script file and uses it to run the tests and generate the artifacts. The plugin writes the contents of this file to the build log. You can review the build log on the **Console Output** page to understand the testing workflow. - Artifacts that the plugin generates are subject to these restrictions: * Producing a PDF test report on macOS platforms is supported in MATLAB R2020b and later. * Exporting Simulink Test™ Manager results requires a Simulink Test license and is supported in MATLAB R2019a and later. * Collecting model coverage results requires a Simulink Coverage™ license and is supported in MATLAB R2018b and later. +The **Run MATLAB Tests** build step produces a MATLAB script file and uses it to run the tests and generate the artifacts. The plugin writes the contents of this file to the build log. You can review the build log on the **Console Output** page to understand the testing workflow. + +You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [Access Visualized Test Results](#access-visualized-test-results). + #### Run MATLAB Command The **Run MATLAB Command** build step lets you run MATLAB scripts, functions, and statements. You can use this build step to customize your test run or execute any MATLAB commands. @@ -366,6 +368,8 @@ node { } ``` +You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [Access Visualized Test Results](#access-visualized-test-results). + ### Use the `runMATLABCommand` Step Use the `runMATLABCommand` step in your pipeline to run MATLAB scripts, functions, and statements. You can use this step to customize your test run or execute any MATLAB commands. The step requires an input and also accepts an optional input. From 1107338ebaee9957e5f527cc26cf27421c100ac8 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Mon, 3 Mar 2025 17:15:15 -0500 Subject: [PATCH 03/16] Update CONFIGDOC.md --- CONFIGDOC.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index cc44411e..e1026749 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -493,6 +493,10 @@ Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or ![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4) ### Access Visualized Test Results +If you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface when you take any of these actions: +- Run tests using the **Run MATLAB Tests** or `runMATLABTests` step. +- Run tests using a [`matlab.buildtool.tasks.TestTask`] (https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance through the **Run MATLAB Build** or `runMATLABBuild` step. +- Run tests using a default test runner through the **Run MATLAB Command** or `runMATLABCommand` step. ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From 7169f2ea4c40c5ff655052937b69f50534769c97 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Mon, 3 Mar 2025 17:16:28 -0500 Subject: [PATCH 04/16] Update CONFIGDOC.md --- CONFIGDOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index e1026749..5364a883 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -495,7 +495,7 @@ Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or ### Access Visualized Test Results If you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface when you take any of these actions: - Run tests using the **Run MATLAB Tests** or `runMATLABTests` step. -- Run tests using a [`matlab.buildtool.tasks.TestTask`] (https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance through the **Run MATLAB Build** or `runMATLABBuild` step. +- Run tests using a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance through the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests using a default test runner through the **Run MATLAB Command** or `runMATLABCommand` step. ## Register MATLAB as Jenkins Tool From 5169232bdb03fbe03de611f05f026ac02055a0c1 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 09:28:18 -0500 Subject: [PATCH 05/16] Update CONFIGDOC.md --- CONFIGDOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 5364a883..23053dda 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -493,7 +493,7 @@ Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or ![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4) ### Access Visualized Test Results -If you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface when you take any of these actions: +Starting in R2024b, if you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface by taking any of these actions: - Run tests using the **Run MATLAB Tests** or `runMATLABTests` step. - Run tests using a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance through the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests using a default test runner through the **Run MATLAB Command** or `runMATLABCommand` step. From 040bf1038b58895f79367c3d68f6f13095d36c34 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 14:55:25 -0500 Subject: [PATCH 06/16] Update CONFIGDOC.md --- CONFIGDOC.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 23053dda..51ea01cf 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -20,9 +20,9 @@ When you define an automated pipeline of tasks in Jenkins™, whether in the - [Use the `runMATLABTests` Step](#use-the-runmatlabtests-step) - [Use the `runMATLABCommand` Step](#use-the-runmatlabcommand-step) - [Use MATLAB in Matrix Build](#use-matlab-in-matrix-build) -- [Access Visualized MATLAB Build and Test Results](#access-visualized-matlab-build-and-test-results) - - [Access Visualized Build Results](#access-visualized-build-results) - - [Access Visualized Test Results](#access-visualized-test-results) +- [View MATLAB Build and Test Results](#view-matlab-build-and-test-results) + - [View Build Results](#view-build-results) + - [View Test Results](#view-test-results) - [Register MATLAB as Jenkins Tool](#register-matlab-as-jenkins-tool) - [Register Preinstalled MATLAB Version](#register-preinstalled-matlab-version) - [Automatically Install MATLAB Using MATLAB Package Manager](#automatically-install-matlab-using-matlab-package-manager) @@ -81,7 +81,7 @@ You can specify build options for your MATLAB build by first selecting **Build o MATLAB exits with exit code 0 if the specified tasks run without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the step to fail. -You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [Access Visualized Build Results](#access-visualized-build-results). +You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [View Build Results](#view-build-results). #### Run MATLAB Tests The **Run MATLAB Tests** build step lets you run MATLAB and Simulink tests and generate artifacts, such as test results in JUnit-style XML format and code coverage results in Cobertura XML format. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your build does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders. @@ -119,7 +119,7 @@ Artifacts that the plugin generates are subject to these restrictions: The **Run MATLAB Tests** build step produces a MATLAB script file and uses it to run the tests and generate the artifacts. The plugin writes the contents of this file to the build log. You can review the build log on the **Console Output** page to understand the testing workflow. -You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [Access Visualized Test Results](#access-visualized-test-results). +You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [View Test Results](#view-test-results). #### Run MATLAB Command The **Run MATLAB Command** build step lets you run MATLAB scripts, functions, and statements. You can use this build step to customize your test run or execute any MATLAB commands. @@ -286,7 +286,7 @@ node { } ``` -You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [Access Visualized Build Results](#access-visualized-build-results). +You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [View Build Results](#view-build-results). ### Use the `runMATLABTests` Step Use the `runMATLABTests` step in your pipeline to run MATLAB and Simulink tests and generate test and coverage artifacts. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your pipeline does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders. @@ -368,7 +368,7 @@ node { } ``` -You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [Access Visualized Test Results](#access-visualized-test-results). +You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [View Test Results](#view-test-results). ### Use the `runMATLABCommand` Step Use the `runMATLABCommand` step in your pipeline to run MATLAB scripts, functions, and statements. You can use this step to customize your test run or execute any MATLAB commands. The step requires an input and also accepts an optional input. @@ -484,19 +484,19 @@ pipeline { } ``` -## Access Visualized MATLAB Build and Test Results +## View MATLAB Build and Test Results You can access the results of running a MATLAB build and the results of running MATLAB and Simulink tests directly from your Jenkins interface. -### Access Visualized Build Results +### View Build Results Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or `runMATLABBuild` step, you can view the MATLAB build results in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page. ![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4) -### Access Visualized Test Results +### View Test Results Starting in R2024b, if you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface by taking any of these actions: - Run tests using the **Run MATLAB Tests** or `runMATLABTests` step. -- Run tests using a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance through the **Run MATLAB Build** or `runMATLABBuild` step. -- Run tests using a default test runner through the **Run MATLAB Command** or `runMATLABCommand` step. +- Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. +- Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From 6f9d9285e48bdd386768ea3500bd16b6db249d9c Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 16:22:39 -0500 Subject: [PATCH 07/16] Update CONFIGDOC.md --- CONFIGDOC.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 51ea01cf..779b8327 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -498,6 +498,10 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. +After your tests run, the Jenkins build summary page displays the total number of tests that run as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. The table provides information about each test that ran. + +![Table of MATLAB test results including six passing tests from three test files. The tests within the first test file are visiable after clicking the expand button. Each test row includes a test name, its diagnostics, and duration.](https://github.com/user-attachments/assets/28224b5e-8558-4bd5-aef4-b8c8d61c22cb) + ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From 902d4dc034b1214cba323730181f80ec52d0f561 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 16:48:30 -0500 Subject: [PATCH 08/16] Update CONFIGDOC.md --- CONFIGDOC.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 779b8327..4a73a206 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -496,11 +496,19 @@ Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or Starting in R2024b, if you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface by taking any of these actions: - Run tests using the **Run MATLAB Tests** or `runMATLABTests` step. - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. -- Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. +- Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your tests run, the Jenkins build summary page displays the total number of tests that run as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. The table provides information about each test that ran. +After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. The table provides information about each test that ran. -![Table of MATLAB test results including six passing tests from three test files. The tests within the first test file are visiable after clicking the expand button. Each test row includes a test name, its diagnostics, and duration.](https://github.com/user-attachments/assets/28224b5e-8558-4bd5-aef4-b8c8d61c22cb) +Each row of the table represents the test file. +All tests for a single file are shown under that file. +The files with same name and different parent directories are shown separately and you can hover over the file name to see its path. +The table in table format allows easy management of test cases for a test file +You see the logs in-place for a failed/incomplete. If there are more than failures within a test case, say multiple verification failures, each verification failure will have its own dropdown and log box. +Each of the passed, failed, etc. buttons act as filters to respective type of tests + + +![Table of MATLAB test results including six passing tests from three test files. The tests within the first test file are visiable after clicking the expand button. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/28224b5e-8558-4bd5-aef4-b8c8d61c22cb) ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From dd263ae0e4b38d45aa5cd9f3886e71a7a2276353 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 17:51:42 -0500 Subject: [PATCH 09/16] Update CONFIGDOC.md --- CONFIGDOC.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 4a73a206..ff5f1d00 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -498,17 +498,17 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. The table provides information about each test that ran. +After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. By default, the table includes a row for each test file that ran. Each row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to view its parent directory. -Each row of the table represents the test file. -All tests for a single file are shown under that file. -The files with same name and different parent directories are shown separately and you can hover over the file name to see its path. -The table in table format allows easy management of test cases for a test file -You see the logs in-place for a failed/incomplete. If there are more than failures within a test case, say multiple verification failures, each verification failure will have its own dropdown and log box. -Each of the passed, failed, etc. buttons act as filters to respective type of tests +![Table of MATLAB test results including three test files. Each row displays a Passed status, filename, expander button, and duration.](https://github.com/user-attachments/assets/4d65d007-72a8-494d-8d62-68a9e4e04c25) +To view the tests within each test file, click the expander to the right of the filename. The test results are displayed in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, or Incomplete), test procedure name, test diagnostics, and duration. -![Table of MATLAB test results including six passing tests from three test files. The tests within the first test file are visiable after clicking the expand button. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/28224b5e-8558-4bd5-aef4-b8c8d61c22cb) +- Each of the passed, failed, etc. buttons act as filters to respective type of tests + +![Table of MATLAB test results including six passing tests from three test files. The tests within the first test file are visiable after clicking the expander to the right of the filename. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/28224b5e-8558-4bd5-aef4-b8c8d61c22cb) + +You can use the status filters above the **MATLAB Test Results** table to customize your view. For example, to focus on the failed tests, select the Failed status filter. ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From 43483b8bc5793aa7bc0f9bc4cdb059fec592224a Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 18:08:08 -0500 Subject: [PATCH 10/16] Update CONFIGDOC.md --- CONFIGDOC.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index ff5f1d00..5112879c 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -498,17 +498,15 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. By default, the table includes a row for each test file that ran. Each row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to view its parent directory. +After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. By default, the table includes a row for each test file that ran. The row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to view its parent directory. -![Table of MATLAB test results including three test files. Each row displays a Passed status, filename, expander button, and duration.](https://github.com/user-attachments/assets/4d65d007-72a8-494d-8d62-68a9e4e04c25) +![Table of MATLAB test results including one test file. The row in the table displays an Incomplete status, filename, expander, and duration.](https://github.com/user-attachments/assets/1764d0f2-d4d9-4b93-bc82-0158a011c1fc) -To view the tests within each test file, click the expander to the right of the filename. The test results are displayed in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, or Incomplete), test procedure name, test diagnostics, and duration. +You can interact with the table of test results. To view the tests within each test file, click the expander to the right of the filename. The test results are displayed in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, or Incomplete), test procedure name, test diagnostics, and duration. -- Each of the passed, failed, etc. buttons act as filters to respective type of tests +![Table of MATLAB test results including three passed tests and one incomplete test from a single test files. The tests within the first test file are visiable after clicking the expander to the right of the filename. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/a275caa7-a297-4510-a151-b7f2dee9e3c9) -![Table of MATLAB test results including six passing tests from three test files. The tests within the first test file are visiable after clicking the expander to the right of the filename. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/28224b5e-8558-4bd5-aef4-b8c8d61c22cb) - -You can use the status filters above the **MATLAB Test Results** table to customize your view. For example, to focus on the failed tests, select the Failed status filter. +You can use the status filters above the **MATLAB Test Results** table to customize your view. For example, to focus on any incomplete tests, select the Incomplete status filter. ## Register MATLAB as Jenkins Tool When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project. From adf9257b02eb43ee54f45fed10e281c517ddda31 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Tue, 4 Mar 2025 18:11:50 -0500 Subject: [PATCH 11/16] Update CONFIGDOC.md --- CONFIGDOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 5112879c..57f46aa8 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -498,7 +498,7 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. By default, the table includes a row for each test file that ran. The row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to view its parent directory. +After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each test file that ran. The row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to view its parent directory. ![Table of MATLAB test results including one test file. The row in the table displays an Incomplete status, filename, expander, and duration.](https://github.com/user-attachments/assets/1764d0f2-d4d9-4b93-bc82-0158a011c1fc) From e3e095e282f6ffe2d97c2f8ebf765a6b9e7b14ce Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Wed, 5 Mar 2025 15:58:03 -0500 Subject: [PATCH 12/16] Update CONFIGDOC.md --- CONFIGDOC.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 57f46aa8..97917d8c 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -81,7 +81,7 @@ You can specify build options for your MATLAB build by first selecting **Build o MATLAB exits with exit code 0 if the specified tasks run without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the step to fail. -You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [View Build Results](#view-build-results). +You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [View MATLAB Build and Test Results](#view-matlab-build-and-test-results). #### Run MATLAB Tests The **Run MATLAB Tests** build step lets you run MATLAB and Simulink tests and generate artifacts, such as test results in JUnit-style XML format and code coverage results in Cobertura XML format. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your build does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders. @@ -119,8 +119,6 @@ Artifacts that the plugin generates are subject to these restrictions: The **Run MATLAB Tests** build step produces a MATLAB script file and uses it to run the tests and generate the artifacts. The plugin writes the contents of this file to the build log. You can review the build log on the **Console Output** page to understand the testing workflow. -You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [View Test Results](#view-test-results). - #### Run MATLAB Command The **Run MATLAB Command** build step lets you run MATLAB scripts, functions, and statements. You can use this build step to customize your test run or execute any MATLAB commands. @@ -286,7 +284,7 @@ node { } ``` -You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [View Build Results](#view-build-results). +You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [View MATLAB Build and Test Results](#view-matlab-build-and-test-results). ### Use the `runMATLABTests` Step Use the `runMATLABTests` step in your pipeline to run MATLAB and Simulink tests and generate test and coverage artifacts. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your pipeline does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders. @@ -368,8 +366,6 @@ node { } ``` -You can access the results of running MATLAB and Simulink tests directly from your Jenkins interface. For more information, see [View Test Results](#view-test-results). - ### Use the `runMATLABCommand` Step Use the `runMATLABCommand` step in your pipeline to run MATLAB scripts, functions, and statements. You can use this step to customize your test run or execute any MATLAB commands. The step requires an input and also accepts an optional input. @@ -494,7 +490,6 @@ Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or ### View Test Results Starting in R2024b, if you have a MATLAB Test™ license, you can view your MATLAB and Simulink test results in your Jenkins interface by taking any of these actions: -- Run tests using the **Run MATLAB Tests** or `runMATLABTests` step. - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. From 78fb95f555c0232a85af34429248fee6721c3f91 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Wed, 5 Mar 2025 17:08:01 -0500 Subject: [PATCH 13/16] Update CONFIGDOC.md --- CONFIGDOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 97917d8c..46f6c9bd 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -493,7 +493,7 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your tests run, the Jenkins build summary page displays the number of tests that ran as well as the number of passed, failed, and incomplete tests. You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each test file that ran. The row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to view its parent directory. +After your tests run, the Jenkins build summary page displays the number of tests that ran, the number of passed, failed, and incomplete tests, and the number of tests that did not run (due to a fatal assertion failure). You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each test file that ran. The row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to identify its path within your project. ![Table of MATLAB test results including one test file. The row in the table displays an Incomplete status, filename, expander, and duration.](https://github.com/user-attachments/assets/1764d0f2-d4d9-4b93-bc82-0158a011c1fc) From a77ae69203db7bc7cc2ac49fcffbf2417348e5a7 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:27:14 -0500 Subject: [PATCH 14/16] Update CONFIGDOC.md --- CONFIGDOC.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 46f6c9bd..914fdc4b 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -493,11 +493,11 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your tests run, the Jenkins build summary page displays the number of tests that ran, the number of passed, failed, and incomplete tests, and the number of tests that did not run (due to a fatal assertion failure). You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each test file that ran. The row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to identify its path within your project. +After your build runs, the Jenkins build summary page displays the number of tests in the test suite as well as the number of tests that passed, failed, were incomplete (due to assumption failure), and did not run (due to fatal assertion failure). You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each file that defines a test in the test suite. Each table row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to identify its path within your project. ![Table of MATLAB test results including one test file. The row in the table displays an Incomplete status, filename, expander, and duration.](https://github.com/user-attachments/assets/1764d0f2-d4d9-4b93-bc82-0158a011c1fc) -You can interact with the table of test results. To view the tests within each test file, click the expander to the right of the filename. The test results are displayed in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, or Incomplete), test procedure name, test diagnostics, and duration. +You can interact with the table of test results. To view the results of tests within each test file, click the expander to the right of the filename. The test results are displayed in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, Incomplete, or Not Run), test procedure name, test diagnostics, and duration. ![Table of MATLAB test results including three passed tests and one incomplete test from a single test files. The tests within the first test file are visiable after clicking the expander to the right of the filename. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/a275caa7-a297-4510-a151-b7f2dee9e3c9) From d6aebed94f9ed4d03eae43d61349c63176b5f533 Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Thu, 6 Mar 2025 09:24:48 -0500 Subject: [PATCH 15/16] Update CONFIGDOC.md --- CONFIGDOC.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONFIGDOC.md b/CONFIGDOC.md index 914fdc4b..cb078d6a 100644 --- a/CONFIGDOC.md +++ b/CONFIGDOC.md @@ -493,13 +493,13 @@ Starting in R2024b, if you have a MATLAB Test™ license, you can view your - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the **Run MATLAB Build** or `runMATLABBuild` step. - Run tests with a default test runner using the **Run MATLAB Command** or `runMATLABCommand` step. A default test runner is equivalent to the runner that the testing framework configures by default when you call the [`runtests`](https://www.mathworks.com/help/matlab/ref/runtests.html) function. -After your build runs, the Jenkins build summary page displays the number of tests in the test suite as well as the number of tests that passed, failed, were incomplete (due to assumption failure), and did not run (due to fatal assertion failure). You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each file that defines a test in the test suite. Each table row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to identify its path within your project. +After your build runs, the Jenkins build summary page displays the number of tests in the test suite, as well as the number of tests that passed, failed, were incomplete (due to assumption failure), and did not run (due to fatal assertion failure). You can click the **MATLAB Test Results** link on the page to access the table of test results. The status buttons above the table provide a summary of the test results. By default, the table includes a row for each file that defines a test in the test suite. Each table row displays the status of a test file, its name, and the time it took to run. You can point to a filename in the table to identify its path within your project. ![Table of MATLAB test results including one test file. The row in the table displays an Incomplete status, filename, expander, and duration.](https://github.com/user-attachments/assets/1764d0f2-d4d9-4b93-bc82-0158a011c1fc) -You can interact with the table of test results. To view the results of tests within each test file, click the expander to the right of the filename. The test results are displayed in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, Incomplete, or Not Run), test procedure name, test diagnostics, and duration. +You can interact with the table of test results. To view the results of tests within each test file, click the expander to the right of the filename. The test results appear in a table under the filename. The row corresponding to each test includes the test status (Passed, Failed, Incomplete, or Not Run), test procedure name, test diagnostics, and duration. -![Table of MATLAB test results including three passed tests and one incomplete test from a single test files. The tests within the first test file are visiable after clicking the expander to the right of the filename. The row corresponding to each test includes the test procedure name, its diagnostics, and duration.](https://github.com/user-attachments/assets/a275caa7-a297-4510-a151-b7f2dee9e3c9) +![Table of MATLAB test results including three passed tests and one incomplete test from a single test files. The tests within the test file appear after clicking the expander to the right of the filename. The row corresponding to each test includes the test status, test procedure name, diagnostics, and duration.](https://github.com/user-attachments/assets/a275caa7-a297-4510-a151-b7f2dee9e3c9) You can use the status filters above the **MATLAB Test Results** table to customize your view. For example, to focus on any incomplete tests, select the Incomplete status filter. From c53db05b62948381ed6a20dfa80f5ed9079fa77a Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Thu, 6 Mar 2025 10:41:38 -0500 Subject: [PATCH 16/16] Update CONFIGDOC.md