panda-core 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2c7f949ef7ad87f9b6aa0ec54ccd8c1dc1574ee09f9ef3651af635930ae65e4
-  data.tar.gz: 80e06efeb33c7092e93e1b2a06997e23c0951578f08524bdd6ef6483f7b07766
+  metadata.gz: 28b16d6a5d79cf880c87149553332200a4b0c685fd1c9e654ec969475c85b1a7
+  data.tar.gz: 67a0a3ae10b209c96219e3974f8917007443cfbd1734db1943c255c99554d674
 SHA512:
-  metadata.gz: 482bf161016f2fc352083a22c9f85e5da7d01f72ca9be8c8755cfb0939f0bb7e48abd12b5e324e542047c164a193586ca9d083f80aaeec9d7e3179cccbae7397
-  data.tar.gz: c74f6e9909a28464f636c0edd0fbb7a2086484bd2d1d3e58adffb9e85c93552d630109d8c944ac886f6d9c92825e5e447914506bf0ce2062a7e890f5afe58e91
+  metadata.gz: 501c2f8db9b9a09c55d1c2c990672683a11e1fe63ff99067b2844edab3c7c31a10ef50c7f76658e0ce9862acfd0cdc5d979227f6b56ab18c797634b2a0343776
+  data.tar.gz: ce9f83f3d6619f6bf6b58d29c4b589a6bb3727120e0695391edbe8c22007c50aeb96c1a508b1c9798386db6a9c567f31644943a48dc7978700fb0a7377e0d7fb

data/lib/panda/core/testing/rails_helper.rb

@@ -61,6 +61,8 @@ RSpec.configure do |config|
   if ENV["GITHUB_ACTIONS"] == "true"
     require "rspec/github"
     config.add_formatter RSpec::Github::Formatter
+    # Also add documentation formatter for colored real-time output in CI logs
+    config.add_formatter RSpec::Core::Formatters::DocumentationFormatter, $stdout
   end
 
   # Controller testing support (if rails-controller-testing is available)

