test: move tmpdir to submodule of common

Move tmpdir functionality to its own module (common/tmpdir). PR-URL: #17856 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>

Author: Trott

benchmark/http/http_server_for_chunky_client.js

@@ -2,22 +2,15 @@
 
 constassert=require('assert');
 consthttp=require('http');
-constfs=require('fs');
 const{ fork }=require('child_process');
 constcommon=require('../common.js');
-const{PIPE, tmpDir }=require('../../test/common');
+const{PIPE}=require('../../test/common');
+consttmpdir=require('../../test/common/tmpdir');
 process.env.PIPE_NAME=PIPE;
 
-try{
-fs.accessSync(tmpDir,fs.F_OK);
-}catch(e){
-fs.mkdirSync(tmpDir);
-}
+tmpdir.refresh();
 
 varserver;
-try{
-fs.unlinkSync(process.env.PIPE_NAME);
-}catch(e){/* ignore */}
 
 server=http.createServer(function(req,res){
 constheaders={

benchmark/module/module-loader.js

@@ -3,8 +3,8 @@ const fs = require('fs');
 constpath=require('path');
 constcommon=require('../common.js');
 
-const{ refreshTmpDir, tmpDir }=require('../../test/common');
-constbenchmarkDirectory=path.join(tmpDir,'nodejs-benchmark-module');
+consttmpdir=require('../../test/common/tmpdir');
+constbenchmarkDirectory=path.join(tmpdir.path,'nodejs-benchmark-module');
 
 constbench=common.createBenchmark(main,{
 thousands: [50],
@@ -15,7 +15,7 @@ const bench = common.createBenchmark(main,{
 functionmain({ thousands, fullPath, useCache }){
 constn=thousands*1e3;
 
-refreshTmpDir();
+tmpdir.refresh();
 try{fs.mkdirSync(benchmarkDirectory);}catch(e){}
 
 for(vari=0;i<=n;i++){
@@ -35,7 +35,7 @@ function main({thousands, fullPath, useCache }){
 else
 measureDir(n,useCache==='true');
 
-refreshTmpDir();
+tmpdir.refresh();
 }
 
 functionmeasureFull(n,useCache){

test/addons/load-long-path/test.js

@@ -7,12 +7,13 @@ const fs = require('fs');
 constpath=require('path');
 constassert=require('assert');
 
-common.refreshTmpDir();
+consttmpdir=require('../../common/tmpdir');
+tmpdir.refresh();
 
 // make a path that is more than 260 chars long.
 // Any given folder cannot have a name longer than 260 characters,
 // so create 10 nested folders each with 30 character long names.
-letaddonDestinationDir=path.resolve(common.tmpDir);
+letaddonDestinationDir=path.resolve(tmpdir.path);
 
 for(leti=0;i<10;i++){
 addonDestinationDir=path.join(addonDestinationDir,'x'.repeat(30));

test/addons/symlinked-module/test.js

@@ -12,10 +12,11 @@ const assert = require('assert');
 // This test should pass in Node.js v4 and v5. This test will pass in Node.js
 // with https://github.com/nodejs/node/pull/5950 reverted.
 
-common.refreshTmpDir();
+consttmpdir=require('../../common/tmpdir');
+tmpdir.refresh();
 
 constaddonPath=path.join(__dirname,'build',common.buildType);
-constaddonLink=path.join(common.tmpDir,'addon');
+constaddonLink=path.join(tmpdir.path,'addon');
 
 try{
 fs.symlinkSync(addonPath,addonLink);

test/async-hooks/test-graph.pipeconnect.js

@@ -6,7 +6,8 @@ const verifyGraph = require('./verify-graph');
 
 constnet=require('net');
 
-common.refreshTmpDir();
+consttmpdir=require('../common/tmpdir');
+tmpdir.refresh();
 
 consthooks=initHooks();
 hooks.enable();

test/async-hooks/test-pipeconnectwrap.js

@@ -8,7 +8,8 @@ const{checkInvocations } = require('./hook-checks');
 
 constnet=require('net');
 
-common.refreshTmpDir();
+consttmpdir=require('../common/tmpdir');
+tmpdir.refresh();
 
 consthooks=initHooks();
 hooks.enable();

test/common/README.md

@@ -12,6 +12,7 @@ This directory contains modules used to test the Node.js implementation.
 *[Fixtures module](#fixtures-module)
 *[HTTP2 module](#http2-module)
 *[Internet module](#internet-module)
+*[tmpdir module](#tmpdir-module)
 *[WPT module](#wpt-module)
 
 ## Benchmark Module
@@ -332,11 +333,6 @@ A port number for tests to use if one is needed.
 
 Logs '1..0 # Skipped: ' + `msg`
 
-### refreshTmpDir()
-* return [<String>]
-
-Deletes the testing 'tmp' directory and recreates it.
-
 ### restoreStderr()
 
 Restore the original `process.stderr.write`. Used to restore `stderr` to its
@@ -384,11 +380,6 @@ Platform normalizes the `pwd` command.
 
 Synchronous version of `spawnPwd`.
 
-### tmpDir
-*[<String>]
-
-The realpath of the 'tmp' directory.
-
 ## Countdown Module
 
 The `Countdown` module provides a simple countdown mechanism for tests that
@@ -670,6 +661,19 @@ via `NODE_TEST_*` environment variables. For example, to configure
 `internet.addresses.INET_HOST`, set the environment
 variable `NODE_TEST_INET_HOST` to a specified host.
 
+## tmpdir Module
+
+The `tmpdir` module supports the use of a temporary directory for testing.
+
+### path
+*[<String>]
+
+The realpath of the testing temporary directory.
+
+### refresh()
+
+Deletes and recreates the testing temporary directory.
+
 ## WPT Module
 
 The wpt.js module is a port of parts of

test/common/index.js

@@ -30,16 +30,10 @@ const stream = 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,'..');
+consttmpdir=require('./tmpdir');
 
 constnoop=()=>{};
 
-// Using a `.` prefixed name, which is the convention for "hidden" on POSIX,
-// gets tools to ignore it by default or by simple rules, especially eslint.
-lettmpDirName='.tmp';
-
 Object.defineProperty(exports,'PORT',{
 get: ()=>{
 if(+process.env.TEST_PARALLEL){
@@ -120,62 +114,6 @@ if (process.env.NODE_TEST_WITH_ASYNC_HOOKS){
 }).enable();
 }
 
-functionrimrafSync(p){
-letst;
-try{
-st=fs.lstatSync(p);
-}catch(e){
-if(e.code==='ENOENT')
-return;
-}
-
-try{
-if(st&&st.isDirectory())
-rmdirSync(p,null);
-else
-fs.unlinkSync(p);
-}catch(e){
-if(e.code==='ENOENT')
-return;
-if(e.code==='EPERM')
-returnrmdirSync(p,e);
-if(e.code!=='EISDIR')
-throwe;
-rmdirSync(p,e);
-}
-}
-
-functionrmdirSync(p,originalEr){
-try{
-fs.rmdirSync(p);
-}catch(e){
-if(e.code==='ENOTDIR')
-throworiginalEr;
-if(e.code==='ENOTEMPTY'||e.code==='EEXIST'||e.code==='EPERM'){
-constenc=exports.isLinux ? 'buffer' : 'utf8';
-fs.readdirSync(p,enc).forEach((f)=>{
-if(finstanceofBuffer){
-constbuf=Buffer.concat([Buffer.from(p),Buffer.from(path.sep),f]);
-rimrafSync(buf);
-}else{
-rimrafSync(path.join(p,f));
-}
-});
-fs.rmdirSync(p);
-}
-}
-}
-
-exports.refreshTmpDir=function(){
-rimrafSync(exports.tmpDir);
-fs.mkdirSync(exports.tmpDir);
-};
-
-if(process.env.TEST_THREAD_ID){
-tmpDirName+=`.${process.env.TEST_THREAD_ID}`;
-}
-exports.tmpDir=path.join(testRoot,tmpDirName);
-
 letopensslCli=null;
 letinFreeBSDJail=null;
 letlocalhostIPv4=null;
@@ -269,7 +207,7 @@ Object.defineProperty(exports, 'hasFipsCrypto',{
 });
 
 {
-constlocalRelative=path.relative(process.cwd(),`${exports.tmpDir}/`);
+constlocalRelative=path.relative(process.cwd(),`${tmpdir.path}/`);
 constpipePrefix=exports.isWindows ? '\\\\.\\pipe\\' : localRelative;
 constpipeName=`node-test.${process.pid}.sock`;
 exports.PIPE=path.join(pipePrefix,pipeName);

test/common/tmpdir.js

@@ -0,0 +1,67 @@
+/* eslint-disable required-modules */
+'use strict';
+
+constfs=require('fs');
+constpath=require('path');
+
+functionrimrafSync(p){
+letst;
+try{
+st=fs.lstatSync(p);
+}catch(e){
+if(e.code==='ENOENT')
+return;
+}
+
+try{
+if(st&&st.isDirectory())
+rmdirSync(p,null);
+else
+fs.unlinkSync(p);
+}catch(e){
+if(e.code==='ENOENT')
+return;
+if(e.code==='EPERM')
+returnrmdirSync(p,e);
+if(e.code!=='EISDIR')
+throwe;
+rmdirSync(p,e);
+}
+}
+
+functionrmdirSync(p,originalEr){
+try{
+fs.rmdirSync(p);
+}catch(e){
+if(e.code==='ENOTDIR')
+throworiginalEr;
+if(e.code==='ENOTEMPTY'||e.code==='EEXIST'||e.code==='EPERM'){
+constenc=process.platform==='linux' ? 'buffer' : 'utf8';
+fs.readdirSync(p,enc).forEach((f)=>{
+if(finstanceofBuffer){
+constbuf=Buffer.concat([Buffer.from(p),Buffer.from(path.sep),f]);
+rimrafSync(buf);
+}else{
+rimrafSync(path.join(p,f));
+}
+});
+fs.rmdirSync(p);
+}
+}
+}
+
+consttestRoot=process.env.NODE_TEST_DIR ?
+fs.realpathSync(process.env.NODE_TEST_DIR) : path.resolve(__dirname,'..');
+
+// Using a `.` prefixed name, which is the convention for "hidden" on POSIX,
+// gets tools to ignore it by default or by simple rules, especially eslint.
+lettmpdirName='.tmp';
+if(process.env.TEST_THREAD_ID){
+tmpdirName+=`.${process.env.TEST_THREAD_ID}`;
+}
+exports.path=path.join(testRoot,tmpdirName);
+
+exports.refresh=()=>{
+rimrafSync(exports.path);
+fs.mkdirSync(exports.path);
+};

test/es-module/test-esm-preserve-symlinks.js

@@ -7,8 +7,9 @@ const assert = require('assert');
 constpath=require('path');
 constfs=require('fs');
 
-common.refreshTmpDir();
-consttmpDir=common.tmpDir;
+consttmpdir=require('../common/tmpdir');
+tmpdir.refresh();
+consttmpDir=tmpdir.path;
 
 constentry=path.join(tmpDir,'entry.js');
 constreal=path.join(tmpDir,'real.js');