blob: 6ad2d59cca86ca4f49d872fb336c51a406ce9a13 [file] [edit]
load("@rules_ruby//ruby:defs.bzl", "rb_test")
load(
"//common:browsers.bzl",
"COMMON_TAGS",
"chrome_beta_data",
"chrome_data",
"edge_data",
"firefox_beta_data",
"firefox_data",
)
load("//common/manager:defs.bzl", "SE_MANAGER_TEST_DATA", "SE_MANAGER_TEST_ENV", "SE_MANAGER_TEST_EXEC_PROPERTIES")
BROWSERS = {
"chrome": {
"data": chrome_data,
"deps": ["//rb/lib/selenium/webdriver:chrome"],
"tags": [],
"target_compatible_with": [],
"bidi": True,
"env": {
"WD_REMOTE_BROWSER": "chrome",
"WD_SPEC_DRIVER": "chrome",
} | select({
"@selenium//common:use_headless_browser": {"HEADLESS": "true"},
"//conditions:default": {},
}),
"pinned_env": select({
"@selenium//common:use_pinned_linux_chrome": {
"CHROME_BINARY": "$(rlocationpath @linux_chrome//:chrome-linux64/chrome)",
"CHROMEDRIVER_BINARY": "$(rlocationpath @linux_chromedriver//:chromedriver)",
},
"@selenium//common:use_pinned_macos_chrome": {
"CHROME_BINARY": "$(rlocationpath @mac_chrome//:Chrome.app)/Contents/MacOS/Chrome",
"CHROMEDRIVER_BINARY": "$(rlocationpath @mac_chromedriver//:chromedriver)",
},
"//conditions:default": {},
}),
},
"chrome-beta": {
"data": chrome_beta_data,
"deps": ["//rb/lib/selenium/webdriver:chrome"],
"tags": [],
"target_compatible_with": [],
"bidi": True,
"env": {
"WD_REMOTE_BROWSER": "chrome",
"WD_SPEC_DRIVER": "chrome",
"WD_BROWSER_VERSION": "beta",
} | select({
"@selenium//common:use_headless_browser": {"HEADLESS": "true"},
"//conditions:default": {},
}),
"pinned_env": select({
"@selenium//common:use_pinned_linux_chrome": {
"CHROME_BINARY": "$(rlocationpath @linux_beta_chrome//:chrome-linux64/chrome)",
"CHROMEDRIVER_BINARY": "$(rlocationpath @linux_beta_chromedriver//:chromedriver)",
},
"@selenium//common:use_pinned_macos_chrome": {
"CHROME_BINARY": "$(rlocationpath @mac_beta_chrome//:Chrome.app)/Contents/MacOS/Chrome",
"CHROMEDRIVER_BINARY": "$(rlocationpath @mac_beta_chromedriver//:chromedriver)",
},
"//conditions:default": {},
}),
},
"edge": {
"data": edge_data,
"deps": ["//rb/lib/selenium/webdriver:edge"],
"tags": [],
"target_compatible_with": [],
"bidi": True,
"env": {
"WD_REMOTE_BROWSER": "edge",
"WD_SPEC_DRIVER": "edge",
} | select({
"@selenium//common:use_headless_browser": {"HEADLESS": "true"},
"//conditions:default": {},
}),
"pinned_env": select({
"@selenium//common:use_pinned_linux_edge": {
"EDGE_BINARY": "$(rlocationpath @linux_edge//:opt/microsoft/msedge/microsoft-edge)",
"MSEDGEDRIVER_BINARY": "$(rlocationpath @linux_edgedriver//:msedgedriver)",
},
"@selenium//common:use_pinned_macos_edge": {
"EDGE_BINARY": "$(rlocationpath @mac_edge//:Edge.app)/Contents/MacOS/Microsoft\\ Edge",
"MSEDGEDRIVER_BINARY": "$(rlocationpath @mac_edgedriver//:msedgedriver)",
},
"//conditions:default": {},
}),
},
"firefox": {
"data": firefox_data,
"deps": ["//rb/lib/selenium/webdriver:firefox"],
"tags": [],
"target_compatible_with": [],
"bidi": True,
"env": {
"WD_REMOTE_BROWSER": "firefox",
"WD_SPEC_DRIVER": "firefox",
} | select({
"@selenium//common:use_headless_browser": {"HEADLESS": "true"},
"//conditions:default": {},
}),
"pinned_env": select({
"@selenium//common:use_pinned_linux_firefox": {
"FIREFOX_BINARY": "$(rlocationpath @linux_firefox//:firefox/firefox)",
"GECKODRIVER_BINARY": "$(rlocationpath @linux_geckodriver//:geckodriver)",
},
"@selenium//common:use_pinned_macos_firefox": {
"FIREFOX_BINARY": "$(rlocationpath @mac_firefox//:Firefox.app)/Contents/MacOS/firefox",
"GECKODRIVER_BINARY": "$(rlocationpath @mac_geckodriver//:geckodriver)",
},
"//conditions:default": {},
}),
},
"firefox-beta": {
"data": firefox_beta_data,
"deps": ["//rb/lib/selenium/webdriver:firefox"],
"tags": [],
"target_compatible_with": [],
"bidi": True,
"env": {
"WD_REMOTE_BROWSER": "firefox",
"WD_SPEC_DRIVER": "firefox",
"WD_BROWSER_VERSION": "beta",
} | select({
"@selenium//common:use_headless_browser": {"HEADLESS": "true"},
"//conditions:default": {},
}),
"pinned_env": select({
"@selenium//common:use_pinned_linux_firefox": {
"FIREFOX_BINARY": "$(rlocationpath @linux_beta_firefox//:firefox/firefox)",
"GECKODRIVER_BINARY": "$(rlocationpath @linux_geckodriver//:geckodriver)",
},
"@selenium//common:use_pinned_macos_firefox": {
"FIREFOX_BINARY": "$(rlocationpath @mac_beta_firefox//:Firefox.app)/Contents/MacOS/firefox",
"GECKODRIVER_BINARY": "$(rlocationpath @mac_geckodriver//:geckodriver)",
},
"//conditions:default": {},
}),
},
"ie": {
"data": [],
"deps": ["//rb/lib/selenium/webdriver:ie"],
"tags": [],
"target_compatible_with": ["@platforms//os:windows"],
"classic": False,
"env": {
"WD_REMOTE_BROWSER": "ie",
"WD_SPEC_DRIVER": "ie",
},
},
"safari": {
"data": [],
"deps": ["//rb/lib/selenium/webdriver:safari"],
"tags": [
"exclusive-if-local", # Safari cannot run in parallel.
],
"target_compatible_with": ["@platforms//os:macos"],
"env": {
"WD_REMOTE_BROWSER": "safari",
"WD_SPEC_DRIVER": "safari",
},
},
"safari-preview": {
"data": [],
"deps": ["//rb/lib/selenium/webdriver:safari"],
"tags": [
"exclusive-if-local", # Safari cannot run in parallel.
],
"target_compatible_with": ["@platforms//os:macos"],
"classic": False,
"bidi": True,
"env": {
"WD_REMOTE_BROWSER": "safari-preview",
"WD_SPEC_DRIVER": "safari-preview",
},
},
}
# Tags listed here apply only to the local target of the listed browsers.
_BROWSER_TAG_FILTERS = {
"os-sensitive": ["chrome", "edge", "firefox", "safari"],
"se-manager": ["chrome", "edge", "firefox", "safari"],
}
# Tags listed here apply only to the remote targets, prefixed with the browser.
_REMOTE_TAGS = ["grid"]
def _split_filtered_tags(tags, browser):
universal_tags = [t for t in tags if t not in _BROWSER_TAG_FILTERS and t not in _REMOTE_TAGS]
local_tags = [t for t in tags if browser in _BROWSER_TAG_FILTERS.get(t, [])]
remote_tags = ["{}-{}".format(browser, t) for t in tags if t in _REMOTE_TAGS]
return universal_tags, local_tags, remote_tags
def _browser_env(browser, se_manager = False):
overlay = SE_MANAGER_TEST_ENV if se_manager else BROWSERS[browser].get("pinned_env", {})
return BROWSERS[browser]["env"] | overlay
def rb_integration_test(
name,
srcs,
deps = [],
data = [],
browsers = BROWSERS,
tags = [],
bidi = False,
classic = True,
grid = True,
grid_bidi = False):
for browser in browsers:
generate_classic = BROWSERS[browser].get("classic", True)
generate_bidi = BROWSERS[browser].get("bidi", False)
universal_tags, local_tags, remote_tags = _split_filtered_tags(tags, browser)
se_manager = "se-manager" in local_tags
# Family groups beta/preview variants with their stable counterpart so
# e.g. `--test_tag_filters=chrome` matches chrome and chrome-beta targets.
family = browser.split("-")[0]
family_tags = [browser, family] if family != browser else [browser]
if classic and generate_classic:
# Generate a test target for local browser execution.
rb_test(
name = "{}-{}".format(name, browser),
size = "large",
srcs = srcs,
args = ["rb/spec/"],
data = (SE_MANAGER_TEST_DATA if se_manager else BROWSERS[browser]["data"]) + data + [
"//common/certificates",
"//common/src/web",
],
env = _browser_env(browser, se_manager),
exec_properties = SE_MANAGER_TEST_EXEC_PROPERTIES if se_manager else {},
main = "@bundle//bin:rspec",
tags = COMMON_TAGS + BROWSERS[browser]["tags"] + universal_tags + local_tags + ["{}-local".format(browser)] + family_tags,
deps = ["//rb/spec/integration/selenium/webdriver:spec_helper"] + BROWSERS[browser]["deps"] + deps,
visibility = ["//rb:__subpackages__"],
target_compatible_with = BROWSERS[browser]["target_compatible_with"],
)
# Generate a test target for remote browser execution (Grid).
if grid:
rb_test(
name = "{}-{}-remote".format(name, browser),
size = "large",
srcs = srcs,
args = ["rb/spec/"],
data = BROWSERS[browser]["data"] + data + [
"//common/certificates",
"//common/src/web",
"//java/src/org/openqa/selenium/grid:selenium_server_deploy.jar",
"//rb/spec:java-location",
"@bazel_tools//tools/jdk:current_java_runtime",
],
env = _browser_env(browser) | {
"WD_BAZEL_JAVA_LOCATION": "$(rootpath //rb/spec:java-location)",
"WD_SPEC_DRIVER": "remote",
},
main = "@bundle//bin:rspec",
tags = COMMON_TAGS + BROWSERS[browser]["tags"] + universal_tags + remote_tags + ["{}-remote".format(browser)] + family_tags,
deps = ["//rb/spec/integration/selenium/webdriver:spec_helper"] + BROWSERS[browser]["deps"] + deps,
visibility = ["//rb:__subpackages__"],
target_compatible_with = BROWSERS[browser]["target_compatible_with"],
)
if bidi and generate_bidi:
rb_test(
name = "{}-{}-bidi".format(name, browser),
size = "large",
srcs = srcs,
args = ["rb/spec/"],
data = BROWSERS[browser]["data"] + data + [
"//common/certificates",
"//common/src/web",
],
env = _browser_env(browser) | {"WEBDRIVER_BIDI": "true"},
main = "@bundle//bin:rspec",
tags = COMMON_TAGS + BROWSERS[browser]["tags"] + universal_tags + ["bidi", "{}-bidi".format(browser)] + family_tags,
deps = {d: True for d in (
["//rb/spec/integration/selenium/webdriver:spec_helper", "//rb/lib/selenium/webdriver:bidi"] +
BROWSERS[browser]["deps"] +
deps
)}.keys(),
visibility = ["//rb:__subpackages__"],
target_compatible_with = BROWSERS[browser]["target_compatible_with"],
)
# Bidi over a Grid, for specs that must exercise remote-end behavior.
if grid_bidi:
rb_test(
name = "{}-{}-remote-bidi".format(name, browser),
size = "large",
srcs = srcs,
args = ["rb/spec/"],
data = BROWSERS[browser]["data"] + data + [
"//common/certificates",
"//common/src/web",
"//java/src/org/openqa/selenium/grid:selenium_server_deploy.jar",
"//rb/spec:java-location",
"@bazel_tools//tools/jdk:current_java_runtime",
],
env = _browser_env(browser) | {
"WD_BAZEL_JAVA_LOCATION": "$(rootpath //rb/spec:java-location)",
"WD_SPEC_DRIVER": "remote",
"WEBDRIVER_BIDI": "true",
},
main = "@bundle//bin:rspec",
tags = COMMON_TAGS + BROWSERS[browser]["tags"] + universal_tags + remote_tags + ["bidi", "{}-grid".format(browser), "{}-remote".format(browser)] + family_tags,
deps = {d: True for d in (
["//rb/spec/integration/selenium/webdriver:spec_helper", "//rb/lib/selenium/webdriver:bidi"] +
BROWSERS[browser]["deps"] +
deps
)}.keys(),
visibility = ["//rb:__subpackages__"],
target_compatible_with = BROWSERS[browser]["target_compatible_with"],
)