-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
426 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| module.exports = { | ||
| "extends": "standard", | ||
| "plugins": [ | ||
| "standard", | ||
| "promise" | ||
| ], | ||
| "rules": { | ||
| "semi": [2, "always"], | ||
| "no-extra-semi": 2 | ||
| }, | ||
| globals: { | ||
| browser: false, | ||
| expect: false, | ||
| $: false, | ||
| $$: false | ||
| }, | ||
| "env": { | ||
| "mocha": true | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| language: node_js | ||
|
|
||
| node_js: | ||
| - '6.5' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,28 @@ | ||
| # wdio-starter-kit | ||
| [](https://travis-ci.org/klamping/wdio-starter-kit) | ||
|
|
||
| [](https://github.com/Flet/semistandard) | ||
|
|
||
| # WebdriverIO Starter Kit | ||
|
|
||
| Boilerplate repo for quick set up of WebdriverIO test scripts with TravisCI, Sauce Labs and Visual Regression Testing | ||
|
|
||
|
|
||
| ## Includes: | ||
|
|
||
| - Visual Regression Service | ||
| - Mocha | ||
| - Chai with Expect global | ||
| - [Chai WebdriverIO](https://github.com/marcodejongh/chai-webdriverio) | ||
| - Node Notifier | ||
|
|
||
| ## Debug Command Line Flag to adjust timeout | ||
|
|
||
| `DEBUG=true npm test` | ||
|
|
||
| ## Configuration file flavors | ||
|
|
||
| By default, tests will run in Sauce Labs testing your production server. | ||
|
|
||
| To run the tests entirely locally, run: | ||
|
|
||
| `npm test -- wdio.conf.local.js` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| { | ||
| "name": "wdio-starter-kit", | ||
| "version": "0.0.1", | ||
| "description": "Boilerplate repo for quick set up of WebdriverIO test scripts with TravisCI, Sauce Labs and Visual Regression Testing", | ||
| "main": "index.js", | ||
| "scripts": { | ||
| "lint": "eslint .", | ||
| "test": "wdio" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/klamping/wdio-starter-kit.git" | ||
| }, | ||
| "keywords": [ | ||
| "WebdriverIO" | ||
| ], | ||
| "author": "Kevin Lamping", | ||
| "license": "MIT", | ||
| "bugs": { | ||
| "url": "https://github.com/klamping/wdio-starter-kit/issues" | ||
| }, | ||
| "homepage": "https://github.com/klamping/wdio-starter-kit#readme", | ||
| "devDependencies": { | ||
| "chai": "^4.0.2", | ||
| "chai-webdriverio": "^0.4.1", | ||
| "eslint": "^4.1.1", | ||
| "eslint-config-standard": "^10.2.1", | ||
| "eslint-plugin-import": "^2.6.1", | ||
| "eslint-plugin-node": "^5.1.0", | ||
| "eslint-plugin-promise": "^3.5.0", | ||
| "eslint-plugin-standard": "^3.0.1", | ||
| "node-notifier": "^5.1.2", | ||
| "wdio-mocha-framework": "^0.5.10", | ||
| "wdio-sauce-service": "^0.4.0", | ||
| "wdio-selenium-standalone-service": "0.0.9", | ||
| "wdio-spec-reporter": "^0.1.0", | ||
| "wdio-visual-regression-service": "^0.8.0", | ||
| "webdriverio": "^4.8.0" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,283 @@ | ||
| const VisualRegressionCompare = require('wdio-visual-regression-service/compare'); | ||
| const path = require('path'); | ||
|
|
||
| function getScreenshotName (folder, context) { | ||
| const type = context.type; | ||
| const testParent = context.test.parent; | ||
| const testName = context.test.title; | ||
| const browserVersion = parseInt(context.browser.version, 10); | ||
| const browserName = context.browser.name; | ||
| const browserViewport = context.meta.viewport; | ||
| const browserWidth = browserViewport.width; | ||
| const browserHeight = browserViewport.height; | ||
|
|
||
| return path.join(process.cwd(), 'screenshots', folder, `${testParent}_${testName}_${type}_${browserName}_v${browserVersion}_${browserWidth}x${browserHeight}.png`); | ||
| } | ||
|
|
||
| var mochaTimeout = process.env.DEBUG ? 99999999 : 60000; | ||
|
|
||
| exports.config = { | ||
| // Set a base URL in order to shorten url command calls. If your url parameter starts | ||
| // with "/", then the base url gets prepended. | ||
| baseUrl: 'http://replaceme/', | ||
|
|
||
| // | ||
| // ================= | ||
| // Service Providers | ||
| // ================= | ||
| // WebdriverIO supports Sauce Labs, Browserstack, and Testing Bot (other cloud providers | ||
| // should work too though). These services define specific user and key (or access key) | ||
| // values you need to put in here in order to connect to these services. | ||
| // | ||
| user: process.env.SAUCE_USERNAME, | ||
| key: process.env.SAUCE_ACCESS_KEY, | ||
| sauceConnect: true, | ||
|
|
||
| // | ||
| // ================== | ||
| // Specify Test Files | ||
| // ================== | ||
| // Define which test specs should run. The pattern is relative to the directory | ||
| // from which `wdio` was called. Notice that, if you are calling `wdio` from an | ||
| // NPM script (see https://docs.npmjs.com/cli/run-script) then the current working | ||
| // directory is where your package.json resides, so `wdio` will be called from there. | ||
| // | ||
| specs: [ | ||
| './test/**/*.spec.js' | ||
| ], | ||
| // Patterns to exclude. | ||
| exclude: [ | ||
| './test/**/*.page.js' | ||
| ], | ||
| // | ||
| // ============ | ||
| // Capabilities | ||
| // ============ | ||
| // Define your capabilities here. WebdriverIO can run multiple capabilities at the same | ||
| // time. Depending on the number of capabilities, WebdriverIO launches several test | ||
| // sessions. Within your capabilities you can overwrite the spec and exclude options in | ||
| // order to group specific specs to a specific capability. | ||
| // | ||
| // First, you can define how many instances should be started at the same time. Let's | ||
| // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have | ||
| // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec | ||
| // files and you set maxInstances to 10, all spec files will get tested at the same time | ||
| // and 30 processes will get spawned. The property handles how many capabilities | ||
| // from the same test should run tests. | ||
| // | ||
| maxInstances: 10, | ||
| // | ||
| // If you have trouble getting all important capabilities together, check out the | ||
| // Sauce Labs platform configurator - a great tool to configure your capabilities: | ||
| // https://docs.saucelabs.com/reference/platforms-configurator | ||
| // | ||
| capabilities: [{ | ||
| // maxInstances can get overwritten per capability. So if you have an in-house Selenium | ||
| // grid with only 5 firefox instances available you can make sure that not more than | ||
| // 5 instances get started at a time. | ||
| maxInstances: 5, | ||
| // | ||
| browserName: 'firefox' | ||
| }], | ||
| // | ||
| // =================== | ||
| // Test Configurations | ||
| // =================== | ||
| // Define all options that are relevant for the WebdriverIO instance here | ||
| // | ||
| // By default WebdriverIO commands are executed in a synchronous way using | ||
| // the wdio-sync package. If you still want to run your tests in an async way | ||
| // e.g. using promises you can set the sync option to false. | ||
| sync: true, | ||
| // | ||
| // Level of logging verbosity: silent | verbose | command | data | result | error | ||
| logLevel: 'silent', | ||
| // | ||
| // Enables colors for log output. | ||
| coloredLogs: true, | ||
| // | ||
| // If you only want to run your tests until a specific amount of tests have failed use | ||
| // bail (default is 0 - don't bail, run all tests). | ||
| bail: 0, | ||
| // | ||
| // Saves a screenshot to a given path if a command fails. | ||
| screenshotPath: './errorShots/', | ||
| // | ||
| // Default timeout for all waitFor* commands. | ||
| waitforTimeout: 10000, | ||
| // | ||
| // Default timeout in milliseconds for request | ||
| // if Selenium Grid doesn't send response | ||
| connectionRetryTimeout: 90000, | ||
| // | ||
| // Default request retries count | ||
| connectionRetryCount: 3, | ||
| // | ||
| // Initialize the browser instance with a WebdriverIO plugin. The object should have the | ||
| // plugin name as key and the desired plugin options as properties. Make sure you have | ||
| // the plugin installed before running any tests. The following plugins are currently | ||
| // available: | ||
| // WebdriverCSS: https://github.com/webdriverio/webdrivercss | ||
| // WebdriverRTC: https://github.com/webdriverio/webdriverrtc | ||
| // Browserevent: https://github.com/webdriverio/browserevent | ||
| // plugins: { | ||
| // webdrivercss: { | ||
| // screenshotRoot: 'my-shots', | ||
| // failedComparisonsRoot: 'diffs', | ||
| // misMatchTolerance: 0.05, | ||
| // screenWidth: [320,480,640,1024] | ||
| // }, | ||
| // webdriverrtc: {}, | ||
| // browserevent: {} | ||
| // }, | ||
| // | ||
| // Test runner services | ||
| // Services take over a specific job you don't want to take care of. They enhance | ||
| // your test setup with almost no effort. Unlike plugins, they don't add new | ||
| // commands. Instead, they hook themselves up into the test process. | ||
| services: ['sauce', 'visual-regression'], | ||
|
|
||
| visualRegression: { | ||
| compare: new VisualRegressionCompare.LocalCompare({ | ||
| referenceName: getScreenshotName.bind(null, 'baseline'), | ||
| screenshotName: getScreenshotName.bind(null, 'latest'), | ||
| diffName: getScreenshotName.bind(null, 'diff') | ||
| }), | ||
| viewports: [{width: 300, height: 500}, {width: 800, height: 700}] | ||
| }, | ||
| // | ||
| // Framework you want to run your specs with. | ||
| // The following are supported: Mocha, Jasmine, and Cucumber | ||
| // see also: http://webdriver.io/guide/testrunner/frameworks.html | ||
| // | ||
| // Make sure you have the wdio adapter package for the specific framework installed | ||
| // before running any tests. | ||
| framework: 'mocha', | ||
| // | ||
| // Test reporter for stdout. | ||
| // The only one supported by default is 'dot' | ||
| // see also: http://webdriver.io/guide/testrunner/reporters.html | ||
| reporters: ['spec'], | ||
|
|
||
| // | ||
| // Options to be passed to Mocha. | ||
| // See the full list at http://mochajs.org/ | ||
| mochaOpts: { | ||
| ui: 'bdd', | ||
| timeout: mochaTimeout | ||
| }, | ||
| // | ||
| // ===== | ||
| // Hooks | ||
| // ===== | ||
| // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance | ||
| // it and to build services around it. You can either apply a single function or an array of | ||
| // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got | ||
| // resolved to continue. | ||
| /** | ||
| * Gets executed once before all workers get launched. | ||
| * @param {Object} config wdio configuration object | ||
| * @param {Array.<Object>} capabilities list of capabilities details | ||
| */ | ||
| // onPrepare: function (config, capabilities) { | ||
| // }, | ||
| /** | ||
| * Gets executed just before initialising the webdriver session and test framework. It allows you | ||
| * to manipulate configurations depending on the capability or spec. | ||
| * @param {Object} config wdio configuration object | ||
| * @param {Array.<Object>} capabilities list of capabilities details | ||
| * @param {Array.<String>} specs List of spec file paths that are to be run | ||
| */ | ||
| // beforeSession: function (config, capabilities, specs) { | ||
| // }, | ||
| /** | ||
| * Gets executed before test execution begins. At this point you can access to all global | ||
| * variables like `browser`. It is the perfect place to define custom commands. | ||
| * @param {Array.<Object>} capabilities list of capabilities details | ||
| * @param {Array.<String>} specs List of spec file paths that are to be run | ||
| */ | ||
| before: function (capabilities, specs) { | ||
| var chai = require('chai'); | ||
| var chaiWebdriver = require('chai-webdriverio').default; | ||
| chai.use(chaiWebdriver(browser)); | ||
|
|
||
| global.expect = chai.expect; | ||
| }// , | ||
| // | ||
| /** | ||
| * Hook that gets executed before the suite starts | ||
| * @param {Object} suite suite details | ||
| */ | ||
| // beforeSuite: function (suite) { | ||
| // }, | ||
| /** | ||
| * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling | ||
| * beforeEach in Mocha) | ||
| */ | ||
| // beforeHook: function () { | ||
| // }, | ||
| /** | ||
| * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling | ||
| * afterEach in Mocha) | ||
| */ | ||
| // afterHook: function () { | ||
| // }, | ||
| /** | ||
| * Function to be executed before a test (in Mocha/Jasmine) or a step (in Cucumber) starts. | ||
| * @param {Object} test test details | ||
| */ | ||
| // beforeTest: function (test) { | ||
| // }, | ||
| /** | ||
| * Runs before a WebdriverIO command gets executed. | ||
| * @param {String} commandName hook command name | ||
| * @param {Array} args arguments that command would receive | ||
| */ | ||
| // beforeCommand: function (commandName, args) { | ||
| // }, | ||
| /** | ||
| * Runs after a WebdriverIO command gets executed | ||
| * @param {String} commandName hook command name | ||
| * @param {Array} args arguments that command would receive | ||
| * @param {Number} result 0 - command success, 1 - command error | ||
| * @param {Object} error error object if any | ||
| */ | ||
| // afterCommand: function (commandName, args, result, error) { | ||
| // }, | ||
| /** | ||
| * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) starts. | ||
| * @param {Object} test test details | ||
| */ | ||
| // afterTest: function (test) { | ||
| // }, | ||
| /** | ||
| * Hook that gets executed after the suite has ended | ||
| * @param {Object} suite suite details | ||
| */ | ||
| // afterSuite: function (suite) { | ||
| // }, | ||
| /** | ||
| * Gets executed after all tests are done. You still have access to all global variables from | ||
| * the test. | ||
| * @param {Number} result 0 - test pass, 1 - test fail | ||
| * @param {Array.<Object>} capabilities list of capabilities details | ||
| * @param {Array.<String>} specs List of spec file paths that ran | ||
| */ | ||
| // after: function (result, capabilities, specs) { | ||
| // }, | ||
| /** | ||
| * Gets executed right after terminating the webdriver session. | ||
| * @param {Object} config wdio configuration object | ||
| * @param {Array.<Object>} capabilities list of capabilities details | ||
| * @param {Array.<String>} specs List of spec file paths that ran | ||
| */ | ||
| // afterSession: function (config, capabilities, specs) { | ||
| // }, | ||
| /** | ||
| * Gets executed after all workers got shut down and the process is about to exit. It is not | ||
| * possible to defer the end of the process using a promise. | ||
| * @param {Object} exitCode 0 - success, 1 - fail | ||
| */ | ||
| // onComplete: function(exitCode) { | ||
| // } | ||
| }; |
Oops, something went wrong.