feat: added RunRelevantTests test-level @W-20152151@

Author: jfeingold35

messages/sdr.md

@@ -22,6 +22,10 @@ Could not find parent type for %s (%s)
 
 Component conversion failed: %s
 
+# error_invalid_test_level
+
+TestLevel cannot be '%s' unless API version is %s or later
+
 # error_merge_metadata_target_unsupported
 
 Merge convert for metadata target format currently unsupported

package.json

@@ -29,6 +29,7 @@
     "@salesforce/kit": "^3.2.4",
     "@salesforce/ts-types": "^2.0.12",
     "@salesforce/types": "^1.5.0",
+    "@types/semver": "^7.7.1",
     "fast-levenshtein": "^3.0.0",
     "fast-xml-parser": "^4.5.3",
     "got": "^11.8.6",
@@ -38,6 +39,7 @@
     "mime": "2.6.0",
     "minimatch": "^9.0.5",
     "proxy-agent": "^6.4.0",
+    "semver": "^7.7.3",
     "yaml": "^2.8.1"
   },
   "devDependencies": {

src/client/metadataApiDeploy.ts

@@ -18,6 +18,7 @@ import { format } from 'node:util';
 import { isString } from '@salesforce/ts-types';
 import JSZip from 'jszip';
 import fs from 'graceful-fs';
+import semver from 'semver';
 import { Lifecycle } from '@salesforce/core/lifecycle';
 import { Messages } from '@salesforce/core/messages';
 import { SfError } from '@salesforce/core/sfError';
@@ -116,6 +117,7 @@ export class MetadataApiDeploy extends MetadataTransfer<
   public constructor(options: MetadataApiDeployOptions) {
     super(options);
     options.apiOptions = { ...MetadataApiDeploy.DEFAULT_OPTIONS.apiOptions, ...options.apiOptions };
+    validateOptions(options);
     this.options = Object.assign({}, options);
     this.isRestDeploy = !!options.apiOptions?.rest;
     this.registry = options.registry ?? new RegistryAccess();
@@ -524,6 +526,17 @@ const buildFileResponsesFromComponentSet =
     }
     return fileResponses;
   };
+
+const validateOptions = (options: MetadataApiDeployOptions): void => {
+  const runningRelevantTestsOnly = options.apiOptions?.testLevel === 'RunRelevantTests';
+  const beforeApiV66 = options.apiVersion && semver.lt(semver.coerce(options.apiVersion)!, '66.0.0');
+  if (runningRelevantTestsOnly && beforeApiV66) {
+    throw new SfError(
+      messages.getMessage('error_invalid_test_level', ['RunRelevantTests', '66.0']),
+      'InvalidTestLevelSelection'
+    );
+  }
+};
 /**
  * register a listener to `scopedPreDeploy`
  */

src/client/types.ts

@@ -364,7 +364,7 @@ export type MetadataApiDeployOptions = {
   runAllTests?: boolean;
   runTests?: string[];
   singlePackage?: boolean;
-  testLevel?: 'NoTestRun' | 'RunSpecifiedTests' | 'RunLocalTests' | 'RunAllTestsInOrg';
+  testLevel?: 'NoTestRun' | 'RunSpecifiedTests' | 'RunLocalTests' | 'RunAllTestsInOrg' | 'RunRelevantTests';
   /**
    * Set to true to use the REST API for deploying.
    */

test/client/metadataApiDeploy.test.ts

@@ -1256,6 +1256,27 @@ describe('MetadataApiDeploy', () => {
       expect(mdOpts.zipPath).to.equal('foo/myZip.zip');
     });
 
+    it('should disallow "RunRelevantTests" for API versions <66.0', () => {
+      const constructorError = {
+        name: 'InvalidTestLevelSelection',
+        message: messages.getMessage('error_invalid_test_level', ['RunRelevantTests', '66.0']),
+      };
+      try {
+        new MetadataApiDeploy({
+          usernameOrConnection: 'testing',
+          apiOptions: {
+            testLevel: 'RunRelevantTests',
+          },
+          apiVersion: '8.0', // Tricksy case here: 8.0 is alphabetically after "66.0" but semantically after it.
+        });
+        assert.fail('Should have thrown an error');
+      } catch (e) {
+        assert(e instanceof Error);
+        expect(e.name).to.equal(constructorError.name);
+        expect(e.message).to.equal(constructorError.message);
+      }
+    });
+
     it('should allow mdapi path', () => {
       const mdApiDeploy = new MetadataApiDeploy({
         usernameOrConnection: 'testing',

yarn.lock

@@ -1039,6 +1039,11 @@
   resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.5.8.tgz#8268a8c57a3e4abd25c165ecd36237db7948a55e"
   integrity sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==
 
+"@types/semver@^7.7.1":
+  version "7.7.1"
+  resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.7.1.tgz#3ce3af1a5524ef327d2da9e4fd8b6d95c8d70528"
+  integrity sha512-FmgJfu+MOcQ370SD0ev7EI8TlCAfKYU+B4m5T3yXc1CiRN94g/SZPtsCkk506aUDtlMnFZvasDwHHUcZUEaYuA==
+
 "@types/shelljs@^0.8.15":
   version "0.8.15"
   resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.8.15.tgz#22c6ab9dfe05cec57d8e6cb1a95ea173aee9fcac"