2023-09-21 21:46:09 +00:00
|
|
|
import type { Options } from "@wdio/types";
|
web/add webdriverIO testing layer
This commit adds WebdriverIO as an end-to-end solution to unit testing. WebdriverIO can be run both
locally and remotely, supports strong integration with web components, and is generally robust for
use in pipelines. I'll confess to working through a tutorial on how to do this for web components,
and this is just chapter 2 (I think there are 5 or so chapters...).
There's a makefile, with help! If you just run `make` it tells you:
```
Specify a command. The choices are:
help Show this help
node_modules Runs `npm install` to prepare this feature
precommit Run the precommit: spell check all comments, eslint with sonarJS, prettier-write
test-good-login Test that we can log into the server. Requires a running instance of the server.
test-bad-login Test that bad usernames and passwords create appropriate error messages
```
... because Makefiles are documentation, and documentation belongs in Makefiles.
I've chosen to go with a PageObject-oriented low-level DSL; what that means is that for each major
components (a page, a form, a wizard), there's a class that provides human-readable names for
human-interactable and human-viewable objects on the page. The LoginPage object, for example, has
selectors for the username, password, submit button, and the failure alert; accessing those allows
us to test for items as expected., and to write a DSL for "a good login" that's as straightforward
as:
```
await LoginPage.open();
await LoginPage.login("ken@goauthentik.io", "eat10bugs");
await expect(UserLibraryPage.pageHeader).toHaveText("My applications");
```
There was a *lot* of messing around with the LoginPage to get the username and password into the
system. For example, I had to do this with all the `waitForClickable` and `waitForEnable` because
we both keep the buttons inaccessible until the form has something and we "black out" the page (put
a darkening filter over it) while accessing the flow, meaning there was a race condition such that
the test would attempt to interact with the username or password field before it was accessible.
But this works now, which is very nice.
``` JavaScript
get inputUsername() {
return $('>>>input[name="uidField"]');
}
get btnSubmit() {
return $('>>>button[type="submit"]');
}
async username(username: string) {
await this.inputUsername.waitForClickable();
await this.inputUsername.setValue(username);
await this.btnSubmit.waitForEnabled();
await this.btnSubmit.click();
}
```
The bells & whistles of *Prettier*, *Eslint*, and *Codespell* have also been enabled. I do like my
guardrails.
2023-09-22 18:12:52 +00:00
|
|
|
|
2023-09-21 21:46:09 +00:00
|
|
|
export const config: Options.Testrunner = {
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
// ====================
|
|
|
|
|
// Runner Configuration
|
|
|
|
|
// ====================
|
2023-09-21 21:46:09 +00:00
|
|
|
// WebdriverIO supports running e2e tests as well as unit and component tests.
|
2023-08-28 22:33:59 +00:00
|
|
|
runner: "local",
|
2023-09-21 21:46:09 +00:00
|
|
|
autoCompileOpts: {
|
|
|
|
|
autoCompile: true,
|
|
|
|
|
tsNodeOpts: {
|
|
|
|
|
project: "./tsconfig.json",
|
|
|
|
|
transpileOnly: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
// ==================
|
|
|
|
|
// Specify Test Files
|
|
|
|
|
// ==================
|
|
|
|
|
// Define which test specs should run. The pattern is relative to the directory
|
2023-09-21 21:46:09 +00:00
|
|
|
// of the configuration file being run.
|
|
|
|
|
//
|
|
|
|
|
// The specs are defined as an array of spec files (optionally using wildcards
|
|
|
|
|
// that will be expanded). The test for each spec file will be run in a separate
|
|
|
|
|
// worker process. In order to have a group of spec files run in the same worker
|
|
|
|
|
// process simply enclose them in an array within the specs array.
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
2023-09-21 21:46:09 +00:00
|
|
|
// 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/specs/**/*.ts"],
|
2023-08-28 22:33:59 +00:00
|
|
|
// Patterns to exclude.
|
|
|
|
|
exclude: [
|
|
|
|
|
// 'path/to/excluded/files'
|
|
|
|
|
],
|
|
|
|
|
//
|
|
|
|
|
// ============
|
|
|
|
|
// 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.
|
|
|
|
|
//
|
2023-09-21 21:46:09 +00:00
|
|
|
maxInstances: 1,
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
// If you have trouble getting all important capabilities together, check out the
|
|
|
|
|
// Sauce Labs platform configurator - a great tool to configure your capabilities:
|
2023-09-21 21:46:09 +00:00
|
|
|
// https://saucelabs.com/platform/platform-configurator
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
capabilities: [
|
|
|
|
|
{
|
2023-09-25 22:20:32 +00:00
|
|
|
"browserName": "chrome",
|
|
|
|
|
"goog:chromeOptions": {
|
|
|
|
|
args: ["--disable-infobars", "--window-size=1280,800"].concat(
|
|
|
|
|
(function () {
|
|
|
|
|
return process.env.HEADLESS_CHROME === "1"
|
|
|
|
|
? [
|
|
|
|
|
"--headless",
|
|
|
|
|
"--no-sandbox",
|
|
|
|
|
"--disable-gpu",
|
|
|
|
|
"--disable-setuid-sandbox",
|
|
|
|
|
"--disable-dev-shm-usage",
|
|
|
|
|
]
|
|
|
|
|
: [];
|
2023-09-28 21:45:57 +00:00
|
|
|
})(),
|
2023-09-25 22:20:32 +00:00
|
|
|
),
|
|
|
|
|
},
|
2023-08-25 18:12:13 +00:00
|
|
|
},
|
|
|
|
|
],
|
2023-09-21 21:46:09 +00:00
|
|
|
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
// ===================
|
|
|
|
|
// Test Configurations
|
|
|
|
|
// ===================
|
|
|
|
|
// Define all options that are relevant for the WebdriverIO instance here
|
|
|
|
|
//
|
|
|
|
|
// Level of logging verbosity: trace | debug | info | warn | error | silent
|
2023-09-27 22:30:56 +00:00
|
|
|
logLevel: "warn",
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
// Set specific log levels per logger
|
|
|
|
|
// loggers:
|
|
|
|
|
// - webdriver, webdriverio
|
2023-09-21 21:46:09 +00:00
|
|
|
// - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service
|
2023-08-28 22:33:59 +00:00
|
|
|
// - @wdio/mocha-framework, @wdio/jasmine-framework
|
|
|
|
|
// - @wdio/local-runner
|
|
|
|
|
// - @wdio/sumologic-reporter
|
2023-09-21 21:46:09 +00:00
|
|
|
// - @wdio/cli, @wdio/config, @wdio/utils
|
2023-08-28 22:33:59 +00:00
|
|
|
// Level of logging verbosity: trace | debug | info | warn | error | silent
|
|
|
|
|
// logLevels: {
|
|
|
|
|
// webdriver: 'info',
|
2023-09-21 21:46:09 +00:00
|
|
|
// '@wdio/appium-service': 'info'
|
2023-08-28 22:33:59 +00:00
|
|
|
// },
|
|
|
|
|
//
|
|
|
|
|
// 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,
|
|
|
|
|
//
|
|
|
|
|
// Set a base URL in order to shorten url command calls. If your `url` parameter starts
|
|
|
|
|
// with `/`, the base url gets prepended, not including the path portion of your baseUrl.
|
|
|
|
|
// If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
|
|
|
|
|
// gets prepended directly.
|
|
|
|
|
baseUrl: "http://localhost",
|
|
|
|
|
//
|
|
|
|
|
// Default timeout for all waitFor* commands.
|
|
|
|
|
waitforTimeout: 10000,
|
|
|
|
|
//
|
|
|
|
|
// Default timeout in milliseconds for request
|
|
|
|
|
// if browser driver or grid doesn't send response
|
|
|
|
|
connectionRetryTimeout: 120000,
|
|
|
|
|
//
|
|
|
|
|
// Default request retries count
|
|
|
|
|
connectionRetryCount: 3,
|
|
|
|
|
//
|
|
|
|
|
// 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.
|
2023-09-21 21:46:09 +00:00
|
|
|
// services: [],
|
|
|
|
|
//
|
2023-08-28 22:33:59 +00:00
|
|
|
// Framework you want to run your specs with.
|
|
|
|
|
// The following are supported: Mocha, Jasmine, and Cucumber
|
2023-09-21 21:46:09 +00:00
|
|
|
// see also: https://webdriver.io/docs/frameworks
|
2023-08-28 22:33:59 +00:00
|
|
|
//
|
|
|
|
|
// Make sure you have the wdio adapter package for the specific framework installed
|
|
|
|
|
// before running any tests.
|
|
|
|
|
framework: "mocha",
|
|
|
|
|
//
|
|
|
|
|
// The number of times to retry the entire specfile when it fails as a whole
|
|
|
|
|
// specFileRetries: 1,
|
|
|
|
|
//
|
|
|
|
|
// Delay in seconds between the spec file retry attempts
|
|
|
|
|
// specFileRetriesDelay: 0,
|
|
|
|
|
//
|
2023-09-21 21:46:09 +00:00
|
|
|
// Whether or not retried spec files should be retried immediately or deferred to the end of the queue
|
2023-08-28 22:33:59 +00:00
|
|
|
// specFileRetriesDeferred: false,
|
|
|
|
|
//
|
|
|
|
|
// Test reporter for stdout.
|
|
|
|
|
// The only one supported by default is 'dot'
|
2023-09-21 21:46:09 +00:00
|
|
|
// see also: https://webdriver.io/docs/dot-reporter
|
|
|
|
|
reporters: ["spec"],
|
2023-08-28 22:33:59 +00:00
|
|
|
|
|
|
|
|
//
|
|
|
|
|
// Options to be passed to Mocha.
|
|
|
|
|
// See the full list at http://mochajs.org/
|
|
|
|
|
mochaOpts: {
|
|
|
|
|
ui: "bdd",
|
2023-09-21 21:46:09 +00:00
|
|
|
timeout: 60000,
|
2023-08-28 22:33:59 +00:00
|
|
|
},
|
|
|
|
|
//
|
|
|
|
|
// =====
|
|
|
|
|
// 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.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} config wdio configuration object
|
2023-08-28 22:33:59 +00:00
|
|
|
* @param {Array.<Object>} capabilities list of capabilities details
|
|
|
|
|
*/
|
|
|
|
|
// onPrepare: function (config, capabilities) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Gets executed before a worker process is spawned and can be used to initialise specific service
|
|
|
|
|
* for that worker as well as modify runtime environments in an async fashion.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {string} cid capability id (e.g 0-0)
|
|
|
|
|
* @param {object} caps object containing capabilities for session that will be spawn in the worker
|
|
|
|
|
* @param {object} specs specs to be run in the worker process
|
|
|
|
|
* @param {object} args object that will be merged with the main configuration once worker is initialized
|
|
|
|
|
* @param {object} execArgv list of string arguments passed to the worker process
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
|
|
|
|
// onWorkerStart: function (cid, caps, specs, args, execArgv) {
|
|
|
|
|
// },
|
2023-09-21 21:46:09 +00:00
|
|
|
/**
|
|
|
|
|
* Gets executed just after a worker process has exited.
|
|
|
|
|
* @param {string} cid capability id (e.g 0-0)
|
|
|
|
|
* @param {number} exitCode 0 - success, 1 - fail
|
|
|
|
|
* @param {object} specs specs to be run in the worker process
|
|
|
|
|
* @param {number} retries number of retries used
|
|
|
|
|
*/
|
|
|
|
|
// onWorkerEnd: function (cid, exitCode, specs, retries) {
|
|
|
|
|
// },
|
2023-08-28 22:33:59 +00:00
|
|
|
/**
|
|
|
|
|
* Gets executed just before initialising the webdriver session and test framework. It allows you
|
|
|
|
|
* to manipulate configurations depending on the capability or spec.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} config wdio configuration object
|
2023-08-28 22:33:59 +00:00
|
|
|
* @param {Array.<Object>} capabilities list of capabilities details
|
|
|
|
|
* @param {Array.<String>} specs List of spec file paths that are to be run
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {string} cid worker id (e.g. 0-0)
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
2023-09-21 21:46:09 +00:00
|
|
|
// beforeSession: function (config, capabilities, specs, cid) {
|
2023-08-28 22:33:59 +00:00
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* 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
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} browser instance of created browser/device session
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
2023-09-27 22:30:56 +00:00
|
|
|
before: function (capabilities, specs) {
|
|
|
|
|
},
|
2023-08-28 22:33:59 +00:00
|
|
|
/**
|
|
|
|
|
* Runs before a WebdriverIO command gets executed.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {string} commandName hook command name
|
2023-08-28 22:33:59 +00:00
|
|
|
* @param {Array} args arguments that command would receive
|
|
|
|
|
*/
|
|
|
|
|
// beforeCommand: function (commandName, args) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Hook that gets executed before the suite starts
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} suite suite details
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
|
|
|
|
// beforeSuite: function (suite) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Function to be executed before a test (in Mocha/Jasmine) starts.
|
|
|
|
|
*/
|
|
|
|
|
// beforeTest: function (test, context) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
|
|
|
|
|
* beforeEach in Mocha)
|
|
|
|
|
*/
|
|
|
|
|
// beforeHook: function (test, context) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
|
|
|
|
|
* afterEach in Mocha)
|
|
|
|
|
*/
|
|
|
|
|
// afterHook: function (test, context, { error, result, duration, passed, retries }) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
2023-09-21 21:46:09 +00:00
|
|
|
* Function to be executed after a test (in Mocha/Jasmine only)
|
|
|
|
|
* @param {object} test test object
|
|
|
|
|
* @param {object} context scope object the test was executed with
|
|
|
|
|
* @param {Error} result.error error object in case the test fails, otherwise `undefined`
|
|
|
|
|
* @param {*} result.result return object of test function
|
|
|
|
|
* @param {number} result.duration duration of test
|
|
|
|
|
* @param {boolean} result.passed true if test has passed, otherwise false
|
|
|
|
|
* @param {object} result.retries information about spec related retries, e.g. `{ attempts: 0, limit: 0 }`
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
|
|
|
|
// afterTest: function(test, context, { error, result, duration, passed, retries }) {
|
|
|
|
|
// },
|
2023-08-25 18:12:13 +00:00
|
|
|
|
2023-08-28 22:33:59 +00:00
|
|
|
/**
|
|
|
|
|
* Hook that gets executed after the suite has ended
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} suite suite details
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
|
|
|
|
// afterSuite: function (suite) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Runs after a WebdriverIO command gets executed
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {string} commandName hook command name
|
2023-08-28 22:33:59 +00:00
|
|
|
* @param {Array} args arguments that command would receive
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {number} result 0 - command success, 1 - command error
|
|
|
|
|
* @param {object} error error object if any
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
|
|
|
|
// afterCommand: function (commandName, args, result, error) {
|
|
|
|
|
// },
|
|
|
|
|
/**
|
|
|
|
|
* Gets executed after all tests are done. You still have access to all global variables from
|
|
|
|
|
* the test.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {number} result 0 - test pass, 1 - test fail
|
2023-08-28 22:33:59 +00:00
|
|
|
* @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.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} config wdio configuration object
|
2023-08-28 22:33:59 +00:00
|
|
|
* @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. An error
|
|
|
|
|
* thrown in the onComplete hook will result in the test run failing.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {object} exitCode 0 - success, 1 - fail
|
|
|
|
|
* @param {object} config wdio configuration object
|
2023-08-28 22:33:59 +00:00
|
|
|
* @param {Array.<Object>} capabilities list of capabilities details
|
|
|
|
|
* @param {<Object>} results object containing test results
|
|
|
|
|
*/
|
2023-09-21 21:46:09 +00:00
|
|
|
// onComplete: function(exitCode, config, capabilities, results) {
|
|
|
|
|
// },
|
2023-08-28 22:33:59 +00:00
|
|
|
/**
|
|
|
|
|
* Gets executed when a refresh happens.
|
2023-09-21 21:46:09 +00:00
|
|
|
* @param {string} oldSessionId session ID of the old session
|
|
|
|
|
* @param {string} newSessionId session ID of the new session
|
2023-08-28 22:33:59 +00:00
|
|
|
*/
|
|
|
|
|
// onReload: function(oldSessionId, newSessionId) {
|
|
|
|
|
// }
|
|
|
|
|
};
|
