apex-mutation-testing 1.0.0-dev-6.13527894120-1

package/lib/service/mutationTestingService.js

@@ -0,0 +1,113 @@
+import { ApexClassRepository } from '../adapter/apexClassRepository.js';
+import { ApexTestRunner } from '../adapter/apexTestRunner.js';
+import { MutantGenerator } from './mutantGenerator.js';
+export class MutationTestingService {
+    progress;
+    spinner;
+    connection;
+    apexClassName;
+    apexClassTestName;
+    constructor(progress, spinner, connection, { apexClassName, apexClassTestName, }) {
+        this.progress = progress;
+        this.spinner = spinner;
+        this.connection = connection;
+        this.apexClassName = apexClassName;
+        this.apexClassTestName = apexClassTestName;
+    }
+    async process() {
+        const apexClassRepository = new ApexClassRepository(this.connection);
+        const apexTestRunner = new ApexTestRunner(this.connection);
+        this.spinner.start(`Fetching "${this.apexClassName}" ApexClass content`, undefined, {
+            stdout: true,
+        });
+        const apexClass = (await apexClassRepository.read(this.apexClassName));
+        this.spinner.stop('Done');
+        this.spinner.start(`Generating mutants for "${this.apexClassName}" ApexClass`, undefined, {
+            stdout: true,
+        });
+        const mutantGenerator = new MutantGenerator();
+        const mutations = mutantGenerator.compute(apexClass.Body);
+        const mutationResults = {
+            sourceFile: this.apexClassName,
+            sourceFileContent: apexClass.Body,
+            testFile: this.apexClassTestName,
+            mutants: [],
+        };
+        this.spinner.stop(`${mutations.length} mutations generated`);
+        this.progress.start(mutations.length, { info: 'Starting mutation testing' }, {
+            title: 'MUTATION TESTING PROGRESS',
+            format: '%s | {bar} | {value}/{total} {info}',
+        });
+        let mutationCount = 0;
+        for (const mutation of mutations) {
+            const mutatedVersion = mutantGenerator.mutate(mutation);
+            this.progress.update(mutationCount, {
+                info: `Deploying "${mutation.replacement}" mutation at line ${mutation.token.symbol.line}`,
+            });
+            let progressMessage;
+            try {
+                await apexClassRepository.update({
+                    Id: apexClass.Id,
+                    Body: mutatedVersion,
+                });
+                this.progress.update(mutationCount, {
+                    info: `Running tests for "${mutation.replacement}" mutation at line ${mutation.token.symbol.line}`,
+                });
+                const testResult = await apexTestRunner.run(this.apexClassTestName);
+                const mutantResult = this.buildMutantResult(mutation, testResult);
+                mutationResults.mutants.push(mutantResult);
+                progressMessage = `Mutation result: ${testResult.summary.outcome === 'Pass' ? 'zombie' : 'mutant killed'}`;
+            }
+            catch {
+                progressMessage = `Issue while computing "${mutation.replacement}" mutation at line ${mutation.token.symbol.line}`;
+            }
+            ++mutationCount;
+            this.progress.update(mutationCount, {
+                info: progressMessage,
+            });
+        }
+        this.progress.finish({
+            info: `All mutations evaluated`,
+        });
+        try {
+            this.spinner.start(`Rolling back "${this.apexClassName}" ApexClass to its original state`, undefined, {
+                stdout: true,
+            });
+            await apexClassRepository.update(apexClass);
+            this.spinner.stop('Done');
+        }
+        catch {
+            this.spinner.stop('Class not rolled back, please do it manually');
+        }
+        return mutationResults;
+    }
+    calculateScore(mutationResult) {
+        return ((mutationResult.mutants.filter(mutant => mutant.status === 'Killed')
+            .length /
+            mutationResult.mutants.length) *
+            100 || 0);
+    }
+    buildMutantResult(mutation, testResult) {
+        const token = mutation.token;
+        // TODO Handle NoCoverage
+        const mutationStatus = testResult.summary.outcome === 'Pass' ? 'Survived' : 'Killed';
+        return {
+            id: `${this.apexClassName}-${token.symbol.line}-${token.symbol.charPositionInLine}-${token.symbol.tokenIndex}-${Date.now()}`,
+            mutatorName: mutation.mutationName,
+            status: mutationStatus,
+            location: {
+                start: {
+                    line: token.symbol.line,
+                    column: token.symbol.charPositionInLine,
+                },
+                end: {
+                    line: token.symbol.line,
+                    column: token.symbol.charPositionInLine + mutation.replacement.length,
+                },
+            },
+            replacement: mutation.replacement,
+            original: token.text,
+        };
+    }
+}
+//# sourceMappingURL=mutationTestingService.js.map

package/lib/service/mutationTestingService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutationTestingService.js","sourceRoot":"","sources":["../../src/service/mutationTestingService.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAI7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,OAAO,sBAAsB;IAKZ;IACA;IACA;IANF,aAAa,CAAQ;IACrB,iBAAiB,CAAQ;IAE5C,YACqB,QAAkB,EAClB,OAAgB,EAChB,UAAsB,EACzC,EACE,aAAa,EACb,iBAAiB,GACoC;QANpC,aAAQ,GAAR,QAAQ,CAAU;QAClB,YAAO,GAAP,OAAO,CAAS;QAChB,eAAU,GAAV,UAAU,CAAY;QAMzC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACpE,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAE1D,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,aAAa,IAAI,CAAC,aAAa,qBAAqB,EACpD,SAAS,EACT;YACE,MAAM,EAAE,IAAI;SACb,CACF,CAAA;QACD,MAAM,SAAS,GAAc,CAAC,MAAM,mBAAmB,CAAC,IAAI,CAC1D,IAAI,CAAC,aAAa,CACnB,CAAyB,CAAA;QAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEzB,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,2BAA2B,IAAI,CAAC,aAAa,aAAa,EAC1D,SAAS,EACT;YACE,MAAM,EAAE,IAAI;SACb,CACF,CAAA;QACD,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACzD,MAAM,eAAe,GAA2B;YAC9C,UAAU,EAAE,IAAI,CAAC,aAAa;YAC9B,iBAAiB,EAAE,SAAS,CAAC,IAAI;YACjC,QAAQ,EAAE,IAAI,CAAC,iBAAiB;YAChC,OAAO,EAAE,EAAE;SACZ,CAAA;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,sBAAsB,CAAC,CAAA;QAE5D,IAAI,CAAC,QAAQ,CAAC,KAAK,CACjB,SAAS,CAAC,MAAM,EAChB,EAAE,IAAI,EAAE,2BAA2B,EAAE,EACrC;YACE,KAAK,EAAE,2BAA2B;YAClC,MAAM,EAAE,qCAAqC;SAC9C,CACF,CAAA;QAED,IAAI,aAAa,GAAG,CAAC,CAAA;QACrB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAEvD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE;gBAClC,IAAI,EAAE,cAAc,QAAQ,CAAC,WAAW,sBAAsB,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE;aAC3F,CAAC,CAAA;YAEF,IAAI,eAAe,CAAA;YACnB,IAAI,CAAC;gBACH,MAAM,mBAAmB,CAAC,MAAM,CAAC;oBAC/B,EAAE,EAAE,SAAS,CAAC,EAAY;oBAC1B,IAAI,EAAE,cAAc;iBACrB,CAAC,CAAA;gBAEF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE;oBAClC,IAAI,EAAE,sBAAsB,QAAQ,CAAC,WAAW,sBAAsB,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE;iBACnG,CAAC,CAAA;gBACF,MAAM,UAAU,GAAe,MAAM,cAAc,CAAC,GAAG,CACrD,IAAI,CAAC,iBAAiB,CACvB,CAAA;gBAED,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;gBACjE,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;gBAE1C,eAAe,GAAG,oBAAoB,UAAU,CAAC,OAAO,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;YAC5G,CAAC;YAAC,MAAM,CAAC;gBACP,eAAe,GAAG,0BAA0B,QAAQ,CAAC,WAAW,sBAAsB,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;YACpH,CAAC;YACD,EAAE,aAAa,CAAA;YACf,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE;gBAClC,IAAI,EAAE,eAAe;aACtB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACnB,IAAI,EAAE,yBAAyB;SAChC,CAAC,CAAA;QAEF,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,iBAAiB,IAAI,CAAC,aAAa,mCAAmC,EACtE,SAAS,EACT;gBACE,MAAM,EAAE,IAAI;aACb,CACF,CAAA;YACD,MAAM,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;YAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAA;QACnE,CAAC;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;IAEM,cAAc,CAAC,cAAsC;QAC1D,OAAO,CACL,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC;aACjE,MAAM;YACP,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC;YAC9B,GAAG,IAAI,CAAC,CACX,CAAA;IACH,CAAC;IAEO,iBAAiB,CAAC,QAAsB,EAAE,UAAsB;QACtE,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;QAC5B,yBAAyB;QACzB,MAAM,cAAc,GAClB,UAAU,CAAC,OAAO,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAA;QAE/D,OAAO;YACL,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,kBAAkB,IAAI,KAAK,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE;YAC5H,WAAW,EAAE,QAAQ,CAAC,YAAY;YAClC,MAAM,EAAE,cAAc;YACtB,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;oBACvB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,kBAAkB;iBACxC;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;oBACvB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,kBAAkB,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM;iBACtE;aACF;YACD,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,QAAQ,EAAE,KAAK,CAAC,IAAI;SACrB,CAAA;IACH,CAAC;CACF"}

package/lib/type/ApexClass.d.ts

@@ -0,0 +1,4 @@
+export interface ApexClass {
+    Id: string;
+    Body: string;
+}

package/lib/type/ApexClass.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ApexClass.js.map

package/lib/type/ApexClass.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApexClass.js","sourceRoot":"","sources":["../../src/type/ApexClass.ts"],"names":[],"mappings":""}

package/lib/type/ApexMutation.d.ts

@@ -0,0 +1,6 @@
+import { TerminalNode } from 'antlr4ts/tree';
+export interface ApexMutation {
+    mutationName: string;
+    token: TerminalNode;
+    replacement: string;
+}

package/lib/type/ApexMutation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ApexMutation.js.map

package/lib/type/ApexMutation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApexMutation.js","sourceRoot":"","sources":["../../src/type/ApexMutation.ts"],"names":[],"mappings":""}

package/lib/type/ApexMutationTestResult.d.ts

@@ -0,0 +1,22 @@
+export interface ApexMutationTestResult {
+    sourceFile: string;
+    sourceFileContent: string;
+    testFile: string;
+    mutants: {
+        id: string;
+        mutatorName: string;
+        status: 'Killed' | 'Survived' | 'NoCoverage';
+        location: {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        };
+        replacement: string;
+        original: string;
+    }[];
+}

package/lib/type/ApexMutationTestResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ApexMutationTestResult.js.map

package/lib/type/ApexMutationTestResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApexMutationTestResult.js","sourceRoot":"","sources":["../../src/type/ApexMutationTestResult.ts"],"names":[],"mappings":""}

package/messages/apex.mutation.test.run.md

@@ -0,0 +1,49 @@
+# summary
+
+Evaluate test coverage quality by injecting mutations and measuring test detection rates
+
+# description
+
+The Apex Mutation Testing plugin helps evaluate the effectiveness of your Apex test classes by introducing mutations into your code and checking if your tests can detect these changes:
+
+The plugin provides insights into how trustworthy your test suite is by measuring its ability to catch intentional code changes.
+
+# flags.apex-class.summary
+
+Apex class name to mutate
+
+# flags.test-class.summary
+
+Apex test class name to validate mutations
+
+# flags.report-dir.summary
+
+Path to the directory where mutation test reports will be generated
+
+# examples
+
+- Run mutation testing on a class with its test file:
+
+  <%= config.bin %> <%= command.id %> --class-file MyClass --test-file MyClassTest
+
+# info.reportGenerated
+
+Report has been generated at this location: %s
+
+# info.CommandIsRunning
+
+Running mutation testing for "%s" with "%s" test class
+
+# info.CommandSuccess
+
+Mutation score: %s%
+
+# info.CommandFailure
+
+Failure
+
+# info.EncourageSponsorship
+
+💡 Enjoying apex-mutation-testing?
+Your contribution helps us provide fast support 🚀 and high quality features 🔥
+Become a sponsor: https://github.com/sponsors/scolladon 💙