Something appears to mess with PATH on Travis Linux when running tests #20

DanTup · 2018-04-05T07:05:03Z

I pushed a repo to Travis that is just the TypeScript extension sample with a travis file that echos the PATH in the Travis script, the npm test script and then also inside the sample test. The values are different. Significantly, the path to node has been removed by the time we get into the tests. In my real project, this means my tests are failing because they use the DebugClient and pass node as the executable.

Here's the code:
https://github.com/DanTup/vscode_extension_path_test

Here's the Travis log:
https://travis-ci.org/DanTup/vscode_extension_path_test/jobs/362281254

Here's the relevant parts:

PATH as output in the travis file:

./node_modules/.bin:/home/travis/bin:/home/travis/.local/bin:/opt/pyenv/shims:/home/travis/.phpenv/shims:/home/travis/perl5/perlbrew/bin:/home/travis/.nvm/versions/node/v8.11.1/bin:/home/travis/.kiex/elixirs/elixir-1.4.5/bin:/home/travis/.kiex/bin:/home/travis/.rvm/gems/ruby-2.4.1/bin:/home/travis/.rvm/gems/ruby-2.4.1@global/bin:/home/travis/.rvm/rubies/ruby-2.4.1/bin:/home/travis/gopath/bin:/usr/local/phantomjs/bin:/usr/local/phantomjs:/usr/local/neo4j-3.2.7/bin:/usr/local/maven-3.5.2/bin:/usr/local/cmake-3.9.2/bin:/usr/local/clang-5.0.0/bin:/home/travis/.gimme/versions/go1.7.4.linux.amd64/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/travis/.rvm/bin:/home/travis/.phpenv/bin:/opt/pyenv/bin:/home/travis/.yarn/bin

PATH as output by prefixing the test script in package.json with echo $PATH:

/home/travis/.nvm/versions/node/v8.11.1/lib/node_modules/npm/node_modules/npm-lifecycle/node-gyp-bin:/home/travis/build/DanTup/vscode_extension_path_test/node_modules/.bin:./node_modules/.bin:/home/travis/bin:/home/travis/.local/bin:/opt/pyenv/shims:/home/travis/.phpenv/shims:/home/travis/perl5/perlbrew/bin:/home/travis/.nvm/versions/node/v8.11.1/bin:/home/travis/.kiex/elixirs/elixir-1.4.5/bin:/home/travis/.kiex/bin:/home/travis/.rvm/gems/ruby-2.4.1/bin:/home/travis/.rvm/gems/ruby-2.4.1@global/bin:/home/travis/.rvm/rubies/ruby-2.4.1/bin:/home/travis/gopath/bin:/usr/local/phantomjs/bin:/usr/local/phantomjs:/usr/local/neo4j-3.2.7/bin:/usr/local/maven-3.5.2/bin:/usr/local/cmake-3.9.2/bin:/usr/local/clang-5.0.0/bin:/home/travis/.gimme/versions/go1.7.4.linux.amd64/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/travis/.rvm/bin:/home/travis/.phpenv/bin:/opt/pyenv/bin:/home/travis/.yarn/bin

PATH as output in tests:

/home/travis/.local/bin:/opt/pyenv/shims:/home/travis/.phpenv/shims:/home/travis/perl5/perlbrew/bin:/home/travis/.kiex/elixirs/elixir-1.4.5/bin:/home/travis/.kiex/bin:/home/travis/.phpenv/shims:/home/travis/gopath/bin:/home/travis/.gimme/versions/go1.7.4.linux.amd64/bin:/usr/local/phantomjs/bin:/usr/local/phantomjs:/usr/local/neo4j-3.2.7/bin:/usr/local/maven-3.5.2/bin:/usr/local/cmake-3.9.2/bin:/usr/local/clang-5.0.0/bin:/home/travis/.gimme/versions/go1.7.4.linux.amd64/bin:/usr/local/phantomjs/bin:/usr/local/phantomjs:/usr/local/neo4j-3.2.7/bin:/usr/local/maven-3.5.2/bin:/usr/local/cmake-3.9.2/bin:/usr/local/clang-5.0.0/bin:/home/travis/.nvm/versions/node/v8.11.1/lib/node_modules/npm/node_modules/npm-lifecycle/node-gyp-bin:/home/travis/build/DanTup/vscode_extension_path_test/node_modules/.bin:./node_modules/.bin:/home/travis/bin:/home/travis/.local/bin:/opt/pyenv/shims:/home/travis/.phpenv/shims:/home/travis/.kiex/elixirs/elixir-1.4.5/bin:/home/travis/.kiex/bin:/home/travis/.rvm/gems/ruby-2.4.1/bin:/home/travis/.rvm/gems/ruby-2.4.1@global/bin:/home/travis/.rvm/rubies/ruby-2.4.1/bin:/home/travis/gopath/bin:/usr/local/phantomjs/bin:/usr/local/phantomjs:/usr/local/neo4j-3.2.7/bin:/usr/local/maven-3.5.2/bin:/usr/local/cmake-3.9.2/bin:/usr/local/clang-5.0.0/bin:/home/travis/.gimme/versions/go1.7.4.linux.amd64/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/travis/.rvm/bin:/home/travis/.phpenv/bin:/opt/pyenv/bin:/home/travis/.yarn/bin:/home/travis/.phpenv/bin:/opt/pyenv/bin

