Fix formatting

Author: aguspe

rb/spec/tests.bzl

@@ -128,7 +128,7 @@ BROWSERS = {
         "data": [],
         "deps": ["//rb/lib/selenium/webdriver:ie"],
         "tags": [
-            "skip-remote",
+            "skip-remote", # RBE is Linux-only.
         ],
         "target_compatible_with": ["@platforms//os:windows"],
         "env": {
@@ -140,8 +140,8 @@ BROWSERS = {
         "data": [],
         "deps": ["//rb/lib/selenium/webdriver:safari"],
         "tags": [
-            "exclusive-if-local",
-            "skip-remote",
+            "exclusive-if-local", # Safari cannot run in parallel.
+            "skip-remote", # RBE is Linux-only.
         ],
         "target_compatible_with": ["@platforms//os:macos"],
         "env": {
@@ -153,8 +153,8 @@ BROWSERS = {
         "data": [],
         "deps": ["//rb/lib/selenium/webdriver:safari"],
         "tags": [
-            "exclusive-if-local",
-            "skip-remote",
+            "exclusive-if-local", # Safari cannot run in parallel.
+            "skip-remote", # RBE is Linux-only.
         ],
         "target_compatible_with": ["@platforms//os:macos"],
         "env": {
@@ -165,12 +165,15 @@ BROWSERS = {
 }
 
 def rb_integration_test(name, srcs, deps = [], data = [], browsers = BROWSERS.keys(), tags = []):
+  # Generate a library target that is used by //rb/spec:spec to expose all tests to //rb:lint.
     rb_library(
         name = name,
         srcs = srcs,
         visibility = ["//rb:__subpackages__"],
     )
+
     for browser in browsers:
+      # Generate a test target for local browser execution.
         rb_test(
             name = "{}-{}".format(name, browser),
             size = "large",
@@ -184,6 +187,8 @@ def rb_integration_test(name, srcs, deps = [], data = [], browsers = BROWSERS.ke
             visibility = ["//rb:__subpackages__"],
             target_compatible_with = BROWSERS[browser]["target_compatible_with"],
         )
+
+        # Generate a test target for remote browser execution (Grid).
         rb_test(
             name = "{}-{}-remote".format(name, browser),
             size = "large",
@@ -205,6 +210,8 @@ def rb_integration_test(name, srcs, deps = [], data = [], browsers = BROWSERS.ke
             visibility = ["//rb:__subpackages__"],
             target_compatible_with = BROWSERS[browser]["target_compatible_with"],
         )
+
+        # Generate a test target for bidi browser execution.
         rb_test(
             name = "{}-{}-bidi".format(name, browser),
             size = "large",
@@ -231,7 +238,7 @@ def rb_unit_test(name, srcs, deps, data = []):
         args = ["rb/spec/"],
         main = "@bundle//bin:rspec",
         data = data,
-        tags = ["no-sandbox"],
+        tags = ["no-sandbox"], # TODO: Do we need this?
         deps = ["//rb/spec/unit/selenium/webdriver:spec_helper"] + deps,
         visibility = ["//rb:__subpackages__"],
     )

scripts/pinned_browsers.py

@@ -10,6 +10,10 @@
 import urllib3
 from packaging.version import parse
 
+# Find the current stable versions of each browser we
+# support and the sha256 of these. That's useful for
+# updating `//common:repositories.bzl`
+
 http = urllib3.PoolManager()
 
 
@@ -32,19 +36,23 @@ def get_chrome_milestone(channel=None):
         "GET", f"https://chromiumdash.appspot.com/fetch_releases?channel={channel}&num=1&platform=Mac,Linux"
     )
     all_versions = json.loads(r.data)
+    # use the same milestone for all chrome releases, so pick the lowest
     milestone = min([version["milestone"] for version in all_versions if version["milestone"]])
     r = http.request(
         "GET", "https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json"
     )
     versions = json.loads(r.data)["versions"]
+
     return sorted(
         filter(lambda v: v["version"].split(".")[0] == str(milestone), versions), key=lambda v: parse(v["version"])
     )[-1]
 
 
 def chromedriver(selected_version, workspace_prefix=""):
     content = ""
+
     drivers = selected_version["downloads"]["chromedriver"]
+
     linux = [d["url"] for d in drivers if d["platform"] == "linux64"][0]
     sha = calculate_hash(linux)
     content = content + """    http_archive(
@@ -91,8 +99,10 @@ def chromedriver(selected_version, workspace_prefix=""):
 
 def chrome(selected_version, workspace_prefix=""):
     chrome_downloads = selected_version["downloads"]["chrome"]
+
     linux = [d["url"] for d in chrome_downloads if d["platform"] == "linux64"][0]
     sha = calculate_hash(linux)
+
     content = """
     http_archive(
         name = "linux_%schrome",
@@ -163,11 +173,13 @@ def edge():
     content = ""
     r = http.request("GET", "https://edgeupdates.microsoft.com/api/products")
     all_data = case_insensitive_json_loads(r.data)
+
     linux = None
     linux_hash = None
     mac = None
     mac_hash = None
     version = None
+
     for data in all_data:
         if not "Stable" == data.get("product"):
             continue
@@ -183,6 +195,7 @@ def edge():
                     if "deb" == artifact["artifactname"]:
                         linux = artifact["location"]
                         linux_hash = artifact["hash"]
+
     if mac and mac_hash:
         content += """
     pkg_archive(
@@ -238,7 +251,9 @@ def edgedriver():
     major_version = stable_version.split('.')[0]
     r = http.request("GET", f"https://msedgedriver.azureedge.net/LATEST_RELEASE_{major_version}_LINUX")
     linux_version = r.data.decode("utf-16").strip()
+
     content = ""
+
     linux = "https://msedgedriver.azureedge.net/%s/edgedriver_linux64.zip" % linux_version
     sha = calculate_hash(linux)
     content = content + """
@@ -286,6 +301,7 @@ def edgedriver():
 
 def geckodriver():
     content = ""
+
     r = http.request("GET", "https://api.github.com/repos/mozilla/geckodriver/releases/latest")
     for a in json.loads(r.data)["assets"]:
         if a["name"].endswith("-linux64.tar.gz"):
@@ -334,10 +350,12 @@ def geckodriver():
 
 def firefox():
     firefox_versions = json.loads(firefox_version_data())
+
     latest_firefox = firefox_versions["LATEST_FIREFOX_VERSION"]
     sha_linux = calculate_hash(firefox_linux(latest_firefox))
     sha_mac = calculate_hash(firefox_mac(latest_firefox))
     content = print_firefox(latest_firefox, "", sha_linux, sha_mac)
+
     beta_firefox = firefox_versions["LATEST_FIREFOX_RELEASED_DEVEL_VERSION"]
     if latest_firefox != beta_firefox:
         sha_linux = calculate_hash(firefox_linux(beta_firefox))