<!DOCTYPE html>

<html itemscope itemtype="https://schema.org/WebPage" lang="en">

<head>

<meta charset="utf-8">

<meta content="IE=edge" http-equiv="X-UA-Compatible">

<meta content="width=device-width, initial-scale=1" name="viewport">

<link href="/rules_nodejs/Protractor.html" rel="canonical">

<link href="" rel="shortcut icon" type="image/png">

<title>rules_nodejs - Protractor</title>

<!-- Webfont -->

<link href="//fonts.googleapis.com/css?family=Source+Code+Pro:400,500,700|Open+Sans:400,600,700,800" rel="stylesheet">

<!-- Bootstrap -->

<link crossorigin="anonymous" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"

integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" rel="stylesheet">

<!-- Font Awesome -->

<link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">

<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->

<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->

<!--[if lt IE 9]>

<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>

<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>

<![endif]-->

<!-- Custom stylesheet -->

<link href="/rules_nodejs/css/main.css" rel="stylesheet">

<!-- metadata -->

<meta content="rules_nodejs" name="og:title"/>

<meta content="JavaScript and NodeJS rules for Bazel" name="og:description"/>

</head>

<body>

<nav class="navbar navbar-inverse navbar-fixed-top" id="common-nav">

<div class="container">

<!-- Brand and toggle get grouped for better mobile display -->

<div class="navbar-header">

<button class="navbar-toggle collapsed" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse"

type="button">

<span class="sr-only">Toggle navigation</span>

<span class="icon-bar"></span>

<span class="icon-bar"></span>

<span class="icon-bar"></span>

</button>

<a class="navbar-brand" href="/rules_nodejs/">

<img class="navbar-logo" src="/rules_nodejs/images/bazel-navbar.svg">

</a>

</div>

<!-- Collect the nav links, forms, and other content for toggling -->

<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">

<form class="navbar-form navbar-right" action="/rules_nodejs/search.html" id="cse-search-box">

<div class="form-group">

<input type="hidden" name="cx" value="2735dc72dd157bd19">

<input type="search" name="q" id="q" class="form-control input-sm" placeholder="Search">

</div>

</form>

<ul class="nav navbar-nav navbar-right">

<li><a href="https://github.com/bazelbuild/rules_nodejs">GitHub</a></li>

</ul>

</div><!-- /.navbar-collapse -->

</div><!-- /.container-fluid -->

</nav>

<div class="container vpad">

<div class="row">

<div class="col-md-2">

<a aria-controls="sidebar-nav"

aria-expanded="false" class="btn btn-default btn-lg btn-block sidebar-toggle" data-toggle="collapse"

href="#sidebar-nav">

<i class="glyphicon glyphicon-menu-hamburger"></i> Navigation

</a>

<nav class="sidebar collapse" id="sidebar-nav">

<select onchange="location.href=this.value">

<option selected disabled hidden>Version: 3.x</option>

<option value="/rules_nodejs/Protractor.html">3.x</option>

<option value="https://docs.aspect.dev/rules_nodejs/Protractor.html">2.3</option>

</select>

<h3>rules_nodejs</h3>

<ul class="sidebar-nav">

<li><a href="/rules_nodejs/">Introduction</a></li>

<li><a href="install.html">Installation</a></li>

<li><a href="repositories.html">Repositories</a></li>

<li><a href="dependencies.html">Dependencies</a></li>

<li><a href="debugging.html">Debugging</a></li>

<li><a href="stamping.html">Stamping</a></li>

<li><a href="changing-rules.html">Making changes to rules_nodejs</a></li>

<li><a href="examples.html">Examples</a></li>

</ul>

<h3>Rules</h3>

<ul class="sidebar-nav">

<li><a href="/rules_nodejs/Built-ins.html">Built-ins</a></li>

<li><a href="/rules_nodejs/Concatjs.html">Concatjs</a></li>

<li><a href="/rules_nodejs/Cypress.html">Cypress</a></li>

<li><a href="/rules_nodejs/Jasmine.html">Jasmine</a></li>

<li><a href="/rules_nodejs/Labs.html">Labs</a></li>

<li><a href="/rules_nodejs/Protractor.html">Protractor</a></li>

<li><a href="/rules_nodejs/Rollup.html">Rollup</a></li>

