Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(integ-runner): Fix call to spawnSync for hooks commands #22429

Merged
merged 22 commits into from
Oct 19, 2022
Merged

fix(integ-runner): Fix call to spawnSync for hooks commands #22429

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
a91c3c3
fix(integ-runner): Fix call to spawnSync for hooks commands
arewa Oct 8, 2022
1b798f3
Additional tests
arewa Oct 8, 2022
268a3f6
Merge branch 'main' into issue-22344
arewa Oct 10, 2022
c19f2ff
Merge branch 'main' into issue-22344
arewa Oct 10, 2022
1661e8f
Merge branch 'main' into issue-22344
arewa Oct 11, 2022
a0d433f
Merge branch 'main' into issue-22344
arewa Oct 11, 2022
f71d813
Add sample integration test
arewa Oct 11, 2022
8c44451
Merge branch 'main' into issue-22344
arewa Oct 11, 2022
049852a
Merge branch 'main' into issue-22344
arewa Oct 12, 2022
2021e09
Merge branch 'main' into issue-22344
arewa Oct 12, 2022
85c88b3
Merge branch 'main' into issue-22344
arewa Oct 13, 2022
4f5e259
Merge branch 'main' into issue-22344
arewa Oct 14, 2022
b15c9a8
Remove excess integ test
arewa Oct 14, 2022
24f7ba8
Remove excess snapshots
arewa Oct 14, 2022
b015106
Merge branch 'main' into issue-22344
arewa Oct 19, 2022
3fcd260
Merge branch 'main' into issue-22344
arewa Oct 19, 2022
952b8a9
Merge branch 'main' into issue-22344
arewa Oct 19, 2022
937e43d
Refator the solution
arewa Oct 19, 2022
c5ed430
Tiny update
arewa Oct 19, 2022
a899f7f
Tiny update
arewa Oct 19, 2022
91f6884
Merge branch 'main' into issue-22344
arewa Oct 19, 2022
5c93451
Merge branch 'main' into issue-22344
arewa Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions packages/@aws-cdk/integ-runner/lib/runner/integ-test-runner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { RequireApproval } from '@aws-cdk/cloud-assembly-schema';
import { DeployOptions, DestroyOptions } from 'cdk-cli-wrapper';
import * as fs from 'fs-extra';
import * as logger from '../logger';
import { chain, exec } from '../utils';
import { exec, prepareForExec } from '../utils';
import { DestructiveChange, AssertionResults, AssertionResult } from '../workers/common';
import { IntegRunnerOptions, IntegRunner, DEFAULT_SYNTH_OPTIONS } from './runner-base';

Expand Down Expand Up @@ -222,17 +222,21 @@ export class IntegTestRunner extends IntegRunner {
const actualTestCase = this.actualTestSuite.testSuite[testCaseName];
try {
if (actualTestCase.hooks?.preDestroy) {
exec([chain(actualTestCase.hooks.preDestroy)], {
cwd: path.dirname(this.snapshotDir),
actualTestCase.hooks.preDestroy.forEach(cmd => {
exec(prepareForExec(cmd), {
cwd: path.dirname(this.snapshotDir),
});
});
}
this.cdk.destroy({
...destroyArgs,
});

if (actualTestCase.hooks?.postDestroy) {
exec([chain(actualTestCase.hooks.postDestroy)], {
cwd: path.dirname(this.snapshotDir),
actualTestCase.hooks.postDestroy.forEach(cmd => {
exec(prepareForExec(cmd), {
cwd: path.dirname(this.snapshotDir),
});
});
}
} catch (e) {
Expand All @@ -255,8 +259,10 @@ export class IntegTestRunner extends IntegRunner {
const actualTestCase = this.actualTestSuite.testSuite[testCaseName];
try {
if (actualTestCase.hooks?.preDeploy) {
exec([chain(actualTestCase.hooks?.preDeploy)], {
cwd: path.dirname(this.snapshotDir),
actualTestCase.hooks.preDeploy.forEach(cmd => {
exec(prepareForExec(cmd), {
cwd: path.dirname(this.snapshotDir),
});
});
}
// if the update workflow is not disabled, first
Expand Down Expand Up @@ -297,8 +303,10 @@ export class IntegTestRunner extends IntegRunner {
});

if (actualTestCase.hooks?.postDeploy) {
exec([chain(actualTestCase.hooks?.postDeploy)], {
cwd: path.dirname(this.snapshotDir),
actualTestCase.hooks.postDeploy.forEach(cmd => {
exec(prepareForExec(cmd), {
cwd: path.dirname(this.snapshotDir),
});
});
}

Expand Down
12 changes: 12 additions & 0 deletions packages/@aws-cdk/integ-runner/lib/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,18 @@ export function chain(commands: string[]): string {
return commands.filter(c => !!c).join(' && ');
}

/**
* Prepare command for execution by exec
*/
export function prepareForExec(command: string): string[] {
let chunks = command.split(/\s+/);
const cmd = chunks.shift();
if (cmd !== undefined) {
return [cmd, chunks.join(' ')];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be return chunks instead?

For example if I had

hooks: {
  preDeploy: ['npx cdk deploy'],
}

I would want it to return ['npx', 'cdk', 'deploy'] right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@corymhall, thank you for the comment, for the command you mentioned it could be like that. But for example for the command echo "preDeploy hook" if we just split it by space it will result in ['echo', '"preDeploy', 'hook"'] which seems to be not the correct input for exec.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could do something like this instead in order to keep quoted sections together.

let chunks = command.match(/(?:[^\s"]+|"[^"]*")+/g)
// ['echo', '"preDeploy hook"']

I think if you use arguments with spawnSync each argument to the command needs to be its own element in the list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, make sense, I updated the solution. Thank you again for the review.

}
return [];
}


/**
* A class holding a set of items which are being crossed off in time
Expand Down
8 changes: 4 additions & 4 deletions packages/@aws-cdk/integ-runner/test/runner/integ-test-runner.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,16 +347,16 @@ describe('IntegTest runIntegTests', () => {
// THEN
expect(spawnSyncMock.mock.calls).toEqual(expect.arrayContaining([
expect.arrayContaining([
'echo "preDeploy"',
'echo', ['"preDeploy hook"'],
]),
expect.arrayContaining([
'echo "postDeploy"',
'echo', ['"postDeploy hook"'],
]),
expect.arrayContaining([
'echo "preDestroy"',
'echo', ['"preDestroy hook"'],
]),
expect.arrayContaining([
'echo "postDestroy"',
'echo', ['"postDestroy hook"'],
]),
]));
});
Expand Down
8 changes: 4 additions & 4 deletions ...s/@aws-cdk/integ-runner/test/test-data/cdk-integ.out.test-with-snapshot-assets/integ.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
"stackUpdateWorkflow": false,
"diffAssets": false,
"hooks": {
"preDeploy": ["echo \"preDeploy\""],
"postDeploy": ["echo \"postDeploy\""],
"preDestroy": ["echo \"preDestroy\""],
"postDestroy": ["echo \"postDestroy\""]
"preDeploy": ["echo \"preDeploy hook\""],
"postDeploy": ["echo \"postDeploy hook\""],
"preDestroy": ["echo \"preDestroy hook\""],
"postDestroy": ["echo \"postDestroy hook\""]
},
"allowDestroy": [
"AWS::IAM::Role"
Expand Down