Feat(config): Add 'always' option to cleanTempDir #4187
Merged
+48
−15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added 'always' option to cleanTempDir Always remove stryker-tmp folder, even if stryker is failing
nicojs
requested changes
May 15, 2023
nicojs
requested changes
May 20, 2023
| @@ -17,7 +17,7 @@ export class TemporaryDirectory implements Disposable { | |||
| public static readonly inject = tokens(commonTokens.logger, commonTokens.options); | |||
| constructor(private readonly log: Logger, options: StrykerOptions) { | |||
| this.temporaryDirectory = path.resolve(options.tempDirName); | |||
| this.removeDuringDisposal = options.cleanTempDir; | |||
| this.removeDuringDisposal = typeof options.cleanTempDir === 'boolean' ? options.cleanTempDir : options.cleanTempDir == 'always' ? true : false; | |||
There was a problem hiding this comment.
Suggested change
| this.removeDuringDisposal = typeof options.cleanTempDir === 'boolean' ? options.cleanTempDir : options.cleanTempDir == 'always' ? true : false; | |
| this.removeDuringDisposal = Boolean(options.cleanTempDir) |
This should work here, right? Seems a lot simpler.
Comment on lines
203
to
249
| }); | ||
|
|
||
| describe('runMutationTest()', () => { | ||
| beforeEach(() => { | ||
| injectorMock = factory.injector(); | ||
| loggerMock = factory.logger(); | ||
| strOptions = factory.strykerOptions({ cleanTempDir: 'always' }); | ||
| getLoggerStub = sinon.stub(); | ||
| mutantResults = []; | ||
| temporaryDirectoryMock = sinon.createStubInstance(TemporaryDirectory); | ||
| prepareExecutorMock = sinon.createStubInstance(PrepareExecutor); | ||
| mutantInstrumenterExecutorMock = sinon.createStubInstance(MutantInstrumenterExecutor); | ||
| dryRunExecutorMock = sinon.createStubInstance(DryRunExecutor); | ||
| mutationTestExecutorMock = sinon.createStubInstance(MutationTestExecutor); | ||
| injectorMock.injectClass | ||
| .withArgs(PrepareExecutor) | ||
| .returns(prepareExecutorMock) | ||
| .withArgs(MutantInstrumenterExecutor) | ||
| .returns(mutantInstrumenterExecutorMock) | ||
| .withArgs(DryRunExecutor) | ||
| .returns(dryRunExecutorMock) | ||
| .withArgs(MutationTestExecutor) | ||
| .returns(mutationTestExecutorMock); | ||
| injectorMock.resolve | ||
| .withArgs(commonTokens.getLogger) | ||
| .returns(getLoggerStub) | ||
| .withArgs(coreTokens.temporaryDirectory) | ||
| .returns(temporaryDirectoryMock) | ||
| .withArgs(commonTokens.options) | ||
| .returns(strOptions); | ||
| getLoggerStub.returns(loggerMock); | ||
|
|
||
| prepareExecutorMock.execute.resolves(injectorMock as typedInject.Injector<MutationTestContext>); | ||
| mutantInstrumenterExecutorMock.execute.resolves(injectorMock as typedInject.Injector<MutationTestContext>); | ||
| dryRunExecutorMock.execute.resolves(injectorMock as typedInject.Injector<MutationTestContext>); | ||
| mutationTestExecutorMock.execute.resolves(mutantResults); | ||
|
|
||
| cliOptions = {}; | ||
| sut = new Stryker(cliOptions, () => injectorMock as typedInject.Injector<MutationTestContext>); | ||
| }); | ||
|
|
||
| it('should not disable `removeDuringDisposal` on the temp dir when dry run rejects and cleanTempDir is set to `always`', async () => { | ||
| dryRunExecutorMock.execute.rejects(new Error('expected error for testing')); | ||
| await expect(sut.runMutationTest()).rejected; | ||
| expect(temporaryDirectoryMock.removeDuringDisposal).not.false; | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Why do you recreate an entire describe here? You should be able to just put this test in the previous describe:
it('should not disable `removeDuringDisposal` on the temp dir when dry run rejects and cleanTempDir is set to `always`', async () => {
testInjector.options.cleanTempDir= 'always';
dryRunExecutorMock.execute.rejects(new Error('expected error for testing'));
await expect(sut.runMutationTest()).rejected;
expect(temporaryDirectoryMock.removeDuringDisposal).not.false;
});There was a problem hiding this comment.
Sorry for my blunder here, removed the describe section and I have a question why this line
expect(temporaryDirectoryMock.removeDuringDisposal).not.false; when set to
expect(temporaryDirectoryMock.removeDuringDisposal).true; throws AssertionError: expected undefined to be true
There was a problem hiding this comment.
Ah yes, this is because temporaryDirectoryMock is a mock, created on line 36. The property removeDuringDisposal is simply never set, so it doesn't get reflected here.
There was a problem hiding this comment.
I also added a unit test for the in temporary-directory.spec.ts: "should remove the dir if cleanTempDir option is 'always'"
There was a problem hiding this comment.
Thank for doing that.
nicojs
approved these changes
May 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This 'always' option removes stryker-tmp folder irrespective of successful run or not