Istanbul: Windows support

Created on 19 Oct 2012 · 49Comments · Source: gotwarlost/istanbul

My istanbul cover commands fail on windows, but the vows --spec ./test/foo.js works fine.

I get this error:

YUI@WINDOWS7 ~/Desktop/play/cpr (master)
$ npm test

> [email protected] pretest c:\Users\YUI\Desktop\play\cpr
> jshint --config ./node_modules/yui-lint/jshint.json ./lib/


> [email protected] test c:\Users\YUI\Desktop\play\cpr
> istanbul cover --print both -- vows --spec ./tests/full.js


c:\Users\YUI\Desktop\play\cpr\node_modules\.bin\vows.CMD:1
(function (exports, require, module, __filename, __dirname) { :: Created by np
                                                              ^
Unexpected token :
SyntaxError: Unexpected token :
    at Module._compile (module.js:437:25)
    at Module._extensions..js (module.js:467:10)
    at Object.Module._extensions..js (c:\Users\YUI\Desktop\play\cpr\node_modules
\istanbul\lib\hook.js:101:13)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:492:10)
    at runFn (c:\Users\YUI\Desktop\play\cpr\node_modules\istanbul\lib\command\co
mmon\run-with-cover.js:80:16)
    at c:\Users\YUI\Desktop\play\cpr\node_modules\istanbul\lib\command\common\ru
n-with-cover.js:148:17
    at c:\Users\YUI\Desktop\play\cpr\node_modules\istanbul\lib\util\file-matcher
.js:52:16
    at c:\Users\YUI\Desktop\play\cpr\node_modules\istanbul\lib\util\file-matcher
.js:35:9
No coverage information was collected, exit without writing coverage information

npm ERR! Test failed.  See above for more details.
npm ERR! not ok code 0

YUI@WINDOWS7 ~/Desktop/play/cpr (master)
$

For reference, that vows is running:

YUI@WINDOWS7 ~/Desktop/play/cpr (master)
$ ./node_modules/.bin/vows --spec ./tests/full.js

  ♢ CPR Tests

  should be loaded
    ✓ should have cpr method
  should fail on non-existant from dir
    ✓ should return an error in the callback
  should be loaded and should NOT copy node_modules
    ✓ does not have ./out/1
    ✓ and threw an error
  should be loaded and should not copy graceful-fs from function
    ✓ and has ./out/3
    ✓ and dirs are not equal
    ✓ and from directory has graceful-fs dir
    ✓ and to directory does not have graceful-fs dir
  should be loaded and should copy node_modules
    ✓ has ./out/0
    ✓ and dirs are equal
    ✓ and from directory has graceful-fs dir
    ✓ and to directory has graceful-fs dir
  should be loaded and should not copy yui-lint from regex
    ✓ and has ./out/2
    ✓ and dirs are not equal
    ✓ and from directory has yui-lint dir
    ✓ and to directory does not have yui-lint dir
  should be loaded and should copy node_modules with overwrite flag
    ✓ has ./out/0
    ✓ and dirs are equal
    ✓ and from directory has graceful-fs dir
    ✓ and to directory has graceful-fs dir

✓ OK » 20 honored (10.885s)


YUI@WINDOWS7 ~/Desktop/play/cpr (master)
$

Source

davglass

👍2

Most helpful comment

See my previous comment, reproduced for your benefit:

so the "magic" expansion of commands to JS files only works on Mac/ Unix because the executable files directly resolve to the JS files that have shebangs in them.

On windows, you need to actually pass the JS file name that the mocha command uses, since in that environment the commands resolve to batch files and not JS files.

gotwarlost on 10 Jan 2014

❤4 👍3

All 49 comments

Something screwy with the colon character in the path name that is confusing istanbul.

Damn, I wish I had an easy way to reproduce windows issues. Do you have a VM or something I can use to play with this.

Windows is the biggest gap in tests for istanbul

gotwarlost on 19 Oct 2012

I have a personal Windows 7 VM that I have setup with Node and git, but nothing that I can share as its in my server closet in IL ;)

davglass on 19 Oct 2012

Could you run istanbul cover -v and paste the output just in case there is any additional info to be had from verbose logging?

gotwarlost on 19 Oct 2012

The output of -v is exactly the same as above.

