[RFC] doc: add `How to write a node test` guide by santigimeno · Pull Request #30 · nodejs/testing

santigimeno · 2016-04-14T00:08:50Z

It's a very basic guide on how to write a node test. It surely needs more work (and syntax corrections!) but it can be a good starting point. Comments are welcome. Thanks.

P.S.: I'm planning to create an accompanying text documenting the common API.

cjihrig · 2016-04-14T00:33:55Z

test_guide.md

@@ -0,0 +1,139 @@
+# How to write a node test


node -> Node.js

santigimeno · 2016-04-16T21:56:19Z

Updated per @cjihrig comments. Thanks!!

cjihrig · 2016-04-19T18:04:37Z

test_guide.md

+const common = require('../common');
+```
+
+These 2 lines are mandatory and should be included on every test.


Can you spell out "two"

santigimeno · 2016-04-19T20:18:00Z

Updated! Thanks again @cjihrig !

cjihrig · 2016-04-21T15:14:33Z

LGTM

jasnell · 2016-04-21T15:27:05Z

This should also say something about things like // Flags: --expose-internals ... specifically, adding a // Flags comment in the pre-amble of the test (along with the 'use strict'; allows the test to be run with specific Node.js command line flags set. In the case of --expose-internals, it allows a test to require the various internal/* modules used internally by Node core.

jasnell · 2016-04-21T15:29:01Z

test_guide.md

+## General recommendations
+
+- The use of timers is discouraged, unless we're testing timers. The reasons for this are multiple. Mainly, they are a source of flakiness. For a thorough explanation go [here](https://github.com/nodejs/testing/issues/27).
+


Perhaps something about common.platformTimeout() here?

jasnell · 2016-04-21T15:33:17Z

Great work @santigimeno! Great to see this. Left a few suggestions.

Trott · 2016-04-30T22:56:54Z

LGTM. Thank you so much for doing this, @santigimeno!

Trott · 2016-05-12T05:58:30Z

Bump! Is this publishable as it stands or does it need a few tweaks?

santigimeno · 2016-05-12T08:05:18Z

@Trott I wanted to incoporate @jasnell suggestions first, but had no time in the last few weeks :(. I think it can be publishable as it is and can improve it afterwards.
General question: where do you think this doc should live in?

Trott · 2016-05-12T17:46:09Z

General question: where do you think this doc should live in?

It's short enough and important/helpful enough that I would make it part of test/README.md in the main core repository. I think the README needs (at least) three things:

How to run the tests
How to write tests (what this doc is!)
What the various tests are (this is what's there already, although it can use some expansion perhaps)

Fishrock123 · 2016-05-23T15:22:52Z

Shouldn't this be PR'd to nodejs/node under doc/guides/?

jasnell · 2016-05-23T15:40:19Z

ah, yes, good point

santigimeno · 2016-05-26T00:32:51Z

Opened PR @ nodejs/node: nodejs/node#6984, incorporating @jasnell suggestions. Closing this. Thank for all the comments!

santigimeno force-pushed the how_to_write branch from 83e90e2 to f746ce6 Compare April 14, 2016 00:10

cjihrig reviewed Apr 14, 2016
View reviewed changes

test_guide.md Outdated

@@ -0,0 +1,139 @@

# How to write a node test

Copy link

cjihrig Apr 14, 2016

Choose a reason for hiding this comment

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

node -> Node.js

santigimeno force-pushed the how_to_write branch from f746ce6 to f233114 Compare April 16, 2016 21:55

cjihrig reviewed Apr 19, 2016
View reviewed changes

santigimeno force-pushed the how_to_write branch from f233114 to 13b4038 Compare April 19, 2016 20:17

jasnell reviewed Apr 21, 2016
View reviewed changes

doc: add How to write a node test guide

87fee17

santigimeno force-pushed the how_to_write branch 3 times, most recently from b7379c2 to d610c5f Compare May 26, 2016 00:23

Add suggestions

d610c5f

santigimeno mentioned this pull request May 26, 2016

doc: add How to write a Node.js test guide nodejs/node#6984

Merged

2 tasks

santigimeno closed this May 26, 2016

		## General recommendations

		- The use of timers is discouraged, unless we're testing timers. The reasons for this are multiple. Mainly, they are a source of flakiness. For a thorough explanation go [here](https://github.com/nodejs/testing/issues/27).

Uh oh!

Conversation

santigimeno commented Apr 14, 2016

Uh oh!

cjihrig Apr 14, 2016

Choose a reason for hiding this comment

Uh oh!

santigimeno commented Apr 16, 2016

Uh oh!

cjihrig Apr 19, 2016

Choose a reason for hiding this comment

Uh oh!

santigimeno commented Apr 19, 2016

Uh oh!

cjihrig commented Apr 21, 2016

Uh oh!

jasnell commented Apr 21, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasnell Apr 21, 2016

Choose a reason for hiding this comment

Uh oh!

jasnell commented Apr 21, 2016

Uh oh!

Trott commented Apr 30, 2016

Uh oh!

Trott commented May 12, 2016

Uh oh!

santigimeno commented May 12, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Trott commented May 12, 2016

Uh oh!

Fishrock123 commented May 23, 2016

Uh oh!

jasnell commented May 23, 2016

Uh oh!

santigimeno commented May 26, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jasnell commented Apr 21, 2016 •

edited

Loading

santigimeno commented May 12, 2016 •

edited

Loading