test: Environment varible to specify directory for pipes #9381

mhdawson · 2015-03-11T21:39:42Z

At the uv layer pipes are connected with uv_pipe_connect.
The current spec for this method indicates that the maximum
length is limited to the size of length of
sizeof(sockaddr_un.sun_path), typically between 92 and
108 bytes. Anything longer than that just gets truncated.

The simple testsuite currently creates pipes in directories
under the directory where node was built. In our jenkins
jobs this sometimes ends up being a deep enough path that
the path for the pipes is getting truncated. The result
is that tests using pipes fail with errors that don't
make it obvious what the problem is.

Even if the errors were helpful, we still need a way
to avoid the truncation.

This patch adds the environment variable NODE_PIPE_DIR.
If set the tests create pipes in this directory instead of
the current defaults. In addition the test harness is
updated to remove/delete this directory before/after
each test is run.

modified:   test/common.js
modified:   test/simple/test-net-pipe-connect-errors.js
modified:   test/testpy/__init__.py
modified:   test/simple/test-cluster-eaccess.js

cjihrig · 2015-03-11T21:58:01Z

test/common.js

@@ -35,7 +35,11 @@ if (process.platform === 'win32') {
  exports.PIPE = '\\\\.\\pipe\\libuv-test';
  exports.opensslCli += '.exe';
 } else {
-  exports.PIPE = exports.tmpDir + '/test.sock';
+  if (typeof process.env.NODE_PIPE_DIR == 'undefined') {


Can you replace the typeof checks with direct comparisons to undefined?

This should be ===.

misterdjules · 2015-03-12T23:30:50Z

@mdawsonibm As discussed during the core team meeting, please add this to the 0.12.1 or 0.12.2 milestone as you see fit.

mhdawson · 2015-03-17T01:00:50Z

Updated per comments and all tests pass on linux with/without NODE_PIPE_DIR in a shallow directory. In a deep directory all pass with NODE_PIPE_DIR and without some fail as expected.

misterdjules · 2015-03-17T22:20:21Z

test/testpy/__init__.py

@@ -53,11 +53,15 @@ def AfterRun(self, result):
    # delete the whole tmp dir
    try:
      rmtree(self.tmpdir)
+      if "NODE_PIPE_DIR" in os.environ:
+        rmtree(join(os.environ["NODE_PIPE_DIR"], 'NodePipeTmp'));


Can we avoid the repetition of join(os.environ["NODE_PIPE_DIR"], 'NodePipeTmp') by having a self.pipeTmpDir member variable?

misterdjules · 2015-03-20T19:00:54Z

@mdawsonibm Once this comment: https://github.com/joyent/node/pull/9381/files#r26866770 is addressed, LGTM 👍 Thank you very much!

mhdawson · 2015-03-25T15:05:07Z

When I ran the accept job test-cluster-eaccess failed on windows 32bit. I think its because what's used for common.PIPE ('\.\pipe\libuv-test') is special and can't be used by fs.writeFileSync and we end up with this error:

#Error: ENOENT, no such file or directory '.\pipe\libuv-test'

It seems like test already special cases for windows 32 in that it expects a different error.

I think it makes the most sense to special case what we use for socketPatch for windows. In this way we share the common solution to the depth paths on non-windows were we say the original problem while keeping the test on windows running in the way it did perviously

mhdawson · 2015-03-25T15:13:36Z

Pushed additional change to address failure seen on windows

misterdjules · 2015-03-25T16:37:15Z

test/simple/test-cluster-eaccess.js

+  // for windows pipes are handled specially and we can't write to
+  // common.PIPE with fs.writeFileSync like we can on other platforms
+  socketPath = path.join(common.fixturesDir, 'socket-path');
+}


If this test was not failing before when run in a deep directory and we can't use common.PIPE on all platforms, then I suggest reverting to the old behavior of using path.join(common.fixturesDir, 'socket-path'); on all platforms. Sorry for the confusion.

misterdjules · 2015-03-25T16:41:20Z

Added two comments, can you please take a look and let me know what you think? Also, we'll need to squash these commits into just one before we merge them with the node-accept-pull-request Jenkins job.

mhdawson · 2015-03-25T16:53:20Z

It was failing on unix due to the deep paths, that is why I modified it in the first patch. On windows it would have been ok because its not actually a pipe but a directory that's being used.

misterdjules · 2015-03-25T17:08:20Z

@mdawsonibm OK, thank you for the clarification. Did you have some time to take a look at this comment: #9381 (comment)?

mhdawson · 2015-03-25T18:36:48Z

Sorry did not look far up enough to see that one. Will update and squash into one commit.

mhdawson · 2015-03-25T19:16:39Z

Ok updated to reflect that comment and squashed into 1 commit

misterdjules · 2015-03-25T20:59:05Z

Thank you @mdawsonibm! The first line of the commit should be 50 columns or less, as indicated in the contribution guidelines. Otherwise, LGTM 👍

At the uv layer pipes are connected with uv_pipe_connect. The current spec for this method indicates that the maximum length is limited to the size of length of sizeof(sockaddr_un.sun_path), typically between 92 and 108 bytes. Anything longer than that just gets truncated. The simple testsuite currently creates pipes in directories under the directory where node was built. In our jenkins jobs this sometimes ends up being a deep enough path that the path for the pipes is getting truncated. The result is that tests using pipes fail with errors that don't make it obvious what the problem is. Even if the errors were helpful, we still need a way to avoid the truncation. This patch adds the environment variable NODE_PIPE_DIR. If set the tests create pipes in this directory instead of the current defaults. In addition the test harness is updated to remove/delete this directory before/after each test is run. modified: test/common.js modified: test/simple/test-net-pipe-connect-errors.js modified: test/testpy/__init__.py modified: test/simple/test-cluster-eaccess.js

mhdawson · 2015-03-26T18:28:40Z

Ok shrunk length of first line, will land now

At the uv layer pipes are connected with uv_pipe_connect. The current spec for this method indicates that the maximum length is limited to the size of length of sizeof(sockaddr_un.sun_path), typically between 92 and 108 bytes. Anything longer than that just gets truncated. The simple testsuite currently creates pipes in directories under the directory where node was built. In our jenkins jobs this sometimes ends up being a deep enough path that the path for the pipes is getting truncated. The result is that tests using pipes fail with errors that don't make it obvious what the problem is. Even if the errors were helpful, we still need a way to avoid the truncation. This patch adds the environment variable NODE_PIPE_DIR. If set the tests create pipes in this directory instead of the current defaults. In addition the test harness is updated to remove/delete this directory before/after each test is run. modified: test/common.js modified: test/simple/test-net-pipe-connect-errors.js modified: test/testpy/__init__.py modified: test/simple/test-cluster-eaccess.js Reviewed-By: Julien Gilli <julien.gilli@joyent.com> PR-URL: #9381

mhdawson · 2015-03-26T19:23:13Z

landed as 5dd5ce7

tjfontaine added the in progress label Mar 11, 2015

Nodejs-Jenkins added pr v0.12 labels Mar 11, 2015

mhdawson mentioned this pull request Mar 11, 2015

simple testsuite does not tolerate being run in deep file paths. #9334

Closed

cjihrig reviewed Mar 11, 2015
View reviewed changes

mhdawson added this to the 0.12.1 milestone Mar 16, 2015

misterdjules reviewed Mar 17, 2015
View reviewed changes

misterdjules reviewed Mar 25, 2015
View reviewed changes

mhdawson closed this Mar 26, 2015

tjfontaine removed the in progress label Mar 26, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: Environment varible to specify directory for pipes #9381

test: Environment varible to specify directory for pipes #9381

mhdawson commented Mar 11, 2015

cjihrig Mar 11, 2015

cjihrig Mar 11, 2015

misterdjules commented Mar 12, 2015

mhdawson commented Mar 17, 2015

misterdjules Mar 17, 2015

mhdawson Mar 18, 2015

misterdjules commented Mar 20, 2015

mhdawson commented Mar 25, 2015

mhdawson commented Mar 25, 2015

misterdjules Mar 25, 2015

misterdjules commented Mar 25, 2015

mhdawson commented Mar 25, 2015

misterdjules commented Mar 25, 2015

mhdawson commented Mar 25, 2015

mhdawson commented Mar 25, 2015

misterdjules commented Mar 25, 2015

mhdawson commented Mar 26, 2015

mhdawson commented Mar 26, 2015

test: Environment varible to specify directory for pipes #9381

test: Environment varible to specify directory for pipes #9381

Conversation

mhdawson commented Mar 11, 2015

cjihrig Mar 11, 2015

Choose a reason for hiding this comment

cjihrig Mar 11, 2015

Choose a reason for hiding this comment

misterdjules commented Mar 12, 2015

mhdawson commented Mar 17, 2015

misterdjules Mar 17, 2015

Choose a reason for hiding this comment

mhdawson Mar 18, 2015

Choose a reason for hiding this comment

misterdjules commented Mar 20, 2015

mhdawson commented Mar 25, 2015

mhdawson commented Mar 25, 2015

misterdjules Mar 25, 2015

Choose a reason for hiding this comment

misterdjules commented Mar 25, 2015

mhdawson commented Mar 25, 2015

misterdjules commented Mar 25, 2015

mhdawson commented Mar 25, 2015

mhdawson commented Mar 25, 2015

misterdjules commented Mar 25, 2015

mhdawson commented Mar 26, 2015

mhdawson commented Mar 26, 2015