davglass on 19 Oct 2012

Ok, here's some info for you.

If I change my test script to:

istanbul --cover -v --print both -- ./node_modules/vows/bin/vows --spec ./tests/full.js

From:

istanbul --cover -v --print both -- vows --spec ./tests/full.js

It works.

On Windows, the ./node_modules/.bin/vows.cmd is a windows bat script. So istanbul needs to know how to deal with that.

davglass on 19 Oct 2012

Thanks for the info. This is going to be really tricky, if not impossible....

Bascially, the "command processing" is done using node-which and the result of this operation is assumed to be a JS file that is passed directly to the module loader as in: Module.runMain(file).

gotwarlost on 19 Oct 2012

Also, off-topic - does the HTML reporting work correctly on Windows? I don't have a single test for this and it's the reporting that has path-delimiter specific code.

gotwarlost on 19 Oct 2012

Yeah, I figured as much. If I have some time, I may see what I can come up with to help out since I have a fully functional windows dev environment here.

davglass on 19 Oct 2012

The reporting works and looks ok. It renders all the / in the HTML as \, which just doesn't quite look right to me. Besides, the reports should be pretty close to exact no matter what system they are generated on. (thinking about coverage files that are checked into source control).

davglass on 19 Oct 2012

Let me work on getting a Windows machine up and running - I think I'll pinch my son's machine for this. Totally agree that everything should work the same on windows.

gotwarlost on 19 Oct 2012

Everything seems to be working ok on Windows, but I have one small question:

Say I have the following folder structure:

lib/

lib1.js
lib2.js

tests/

lib1.js
lib2.js

index.js (main file that requires all the tests)

If I run istanbul cover index.js besides the coverage\ folder it creates .html files in lib/ and a index.html && index.js.html file inside the root.

The main html coverage stats file is in coverage\, but shouldn't the rest also be there... ? (I haven't had time to test the library in OSX / Ubuntu yet to see if it's the same there).

I really hate having all those .html files laying around everywhere. Thanks

@gotwarlost @davglass

alessioalex on 13 Dec 2012

Ok followup: so normally istanbul should put the html files inside /coverage/lcov-report/ (and specific files inside the folder ProjectName).

The thing is in Windows it only puts /coverage/lcov-report/index.html there, the rest of the html files are dispersed all over the place (wherever there's a covered_test_file.js it will put the html in the same folder).

More details about my setup: Windows 7 and:

$ node -v && npm -v
v0.6.11
1.1.1

Anyway, I'm happy it works in OSX/Linux :D

alessioalex on 13 Dec 2012

Can you install the latest node on Windows and check it against that first? 0.6.11 is quite old ;)

davglass on 13 Dec 2012

Anyone else still having problems in Windows? I still get that same kind of error like this:

