7 |
8 | Firefox driver is included in the selenium-server-standalone.jar available in the Selenium downloads. The driver comes in the form of an xpi (firefox extension) which is added to the firefox profile when you start a new instance of FirefoxDriver.
9 |
10 | ### Available CLI arguments
11 | These can be found on the [FirefoxDriver page](https://code.google.com/p/selenium/wiki/FirefoxDriver#Important_System_Properties).
12 |
13 | Settings for the Firefox profile, which can be set via the desiredCapabilities, can be found [**here**](https://code.google.com/p/selenium/wiki/DesiredCapabilities#settings).
--------------------------------------------------------------------------------
/docs/guide/overview/whats-new.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Nightwatch release history
3 | description: Stay upto date with the release wise updates of the different versions of Nightwatch
4 | ---
5 |
6 | # Release history
7 |
8 |
31 |
--------------------------------------------------------------------------------
/docs/api/expect/_element.md:
--------------------------------------------------------------------------------
1 | ## expect.element()
2 |
3 | Expect assertions operating on a single element, specified by its CSS/Xpath selector.
4 |
5 | ##### Syntax:
6 |
7 |
browser.element('#selector')
8 |
9 |
10 | ##### Parameters:
11 |
12 |
13 |
14 |
15 |
Name
16 |
Type
17 |
description
18 |
19 |
20 |
21 |
22 |
selector
23 |
String
24 |
The CSS/XPath selector of the element to be inspected.
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/public/images/images1/youtube.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/src/includes/ga.ejs:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/api/expect/element/index.md:
--------------------------------------------------------------------------------
1 | ## Expect API
2 |
3 | ### Overview
4 |
5 | Nightwatch provides a fluent BDD-style interface for performing assertions on elements, defined on the `expect` namespace on the main Nightwatch instance.
6 | It is based on the Chai Expect assertion library and provides a greater level of flexibility,
7 | also adding new capabilities over the classic `assert` interface.
8 |
9 | It uses a chain-able language to construct assertions given an element specified by a css/xpath selector. A simple example looks like the following:
10 |
11 | ```javascript
12 | describe('expect example', function() {
13 | it('sample test', function (browser) {
14 | // start with identifying the element
15 | // and then assert the element is present
16 | browser.expect.element('#main').to.be.present;
17 | // or assert the element is visible
18 | browser.expect.element('#main').to.be.visible;
19 | });
20 | }
21 | ```
--------------------------------------------------------------------------------
/docs/api/expect/elements/index.md:
--------------------------------------------------------------------------------
1 | ## Expect API
2 |
3 | ### Overview
4 |
5 | Nightwatch provides a fluent BDD-style interface for performing assertions on elements, defined on the `expect` namespace on the main Nightwatch instance.
6 | It is based on the Chai Expect assertion library and provides a greater level of flexibility,
7 | also adding new capabilities over the classic `assert` interface.
8 |
9 | It uses a chain-able language to construct assertions given an element specified by a css/xpath selector. A simple example looks like the following:
10 |
11 | ```javascript
12 | describe('expect example', function() {
13 | it('sample test', function (browser) {
14 | // start with identifying the element
15 | // and then assert the element is present
16 | browser.expect.element('#main').to.be.present;
17 | // or assert the element is visible
18 | browser.expect.element('#main').to.be.visible;
19 | });
20 | }
21 | ```
--------------------------------------------------------------------------------
/public/images/images1/email.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/public/images/images1/html.svg:
--------------------------------------------------------------------------------
1 |
8 |
--------------------------------------------------------------------------------
/public/images/landing/integrations/html.svg:
--------------------------------------------------------------------------------
1 |
8 |
--------------------------------------------------------------------------------
/public/img/icons/management-128.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/api/method/end.md:
--------------------------------------------------------------------------------
1 | ### Overview
2 | Behind the scenes, the `end` commands sends a `DELETE` request to the WebDriver server, passing the current `sessionId` property.
3 | After the `DELETE` is done, the `sessionId` is null-ed.
4 |
5 | If the `sessionId` is not set, the callback is invoked right away and complete event is signaled.
6 |
7 | #### Taking screenshots on failures/errors
8 | If test failures or errors exist and screenshots are enabled, then screenshots are taken prior to sending the `DELETE`.
9 |
10 | To enable screenshots for test failures/errors, set the `screenshots` property in your `nightwatch.json`, under the desired `test_settings` environment. E.g.:
11 |
12 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2015 Andrei Rusu
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
6 | this software and associated documentation files (the "Software"), to deal in
7 | the Software without restriction, including without limitation the rights to
8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 | of the Software, and to permit persons to whom the Software is furnished to do
10 | so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/public/images/images1/circleci.svg:
--------------------------------------------------------------------------------
1 |
11 |
--------------------------------------------------------------------------------
/src/includes/rightSidebarContent.ejs:
--------------------------------------------------------------------------------
1 | <%
2 | const pageContent = page.content || '';
3 | const content = [...pageContent.matchAll(/]*id="([^"]+)".*?>(?:]*>([^<]+)<\/a>|([^<]+))<\/h3>/g)]
4 | .map(([_, id, titleWithLink, titleWithoutLink]) => ({
5 | id,
6 | title: titleWithLink ? titleWithLink : titleWithoutLink
7 | }));
8 | %>
9 |
10 |
7 |
8 | Another useful concept that Nightwatch provides is test globals. In its most simple form, it is a dictionary of name-value pairs which is defined in your configuration file.
9 |
10 | Globals can be defined either as a `"globals"` property or as an external file which is specified as the `"globals_path"` property.
11 |
12 | Here's an example definition using the `"globals"` property in `nightwatch.json`:
13 |
14 |
32 |
33 | Like the `launch_url` property, the `globals` object is made available directly on the Nightwatch api which is passed to the tests.
34 |
35 |
44 |
45 |
46 | ### Recommended content
47 | - [Reference > All configuration settings](/guide/reference/settings.html)
48 | - [Reference > Configuration defaults](/guide/reference/defaults.html)
--------------------------------------------------------------------------------
/docs/guide/running-tests/test-tags.md:
--------------------------------------------------------------------------------
1 | ## Using Test Tags
2 |
3 | You can also selectively target tests to run based on tags, such that a test may be belong to multiple tags. For example, you might have a login test that belongs to a login suite as well as a sanity suite.
4 |
5 | The tagging can be accomplished by adding the `@tags` property to a test module:
6 |
7 |
36 |
37 |
38 | To skip running tests with a specific tag, use the `--skiptags` flag:
39 |
40 |
nightwatch --skiptags login
41 |
42 | Or to skip multiple tags, add each tag you want to skip as comma-separated:
43 |
44 |
nightwatch --skiptags login,something_else
45 |
46 | - Previous: [Using Test Groups](/guide/running-tests/test-groups.html)
47 | - Next: [Running in Parallel](/guide/running-tests/parallel-running.html)
48 |
--------------------------------------------------------------------------------
/public/images/images1/capabilities1.svg:
--------------------------------------------------------------------------------
1 |
14 |
--------------------------------------------------------------------------------
/docs/guide/configuration/taking-screenshots-on-fail.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Taking screenshots on failures/errors
3 | description: Learn how to enable taking screenshots on failures/errors in Nightwatch.
4 | ---
5 |
6 |
Taking screenshots on failures/errors
7 |
8 | If test failures or errors exist and screenshots are enabled, then screenshots are taken prior to sending the `DELETE`.
9 |
10 | To enable screenshots for test failures/errors, set the `screenshots` property in your `nightwatch.json`, under the desired `test_settings` environment. E.g.:
11 |
12 |
--------------------------------------------------------------------------------
/public/images/images1/bamboo.svg:
--------------------------------------------------------------------------------
1 |
22 |
--------------------------------------------------------------------------------
/docs/guide/resources/migrating-to-nightwatch-2.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Migrating to Nightwatch 2.0
3 | description: Learn how to migrate to Nightwatch 2.0.
4 | ---
5 |
6 |
Migrating to Nightwatch 2
7 |
8 | Below is a list of potentially breaking changes in version 2.0 and deprecated functionality which was removed. All attempts have been made to ensure a complete and accurate list, but there might be things which we overlooked.
9 |
10 | We have tried to minimize the amount of breaking changes as much as possible but some of them were difficult to avoid.
11 |
12 | ### Using ES6 async/await
13 | When using ES6 async/await test cases, the result value of Nightwatch commands does not contain the `status` and `value` properties anymore, but simply the `value` (this can be reversed by setting `backwards_compatibility_mode` to `true` in your nightwatch config).
14 |
15 | ### Element locate errors:
16 | Changes in the result object:
17 | - contains an `error` property which is an Error object instance
18 | - no longer contains `httpStatusCode` property
19 | - no longer contains `value` property
20 |
21 | ### Dependencies
22 | - removed `proxy-agent` as dependency since it was frequently causing dependency issues; the [proxy-agent](https://www.npmjs.com/package/proxy-agent) package can be installed separately from NPM and used in the same way.
23 |
24 | ### Other
25 | - removed .startWebDriver() / .stopWebDriver() from the CLI Runner since the Webdriver service is now managed by the `selenium-webdriver`.
26 | See https://github.com/nightwatchjs/nightwatch/issues/2918
27 | - remove setting `webdriver.use_legacy_jsonwire`
28 | - removed event `nightwatch:finished` from main client instance
29 | - no longer possible to use Nightwatch with Webdriver.io, as was advertised [here](https://v17.nightwatchjs.org/guide/extending-nightwatch/using-with-webdriverio.html).
30 |
31 |
--------------------------------------------------------------------------------
/public/images/images1/nav-github.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/docs/guide/running-tests/test-environments.md:
--------------------------------------------------------------------------------
1 | ## Using Test Environments
2 |
3 | Test environments are a useful concept which Nightwatch provides to be used for a better structure of configuration for using large-scale projects. For a complete overview of what test environments are and how they can be used, please refer to the [Defining test environments](/guide/concepts/test-environments.html#defining-test-environments) page in the Getting Started section.
4 |
5 | You can define multiple sections (environments) in `test_settings` so you could overwrite specific values per environment.
6 |
A "default" environment is required. All the other environments are inheriting from default and can overwrite settings as needed.
7 |
8 | An environment inherits all the base settings and all the settings defined under the "default" environment.
9 |
10 |
29 |
30 |
31 | The key of the settings group can be passed then to the runner as the `--env` argument to use the specified settings, like so:
32 |
33 |
nightwatch --env integration
34 |
35 | This can be useful if you need to have different settings for your local machine and the Continuous Integration server.
36 |
37 | ### Further Reading:
38 | - [Understanding Test Environments](/gettingstarted/concepts/#defining-test-environments)
39 | - Previous: [Command-line Options](/guide/running-tests/command-line-options.html)
40 | - Next: [Using Test Groups](/guide/running-tests/test-groups.html)
41 |
--------------------------------------------------------------------------------
/public/images/images1/discord.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/public/img/icons/remote-128.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/guide/debugging-tests/overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Debugging tests
3 | description: Learn how to debugs tests using Nightwatch tools
4 | ---
5 |
6 |
Debugging tests
7 |
8 | ### Overview
9 |
10 | Starting with v2.3.0, Nightwatch presents a more powerful test script debugging experience. It includes an updated `.pause()` command (without any breaking changes) and a new `.debug()` command.
11 |
12 | #### Updated .pause() command
13 |
14 | The [`.pause()`](/api/pause.html) command now provides the ability to resume paused tests on-demand while debugging. In addition, users can also step over to the next test step (execute the next test step) and pause again.
15 |
16 | #### New .debug() command
17 |
18 | The new [`.debug()`](/api/debug.html) command provides a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) interface where users can try out any of the available Nightwatch commands or assertions and see them get executed in the running browser, in real-time.
19 |
20 |
21 |
22 | ### Recommended content
23 | - [API docs > `.pause()`](/api/pause.html)
24 | - [API docs > `.debug()`](/api/debug.html)
25 |
26 |
58 |
--------------------------------------------------------------------------------
/docs/guide/running-tests/nightwatch-runner.md:
--------------------------------------------------------------------------------
1 | ## Nightwatch CLI Runner
2 |
3 | Nightwatch includes a command-line test runner which makes it easy to run tests and generate useful output. Please refer to the [Installation](https://new.nightwatchjs.org/gettingstarted/#installation) section for details on how to get the runner installed. There are a few different options on how to use the test runner, depending on your installation type.
4 |
5 | #### Global
6 | If you have installed Nightwatch globally (with `-g` option), the binary `nightwatch` will be available anywhere:
7 |
8 |
nightwatch [source] [options]
9 |
10 | #### Project specific
11 | If you have Nightwatch installed as a dependency of your project, you can refer the binary from the `node_modules/.bin` folder or use the [`npx`](https://www.npmjs.com/package/npx) command which is provided by NPM.
12 |
13 |
npx nightwatch [source] [options]
14 |
15 | ##### Linux and MacOSX:
16 |
./node_modules/.bin/nightwatch [source] [options]
17 |
18 | ##### Windows:
19 | Create a file `nightwatch.js` and add the following line:
20 |
21 |
require('nightwatch/bin/runner.js');
22 |
23 | Then run as follows:
24 |
25 |
node nightwatch.js [source] [options]
26 |
27 | ### Tests source
28 | The optional `source` argument can be either one or more files or an entire folder. This can be located irrespectively of the `src_folders` setting.
29 |
30 | ##### Example - single test:
31 |
32 |
37 | [Clear Value] Test Suite
38 | ============================
39 |
40 | Running: clearValue example test
41 | ✔ Element <input[type=text]> was visible after 68 milliseconds.
42 | ✔ Expected element <#rcnt> text to contain: "nightwatchjs.org/" - condition was met in 763ms
43 | ✔ Expected element <#rcnt> text to equal: "" - condition was met in 36ms
44 |
45 | OK. 3 assertions passed. (7.593s)
46 |
47 |
48 |
49 | ### Possible Errors
50 |
51 | Here are the type of errors that you might get when using `clearValue`. Full error details are available when running nightwatch with `--verbose` flag.
52 |
53 | - ```invalid element state``` - if the referenced element is disabled or is not displayed.
54 | - ```element not visible``` - if the referenced element is not visible on the page (either is hidden by CSS, has 0-width, or has 0-height)
55 |
--------------------------------------------------------------------------------
/docs/guide/extending-nightwatch/adding-custom-reporters.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Create custom reporters
3 | description: Learn how to extend Nightwatch capabilities by adding custom reporters.
4 | ---
5 |
6 |
Create custom reporters
7 |
8 | ### Overview
9 |
10 | If you'd like to define your own reporter in addition to the built-in ones (stdout and jUnit-xml) you can do so in two ways:
11 |
12 | ### `--reporter` command-line argument
13 | Define your reporter in a separate file, using the below interface, and then specify the path to the file using the `--reporter` cli argument.
14 |
15 | #### Interface:
16 |
22 |
23 | ### via external globals
24 |
25 | Add your reporter in the external globals file. Read more about [external globals](/guide/concepts/test-globals.html).
26 |
27 | See the provided [globalsModule.js](https://github.com/nightwatchjs/nightwatch/blob/main/examples/globalsModule.js) for an example.
28 |
29 | #### Example:
30 |
59 |
--------------------------------------------------------------------------------
/public/img/icons/noconfig-128.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/public/images/images1/slack.svg:
--------------------------------------------------------------------------------
1 |
14 |
--------------------------------------------------------------------------------
/public/images/landing/integrations/slack.svg:
--------------------------------------------------------------------------------
1 |
14 |
--------------------------------------------------------------------------------
/docs/guide/working-with-page-objects/using-page-objects.md:
--------------------------------------------------------------------------------
1 | ## Using Page Objects
2 |
3 | The Page Objects methodology is a popular pattern to write end-to-end tests by wrapping the pages or page fragments of a web app into objects.
4 | The purpose of a page object is to allow a software client to do anything and see anything that a human can by abstracting away the underlying html actions needed to access and manipulate the page.
5 |
6 | A comprehensive introduction to Page Objects can be found in this article.
7 |
8 |
9 | As of version 1.0 Nightwatch does not support legacy page objects written prior to version 0.7.
10 |
11 |
12 |
13 | ### Configuring Page Objects
14 |
15 | To create a page object simply create an object with properties that describe the page. Each page object should be located in a separate file, located in a designated folder. Nightwatch reads the page objects from the folder (or folders) specified in the `page_objects_path` configuration property.
16 |
17 | The `page_objects_path` property can also be an array of folders, allowing you thus to logically split the page objects into smaller groups.
18 |
19 |
20 | #### The Url property
21 |
22 | You can optionally add a `url` property that designates the page's URL. To navigate to the page, you can call the `navigate` method on the page object.
23 |
24 | The URL will usually be defined as a string:
25 |
26 |
33 |
34 | It can also be a function in case the URL is dynamic. One use case for this is to support different test environments. You can create a function that gets called in the context of the page, thus allowing you to do:
35 |
36 |
4 |
5 | Nightwatch makes it very easy to write automated End-to-End tests using the preferred CSS selector model to locate elements on a page.
6 |
7 | Create a separate folder for tests in your project, e.g.: `tests`. Each file inside it will be loaded as a test suite by the Nightwatch test runner.
8 |
9 | #### Basic Example
10 | Here's a basic test suite example which opens the search engine [Ecosia.org][1], searches for the term "nightwatch", then verifies if the term first result is the Nightwatch.js website.
11 |
12 |
51 |
52 | - Next: [Using BDD describe](/guide/using-nightwatch/using-bdd-describe.html)
53 |
54 | [1]: https://www.ecosia.org/
55 |
--------------------------------------------------------------------------------
/public/img/icons/plugins-128.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/guide/running-tests/using-with-test-groups.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Grouping tests with Nightwatch
3 | description: Learn how to group tests together for better organization of the test suite.
4 | ---
5 |
6 |
Grouping tests with Nightwatch
7 |
8 | ### Overview
9 | Nightwatch makes it possible to organize your test scripts into groups and run them as needed. To group tests together just place them in the same sub-folder. The folder name is the name of the group.
10 |
11 | ### Example
12 |
7 |
8 | Nightwatch supports running the tests in parallel in two main ways:
9 | - via test workers
10 | - by running multiple test environments in parallel
11 |
12 | ### Via test workers
13 |
14 | When this is enabled the test runner will launch a configurable number of child processes and then distribute the loaded tests over to be ran in parallel.
15 |
16 | Test concurrency is done at the file level. Each test file will fill a test worker slot. Individual tests/steps in a test file will not run concurrently.
17 |
18 | ### Multiple environments
19 |
20 | Nightwatch also supports running tests across multiple browsers in parallel.
21 |
22 | You can create a separate environment per browser (by chaining desiredCapabilities) and then run them in parallel. In addition, using the filter and exclude options tests can be split per environment in order to be ran in parallel.
23 |
24 | ### Via workers + multiple environments
25 |
26 | It is very useful to be able to run your tests against multiple browsers in parallel and also distribute your testcases across multiple workers.
27 | From **v1.7** you are able to do just that.
28 |
29 | ### Recommended content
30 | - [Define and use test environments](/guide/configuration/define-test-environments.html)
31 | - [How-to guide > Run tests in parallel](/guide/running-tests/parallel-running.html)
32 |
33 |
2 |
3 | Starting with version `v1.1` it is also possible to write tests as an ES6 [async function][8].
4 | Simply by doing so, it will enable the API commands to return a promise and thus making it possible to use the [`await`][9] operator to retrieve the result, instead of the callback, as it is by default.
5 |
6 | This greatly improves the readability and ease of writing of tests. Chaining the API commands when using an async function is possible since version 1.7.
7 |
8 |
9 |
module.exports = {
10 | 'demo test async': async function (browser) {
11 | // get the available window handles
12 | const result = await browser.windowHandles();
13 | console.log('result', result);
14 |
15 | // switch to the second window
16 | // await is not necessary here since we're not interested in the result
17 | browser.switchWindow(result.value[1]);
18 | }
19 | };
20 |
21 | #### Callbacks and async testcases
22 |
23 | Callbacks can still be used as before and if the callback returns a `Promise`, the result of the promise will be the result of the command. See below for an example:
24 |
25 |
26 |
module.exports = {
27 | 'demo test async': async function (browser) {
28 | // get the available window handles
29 | const value = await browser.windowHandles(function(result) {
30 | // we only want the value, not the entire result object
31 | return Promise.resolve(result.value);
32 | });
33 |
34 | console.log('value', value);
35 |
36 | // switch to the second window
37 | browser.switchWindow(value[1]);
38 | }
39 | };
40 |
41 | - Previous: [Using BDD describe](/guide/using-nightwatch/using-bdd-describe.html)
42 | - Next: [Finding & Interacting with Elements](/guide/using-nightwatch/finding-and-interacting-with-elements.html)
43 |
44 | [8]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function
45 | [9]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await
46 |
--------------------------------------------------------------------------------
/docs/guide/browser-drivers/safaridriver.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Safari Driver
3 | description: Learn about how to use Safari Driver with Nightwatch
4 | ---
5 |
6 |
SafariDriver
7 |
8 | Run your Nightwatch.js tests in Safari using SafariDriver.
9 |
10 | Starting Safari 10, the `safaridriver` is pre-installed if Safari is installed in your OS. You don't need to explicitly install the if you have the Safari browser installed. Support for the legacy `safaridriver` has been removed in recent versions of Selenium, which you can [track here][2].
11 |
12 | ### SafariDriver for pre-Selenium 2.45.0 version
13 |
14 | In earlier versions, pre-Selenium 2.45.0, the SafariDriver acts as an extension to the Safari browser that can be downloaded from [here][1].
15 |
16 | To install SafariDriver:
17 |
18 | 1. From folder that matches the version of Selenium you're using, search and download the `SafariDriver.safariextz` file.
19 | 2. Open Safari and click the **File** menu.
20 | 3. Select the SafariDriver extension package,`SafariDriver.safariextz`, you downloaded and click **Open**.
21 |
22 | You can now use Safari in your test scripts in the `browserName` key under your your `desiredCapabilities` key as a browser:
23 |
--------------------------------------------------------------------------------
/docs/guide/browser-drivers/edgedriver.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Microsoft Edge WebDriver
3 | description: Learn about how to use Microsoft Edge WebDriver with Nightwatch
4 | ---
5 |
6 |
EdgeDriver
7 |
8 | Run your Nightwatch.js tests in Edge can be achieved using the [Microsoft Edge WebDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/).
9 |
10 | ### Downloading EdgeDriver
11 |
12 | **Step 1. Download Microsoft Edge WebDriver** - Depending on the version of your Edge Browser, download the relevant [Microsoft Edge WebDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/).
13 |
14 | **Step 2. Configure the path** - You can either add the path to the Microsoft Edge WebDriver binary to the system PATH or set the location in the `cli_args` key under the `selenium` key in your `nightwatch.json` file as follows:
15 |
34 |
35 | ### Learn more
36 |
37 | For more information about the Microsoft Edge WebDriver refer to the [Official documentation](https://developer.microsoft.com/en-us/microsoft-edge/platform/documentation/dev-guide/tools/webDriver/).
38 |
39 |
--------------------------------------------------------------------------------
/docs/guide/configuration/using-env-variables-in-your-config.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Use ENV variables
3 | description: Learn about how to specify Environment variables in your Nightwatch config file.
4 | ---
5 |
6 |
Use ENV variables
7 |
8 | Any config value in either `nightwatch.conf.js` or `nightwatch.json` can be specified as the name of an environment variables. Nightwatch will automatically populate the value, if found, from `process.env`.
9 |
10 | [Dotenv](https://www.npmjs.com/package/dotenv) files are also supported and will be used if an `.env` file is found in the current working directory.
11 |
12 | Here's an example from the generated `nightwatch.conf.js`:
13 |
14 |
--------------------------------------------------------------------------------
/public/images/features-illustration4.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
29 |
--------------------------------------------------------------------------------
/docs/guide/running-tests/filtering-by-test-tags.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Running tests filtered by tags
3 | description: Learn how to run specific tests that match particular tags.
4 | ---
5 |
6 |
Filtering by test tags
7 |
8 | ### Overview
9 | You can also selectively target tests to run based on tags, such that a test may be belong to multiple tags. For example, you might have a login test that belongs to a login suite as well as a sanity suite.
10 |
11 | The tagging can be accomplished by adding the `@tags` property to a test module:
12 |
13 |
75 |
--------------------------------------------------------------------------------
/public/images/features-illustration7.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
29 |
--------------------------------------------------------------------------------
/docs/guide/using-nightwatch/using-xpath-selectors.md:
--------------------------------------------------------------------------------
1 | ## Using XPath selectors
2 |
3 | XPath stands for XML Path Language. It uses a non-XML syntax to provide a flexible way of finding elements in a web page.
4 |
5 | Nightwatch supports XPath selectors in locating elements. CSS selectors are used by default if no strategy is specified, and there are several ways in which to make use of XPath, depending on the use case:
6 |
7 | #### 1. Using .useXpath() command
8 |
9 | Using `useXpath()` command, as seen in the example below, is a convenient way. You don't need to bother with using multiple parameters on element commands, or you may have more than one subsequent element commands/assertions in the same test which use XPath expressions. To switch back to CSS, call `useCss()`.
10 |
11 |
12 | module.exports = {
13 | demoTest: function (browser) {
14 | browser
15 | .useXpath() // every selector now must be xpath
16 | .click("//tr[@data-recordid]/span[text()='Search Text']")
17 | .useCss() // we're back to CSS now
18 | .setValue('input[type=text]', 'nightwatch')
19 | }
20 | };
21 |
22 | #### 2. Directly finding elements with Xpath selectors
23 |
24 | You can also use Xpath directly on a single command or assertion, by either passing an [element selector object][11], or specifying `'xpath'` strategy as first argument:
25 |
26 |
39 |
40 | #### 3. Always use XPath by default
41 |
42 | If you mostly are using XPath expressions and you want to avoid configuring the strategy in your tests all the time, you can also use XPath by default by setting the property `use_xpath: true` in your [config][10].
43 |
44 | - Previous: [Using expect assertions](/guide/using-nightwatch/expect-assertions.html)
45 | - Next: [Using test hooks](/guide/using-nightwatch/using-test-hooks.html)
46 |
47 | [10]: /gettingstarted/configuration/#extended-settings
48 | [11]: /guide/working-with-page-objects/#element-properties
49 |
--------------------------------------------------------------------------------
/public/images/images1/browserstack.svg:
--------------------------------------------------------------------------------
1 |
20 |
--------------------------------------------------------------------------------