test: cdk watch integ tests for cli and toolkit lib by iankhou · Pull Request #1139 · aws/aws-cdk-cli

iankhou · 2026-02-12T20:38:23Z

Tests #1134

Description of tests

`cdk watch` in CLI

Test: Detects file changes
**OMIT Test: ** negative test, since we would have to wait for "nothing" to happen—this takes a lot more time

`Toolkit.watch()`

Test: Detects file changes for watched files
Test: Does NOT detect file changes for unwatched files

We used AI 🤖 to help with this contribution.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

codecov-commenter · 2026-02-12T20:50:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.72%. Comparing base (6b190a2) to head (e5bafec).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    aws/aws-cdk-cli#1139   +/-   ##
=======================================
  Coverage   87.71%   87.72%           
=======================================
  Files          72       72           
  Lines       10129    10129           
  Branches     1338     1337    -1     
=======================================
+ Hits         8885     8886    +1     
+ Misses       1218     1217    -1     
  Partials       26       26

Flag	Coverage Δ
suite.unit	`87.72% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mrgrain · 2026-02-19T15:45:52Z

...g/tests/cli-integ-tests/watch/cdk-watch-detects-file-changes-with-glob-patterns.integtest.ts

+      // Use separate output dir to avoid conflicts with lingering watch process
+      await fixture.cdkDestroy('test-1', { options: ['--output', 'cdk-destroy.out'] });


No need to manually delete. The rest harness is doing this for us.

Suggested change

// Use separate output dir to avoid conflicts with lingering watch process

await fixture.cdkDestroy('test-1', { options: ['--output', 'cdk-destroy.out'] });

mrgrain · 2026-02-19T15:46:23Z

...ges/@aws-cdk-testing/cli-integ/tests/toolkit-lib-integ-tests/toolkit-watch-glob.integtest.ts

+  }),
+);
+
+integTest(


Only one test per file. Pls move to separate file.

mrgrain · 2026-02-19T15:49:08Z

...g/tests/cli-integ-tests/watch/cdk-watch-detects-file-changes-with-glob-patterns.integtest.ts

+async function waitForOutput(getOutput: () => string, searchString: string, timeoutMs: number): Promise<void> {
+  const startTime = Date.now();
+  return new Promise((resolve, reject) => {
+    const check = () => {
+      if (getOutput().includes(searchString)) return resolve();
+      if (Date.now() - startTime > timeoutMs) {
+        return reject(new Error(`Timeout waiting for: "${searchString}"`));
+      }
+      setTimeout(check, 1000);
+    };
+    check();
+  });
+}
+
+async function waitForCondition(condition: () => boolean, timeoutMs: number, description: string): Promise<void> {
+  const startTime = Date.now();
+  return new Promise((resolve, reject) => {
+    const check = () => {
+      if (condition()) return resolve();
+      if (Date.now() - startTime > timeoutMs) {
+        return reject(new Error(`Timeout waiting for ${description}`));
+      }
+      setTimeout(check, 1000);
+    };
+    check();
+  });
+}


Are there really no existing helpers for this?

kaizencc · 2026-02-19T17:06:43Z

...g/tests/cli-integ-tests/watch/cdk-watch-detects-file-changes-with-glob-patterns.integtest.ts

+    });
+
+    try {
+      await waitForOutput(() => output, "Triggering initial 'cdk deploy'", 120000);


how did you come up with these timeout durations?

kaizencc · 2026-02-19T17:08:23Z

...ges/@aws-cdk-testing/cli-integ/tests/toolkit-lib-integ-tests/toolkit-watch-glob.integtest.ts

+);
+
+integTest(
+  'toolkit watch excludes node_modules and dotfiles by default',


why is this test not part of the cli integ tests also?

Because it will add more time to the test, while offering limited utility IMO. Probably another minute or so. See my PR description where I addressed this discrepancy.

i dont understand why this would be the case. i think you need to
a) touch node_modules / dotfiles
b) assert that we do not see Detected change to '<file>' -- this happens nearly instantly if the file is being watched, so i dont see why it would take another minute.

as for whether this offers utility, i think its worse if we accidentally don't exclude files from watch than if we accidentally don't include files.

kaizencc · 2026-02-19T17:11:20Z

...g/tests/cli-integ-tests/watch/cdk-watch-detects-file-changes-with-glob-patterns.integtest.ts

+    const cdkJsonPath = path.join(fixture.integTestDir, 'cdk.json');
+    const cdkJson = JSON.parse(fs.readFileSync(cdkJsonPath, 'utf-8'));
+    cdkJson.watch = {
+      include: ['**/*.ts', '**/*.js'],


nit: including the .js files is a bad idea for some use cases (say you're also auto-compiling ts changes, now you're double counting). doesn't seem necessary in your test

kaizencc · 2026-02-19T17:12:14Z

...g/tests/cli-integ-tests/watch/cdk-watch-detects-file-changes-with-glob-patterns.integtest.ts

+    const cdkJson = JSON.parse(fs.readFileSync(cdkJsonPath, 'utf-8'));
+    cdkJson.watch = {
+      include: ['**/*.ts', '**/*.js'],
+      exclude: ['node_modules/**', 'cdk.out/**', '**/*.d.ts'],


this part isn't tested. in this test or a new one, we should be testing that changes to exclude files do not trigger deployment.

mrgrain · 2026-02-20T18:31:43Z

...g/tests/cli-integ-tests/watch/cdk-watch-detects-file-changes-with-glob-patterns.integtest.ts

+      include: ['**/*.ts', '**/*.js'],
+      exclude: ['node_modules/**', 'cdk.out/**', '**/*.d.ts'],
+    };
+    fs.writeFileSync(cdkJsonPath, JSON.stringify(cdkJson, null, 2));


we can also just call touch on the file.

integ tests for cli and toolkit lib for cdk watch

3065b0f

iankhou had a problem deploying to automation February 12, 2026 20:38 — with GitHub Actions Failure

iankhou temporarily deployed to automation February 12, 2026 20:38 — with GitHub Actions Inactive

iankhou temporarily deployed to integ-approval February 12, 2026 20:38 — with GitHub Actions Inactive

github-actions bot added bug p0 labels Feb 12, 2026

aws-cdk-automation requested a review from a team February 12, 2026 20:39

iankhou temporarily deployed to run-tests February 12, 2026 20:48 — with GitHub Actions Inactive

iankhou temporarily deployed to run-tests February 12, 2026 20:52 — with GitHub Actions Inactive

iankhou had a problem deploying to run-tests February 12, 2026 20:52 — with GitHub Actions Failure

iankhou temporarily deployed to run-tests February 12, 2026 20:52 — with GitHub Actions Inactive

watch test fix

2b1ee05

iankhou requested a deployment to integ-approval February 13, 2026 17:56 — with GitHub Actions Waiting

iankhou marked this pull request as ready for review February 17, 2026 15:57

iankhou temporarily deployed to run-tests February 17, 2026 15:59 — with GitHub Actions Inactive

iankhou temporarily deployed to run-tests February 17, 2026 16:02 — with GitHub Actions Inactive

iankhou enabled auto-merge February 17, 2026 16:23

iankhou assigned iankhou and unassigned iankhou Feb 17, 2026

mrgrain reviewed Feb 19, 2026

View reviewed changes

mrgrain requested changes Feb 19, 2026

View reviewed changes

mrgrain reviewed Feb 19, 2026

View reviewed changes

kaizencc reviewed Feb 19, 2026

View reviewed changes

mrgrain reviewed Feb 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

test: cdk watch integ tests for cli and toolkit lib#1139

test: cdk watch integ tests for cli and toolkit lib#1139
iankhou wants to merge 9 commits intomainfrom
iankhou-cdk-watch-integ

iankhou commented Feb 12, 2026 •

edited

Loading

Uh oh!

codecov-commenter commented Feb 12, 2026 •

edited

Loading

Uh oh!

mrgrain Feb 19, 2026

Uh oh!

mrgrain Feb 19, 2026

Uh oh!

mrgrain Feb 19, 2026 •

edited

Loading

Uh oh!

kaizencc Feb 19, 2026

Uh oh!

kaizencc Feb 19, 2026

Uh oh!

iankhou Feb 19, 2026 •

edited

Loading

Uh oh!

kaizencc Feb 20, 2026

Uh oh!

kaizencc Feb 19, 2026

Uh oh!

kaizencc Feb 19, 2026

Uh oh!

mrgrain Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		// Use separate output dir to avoid conflicts with lingering watch process
		await fixture.cdkDestroy('test-1', { options: ['--output', 'cdk-destroy.out'] });

Comments

Conversation

iankhou commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of tests

cdk watch in CLI

Toolkit.watch()

Uh oh!

codecov-commenter commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrgrain Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iankhou Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

iankhou commented Feb 12, 2026 •

edited

Loading

`cdk watch` in CLI

`Toolkit.watch()`

codecov-commenter commented Feb 12, 2026 •

edited

Loading

mrgrain Feb 19, 2026 •

edited

Loading

iankhou Feb 19, 2026 •

edited

Loading