https://github.com/vladfilipro/rig-unit-test

A rig containing unit testing utilities
https://github.com/vladfilipro/rig-unit-test

depricated

Last synced: 10 days ago
JSON representation

A rig containing unit testing utilities

• Host: GitHub
• URL: https://github.com/vladfilipro/rig-unit-test
• Owner: vladfilipro
• Created: 2016-04-12T12:21:30.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-07-06T20:41:50.000Z (over 8 years ago)
• Last Synced: 2024-11-06T23:25:27.444Z (about 2 months ago)
• Topics: depricated
• Language: JavaScript
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# rig-unit-test

[![Dependency Status](https://david-dm.org/vladfilipro/rig-unit-test.svg)](https://david-dm.org/vladfilipro/rig-unit-test)

A rig containing tasks used for running unit tests

## How to use

1. Install rigs package: `npm install rigs`

2. Install rig-unit-test: `npm install rig-unit-test`

## Available tasks in rig-unit-test

- `rig-unit-test__karma`: A task which runs Karma with the specific configuration (suitable for browser testing - frontend)

  - properties:

    - `karma`: Object, contains Karma configuration. More info on [karma website](https://karma-runner.github.io/0.13/index.html)

    ```

    {

        taskname: 'rig-unit-test__karma',

        dependency: [],

        karma: {

            basePath: './',

            frameworks: [ 'jasmine', 'browserify' ],

            preprocessors: {

                '/spec/unit/**/*.js': [ 'browserify' ]

            },

            files: [

                '/spec/unit/**/*.js'

            ],

            exclude: [],

            browserify: {

                debug: true,

                transform: [ 'browserify-ngannotate', require( 'browserify-istanbul' )( {

                    ignore: [

                        '**/node_modules/**',

                        '**/spec/**'

                    ]

                } ) ]

            },

            reporters: [ 'progress', 'coverage' ],

            coverageReporter: {

                reporters: [ {

                    type: 'text'

                }, {

                    type: 'text-summary'

                }, {

                    type: 'cobertura',

                    dir: './coverage/unit/'

                }, {

                    type: 'html',

                    dir: './coverage/unit/'

                } ]

            },

            port: 9876,

            colors: true,

            autoWatch: true,

            browsers: [ 'PhantomJS' ],

            singleRun: true

        }

    }

    ```

- `rig-unit-test__mocha`: A task which runs Mocha with the specific configuration (suitable for nodejs testing - backend)

  - properties:

    - `src`: String or Array, refers to the source files for code coverage

    - `tests`: String or Array, refers to the source files of the unit tests

    - `istanbul`: Object, refers to istanbul configuration. See more at [gulp-istanbul](https://www.npmjs.com/package/gulp-istanbul)

    - `mocha`: Object, refers to mocha configuration. See more at [gulp-mocha](https://www.npmjs.com/package/gulp-mocha)

    - `reports`: Object, refers to istanbul reporting configuration.

    ```

    {

        taskname: 'rig-unit-test__mocha',

        dependency: [],

        src: './src/**/*.js',

        tests: './spec/**/*.js',

        istanbul: { includeUntested: true },

        mocha: { reporter: 'nyan' },

        reports: {

            dir: './coverage',

            reporters: [ 'lcov' ],

            reportOpts: { dir: './coverage' }

        }

    }

    ```

### Generated using [webcase-rig](https://www.npmjs.com/package/webcase-rig) version 1.0.0