Taiko Browser Automation

The examples folder demonstrates several common automation tasks using Taiko against 'The Internet Express' application:

• File Upload: 01-file_upload.js
• File Download: 02-file_download.js
• Working with frames: 03-work-with-frames.js
• Handling windows/tabs: 04-windows-tabs.js
• Dropdowns: 05-dropdown.js
• Basic Auth: 06-basic-auth.js
• Dynamic Content: 07-dynamic-loading.js
• Contenteditable elements: 08-contenteditable.js

Taiko supports various community-developed plugins to extend its functionality, including accessibility testing, Android device support, performance diagnostics, screencasting, storage interaction, and automated screenshots.

Available community plugins include:

• taiko-accessibility: Test site accessibility.
• taiko-android: Run web tests on Android devices and emulators.
• taiko-diagnostics: Measure speedindex and performance metrics.
• taiko-screencast: Record a GIF video of a Taiko script run.
• taiko-storage: Interact with browser storages.
• taiko-screeny: Capture a screenshot on every action.
• taiko-video: Save screencasts as compressed MP4 videos.

Taiko supports the following browsers:

• Chrome/Chromium
• Microsoft Edge
• Opera (unverified)
• Firefox (experimental)

Note: Safari is NOT supported. Taiko is designed for web applications using chromium/chrome based browsers. For Android Chrome testing, use the taiko-android plugin.

If you want to attempt an action without failing the test when the implicit assertion fails (e.g., when an element is not visible), wrap the action in a JavaScript try...catch block.

const { openBrowser, goto, click, closeBrowser } = require('taiko');
(async () => {
  await openBrowser();
  await goto("google.com");
  try {
    await click("Google Search");
  } catch(e) {
    // Ignore or log the error.
  } finally {
    closeBrowser();
  }
})();

To use Taiko within the Gauge testing framework, install the Gauge CLI and initialize a JavaScript project.

$ npm install @getgauge/cli
$ gauge init js

To improve load times when running tests in parallel (e.g., in the cloud), use the following Chromium command line arguments with openBrowser.

await openBrowser({args: [
                    '--disable-gpu',
                    '--disable-dev-shm-usage',
                    '--disable-setuid-sandbox',
                    '--no-first-run',
                    '--no-sandbox',
                    '--no-zygote']});

Taiko uses smart selectors to mimic user behavior, reducing the need for brittle CSS or XPath selectors.

• Text-based selection: click("Button Text") clicks an element containing that text.
• Focus-based writing: write("text") writes into the currently focused element.
• Targeted writing: write("text", into(textBox({placeholder: "Username"}))) targets a specific field.
• Proximity selectors: click(checkBox(near("Username"))) clicks the checkbox nearest to the element with text "Username".
• Standard selectors: Supports CSS ($("#id")) and XPath ($("//xpath")).

To enable debug logs for Taiko, run your script with the DEBUG environment variable set to taiko:*.

env DEBUG="taiko:*" taiko code.js

The Taiko REPL includes built-in commands to discover available APIs and their usage:

• .api: Lists all available API categories (e.g., Browser actions, Page actions).
• .api <api_name>: Provides detailed information for a specific API, including a description, parameters, return values, and an example usage.

> .api
> .api click

You can load plugins using the following methods:

1. Taiko CLI/REPL: Use the --plugins option.

   taiko code.js --plugin 'android'

2. Environment Variable: Use TAIKO_PLUGINS to load plugins when using other runners.
3. Automatic Loading: Taiko automatically loads plugins found in the user's package.json dependencies by calling their init method.

You can modify how the examples are executed using CLI flags passed to npm test:

• Observe mode: Use --observe to run the examples in a headed browser so you can visually monitor the actions.
• Run a specific example: Pass the file prefix (e.g., 05) to run only that specific test file.
• Screencast: Use --screencast to run all examples and record the session using the taiko-screencast plugin. Recordings are saved in the captures directory.