aboutsummaryrefslogtreecommitdiffstats
path: root/actionsystemtest/lib/action_system_test/test_helpers/screenshot_helper.rb
blob: af83ca3ec87e9e8eadd46150737deb3ff8a3905b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
module ActionSystemTest
  module TestHelpers
    # Screenshot helper for system testing
    module ScreenshotHelper
      # Takes a screenshot of the current page in the browser.
      #
      # +take_screenshot+ can be used at any point in your system tests to take
      # a screenshot of the current state. This can be useful for debugging or
      # automating visual testing.
      def take_screenshot
        save_image
        puts "[Screenshot]: #{image_path}"
        puts display_image
      end

      # Takes a screenshot of the current page in the browser if the test
      # failed.
      #
      # +take_screenshot+ is included in <tt>system_test_helper.rb</tt> that is
      # generated with the application. To take screenshots when a test fails
      # add +take_failed_screenshot+ to the teardown block before clearing
      # sessions.
      def take_failed_screenshot
        take_screenshot unless passed?
      end

      private
        def image_path
          "tmp/screenshots/failures_#{method_name}.png"
        end

        def save_image
          page.save_screenshot(Rails.root.join(image_path))
        end

        def display_image
          if ENV["CAPYBARA_INLINE_SCREENSHOT"] == "artifact"
            "\e]1338;url=artifact://#{image_path}\a"
          else
            name = inline_base64(File.basename(image_path))
            image = inline_base64(File.read(image_path))
            "\e]1337;File=name=#{name};height=400px;inline=1:#{image}\a"
          end
        end

        def inline_base64(path)
          Base64.encode64(path).gsub("\n", "")
        end
    end
  end
end