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

Jump to bottom

Adding where does test go section in writing-test.md #18802

Closed
wants to merge 11 commits into from
Closed

Adding where does test go section in writing-test.md #18802

Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
481c5f9
Adding where does test go section in writing-test.md
juggernaut451 Feb 15, 2018
dd902a0
Typo fix
juggernaut451 Feb 15, 2018
c1c8eb5
Typo fix
juggernaut451 Feb 15, 2018
5bf8d98
reframing content and topic of section
juggernaut451 Feb 15, 2018
ca0448b
Fixes: https://github.com/nodejs/node/issues/18774
juggernaut451 Feb 17, 2018
2dea00a
Restructuring the description
juggernaut451 Feb 19, 2018
ba6513b
Wrapping line in 80 characters
juggernaut451 Feb 21, 2018
b24c938
Typo fixes
juggernaut451 Feb 22, 2018
0fa4c3a
refactoring content
juggernaut451 Mar 1, 2018
c8696df
wrapping in 80 char
juggernaut451 Mar 2, 2018
fc0c5b4
doc: adding test directory structure
juggernaut451 Mar 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/guides/writing-tests.md
View file
Open in desktop
Expand Up @@ -18,6 +18,14 @@ Add tests when:
- Fixing regressions and bugs.
- Expanding test coverage.

## Test directory structure

See the test [directory structure overview][] for an outline of existing test types and their locations.
When deciding on whether to expand an existing test file or create a new one.
Copy link
Member

Choose a reason for hiding this comment

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

The punctuation at the end should be ,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changes made :)

Copy link
Member

Choose a reason for hiding this comment

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

Sorry for not being clear, I meant the punctuation at the end of this line should be ,, so it should be

See [directory structure overview][] for outline of existing test & locations.
When deciding on whether to expand an existing test file or create a new one,
consider going through the files related to the subsystem.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When deciding on whether to expand an existing test file or create a new one, consider going through the files related to the subsystem.
@joyeecheung it will exceed 80 characters.

Copy link
Member

Choose a reason for hiding this comment

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

I think @joyeecheung meant it to be a text block (without exceeding 80 characters by using new lines in the correct places), not as being in a single line.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok got it.

Consider going through the files related to the subsystem.
For example looking at tests starting with `test-streams` when writing tests for `lib/streams.js`
Copy link
Member

Choose a reason for hiding this comment

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

Missing . at the end.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changes made :)



Copy link
Member

Choose a reason for hiding this comment

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

Please keep this consistent with the other places in the doc and only use a single new line :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changes made.

Copy link
Member

Choose a reason for hiding this comment

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

Hm, this does not seem to be addressed?

## Test structure

Let's analyze this basic test from the Node.js test suite:
Expand Down Expand Up @@ -381,3 +389,4 @@ will depend on what is being tested if this is required or not.
[all maintained branches]: https://github.com/nodejs/lts
[node.green]: http://node.green/
[test fixture]: https://github.com/google/googletest/blob/master/googletest/docs/Primer.md#test-fixtures-using-the-same-data-configuration-for-multiple-tests
[directory structure overview]: https://github.com/nodejs/node/blob/master/test/README.md
Copy link
Member

Choose a reason for hiding this comment

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

Might be a good idea to change this to:

https://github.com/nodejs/node/blob/master/test/README.md#test-directories

so it links directly to the correct section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changes made :)