c:\Users\JGough\AppData\Roaming\npm\_mocha.CMD:1
(function (exports, require, module, __filename, __dirname) { :: Created by np
                                                              ^
SyntaxError: Unexpected token :
    at Module._compile (module.js:437:25)
    at Module._extensions..js (module.js:467:10)
    at Object.Module._extensions..js (c:\Users\JGough\AppData\Roaming\npm\node_m
odules\istanbul\lib\hook.js:101:13)

JogoShugh on 20 May 2013

ok, so the "magic" expansion of commands to JS files only works on Mac/ Unix because the executable files directly resolve to the JS files that have shebangs in them.

On windows, you need to actually pass the JS file name that the mocha command uses, since in that environment the commands resolve to batch files and not JS files.

gotwarlost on 20 May 2013

Hmm.. well, I'm installing a linux vm irght now :-P

But, I tried this too:

istanbul cover test.js

And it told me it could not find 'describe'. So, I assume I somehow have to include mocha in the command.

$ istanbul cover test.js

c:\Projects\v1.NETSdk.GitHub\Versionone.AppCatalog.Web.Git\VersionOne.AppCatalog
.Web\test.js:6
;var should=require('should');__cov_xnGr93WTzh3NigP_PMZaIQ.s['3']++;describe('
                                                                    ^
ReferenceError: describe is not defined
    at Object.<anonymous> (c:\Projects\v1.NETSdk.GitHub\Versionone.AppCatalog.We
b.Git\VersionOne.AppCatalog.Web\test.js:6:194)
    at Object.<anonymous> (c:\Projects\v1.NETSdk.GitHub\Versionone.AppCatalog.We
b.Git\VersionOne.AppCatalog.Web\test.js:6:406)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (c:\Users\JGough\AppData\Roaming\npm\node_m
odules\istanbul\lib\hook.js:99:20)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:492:10)
    at runFn (c:\Users\JGough\AppData\Roaming\npm\node_modules\istanbul\lib\comm
and\common\run-with-cover.js:86:16)
    at c:\Users\JGough\AppData\Roaming\npm\node_modules\istanbul\lib\command\com
mon\run-with-cover.js:185:17
    at c:\Users\JGough\AppData\Roaming\npm\node_modules\istanbul\lib\util\file-m
atcher.js:52:16

JogoShugh on 21 May 2013

right - describe is added as a global by mocha.

gotwarlost on 21 May 2013

@JogoShugh @gotwarlost I ran into the issue with describe is not defined when running mocha. My solution was to update the mocha dependency to the latest version (1.13.0 at the time of writing).

paulbjensen on 3 Nov 2013

When trying to run istanbul using istanbul cover _mocha -- -u exports -R spec on my project, I get the following error:

(function (exports, require, module, __filename, __dirname) { @IF EXIST "%~dp0
                                                              ^
No coverage information was collected, exit without writing coverage information
SyntaxError: Unexpected token ILLEGAL
    at Module._compile (module.js:439:25)
    at Module._extensions..js (module.js:474:10)
    at Object.Module._extensions..js (C:\Users\Sony\AppData\Roaming\npm\node_modules\istanbul\lib\hook.js:101:13)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at runFn (C:\Users\Sony\AppData\Roaming\npm\node_modules\istanbul\lib\command\common\run-with-cover.js:110:16)
    at C:\Users\Sony\AppData\Roaming\npm\node_modules\istanbul\lib\command\common\run-with-cover.js:213:17
    at C:\Users\Sony\AppData\Roaming\npm\node_modules\istanbul\lib\util\file-matcher.js:52:16
    at C:\Users\Sony\AppData\Roaming\npm\node_modules\istanbul\lib\util\file-matcher.js:35:9

I've updated mocha to the latest version and everything works fine and all tests pass. Any idea what could be causing this?

johanneslumpe on 9 Jan 2014

See my previous comment, reproduced for your benefit:

so the "magic" expansion of commands to JS files only works on Mac/ Unix because the executable files directly resolve to the JS files that have shebangs in them.

On windows, you need to actually pass the JS file name that the mocha command uses, since in that environment the commands resolve to batch files and not JS files.

gotwarlost on 10 Jan 2014

❤4 👍3

@gotwarlost Thanks for the response. I just skimmed through the thread - silly me. Sorry for the inconvenience!

johanneslumpe on 10 Jan 2014

I didn't understand at all what @gotwarlost was saying, since file expansion could apply to istanbul or mocha, but then I saw @mscdex link an issue that contains a PR with the actual fix. Posting here if anyone else was confused:

https://github.com/component/path-to-regexp/pull/29/files

tbranyen on 11 Jul 2014

@gotwarlost Could the "magic" expansion be fixed if you added a command line flag to trigger a lookup through the module loader?

Add a flag that is used like this:

istanbul cover --bin <package>[/<command>] --

Which transforms the parameter in a manner similar to this:

var path = require('path');
function lookupBinPath(inputCommandName) {
    var parts = inputCommandName.split('/');
    var packageName = parts[0], commandName = parts[1];
    // If no slash is present, look for a command with the same name as the package
    if (commandName == undefined) commandName = packageName;
    // Look up the package.json
    var packageJSON = require(packageName+'/package.json');
    //Extract the binary path
    var relativeBinaryPath = packageJSON.bin[commandName];
    // prepend the module name and pass it to require.resolve 
    return require.resolve(path.join(packageName, relativeBinaryPath));
}

gamefreak on 26 Nov 2014

I am using this command
istanbul cover C:\Users\abhisek.user\AppData\Roaming\npm\node_modules\mocha\bin_mocha test
But it is giving this as out put and not generating the report.
Transformation error; return original code
[TypeError: Object #

Istanbul: Windows support

Most helpful comment

All 49 comments

Related issues