data/lib/panda/core/testing/support/system/better_system_tests.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# Extends Rails system tests with improved screenshot and driver handling
+#
+# This module provides enhancements to Rails system tests:
+# - Multi-session screenshot support
+# - CI-specific error handling and logging
+# - Enhanced failure screenshots with HTML debugging
+# - Network idle waiting before screenshots
+#
+# @example Using in RSpec
+#   RSpec.configure do |config|
+#     config.include Panda::Core::Testing::BetterSystemTests, type: :system
+#   end
+module Panda
+  module Core
+    module Testing
+      module BetterSystemTests
+        # Make failure screenshots compatible with multi-session setup.
+        # That's where we use Capybara.last_used_session introduced before.
+        def take_screenshot
+          return super unless Capybara.last_used_session
+
+          Capybara.using_session(Capybara.last_used_session) { super }
+        end
+
+        module ClassMethods
+          # Configure better system tests for RSpec
+          # This sets up the necessary hooks and configuration
+          def configure_better_system_tests!
+            # Make urls in mailers contain the correct server host.
+            # This is required for testing links in emails (e.g., via capybara-email).
+            around(:each, type: :system) do |ex|
+              was_host = Rails.application.default_url_options[:host]
+              Rails.application.default_url_options[:host] = Capybara.server_host
+              ex.run
+              Rails.application.default_url_options[:host] = was_host
+            end
+
+            # Make sure this hook runs before others
+            # Means you don't have to set js: true in every system spec
+            prepend_before(:each, type: :system) do
+              driven_by :cuprite
+            end
+
+            # Enable automatic screenshots on failure
+            # Add CI-specific timeout and retry logic for form interactions
+            around(:each, type: :system) do |example|
+              if ENV["GITHUB_ACTIONS"] == "true"
+                # In CI, wrap the test execution with additional error handling
+                begin
+                  example.run
+                rescue => e
+                  # Log any error for debugging
+                  puts "[CI] Test error detected: #{e.class} - #{e.message}"
+                  puts "[CI] Current URL: #{begin
+                    page.current_url
+                  rescue
+                    ""
+                  end}"
+
+                  # Re-raise the original error
+                  raise e
+                end
+              else
+                example.run
+              end
+            end
+
+            after(:each, type: :system) do |example|
+              next unless example.exception
+
+              begin
+                # Wait for any pending JavaScript to complete
+                # Cuprite has direct network idle support
+                begin
+                  page.driver.wait_for_network_idle
+                rescue
+                  nil
+                end
+
+                # Wait for DOM to be ready
+                sleep 0.5
+
+                # Get comprehensive page info
+                page_html = begin
+                  page.html
+                rescue
+                  ""
+                end
+                current_url = begin
+                  page.current_url
+                rescue
+                  ""
+                end
+                current_path = begin
+                  page.current_path
+                rescue
+                  ""
+                end
+                page_title = begin
+                  page.title
+                rescue
+                  ""
+                end
+
+                # Check for redirect or blank page indicators
+                if page_html.length < 100
+                  puts "Warning: Page content appears minimal (#{page_html.length} chars) when taking screenshot"
+                end
+
+                # Use Capybara's save_screenshot method
+                screenshot_path = Capybara.save_screenshot
+                if screenshot_path
+                  puts "Screenshot saved to: #{screenshot_path}"
+                  puts "Page title: #{page_title}" if page_title.present?
+                  puts "Current URL: #{current_url}" if current_url.present?
+                  puts "Current path: #{current_path}" if current_path.present?
+                  puts "Page content length: #{page_html.length} characters"
+
+                  # Save page HTML for debugging in CI
+                  if ENV["GITHUB_ACTIONS"] && page_html.present?
+                    html_debug_path = screenshot_path.gsub(".png", ".html")
+                    File.write(html_debug_path, page_html)
+                    puts "Page HTML saved to: #{html_debug_path}"
+                  end
+                end
+              rescue => e
+                puts "Failed to capture screenshot: #{e.message}"
+                puts "Exception class: #{example.exception.class}"
+                puts "Exception message: #{example.exception.message}"
+              end
+            end
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/panda/core/testing/support/system/cuprite_helpers.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+# Helper methods for Cuprite-based system tests
+#
+# This module provides utility methods for working with Cuprite in system tests:
+# - Page state verification helpers
+# - Network and DOM waiting utilities
+# - Safe form interaction methods with automatic retry in CI
+# - Debugging helpers for headful testing
+#
+# @example Using in a system test
+#   RSpec.configure do |config|
+#     config.include Panda::Core::Testing::CupriteHelpers, type: :system
+#   end
+module Panda
+  module Core
+    module Testing
+      module CupriteHelpers
+        # Ensure page is loaded and stable before interacting
+        def ensure_page_loaded
+          # Check if we're on about:blank and need to reload
+          current_url = begin
+            page.current_url
+          rescue
+            "unknown"
+          end
+          if current_url.include?("about:blank")
+            puts "[CI] Page is on about:blank, skipping recovery to avoid loops" if ENV["GITHUB_ACTIONS"]
+            # Don't try to recover - let the test handle it
+            return false
+          end
+
+          # Wait for page to be ready
+          wait_for_ready_state
+          # Wait for JavaScript to load
+          wait_for_javascript
+          true
+        end
+
+        # Wait for document ready state
+        def wait_for_ready_state
+          Timeout.timeout(5) do
+            loop do
+              ready = page.evaluate_script("document.readyState")
+              break if ready == "complete"
+
+              sleep 0.1
+            end
+          end
+        rescue Timeout::Error
+          puts "[CI] Timeout waiting for document ready state" if ENV["GITHUB_ACTIONS"]
+        end
+
+        # Wait for JavaScript to load (application-specific flag)
+        # Override in your application if you have a custom loaded flag
+        def wait_for_javascript(timeout: 5)
+          Timeout.timeout(timeout) do
+            loop do
+              loaded = begin
+                # Check for common JavaScript loaded indicators
+                page.evaluate_script("document.readyState === 'complete'")
+              rescue
+                false
+              end
+              break if loaded
+
+              sleep 0.1
+            end
+          end
+          true
+        rescue Timeout::Error
+          puts "[CI] Timeout waiting for JavaScript to load" if ENV["GITHUB_ACTIONS"]
+          false
+        end
+
+        # Waits for a specific selector to be present and visible on the page
+        # @param selector [String] CSS selector to wait for
+        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
+        # @return [Boolean] true if element is found, false if timeout occurs
+        def wait_for_selector(selector, timeout: 5)
+          start_time = Time.now
+          while Time.now - start_time < timeout
+            return true if page.has_css?(selector, visible: true)
+
+            sleep 0.1
+          end
+          false
+        end
+
+        # Waits for a specific text to be present on the page
+        # @param text [String] Text to wait for
+        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
+        # @return [Boolean] true if text is found, false if timeout occurs
+        def wait_for_text(text, timeout: 5)
+          start_time = Time.now
+          while Time.now - start_time < timeout
+            return true if page.has_text?(text)
+
+            sleep 0.1
+          end
+          false
+        end
+
+        # Waits for network requests to complete
+        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
+        # @return [Boolean] true if network is idle, false if timeout occurs
+        def wait_for_network_idle(timeout: 5)
+          # Cuprite has direct network idle support
+          page.driver.wait_for_network_idle(timeout: timeout)
+          true
+        rescue => e
+          puts "[CI] Network idle timeout: #{e.message}" if ENV["GITHUB_ACTIONS"]
+          false
+        end
+
+        # Waits for JavaScript to modify the DOM
+        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
+        # @return [Boolean] true if mutation occurred, false if timeout occurs
+        def wait_for_dom_mutation(timeout: 5)
+          start_time = Time.now
+          initial_dom = page.html
+          while Time.now - start_time < timeout
+            return true if page.html != initial_dom
+
+            sleep 0.1
+          end
+          false
+        end
+
+        # Drop #pause anywhere in a test to stop the execution.
+        # Useful when you want to checkout the contents of a web page in the middle of a test
+        # running in a headful mode.
+        def pause
+          # Cuprite-specific pause method
+          page.driver.pause
+        end
+
+        # Drop #browser_debug anywhere in a test to open a Chrome inspector and pause the execution
+        # Usage: browser_debug(binding)
+        def browser_debug(*)
+          # Cuprite-specific debug method
+          page.driver.debug
+        end
+
+        # Allows sending a list of CSS selectors to be clicked on in the correct order (no delay)
+        # Useful where you need to trigger e.g. a blur event on an input field
+        def click_on_selectors(*css_selectors)
+          css_selectors.each do |selector|
+            find(selector).click
+            sleep 0.1 # Add a small delay to allow JavaScript to run
+          end
+        end
+
+        # Wait for a field to have a specific value
+        # @param field_name [String] The field name or label
+        # @param value [String] The expected value
+        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
+        def wait_for_field_value(field_name, value, timeout: 5)
+          start_time = Time.now
+          while Time.now - start_time < timeout
+            return true if page.has_field?(field_name, with: value)
+
+            sleep 0.1
+          end
+          false
+        end
+
+        # Safe methods that handle Ferrum NodeNotFoundError in CI
+        def safe_fill_in(locator, with:)
+          retries = 0
+          start_time = Time.now
+          max_duration = 5 # Maximum 5 seconds total
+
+          begin
+            fill_in locator, with: with
+          rescue Ferrum::NodeNotFoundError, Capybara::ElementNotFound => e
+            retries += 1
+            elapsed = Time.now - start_time
+
+            if retries <= 2 && elapsed < max_duration && ENV["GITHUB_ACTIONS"]
+              puts "[CI] Element not found on fill_in '#{locator}', retry #{retries}/2 (#{elapsed.round(1)}s elapsed)"
+              sleep 0.5
+              retry
+            else
+              puts "[CI] Giving up on fill_in '#{locator}' after #{retries} retries and #{elapsed.round(1)}s" if ENV["GITHUB_ACTIONS"]
+              raise e
+            end
+          end
+        end
+
+        def safe_select(value, from:)
+          retries = 0
+          start_time = Time.now
+          max_duration = 5 # Maximum 5 seconds total
+
+          begin
+            select value, from: from
+          rescue Ferrum::NodeNotFoundError, Capybara::ElementNotFound => e
+            retries += 1
+            elapsed = Time.now - start_time
+
+            if retries <= 2 && elapsed < max_duration && ENV["GITHUB_ACTIONS"]
+              puts "[CI] Element not found on select '#{value}' from '#{from}', retry #{retries}/2 (#{elapsed.round(1)}s elapsed)"
+              sleep 0.5
+              retry
+            else
+              puts "[CI] Giving up on select '#{value}' from '#{from}' after #{retries} retries and #{elapsed.round(1)}s" if ENV["GITHUB_ACTIONS"]
+              raise e
+            end
+          end
+        end
+
+        def safe_click_button(locator)
+          retries = 0
+          start_time = Time.now
+          max_duration = 5 # Maximum 5 seconds total
+
+          begin
+            click_button locator
+          rescue Ferrum::NodeNotFoundError, Capybara::ElementNotFound => e
+            retries += 1
+            elapsed = Time.now - start_time
+
+            if retries <= 2 && elapsed < max_duration && ENV["GITHUB_ACTIONS"]
+              puts "[CI] Element not found on click_button '#{locator}', retry #{retries}/2 (#{elapsed.round(1)}s elapsed)"
+              sleep 0.5
+              retry
+            else
+              puts "[CI] Giving up on click_button '#{locator}' after #{retries} retries and #{elapsed.round(1)}s" if ENV["GITHUB_ACTIONS"]
+              raise e
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/panda/core/testing/support/system/cuprite_setup.rb

@@ -24,10 +24,10 @@ module Panda
             inspector: ENV["INSPECTOR"].in?(%w[y 1 yes true]),
             headless: !ENV["HEADLESS"].in?(%w[n 0 no false]),
             slowmo: ENV["SLOWMO"]&.to_f || 0,
-            timeout: 10,
+            timeout: ENV["CUPRITE_TIMEOUT"]&.to_i || 2,
             js_errors: true,  # IMPORTANT: Report JavaScript errors as test failures
             ignore_default_browser_options: false,
-            process_timeout: 2,
+            process_timeout: ENV["CUPRITE_PROCESS_TIMEOUT"]&.to_i || 2,
             wait_for_network_idle: false,  # Don't wait for all network requests
             pending_connection_errors: false,  # Don't fail on pending external connections
             browser_options: {

data/lib/panda/core/testing/support/system/system_test_helpers.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "cuprite_helpers"
+require_relative "better_system_tests"
+
 # Generic system test helpers for Cuprite-based testing
 # These methods work for any Rails application using Cuprite
 
@@ -7,134 +10,8 @@ module Panda
   module Core
     module Testing
       module SystemTestHelpers
-        # 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
-
-        # Ensure page is loaded and stable before interacting
-        def ensure_page_loaded
-          # Check if we're on about:blank
-          current_url = begin
-            page.current_url
-          rescue
-            "unknown"
-          end
-
-          if current_url.include?("about:blank")
-            puts "[CI] Page is on about:blank, skipping recovery to avoid loops" if ENV["GITHUB_ACTIONS"]
-            return false
-          end
-
-          # Wait for page to be ready
-          wait_for_ready_state
-          true
-        end
-
-        # Wait for document ready state
-        def wait_for_ready_state
-          Timeout.timeout(5) do
-            loop do
-              ready = page.evaluate_script("document.readyState")
-              break if ready == "complete"
-
-              sleep 0.1
-            end
-          end
-        rescue Timeout::Error
-          puts "[CI] Timeout waiting for document ready state" if ENV["GITHUB_ACTIONS"]
-        end
-
-        # Waits for a specific selector to be present and visible
-        # @param selector [String] CSS selector to wait for
-        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
-        # @return [Boolean] true if element is found, false if timeout occurs
-        def wait_for_selector(selector, timeout: 5)
-          start_time = Time.now
-          while Time.now - start_time < timeout
-            return true if page.has_css?(selector, visible: true)
-
-            sleep 0.1
-          end
-          false
-        end
-
-        # Waits for a specific text to be present on the page
-        # @param text [String] Text to wait for
-        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
-        # @return [Boolean] true if text is found, false if timeout occurs
-        def wait_for_text(text, timeout: 5)
-          start_time = Time.now
-          while Time.now - start_time < timeout
-            return true if page.has_text?(text)
-
-            sleep 0.1
-          end
-          false
-        end
-
-        # Waits for network requests to complete
-        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
-        # @return [Boolean] true if network is idle, false if timeout occurs
-        def wait_for_network_idle(timeout: 5)
-          page.driver.wait_for_network_idle(timeout: timeout)
-          true
-        rescue => e
-          puts "[CI] Network idle timeout: #{e.message}" if ENV["GITHUB_ACTIONS"]
-          false
-        end
-
-        # Waits for JavaScript to modify the DOM
-        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
-        # @return [Boolean] true if mutation occurred, false if timeout occurs
-        def wait_for_dom_mutation(timeout: 5)
-          start_time = Time.now
-          initial_dom = page.html
-          while Time.now - start_time < timeout
-            return true if page.html != initial_dom
-
-            sleep 0.1
-          end
-          false
-        end
-
-        # Drop #pause anywhere in a test to stop the execution
-        # Useful when you want to check out the contents of a web page in the middle of a test
-        # running in a headful mode
-        def pause
-          page.driver.pause
-        end
-
-        # Drop #browser_debug anywhere in a test to open a Chrome inspector and pause the execution
-        # Usage: browser_debug(binding)
-        def browser_debug(*)
-          page.driver.debug
-        end
-
-        # Allows sending a list of CSS selectors to be clicked on in the correct order (no delay)
-        # Useful where you need to trigger e.g. a blur event on an input field
-        def click_on_selectors(*css_selectors)
-          css_selectors.each do |selector|
-            find(selector).click
-            sleep 0.1 # Add a small delay to allow JavaScript to run
-          end
-        end
-
-        # Wait for a field to have a specific value
-        # @param field_name [String] The field name or label
-        # @param value [String] The expected value
-        # @param timeout [Integer] Maximum time to wait in seconds (default: 5)
-        def wait_for_field_value(field_name, value, timeout: 5)
-          start_time = Time.now
-          while Time.now - start_time < timeout
-            return true if page.has_field?(field_name, with: value)
-
-            sleep 0.1
-          end
-          false
-        end
+        include CupriteHelpers
+        include BetterSystemTests
       end
     end
   end
@@ -144,8 +21,7 @@ end
 RSpec.configure do |config|
   config.include Panda::Core::Testing::SystemTestHelpers, type: :system
 
-  # Make URLs in mailers contain the correct server host
-  # This is required for testing links in emails (e.g., via capybara-email)
+  # Make urls in mailers contain the correct server host
   config.around(:each, type: :system) do |ex|
     was_host = Rails.application.default_url_options[:host]
     Rails.application.default_url_options[:host] = Capybara.server_host
@@ -154,7 +30,6 @@ RSpec.configure do |config|
   end
 
   # Make sure this hook runs before others
-  # Means you don't have to set js: true in every system spec
   config.prepend_before(:each, type: :system) do
     driven_by :cuprite
   end
@@ -169,7 +44,7 @@ RSpec.configure do |config|
         puts "[CI] Current URL: #{begin
           page.current_url
         rescue
-          "unknown"
+          ""
         end}"
         raise e
       end
