Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix no coverage with globally installed testers on Windows #104

Closed
wants to merge 1 commit into from

Conversation

An-dz
Copy link

@An-dz An-dz commented Aug 30, 2019

This is a try on fixing the bug where nyc does not report coverage data when the test runners are installed globally on Windows. This fixes #1029 on nyc repo.

As I explained on the nyc issue, on Windows the modules "executables" are *.cmd files that check if the node executable is under the same directory and if so they use it instead of the one in PATH.

My solution is to copy those scripts (batch/shell/powershell) to the same temporary directory you guys already use for the node script and modify them to point to their correct module paths. Honestly I fear this solution is too dirty and not fail proof, but has worked fine with both AVA and mocha.

I have tested with cmd and MSYS2/Mintty. I have not tested with local installations of the testers.

CC: @bcoe

@@ -147,6 +147,24 @@ function setup(argv, env) {
fs.writeFileSync(path.join(workingDir, cmdname), shim)
fs.chmodSync(path.join(workingDir, cmdname), '0755')
}
else if (cmdname === 'node') {
const nodePath = path.dirname(process.execPath)
const cmds = JSON.parse(env.NYC_CONFIG)._
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although nyc is a primary user of spawn-wrap it's not the only user. I tend to think it's not appropriate to look at process.env.NYC_CONFIG. CC @bcoe @isaacs any thoughts on this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps instead of copying only the scripts from the process that nyc will use, it should copy all of them so any user of spaw-wrap and even chaining operations (one process calling the other) will work as expected.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If running locally installed testers were a problem this could work, but it's not possible for us to copy every tester installed to the global path. The truth is that manipulation of scripts as done in spawn-wrap is problematic, I fear it's not possible to eliminate 100% of edge cases.

FYI an alternative I'm working on is istanbuljs/nyc#1169. The idea is that this will use environmental variables to wrap child processes. You can test this by running npm install -D git://github.com/coreyfarrell/nyc#set-node-options, then adding --set-node-options=true to your nyc command-line. Keep in mind this has not passed review, is subject to change and once merged that branch will be deleted. As mentioned in a comment on that PR a current issue is that clearing the environment will remove coverage from child processes. I'm working on a solution to that but the PR isn't updated yet.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a fan of the alternative that @coreyfarrell is working on, the copying of all the scripts seems a little bit heavy handed.

@coreyfarrell
Copy link
Member

I appreciate this attempt but I believe spawn-wrap cannot be fixed to work in all situations. I think it's best to work towards sun-setting spawn-wrap in favor of the new approach used by nyc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

NYC output is empty with mocha installed globally
3 participants