Improve system tests configuration

Author: palkan

spec/support/capybara_setup.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require "system_helper"
 
 describe "Workspaces -> Chat" do
   fixtures :workspaces

spec/support/session_helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require "system_helper"
 
 describe "Workspaces -> New list" do
   fixtures :workspaces

spec/system/chat/messaging_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require "system_helper"
 
 describe "Workspaces -> List -> Delete" do
   fixtures :workspaces, :lists

spec/system/lists/create_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require "system_helper"
 
 describe "Workspaces -> List -> Items" do
   fixtures :workspaces, :lists, :items

spec/system/lists/delete_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require "system_helper"
 
 describe "Log in", auth: false do
   fixtures :workspaces

spec/system/lists/items_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require "system_helper"
 
 describe "Log in" do
   it "I can logout" do

spec/system/sessions/login_spec.rb

@@ -2,17 +2,21 @@
 
 # Rails is not flexible enough; at least for now(
 module BetterRailsSystemTests
-  # Use our `Capybara.save_path` to store images (required for CircleCI artifacts)
+  # Use our `Capybara.save_path` to store screenshots with other capybara artifacts
   # (Rails screenshots path is not configurable https://github.com/rails/rails/blob/49baf092439fc74fc3377b12e3334c3dd9d0752f/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb#L79)
   def absolute_image_path
-    Rails.root.join("#{Capybara.save_path}/#{image_name}.png")
+    Rails.root.join("#{Capybara.save_path}/screenshots/#{image_name}.png")
   end
 
-  # Generate clickable paths for VS Code
-  def display_image
-    path = Pathname.new(image_path)
-    path = path.relative_path_from(Rails.root) unless path.relative?
-    "🖼  [Screenshot]: #{path}\n"
+  # Use relative path in screenshot message to make it clickable in VS Code when running in Docker
+  def image_path
+    absolute_image_path.relative_path_from(Rails.root).to_s
+  end
+
+  # Make failure screenshots compatible with multi-session setup
+  def take_screenshot
+    return super unless Capybara.last_used_session
+    Capybara.using_session(Capybara.last_used_session) { super }
   end
 end
 
@@ -26,7 +30,8 @@ def display_image
     Rails.application.default_url_options[:host] = was_host
   end
 
-  config.before(:each, type: :system) do
+  # Make sure this hook runs before others
+  config.prepend_before(:each, type: :system) do
     # Rails sets host to `127.0.0.1` for every test by default.
     # That would break in Docker
     # NOTE: Fixed in 6.1 (https://github.com/rails/rails/commit/d415eb4f6d6bb24b78b968ae28c22bb7e1721285#diff-9de6fe0bff4847b77cba72441ee855c2)

spec/system/sessions/logout_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Capybara settings (not covered by Rails system tests)
+
+# Use a hostname accessible from the outside world
+# (Required for running tests in Docker)
+Capybara.server_host = `hostname`.strip&.downcase || "0.0.0.0"
+Capybara.app_host = "http://#{Capybara.server_host}"
+
+# Don't wait too long in `have_xyz` matchers
+Capybara.default_max_wait_time = 2
+
+# Normalizes whitespaces when using `has_text?` and similar matchers
+Capybara.default_normalize_ws = true
+
+# Where to store artifacts (e.g. screenshots, downloaded files, etc.)
+Capybara.save_path = ENV.fetch("CAPYBARA_ARTIFACTS", "./tmp/capybara")
+
+Capybara.singleton_class.prepend(Module.new do
+  attr_accessor :last_used_session
+
+  def using_session(name, &block)
+    self.last_used_session = name
+    super
+  ensure
+    self.last_used_session = nil
+  end
+end)