Add capybara screenshots

.github/workflows/test.yml

@@ -99,3 +99,16 @@ jobs:
           max_attempts: 3
           retry_on: error
           command: CI=1 RAILS_ENV=test bundle exec rspec --backtrace
+
+      # Prepare screenshots for upload
+      - name: Prepare screenshots for upload
+        run: RAILS_ENV=test bundle exec rails ci:screenshots:rename
+        if: always()
+
+      # Upload screenshots artifact
+      - name: Upload screenshots
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: screenshot_artifact
+          path: /home/runner/work/participa/participa/tmp/screenshots/

Gemfile

@@ -56,5 +56,6 @@ group :development do
 end
 
 group :test do
+  gem "capybara-screenshot"
   gem "database_cleaner"
 end

Gemfile.lock

@@ -358,6 +358,9 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
+    capybara-screenshot (1.0.26)
+      capybara (>= 1.0, < 4)
+      launchy
     carrierwave (2.2.6)
       activemodel (>= 5.0.0)
       activesupport (>= 5.0.0)
@@ -933,6 +936,7 @@ PLATFORMS
 DEPENDENCIES
   bootsnap
   byebug
+  capybara-screenshot
   daemons
   database_cleaner
   decidim!

lib/tasks/ci_rename_screenshots.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+SCREENSHOT_DIRECTORY = "/home/runner/work/participa/participa/tmp/screenshots"
+
+namespace :ci do
+  namespace :screenshots do
+    task rename: :environment do
+      Dir["#{SCREENSHOT_DIRECTORY}/*"].each do |filename|
+        new_filename = filename.gsub(":", "").gsub(". .", ".")
+        File.rename(filename, new_filename)
+        puts "#{filename} was renamed to #{new_filename}"
+      end
+    end
+  end
+end

spec/rails_helper.rb

@@ -51,4 +51,9 @@
 
   # Filter lines from Rails gems in backtraces.
   config.filter_rails_from_backtrace!
+
+  # Change the default screenshots file name
+  Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
+    "screenshot_#{example.description.gsub(" ", "-").gsub(":", "").gsub(%r{^.*/spec/}, "")}"
+  end
 end