Note that /home/travis/.nvm/versions/node/v8.11.1/bin exists in the first and second, but not the last one (the one from inside the tests).

The text was updated successfully, but these errors were encountered:

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

DanTup · 2018-04-05T07:08:29Z

As a workaround, since I only need to spawn nodejs, I'm just passing process.execPath instead of "node" to the DebugClient.

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

bpasero · 2019-05-29T11:05:07Z

Please reopen if you still see this once https://github.com/microsoft/vscode-docs/blob/vnext/release-notes/v1_35.md#splitting-vscode-package-into-typesvscode-and-vscode-test lands.

DanTup · 2019-05-29T11:45:13Z

Will do!

BTW, it seems like both those new packages exist - is there anything stopping me migrating now? (I'm not sure what needs to land).

Thanks!

bpasero · 2019-05-29T13:17:18Z

@octref can maybe comment who is in charge of these new packages

octref · 2019-05-29T13:40:20Z

Go ahead and let me know issues you run into.

DanTup · 2019-06-05T07:34:51Z

@octref I noticed the info linked above has all been removed from the release notes:

microsoft/vscode-docs@9402e03#diff-0ae46b9ea8531a6a66fe2ed2a836709a

Does this mean it's not safe to go ahead with migrating?

DanTup · 2019-06-05T08:53:11Z

Scratch that, it seems to be working, so I've gone with it (though I'm curious why it was removed from release notes).

@bpasero the original issue here is still present on latest versions of everything and using that package.

It actually somewhat repros locally.. If I run npm run test using the repo I linked above, the PATH is different inside the tests to out. If you run npm run test it prints path before running the tests, because the definition of the test script in package.json is this:

 "test": "echo $PATH && npm run compile && node ./out/test/runTest.js"

Inside the test, I have this:

        console.log("INSIDE TESTS, PATH IS");
        console.log(process.env.PATH);

And the output of the two differs. Inside the test the first three items have been added to the end of PATH and the first two of them removed from the beginning (in this case nothing is lost, but the ordering has changed which is still bad):

Running on Travis Linux, some items are added to the beginning and end, and two items are removed from the middle (one of them is added to the beginning, so possibly removed to be de-duped, but the other is node - the same thing originally reported above):

DanTup · 2019-06-05T08:53:50Z

Here's the Travis log:

https://travis-ci.org/DanTup/vscode_extension_path_test/jobs/541626326

bpasero · 2019-06-05T13:49:30Z

PR welcome, I will not have time to look into this.

bpasero · 2019-06-05T13:49:57Z

@octref please decide if this should move into the vscode-test repository.

DanTup · 2019-06-05T13:51:17Z

I'm not sure I'd know where to start looking - I can't come up with any explanation for what might be happening 🤷‍♂️

It's not critical, I've worked around it by just setting another env variable and then reading from it in the extension, but it's a little weird 🙃

bpasero · 2019-06-05T13:57:39Z

Ok good to know there is a workaround. We can close this issue if no-one jumps on it in the next weeks.

octref · 2019-06-17T04:15:22Z

vscode-test reads from process.env and add any testRunnerEnv if specified:

https://github.com/microsoft/vscode-test/blob/master/lib/runTest.ts#L159-L160

I'm not sure if it's a Travis problem (maybe try Azure Devops?) or npm script limiting the $PATH for it scripts. Can you try cross-env too?

DanTup · 2019-06-19T15:11:53Z

Ok, this is easily reproducible on macOS locally, so it's not Linux specific or Travis specific.

If I mess with my path (eg., push cwd onto the front export PATH=`pwd`:$PATH) and then run code . then the path is correct:

