apextestlist 1.12.3 → 1.13.0

package/CHANGELOG.md

@@ -5,6 +5,21 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.13.0](https://github.com/renatoliveira/apex-test-list/compare/v1.12.4...v1.13.0) (2025-06-19)
+
+
+### Features
+
+* add metadata filter option via yaml ([#234](https://github.com/renatoliveira/apex-test-list/issues/234)) ([1ccaf7b](https://github.com/renatoliveira/apex-test-list/commit/1ccaf7b445feb75c20770879289d1f3d5e1a2ae6))
+
+## [1.12.4](https://github.com/renatoliveira/apex-test-list/compare/v1.12.3...v1.12.4) (2025-06-14)
+
+
+### Bug Fixes
+
+* **deps:** bump @oclif/core from 4.3.0 to 4.3.3 ([#230](https://github.com/renatoliveira/apex-test-list/issues/230)) ([ec2ed5c](https://github.com/renatoliveira/apex-test-list/commit/ec2ed5c1f25ecc2366ebc219b71edc156440a45c))
+* **deps:** bump @salesforce/source-deploy-retrieve ([#231](https://github.com/renatoliveira/apex-test-list/issues/231)) ([5c5d78c](https://github.com/renatoliveira/apex-test-list/commit/5c5d78c5990c61ce3f82b7cbd4ac02f7cc8f1e52))
+
 ## [1.12.3](https://github.com/renatoliveira/apex-test-list/compare/v1.12.2...v1.12.3) (2025-06-01)
 
 

package/README.md

@@ -13,6 +13,7 @@ A plugin that generates a list of tests that your automated process should run,
   - [1. `@Tests:` (Custom Comment Annotation)](#1-tests-custom-comment-annotation)
   - [2. `@TestSuites:` (Custom Comment Annotation)](#2-testsuites-custom-comment-annotation)
   - [3. `@isTest` (Apex Annotation)](#3-istest-apex-annotation)
+  - [4. `.test-dependencies.yml` (Centralized Metadata Filter)](#4-test-dependenciesyml-centralized-metadata-filter)
 - [Running the Tool](#running-the-tool)
   - [Handling Missing Tests](#handling-missing-tests)
   - [Handling Missing Annotations](#handling-missing-annotations)
@@ -31,7 +32,7 @@ sf plugins install apextestlist
 
 ## Usage
 
-This tool identifies Apex tests using three annotations:
+This tool identifies Apex tests using either 3 Apex annotations or a separate metadata filter.
 
 ### 1. `@Tests:` (Custom Comment Annotation)
 
@@ -70,6 +71,35 @@ private class SampleTest {
 }
 ```
 
+### 4. `.test-dependencies.yml` (Centralized Metadata Filter)
+
+Instead of using the Apex annotations described previously, you can use this plugin to determine Apex tests with specific Salesforce metadata.
+
+This approach is designed to work seamlessly with the `-x`/`--manifest` flag using a manifest file generated by the [`sfdx-git-delta`](https://github.com/scolladon/sfdx-git-delta) plugin.
+
+1. Create a `.test-dependencies.yml` file in the root of your project.
+2. Map test classes to metadata entries (in `MetadataType:MetadataMember` format).
+   1. Use wildcards (\*) to match all children under a metadata namespace (e.g., all custom fields in an object).
+   2. The plugin will fail if the entries in the YAML don't match the expected format.
+
+```yml
+MyFooTest:
+  - CustomField:Account__c.field__c
+  - Flow:OpportunityFlowX
+  - ValidationRule:Account.RequiredEmail
+  - CustomField:Opportunity__c.*
+
+MyBarTest:
+  - CustomObject:Lead__c
+  - Flow:LeadFlowY
+```
+
+3. Run this plugin's command with the `filter-by-metadata`/`-m` flag **and** the `-x`/`--manifest` flag.
+
+```sh
+sf apextests list -x package/package.xml -m
+```
+
 ## Running the Tool
 
 To generate a test list, run the command in any Salesforce DX project:
@@ -96,7 +126,7 @@ The final deployment command would look like:
 sf project deploy start --tests SampleTest SuperSampleTest Sample2Test SuperSample2Test SampleTriggerTest
 ```
 
-If no annotations are found, the command output will be empty and will present this warning:
+If no test methods are found, the command output will be empty and will present this warning:
 
 ```sh
 No test methods found
@@ -104,7 +134,7 @@ No test methods found
 
 ### Handling Missing Tests
 
-By default, this tool does **not** verify if the tests specified in `@Tests:` or `@TestSuites:` exist in the project. To enable warnings for missing tests, use:
+By default, this tool does **not** verify if the test methods found exist in the project. To enable warnings for missing tests, use:
 
 ```sh
 sf apextests list --ignore-missing-tests
@@ -130,7 +160,7 @@ sf apextests list --no-warnings
 
 ```
 USAGE
-  $ sf apextests list -f <value> -x <value> -s -n -d <value> [--json]
+  $ sf apextests list -f <value> -x <value> -s -n -d <value> -m [--json]
 
 FLAGS
   -f, --format=<value>            Output format. Available options:
@@ -142,6 +172,8 @@ FLAGS
   -d, --ignore-package-directory  Ignore a package directory when looking for test annotations.
                                   Should match how they are declared in "sfdx-project.json".
                                   Can be declared multiple times.
+  -m, --filter-by-metadata        [default: false] When enabled with `manifest`, test selection is based on metadata changes (e.g., Flow, CustomObject) rather than Apex annotations.
+
 
 GLOBAL FLAGS
   --json  Format output as JSON.

package/lib/commands/apextests/list.d.ts

@@ -1,18 +1,16 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
-export type ApextestsListResult = {
-    tests: string[];
-    command: string;
-};
+import { ApextestsListResult } from '../../utils/types.js';
 export default class ApextestsList extends SfCommand<ApextestsListResult> {
     static readonly summary: string;
     static readonly description: string;
     static readonly examples: string[];
     static readonly flags: {
-        format: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         manifest: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'ignore-missing-tests': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'ignore-package-directory': import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'no-warnings': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'filter-by-metadata': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<ApextestsListResult>;
 }

package/lib/commands/apextests/list.js

@@ -1,13 +1,7 @@
-/* eslint-disable no-console */
 'use strict';
-/* eslint-disable no-await-in-loop */
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
-import { getPackageDirectories } from '../../helpers/getPackageDirectories.js';
-import { validateTests } from '../../helpers/validateTests.js';
-import { extractTypeNamesFromManifestFile } from '../../helpers/parsers.js';
-import { formatList } from '../../helpers/formatters.js';
-import { searchDirectoryForTestClasses, searchDirectoryForTestNamesInTestSuites } from '../../helpers/readers.js';
+import { listTests } from '../../core/listTests.js';
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('apextestlist', 'apextests.list');
 export default class ApextestsList extends SfCommand {
@@ -20,6 +14,7 @@ export default class ApextestsList extends SfCommand {
             description: messages.getMessage('flags.format.description'),
             char: 'f',
             required: false,
+            default: 'sf',
         }),
         manifest: Flags.string({
             summary: messages.getMessage('flags.manifest.summary'),
@@ -48,66 +43,25 @@ export default class ApextestsList extends SfCommand {
             required: false,
             default: false,
         }),
+        'filter-by-metadata': Flags.boolean({
+            summary: messages.getMessage('flags.filter-by-metadata.summary'),
+            description: messages.getMessage('flags.filter-by-metadata.description'),
+            char: 'm',
+            required: false,
+            default: false,
+        }),
     };
     async run() {
         const { flags } = await this.parse(ApextestsList);
-        const format = flags.format ?? 'sf';
-        const manifest = flags.manifest ?? undefined;
-        const ignoreMissingTests = flags['ignore-missing-tests'] ?? false;
-        const ignoreDirs = flags['ignore-package-directory'] ?? [];
-        const noWarnings = flags['no-warnings'];
-        let testClassesNames = null;
-        const testSuitesNames = [];
-        const allTestClasses = [];
-        const warnings = [];
-        // Get package directories full paths
-        const packageDirectories = await getPackageDirectories(ignoreDirs);
-        if (manifest) {
-            const manifestMetadata = await extractTypeNamesFromManifestFile(manifest);
-            testClassesNames = manifestMetadata.filter((name) => !name.endsWith('testSuite-meta.xml'));
-        }
-        // Loop through each directory and search for test classes
-        for (const directory of packageDirectories) {
-            const searchResult = await searchDirectoryForTestClasses(directory, testClassesNames);
-            allTestClasses.push(...searchResult.classes);
-            testSuitesNames.push(...searchResult.testSuites);
-            if (searchResult.warnings?.length) {
-                warnings.push(...searchResult.warnings);
-            }
-        }
-        if (testSuitesNames.length > 0) {
-            for (const directory of packageDirectories.filter((dir) => dir.includes('testSuites'))) {
-                const testNames = await searchDirectoryForTestNamesInTestSuites(directory, packageDirectories);
-                allTestClasses.push(...testNames);
-            }
-        }
-        let finalTestMethods = Array.from(new Set(allTestClasses.map((test) => test.trim())));
-        // If ignore-missing-tests is true, validate the test methods
-        if (ignoreMissingTests) {
-            const { validatedTests, warnings: validationWarnings } = await validateTests(finalTestMethods, packageDirectories);
-            finalTestMethods = validatedTests;
-            if (validationWarnings.length > 0) {
-                warnings.push(...validationWarnings);
-            }
-            if (validatedTests.length === 0) {
-                warnings.push('No test methods declared in your annotations were found in your package directories');
-            }
-        }
-        // Print all collected warnings
-        if (!noWarnings && warnings.length > 0) {
-            warnings.forEach((warning) => {
-                this.warn(warning);
-            });
-        }
-        finalTestMethods.sort((a, b) => a.localeCompare(b));
-        if (finalTestMethods.length === 0) {
-            this.warn('No test methods found');
-            return {
-                tests: [],
-                command: '',
-            };
-        }
-        const result = await formatList(format, finalTestMethods);
+        const result = await listTests({
+            format: flags.format,
+            manifest: flags.manifest,
+            ignoreMissingTests: flags['ignore-missing-tests'],
+            ignoreDirs: flags['ignore-package-directory'],
+            noWarnings: flags['no-warnings'],
+            filterByMetadata: flags['filter-by-metadata'],
+            warn: this.warn.bind(this),
+        });
         this.log(result.command);
         return result;
     }

package/lib/commands/apextests/list.js.map

@@ -1 +1 @@
-{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/commands/apextests/list.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,YAAY,CAAC;AACb,qCAAqC;AAErC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,wCAAwC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,6BAA6B,EAAE,uCAAuC,EAAE,MAAM,0BAA0B,CAAC;AAGlH,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAQzE,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAA8B;IAChE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACpD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YAC5D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;YAC9D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,sBAAsB,EAAE,KAAK,CAAC,OAAO,CAAC;YACpC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oCAAoC,CAAC;YAClE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wCAAwC,CAAC;YAC1E,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;SACf,CAAC;QACF,0BAA0B,EAAE,KAAK,CAAC,SAAS,CAAC;YAC1C,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wCAAwC,CAAC;YACtE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4CAA4C,CAAC;YAC9E,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC;YAC3B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;YACzD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;YACjE,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC;QACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,SAAS,CAAC;QAC7C,MAAM,kBAAkB,GAAG,KAAK,CAAC,sBAAsB,CAAC,IAAI,KAAK,CAAC;QAClE,MAAM,UAAU,GAAG,KAAK,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAC;QAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,gBAAgB,GAAoB,IAAI,CAAC;QAC7C,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,qCAAqC;QACrC,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,gBAAgB,GAAG,MAAM,gCAAgC,CAAC,QAAQ,CAAC,CAAC;YAC1E,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC7F,CAAC;QAED,0DAA0D;QAC1D,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE,CAAC;YAC3C,MAAM,YAAY,GAAiB,MAAM,6BAA6B,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpG,cAAc,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;YAC7C,eAAe,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;YACjD,IAAI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;gBAClC,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,KAAK,MAAM,SAAS,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBACvF,MAAM,SAAS,GAAa,MAAM,uCAAuC,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;gBACzG,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QAED,IAAI,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAEtF,6DAA6D;QAC7D,IAAI,kBAAkB,EAAE,CAAC;YACvB,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,kBAAkB,EAAE,GAAG,MAAM,aAAa,CAC1E,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;YACF,gBAAgB,GAAG,cAAc,CAAC;YAElC,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClC,QAAQ,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC;YACvC,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,QAAQ,CAAC,IAAI,CAAC,qFAAqF,CAAC,CAAC;YACvG,CAAC;QACH,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,UAAU,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAEpD,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACnC,OAAO;gBACL,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,EAAE;aACZ,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAC1D,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC"}
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/commands/apextests/list.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAEzE,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAA8B;IAChE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACpD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YAC5D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;SACd,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;YAC9D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,sBAAsB,EAAE,KAAK,CAAC,OAAO,CAAC;YACpC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oCAAoC,CAAC;YAClE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wCAAwC,CAAC;YAC1E,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,KAAK;SACf,CAAC;QACF,0BAA0B,EAAE,KAAK,CAAC,SAAS,CAAC;YAC1C,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wCAAwC,CAAC;YACtE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4CAA4C,CAAC;YAC9E,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC;YAC3B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;YACzD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC;YACjE,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;QACF,oBAAoB,EAAE,KAAK,CAAC,OAAO,CAAC;YAClC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,kCAAkC,CAAC;YAChE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,sCAAsC,CAAC;YACxE,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAC;IAGK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC;YAC7B,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,kBAAkB,EAAE,KAAK,CAAC,sBAAsB,CAAC;YACjD,UAAU,EAAE,KAAK,CAAC,0BAA0B,CAAC;YAC7C,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;YAChC,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC"}

package/lib/core/listTests.d.ts

@@ -0,0 +1,2 @@
+import { ListTestsOptions, ApextestsListResult } from '../utils/types.js';
+export declare function listTests({ format, manifest, ignoreMissingTests, ignoreDirs, noWarnings, filterByMetadata, warn, }: ListTestsOptions): Promise<ApextestsListResult>;

package/lib/core/listTests.js

@@ -0,0 +1,62 @@
+/* eslint-disable no-await-in-loop */
+import { resolve } from 'node:path';
+import { getPackageDirectories } from '../utils/getPackageDirectories.js';
+import { validateTests } from '../utils/validateTests.js';
+import { extractTypeNamesFromManifestFile } from '../parsers/manifestParser.js';
+import { formatList } from '../utils/formatters.js';
+import { searchDirectoryForTestClasses } from '../readers/directorySearcher.js';
+import { searchDirectoryForTestNamesInTestSuites } from '../readers/testSuiteSearcher.js';
+import { METADATA_FILTER_CONFIG } from '../utils/constants.js';
+import { loadTestMetadataDependencies, selectRelevantTests } from '../parsers/metadataFilterParser.js';
+export async function listTests({ format = 'sf', manifest, ignoreMissingTests = false, ignoreDirs = [], noWarnings = false, filterByMetadata = false, warn = () => { }, }) {
+    let testClassesNames = null;
+    const testSuitesNames = [];
+    const allTestClasses = [];
+    const warnings = [];
+    const { metadataPaths: packageDirectories, repoRoot } = await getPackageDirectories(ignoreDirs);
+    if (manifest) {
+        const manifestMetadata = await extractTypeNamesFromManifestFile(manifest);
+        testClassesNames = manifestMetadata.filter((name) => !name.endsWith('testSuite-meta.xml'));
+        if (filterByMetadata) {
+            const ymlConfigPath = resolve(repoRoot, METADATA_FILTER_CONFIG);
+            const testMap = await loadTestMetadataDependencies(ymlConfigPath);
+            const testsToRun = selectRelevantTests(testMap, manifestMetadata);
+            allTestClasses.push(...testsToRun);
+        }
+    }
+    if (!filterByMetadata) {
+        for (const directory of packageDirectories) {
+            const searchResult = await searchDirectoryForTestClasses(directory, testClassesNames);
+            allTestClasses.push(...searchResult.classes);
+            testSuitesNames.push(...searchResult.testSuites);
+            if (searchResult.warnings?.length) {
+                warnings.push(...searchResult.warnings);
+            }
+        }
+        if (testSuitesNames.length > 0) {
+            for (const directory of packageDirectories.filter((dir) => dir.includes('testSuites'))) {
+                const testNames = await searchDirectoryForTestNamesInTestSuites(directory, packageDirectories);
+                allTestClasses.push(...testNames);
+            }
+        }
+    }
+    let finalTestMethods = Array.from(new Set(allTestClasses.map((test) => test.trim())));
+    if (ignoreMissingTests) {
+        const { validatedTests, warnings: validationWarnings } = await validateTests(finalTestMethods, packageDirectories);
+        finalTestMethods = validatedTests;
+        warnings.push(...validationWarnings);
+    }
+    if (!noWarnings && warnings.length > 0) {
+        warnings.forEach(warn);
+    }
+    finalTestMethods.sort((a, b) => a.localeCompare(b));
+    if (finalTestMethods.length === 0) {
+        warn('No test methods found');
+        return {
+            tests: [],
+            command: '',
+        };
+    }
+    return formatList(format, finalTestMethods);
+}
+//# sourceMappingURL=listTests.js.map

package/lib/core/listTests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listTests.js","sourceRoot":"","sources":["../../src/core/listTests.ts"],"names":[],"mappings":"AAAA,qCAAqC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,uCAAuC,EAAE,MAAM,iCAAiC,CAAC;AAE1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAEvG,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAC9B,MAAM,GAAG,IAAI,EACb,QAAQ,EACR,kBAAkB,GAAG,KAAK,EAC1B,UAAU,GAAG,EAAE,EACf,UAAU,GAAG,KAAK,EAClB,gBAAgB,GAAG,KAAK,EACxB,IAAI,GAAG,GAAS,EAAE,GAAE,CAAC,GACJ;IACjB,IAAI,gBAAgB,GAAoB,IAAI,CAAC;IAC7C,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,MAAM,cAAc,GAAa,EAAE,CAAC;IACpC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,QAAQ,EAAE,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAEhG,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,gBAAgB,GAAG,MAAM,gCAAgC,CAAC,QAAQ,CAAC,CAAC;QAC1E,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC3F,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,MAAM,4BAA4B,CAAC,aAAa,CAAC,CAAC;YAClE,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAClE,cAAc,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,KAAK,MAAM,SAAS,IAAI,kBAAkB,EAAE,CAAC;YAC3C,MAAM,YAAY,GAAiB,MAAM,6BAA6B,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpG,cAAc,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;YAC7C,eAAe,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;YACjD,IAAI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;gBAClC,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,KAAK,MAAM,SAAS,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBACvF,MAAM,SAAS,GAAG,MAAM,uCAAuC,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;gBAC/F,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAEtF,IAAI,kBAAkB,EAAE,CAAC;QACvB,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,kBAAkB,EAAE,GAAG,MAAM,aAAa,CAC1E,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;QACF,gBAAgB,GAAG,cAAc,CAAC;QAClC,QAAQ,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,CAAC,UAAU,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpD,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAC9B,OAAO;YACL,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAC9C,CAAC"}

package/lib/parsers/manifestParser.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Given a certain manifest file, reads that file and returns the classes,
+ * triggers and test suites members with their types as prefix.
+ *
+ * For example, as ApexClass:MyClass.
+ *
+ * @param manifestFile the path to the manifest file
+ * @returns a list of strings with the type and member names
+ */
+export declare function extractTypeNamesFromManifestFile(manifestFile: string): Promise<string[]>;

package/lib/parsers/manifestParser.js

@@ -0,0 +1,25 @@
+'use strict';
+import { existsSync } from 'node:fs';
+import { ComponentSet } from '@salesforce/source-deploy-retrieve';
+/**
+ * Given a certain manifest file, reads that file and returns the classes,
+ * triggers and test suites members with their types as prefix.
+ *
+ * For example, as ApexClass:MyClass.
+ *
+ * @param manifestFile the path to the manifest file
+ * @returns a list of strings with the type and member names
+ */
+export async function extractTypeNamesFromManifestFile(manifestFile) {
+    const result = [];
+    if (!manifestFile || !existsSync(manifestFile)) {
+        return result;
+    }
+    const componentSet = await ComponentSet.fromManifest({ manifestPath: manifestFile });
+    for (const component of componentSet) {
+        const typeName = component.type.name;
+        result.push(`${typeName}:${component.fullName}`);
+    }
+    return result.sort((a, b) => a.localeCompare(b));
+}
+//# sourceMappingURL=manifestParser.js.map

package/lib/parsers/manifestParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifestParser.js","sourceRoot":"","sources":["../../src/parsers/manifestParser.ts"],"names":[],"mappings":"AACA,YAAY,CAAC;AAEb,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,YAAY,EAAG,MAAM,oCAAoC,CAAC;AAEnE;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gCAAgC,CAAC,YAAoB;IACzE,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,CAAC,YAAY,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,YAAY,GAAiB,MAAM,YAAY,CAAC,YAAY,CAAC,EAAC,YAAY,EAAE,YAAY,EAAC,CAAC,CAAC;IACjG,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC"}

package/lib/parsers/metadataFilterParser.d.ts

@@ -0,0 +1,9 @@
+import { TestMetadataMap } from '../utils/types.js';
+/**
+ * Loads the test metadata filter YAML file and confirms it matches the expected structure.
+ */
+export declare function loadTestMetadataDependencies(configPath: string): Promise<TestMetadataMap>;
+/**
+ * Return test classes that depend on any of the changed metadata.
+ */
+export declare function selectRelevantTests(testMap: TestMetadataMap, changedMetadata: string[]): string[];

package/lib/parsers/metadataFilterParser.js

@@ -0,0 +1,50 @@
+import { readFile } from 'node:fs/promises';
+import { parse } from 'yaml';
+/**
+ * Verifies structure matches the test metadata map type.
+ */
+function isTestMetadataMap(obj) {
+    if (typeof obj !== 'object' || obj === null)
+        return false;
+    return Object.entries(obj).every(([key, value]) => typeof key === 'string' &&
+        Array.isArray(value) &&
+        value.every(v => typeof v === 'string'));
+}
+/**
+ * Loads the test metadata filter YAML file and confirms it matches the expected structure.
+ */
+export async function loadTestMetadataDependencies(configPath) {
+    const content = await readFile(configPath, 'utf-8');
+    const parsed = parse(content);
+    if (isTestMetadataMap(parsed)) {
+        return parsed;
+    }
+    throw new Error('Invalid test metadata dependencies format in YAML');
+}
+/**
+ * Compare two metadata strings like "CustomField:Account__c.Name"
+ * against patterns with wildcards, like "CustomField:Account__c.*"
+ */
+function matchesDependency(dependency, changed) {
+    if (dependency.includes('*')) {
+        const pattern = dependency
+            .replace('.', '\\.')
+            .replace('*', '.*');
+        return new RegExp(`^${pattern}$`).test(changed);
+    }
+    return dependency === changed;
+}
+/**
+ * Return test classes that depend on any of the changed metadata.
+ */
+export function selectRelevantTests(testMap, changedMetadata) {
+    const selected = [];
+    for (const [testClass, dependencies] of Object.entries(testMap)) {
+        const matches = changedMetadata.some(changed => dependencies.some(dep => matchesDependency(dep, changed)));
+        if (matches) {
+            selected.push(testClass);
+        }
+    }
+    return selected;
+}
+//# sourceMappingURL=metadataFilterParser.js.map

package/lib/parsers/metadataFilterParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadataFilterParser.js","sourceRoot":"","sources":["../../src/parsers/metadataFilterParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAI7B;;GAEG;AACH,SAAS,iBAAiB,CAAC,GAAY;IACnC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAE1D,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAC9C,OAAO,GAAG,KAAK,QAAQ;QACvB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAC1C,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,UAAkB;IACjE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,MAAM,GAAY,KAAK,CAAC,OAAO,CAAC,CAAC;IAEvC,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,UAAkB,EAAE,OAAe;IAC1D,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,UAAU;aACrB,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC;aACnB,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,UAAU,KAAK,OAAO,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAC/B,OAAwB,EACxB,eAAyB;IAEzB,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9D,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAC3C,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAC5D,CAAC;QACF,IAAI,OAAO,EAAE,CAAC;YACV,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC"}

package/lib/parsers/testNameParser.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Parses the line in an Apex file that contains the test names.
+ *
+ * @param testNames names of the tests in an Apex file line
+ * @returns list of the test classes
+ */
+export declare function parseTestsNames(testNames: string[] | null): string[];

package/lib/parsers/testNameParser.js

@@ -0,0 +1,19 @@
+/**
+ * Parses the line in an Apex file that contains the test names.
+ *
+ * @param testNames names of the tests in an Apex file line
+ * @returns list of the test classes
+ */
+export function parseTestsNames(testNames) {
+    if (!testNames || testNames.length === 0) {
+        return [];
+    }
+    // remove the prefix @Tests
+    return testNames
+        .join(' ')
+        .replace(/(@tests\s*:\s*)/gi, '')
+        .replace(/[,\s]+/g, ' ')
+        .trim()
+        .split(' ');
+}
+//# sourceMappingURL=testNameParser.js.map

package/lib/parsers/testNameParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testNameParser.js","sourceRoot":"","sources":["../../src/parsers/testNameParser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,SAA0B;IACxD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,2BAA2B;IAC3B,OAAO,SAAS;SACb,IAAI,CAAC,GAAG,CAAC;SACT,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;SAChC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,IAAI,EAAE;SACN,KAAK,CAAC,GAAG,CAAC,CAAC;AAChB,CAAC"}

package/lib/parsers/testSuiteParser.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Analyzes the content of a test suite xml file and returns the Apex classes
+ * included in it.
+ *
+ * @param data string with the content of the test suite xml file
+ * @returns a list of test classes names in the test suite
+ */
+export declare function parseTestSuiteFile(data: string): string[];
+/**
+ * Parses the line in an Apex file that contains the test suites names.
+ *
+ * @param testNames names of the test suites in an Apex file line
+ * @returns list of the test suites
+ */
+export declare function parseTestSuitesNames(testSuitesNames: string[] | null): string[];

package/lib/parsers/testSuiteParser.js

@@ -0,0 +1,40 @@
+'use strict';
+import { Parser } from 'xml2js';
+/**
+ * Analyzes the content of a test suite xml file and returns the Apex classes
+ * included in it.
+ *
+ * @param data string with the content of the test suite xml file
+ * @returns a list of test classes names in the test suite
+ */
+export function parseTestSuiteFile(data) {
+    const result = [];
+    new Parser().parseString(data, (error, parsed) => {
+        if (error) {
+            throw error;
+        }
+        parsed.ApexTestSuite.testClassName.forEach((testSuite) => {
+            result.push(testSuite);
+        });
+    });
+    return result.sort();
+}
+/**
+ * Parses the line in an Apex file that contains the test suites names.
+ *
+ * @param testNames names of the test suites in an Apex file line
+ * @returns list of the test suites
+ */
+export function parseTestSuitesNames(testSuitesNames) {
+    if (!testSuitesNames || testSuitesNames.length === 0) {
+        return [];
+    }
+    // remove the prefix @testsuites
+    return testSuitesNames
+        .join(' ')
+        .replace(/(@testsuites\s*:\s*)/gi, '')
+        .replace(/[,\s]+/g, ' ')
+        .trim()
+        .split(' ');
+}
+//# sourceMappingURL=testSuiteParser.js.map

package/lib/parsers/testSuiteParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testSuiteParser.js","sourceRoot":"","sources":["../../src/parsers/testSuiteParser.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,MAAsD,EAAE,EAAE;QAC/F,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,KAAK,CAAC;QACd,CAAC;QACD,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACvD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,eAAgC;IACnE,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,gCAAgC;IAChC,OAAO,eAAe;SACnB,IAAI,CAAC,GAAG,CAAC;SACT,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC;SACrC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,IAAI,EAAE;SACN,KAAK,CAAC,GAAG,CAAC,CAAC;AAChB,CAAC"}

package/lib/readers/directorySearcher.d.ts

@@ -0,0 +1,10 @@
+import { SearchResult } from '../utils/types.js';
+/**
+ * Given a certain directory, search its contents for files that end with '.cls' or '.trigger'.
+ * Extracts the test names from the annotations on those files, and returns a list with those.
+ *
+ * @param directory directory within the project to search for files
+ * @param names names of test files
+ * @returns list of test classes
+ */
+export declare function searchDirectoryForTestClasses(directory: string, names: string[] | null): Promise<SearchResult>;

package/lib/readers/directorySearcher.js

@@ -0,0 +1,82 @@
+'use strict';
+import { readdirSync, readFileSync } from 'node:fs';
+import { queue } from 'async';
+import { parseTestSuitesNames } from '../parsers/testSuiteParser.js';
+import { parseTestsNames } from '../parsers/testNameParser.js';
+import { TEST_CLASS_ANNOTATION_REGEX, TEST_NAME_REGEX, TEST_SUITE_NAME_REGEX } from '../utils/constants.js';
+import { getConcurrencyThreshold } from '../utils/concurrencyThreshold.js';
+/**
+ * Given a certain directory, search its contents for files that end with '.cls' or '.trigger'.
+ * Extracts the test names from the annotations on those files, and returns a list with those.
+ *
+ * @param directory directory within the project to search for files
+ * @param names names of test files
+ * @returns list of test classes
+ */
+export async function searchDirectoryForTestClasses(directory, names) {
+    const testClassesNames = new Set();
+    const testSuitesNames = new Set();
+    const warnings = [];
+    let readDir;
+    try {
+        readDir = readdirSync(directory, { recursive: true });
+    }
+    catch (error) {
+        throw new Error(`Invalid or inaccessible directory: ${directory}`);
+    }
+    // Gets the list of Apex files (classes and triggers)
+    const apexFiles = readDir.filter((file) => {
+        if (!file.endsWith('.cls') && !file.endsWith('.trigger')) {
+            return false;
+        }
+        const fileFullName = file.split('/').pop()?.split('.');
+        if (!names) {
+            return true;
+        }
+        if (fileFullName && fileFullName.length > 0) {
+            const formattedName = `${fileFullName[1] === 'cls' ? 'ApexClass' : 'ApexTrigger'}:${fileFullName[0]}`;
+            return names.includes(formattedName);
+        }
+    });
+    const testClassNameHandler = (fileName) => {
+        const path = `${directory}/${fileName}`;
+        const data = readFileSync(path, 'utf-8');
+        const testNameMatches = Array.from(data.matchAll(TEST_NAME_REGEX));
+        const testSuiteMatches = Array.from(data.matchAll(TEST_SUITE_NAME_REGEX));
+        const testClassAnnotationMatches = data.match(TEST_CLASS_ANNOTATION_REGEX);
+        let hasAnnotation = false;
+        if (testNameMatches.length > 0) {
+            hasAnnotation = true;
+            for (const match of testNameMatches) {
+                parseTestsNames(match).forEach((testMethod) => testClassesNames.add(testMethod));
+            }
+        }
+        if (testSuiteMatches.length > 0) {
+            hasAnnotation = true;
+            for (const match of testSuiteMatches) {
+                parseTestSuitesNames(match).forEach((testMethod) => testSuitesNames.add(testMethod));
+            }
+        }
+        if (testClassAnnotationMatches && testClassAnnotationMatches.length > 0) {
+            hasAnnotation = true;
+            testClassesNames.add(fileName.split('.').shift());
+        }
+        if (!hasAnnotation) {
+            warnings.push(`File "${fileName}" does not contain @tests, @testsuites, or @istest annotations`);
+        }
+    };
+    const testClassNameProcessor = queue((f, cb) => {
+        testClassNameHandler(f);
+        cb();
+    }, getConcurrencyThreshold());
+    await testClassNameProcessor.push(apexFiles);
+    if (testClassNameProcessor.length() > 0) {
+        await testClassNameProcessor.drain();
+    }
+    return {
+        classes: Array.from(testClassesNames),
+        testSuites: Array.from(testSuitesNames),
+        warnings,
+    };
+}
+//# sourceMappingURL=directorySearcher.js.map

package/lib/readers/directorySearcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directorySearcher.js","sourceRoot":"","sources":["../../src/readers/directorySearcher.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAAE,2BAA2B,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC5G,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAE3E;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,SAAiB,EAAE,KAAsB;IAC3F,MAAM,gBAAgB,GAAgB,IAAI,GAAG,EAAU,CAAC;IACxD,MAAM,eAAe,GAAgB,IAAI,GAAG,EAAU,CAAC;IACvD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,OAAO,GAAG,WAAW,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAa,CAAC;IACpE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,sCAAsC,SAAS,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,qDAAqD;IACrD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACxC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACzD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,YAAY,GAAyB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7E,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,aAAa,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YACtG,OAAO,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACvC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAQ,EAAE;QACtD,MAAM,IAAI,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;QACnE,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAC1E,MAAM,0BAA0B,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAE3E,IAAI,aAAa,GAAG,KAAK,CAAC;QAE1B,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,aAAa,GAAG,IAAI,CAAC;YACrB,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;gBACpC,eAAe,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;QAED,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,aAAa,GAAG,IAAI,CAAC;YACrB,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE,CAAC;gBACrC,oBAAoB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;QAED,IAAI,0BAA0B,IAAI,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,aAAa,GAAG,IAAI,CAAC;YACrB,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAY,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,QAAQ,CAAC,IAAI,CAAC,SAAS,QAAQ,gEAAgE,CAAC,CAAC;QACnG,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,sBAAsB,GAAG,KAAK,CAAC,CAAC,CAAS,EAAE,EAAuC,EAAE,EAAE;QAC1F,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACxB,EAAE,EAAE,CAAC;IACP,CAAC,EAAE,uBAAuB,EAAE,CAAC,CAAC;IAE9B,MAAM,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAE7C,IAAI,sBAAsB,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,sBAAsB,CAAC,KAAK,EAAE,CAAC;IACvC,CAAC;IAED,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACrC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;QACvC,QAAQ;KACT,CAAC;AACJ,CAAC"}