Initial Commit

Author: muhammaddadu

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+npm-debug.log
+tmp

Gruntfile.js

@@ -0,0 +1,64 @@
+/*
+ * grunt-appc-coverage
+ * 
+ *
+ * Copyright (c) 2015 Appcelerator
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+module.exports = function (grunt) {
+  // load all npm grunt tasks
+  require('load-grunt-tasks')(grunt);
+
+  // Project configuration.
+  grunt.initConfig({
+
+    mochaTest: {
+      options: {
+        timeout: 3000,
+        reporter: 'spec',
+        ignoreLeaks: false
+      },
+      unit: {
+        src: ['test/**/*_test.js']
+      },
+    },
+
+    appcJs: {
+      src: ['lib/**/*.js']
+    },
+
+    // Before generating any new files, remove any previously-created files.
+    clean: {
+      tests: ['tmp']
+    },
+
+    kahvesi: { src: ['test/**/*_test.js'] },
+
+    // Configuration to be run (and then tested).
+    appc_coverage: {
+      default_options: {
+        src: 'coverage/lcov.info',
+        force: true
+      }
+    },
+
+  });
+
+  // Actually load this plugin's task(s).
+  grunt.loadTasks('tasks');
+
+  grunt.loadNpmTasks('grunt-kahvesi');
+  grunt.loadNpmTasks('grunt-mocha-test');
+  grunt.loadNpmTasks('grunt-appc-js');
+
+  // Whenever the "test" task is run, first clean the "tmp" dir, then run this
+  // plugin's task(s), then test the result.
+  grunt.registerTask('test', ['clean', 'appcJs','mochaTest:unit', 'kahvesi', 'appc_coverage']);
+
+  // By default, lint and run all tests.
+  grunt.registerTask('default', ['jshint', 'appcJs','mochaTest:unit']);
+
+};

README.md

@@ -0,0 +1,40 @@
+# grunt-appc-coverage
+
+> Grunt task to load coverage results and submit them to coverage.appcelerator.com
+
+## Getting Started
+This plugin requires Grunt.
+
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
+
+```shell
+npm install grunt-appc-coverage --save-dev
+```
+
+Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+
+```js
+grunt.loadNpmTasks('grunt-appc-coverage');
+```
+
+## The "appc_coverage" task
+
+### Overview
+In your project's Gruntfile, add a section named `appc_coverage` to the data object passed into `grunt.initConfig()`.
+
+```js
+grunt.initConfig({
+  appc_coverage: {
+    default_options: {
+      src: ['paths', 'to', 'js', 'files'],
+      force: true
+    }
+  }
+})
+```
+
+## Contributing
+Add unit tests for any new or changed functionality. Run npm test to ensure your added code matches existing style standards.
+
+## License
+Copyright (c) 2015 Appcelerator. Licensed under the MIT license.

lib/appc-coverage.js

