Skip to content

Commit bb17e90

Browse files
committed
Added content to e2e README on debugging.
1 parent c898447 commit bb17e90

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

test/e2e/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,15 @@ For example,
6161
JOB=PR-Blocking make run-e2e
6262
```
6363
This command runs the e2e tests that contains `PR-Blocking` in their spec names.
64+
65+
### Debugging the e2e tests
66+
The E2E tests can be debugged by attaching a debugger to the e2e process after it is launched (*i.e., make run-e2e*).
67+
To facilitate this, the E2E tests can be run with environment variable PAUSE_FOR_DEBUGGER_ATTACH=true.
68+
(This is only strictly needed when you want the debugger to break early in the test process, i.e., in SynchronizedBeforeSuite.
69+
There's usually quite enough time to attach if you're not breaking until your actual test code runs.)
70+
71+
When this environment variable is set to *true* a 15s pause is inserted at the beginning of the test process
72+
(i.e., in the SynchronizedBeforeSuite). The workflow is:
73+
- Launch the e2e test: *PAUSE_FOR_DEBUGGER_ATTACH=true JOB=MyTest make run-e2e*
74+
- Wait for console message: *Pausing 15s so you have a chance to attach a debugger to this process...*
75+
- Quickly attach your debugger to the e2e process (i.e., e2e.test)

0 commit comments

Comments
 (0)