@@ -190,22 +65,31 @@ RSpec.configure do |config|
         nil
       end
 
-      sleep 0.5 # Wait for DOM to be ready
+      sleep 0.5
 
       # Get comprehensive page info
       page_html = begin
         page.html
       rescue
-        "<html><body>Error loading page</body></html>"
+        ""
+      end
+      current_url = begin
+        page.current_url
+      rescue
+        ""
+      end
+      current_path = begin
+        page.current_path
+      rescue
+        ""
       end
-
       page_title = begin
         page.title
       rescue
-        "N/A"
+        ""
       end
 
-      # Warn about minimal page content
+      # Check for redirect or blank page indicators
       if page_html.length < 100
         puts "Warning: Page content appears minimal (#{page_html.length} chars) when taking screenshot"
       end
@@ -214,11 +98,13 @@ RSpec.configure do |config|
       screenshot_path = Capybara.save_screenshot
       if screenshot_path
         puts "Screenshot saved to: #{screenshot_path}"
-        puts "Page title: #{page_title}"
+        puts "Page title: #{page_title}" if page_title.present?
+        puts "Current URL: #{current_url}" if current_url.present?
+        puts "Current path: #{current_path}" if current_path.present?
         puts "Page content length: #{page_html.length} characters"
 
         # Save page HTML for debugging in CI
-        if ENV["GITHUB_ACTIONS"]
+        if ENV["GITHUB_ACTIONS"] && page_html.present?
           html_debug_path = screenshot_path.gsub(".png", ".html")
           File.write(html_debug_path, page_html)
           puts "Page HTML saved to: #{html_debug_path}"

data/lib/panda/core/version.rb

@@ -2,6 +2,6 @@
 
 module Panda
   module Core
-    VERSION = "0.8.3"
+    VERSION = "0.8.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda-core
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Otaina Limited
@@ -505,7 +505,9 @@ files:
 - lib/panda/core/testing/support/omniauth_setup.rb
 - lib/panda/core/testing/support/service_stubs.rb
 - lib/panda/core/testing/support/setup.rb
+- lib/panda/core/testing/support/system/better_system_tests.rb
 - lib/panda/core/testing/support/system/capybara_setup.rb
+- lib/panda/core/testing/support/system/cuprite_helpers.rb
 - lib/panda/core/testing/support/system/cuprite_setup.rb
 - lib/panda/core/testing/support/system/database_connection_helpers.rb
 - lib/panda/core/testing/support/system/system_test_helpers.rb