CODEWITHSUNDEEP
javascriptnode.jsjasminecodeship
Guy
Guy

Reputation: 67260

Disable Jasmine's fdescribe() and fit() based on environment

fdescribe() and fit() are great for reducing noise when you're working on a subset of tests. I sometimes forget to change them back to describe()/it() before merging my branch into master. (It's okay to have them in separate branch while working on code - i.e. a pre-commit check wouldn't work for me.)

My CI environment is Codeship. Is there a solution to this problem that would fail the tests in Codeship if it came across any focused methods?

Using something like no-focused-tests would be okay. Any idea how to enable this rule as an error in Codeship and disable it locally?

Upvotes: 24

Views: 8008

Answers (6)

Coderer
Coderer

Reputation: 27264

If you're willing to fail on when tests are marked for focus or skip (fit + xit), there's a relatively new Karma feature that solves the problem with no plugins. Karma now supports a failOnSkippedTests config file / CLI option, which, per the docs, causes "failure on tests deliberately disabled, eg fit() or xit()".

Upvotes: 0

Questioning
Questioning

Reputation: 2043

I'm late to the party.

I had a similar issue with my builds. We don't use ts / eslint so I just wrote a quick script to throw an error that would fail my dockerfile / build.

Here it is.

#!/bin/sh
files=$(find "./.." -type f -name '*.spec*')
errored=false

echo "Checking for focused tests"

for file in $files
do
    if grep -E "fdescribe|fit" $file; [ $? -eq 0 ]; then
        echo "-Focusing a test in the file $file"
        errored=true
    fi
done

if $errored; then
    echo "Some tests were focused"
    exit 1
else
    echo "No tests were focused"
fi

Upvotes: 1

Dominik Ehrenberg
Dominik Ehrenberg

Reputation: 1746

Edit 14.11.19:

To make things easier I created an installable package you can find at https://www.npmjs.com/package/tslint-jasmine

Original post:

If you're using TSLint and (like me) found that all the defocus and tslint-jasmine-noSkipOrFocus checkers are not working for you, I created a Gist for that: https://gist.github.com/djungowski/7d9126bb79970446b4ffeb5656c6bf1f

How to use:

  1. Save Gist in a a folder called TSLint/Rules as noJasmineFocusRule.js
  2. Add the Rules folder to your TSLint config: rulesDirectory: 'TSLint/Rules'
  3. Enable option with "no-jasmine-focus": true

Upvotes: 7

Jesus is Lord
Jesus is Lord

Reputation: 15399

This isn't the best solution. But it works for my needs.

To setup:

npm i lodash
npm i minimist

I call this from my gulp tasks:

node .\\build\\throwIfFocusedTest.js e2e/
node .\\build\\throwIfFocusedTest.js src/

throwIfFocusedTest.js:

const walkSync = require('./walkSync').default;
const _ = require('lodash');
const argv = require('minimist')(process.argv);
const fs = require('fs');

if (argv._.length !== 3) {
    throw 'expecting 1 command line argument';
}

const directory = argv._[2];

const files = walkSync(directory);
const scriptFiles = _.filter(files, f => f.endsWith('.js') || f.endsWith('.ts'));

const invalidStrings = [
    'fdescribe',
    'fit',
];

_.each(scriptFiles, fileName => {
    const contents = fs.readFileSync(fileName, 'utf8');
    invalidStrings.forEach(is => {
        if (contents.includes(is)) {
            console.error(`throwIfFocusedTest: ${directory}: File contains ${is}: ${fileName}`);
            process.exit(1);
        }
    });
});
console.log(`throwIfFocusedTest: ${directory}: No files contain: ${invalidStrings.join(', ')}`);

walkSync.js:

/**
 * From: https://gist.github.com/kethinov/6658166 
 */
exports.default = function walkSync(dir, filelist) {
    var fs = fs || require('fs'),
        files = fs.readdirSync(dir);
    filelist = filelist || [];
    files.forEach(function (file) {
        var path = dir + file;
        if (fs.statSync(dir + file).isDirectory()) {
            filelist = walkSync(dir + file + '/', filelist);
        }
        else {
            filelist.push(path);
        }
    });
    return filelist;
};

Upvotes: 0

TheNastyOne
TheNastyOne

Reputation: 1065

For those interested, if you are using jasmine and eslint, you can use this plugin to ensure no focused tests: https://github.com/tlvince/eslint-plugin-jasmine.

  1. First install eslint globally npm install -g eslint.
  2. Then install the eslint-plugin-jasmine library npm install --save-dev eslint-plugin-jasmine.

  3. Create a .eslintrc file which would look something like this: 

    {
  "rules": {
    "semi": 2
  },
  "plugins": ["jasmine"],
  "env": {
    "jasmine": true
  },
  "extends": "plugin:jasmine/recommended",
}

  4. Then you are ready to run the linter eslint -c ./.eslintrc app.js

Upvotes: 3

Alan
Alan

Reputation: 458

Using something like no-focused-tests would be okay. Any idea how to enable this rule as an error in Codeship and disable it locally?

You could use a combination of environment variables and redefining the fdescribe/fit global functions:

  1. npm i --save cross-env

  2. package.json:

    "scripts": {
  "test": "jasmine",
  "test-safe": "cross-env FOCUSED_TESTS=off jasmine"
},

  3. disableFocusedTestsIfNecessary.js (included after jasmine defines its globals):

    if (process.env.FOCUSED_TESTS === "off") {
  console.log("Focused tests must be off");
  global.fdescribe = global.fit = function() {
    throw new Error("fdescribe and fit are disabled in this environment");
  };
}
else {
  console.log("Focused tests enabled");
}

  4. Tell codeship to run npm run test-safe instead of npm run test

Upvotes: 4

Related Questions