Bazel rules and supporting code to allow testing against a browser with WebDriver.
For all languages, you need to add the following to your WORKSPACE file:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "io_bazel_rules_webtesting",
sha256 = "<version-specific-sha>",
urls = [
"https://github.com/bazelbuild/rules_webtesting/releases/download/<version>/rules_webtesting.tar.gz",
],
)
load("@io_bazel_rules_webtesting//web:repositories.bzl", "web_test_repositories")
web_test_repositories()We maintain predefined versioned browsers in
@io_bazel_rules_webtesting//web/versioned:browsers-<version>.bzl that can be
referenced from @io_bazel_rules_webtesting//browsers. Note: these versions in
these files are not locked in until the corresponding release has been created.
To use, add the following to your WORKSPACE file:
load("@io_bazel_rules_webtesting//web/versioned:browsers-<version>.bzl", "browser_repositories")
browser_repositories(chromium=True, firefox=True)Then you should add the appropriate dependencies depending on what language you are writing your tests in:
load("@io_bazel_rules_webtesting//web:java_repositories.bzl", "java_repositories")
java_repositories()If you're using rules_jvm_external to manage your dependencies, you can add
the required artifacts directly to your maven_install instead of using
java_repositories.
load("@io_bazel_rules_webtesting//web:java_repositories.bzl", "RULES_WEBTESTING_ARTIFACTS")
maven_install(
artifacts = [
# Your artifacts
] + RULES_WEBTESTING_ARTIFACTS,
# Enabling compatability support is required.
generate_compat_repositories = True,
)load("@io_bazel_rules_webtesting//web:java_repositories.bzl", "java_repositories")
java_repositories()
rule_scala_version = "e4560ac332e9da731c1e50a76af2579c55836a5c"
http_archive(
name = "io_bazel_rules_scala",
sha256 = "ccf19e8f966022eaaca64da559c6140b23409829cb315f2eff5dc3e757fb6ad8",
strip_prefix = "rules_scala-%s" % rules_scala_version,
type = "zip",
url = "https://github.com/bazelbuild/rules_scala/archive/%s.zip" % rules_scala_version,
)
# Stores Scala version and other configuration
# 2.12 is a default version, other versions can be use by passing them explicitly:
# scala_config(scala_version = "2.11.12")
load("@io_bazel_rules_scala//:scala_config.bzl", "scala_config")
scala_config()
load("@io_bazel_rules_scala//scala:scala.bzl", "scala_repositories")
scala_repositories()
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
rules_proto_dependencies()
rules_proto_toolchains()
load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_toolchains")
scala_register_toolchains()
# optional: setup ScalaTest toolchain and dependencies
load("@io_bazel_rules_scala//testing:scalatest.bzl", "scalatest_repositories", "scalatest_toolchain")
scalatest_repositories()
scalatest_toolchain()load("@io_bazel_rules_webtesting//web:py_repositories.bzl", "py_repositories")
py_repositories()http_archive(
name = "io_bazel_rules_go",
sha256 = "b7a62250a3a73277ade0ce306d22f122365b513f5402222403e507f2f997d421",
urls = [
"https://github.com/bazelbuild/rules_go/releases/download/0.16.3/rules_go-0.16.3.tar.gz",
],
)
http_archive(
name = "bazel_gazelle",
sha256 = "6e875ab4b6bf64a38c352887760f21203ab054676d9c1b274963907e0768740d",
urls = [
"https://github.com/bazelbuild/bazel-gazelle/releases/download/0.15.0/bazel-gazelle-0.15.0.tar.gz",
],
)
load("@io_bazel_rules_go//go:def.bzl", "go_register_toolchains", "go_rules_dependencies")
go_rules_dependencies()
go_register_toolchains()
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
gazelle_dependencies()
load("@io_bazel_rules_webtesting//web:go_repositories.bzl", "go_repositories")
go_repositories()Write your test in the language of your choice, but use our provided Browser API to get an instance of WebDriver.
import com.google.testing.web.WebTest;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.openqa.selenium.WebDriver;
@RunWith(JUnit4.class)
public class BrowserTest {
private WebDriver driver;
@Before public void createDriver() {
driver = new WebTest().newWebDriverSession();
}
@After public void quitDriver() {
try {
driver.quit();
} finally {
driver = null;
}
}
// your tests here
}import unittest
from testing.web import webtest
class BrowserTest(unittest.TestCase):
def setUp(self):
self.driver = webtest.new_webdriver_session()
def tearDown(self):
try:
self.driver.quit()
finally:
self.driver = None
# Your tests here
if __name__ == "__main__":
unittest.main()import (
"testing"
"github.com/tebeka/selenium"
"github.com/bazelbuild/rules_webtesting/go/webtest"
)
func TestWebApp(t *testing.T) {
wd, err := webtest.NewWebDriverSession(selenium.Capabilities{})
if err != nil {
t.Fatal(err)
}
// your test here
if err := wd.Quit(); err != nil {
t.Logf("Error quitting webdriver: %v", err)
}
}In your BUILD files, load the correct language specific build rule and create a test target using it:
load("@io_bazel_rules_webtesting//web:py.bzl", "py_web_test_suite")
py_web_test_suite(
name = "browser_test",
srcs = ["browser_test.py"],
browsers = [
"@io_bazel_rules_webtesting//browsers:chromium-local",
],
local = True,
deps = ["@io_bazel_rules_webtesting//testing/web"],
)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent