feat(api): add id to Mutant interface (#2255)

Add `id` property to `Mutant` api
stryker-mutator · Jun 11, 2020 · cfc9053 · cfc9053
1 parent d330af9
commit cfc9053
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 16 deletions.
diff --git a/packages/api/src/core/Mutant.ts b/packages/api/src/core/Mutant.ts
@@ -1,6 +1,7 @@
 import { Range } from '../../core';
 
 interface Mutant {
+  id: number;
   mutatorName: string;
   fileName: string;
   range: Range;

diff --git a/packages/core/test/unit/mutants/MutantTestMatcher.spec.ts b/packages/core/test/unit/mutants/MutantTestMatcher.spec.ts
@@ -3,7 +3,7 @@ import { MatchedMutant } from '@stryker-mutator/api/report';
 import { TestSelection } from '@stryker-mutator/api/test_framework';
 import { CoverageCollection, CoveragePerTestResult, RunStatus, TestResult, TestStatus } from '@stryker-mutator/api/test_runner';
 import { testInjector } from '@stryker-mutator/test-helpers';
-import { mutant, testResult } from '@stryker-mutator/test-helpers/src/factory';
+import { factory } from '@stryker-mutator/test-helpers';
 import { expect } from 'chai';
 import * as sinon from 'sinon';
 
@@ -57,21 +57,21 @@ describe(MutantTestMatcher.name, () => {
         let testResultTwo: TestResult;
 
         beforeEach(() => {
-          mutantOne = {
+          mutantOne = factory.mutant({
             fileName: 'fileWithMutantOne',
             mutatorName: 'myMutator',
             range: [9, 9], // line 4:5 -> line 4:5
             replacement: '>',
             // location: { start: { line: 4, column: 5 }, end: { line: 4, column: 5 } },
-          };
+          });
 
-          mutantTwo = {
+          mutantTwo = factory.mutant({
             fileName: 'fileWithMutantTwo',
             mutatorName: 'myMutator',
             range: [9, 9], // line 9:0 -> line 9:0
             replacement: '<',
             // location: { start: { line: 9, column: 0 }, end: { line: 9, column: 0 } },
-          };
+          });
 
           testResultOne = {
             name: 'test one',
@@ -332,7 +332,7 @@ describe(MutantTestMatcher.name, () => {
         sourceFile.getLocation = () => ({ start: { line: 13, column: 38 }, end: { line: 24, column: 5 } });
         const testableMutant = new TestableMutant(
           '1',
-          mutant({
+          factory.mutant({
             fileName: 'juice-shop\\app\\js\\controllers\\SearchResultController.js',
           }),
           sourceFile
@@ -455,8 +455,8 @@ describe(MutantTestMatcher.name, () => {
     });
 
     it('should match all mutants to all tests and log a warning when there is no coverage data', async () => {
-      mutants.push(mutant({ fileName: 'fileWithMutantOne' }), mutant({ fileName: 'fileWithMutantTwo' }));
-      initialRunResult.runResult.tests.push(testResult(), testResult());
+      mutants.push(factory.mutant({ fileName: 'fileWithMutantOne' }), factory.mutant({ fileName: 'fileWithMutantTwo' }));
+      initialRunResult.runResult.tests.push(factory.testResult(), factory.testResult());
 
       const result = await sut.matchWithMutants(mutants);
 
@@ -485,7 +485,7 @@ describe(MutantTestMatcher.name, () => {
 
       it('should retrieves source mapped location', async () => {
         // Arrange
-        mutants.push(mutant({ fileName: 'fileWithMutantOne', range: [4, 5] }));
+        mutants.push(factory.mutant({ fileName: 'fileWithMutantOne', range: [4, 5] }));
 
         // Act
         await sut.matchWithMutants(mutants);
@@ -503,8 +503,8 @@ describe(MutantTestMatcher.name, () => {
 
       it('should match mutant to single test result', async () => {
         // Arrange
-        mutants.push(mutant({ fileName: 'fileWithMutantOne', range: [4, 5] }));
-        initialRunResult.runResult.tests.push(testResult({ name: 'test 1' }), testResult({ name: 'test 2' }));
+        mutants.push(factory.mutant({ fileName: 'fileWithMutantOne', range: [4, 5] }));
+        initialRunResult.runResult.tests.push(factory.testResult({ name: 'test 1' }), factory.testResult({ name: 'test 2' }));
 
         // Act
         const result = await sut.matchWithMutants(mutants);
@@ -533,8 +533,8 @@ describe(MutantTestMatcher.name, () => {
     });
 
     it('should match all mutants to all tests', async () => {
-      mutants.push(mutant({ fileName: 'fileWithMutantOne' }), mutant({ fileName: 'fileWithMutantTwo' }));
-      initialRunResult.runResult.tests.push(testResult(), testResult());
+      mutants.push(factory.mutant({ fileName: 'fileWithMutantOne' }), factory.mutant({ fileName: 'fileWithMutantTwo' }));
+      initialRunResult.runResult.tests.push(factory.testResult(), factory.testResult());
 
       const result = await sut.matchWithMutants(mutants);
 

diff --git a/packages/javascript-mutator/src/JavaScriptMutator.ts b/packages/javascript-mutator/src/JavaScriptMutator.ts
@@ -28,6 +28,7 @@ export class JavaScriptMutator implements Mutator {
               const replacement = types.isNode(mutation) ? this.parser.generateCode(mutation) : mutation.raw;
 
               mutants.push({
+                id: 42, // TODO this code will be removed in #1514. Temp fill it with a string.
                 fileName: fileName,
                 mutatorName: mutatorName,
                 range: [original.start, original.end],

diff --git a/packages/javascript-mutator/test/unit/JavaScriptMutator.spec.ts b/packages/javascript-mutator/test/unit/JavaScriptMutator.spec.ts
@@ -30,6 +30,7 @@ describe('JavaScriptMutator', () => {
 
     expect(mutants.length).to.equal(1);
     expect(mutants[0]).to.deep.equal({
+      id: 42,
       fileName: files[0].name,
       mutatorName: 'ArithmeticOperator',
       range: [22, 27],
@@ -65,6 +66,7 @@ describe('JavaScriptMutator', () => {
 
     expect(mutants.length).to.equal(6);
     expect(mutants).to.deep.include({
+      id: 42,
       fileName: 'testFile.jsx',
       mutatorName: 'ConditionalExpression',
       range: [197, 202],
@@ -128,6 +130,7 @@ describe('JavaScriptMutator', () => {
 
     expect(mutants.length).to.equal(6);
     expect(mutants).to.deep.include({
+      id: 42,
       fileName: 'testFile.js',
       mutatorName: 'ConditionalExpression',
       range: [121, 128],

diff --git a/packages/test-helpers/src/factory.ts b/packages/test-helpers/src/factory.ts
@@ -105,6 +105,7 @@ export const mutationTestReportSchemaMutationTestResult = factoryMethod<mutation
 }));
 
 export const mutant = factoryMethod<Mutant>(() => ({
+  id: 42,
   fileName: 'file',
   mutatorName: 'foobarMutator',
   range: [0, 0],
@@ -172,6 +173,16 @@ export const testResult = factoryMethod<TestResult>(() => ({
   timeSpentMs: 10,
 }));
 
+export const testSelection = factoryMethod<TestSelection>(() => ({
+  id: 23,
+  name: 'foo should bar',
+}));
+
+export const mutantRunOptions = factoryMethod<{ activeMutant: Mutant; timeout: number }>(() => ({
+  activeMutant: mutant(),
+  timeout: 2000,
+}));
+
 export const runResult = factoryMethod<RunResult>(() => ({
   status: RunStatus.Complete,
   tests: [testResult()],

diff --git a/packages/typescript/src/mutator/NodeMutator.ts b/packages/typescript/src/mutator/NodeMutator.ts
@@ -20,6 +20,7 @@ export default abstract class NodeMutator<T extends ts.Node = ts.Node> {
 
   private createMutant(original: ts.Node, replacement: string, sourceFile: ts.SourceFile): Mutant {
     return {
+      id: 42, // TODO this code will be removed in #1514. Temp fill it with a string.
       fileName: sourceFile.fileName.replace(/\//g, path.sep),
       mutatorName: this.name,
       range: [original.getStart(sourceFile), original.getEnd()],

diff --git a/packages/typescript/test/unit/TypescriptMutator.spec.ts b/packages/typescript/test/unit/TypescriptMutator.spec.ts
@@ -99,18 +99,21 @@ describe('TypescriptMutator', () => {
         // Assert
         expect(mutants).to.deep.equal([
           {
+            id: 42,
             fileName: 'file1.ts',
             mutatorName: 'SourceFileForTest',
             range: [0, 39],
             replacement: '"stryker was here"',
           },
           {
+            id: 42,
             fileName: 'file1.ts',
             mutatorName: 'FunctionDeclarationForTest',
             range: [0, 39],
             replacement: '// Function declaration removed',
           },
           {
+            id: 42,
             fileName: 'file1.ts',
             mutatorName: 'FunctionDeclarationForTest',
             range: [0, 39],
@@ -129,6 +132,7 @@ describe('TypescriptMutator', () => {
         // Assert
         expect(mutants).to.deep.equal([
           {
+            id: 42,
             fileName: 'file1.ts',
             mutatorName: 'SourceFileForTest',
             range: [0, 50],
@@ -153,6 +157,7 @@ describe('TypescriptMutator', () => {
         // Assert
         expect(mutants).to.deep.equal([
           {
+            id: 42,
             fileName: 'file1.ts',
             mutatorName: 'SourceFileForTest',
             range: [0, 85],

diff --git a/packages/vue-mutator/test/unit/VueMutator.spec.ts b/packages/vue-mutator/test/unit/VueMutator.spec.ts
@@ -1,6 +1,6 @@
 import { Mutant, File } from '@stryker-mutator/api/core';
 import { Mutator } from '@stryker-mutator/api/mutant';
-import { testInjector } from '@stryker-mutator/test-helpers';
+import { testInjector, factory } from '@stryker-mutator/test-helpers';
 import { expect } from 'chai';
 import { SinonStubbedInstance } from 'sinon';
 import * as sinon from 'sinon';
@@ -347,12 +347,12 @@ describe('VueMutator', () => {
     <script>${script}</script>`
     );
     const files = [vueFile];
-    const jsMutant: Mutant = {
+    const jsMutant: Mutant = factory.mutant({
       fileName: `${vueFile.name}.js`,
       mutatorName: 'StringLiteral',
       range: [script.indexOf(codeToMutate), script.indexOf(codeToMutate) + codeToMutate.length],
       replacement: '',
-    };
+    });
     stubJavaScriptMutator.mutate.returns([jsMutant]);
     const sut = createSut();