<li><a href="/rules_nodejs/Terser.html">Terser</a></li>

<li><a href="/rules_nodejs/TypeScript.html">TypeScript</a></li>

<li><a href="/rules_nodejs/esbuild.html">esbuild</a></li>

</ul>

<h3>Community</h3>

<ul class="sidebar-nav">

<li><a href="https://github.com/bazelbuild/rules_nodejs/blob/master/CONTRIBUTING.md">Contribute to

rules_nodejs</a></li>

<li><a href="https://slack.bazel.build">Join #javascript on Slack</a></li>

<li><a href="https://github.com/bazelbuild/rules_nodejs/issues">Issue Tracker</a></li>

<li><a href="https://github.com/bazelbuild/rules_nodejs">Github</a></li>

</ul>

</nav>

</div>

<div class="col-md-8">

<div class="content">

<!-- *********************

DO NOT EDIT THIS FILE

It is a generated build output from Stardoc.

Instead you must edit the .bzl file where the rules are declared,

or possibly a markdown file next to the .bzl file

********************* -->

<h1 id="protractor-rules-for-bazel">Protractor rules for Bazel</h1>

<p>The Protractor rules run tests under the Protractor framework with Bazel.</p>

<h2 id="installation">Installation</h2>

<p>Add the <code class="language-plaintext highlighter-rouge">@bazel/protractor</code> npm package to your <code class="language-plaintext highlighter-rouge">devDependencies</code> in <code class="language-plaintext highlighter-rouge">package.json</code>.</p>

<h2 id="protractor_web_test">protractor_web_test</h2>

<p><strong>USAGE</strong></p>

<pre>

protractor_web_test(<a href="#protractor_web_test-name">name</a>, <a href="#protractor_web_test-configuration">configuration</a>, <a href="#protractor_web_test-on_prepare">on_prepare</a>, <a href="#protractor_web_test-srcs">srcs</a>, <a href="#protractor_web_test-deps">deps</a>, <a href="#protractor_web_test-data">data</a>, <a href="#protractor_web_test-server">server</a>, <a href="#protractor_web_test-tags">tags</a>, <a href="#protractor_web_test-peer_deps">peer_deps</a>,

<a href="#protractor_web_test-protractor_entry_point">protractor_entry_point</a>, <a href="#protractor_web_test-kwargs">kwargs</a>)

</pre>

<p>Runs a protractor test in a browser.</p>

<p><strong>PARAMETERS</strong></p>

<h4 id="protractor_web_test-name">name</h4>

<p>The name of the test</p>

<h4 id="protractor_web_test-configuration">configuration</h4>

<p>Protractor configuration file.</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">None</code></p>

<h4 id="protractor_web_test-on_prepare">on_prepare</h4>

<p>A file with a node.js script to run once before all tests run.

If the script exports a function which returns a promise, protractor

will wait for the promise to resolve before beginning tests.</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">None</code></p>

<h4 id="protractor_web_test-srcs">srcs</h4>

<p>JavaScript source files</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">[]</code></p>

<h4 id="protractor_web_test-deps">deps</h4>

<p>Other targets which produce JavaScript such as <code class="language-plaintext highlighter-rouge">ts_library</code></p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">[]</code></p>

<h4 id="protractor_web_test-data">data</h4>

<p>Runtime dependencies</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">[]</code></p>

<h4 id="protractor_web_test-server">server</h4>

<p>Optional server executable target</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">None</code></p>

<h4 id="protractor_web_test-tags">tags</h4>

<p>Standard Bazel tags, this macro adds one for ibazel</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">[]</code></p>

<h4 id="protractor_web_test-peer_deps">peer_deps</h4>

<p>List of peer npm deps required by protractor_web_test</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">["@npm//@bazel/protractor", "@npm//protractor"]</code></p>

<h4 id="protractor_web_test-protractor_entry_point">protractor_entry_point</h4>

<p>A label providing the protractor entry point

Default to <code class="language-plaintext highlighter-rouge">:node_modules/protractor/bin/protractor</code>.</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">"@npm//:node_modules/protractor/bin/protractor"</code></p>

<h4 id="protractor_web_test-kwargs">kwargs</h4>

<p>passed through to <code class="language-plaintext highlighter-rouge">protractor_web_test</code></p>

