ruby_raider 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5fc3418c82e5a121ebecbc862acd716ded56f9d7dc49be670e9f0361917deb
-  data.tar.gz: b7464935c9d32155bd30d80750c914e6fd3ba95b3db3d6ed8eb95d5461f86fcb
+  metadata.gz: 5141b6656f193315dce72afc9a7096ea48e63eed8a23c348cf38be0978627e90
+  data.tar.gz: b47a32013c49843ac2511f4bb0188adfcd50a83294fdbe692f8e483f3215ca67
 SHA512:
-  metadata.gz: 827db06d8dab522391496aeedbff5e199119ac287e548241e1ce23bb9ff65616043c1626cb35226ce1230a8c154953c9eb0bc3f65d5a7abaa9ee323dfd76522d
-  data.tar.gz: e37a2899b4e8f78c941dd0f570f2a5c2833a61cc74cb30e392cc7e53565f1df78374853b0fd73b38aeabb7d8849fd22210cf534e153f3c8d9664128bd1566b5a
+  metadata.gz: 4840894d57645404ac69faf2ebe7985e59b5df8e653ec8746fb40d23a45e082b0f2708b1d2cc275f7cfa3ce250a009dea61d2022ed6ca96f6c835ac36ed04bca
+  data.tar.gz: f0eee8de1a42d7ff1440ee7d6700c9d6ffa9370fe53a811b2c99ba03147eed8101edeff5a8e9df0849fe25fb5189d5fd34aab9e07b5ee0642d575d46739f487c

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.1.0
+  TargetRubyVersion: 3.2.0
 
 # Layout
 Layout/CaseIndentation:

data/RELEASE.md

@@ -2,6 +2,13 @@
 
 ## Release Notes
 
+### 3.4.0
+
+- Generated RSpec projects with GitHub CI now include a `raider-comment` job that comments Raider test results on pull requests via `raider-reporter comment`. It runs after every test job, only on pull requests, and needs the `RAIDER_TOKEN` secret and `RAIDER_ENDPOINT` variable. Cucumber projects are unchanged.
+- The job needs `contents: read`, `pull-requests: write` and `statuses: write` permissions; it reports a `raider/tests` status, and pull requests from forks are skipped.
+- Generated Gemfiles now require `raider_reporter` `~> 0.3`.
+- Ruby Raider now requires Ruby 3.2.0 or newer.
+
 ### 3.3.0
 
 - Generated RSpec projects now include `raider_reporter`: results are written to `raider-results/` and uploaded when `RAIDER_TOKEN` and `RAIDER_ENDPOINT` are set. Allure is still produced. Cucumber projects are unchanged.

data/lib/generators/infrastructure/templates/github.tt

@@ -81,3 +81,24 @@ jobs:
           PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PUBLISH_BRANCH: gh-pages
           PUBLISH_DIR: allure-history
+
+<%- unless framework == 'cucumber' -%>
+  raider-comment:
+    needs: [build]
+    if: always() && github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.4.0, bundler-cache: true }
+      - name: Comment Raider results on the pull request
+        run: bundle exec raider-reporter comment
+        env:
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+<%- end -%>

data/lib/generators/infrastructure/templates/github_appium.tt

@@ -126,3 +126,24 @@ jobs:
           if-no-files-found: ignore
 <%- end -%>
 <%- end -%>
+
+<%- unless cucumber? -%>
+  raider-comment:
+    needs: [<%= [('ios-tests' if ios? || cross_platform?), ('android-tests' if android? || cross_platform?)].compact.join(', ') %>]
+    if: always() && github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.4.0, bundler-cache: true }
+      - name: Comment Raider results on the pull request
+        run: bundle exec raider-reporter comment
+        env:
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+<%- end -%>

data/lib/generators/templates/common/gemfile.tt

@@ -20,7 +20,7 @@ gem 'parallel_tests'
 gem 'rake'
 gem 'reek'
 <%- if rspec? -%>
-gem 'raider_reporter', '~> 0.2'
+gem 'raider_reporter', '~> 0.3'
 gem 'rspec-retry'
 <%- end -%>
 gem '<%= framework %>'

data/lib/version

@@ -1 +1 @@
-3.3.0
+3.4.0

data/ruby_raider.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = 'agustin.pe94@gmail.com'
   s.homepage = 'https://github.com/RubyRaider/ruby_raider'
   s.license = 'MIT'
-  s.required_ruby_version = '>= 3.1.0'
+  s.required_ruby_version = '>= 3.2.0'
   s.files  = `git ls-files -z`.split("\x0")
   s.bindir = 'bin'
   s.executables << 'raider'

data/spec/integration/content/ci_content_spec.rb

@@ -81,7 +81,7 @@ describe 'CI pipeline content' do
 
     it 'uploads raider-results as an artifact even on failure in every job' do
       uploads = steps.select { |step| step['uses'] == 'actions/upload-artifact@v4' }
-      expect(uploads.size).to eq(YAML.safe_load(pipeline)['jobs'].size)
+      expect(uploads.size).to eq(YAML.safe_load(pipeline)['jobs'].except('raider-comment').size)
       uploads.each do |upload|
         expect(upload['with']['path']).to eq('raider-results/')
         expect(upload['if']).to eq('always()')
@@ -89,6 +89,54 @@ describe 'CI pipeline content' do
     end
   end
 
