ruby_raider 3.8.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd1d87871eeb4bad99f5952f35a7f81da1f54d9170536ebd959ebe19403d63d
-  data.tar.gz: 0bdb788bce2e8245483176ebe5118ff046fef892ae8767d74986384d9747deba
+  metadata.gz: 2a901c209fc30681088e9acb4d7c5fb315990db7346128a63533e0e70ef8c58f
+  data.tar.gz: 1e99b0e973091657bfc10b98d5de1b730d9f7972a2446c56b7a56ddd786f9392
 SHA512:
-  metadata.gz: 0a9f31493361abd7af6a78f8afe18a7d6f82569c364ed08c17445705bc3e0e5ef770a0da54b927139996393622a49306433b8aa0deccd61483a8af724b432fcc
-  data.tar.gz: 85c9d92cf395f858f4c2977a382c96385ebb82992cdc6ad100477ed8c9d91f34a6ea302a3cea26a612e5b682b4ad1b3d398449420abc6e5f58c3b5eaa8ccebbb
+  metadata.gz: 757ad8b61b6c3605d17739690e895198f2ad4c0aadbe4144fc1df77ec743afefd8095472c07e4d2ba4246c515d8038c052d096badc8cfbb04c432218c68ddb45
+  data.tar.gz: 2e9d2bfb4e714c98052cb6df654be058d37fe40476aa93ce20e9319aeea5bbc24abe4359299b7a9f71f0c204ad19599865f1396794393e634b7200ed29a80bdb

data/.github/workflows/release.yml

@@ -23,18 +23,10 @@ jobs:
       url: https://rubygems.org/gems/ruby_raider
 
     steps:
-      - name: Generate release token
-        id: app-token
-        uses: actions/create-github-app-token@v1
-        with:
-          app-id: ${{ secrets.APP_ID }}
-          private-key: ${{ secrets.APP_PRIVATE_KEY }}
-
       - name: Checkout code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          token: ${{ steps.app-token.outputs.token }}
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -42,29 +34,20 @@ jobs:
           ruby-version: '3.3'
           bundler-cache: true
 
-      - name: Configure git
-        run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-
-      - name: Update version file
+      # master is protected, so the workflow does not push a version bump: bump lib/version in a PR,
+      # merge it, then run this workflow with the same version.
+      - name: Check version file
         id: version
+        env:
+          VERSION: ${{ github.event.inputs.version }}
         run: |
-          VERSION="${{ github.event.inputs.version }}"
-          echo "$VERSION" > lib/version
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-          echo "Releasing version: $VERSION"
-
-      - name: Commit and push version bump
-        run: |
-          VERSION="${{ steps.version.outputs.version }}"
-          git add lib/version
-          if git diff --cached --quiet; then
-            echo "Version already up to date"
-          else
-            git commit -m "Bump version to ${VERSION}"
-            git push origin HEAD
+          CURRENT="$(tr -d '[:space:]' < lib/version)"
+          if [ "$CURRENT" != "$VERSION" ]; then
+            echo "::error::lib/version is $CURRENT but $VERSION was requested. Bump lib/version to $VERSION in a PR, merge it, then run this workflow again."
+            exit 1
           fi
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "Releasing version: $VERSION"
 
       - name: Install dependencies
         run: bundle install
@@ -170,6 +153,12 @@ jobs:
             echo "Could not check RubyGems (HTTP $HTTP_CODE) — will attempt push"
           fi
 
+      # The Rakefile has no bundler/gem_tasks, so rubygems/release-gem (which runs `rake release`)
+      # cannot be used; push the gem built above with trusted-publishing (OIDC) credentials instead.
+      - name: Configure RubyGems credentials (trusted publishing)
+        if: steps.check_gem.outputs.published == 'false'
+        uses: rubygems/configure-rubygems-credentials@v2.1.0
+
       - name: Push gem to RubyGems
         if: steps.check_gem.outputs.published == 'false'
-        uses: rubygems/release-gem@v1
+        run: gem push "${{ steps.build.outputs.gem_file }}"

data/.github/workflows/security.yml

@@ -0,0 +1,68 @@
+name: Security
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  schedule:
+    - cron: '0 6 * * 1' # Mondays 06:00 UTC
+
+permissions:
+  contents: read
+
+jobs:
+  bundler-audit:
+    name: bundler-audit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Check gems for known vulnerabilities
+        run: bundle exec bundler-audit check --update
+
+  ruby-audit:
+    name: ruby-audit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Check Ruby and RubyGems for known vulnerabilities
+        run: bundle exec ruby-audit check
+
+  osv-scanner:
+    name: osv-scanner
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Gemfile.lock is gitignored in this repo, so generate it for the scanner
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+
+      - name: Generate Gemfile.lock
+        run: bundle lock
+
+      - name: Scan with OSV-Scanner
+        uses: google/osv-scanner-action/osv-scanner-action@v2.7.0
+        with:
+          scan-args: |-
+            --recursive
+            --no-ignore
+            ./

data/.rubocop.yml

@@ -60,11 +60,39 @@ Naming/AccessorMethodName:
 # Migration
 
 # Naming
+# Stands in for the selenium-webdriver gem, so it keeps the gem's require name.
+Naming/FileName:
+  Exclude:
+    - 'spec/generators/fixtures/video_helper_stubs/selenium-webdriver.rb'
+
 Naming/PredicateName:
   ForbiddenPrefixes:
     - 'is_'
 
 # Security