@@ -0,0 +1,76 @@
+/*
+ * grunt-appc-coverage
+ *
+ *
+ * Copyright (c) 2015 Appcelerator
+ * Licensed under the MIT license.
+ */
+
+var request = require('request'),
+	parse = require('lcov-parse');
+
+const
+	SUCCESS_UPLOAD = 'Successfully submitted coverage results to coverage.appcelerator.com',
+	FAILED_UPLOAD = 'Failed to submit coverage results to coverage.appcelerator.com',
+	SERVER = 'http://localhost:8080/v1';
+
+/**
+ * Get enviromental options such as service and git
+ */
+exports.getOptions = function () {
+	var options = {
+		service: {
+			name: 'grunt-appc-coverage',
+			jobId: null
+		},
+		git: {
+			commit: null,
+			branch: null,
+			pullRequest: null,
+			fullName: null
+		}
+	};
+
+	if (process.env.TRAVIS) {
+		// service
+		options.service.name = 'travis-ci';
+		options.service.jobId = process.env.TRAVIS_JOB_ID;
+		// git info
+		options.git.commit = process.env.TRAVIS_COMMIT;
+		options.git.branch = process.env.TRAVIS_BRANCH;
+		options.git.pullRequest = process.env.TRAVIS_PULL_REQUEST;
+		options.git.fullName = process.env.TRAVIS_REPO_SLUG;
+	}
+
+	return options;
+};
+
+/**
+ * Parse Lcov into something processable
+ */
+exports.parseLcov = function (lcovString, callback) {
+	parse(lcovString, function (err, data) {
+		//process the data here
+		callback(err, data);
+	});
+};
+
+/**
+ * Upload the data to the coverage server
+ */
+exports.upload = function (data, callback) {
+	request.post({
+		url : SERVER + '/coverage',
+		form : {
+			type : 'grunt-appc-coverage',
+			data: data
+		},
+		json: true
+	}, function (err, response, body) {
+		if (response.statusCode === 500 || err || body.hasOwnProperty('error')) {
+			return callback(FAILED_UPLOAD);
+		}
+
+		return callback(null, SUCCESS_UPLOAD);
+	});
+};

package.json

@@ -0,0 +1,44 @@
+{
+  "name": "grunt-appc-coverage",
+  "version": "0.1.0",
+  "description": "Grunt task to load coverage results and submit them to coverage.appcelerator.com",
+  "repository": "https://github.com/appcelerator-modules/grunt-appc-coverage",
+  "author": {
+    "name": "Muhammad Dadu",
+    "email": "[email protected]"
+  },
+  "bugs": {
+    "url": "https://github.com/appcelerator-modules/grunt-appc-coverage/issues"
+  },
+  "keywords": [
+    "gruntplugin",
+    "coverage",
+    "appcelerator"
+  ],
+  "main": "Gruntfile.js",
+  "engines": {
+    "node": ">= 0.8.0"
+  },
+  "license": "MIT",
+  "dependencies": {    
+    "load-grunt-tasks": "~0.3.0",
+    "grunt-appc-js": "*",
+    "grunt-kahvesi": "git://github.com/appcelerator-modules/grunt-kahvesi.git",
+    "grunt-mocha-test": "^0.12.7",
+    "mocha": "^2.1.0",
+    "unit.js": "*",
+    "request": "~2.53.0",
+    "lcov-parse": "0.0.9"
+  },
+  "devDependencies": {
+    "grunt-cli": "*",
+    "grunt-bump": "^0.3.0",
+    "grunt-contrib-clean": "^0.5.0"
+  },
+  "peerDependencies": {
+    "grunt": "~0.4.5"
+  },
+  "scripts": {
+    "test": "grunt test"
+  }
+}

tasks/appc_coverage.js

@@ -0,0 +1,78 @@
+/*
+ * grunt-appc-coverage
+ * 
+ *
+ * Copyright (c) 2015 Appcelerator
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+var NOT_FOUND = 'No src files could be found for coverage.appcelerator.com';
+
+var coverage = require('../lib/appc-coverage');
+
+module.exports = function (grunt) {
+
+  function appcCoverage() {
+  // Force task into async mode and grab a handle to the "done" function.
+    var done = this.async(),
+      force = this.options().force || this.data.force || false,
+      filesProcessed = 0;
+
+    if (this.filesSrc.length === 0) {
+      if (force) {
+        grunt.log.warn(NOT_FOUND);
+        return done();
+      }
+
+      grunt.log.error(NOT_FOUND);
+      return done(false);
+    }
+    for (var i = 0, max = this.filesSrc.length; i < max; i++) {
+      processFile(this.filesSrc[i], function (err, status) {
+        // increment
+        filesProcessed++;
+        // check for error
+        if (err && !force) {
+          grunt.log.error(err);
+          return done(false);
+        } else if (err) {
+          // warn
+          grunt.log.warn(err);
+        } else {
+          // log status
+          grunt.log.ok(status);
+        }
+
+        // Check if all the files are processed
+        if (filesProcessed === max) {
+          return done();
+        }
+      });
+    }
+  }
+
+  function processFile(coverageFile, callback) {
+    // Check if file exists
+    if (!grunt.file.exists(coverageFile)) {
+      return callback(NOT_FOUND);
+    }
+
+    var objectToUpload = {};
+    // Get options
+    objectToUpload.options = coverage.getOptions();
+    // parse Lcov
+    coverage.parseLcov( grunt.file.read(coverageFile), function (err, data) {
+      if (err) {
+        return callback(err);
+      }
+      objectToUpload.coverage = data;
+      // Upload Data
+      coverage.upload(objectToUpload, callback);
+    });
+  }
+
+  grunt.registerMultiTask('appc_coverage', 'Grunt task to load coverage results and submit them to coverage.appcelerator.com', appcCoverage);
+
+};

test/appc_coverage_test.js

@@ -0,0 +1,22 @@
+var test = require('unit.js'),
+    coverage = require('../lib/appc-coverage.js'),
+    fs = require('fs');
+
+describe('library', function () {
+    it('coverage.getOptions();', function () {
+        var options = coverage.getOptions();
+
+        test.object(options)
+            .hasProperty('service')
+            .hasProperty('git');
+    });
+
+    it('coverage.parseLcov();', function (done) {
+        var lcovString = fs.readFileSync('./test/fixtures/lcov.info').toString();
+        coverage.parseLcov(lcovString, function(err, data) {
+            test.assert(err == null, err);
+            test.assert(JSON.stringify(data) === fs.readFileSync('./test/expected/coverage.txt').toString(), 'Files did not match');
+            done();
+        });
+    })
+});

test/expected/coverage.txt

@@ -0,0 +1 @@
+[{"lines":{"found":16,"hit":7,"details":[{"line":9,"hit":1},{"line":15,"hit":1},{"line":16,"hit":1},{"line":29,"hit":1},{"line":31,"hit":0},{"line":32,"hit":0},{"line":34,"hit":0},{"line":35,"hit":0},{"line":36,"hit":0},{"line":37,"hit":0},{"line":40,"hit":1},{"line":46,"hit":1},{"line":47,"hit":0},{"line":49,"hit":0},{"line":56,"hit":1},{"line":57,"hit":0}]},"functions":{"hit":1,"found":4,"details":[{"name":"(anonymous_1)","line":15,"hit":1},{"name":"(anonymous_2)","line":46,"hit":0},{"name":"(anonymous_3)","line":47,"hit":0},{"name":"(anonymous_4)","line":56,"hit":0}]},"branches":{"hit":1,"found":2,"details":[{"line":29,"block":1,"branch":0,"taken":0},{"line":29,"block":1,"branch":1,"taken":1}]},"title":"","file":"/Volumes/Data/Git/DE-290/grunt-appc-coverage/lib/appc-coverage.js"}]

test/fixtures/lcov.info

@@ -0,0 +1,35 @@
+TN:
+SF:/Volumes/Data/Git/DE-290/grunt-appc-coverage/lib/appc-coverage.js
+FN:15,(anonymous_1)
+FN:46,(anonymous_2)
+FN:47,(anonymous_3)
+FN:56,(anonymous_4)
+FNF:4
+FNH:1
+FNDA:1,(anonymous_1)
+FNDA:0,(anonymous_2)
+FNDA:0,(anonymous_3)
+FNDA:0,(anonymous_4)
+DA:9,1
+DA:15,1
+DA:16,1
+DA:29,1
+DA:31,0
+DA:32,0
+DA:34,0
+DA:35,0
+DA:36,0
+DA:37,0
+DA:40,1
+DA:46,1
+DA:47,0
+DA:49,0
+DA:56,1
+DA:57,0
+LF:16
+LH:7
+BRDA:29,1,0,0
+BRDA:29,1,1,1
+BRF:2
+BRH:1
+end_of_record