+  shared_examples 'github raider-comment job' do |project_name, file, test_jobs|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    let(:jobs) { YAML.safe_load(pipeline)['jobs'] }
+    let(:job) { jobs['raider-comment'] }
+
+    it 'is a valid workflow with exactly the expected jobs' do
+      expect(jobs.keys).to match_array(test_jobs + ['raider-comment'])
+    end
+
+    it 'needs every test job' do
+      expect(job['needs']).to match_array(test_jobs)
+    end
+
+    it 'runs always, on pull requests only' do
+      expect(job['if']).to eq("always() && github.event_name == 'pull_request'")
+      expect(job['runs-on']).to eq('ubuntu-latest')
+    end
+
+    it 'has the least permissions required' do
+      expect(job['permissions']).to eq('contents' => 'read', 'pull-requests' => 'write', 'statuses' => 'write')
+    end
+
+    it 'checks out, sets up the same Ruby as the test jobs and comments' do
+      steps = job['steps']
+      expect(steps[0]).to eq('uses' => 'actions/checkout@v4')
+      expect(steps[1]['uses']).to eq('ruby/setup-ruby@v1')
+      test_ruby = jobs.values_at(*test_jobs).flat_map { |j| j['steps'] }
+                      .find { |step| step['uses'] == 'ruby/setup-ruby@v1' }['with']['ruby-version']
+      expect(steps[1]['with']).to eq('ruby-version' => test_ruby, 'bundler-cache' => true)
+      expect(steps[2]).to eq('name' => 'Comment Raider results on the pull request',
+                             'run' => 'bundle exec raider-reporter comment',
+                             'env' => { 'RAIDER_TOKEN' => '${{ secrets.RAIDER_TOKEN }}',
+                                        'RAIDER_ENDPOINT' => '${{ vars.RAIDER_ENDPOINT }}',
+                                        'GITHUB_TOKEN' => '${{ secrets.GITHUB_TOKEN }}' })
+      expect(steps.size).to eq(3)
+    end
+  end
+
+  shared_examples 'github without raider-comment job' do |project_name, file|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    it 'has no raider-comment job' do
+      expect(pipeline).not_to include('raider-comment')
+      expect(pipeline).not_to include('raider-reporter')
+    end
+  end
+
   shared_examples 'github without raider wiring' do |project_name, file|
     subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
 
@@ -112,6 +160,7 @@ describe 'CI pipeline content' do
     include_examples 'github rspec pipeline', name
     include_examples 'github triggers', name, 'test_pipeline.yml'
     include_examples 'github raider wiring', name, 'test_pipeline.yml'
+    include_examples 'github raider-comment job', name, 'test_pipeline.yml', %w[build]
     include_examples 'github allure steps', name
   end
 
@@ -121,6 +170,7 @@ describe 'CI pipeline content' do
     include_examples 'github cucumber pipeline', name
     include_examples 'github triggers', name, 'test_pipeline.yml'
     include_examples 'github without raider wiring', name, 'test_pipeline.yml'
+    include_examples 'github without raider-comment job', name, 'test_pipeline.yml'
     include_examples 'github allure steps', name
   end
 
@@ -130,12 +180,17 @@ describe 'CI pipeline content' do
     include_examples 'github rspec pipeline', name
     include_examples 'github triggers', name, 'test_pipeline.yml'
     include_examples 'github raider wiring', name, 'test_pipeline.yml'
+    include_examples 'github raider-comment job', name, 'test_pipeline.yml', %w[build]
     include_examples 'github allure steps', name
   end
 
-  %w[android ios cross_platform].each do |automation|
+  appium_jobs = { 'android' => %w[android-tests], 'ios' => %w[ios-tests],
+                  'cross_platform' => %w[ios-tests android-tests] }
+
+  appium_jobs.each do |automation, test_jobs|
     context "with rspec and #{automation}" do
       name = "#{FrameworkIndex::RSPEC}_#{automation}"
+      include_examples 'github raider-comment job', name, 'appium_pipeline.yml', test_jobs
       include_examples 'github triggers', name, 'appium_pipeline.yml'
       include_examples 'github raider wiring', name, 'appium_pipeline.yml'
     end
@@ -144,6 +199,7 @@ describe 'CI pipeline content' do
       name = "#{FrameworkIndex::CUCUMBER}_#{automation}"
       include_examples 'github triggers', name, 'appium_pipeline.yml'
       include_examples 'github without raider wiring', name, 'appium_pipeline.yml'
+      include_examples 'github without raider-comment job', name, 'appium_pipeline.yml'
     end
   end
 end

data/spec/integration/content/gemfile_content_spec.rb

@@ -127,7 +127,7 @@ describe 'Gemfile content' do
         let(:gemfile) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'Gemfile') }
 
         it 'includes raider_reporter' do
-          expect(gemfile).to include("gem 'raider_reporter', '~> 0.2'")
+          expect(gemfile).to include("gem 'raider_reporter', '~> 0.3'")
         end
 
         it 'keeps allure gems' do

data/spec/integration/end_to_end_spec.rb

@@ -104,6 +104,15 @@ describe 'End-to-End Project Generation and Execution' do
       expect(bundle_install(project)).to be true
     end
 
+    it 'resolves raider_reporter 0.3 from RubyGems and ships the raider-reporter executable', :aggregate_failures do
+      skip 'Bundle install failed' unless bundle_install(project)
+
+      expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^    raider_reporter \(0\.3\.\d+\)$/)
+      result = run_in_project(project, 'bundle exec raider-reporter --help', timeout: 60)
+      expect(result[:exit_code]).to eq(0), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
+      expect(result[:stdout] + result[:stderr]).to include('raider-reporter comment')
+    end
+
     it 'runs generated RSpec tests successfully', :slow do
       skip 'Bundle install failed' unless bundle_install(project)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Agustin Pequeno
@@ -346,7 +346,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="