https://github.com/jsok/karma-env-preprocessor

A Karma plugin to read environment variables and make them available inside your tests.
https://github.com/jsok/karma-env-preprocessor

Last synced: 3 months ago
JSON representation

A Karma plugin to read environment variables and make them available inside your tests.

• Host: GitHub
• URL: https://github.com/jsok/karma-env-preprocessor
• Owner: jsok
• License: mit
• Created: 2014-09-08T23:21:27.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-06-13T22:03:42.000Z (over 8 years ago)
• Last Synced: 2024-10-02T13:15:36.251Z (3 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# karma-env-preprocessor

[![npm version](https://badge.fury.io/js/karma-env-preprocessor.svg)](http://badge.fury.io/js/karma-env-preprocessor)

> Preprocessor which makes environment variables available to your tests.

## Installation

The easiest way is to keep `karma-env-preprocessor` as a devDependency in your `package.json`.

```json

{

  "devDependencies": {

    "karma": "~0.10",

    "karma-env-preprocessor": "~0.1"

  }

}

```

You can simple do it by:

```bash

npm install karma-env-preprocessor --save-dev

```

To load `karma-env-preprocessor` into Karma you should add it to the plugins array in the Karma configuration file.

For more information see [the Plugins section](http://karma-runner.github.io/0.13/config/plugins.html) of the Karma documentation.

## Configuration

Any files you preprocess using this plugin will be affected, e.g for all JavaScript files:

```js

// karma.conf.js

module.exports = function(config) {

  config.set({

    preprocessors: {

      '**/*.js': ['env']

    },

    envPreprocessor: [

      'PATH',

      'HOME'

    ],

    plugins: [

      'karma-env-preprocessor'

    ],

  });

};

```

## How does it work ?

This preprocessor uses `process.env` to read the value of each environment variable specified in `envPreprocessor` and publishes them in the global `window.__env__`, so you can read these values in your tests.

For example, the above configuration will be served as:

```js

window.__env__ = window.__env__ || []

window.__env__['PATH'] = '/usr/sbin:/usr/bin:/sbin:/bin';

window.__env__['HOME'] = '/home/jsok';

```

----

For more information on Karma see the [homepage].

[homepage]: http://karma-runner.github.com