test: use realpath for NODE_TEST_DIR in common.js #10723

gibfahn · 2017-01-10T14:36:55Z

If you don't specify NODE_TEST_DIR, common.tmpDir will resolve to the
realpath of node/test.

If you do specify NODE_TEST_DIR (with the environment variable or by
running tools/test.py --test-dir=x), common.tmpDir (which
is resolved from testRoot) uses the symbolic path (doesn't resolve
symlinks). This uses fs.realpathSync() to fix that.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

test, common

Fishrock123 · 2017-01-10T15:25:36Z

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

gibfahn · 2017-01-10T15:31:16Z

To reproduce the issue:

git clone https://github.com/nodejs/node.git && cd node && ./configure && make -j8
ln -s node symnode
cd symnode
export NODE_TEST_DIR=$PWD/tmp
tools/test.py parallel/test-process-chdir

gibfahn · 2017-01-10T15:34:33Z

So I noticed another possible issue when running tools/test.py --temp-dir $PWD/tmp parallel/test-process-chdir.

Looking at these lines:

  tempdir = os.environ.get('NODE_TEST_DIR') or options.temp_dir
  if tempdir:
    try:
      os.makedirs(tempdir)
      os.environ['NODE_TEST_DIR'] = tempdir
    except OSError as exception:
      if exception.errno != errno.EEXIST:
        print "Could not create the temporary directory", options.temp_dir
        sys.exit(1)

If tempdir already exists, the os.makedirs(tempdir) fails with errno.EEXIST, which is ignored. However this means that it doesn't ever run the os.environ['NODE_TEST_DIR'] = tempdir line.

Fixed by swapping os.makedirs(tempdir) and os.environ['NODE_TEST_DIR'] = tempdir. This means that NODE_TEST_DIR gets set even if the makedirs fails. If makedir fails because tempdir already existed then we still want NODE_TEST_DIR, if it fails for some other reason tools/test.py will exit, so there shouldn't be a downside to this change.

gibfahn · 2017-01-10T16:24:11Z

CI 2: https://ci.nodejs.org/job/node-test-commit/7145/

gibfahn · 2017-01-10T21:39:24Z

cc/ @nodejs/python

thefourtheye · 2017-01-10T21:50:21Z

tools/test.py

@@ -1629,8 +1629,8 @@ def Main():
  tempdir = os.environ.get('NODE_TEST_DIR') or options.temp_dir
  if tempdir:
    try:
-      os.makedirs(tempdir)
      os.environ['NODE_TEST_DIR'] = tempdir


I would say, move this out of the try...except block.

Makes sense, done.

If you don't specify NODE_TEST_DIR, common.tmpDir will resolve to the realpath of `node/test`. If you do specify NODE_TEST_DIR (with the environment variable or by running or by running tools/test.py --test-dir=x), common.tmpDir (which is resolved from testRoot) uses the symbolic path (doesn't resolve symlinks). This uses fs.realpathSync() to fix that.

If a temp-dir is specified and already exists, the NODE_TEST_DIR environment variable will never be set. This fixes that.

gibfahn · 2017-01-10T22:38:56Z

CI 3: https://ci.nodejs.org/job/node-test-commit/7156/

mhdawson

LGTM

mhdawson · 2017-01-11T14:02:46Z

Failure on arm looks like a machine/connection issue so CI run looks good.

If you don't specify NODE_TEST_DIR, common.tmpDir will resolve to the realpath of `node/test`. If you do specify NODE_TEST_DIR (with the environment variable or by running or by running tools/test.py --test-dir=x), common.tmpDir (which is resolved from testRoot) uses the symbolic path (doesn't resolve symlinks). This uses fs.realpathSync() to fix that. PR-URL: #10723 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

If a temp-dir is specified and already exists, the NODE_TEST_DIR environment variable will never be set. This fixes that. PR-URL: #10723 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

jasnell · 2017-01-12T21:34:48Z

Landed in dd2d3d3 and 57f6a10

gibfahn · 2017-01-16T12:22:05Z

Would be good to get these in v4 and v6, as otherwise we get several test failures in our CI.

If you don't specify NODE_TEST_DIR, common.tmpDir will resolve to the realpath of `node/test`. If you do specify NODE_TEST_DIR (with the environment variable or by running or by running tools/test.py --test-dir=x), common.tmpDir (which is resolved from testRoot) uses the symbolic path (doesn't resolve symlinks). This uses fs.realpathSync() to fix that. PR-URL: nodejs#10723 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

If a temp-dir is specified and already exists, the NODE_TEST_DIR environment variable will never be set. This fixes that. PR-URL: nodejs#10723 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>