docs: update docs on running tests #3556
Merged
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
dbowling
reviewed
Jul 21, 2022
Co-authored-by: Dan Bowling <[email protected]>
dbowling
reviewed
Jul 21, 2022
dbowling
reviewed
Jul 21, 2022
|
|
||
| You can also load tests in any supported browser, which is helpful for debugging. Tests require a local server to run, you must first start a local server to serve files. You can use Grunt to start one by running `npm start`. Once your local server is running you can load the following pages in any browser to run tests: | ||
| - `npm run test:debug -- testDirs=core` |
There was a problem hiding this comment.
Suggested change
| - `npm run test:debug -- testDirs=core` | |
| - `npm run test:debug -- testDirs=core` | |
| You can then open the inspector and debug normally in Chrome by setting breakpoints and refreshing the page. Mocha will re-execute the tests with your debugger running. |
There was a problem hiding this comment.
I feel like this part may not be necessary. Do you feel people debugging tests in a browser wouldn't know this and should to be informed about it?
dbowling
reviewed
Jul 21, 2022
stephenmathieson
previously approved these changes
Jul 25, 2022
stephenmathieson
previously approved these changes
Jul 25, 2022
stephenmathieson
approved these changes
Jul 25, 2022
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.
While helping @dbowling and @pschwendy with their prs, I found that we didn't have a lot of docs around how to run and work with the tests. Adding a few readmes to test directories to describe what each one is doing and updating the developer guide docs to include all our testing commands / strategies.