coveralls - npm Package Compare versions

Comparing version 2.0.13 to 2.0.15

index.js

@@ -9,2 +9,2 @@ var dir = './lib/';
 exports.handleInput = require(dir + 'handleInput');
-
+exports.logger = require(dir + 'logger');

lib/convertLcovToCoveralls.js

@@ -5,3 +5,3 @@ var TRAVIS_JOB_ID = process.env.TRAVIS_JOB_ID || 'unknown';
 var path = require('path');
-var logger = require('./logger');
+var logger = require('./logger')();
 
@@ -31,4 +31,3 @@ var detailsToCoverage = function(length, details){
 var convertLcovToCoveralls = function(input, options, cb){
-  var repo_token = options.repo_token,
-      filepath = options.filepath || '';
+  var filepath = options.filepath || '';
   logger.debug("in: ", filepath);
@@ -47,8 +46,17 @@ if (filepath[0] !== '/'){
     };
-    if (repo_token) {
-      postJson.repo_token = repo_token;
-    } else {
-      postJson.service_job_id = TRAVIS_JOB_ID;
-      postJson.service_name = 'travis-ci';
+    if (options.git){
+      postJson.git = options.git;
     }
+    if (options.run_at){
+      postJson.run_at = options.run_at;
+    }
+    if (options.service_name){
+      postJson.service_name = options.service_name;
+    }
+    if (options.service_job_id){
+      postJson.service_job_id = options.service_job_id;
+    }
+    if (options.repo_token) {
+      postJson.repo_token = options.repo_token;
+    }
     parsed.forEach(function(file){
@@ -55,0 +63,0 @@ postJson.source_files.push(convertLcovFileObject(file, filepath));

lib/getOptions.js

 var fs = require('fs');
 var path = require('path');
 var yaml = require('yaml');
-var logger = require('./logger');
+var logger = require('./logger')();
 
@@ -20,2 +20,18 @@ var getOptions = function(){
 
+  if (process.env.COVERALLS_GIT){
+    options.git = process.env.COVERALLS_GIT;
+  }
+  if (process.env.COVERALLS_SERVICE_JOB_ID){
+    options.service_job_id = process.env.COVERALLS_SERVICE_JOB_ID;
+  }
+
+  options.run_at = process.env.COVERALLS_RUN_AT || JSON.stringify(new Date()).slice(1, -1);
+  if (process.env.COVERALLS_SERVICE_NAME){
+    options.service_name = process.env.COVERALLS_SERVICE_NAME;
+  }
+  if (process.env.TRAVIS){
+    options.service_name = 'travis-ci';
+    options.service_job_id = process.env.TRAVIS_JOB_ID;
+  }
+
 	// try to get the repo token as an environment variable
@@ -29,3 +45,4 @@ if (process.env.COVERALLS_REPO_TOKEN) {
       if (fs.statSync(yml).isFile()) {
-        options.repo_token = yaml.eval(fs.readFileSync(yml, 'utf8')).repo_token;
+				var evaluate = 'eval';  // hack for jshint
+        options.repo_token = yaml[evaluate](fs.readFileSync(yml, 'utf8')).repo_token;
       }
@@ -32,0 +49,0 @@ } catch(ex){

lib/handleInput.js

 var index = require('../index');
-var logger = require('./logger');
+var logger = require('./logger')();
 
@@ -4,0 +4,0 @@ var handleInput = function(input){

lib/logger.js

@@ -1,9 +0,8 @@
-var logger = require('log-driver')({level : 'warn'});
-
-if (process.argv[2]) {
-  if (~['-v', '--verbose'].indexOf(process.argv[2])) {
-    logger = require('log-driver')({level : 'debug'});
+module.exports = function(){
+  if (process.argv[2]) {
+    if (~['-v', '--verbose'].indexOf(process.argv[2])) {
+      return require('log-driver')({level : 'debug'});
+    }
   }
-}
-
-module.exports = logger;
+  return require('log-driver')({level : 'warn'});
+};

package.json

@@ -8,3 +8,3 @@ {
   ],
-  "version": "2.0.13",
+  "version": "2.0.15",
   "bugs": {
@@ -14,3 +14,3 @@ "url": "https://github.com/cainus/node-coveralls/issues"
   "scripts": {
-    "test": "make test-coveralls"
+    "test": "make test"
   },
@@ -27,2 +27,3 @@ "bin": {
     "elliotcable <[e-mail]> (http://elliottcable.name/)",
+    "Slotos <[e-mail]> (http://slotos.net)",
     "Arpad Borsos <[e-mail]> (http://swatinem.de/)"
@@ -41,3 +42,4 @@ ],
     "should": "1.1.0",
-    "jscoverage": "0.3.7"
+    "jscoverage": "0.3.7",
+    "jshint": "2.1.3"
   },
@@ -44,0 +46,0 @@ "engines": {

README.md

@@ -5,5 +5,6 @@ #node-coveralls
 
-[Coveralls.io](https://coveralls.io/) support for node.js.  Get the great coverage reporting of coveralls.io and add a cool coverage button ( like this: ![](https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_94.png) ) to your README.
+[Coveralls.io](https://coveralls.io/) support for node.js.  Get the great coverage reporting of coveralls.io and add a cool coverage button ( like the one above ) to your README.
 
-Installation: Add the latest version of `coveralls` to your package.json:
+##Installation: 
+Add the latest version of `coveralls` to your package.json:
 ``` 
@@ -13,8 +14,27 @@ npm install coveralls --save
 
+If you're using mocha, add `mocha-lcov-reporter` to your package.json:
+``` 
+npm install mocha-lcov-reporter --save 
+```
+
+##Usage:
+
 This script ( `bin/coveralls.js` ) can take standard input from any tool that emits the lcov data format (including [mocha](http://visionmedia.github.com/mocha/)'s [LCov reporter](https://npmjs.org/package/mocha-lcov-reporter)) and send it to coveralls.io to report your code coverage there.
 
+Once your app is instrumented for coverage, and building, you just need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
+
+###[Blanket.js](https://github.com/alex-seville/blanket)
+- Install [blanket.js](http://blanketjs.org/)
+- Configure blanket according to [docs](https://github.com/alex-seville/blanket/blob/master/docs/getting_started_node.md).
+- Run your tests with a command like this:
+
+```sh
+NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \
+  --require blanket \
+  --reporter mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js
+```
+###[JSCoverage](https://github.com/fishbar/jscoverage)
+
 Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://www.seejohncode.com/2012/03/13/setting-up-mocha-jscoverage/) or [here](http://tjholowaychuk.com/post/18175682663/mocha-test-coverage)), but that's also a necessary step. 
 
-Once your app is instrumented for coverage, and building, you just need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
-
 In mocha, if you've got your code instrumented for coverage, the command for a travis build would look something like this:
@@ -24,6 +44,11 @@ ```console
 ```
+Check out an example [Makefile](https://github.com/cainus/urlgrey/blob/master/Makefile) from one of my projects for an example, especially the test-coveralls build target.  Note: Travis runs `npm test`, so whatever target you create in your Makefile must be the target that `npm test` runs (This is set in package.json's 'scripts' property).
 
-If you're running locally, you must have a `.coveralls.yml` file, as documented in their documentation, with your `repo_token` in it; or, you must provide a `COVERALLS_REPO_TOKEN` environment-variable on the command-line.
+##[Istanbul](https://github.com/gotwarlost/istanbul)
+TODO
 
-Check out an example [Makefile](https://github.com/cainus/urlgrey/blob/master/Makefile) from one of my projects for an example, especially the test-coveralls build target.  Note: Travis runs `npm test`, so whatever target you create in your Makefile must be the target that `npm test` runs (This is set in package.json's 'scripts' property).
+## Running locally
 
+If you're running locally, you must have a `.coveralls.yml` file, as documented in [their documentation](https://coveralls.io/docs/ruby), with your `repo_token` in it; or, you must provide a `COVERALLS_REPO_TOKEN` environment-variable on the command-line.
+
+

test/convertLcovToCoveralls.js

 var convertLcovToCoveralls = require('../index').convertLcovToCoveralls;
+var getOptions = require('../index').getOptions;
 var should = require('should');
@@ -22,2 +23,20 @@ var fs = require('fs');
 
+  it ("should pass on all appropriate parameters from the environment", function(){
+    process.env.TRAVIS_JOB_ID = -1;
+    process.env.COVERALLS_GIT = "GIT_HASH";
+    process.env.COVERALLS_SERVICE_NAME = "SERVICE_NAME";
+    process.env.COVERALLS_SERVICE_JOB_ID = "SERVICE_JOB_ID";
+    process.env.COVERALLS_REPO_TOKEN = "REPO_TOKEN";
+    
+    var options = getOptions();
+    var path = __dirname + "/../fixtures/onefile.lcov";
+    var input = fs.readFileSync(path, "utf8");
+    var libpath = "fixtures/lib";
+    options.filepath = libpath;
+    convertLcovToCoveralls(input, options, function(err, output){
+      should.not.exist(err);
+      console.log(output);
+      //output.git.should.equal("GIT_HASH");
+    });
+  });
   it ("should work with a relative path as well", function(){
@@ -24,0 +43,0 @@ process.env.TRAVIS_JOB_ID = -1;

test/getOptions.js

@@ -5,2 +5,5 @@ var should = require('should');
 describe("getOptions", function(){
+  beforeEach(function(){
+    process.env = {};
+  });
   it ("should get a filepath if there is one", function(){
@@ -15,5 +18,26 @@ process.argv[2] = "somepath";
     getOptions().filepath.should.equal("somepath");
-  
   });
+  it ("should set service_job_id if it exists", function(){
+    process.env.COVERALLS_SERVICE_JOB_ID = "SERVICE_JOB_ID";
+    getOptions().service_job_id.should.equal("SERVICE_JOB_ID");
+  });
+  it ("should set git if it exists", function(){
+    process.env.COVERALLS_GIT = "qwer";
+    getOptions().git.should.equal("qwer");
+  });
+  it ("should set repo_token if it exists", function(){
+    process.env.COVERALLS_REPO_TOKEN = "REPO_TOKEN";
+    getOptions().repo_token.should.equal("REPO_TOKEN");
+  });
+  it ("should set service_name if it exists", function(){
+    process.env.COVERALLS_SERVICE_NAME = "SERVICE_NAME";
+    getOptions().service_name.should.equal("SERVICE_NAME");
+  });
+  it ("should set service_name and service_job_id if it's running on travis-ci", function(){
+    process.env.TRAVIS = "TRUE";
+    process.env.TRAVIS_JOB_ID = "1234";
+    getOptions().service_name.should.equal("travis-ci");
+    getOptions().service_job_id.should.equal("1234");
+  });
 
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 6 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

179068

increased by2.17%

Number of package files

21

increased by5%

Lines of code

6120

increased by1.29%

Number of lines in readme file

52

increased by92.59%

Worsened metrics

Dev dependency count

6

increased by20%

Number of low supply chain risk alerts

36

increased by157.14%

No dependency changes