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.

Sign up for GitHub

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

Jump to bottom

feat: Add support for instrumenter options #227

Merged
merged 1 commit into from Oct 8, 2019
Merged

feat: Add support for instrumenter options #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions fixtures/class-functions.js
View file
Open in desktop
@@ -0,0 +1,11 @@
class Foo1 {
bar() {}
barz() {}
}

class Foo2 {
bar() {}
barz() {}
}

module.exports = { Foo1, Foo2 }
10 changes: 9 additions & 1 deletion src/index.js
View file
Open in desktop
Expand Up @@ -115,8 +115,16 @@ export default declare(api => {
inputSourceMap = this.file.inputMap.sourcemap
}
}
const visitorOptions = {}
Object.entries(schema.defaults.instrumentVisitor).forEach(([name, defaultValue]) => {
if (name in this.nycConfig) {
visitorOptions[name] = this.nycConfig[name]
} else {
visitorOptions[name] = schema.defaults.instrumentVisitor[name]
}
})
this.__dv__ = programVisitor(t, realPath, {
coverageVariable: '__coverage__',
...visitorOptions,
inputSourceMap
})
this.__dv__.enter(path)
Expand Down
100 changes: 100 additions & 0 deletions test/babel-plugin-istanbul.js
View file
Open in desktop
Expand Up @@ -10,6 +10,8 @@ describe('babel-plugin-istanbul', function () {
context('Babel plugin config', function () {
it('should instrument file if shouldSkip returns false', function () {
var result = babel.transformFileSync('./fixtures/plugin-should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/plugin-should-cover.js']
Expand All @@ -21,6 +23,8 @@ describe('babel-plugin-istanbul', function () {

it('should not instrument file if shouldSkip returns true', function () {
var result = babel.transformFileSync('./fixtures/plugin-should-not-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/plugin-should-cover.js']
Expand All @@ -33,6 +37,8 @@ describe('babel-plugin-istanbul', function () {
context('local node_modules', function () {
it('should instrument file if shouldSkip returns false', function () {
var result = babel.transformFileSync('./fixtures/node_modules/should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
excludeNodeModules: false,
Expand All @@ -46,6 +52,8 @@ describe('babel-plugin-istanbul', function () {

it('should not instrument file if shouldSkip returns true', function () {
var result = babel.transformFileSync('./fixtures/node_modules/should-not-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/node_modules/should-not-cover.js']
Expand All @@ -59,6 +67,8 @@ describe('babel-plugin-istanbul', function () {
it('should call onCover callback', function () {
var args
babel.transformFileSync('./fixtures/plugin-should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
onCover: function () {
Expand All @@ -76,6 +86,8 @@ describe('babel-plugin-istanbul', function () {
context('source maps', function () {
it('should use inline source map', function () {
var result = babel.transformFileSync('./fixtures/has-inline-source-map.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/has-inline-source-map.js']
Expand All @@ -87,6 +99,8 @@ describe('babel-plugin-istanbul', function () {

it('should not use inline source map if inputSourceMap is set to false', function () {
var result = babel.transformFileSync('./fixtures/has-inline-source-map.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/has-inline-source-map.js'],
Expand All @@ -99,6 +113,8 @@ describe('babel-plugin-istanbul', function () {

it('should use provided source map', function () {
var result = babel.transformFileSync('./fixtures/has-inline-source-map.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/has-inline-source-map.js'],
Expand All @@ -110,10 +126,80 @@ describe('babel-plugin-istanbul', function () {
})
})

context('instrument options', function () {
it('should honor coverageVariable option', function () {
const result = babel.transformFileSync('./fixtures/should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/should-cover.js'],
coverageVariable: '__TEST_VARIABLE__'
}]
]
})
result.code.should.match(/__TEST_VARIABLE__/)
result.code.should.not.match(/__coverage__/)
})

it('should honor coverageGlobalScope option', function () {
const result = babel.transformFileSync('./fixtures/should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/should-cover.js'],
coverageGlobalScope: 'window'
}]
]
})
result.code.should.match(/new Function\("return window"\)/)
result.code.should.not.match(/new Function\("return this"\)/)
})

it('should honor coverageGlobalScope option', function () {
const result = babel.transformFileSync('./fixtures/should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/should-cover.js'],
coverageGlobalScopeFunc: false
}]
]
})
result.code.should.match(/global\s*=\s*this/)
result.code.should.not.match(/global\s*=\s*new Function\("return this"\)/)
})

it('should honor ignoreClassMethods option', function () {
const result = babel.transformFileSync('./fixtures/class-functions.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/class-functions.js'],
ignoreClassMethods: ['bar']
}]
]
})

// bar() is ignored
result.code.should.match(/bar\(\)\s*{\s*}/)
result.code.should.not.match(/bar\(\)\s*{\s*cov_.*/)

// barz() does not get instrumented
result.code.should.match(/barz\(\)\s*{\s*cov_.*/)
result.code.should.not.match(/barz\(\)\s*{\s*}/)
})
})

context('package.json "nyc" config', function () {
context('process.env.NYC_CONFIG is set', function () {
it('should instrument file if shouldSkip returns false', function () {
var result = babel.transformFileSync('./fixtures/should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
makeVisitor
]
Expand All @@ -123,6 +209,8 @@ describe('babel-plugin-istanbul', function () {

it('should not instrument file if shouldSkip returns true', function () {
var result = babel.transformFileSync('./fixtures/should-not-cover.js', {
babelrc: false,
configFile: false,
plugins: [
makeVisitor
]
Expand All @@ -145,6 +233,8 @@ describe('babel-plugin-istanbul', function () {

it('should instrument file if shouldSkip returns false', function () {
var result = babel.transformFileSync('./fixtures/should-cover.js', {
babelrc: false,
configFile: false,
plugins: [
makeVisitor
]
Expand All @@ -154,6 +244,8 @@ describe('babel-plugin-istanbul', function () {

it('should not instrument file if shouldSkip returns true', function () {
var result = babel.transformFileSync('./fixtures/should-not-cover.js', {
babelrc: false,
configFile: false,
plugins: [
makeVisitor
]
Expand All @@ -167,6 +259,8 @@ describe('babel-plugin-istanbul', function () {
const result = babel.transformFileSync(
path.resolve(cwd, file),
{
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, { cwd, ...opts }]
]
Expand All @@ -187,6 +281,8 @@ describe('babel-plugin-istanbul', function () {
babel.transformFileSync(
path.resolve(cwd, 'file1.js'),
{
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, { cwd, nycrcPath: 'missing-config.js' }]
]
Expand All @@ -203,6 +299,8 @@ describe('babel-plugin-istanbul', function () {
// regression test for https://github.com/istanbuljs/babel-plugin-istanbul/issues/78
it('should instrument: export const foo = () => {}', function () {
var result = babel.transformFileSync('./fixtures/issue-78.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/issue-78.js']
Expand All @@ -215,6 +313,8 @@ describe('babel-plugin-istanbul', function () {
// regression test for https://github.com/istanbuljs/babel-plugin-istanbul/issues/201
it('should not conflict with transform-modules-commonjs', function () {
var result = babel.transformFileSync('./fixtures/issue-201.js', {
babelrc: false,
configFile: false,
plugins: [
[makeVisitor, {
include: ['fixtures/issue-201.js']
Expand Down