TheBrainFamily / chimpy

Develop acceptance tests & end-to-end tests with realtime feedback.
https://thebrainfamily.github.io/chimpy
MIT License
52 stars 28 forks source link

How should I configure chimp? #101

Open samhatoum opened 6 years ago

samhatoum commented 6 years ago

Issue by Saravana9210 Friday Nov 17, 2017 at 07:20 GMT Originally opened as https://github.com/xolvio/chimp/issues/664


I'm planning to use chimp with cucumber.js, WebdriverIO and Chai for assertions. Also, I need to configure this as Jenkins project to automate my testing.

How should I configure chimp for this? Which is the configuration file for chimp and where can I find it?

  1. where should I mention the location of feature files and step definition files.
  2. Chai configurations
  3. WebdriverIO configurations

Any kind of help would be appreciated. Thanks in advance!!!

samhatoum commented 6 years ago

Comment by Aracturat Friday Dec 01, 2017 at 09:50 GMT


@Saravana9210 It is example of my config (WebdriverIO + Cucumberjs + typescript). I hope it can help you. Add this code to chimp.config.js then run it chimp chimp.options.js

module.exports = {
    path: './tests/e2e/features',
    compiler: 'ts:ts-node/register',
    browser: process.env.BROWSER ? process.env.BROWSER : 'chrome',
    chai: true,
    timeout: 2000,
    e2eTags: '@focus',
    e2eSteps: './tests/e2e/step_definitions',
    format: 'pretty',

    // - - - - CHIMP - - - -
    watch: true,
    watchTags: '@focus',
    watchWithPolling: false,
    sync: true,
    offline: false,

    // - - - - CUCUMBER - - - -
    tags: '@focus',
    conditionOutput: true,

    // - - - - SESSION-MANAGER  - - - -
    noSessionReuse: false,

    // - - - - DEBUGGING  - - - -
    log: 'info',
    debug: true,
    debugCucumber: true,
    debugBrkCucumber: false,
    seleniumStandaloneOptions: {
        drivers: {
            chrome: {
                version: "2.33",
                arch: process.arch
            }
        }
    },
    webdriverio: {
        logLevel: 'silent',
        coloredLogs: true
    }
};
samhatoum commented 6 years ago

Comment by Saravana9210 Tuesday Dec 26, 2017 at 08:34 GMT


Hi Aracturat,

Thank you for your reply!

  1. My question was where can I find this config file and what are these json keys(watch, watchTags, Sync - description of all these)? I couldn't find chimp.config.js anywhere inside /chimp directrory

  2. But, there is a default config file called default.js under /chimp/dist/bin/default.js Is this the intended config file?

  3. And, if I've to use cucumber-html-report (or any other reporting library for example) for reporting, how should I configure that in the config file?

I basically want to understand deeply about how chimp integrates cucumber.js, selenium webdriver, feature files, reports and jenkins.

Thanks in advance.

samhatoum commented 6 years ago

Comment by Ziinc Friday Mar 16, 2018 at 16:41 GMT


  1. you can find the full chimp config here. Most of the keys are self explanatory, such as watchTags are the tags that chimp will look for in watch mode. Unfortunately, not all keys are documented.

  2. you should create your own config file as recommended in the docs. Whatever options is passed will override the default config options.

proCrichard commented 6 years ago

Is there an updated link to the full chimpy config options?

diawinga commented 5 years ago

Is there an updated link to the full chimpy config options?

https://github.com/TheBrainFamily/chimpy/blob/master/src/bin/default.js