[16:06:57] [General] [Info] Environment PATH:
[16:06:57] [General] [Info]     /Users/dantup/Dev/vscode-repros/vscode_extension_path_test <!--
[16:06:57] [General] [Info]     /Users/dantup/Dev/homebrew/bin
[16:06:57] [General] [Info]     /usr/local/git/current/bin
[16:06:57] [General] [Info]     /usr/local/bin
<snip>
[16:06:57] [General] [Info]     ~/.dotnet/tools
[16:06:57] [General] [Info]     /Users/dantup/.npm-global/bin/

But if I run the way the test runner does (though I've removed the extension/test path since that makes no differences to the outcome):

"/Users/dantup/Dev/vscode-repros/vscode_extension_path_test/.vscode-test/vscode-1.35.1/Visual Studio Code.app/Contents/MacOS/Electron" .

The path is messed up:

[16:07:35] [General] [Info] Environment PATH:
[16:07:35] [General] [Info]     /Users/dantup/Dev/homebrew/bin
[16:07:35] [General] [Info]     /usr/local/git/current/bin
[16:07:35] [General] [Info]     /usr/local/bin
<snip>
[16:07:35] [General] [Info]     ~/.dotnet/tools
[16:07:35] [General] [Info]     /Users/dantup/.npm-global/bin/
[16:07:35] [General] [Info]     /Users/dantup/Dev/vscode-repros/vscode_extension_path_test <-- !!
[16:07:35] [General] [Info]     /Users/dantup/Dev/homebrew/bin

Note that the entry I added is now near the end.

disposedtrolley · 2019-11-21T09:39:48Z

I think I'm getting bitten by this one and would love some advice if possible!

I'm trying to test an extension which spins up a language server via the Executable method upon activation. The executable is an NPM module installed globally and available on the PATH.

During testing the extension fails to start the language server and reports an ENOENT error which I assume is because the executable can't be located on the PATH. I've tried passing through the entirety of process.env when I call runTests() to no avail:

await runTests({
  extensionDevelopmentPath,
  extensionTestsPath,
  extensionTestsEnv: process.env,
  launchArgs: [extensionWorkspacePath, "--disable-extensions"]
});

I'm trying to run the tests on macOS 10.14 locally, and 10.13 on Travis.

DanTup · 2019-11-21T09:48:33Z

I never really got to the bottom of it. I think it may be node/npm messing with the path. My workaround was to use the full path to node when spawning my debug adapter (see Dart-Code/Dart-Code@e4b6fb0) instead of just "node" so it doesn't look in PATH and therefore doesn't get the wrong version. The PATH is still a bit messed up, but it's not being used to resolve anything that has multiple versions anymore so it doesn't cause a problem.

disposedtrolley · 2019-11-21T10:03:29Z

Ahh I see, thanks for the quick response!

I might be able to make that work for testing, but since the language server executable is installed separately by the user, we'd have no control over the actual location of the binary so would need to rely on PATH resolution. I've opened up a new ticket #52 if you're interested in following along!

Meanwhile I might do some more digging to see whether node or NPM are the culprits.

DanTup · 2019-11-21T19:08:59Z

Ah, my fix above only really fixed the ordering (where there were two different node versions).

I did for a while (though I can't remmeber if it was because of this) put my paths into custom env variables, and then updated my extension to scan those locations before PATH.

disposedtrolley · 2019-11-21T22:39:14Z

Oh ok. I think the problem I'm having is that none of the environment variables are being passed through to the test scripts. Even if I explicitly set some random variables, process.env is blank in the test script.

jdneo · 2019-11-22T04:59:03Z

Having the same problem. Before calling runTests({}), the environment variable is correct. But when test session is launched, it seems not picking up those envs although I have passed them in extensionTestsEnv

disposedtrolley · 2019-11-22T05:46:55Z

I managed to get it working! My findings are here - #52 (comment)

jdneo · 2019-11-22T05:56:30Z

Thank you @disposedtrolley,

Yes I just noticed you comment and had a try but still not able to workaround it. Not sure why. Maybe I'm using vscode-test@1.2.0?

octref · 2019-12-11T18:08:44Z

it seems not picking up those envs although I have passed them in extensionTestsEnv

They are passed to cp.spawn. You can do this to see what's happening:

Modify https://github.com/microsoft/vscode-test/blob/master/sample/test/runTest.ts so it only has one runTest, with extensionTestsEnv set
Modify https://github.com/microsoft/vscode-test/blob/master/lib/runTest.ts so it prints the executable, args and fullEnv before this line:

vscode-test/lib/runTest.ts

Line 104 in feaf1b7

const cmd = cp.spawn(executable, args, { env: fullEnv });

I pushed a branch:

Azure DevOps: https://dev.azure.com/vscode/vscode-test/_build/results?buildId=33513
Travis: https://travis-ci.org/microsoft/vscode-test/builds/623793333

DanTup referenced this issue in Dart-Code/Dart-Code Apr 5, 2018

Use full path to nodejs to fix Travis tests

e4b6fb0

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

DanTup referenced this issue in Dart-Code/Dart-Code Apr 5, 2018

Use full path to nodejs to fix Travis tests

99f9d3f

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

DanTup referenced this issue in Dart-Code/Dart-Code Apr 5, 2018

Use full path to nodejs to fix Travis tests

65c6947

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

DanTup referenced this issue in Dart-Code/Dart-Code Apr 5, 2018

Use full path to nodejs to fix Travis tests

c313b30

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

DanTup referenced this issue in Dart-Code/Dart-Code Apr 5, 2018

Use full path to nodejs to fix Travis tests

c1123c9

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

DanTup referenced this issue in Dart-Code/Dart-Code Apr 5, 2018

Use full path to nodejs to fix Travis tests

8f84506

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

bpasero self-assigned this Apr 6, 2018

DanTup referenced this issue in Dart-Code/Dart-Code Apr 16, 2018

Use full path to nodejs to fix Travis tests

5e880ef

This is a workaround for the PATH being messed up (see https://github.com/Microsoft/vscode-extension-vscode/issues/104).

bpasero closed this as completed May 29, 2019

bpasero reopened this Jun 5, 2019

bpasero assigned octref Jun 5, 2019

octref transferred this issue from microsoft/vscode-extension-vscode Jun 17, 2019

octref unassigned bpasero Jun 17, 2019

octref added this to the June 2019 milestone Jun 17, 2019

octref modified the milestones: June 2019, July 2019 Jul 24, 2019

octref modified the milestones: July 2019, August 2019 Aug 6, 2019

octref modified the milestones: August 2019, November 2019 Nov 20, 2019

disposedtrolley mentioned this issue Nov 21, 2019

Environment variables and PATH not passing through in 1.2.3 #52

Closed

octref modified the milestones: November 2019, December/January 2020 Dec 11, 2019

octref removed this from the December/January 2020 milestone Feb 3, 2020

Tyriar unassigned octref Dec 10, 2021

ybiquitous mentioned this issue May 21, 2023

Fix shell workaround ruby/vscode-typeprof#103

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Something appears to mess with PATH on Travis Linux when running tests #20

Something appears to mess with PATH on Travis Linux when running tests #20

DanTup commented Apr 5, 2018

DanTup commented Apr 5, 2018

bpasero commented May 29, 2019

DanTup commented May 29, 2019

bpasero commented May 29, 2019 •

edited

octref commented May 29, 2019

DanTup commented Jun 5, 2019

DanTup commented Jun 5, 2019

DanTup commented Jun 5, 2019

bpasero commented Jun 5, 2019

bpasero commented Jun 5, 2019

DanTup commented Jun 5, 2019

bpasero commented Jun 5, 2019

octref commented Jun 17, 2019

DanTup commented Jun 19, 2019 •

edited

disposedtrolley commented Nov 21, 2019 •

edited

DanTup commented Nov 21, 2019

disposedtrolley commented Nov 21, 2019

DanTup commented Nov 21, 2019

disposedtrolley commented Nov 21, 2019

jdneo commented Nov 22, 2019

disposedtrolley commented Nov 22, 2019

jdneo commented Nov 22, 2019

octref commented Dec 11, 2019

Something appears to mess with PATH on Travis Linux when running tests #20

Something appears to mess with PATH on Travis Linux when running tests #20

Comments

DanTup commented Apr 5, 2018

DanTup commented Apr 5, 2018

bpasero commented May 29, 2019

DanTup commented May 29, 2019

bpasero commented May 29, 2019 • edited

octref commented May 29, 2019

DanTup commented Jun 5, 2019

DanTup commented Jun 5, 2019

DanTup commented Jun 5, 2019

bpasero commented Jun 5, 2019

bpasero commented Jun 5, 2019

DanTup commented Jun 5, 2019

bpasero commented Jun 5, 2019

octref commented Jun 17, 2019

DanTup commented Jun 19, 2019 • edited

disposedtrolley commented Nov 21, 2019 • edited

DanTup commented Nov 21, 2019

disposedtrolley commented Nov 21, 2019

DanTup commented Nov 21, 2019

disposedtrolley commented Nov 21, 2019

jdneo commented Nov 22, 2019

disposedtrolley commented Nov 22, 2019

jdneo commented Nov 22, 2019

octref commented Dec 11, 2019

bpasero commented May 29, 2019 •

edited

DanTup commented Jun 19, 2019 •

edited

disposedtrolley commented Nov 21, 2019 •

edited