+Security:
+  Enabled: true
+
+Security/CompoundHash:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+
+Security/JSONLoad:
+  Enabled: true
+
+Security/MarshalLoad:
+  Enabled: true
+
+Security/Open:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true
 
 # Styles
 

data/README.md

@@ -27,7 +27,7 @@
 
 ## What is Ruby Raider?
 
-Ruby Raider is a CLI gem and API backend for scaffolding and generating UI test automation frameworks. It supports both interactive command-line usage and programmatic invocation via [Raider Desktop](https://ruby-raider.com).
+Ruby Raider is a CLI gem for scaffolding and generating UI test automation frameworks. It supports interactive command-line usage and flag-driven invocation (for example `raider new my_project -p framework:rspec automation:selenium`), which is how [Raider Desktop](https://ruby-raider.com) drives it.
 
 ## Supported Frameworks
 
@@ -60,15 +60,22 @@ Every generated project comes with:
 
 - **Page Object Model** — Base page and component classes with example pages
 - **Test examples** — Working login tests against the [Raider Test Store](https://raider-test-site.onrender.com/)
-- **Raider reporting** — RSpec and Cucumber projects include [raider_reporter](https://github.com/RaiderHQ/raider_reporter), which writes results to `raider-results/` and uploads runs when `RAIDER_TOKEN` and `RAIDER_ENDPOINT` are set; generated CI runs the suite through `raider-reporter exec` with `RAIDER_QUARANTINE`, so quarantined tests do not fail the build
-- **GitHub Actions CI** — Ready-to-use test pipeline
+- **Raider reporting** — RSpec and Cucumber projects include [raider_reporter](https://github.com/RaiderHQ/raider_reporter), which writes results to `raider-results/` and uploads runs to your Raider Hideout server when `RAIDER_TOKEN` and `RAIDER_ENDPOINT` are set; generated CI runs the suite through `raider-reporter exec` with `RAIDER_QUARANTINE`, so quarantined tests do not fail the build; an opt-in `raider-gate` job (`RAIDER_GATE=1`) fails CI when the Raider quality gate fails
+- **Failure video replay** — Every test is recorded and the video is kept only for failing tests, attached to the report as `video` (WebM from page screenshots for Selenium and Watir, Appium's own MP4 for mobile, which needs `ffmpeg` on the Appium server host for iOS and for Android recordings over 180 s). Turn it off per run with `VIDEO=off`, or per project with `raider u video off`; ffmpeg is downloaded once, SHA-256 checked and cached in `~/.cache/raider`. The RaiderHQ `ffmpeg-7.1` build that the download uses is not published yet, so for now set `RAIDER_FFMPEG_PATH` to an ffmpeg with libvpx to get web videos
+- **GitHub Actions CI** — Ready-to-use test pipeline that caches ffmpeg for failure videos
 - **Rake tasks** — Default, smoke, and regression tasks with tag-based filtering
 - **Retry support** — RSpec retry with configurable retry count via `RETRY_COUNT` env var
-- **Re-run failed tests** — Persistence file for tracking example status
+- **Re-run failed tests** — RSpec keeps `spec/examples.txt` for `--only-failures`; Cucumber projects write failed scenarios to `rerun.txt`
 - **Parallel execution** — parallel_tests and parallel_split_test gems included
 - **Configurable browser** — Chrome/Firefox with customizable arguments, viewport, timeout, and headless mode
 - **Linting** — RuboCop and Reek configs included
 
+> **Upgrading from 3.9 or earlier:** existing projects are not changed automatically. To get failure videos, generate a
+> new project with the same options and copy `helpers/video_helper.rb`, the video lines in `helpers/spec_helper.rb`
+> (RSpec) or `features/support/env.rb` (Cucumber), the `listener:` in the driver or browser helper, the `video:` block
+> in `config/config.yml`, and the ffmpeg cache and install steps in your CI pipeline. raider_reporter 0.10 or later
+> adds the inline video player in `raider-results/index.html` and a larger size limit for video attachments.
+
 For Appium projects, download the example [app](https://github.com/RaiderHQ/raider_test_app) and start the server:
 
 ```bash
@@ -156,6 +163,7 @@ raider u viewport [DIMENSIONS]  # Set viewport size (e.g., 1920x1080)
 raider u platform [PLATFORM]    # Set platform for cross-platform tests
 raider u start_appium           # Start Appium server
 raider u desktop                # Download Raider Desktop
+raider u video [ACTION]         # Failure videos: install (ffmpeg), status, on, off
 ```
 
 ## Development
@@ -168,6 +176,16 @@ bundle exec rubocop     # Run linter
 bundle exec reek        # Run code smell detection
 ```
 
+### Security checks
+
+```bash
+bundle exec bundler-audit check --update  # Check gems for known vulnerabilities
+bundle exec ruby-audit check              # Check Ruby and RubyGems versions for known vulnerabilities
+bundle exec rubocop --only Security       # Run RuboCop's Security cops
+```
+
+The same checks (plus OSV-Scanner) run in CI via `.github/workflows/security.yml`.
+
 ## Links
 
 * [RubyGems](https://rubygems.org/gems/ruby_raider)