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

juggernaut451 · 2018-02-15T18:35:24Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

vsemozhetbyt

Thank you, @juggernaut451!
I've made some tiny notes, but they can be addressed by a comment lander if it is more easy for you.

vsemozhetbyt · 2018-02-15T18:58:32Z

doc/guides/writing-tests.md

@@ -18,6 +18,13 @@ Add tests when:
 - Fixing regressions and bugs.
 - Expanding test coverage.

+## Where does the test go
+One can refer [test directory structure](https://github.com/nodejs/node/tree/master/test)
+to decide where to put your test cases. If you want to find any current test that exist then


exist -> exists

vsemozhetbyt · 2018-02-15T18:59:23Z

doc/guides/writing-tests.md

+One can refer [test directory structure](https://github.com/nodejs/node/tree/master/test)
+to decide where to put your test cases. If you want to find any current test that exist then
+go to the defined [test directory structure](https://github.com/nodejs/node/tree/master/test) 
+and search for similar APIs and see if there is similar file available 


A nit: missing period.

did not get this one. Can you please elaborate

Sorry. I think file available should be file available. (with a dot).

resolved :)

apapirovski

Thanks for taking this on @juggernaut451 — some small feedback below.

apapirovski · 2018-02-15T20:57:35Z

doc/guides/writing-tests.md

@@ -18,6 +18,13 @@ Add tests when:
 - Fixing regressions and bugs.
 - Expanding test coverage.

+## Where does the test go
+One can refer [test directory structure](https://github.com/nodejs/node/tree/master/test)


General nit: please keep lines to 80 chars. I think URLs can, maybe, be excepted.

thanks 👍

apapirovski · 2018-02-15T21:01:14Z

doc/guides/writing-tests.md

@@ -18,6 +18,13 @@ Add tests when:
 - Fixing regressions and bugs.
 - Expanding test coverage.

+## Where does the test go


This would sound better as "Where are tests located" (maybe "Where are the..." but that's getting clunky) or even "Test directory structure".

changing it to "Test directory structure"

apapirovski · 2018-02-15T21:12:19Z

doc/guides/writing-tests.md

+One can refer [test directory structure](https://github.com/nodejs/node/tree/master/test)
+to decide where to put your test cases. If you want to find any current test that exists then
+go to the defined [test directory structure](https://github.com/nodejs/node/tree/master/test) 
+and search for similar APIs and see if there is similar file available. 


Overall, this is a bit too verbose and repeats the same information twice. We also do our best to avoid using "you", "your", "one" and similar. We could communicate the same thought in a shorter sentence:

See the test directory structure overview for an outline of existing test types and their locations.

That could probably be improved further. (Note that the link above goes directly to the README rather than the test folder.)

Does above description answers #18774 second issue?

It probably doesn't but I don't think the current one does either. I would go with something like:

When deciding on whether to expand an existing test file or create a new one, consider going through the files related to the subsystem (e.g. ones starting with "test-streams" for lib/streams.js) and assessing whether a related test already exists.

It's possible that should be even more detailed, like for example explaining the difference between parallel and sequential, but that could get quite tricky and complicated.

Thanks making changes with the above one. :)

changes made.

Thank you for feedback.

joyeecheung · 2018-02-16T13:09:24Z

doc/guides/writing-tests.md

+See the test [directory structure overview](https://github.com/nodejs/node/blob/master/test/README.md)
+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, 
+consider going through the files related to the subsystem (e.g. ones starting with "test-streams" for `lib/streams.js`) 


Nit: can you wrap this to 80-chars? Also maybe ones starting with `test-streams-` for `lib/streams.js`

@joyeecheung fixed. Kindly have a look

mmarchini · 2018-02-17T13:04:46Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/179/

BridgeAR · 2018-02-18T10:57:29Z

Light-CI https://ci.nodejs.org/job/node-test-commit-light/293/

BridgeAR

Just a few nits, LG otherwise.

BridgeAR · 2018-02-18T11:07:41Z

doc/guides/writing-tests.md

+For example, take a look at tests starting with "test-streams" 
+when writing tests for `lib/streams.js`
+
+


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

changes made.

Hm, this does not seem to be addressed?

BridgeAR · 2018-02-18T11:09:19Z

doc/guides/writing-tests.md

@@ -18,6 +18,15 @@ Add tests when:
 - Fixing regressions and bugs.
 - Expanding test coverage.

+## Test directory structure
+See the test [directory structure overview](https://github.com/nodejs/node/blob/master/test/README.md)


Since this is longer than 80 characters, please move the reference down to the end of the file and only keep [directory structure overview][].

changes made.

BridgeAR · 2018-02-18T11:10:16Z

doc/guides/writing-tests.md

+When deciding on whether to expand an existing test file or create a new one, 
+consider going through the files related to the subsystem.
+For example, take a look at tests starting with "test-streams" 
+when writing tests for `lib/streams.js`


The line breaks in this paragraph are actually not visible when viewing this not in raw form. Therefore it would be good to wrap each line around 80 characters.

changes made.

BridgeAR · 2018-02-18T11:11:33Z

doc/guides/writing-tests.md

@@ -18,6 +18,15 @@ Add tests when:
 - Fixing regressions and bugs.
 - Expanding test coverage.

+## Test directory structure
+See the test [directory structure overview](https://github.com/nodejs/node/blob/master/test/README.md)


Adding a new line after the header would be good for consistency as well.

changes made.

BridgeAR

Can you please make sure the lines do not exceed 80 characters? :-)

joyeecheung · 2018-02-21T18:36:10Z

doc/guides/writing-tests.md

+## 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.


The punctuation at the end should be ,

changes made :)

joyeecheung · 2018-02-21T18:36:25Z

doc/guides/writing-tests.md

+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.
+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`


Missing . at the end.

changes made :)

joyeecheung · 2018-02-22T11:28:02Z

doc/guides/writing-tests.md

+## Test directory structure
+
+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.


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.

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.

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.

juggernaut451 · 2018-02-26T08:23:38Z

@BridgeAR @joyeecheung can you please review it now

joyeecheung · 2018-02-26T11:56:57Z

doc/guides/writing-tests.md

+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.
+For example viewing tests for `test-streams` when writing for `lib/streams.js`.


...when writing a test for..?

changes made.

joyeecheung · 2018-03-01T22:59:57Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/203/

BridgeAR · 2018-03-01T23:02:22Z

doc/guides/writing-tests.md

+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.
+For example viewing tests for `test-streams` when writing a test for `lib/streams.js`.


This should fail in the linter as it is above 80 characters.

mmarchini · 2018-03-05T14:11:56Z

New Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/220/

juggernaut451 · 2018-03-05T15:05:36Z

@mmarchini I can't find any issue with the above CI.

gibfahn · 2018-03-05T15:06:21Z

@mmarchini I can't find any issue with the above CI.

Yep, CI was green.

gibfahn

LGTM with suggestion

gibfahn · 2018-03-05T15:06:52Z

doc/guides/writing-tests.md

@@ -381,3 +388,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


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.

changes made :)

gibfahn · 2018-03-09T16:27:01Z

CI: https://ci.nodejs.org/job/node-test-commit-lite/388/

juggernaut451 · 2018-03-14T06:44:03Z

Resolved :)

trivikr

LGTM

trivikr · 2018-03-25T03:50:58Z

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/324/

trivikr · 2018-03-25T04:01:13Z

Landed in 59b5d77

PR-URL: #18802 Fixes: #18774 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

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

481c5f9

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 15, 2018

vsemozhetbyt added the test Issues and PRs related to the tests. label Feb 15, 2018

vsemozhetbyt reviewed Feb 15, 2018

View reviewed changes

juggernaut451 added 2 commits February 16, 2018 01:28

Typo fix

dd902a0

Typo fix

c1c8eb5

apapirovski reviewed Feb 15, 2018

View reviewed changes

reframing content and topic of section

5bf8d98

joyeecheung approved these changes Feb 16, 2018

View reviewed changes

jasnell approved these changes Feb 16, 2018

View reviewed changes

juggernaut451 force-pushed the refactoringAddingTest branch from 7899496 to 0493c0e Compare February 17, 2018 08:41

mmarchini approved these changes Feb 17, 2018

View reviewed changes

Fixes: nodejs#18774

ca0448b

juggernaut451 force-pushed the refactoringAddingTest branch from 0493c0e to ca0448b Compare February 17, 2018 13:30

BridgeAR reviewed Feb 18, 2018

View reviewed changes

Restructuring the description

2dea00a

BridgeAR reviewed Feb 21, 2018

View reviewed changes

joyeecheung reviewed Feb 21, 2018

View reviewed changes

Wrapping line in 80 characters

ba6513b

joyeecheung reviewed Feb 22, 2018

View reviewed changes

Typo fixes

b24c938

joyeecheung reviewed Feb 26, 2018

View reviewed changes

refactoring content

0fa4c3a

joyeecheung approved these changes Mar 1, 2018

View reviewed changes

BridgeAR reviewed Mar 1, 2018

View reviewed changes

wrapping in 80 char

c8696df

gibfahn approved these changes Mar 5, 2018

View reviewed changes

doc: adding test directory structure

fc0c5b4

juggernaut451 force-pushed the refactoringAddingTest branch from cfe1481 to fc0c5b4 Compare March 9, 2018 17:28

fhinkel approved these changes Mar 17, 2018

View reviewed changes

Leko approved these changes Mar 17, 2018

View reviewed changes

trivikr approved these changes Mar 25, 2018

View reviewed changes

trivikr closed this Mar 25, 2018

BethGriggs mentioned this pull request Dec 4, 2018

v8.14.1 proposal #24832

Merged

		For example, take a look at tests starting with "test-streams"
		when writing tests for `lib/streams.js`

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

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

Conversation

juggernaut451 commented Feb 15, 2018 • edited

Checklist

Affected core subsystem(s)

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apapirovski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apapirovski Feb 15, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apapirovski Feb 15, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mmarchini commented Feb 17, 2018

BridgeAR commented Feb 18, 2018 • edited

BridgeAR left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juggernaut451 commented Feb 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joyeecheung commented Mar 1, 2018

BridgeAR Mar 1, 2018 • edited

Choose a reason for hiding this comment

mmarchini commented Mar 5, 2018

juggernaut451 commented Mar 5, 2018

gibfahn commented Mar 5, 2018

gibfahn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gibfahn commented Mar 9, 2018 • edited

juggernaut451 commented Mar 14, 2018

trivikr left a comment

Choose a reason for hiding this comment

trivikr commented Mar 25, 2018

trivikr commented Mar 25, 2018

juggernaut451 commented Feb 15, 2018 •

edited

apapirovski Feb 15, 2018 •

edited

apapirovski Feb 15, 2018 •

edited

BridgeAR commented Feb 18, 2018 •

edited

BridgeAR Mar 1, 2018 •

edited

gibfahn commented Mar 9, 2018 •

edited