test: begin normalizing fixtures use

Adds a new `../common/fixtures' module to begin normalizing `test/fixtures` use. Our test code is a bit inconsistent with regards to use of the fixtures directory. Some code uses `path.join()`, some code uses string concats, some other code uses template strings, etc. In mnay cases, significant duplication of code is seen when accessing fixture files, etc. This updates many (but by no means all) of the tests in the test suite to use the new consistent API. There are still many more to update, which would make an excelent Code-n-Learn exercise. Backport-PR-URL: #16265 PR-URL: #14332 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>

Author: jasnell

test/common/README.md

@@ -316,6 +316,37 @@ Decrements the `Countdown` counter.
 Specifies the remaining number of times `Countdown.prototype.dec()` must be
 called before the callback is invoked.
 
+## Fixtures Module
+
+The `common/fixtures` module provides convenience methods for working with
+files in the `test/fixtures` directory.
+
+### fixtures.fixturesDir
+
+*[<String>]
+
+The absolute path to the `test/fixtures/` directory.
+
+### fixtures.path(...args)
+
+*`...args`[<String>]
+
+Returns the result of `path.join(fixtures.fixturesDir, ...args)`.
+
+### fixtures.readSync(args[, enc])
+
+*`args`[<String>] | [<Array>]
+
+Returns the result of
+`fs.readFileSync(path.join(fixtures.fixturesDir, ...args), 'enc')`.
+
+### fixtures.readKey(arg[, enc])
+
+*`arg`[<String>]
+
+Returns the result of
+`fs.readFileSync(path.join(fixtures.fixturesDir, 'keys', arg), 'enc')`.
+
 ## WPT Module
 
 The wpt.js module is a port of parts of

test/common/fixtures.js

@@ -0,0 +1,28 @@
+/* eslint-disable required-modules */
+'use strict';
+
+constpath=require('path');
+constfs=require('fs');
+
+constfixturesDir=path.join(__dirname,'..','fixtures');
+
+functionfixturesPath(...args){
+returnpath.join(fixturesDir, ...args);
+}
+
+functionreadFixtureSync(args,enc){
+if(Array.isArray(args))
+returnfs.readFileSync(fixturesPath(...args),enc);
+returnfs.readFileSync(fixturesPath(args),enc);
+}
+
+functionreadFixtureKey(name,enc){
+returnfs.readFileSync(fixturesPath('keys',name),enc);
+}
+
+module.exports={
+ fixturesDir,
+path: fixturesPath,
+readSync: readFixtureSync,
+readKey: readFixtureKey
+};

test/common/index.js

@@ -8,13 +8,15 @@ const{exec, execSync, spawn, spawnSync } = require('child_process');
 conststream=require('stream');
 constutil=require('util');
 constTimer=process.binding('timer_wrap').Timer;
+const{ fixturesDir }=require('./fixtures');
 
 consttestRoot=process.env.NODE_TEST_DIR ?
 fs.realpathSync(process.env.NODE_TEST_DIR) : path.resolve(__dirname,'..');
 
 constnoop=()=>{};
 
-exports.fixturesDir=path.join(__dirname,'..','fixtures');
+exports.fixturesDir=fixturesDir;
+
 exports.tmpDirName='tmp';
 // PORT should match the definition in test/testpy/__init__.py.
 exports.PORT=+process.env.NODE_COMMON_PORT||12346;

test/parallel/test-child-process-detached.js

@@ -1,11 +1,10 @@
 'use strict';
-constcommon=require('../common');
+require('../common');
 constassert=require('assert');
-constpath=require('path');
+constfixtures=require('../common/fixtures');
 
 constspawn=require('child_process').spawn;
-constchildPath=path.join(common.fixturesDir,
-'parent-process-nonpersistent.js');
+constchildPath=fixtures.path('parent-process-nonpersistent.js');
 letpersistentPid=-1;
 
 constchild=spawn(process.execPath,[childPath]);

test/parallel/test-child-process-execfile.js

@@ -2,10 +2,10 @@
 constcommon=require('../common');
 constassert=require('assert');
 constexecFile=require('child_process').execFile;
-constpath=require('path');
 constuv=process.binding('uv');
+constfixtures=require('../common/fixtures');
 
-constfixture=path.join(common.fixturesDir,'exit.js');
+constfixture=fixtures.path('exit.js');
 
 {
 execFile(

test/parallel/test-child-process-exit-code.js

@@ -2,18 +2,17 @@
 constcommon=require('../common');
 constassert=require('assert');
 constspawn=require('child_process').spawn;
-constpath=require('path');
+constfixtures=require('../common/fixtures');
 
-constexitScript=path.join(common.fixturesDir,'exit.js');
+constexitScript=fixtures.path('exit.js');
 constexitChild=spawn(process.argv[0],[exitScript,23]);
 exitChild.on('exit',common.mustCall(function(code,signal){
 assert.strictEqual(code,23);
 assert.strictEqual(signal,null);
 }));
 
 
-consterrorScript=path.join(common.fixturesDir,
-'child_process_should_emit_error.js');
+consterrorScript=fixtures.path('child_process_should_emit_error.js');
 consterrorChild=spawn(process.argv[0],[errorScript]);
 errorChild.on('exit',common.mustCall(function(code,signal){
 assert.ok(code!==0);

test/parallel/test-child-process-fork-close.js

@@ -2,8 +2,9 @@
 constcommon=require('../common');
 constassert=require('assert');
 constfork=require('child_process').fork;
+constfixtures=require('../common/fixtures');
 
-constcp=fork(`${common.fixturesDir}/child-process-message-and-exit.js`);
+constcp=fork(fixtures.path('child-process-message-and-exit.js'));
 
 letgotMessage=false;
 letgotExit=false;

test/parallel/test-child-process-fork.js

@@ -3,8 +3,9 @@ const common = require('../common');
 constassert=require('assert');
 constfork=require('child_process').fork;
 constargs=['foo','bar'];
+constfixtures=require('../common/fixtures');
 
-constn=fork(`${common.fixturesDir}/child-process-spawn-node.js`,args);
+constn=fork(fixtures.path('child-process-spawn-node.js'),args);
 assert.deepStrictEqual(args,['foo','bar']);
 
 n.on('message',function(m){

test/parallel/test-child-process-fork3.js

@@ -1,5 +1,6 @@
 'use strict';
-constcommon=require('../common');
+require('../common');
 constchild_process=require('child_process');
+constfixtures=require('../common/fixtures');
 
-child_process.fork(`${common.fixturesDir}/empty.js`);// should not hang
+child_process.fork(fixtures.path('empty.js'));// should not hang

test/parallel/test-child-process-ipc.js

@@ -1,13 +1,12 @@
 'use strict';
 
-constcommon=require('../common');
+require('../common');
 constassert=require('assert');
 
-constspawn=require('child_process').spawn;
+const{ spawn }=require('child_process');
+constfixtures=require('../common/fixtures');
 
-constpath=require('path');
-
-constsub=path.join(common.fixturesDir,'echo.js');
+constsub=fixtures.path('echo.js');
 
 letgotHelloWorld=false;
 letgotEcho=false;