ruby-examples.yml

name: Run Ruby examples

on:
  workflow_dispatch:
  schedule:
    - cron: '55 22 * * *'
  pull_request:
    branches:
      - trunk
    paths:
      - 'examples/ruby/**'
  push:
    branches:
      - trunk
    paths:
      - 'examples/ruby/**'

env:
  DISPLAY: :99
  GITHUB_TOKEN: ${{ secrets.SELENIUM_CI_TOKEN }}
  GH_TOKEN: ${{ secrets.SELENIUM_CI_TOKEN }}

jobs:
  tests:
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu, windows, macos ]
        release: [ stable, nightly ]
    runs-on: ${{ format('{0}-latest', matrix.os) }}
    steps:
      - name: Checkout GitHub repo
        uses: actions/checkout@v4
      - name: Remove driver directories Windows
        if: matrix.os == 'windows'
        run: |
          rm "$env:ChromeWebDriver" -r -v
          rm "$env:EdgeWebDriver" -r -v
          rm "$env:GeckoWebDriver" -r -v
      - name: Remove driver directories Non-Windows
        if: matrix.os != 'windows'
        run: |
          sudo rm -rf $CHROMEWEBDRIVER $EDGEWEBDRIVER $GECKOWEBDRIVER
      - name: Setup Fluxbox and Xvfb
        if: matrix.os == 'ubuntu'
        run: |
          sudo apt-get -y install fluxbox libxss1 libappindicator3-1 libindicator7
          Xvfb :99 &
          fluxbox -display :99 &
          echo "DISPLAY=:99" >> "$GITHUB_ENV"
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.1
          bundler-cache: true
      - name: Install Gems Nightly non-Windows
        if: matrix.release == 'nightly' && matrix.os != 'windows'
        run:
          |
          pip install -r ./scripts/requirements.txt
          latest_nightly_webdriver=$(python ./scripts/latest-nightly-version.py rubygems selenium-webdriver)
          echo $latest_nightly_webdriver
          cd examples/ruby
          bundle install
          bundle remove selenium-webdriver
          bundle add selenium-webdriver --version $latest_nightly_webdriver --source "https://token:${{secrets.GITHUB_TOKEN}}@rubygems.pkg.github.com/seleniumhq"
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Install Gems Nightly Windows
        if: matrix.release == 'nightly' && matrix.os == 'windows'
        run:
          |
          pip install -r ./scripts/requirements.txt
          $latest_nightly_webdriver = python ./scripts/latest-nightly-version.py rubygems selenium-webdriver
          cd examples/ruby
          bundle install
          bundle remove selenium-webdriver
          bundle add selenium-webdriver --version $latest_nightly_webdriver --source "https://token:${{secrets.GITHUB_TOKEN}}@rubygems.pkg.github.com/seleniumhq"
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Install Gems Stable
        if: matrix.release == 'stable'
        working-directory: ./examples/ruby
        run: bundle install
      - name: Set up Java
        uses: actions/setup-java@v4
        with:
          distribution: 'temurin'
          java-version: 11
      - name: Run tests on Windows
        if: matrix.os == 'windows'
        uses: nick-invision/retry@v3.0.2
        with:
          timeout_minutes: 20
          max_attempts: 2
          command: |
            cd examples/ruby
            bundle exec rspec
          new_command_on_retry: |
            cd examples/ruby; $env:DEBUG="true"; bundle exec rspec --only-failures --backtrace
      - name: Run tests on ${{ matrix.os }}
        if: matrix.os != 'windows'
        uses: nick-invision/retry@v3.0.2
        with:
          timeout_minutes: 20
          max_attempts: 2
          command: |
            cd examples/ruby
            bundle exec rspec
          new_command_on_retry: |
            cd examples/ruby
            DEBUG=true bundle exec rspec --only-failures --backtrace

  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout GitHub repo
        uses: actions/checkout@v4
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.1
          bundler-cache: true
      - name: Install dependencies
        working-directory: ./examples/ruby
        run: bundle install
      - name: Run RuboCop
        working-directory: ./examples/ruby
        run: bundle exec rubocop