[rb] Split rb/BUILD into smaller packages

This fits more into Bazel approach because smaller packages with a
proper dependency tree would allow to use Bazel caching more
efficiently. For example, only few tests would be re-run considering
you ran all integration tests for Chrome before and only changed code
in `chrome/driver.rb`. This is because just a few tests depend on
`chrome/driver.rb`. Per-test file packages also allow us to use Bazel
flaky retry flags efficiently - previously it would re-run all the tests
when one of them fails.

This commit also moves certain files around to make Ruby codebase more
reasonable:
* CDP client code generator lives in the `rb/lib/selenium/devtools`
* Nightly version generator lives in a new `rb/lib/selenium/support`

Since now integration tests are being in parallel by default, few
changes had to be done to make support code more concurrency-safe.
Notably, Grid and Rack servers are being started on randomized ports.
Some other tests were adapted/guarded to work better when run in
parallel.

The test configuration is now controlled by a combination of
`--define <name>=<value>` flags, supporting `browser/remote/headless` as
names. See README.md changes for more details.

Author: p0deje

.bazelrc

@@ -62,6 +62,7 @@ build --test_env=PYTHON_VERSION
 build --test_env=RUBYOPT="-Irb/lib -w"
 
 # JRuby/TruffleRuby: https://github.com/jruby/jruby/issues/5661
+
 build --action_env=HOME
 test --test_env=HOME
 

.editorconfig

@@ -53,3 +53,7 @@ indent_style = space
 indent_size = 2
 end_of_line = crlf
 charset = utf-8
+
+[{*.bazel,WORKSPACE}]
+indent_style = space
+indent_size = 4

.github/workflows/ci-ruby.yml

@@ -51,23 +51,35 @@ jobs:
       - name: Build Gems
         run: bazel build //rb:${{ matrix.target }}
 
-  chrome-test:
+  integration-test:
     if: ${{ needs.check_workflow.outputs.result == 'true' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(toJson(github.event.commits), '[run ruby]') == true }}
     needs: check_workflow
     runs-on: ${{ matrix.os }}
+    name: ${{ format('{0}{1}-test ({2})', (matrix.remote && 'remote-' || ''), matrix.browser, matrix.os) }}
     strategy:
       fail-fast: false
       matrix:
-        target: [ 'chrome-test', 'remote-chrome-test' ]
-        os: [ 'ubuntu-latest', 'windows-latest' ]
+        browser:
+          - chrome
+          - edge
+          - firefox
+        remote:
+          - false
+          - true
+        os:
+          - ubuntu-latest
+          - windows-latest
+        exclude:
+          - browser: edge
+            os: ubuntu-latest
     steps:
       - name: Checkout source tree
         uses: actions/checkout@v3
       - name: Setup Bazel
         uses: p0deje/[email protected]
         with:
           bazelisk-cache: true
-          disk-cache: rb-${{ matrix.target }}
+          disk-cache: rb-${{ matrix.browser }}-remote-${{ matrix.remote }}
           external-cache: |
             crates: rust/Cargo.Bazel.lock
             npm: package-lock.json
@@ -84,6 +96,7 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
         run: sudo apt-get -y install fluxbox
       - name: Setup Chrome
+        if: matrix.browser == 'chrome'
         uses: browser-actions/setup-chrome@latest
         with:
           chrome-version: stable
@@ -96,95 +109,19 @@ jobs:
       - name: Set resolution
         if: matrix.os == 'windows-latest'
         run: Set-DisplayResolution -Width 1920 -Height 1080 -Force
-      - name: Run Chrome tests
-        run: bazel test --cache_test_results=no --test_output=all //rb:${{ matrix.target }}
-        env:
-          DISPLAY: :99
-
-  edge-test:
-    if: ${{ needs.check_workflow.outputs.result == 'true' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(toJson(github.event.commits), '[run ruby]') == true }}
-    needs: check_workflow
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        target: [ 'edge-test', 'remote-edge-test' ]
-        os: [ 'windows-latest' ]
-    steps:
-      - name: Checkout source tree
-        uses: actions/checkout@v3
-      - name: Setup Java
-        uses: actions/setup-java@v3
-        with:
-          java-version: 11
-          distribution: 'temurin'
-      - name: Setup Bazel
-        uses: p0deje/[email protected]
-        with:
-          bazelisk-cache: true
-          disk-cache: rb-${{ matrix.target }}
-          external-cache: |
-            crates: rust/Cargo.Bazel.lock
-            npm: package-lock.json
-            pypi__pip: py/requirements_lock.txt
-            rules_ruby_dist: rb/ruby_version.bzl
-          repository-cache: true
-          token: ${{ secrets.GITHUB_TOKEN }}
       - name: Setup Edge
+        if: matrix.browser == 'edge'
         uses: browser-actions/setup-edge@latest
         with:
           edge-version: stable
