Skip to content

Latest commit

 

History

History
111 lines (92 loc) · 4.93 KB

writing_plugins.md

File metadata and controls

111 lines (92 loc) · 4.93 KB
layout
page.njk

Taiko features can be extended via plugins which can allow users to take more advantage of ChromeDevtoolsProtocol when core Taiko concentrating on functionalities around UI automation tests. It can also help users simplify their workflow. Below are a few scenarios where plugins can help extending taiko:

  • combine set of taiko actions and provide apis for it (eg: taiko-paypal - which can let users do paypal payment)
  • expose more of ChromeDevtoolsProtocols apis (eg: taiko-diagnostics - which can let users perform diagnostics actions over the website, taiko-screencast - which can let users record a video of the script running)
  • provide selectors based on frameworks (eg: taiko-react - which can give selectors specific to react frameworks)
  • override taiko apis (eg: taiko-android - which can override openBrowser api to launch browser in an android device)

Conventions

  • Plugin names should have the prefix ‘taiko-’. eg: taiko-android, taiko-screencast
  • Plugins should not have taiko as dependency they should use the same instance as users script.
  • Plugins should implement ‘init()’ method which will be called by taiko on load passing taiko and event handler instances.
  • Taiko will communicate with plugins via events.
  • Plugins should implement ‘exec()’ method to extend taiko CLI to execute any action.
module.exports = {
    'exec': (options) => {
        console.log("Taiko's plugin executes operation with following options");
        console.log(options);
    }
};
  • Plugins should add capability in their package.json if they have execute functionality.
capability:[‘subcommands’]` - in plugins package.json

Only if the package.json has the above capability added taiko will consider it to be a subcommand.

Initializing plugin

Plugins are initialized by calling init method defined in plugins. Below are the parameters that init method takes, init(taiko, eventHandlerProxy, descEvent, registerHooks)

  • taiko - exported apis from taiko (eg: openBrowser, button)
  • eventHandlerProxy - eventHandler in taiko that listens to CDP events
  • descEvent - eventHandler used to provide success message to REPL and taiko runner
  • registerHooks - Callback that lets plugins register hooks that are available in taiko

Hooks for plugin

Taiko provides a way for plugins to alter its behavior by letting them register hooks. Below are the available hooks in taiko,

  • preConnectionHook - this hook lets plugin update target details and options before making a CDP connection parameters - target, options return - target, options
//Hooks example
init(taiko, eventHandlerProxy, descEvent, registerHooks){
      registerHooks({
            preConnectionHook: (target, options) => {
                  return {target,options}
            }
      })
}

Plugin Workflow

Taiko plugin workflow

Example:

const { openBrowser, goto, write, press, closeBrowser, into, screencast} = require('taiko');

(async () => {
  try {
        await openBrowser();
        await screencast.startScreencast("output.gif");
        await goto('google.com');
        await write('taiko', into(textBox()));
        await press('Enter');
  } catch (e) {
        console.log(e);
  } finally {
        await screencast.stopScreencast();
        await closeBrowser();
  }
})();
  • On requiring taiko, taiko will look for any runtime plugins given to be loaded via TAIKO_PLUGIN env variable if not it will load plugins from users package.json dependencies by calling init method in plugins passing taiko and eventhandler instances to plugin to get started.
  • Plugin instances are given to user script via taiko as objects with name removing the prefix taiko- eg. screencast in the above script
  • All apis that are overridden will be accessible from taiko other additional apis will be part of plugin object

Running scripts with plugins

  • For running scripts using taiko launch runner or REPL using --plugins option eg: taiko code.js --plugin 'android'
  • Use env variable TAIKO_PLUGINS to load plugins on runtime when using other runners.

Execution capability in plugin

Example: taiko diagnostics http://gauge.org

  • Loads plugins installed globally (local modules when using local taiko instance) as a subcommand when initializing commander.js
  • taiko -help will list all possible subcommands
  • Looks for capability execution in plugins package.json to avoid loading plugins that does not have execution capability
  • exec() function in plugin will be executed for the subcommand

Examples