Contents

# frozen_string_literal: true

require "action_dispatch/system_testing/test_helpers/screenshot_helper"

module ActionDispatch
  module SystemTesting
    module TestHelpers
      module ScreenshotHelper
        private

        # Customize the screenshot helper to fix the file paths for examples that have
        # unallowed characters in them. Otherwise the artefacts creation and upload
        # fails at GitHub actions. See the list of unallowed characters from:
        # https://github.com/actions/toolkit/blob/main/packages/artifact/docs/additional-information.md#non-supported-characters
        def image_name
          # By default, this only cleans up the forward and backward slash characters.
          sanitized_method_name = method_name.tr("/\\()\":<>|*?", "-----------")
          name = "#{unique}_#{sanitized_method_name}"
          name[0...225]
        end

        # Add the file URI scheme so terminal emulators can open one click
        def display_image
          message = +"[Screenshot Image]: file://#{image_path}\n"
          message << +"[Screenshot HTML]: file://#{html_path}\n" if save_html?

          case output_type
          when "artifact"
            message << "\e]1338;url=artifact://#{absolute_image_path}\a\n"
          when "inline"
            name = inline_base64(File.basename(absolute_image_path))
            image = inline_base64(File.read(absolute_image_path))
            message << "\e]1337;File=name=#{name};height=400px;inline=1:#{image}\a\n"
          end

          message
        end
      end
    end
  end
end

Version data entries

25 entries across 25 versions & 1 rubygems

Version	Path
decidim-dev-0.29.1	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.4	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.9	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.29.0	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.3	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.8	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.29.0.rc4	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.29.0.rc3	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.29.0.rc2	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.29.0.rc1	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.2	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.7	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.1	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.6	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.0	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.5	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.0.rc5	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.28.0.rc4	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.4	lib/decidim/dev/test/rspec_support/screenshot_helper.rb
decidim-dev-0.27.3	lib/decidim/dev/test/rspec_support/screenshot_helper.rb