-      - name: Run Edge tests
-        run: bazel test --cache_test_results=no --test_output=all //rb:${{ matrix.target }}
-
-  firefox-test:
-    if: ${{ needs.check_workflow.outputs.result == 'true' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || contains(toJson(github.event.commits), '[run ruby]') == true }}
-    needs: check_workflow
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        target: [ 'firefox-test', 'remote-firefox-test' ]
-        os: [ 'ubuntu-latest', 'windows-latest' ]
-    steps:
-      - name: Checkout source tree
-        uses: actions/checkout@v3
-      - name: Setup Java
-        uses: actions/setup-java@v3
-        with:
-          java-version: 11
-          distribution: 'temurin'
-      - name: Setup Bazel
-        uses: p0deje/[email protected]
-        with:
-          bazelisk-cache: true
-          disk-cache: rb-${{ matrix.target }}
-          external-cache: |
-            crates: rust/Cargo.Bazel.lock
-            npm: package-lock.json
-            pypi__pip: py/requirements_lock.txt
-            rules_ruby_dist: rb/ruby_version.bzl
-          repository-cache: true
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Setup Fluxbox
-        if: matrix.os == 'ubuntu-latest'
-        run: sudo apt-get -y install fluxbox
-      - name: Setup Firefox
-        uses: abhi1693/[email protected]
-        with:
-          browser: firefox
-          version: latest
-      - name: Start XVFB
-        if: matrix.os == 'ubuntu-latest'
-        run: Xvfb :99 &
-      - name: Start Fluxbox
-        if: matrix.os == 'ubuntu-latest'
-        run: fluxbox -display :99 &
-      - name: Set resolution
-        if: matrix.os == 'windows-latest'
-        run: Set-DisplayResolution -Width 1920 -Height 1080 -Force
-      - name: Run Firefox tests
-        run: bazel test --cache_test_results=no --test_output=all //rb:${{ matrix.target }}
+      - name: Run tests
+        run: >
+          bazel test
+          --define browser=${{ matrix.browser }}
+          --define remote=${{ matrix.remote }}
+          --flaky_test_attempts 3
+          --local_test_jobs 1
+          //rb/spec/integration/...
         env:
           DISPLAY: :99
 
@@ -262,4 +199,4 @@ jobs:
           repository-cache: true
           token: ${{ secrets.GITHUB_TOKEN }}
       - name: Run unit tests
-        run: bazel test --cache_test_results=no --test_output=all //rb:unit-test
+        run: bazel test //rb/spec/unit/...

CONTRIBUTING.md

@@ -30,7 +30,7 @@ the issue is a regression.
 ## Feature Requests
 
 If you find that Selenium is missing something, feel free to open an issue
-with details describing what feature(s) you'd like added or changed.  
+with details describing what feature(s) you'd like added or changed.
 
 If you'd like a hand at trying to implement the feature yourself, please refer to the [Code Contributions](#code-contributions) section of the document.
 
@@ -180,7 +180,7 @@ Use `git rebase` (not `git merge`) to sync your work from time to time.
 ### Step 5: Test
 
 Bug fixes and features **should have tests**. Look at other tests to
-see how they should be structured. Verify that new and existing tests are 
+see how they should be structured. Verify that new and existing tests are
 passing locally before pushing code.
 
 #### Running tests locally
@@ -192,20 +192,20 @@ Build your code for the latest changes and run tests locally.
   <summary>
     Click to see How to run Python Tests.
   </summary>
-  
+
   It's not mandatory to run tests sequentially but running Unit tests
   before browser testing is recommended.
-  
+
   Unit Tests
   ```shell
   % bazel test //py:unit
   ```
-  
+
   Remote Tests
   ```shell
   % bazel test --jobs 1 //py:test-remote
   ```
-  
+
   Browser Tests
   ```shell
   % bazel test //py:test-<browsername> #eg test-chrome, test-firefox
@@ -217,17 +217,17 @@ Build your code for the latest changes and run tests locally.
   <summary>
     Click to see How to run JavaScript Tests.
   </summary>
-  
+
   Node Tests
   ```shell
   % bazel test //javascript/node/selenium-webdriver:tests
   ```
-  
+
   Firefox Atom Tests
   ```shell
   % bazel test --test_tag_filters=firefox //javascript/atoms/... //javascript/selenium-atoms/... //javascript/webdriver/...
   ```
-  
+
   Grid UI Unit Tests
   ```shell
   % cd javascript/grid-ui && npm install && npm test
@@ -239,47 +239,27 @@ Build your code for the latest changes and run tests locally.
   <summary>
     Click to see How to run Java Tests.
   </summary>
-  
+
   Small Tests
   ```shell
   % bazel test --cache_test_results=no --test_size_filters=small grid java/test/...
   ```
-  
+
   Large Tests
   ```shell
   % bazel test --cache_test_results=no java/test/org/openqa/selenium/grid/router:large-tests
   ```
-  
+
   Browser Tests
   ```shell
   bazel test --test_size_filters=small,medium --cache_test_results=no --test_tag_filters=-browser-test //java/...
   ```
 </details>
 
 ##### Ruby
-<details>
-  <summary>
-    Click to see How to run Ruby Tests.
-  </summary>
-  
-  It's not mandatory to run tests sequentially but running Unit tests
-  before browser testing is recommended.
-  
-  Unit Tests
-  ```shell
-  % bazel test rb:unit-test
-  ```
-
-  Chrome Tests
-  ```shell
-  bazel test rb:chrome-test
-  ```
 
-  Remote Tests
-  ```shell
-  % bazel test --test_output=all --test_arg="-tfocus" --test_arg="--fail-fast" rb:remote-chrome-test
-  ```
-</details>
+Please see https://github.com/SeleniumHQ/selenium#ruby for details about running
+tests.
 
 ### Step 6: Push
 
@@ -288,7 +268,7 @@ Build your code for the latest changes and run tests locally.
 ```
 
 Go to https://github.com/yourusername/selenium.git and press the _Pull
-Request_ and fill out the form. 
+Request_ and fill out the form.
 
 Pull requests are usually reviewed within a few days. If there are
 comments to address, apply your changes in new commits (preferably