diff --git a/.travis.yml b/.travis.yml index dac66441..03989290 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,7 +6,15 @@ node_js: - "4.2" - "5" -sudo: false +dist: trusty +sudo: required + +addons: + apt: + sources: + - google-chrome + packages: + - google-chrome-stable cache: directories: @@ -24,6 +32,8 @@ matrix: env: NPM_SCRIPT=lint before_install: + - "export DISPLAY=:99.0" + - "sh -e /etc/init.d/xvfb start" - "npm config set spin false" - "npm install -g npm@^2" diff --git a/CHANGELOG.md b/CHANGELOG.md index 8393ff7b..144a8bac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,128 @@ -- 0.1.2 -Bugfix: Fix config to override defaults (thanks @rwjblue) +# Change Log -- 0.1.1 -Bugfix: For QUnit users: support for `/tests` and older ember-cli (`< 2.4.3`) versions +## [v0.3.4](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.3.4) (2016-10-10) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.3.3...v0.3.4) -- 0.1.0 -Initial release. +**Closed issues:** + +- Missing coverage information in top-level addons in 0.3.3. [\#53](https://github.com/kategengler/ember-cli-code-coverage/issues/53) + +**Merged pull requests:** + +- return actual name not function from \_parentName [\#52](https://github.com/kategengler/ember-cli-code-coverage/pull/52) ([nfc036](https://github.com/nfc036)) + +## [v0.3.3](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.3.3) (2016-10-07) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.3.2...v0.3.3) + +**Closed issues:** + +- Addon support: no coverage for addon files on Windows [\#48](https://github.com/kategengler/ember-cli-code-coverage/issues/48) +- No coverage when addon and package name don't match [\#45](https://github.com/kategengler/ember-cli-code-coverage/issues/45) +- Mocha phantom addon coverage issue in master causing a global error. [\#32](https://github.com/kategengler/ember-cli-code-coverage/issues/32) + +**Merged pull requests:** + +- Use posix paths for dealing with modules. [\#50](https://github.com/kategengler/ember-cli-code-coverage/pull/50) ([rwjblue](https://github.com/rwjblue)) +- Handle addons with different package names [\#46](https://github.com/kategengler/ember-cli-code-coverage/pull/46) ([dfreeman](https://github.com/dfreeman)) + +## [v0.3.2](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.3.2) (2016-09-19) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.3.1...v0.3.2) + +**Closed issues:** + +- Integration components support [\#40](https://github.com/kategengler/ember-cli-code-coverage/issues/40) +- Addon tests never exit [\#37](https://github.com/kategengler/ember-cli-code-coverage/issues/37) + +**Merged pull requests:** + +- Fix hang when running in PhantomJS. [\#43](https://github.com/kategengler/ember-cli-code-coverage/pull/43) ([dfreeman](https://github.com/dfreeman)) +- add Windows notes [\#38](https://github.com/kategengler/ember-cli-code-coverage/pull/38) ([kellyselden](https://github.com/kellyselden)) + +## [v0.3.1](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.3.1) (2016-09-15) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.3.0...v0.3.1) + +**Closed issues:** + +- Add code coverage [\#34](https://github.com/kategengler/ember-cli-code-coverage/issues/34) + +**Merged pull requests:** + +- Remove stray console.log [\#35](https://github.com/kategengler/ember-cli-code-coverage/pull/35) ([arjansingh](https://github.com/arjansingh)) + +## [v0.3.0](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.3.0) (2016-09-14) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.2.2...v0.3.0) + +**Closed issues:** + +- does not work with addons [\#26](https://github.com/kategengler/ember-cli-code-coverage/issues/26) +- Does not appear to work with decorators [\#25](https://github.com/kategengler/ember-cli-code-coverage/issues/25) +- No Coverage generated got following error [\#21](https://github.com/kategengler/ember-cli-code-coverage/issues/21) +- Support Addon Coverage [\#14](https://github.com/kategengler/ember-cli-code-coverage/issues/14) + +**Merged pull requests:** + +- Support Addon Coverage [\#31](https://github.com/kategengler/ember-cli-code-coverage/pull/31) ([rwjblue](https://github.com/rwjblue)) +- Processed addon js files [\#30](https://github.com/kategengler/ember-cli-code-coverage/pull/30) ([EWhite613](https://github.com/EWhite613)) +- Avoid requiring jQuery for sending the coverage report back. [\#24](https://github.com/kategengler/ember-cli-code-coverage/pull/24) ([rwjblue](https://github.com/rwjblue)) +- Try catch around instrumenter. So it spits out a clearer error [\#22](https://github.com/kategengler/ember-cli-code-coverage/pull/22) ([EWhite613](https://github.com/EWhite613)) + +## [v0.2.2](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.2.2) (2016-06-30) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.2.1...v0.2.2) + +**Closed issues:** + +- Enabling useBabelInstrumenter results in "Unknown option: direct.includePolyfill" error [\#18](https://github.com/kategengler/ember-cli-code-coverage/issues/18) +- Should .hbs files be taken into account? [\#17](https://github.com/kategengler/ember-cli-code-coverage/issues/17) + +**Merged pull requests:** + +- Add `includePolyfill` to removed babel options. [\#19](https://github.com/kategengler/ember-cli-code-coverage/pull/19) ([rwjblue](https://github.com/rwjblue)) + +## [v0.2.1](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.2.1) (2016-06-22) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.2.0...v0.2.1) + +**Closed issues:** + +- Coverage is against transpiled ES5 Code [\#12](https://github.com/kategengler/ember-cli-code-coverage/issues/12) + +**Merged pull requests:** + +- Update ember-cli-release to allow easier releasing. [\#16](https://github.com/kategengler/ember-cli-code-coverage/pull/16) ([rwjblue](https://github.com/rwjblue)) +- Report Correct Line Numbers for esnext [\#15](https://github.com/kategengler/ember-cli-code-coverage/pull/15) ([sandersky](https://github.com/sandersky)) + +## [v0.2.0](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.2.0) (2016-06-21) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.1.2...v0.2.0) + +**Closed issues:** + +- paths in "lcov.info" don't relate to project setup [\#8](https://github.com/kategengler/ember-cli-code-coverage/issues/8) +- files from addons bleed into coverage results [\#7](https://github.com/kategengler/ember-cli-code-coverage/issues/7) +- Change config file name? [\#4](https://github.com/kategengler/ember-cli-code-coverage/issues/4) + +**Merged pull requests:** + +- Filter out files from addons, fix file paths, and rename config file [\#11](https://github.com/kategengler/ember-cli-code-coverage/pull/11) ([sandersky](https://github.com/sandersky)) +- Add ember-cli-mirage min version to README.md [\#3](https://github.com/kategengler/ember-cli-code-coverage/pull/3) ([benoror](https://github.com/benoror)) + +## [v0.1.2](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.1.2) (2016-05-15) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.1.1...v0.1.2) + +**Closed issues:** + +- Take over the 'ember-cli-istanbul' package? [\#6](https://github.com/kategengler/ember-cli-code-coverage/issues/6) +- Testem global not found [\#1](https://github.com/kategengler/ember-cli-code-coverage/issues/1) + +**Merged pull requests:** + +- Allow users config to override the default config. [\#5](https://github.com/kategengler/ember-cli-code-coverage/pull/5) ([rwjblue](https://github.com/rwjblue)) + +## [v0.1.1](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.1.1) (2016-05-05) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.1.0...v0.1.1) + +## [v0.1.0](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.1.0) (2016-05-03) +[Full Changelog](https://github.com/kategengler/ember-cli-code-coverage/compare/v0.0.1...v0.1.0) + +## [v0.0.1](https://github.com/kategengler/ember-cli-code-coverage/tree/v0.0.1) (2016-05-03) + + +\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \ No newline at end of file diff --git a/README.md b/README.md index b70ba69c..9713ac8a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ Code coverage using [Istanbul](https://github.com/gotwarlost/istanbul) for Ember ## Requirements * If using Mocha, Testem `>= 1.6.0` for which you need ember-cli `> 2.4.3` * If using Mirage you need `ember-cli-mirage >= 0.1.13` -* If using Pretender you need `pretender >= 0.11.0` +* If using Pretender (even as a dependency of Mirage) you need `pretender >= 0.11.0` +* If using Mirage or Pretender, you need to [set up a passthrough for coverage to be written](#create-a-passthrough-when-intercepting-all-ajax-requests-in-tests). ## Installation @@ -14,15 +15,23 @@ Code coverage using [Istanbul](https://github.com/gotwarlost/istanbul) for Ember ## Usage -Coverage will only be generated when an environment variable is true (by default `COVERAGE`) and running your test command like normal. +Coverage will only be generated when an [environment variable](https://en.wikipedia.org/wiki/Environment_variable) is true (by default `COVERAGE`) and running your test command like normal. For example: `COVERAGE=true ember test` +If you want your coverage to work on both Unix and Windows, you can do this: + +`npm install cross-env --save-dev` + +and then: + +`cross-env COVERAGE=true ember test` + ## Configuration -Configuration is optional. It should be put in a file at `config/coverage.js`. +Configuration is optional. It should be put in a file at `config/coverage.js`. #### Options @@ -36,9 +45,16 @@ Configuration is optional. It should be put in a file at `config/coverage.js`. - `useBabelInstrumenter`: Defaults to `false`. Whether or not to use Babel instrumenter instead of default instrumenter. The Babel instrumenter is useful when you are using features of ESNext as it uses your Babel configuration defined in `ember-cli-build.js`. -## Using when intercepting all ajax requests in tests +#### Example +```js + module.exports = { + coverageEnvVar: 'COV' + } +``` + +## Create a passthrough when intercepting all ajax requests in tests -Aka when using ember-cli-mirage or Pretender. You may require a version of Pretender that includes [this fix](https://github.com/pretenderjs/pretender/pull/130). +(When using ember-cli-mirage or Pretender.) To work, this addon has to post coverage results back to a middleware at `/write-coverage`. diff --git a/index.js b/index.js index d14ffa6d..b9678767 100644 --- a/index.js +++ b/index.js @@ -17,7 +17,7 @@ module.exports = { included: function() { if (this._isCoverageEnabled() && this.parent.isEmberCLIAddon()) { - var coveredAddon = this.project.findAddonByName(this.project.pkg.name); + var coveredAddon = this._findCoveredAddon(); var coverageAddonContext = this; coveredAddon.processedAddonJsFiles = function (tree){ @@ -65,7 +65,7 @@ module.exports = { // Instrument JavaScript for code coverage var instrumentedNode = new CoverageInstrumenter(appFiles, { annotation: 'Instrumenting for code coverage', - appName: this.parent.pkg.name, + appName: this._parentName(), appRoot: this.parent.root, babelOptions: this.app.options.babel, useBabelInstrumenter: useBabelInstrumenter, @@ -90,7 +90,12 @@ module.exports = { */ testemMiddleware: function(app) { if (!this._isCoverageEnabled()) { return; } - attachMiddleware(app, { root: this.project.root, ui: this.ui }); + attachMiddleware(app, + { + root: this.project.root, + ui: this.ui, + appName: this.parent.pkg.name, + excludes: this._getConfig().excludes || [] }); }, // Custom Methods @@ -124,20 +129,23 @@ module.exports = { return this._doesTemplateFileExist(relativePath); }, - /** + + /** * Check if a file exists within the current addon directory. Removing `module/` from the path. * @param {String} relativePath - path to file within current app * @returns {Boolean} whether or not the file exists within the current app */ - _doesFileExistIsCurrentProjectAddonModule: function(relativePath) { - relativePath = path.join('addon', relativePath.replace(path.join('modules', this.project.pkg.name),'')); + _doesFileExistInCurrentProjectAddonModule: function(relativePath) { + var relativePathWithoutProjectNamePrefix = relativePath.replace('modules' + '/' + this._parentName(), ''); + var _relativePath = 'addon/' + relativePathWithoutProjectNamePrefix; - if (this._existsSync(relativePath)) { + if (this._existsSync(_relativePath)) { return true; } - return this._doesTemplateFileExist(relativePath); + return this._doesTemplateFileExist(_relativePath); }, + /** * Check if a file exists within the dummy app * @param {String} relativePath - path to file within dummy app @@ -203,11 +211,9 @@ module.exports = { this._doesFileExistInDummyApp(relativePath) || this._doesFileExistInCurrentProjectApp(relativePath) || this._doesFileExistInCurrentProjectAddon(relativePath) || - this._doesFileExistIsCurrentProjectAddonModule(relativePath) + this._doesFileExistInCurrentProjectAddonModule(relativePath) ); - console.log(!fileExists, name, relativePath); - return !fileExists; }, @@ -225,7 +231,7 @@ module.exports = { */ _getExcludes: function() { var excludes = this._getConfig().excludes || []; - var name = this.parent.pkg.name; + var name = this._parentName(); excludes.push(this._filterOutAddonFiles.bind(this, name)); return excludes; @@ -243,5 +249,29 @@ module.exports = { } return ['true', true].indexOf(value) !== -1; + }, + + /** + * Determine the name of the parent app or addon. + * @returns {String} the name of the parent + */ + _parentName: function() { + if (this.parent.isEmberCLIAddon()) { + return this._findCoveredAddon().name; + } else { + return this.parent.name(); + } + }, + + /** + * Find the addon (if any) that's being covered. + * @returns {Addon} the addon under test + */ + _findCoveredAddon: function() { + if (!this._coveredAddon) { + this._coveredAddon = this.project.findAddonByName(this.project.pkg.name); + } + + return this._coveredAddon; } }; diff --git a/lib/attach-middleware.js b/lib/attach-middleware.js index bb612c74..6ecd109e 100644 --- a/lib/attach-middleware.js +++ b/lib/attach-middleware.js @@ -5,7 +5,7 @@ var Istanbul = require('istanbul'); var config = require('./config'); var path = require('path'); var fs = require('fs-extra'); - +var minimatch = require('minimatch') function logError(err, req, res, next) { console.error(err.stack); next(err); @@ -34,4 +34,40 @@ module.exports = function(app, options) { }); }, logError); + + function shouldExclude(moduleName, excludes) { + for (var i = 0; i < excludes.length; i++) { + if (minimatch(moduleName, excludes[i])) { + return true + } + } + return false + } + app.post('/filter-entries',bodyParser.urlencoded({ + limit: options.root.coveragePostLimit ||'50mb', + extended: false, + parameterLimit: options.root.coveragePostParameterLimit ||10000 + }),bodyParser.json({ + limit: options.root.coveragePostLimit || '50mb' + }), + function(req, res) { + var entries = req.body['entries[]'] || req.body.entries + var seen = {} + var appName = options.appName + var filteredEntries = entries.filter(function(entry) { + var result = false + if (typeof (seen[entry]) === 'undefined') { + var parts = entry.split('/') + if (parts.length >= 1 && parts[0] === appName || parts.length >= 2 && parts[0] === 'dummy' && parts[1] === appName) { + if (!shouldExclude(entry, options.excludes)) { + result = true + } + } + seen[entry] = true; + return result + } + return result + }) + res.send({entries: filteredEntries}) + }) }; diff --git a/lib/coverage-instrumenter.js b/lib/coverage-instrumenter.js index 1a6b4f17..972ee573 100644 --- a/lib/coverage-instrumenter.js +++ b/lib/coverage-instrumenter.js @@ -62,7 +62,8 @@ function CoverageInstrumenter(inputNode, options) { // simply remove them from the babel config [ 'compileModules', - 'resolveModuleSource' + 'resolveModuleSource', + 'includePolyfill' ].forEach(function(key) { delete this._babelOptions[key]; }.bind(this)); diff --git a/lib/templates/test-body-footer.html b/lib/templates/test-body-footer.html index 580bbe8b..081fdc2f 100644 --- a/lib/templates/test-body-footer.html +++ b/lib/templates/test-body-footer.html @@ -3,41 +3,71 @@ var coverageData = window.__coverage__; var data = JSON.stringify(coverageData || {}); - $.ajax({ - type: 'POST', - async: false, - url: '/write-coverage', - datatype: 'json', - contentType:'application/json; charset=utf-8', - data: data, - error: function(jqXHR, textStatus, errorThrown ) { - throw errorThrown; - }, - success: function(data) { - if (!data || !data.total) { - return; - } + var request = new XMLHttpRequest(); + request.open('POST', '/write-coverage', true); + request.setRequestHeader('Content-Type', 'application/json; charset=utf-8'); + request.send(data); + request.responseType = 'json'; - var results = ['Lines', 'Branches', 'Functions', 'Statements'] - .filter(function (name) { - return data.total[name.toLowerCase()] - }) - .map(function (name) { - return name + ' ' + data.total[name.toLowerCase()].pct + '%' - }) - - $('body').append('
' + results.join(' | ') + '
'); - }, - complete: function() { - if (callback) { - callback(); - } + request.onload = function() { + var data = this.response; + + // PhantomJS doesn't honor `responseType = 'json'` + if (typeof data === 'string') { + data = JSON.parse(data); } - }); + + if (!data || !data.total) { + return; + } + + var results = ['Lines', 'Branches', 'Functions', 'Statements'] + .filter(function (name) { + return data.total[name.toLowerCase()] + }) + .map(function (name) { + return name + ' ' + data.total[name.toLowerCase()].pct + '%' + }); + + var resultsText = document.createTextNode(results.join(' | ')); + var element = document.createElement('div'); + element.style = 'background-color: white; color: black; border: 2px solid black; padding: 1em;position: fixed; left: 15px; bottom: 15px'; + element.appendChild(resultsText); + document.body.appendChild(element); + + if (callback) { + callback(); + } + }; } + function getModuleName (){ + return jQuery.ajax({ + url: '/get-module-name', + async: false + }).responseJSON // TODO: async after POC + } + function filterEntries(entries){ + return jQuery.ajax({ + type: 'POST', + url: '/filter-entries', + async: false, + data: { + entries: entries + } + }).responseJSON + } if (typeof Testem !== "undefined" && Testem.afterTests) { Testem.afterTests(function(config, data, callback) { + var entries = filterEntries(Object.keys(requirejs.entries)).entries + for (var entry in entries){ + console.warn('requiring unseen module: ' + entries[entry]) + try { + require(entries[entry]) + } catch (err){ + console.error(err) + } + } sendCoverage(callback); }); } else if (typeof QUnit !== "undefined") { diff --git a/package.json b/package.json index e4543a16..08a9a60e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ember-cli-code-coverage", - "version": "0.2.1", + "version": "0.3.4", "description": "Code coverage for ember projects using Istanbul", "directories": { "doc": "doc", @@ -64,6 +64,7 @@ "extend": "^3.0.0", "fs-extra": "^0.26.7", "istanbul": "^0.4.3", + "minimatch": "^3.0.3", "source-map": "0.5.6" }, "ember-addon": { diff --git a/test/helpers/run-command.js b/test/helpers/run-command.js index be326a2b..48066c9a 100644 --- a/test/helpers/run-command.js +++ b/test/helpers/run-command.js @@ -6,7 +6,7 @@ var spawn = require('child_process').spawn; module.exports = function runCommand(command, args, opts) { opts = opts || {}; - opts.stdio = opts.stdio || 'ignore'; + opts.stdio = opts.stdio || 'inherit'; var newENV = {}; var item, envOption; @@ -24,7 +24,7 @@ module.exports = function runCommand(command, args, opts) { var p = spawn(command, args, opts); p.on('close', function(code) { if (code !== 0) { - reject(code); + reject(new Error('Command ' + command + ' ' + args.join(' ') + ' exited ' + code)); } else { resolve(); } diff --git a/test/unit/index-test.js b/test/unit/index-test.js index e81319fa..05a7928f 100644 --- a/test/unit/index-test.js +++ b/test/unit/index-test.js @@ -64,12 +64,18 @@ describe('index.js', function() { beforeEach(function() { app = { - post: sinon.spy() + post: sinon.spy(), + get: sinon.spy() }; Index.project = { root: '/path/to/foo-bar' }; + Index.parent = { + pkg: { + name: 'foo-bar' + } + } }); describe('when coverage is enabled', function() { @@ -78,8 +84,8 @@ describe('index.js', function() { Index.testemMiddleware(app); }); - it('adds POST endpoint to app', function() { - expect(app.post.callCount).to.equal(1); + it('adds POST endpoints to app', function() { + expect(app.post.callCount).to.equal(2); }); }); @@ -92,6 +98,9 @@ describe('index.js', function() { it('does not add POST endpoint to app', function() { expect(app.post.callCount).to.equal(0); }); + it('does not GET endpoint to app', function() { + expect(app.get.callCount).to.equal(0); + }); }); }); @@ -249,13 +258,16 @@ describe('index.js', function() { }); }); - describe('_getEcludes', function() { + describe('_getExcludes', function() { beforeEach(function() { sandbox.stub(Index, '_filterOutAddonFiles').returns('test'); Index.parent = { - pkg: { - name: 'foo-bar' + isEmberCLIAddon: function() { + return false; + }, + name: function() { + return 'test'; } }; }); @@ -397,4 +409,63 @@ describe('index.js', function() { }); }); }); + + describe('_parentName', function() { + var isAddon; + + beforeEach(function() { + Index.parent = { + name: function() { + return 'parent-app'; + }, + isEmberCLIAddon: function() { + return isAddon; + } + }; + }); + + describe('when parent is an app', function() { + beforeEach(function() { + isAddon = false; + }); + + it('returns the app name', function() { + expect(Index._parentName()).to.equal('parent-app'); + }); + }); + + describe('when parent is an addon', function() { + beforeEach(function() { + isAddon = true; + sandbox.stub(Index, '_findCoveredAddon').returns({ name: 'some-addon' }); + }); + + it('returns the addon name', function() { + expect(Index._parentName()).to.equal('some-addon'); + }); + }); + }); + + describe('_findCoveredAddon', function() { + var result; + + beforeEach(function() { + Index.project = { + findAddonByName: sinon.stub().returns({ name: 'my-addon' }), + pkg: { + name: '@scope/ember-cli-my-addon' + } + }; + + result = Index._findCoveredAddon(); + }); + + it('looks up the addon by the package name', function() { + expect(Index.project.findAddonByName.calledWith('@scope/ember-cli-my-addon')).to.be.true; + }); + + it('returns the located addon', function() { + expect(result.name).to.equal('my-addon'); + }); + }); }); diff --git a/testem.js b/testem.js index f37e0a49..2c1382b2 100644 --- a/testem.js +++ b/testem.js @@ -7,10 +7,9 @@ module.exports = { "test_page": "tests/index.html?hidepassed", "disable_watching": true, "launch_in_ci": [ - "PhantomJS" + "Chrome" ], "launch_in_dev": [ - "PhantomJS", "Chrome" ] };