Leverage testCase.assumeTrue to skip tests in certain environments

Author: dklilley

.github/workflows/test.yml

@@ -42,6 +42,8 @@ jobs:
       run: npm test
 
   matlab-test:
+    env:
+      MATLAB_TEST_ENVIRONMENT: 1
     name: ${{ matrix.matlab-version }}-${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:

tests/matlab/matlabls/handlers/folding/tGetFoldingRanges.m

@@ -1,6 +1,13 @@
 % Copyright 2025 The MathWorks, Inc.
 classdef tGetFoldingRanges < matlab.unittest.TestCase
     methods (TestClassSetup)
+        function isApplicable (testCase)
+            % Determine if the test should be skipped in the current environment
+            testCase.assumeTrue(...
+                ~isMATLABReleaseOlderThan('R2024b'),...
+                "Code folding only supported in R2024b and later.");
+        end
+
         function setup (~)
             % Add function under test to path
             addpath("../../../../../matlab");

tests/matlab/matlabls/handlers/formatting/tFormatCode.m

@@ -5,6 +5,16 @@
     end
 
     methods (TestClassSetup)
+        function isApplicable (testCase)
+            % Determine if the test should be skipped in the current environment
+            isTestingEnvironment = ~isempty(getenv('MATLAB_TEST_ENVIRONMENT'));
+            shouldRun = ~(isMATLABReleaseOlderThan('R2025a') && isTestingEnvironment);
+
+            testCase.assumeTrue(...
+                shouldRun,...
+                "Document formatting test cannot run prior to 25a in GitHub test environment.");
+        end
+
         function setup (~)
             % Add function under test to path
             addpath("../../../../../matlab");
@@ -15,12 +25,6 @@ function setup (~)
         % Test correct formatting with spaces when the tab size is 4.
         % Each indent should be represented by 4 spaces.
         function testFormatting4WithSpaces (testCase)
-            if shouldSkipTest()
-                disp('Skipping test due to environment limitations.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             options.insertSpaces = true;
             options.tabSize = 4;
 
@@ -33,12 +37,6 @@ function testFormatting4WithSpaces (testCase)
         % Test correct formatting with tabs when the tab size is 4.
         % Each indent should be represented by 1 tab character.
         function testFormatting4WithTabs (testCase)
-            if shouldSkipTest()
-                disp('Skipping test due to environment limitations.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             options.insertSpaces = false;
             options.tabSize = 4;
 
@@ -51,12 +49,6 @@ function testFormatting4WithTabs (testCase)
         % Test correct formatting with spaces when the tab size is 6.
         % Each indent should be represented by 6 spaces.
         function testFormatting6WithSpaces (testCase)
-            if shouldSkipTest()
-                disp('Skipping test due to environment limitations.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             options.insertSpaces = true;
             options.tabSize = 6;
 
@@ -69,12 +61,6 @@ function testFormatting6WithSpaces (testCase)
         % Test correct formatting with tabs when the tab size is 6.
         % Each indent should be represented by 1 tab character.
         function testFormatting6WithTabs (testCase)
-            if shouldSkipTest()
-                disp('Skipping test due to environment limitations.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             options.insertSpaces = false;
             options.tabSize = 4;
 
@@ -85,9 +71,3 @@ function testFormatting6WithTabs (testCase)
         end
     end
 end
-
-function shouldSkip = shouldSkipTest ()
-    % Before 25a, code formatting depends on Java logic, which may not be available
-    % in the testing environment.
-    shouldSkip = isMATLABReleaseOlderThan('R2025a') && ~isempty(javachk('swing'));
-end

tests/matlab/matlabls/handlers/linting/tGetSuppressionEdits.m

@@ -1,6 +1,13 @@
 % Copyright 2025 The MathWorks, Inc.
 classdef tGetSuppressionEdits < matlab.unittest.TestCase
     methods (TestClassSetup)
+        function isApplicable (testCase)
+            % Determine if the test should be skipped in the current environment
+            testCase.assumeTrue(...
+                ~isMATLABReleaseOlderThan('R2022a'),...
+                "Diagnostic suppression tests require R2022a and later.");
+        end
+
         function setup (~)
             % Add function under test to path
             addpath("../../../../../matlab");
@@ -10,12 +17,6 @@ function setup (~)
     methods (Test)
         % Test a basic case where a suppression should be placed on the same line
         function testBasicSuppression (testCase)
-            if shouldSkipTest()
-                disp('Skipping test on MATLAB version prior to R2022a.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             code = sprintf('if true\n    x = 3;\nend');
             diagnosticId = 'testId';
             diagnosticLine = 2;
@@ -30,12 +31,6 @@ function testBasicSuppression (testCase)
 
         % Test a basic case where a file-wide suppression should be placed on the same line
         function testBasicSuppressionInFile (testCase)
-            if shouldSkipTest()
-                disp('Skipping test on MATLAB version prior to R2022a.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             code = sprintf('if true\n    x = 3;\nend');
             diagnosticId = 'testId';
             diagnosticLine = 2;
@@ -50,12 +45,6 @@ function testBasicSuppressionInFile (testCase)
 
         % Test that suppression does not have preceding whitespace when there is trailing whitespace on line
         function testSuppressionWithTrailingSpace (testCase)
-            if shouldSkipTest()
-                disp('Skipping test on MATLAB version prior to R2022a.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             code = sprintf('if true\n    x = 3;  \nend');
             diagnosticId = 'testId';
             diagnosticLine = 2;
@@ -70,12 +59,6 @@ function testSuppressionWithTrailingSpace (testCase)
 
         % Test a case where a suppression should be placed at the end of a multi-line statement
         function testSuppressionAfterMultilineStatement (testCase)
-            if shouldSkipTest()
-                disp('Skipping test on MATLAB version prior to R2022a.');
-                testCase.verifyTrue(true);
-                return;
-            end
-
             code = sprintf('if true\n    x = 1 + ...\n        2 + ...\n        3;\nend');
             diagnosticId = 'testId';
             diagnosticLine = 2;
@@ -89,8 +72,3 @@ function testSuppressionAfterMultilineStatement (testCase)
         end
     end
 end
-
-function shouldSkip = shouldSkipTest ()
-    % Required APIs are not available prior to R2022a
-    shouldSkip = isMATLABReleaseOlderThan('R2022a');
-end