<h2 id="protractor_web_test_suite">protractor_web_test_suite</h2>

<p><strong>USAGE</strong></p>

<pre>

protractor_web_test_suite(<a href="#protractor_web_test_suite-name">name</a>, <a href="#protractor_web_test_suite-browsers">browsers</a>, <a href="#protractor_web_test_suite-web_test_data">web_test_data</a>, <a href="#protractor_web_test_suite-wrapped_test_tags">wrapped_test_tags</a>, <a href="#protractor_web_test_suite-kwargs">kwargs</a>)

</pre>

<p>Defines a test_suite of web_test targets that wrap a protractor_web_test target.</p>

<p><strong>PARAMETERS</strong></p>

<h4 id="protractor_web_test_suite-name">name</h4>

<p>The base name of the test</p>

<h4 id="protractor_web_test_suite-browsers">browsers</h4>

<p>A sequence of labels specifying the browsers to use.</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">None</code></p>

<h4 id="protractor_web_test_suite-web_test_data">web_test_data</h4>

<p>Data dependencies for the wrapper web_test targets.</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">[]</code></p>

<h4 id="protractor_web_test_suite-wrapped_test_tags">wrapped_test_tags</h4>

<p>A list of test tag strings to use for the wrapped

karma_web_test target.</p>

<p>Defaults to <code class="language-plaintext highlighter-rouge">["manual", "noci"]</code></p>

<h4 id="protractor_web_test_suite-kwargs">kwargs</h4>

<p>Arguments for the wrapped karma_web_test target.</p>

</div>

</div>

<div class="col-md-2 sticky-sidebar">

<div class="right-sidebar">

<ul class="gh-links">

<li>

<i class="fa fa-github"></i>

<a href="https://github.com/bazelbuild/rules_nodejs/issues/new?title=Documentation issue: Protractor&labels=question/docs">Create

issue</a>

</li>

</ul>

<ul class="section-nav">

<li class="toc-entry toc-h2"><a href="#installation">Installation</a></li>

<li class="toc-entry toc-h2"><a href="#protractor_web_test">protractor_web_test</a></li>

<li class="toc-entry toc-h2"><a href="#protractor_web_test_suite">protractor_web_test_suite</a></li>

</ul>

</div>

</div>

</div>

</div>

<footer class="footer">

<div class="container">

<div class="row">

<div class="col-lg-8">

<p class="text-muted">&copy; 2021 The rules_nodejs authors</p>

</div>

</div>

</div>

</footer>

<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

<!-- Include all compiled plugins (below), or include individual files as needed -->

<script crossorigin="anonymous"

integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa"

src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>

<!-- Anchor JS -->

<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.2.0/anchor.min.js" type="text/javascript"></script>

<script>

// Automatically add anchors and links to all header elements that don't already have them.

anchors.options = { placement: 'left' };

anchors.add();

</script>

<script>

var shiftWindow = function () {

if (location.hash.length !== 0) {

window.scrollBy(0, -50);

}

};

window.addEventListener("hashchange", shiftWindow);

var highlightCurrentSidebarNav = function () {

var href = location.pathname;

var item = $('#sidebar-nav [href$="' + href + '"]');

if (item) {

var li = item.parent();

li.addClass("active");

if (li.parent() && li.parent().is("ul")) {

do {

var ul = li.parent();

if (ul.hasClass("collapse")) {

ul.collapse("show");

}

li = ul.parent();

} while (li && li.is("li"));

}

}

};

$(document).ready(function () {

// Scroll to anchor of location hash, adjusted for fixed navbar.

window.setTimeout(function () {

shiftWindow();

}, 1);

// Flip the caret when submenu toggles are clicked.

$(".sidebar-submenu").on("show.bs.collapse", function () {

var toggle = $('[href$="#' + $(this).attr('id') + '"]');

if (toggle) {

toggle.addClass("dropup");

}

});

$(".sidebar-submenu").on("hide.bs.collapse", function () {

var toggle = $('[href$="#' + $(this).attr('id') + '"]');

if (toggle) {

toggle.removeClass("dropup");

}

});

// Highlight the current page on the sidebar nav.

highlightCurrentSidebarNav();

});

</script>

</body>

</html>