Skip to content

Commit

Permalink
doc: add a note about require('../common') in testing documentation
Browse files Browse the repository at this point in the history
PR-URL: #56953
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
  • Loading branch information
Aditi-1400 authored Feb 15, 2025
1 parent 409e28d commit 794f35f
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions test/common/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
# Node.js Core Test Common Modules

This directory contains modules used to test the Node.js implementation.
All tests must begin by requiring the `common` module:

```js
require('../common');
```

This is not just a convenience for exporting helper functions etc; it also performs
several other tasks:

* Verifies that no unintended globals have been leaked to ensure that tests
don't accidentally pollute the global namespace.

* Some tests assume a default umask of `0o022`. To enforce this assumption,
the common module sets the unmask at startup. Tests that require a
different umask can override this setting after loading the module.

* Some tests specify runtime flags (example, `--expose-internals`) via a
comment at the top of the file: `// Flags: --expose-internals`.
If the test is run without those flags, the common module automatically
spawns a child process with proper flags. This ensures that the tests
always run under the expected conditions. Because of this behaviour, the
common module must be loaded first so that any code below it is not
executed until the process has been re-spawned with the correct flags.

## Table of contents

Expand Down

0 comments on commit 794f35f

Please sign in to comment.