Switch to CircleCI

Author: route

.circleci/config.yml

@@ -1,15 +1,50 @@
 version: 2.1
+
 orbs:
   ruby: circleci/[email protected]
 
-jobs:
-  build:
+executors:
+  ruby:
     docker:
-      - image: circleci/ruby:2.7.1-stretch-node
-    executor: ruby/default
+      - image: circleci/ruby:buster-node-browsers
+
+commands:
+  create_artifact_folders:
     steps:
-      - checkout
       - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install
+          name: Create artifacts folders
+          command: mkdir -p /home/circleci/project/tmp/{screenshots,logs}
+  store_screenshots_and_logs:
+    steps:
+      - store_artifacts:
+          path: /home/circleci/project/tmp/screenshots
+          destination: screenshots
+      - store_artifacts:
+          path: /home/circleci/project/tmp/logs
+          destination: logs
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+      gemfile:
+        type: string
+    executor: ruby
+    steps:
+      - checkout
+      - create_artifact_folders
+      - ruby/install:
+          version: << parameters.ruby-version >>
+      - run: bundle install
+      - run: bundle exec rake
+      - store_screenshots_and_logs
+
+workflows:
+  build:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["2.5", "2.6", "2.7"]
+              gemfile: ["gemfiles/websocket-driver-0.6.x.gemfile", "gemfiles/websocket-driver-0.7.x.gemfile"]

README.md

@@ -1,6 +1,6 @@
 # Ferrum - high-level API to control Chrome in Ruby
 
-[![CircleCI](https://circleci.com/gh/rubycdp/ferrum.svg?style=svg)](https://circleci.com/gh/rubycdp/ferrum)
+[![CircleCI](https://circleci.com/gh/rubycdp/ferrum.svg?style=shield)](https://circleci.com/gh/rubycdp/ferrum)
 
 <img align="right"
      width="320" height="241"

spec/frame_spec.rb

@@ -283,6 +283,7 @@ module Ferrum
           browser.execute <<-JS
             document.body.innerHTML += "<iframe src='/ferrum/buttons' id='buttons_frame'>"
           JS
+          browser.network.wait_for_idle
 
           frame = browser.at_xpath("//iframe[@id='buttons_frame']").frame
           expect(frame.xpath("//button").size).to eq(3)
@@ -320,6 +321,7 @@ module Ferrum
           browser.execute <<-JS
             document.body.innerHTML += "<iframe src='/ferrum/buttons' id='buttons_frame'>"
           JS
+          browser.network.wait_for_idle
 
           frame = browser.at_xpath("//iframe[@id='buttons_frame']").frame
           expect(frame.at_xpath("//button[@id='click_me_123']")).not_to be_nil
@@ -357,6 +359,7 @@ module Ferrum
           browser.execute <<-JS
             document.body.innerHTML += "<iframe src='/ferrum/buttons' id='buttons_frame'>"
           JS
+          browser.network.wait_for_idle
 
           frame = browser.at_css("iframe#buttons_frame").frame
           expect(frame.css("button").size).to eq(3)
@@ -394,6 +397,7 @@ module Ferrum
           browser.execute <<-JS
             document.body.innerHTML += "<iframe src='/ferrum/buttons' id='buttons_frame'>"
           JS
+          browser.network.wait_for_idle
 
           frame = browser.at_css("iframe#buttons_frame").frame
           expect(frame.at_css("button#click_me_123")).not_to be_nil

spec/spec_helper.rb

@@ -8,32 +8,7 @@
 
 require "ferrum"
 require "support/server"
-
-RSpec.shared_context "Global helpers" do
-  def server
-    Ferrum::Server.server
-  end
-
-  def base_url(*args)
-    server.base_url(*args)
-  end
-
-  def browser
-    @browser
-  end
-
-  def with_external_browser(host: "127.0.0.1", port: 32001)
-    options = { host: host, port: port, window_size: [1400, 1400], headless: true }
-    process = Ferrum::Browser::Process.new(options)
-
-    begin
-      process.start
-      yield "http://#{host}:#{port}"
-    ensure
-      process.stop
-    end
-  end
-end
+require "support/global_helpers"
 
 RSpec.configure do |config|
   config.include_context "Global helpers"
@@ -54,8 +29,14 @@ def with_external_browser(host: "127.0.0.1", port: 32001)
 
   config.before(:all) do
     base_url = Ferrum::Server.server.base_url
-    @browser = Ferrum::Browser.new(base_url: base_url,
-                                   process_timeout: 5)
+    options = { base_url: base_url, process_timeout: 5 }
+
+    if ENV['CI']
+      FERRUM_LOGGER = StringIO.new
+      options.merge!(logger: FERRUM_LOGGER)
+    end
+
+    @browser = Ferrum::Browser.new(**options)
   end
 
   config.after(:all) do
@@ -64,9 +45,33 @@ def with_external_browser(host: "127.0.0.1", port: 32001)
 
   config.before(:each) do
     server&.wait_for_pending_requests
+
+    if ENV['CI']
+      FERRUM_LOGGER.truncate(0)
+      FERRUM_LOGGER.rewind
+    end
   end
 
-  config.after(:each) do
+  config.after(:each) do |example|
+    if ENV['CI'] && example.exception
+      save_exception_aftifacts(browser, example.metadata)
+    end
+
     @browser.reset
   end
+
+  def save_exception_aftifacts(browser, meta)
+    time_now = Time.now
+    filename = File.basename(meta[:file_path])
+    line_number = meta[:line_number]
+    timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec/1000).to_i}"
+
+    screenshot_name = "screenshot-#{filename}-#{line_number}-#{timestamp}.png"
+    screenshot_path = "#{ENV["CIRCLE_ARTIFACTS"]}/screenshots/#{screenshot_name}"
+    browser.screenshot(path: screenshot_path, full: true)
+
+    log_name = "ferrum-#{filename}-#{line_number}-#{timestamp}.txt"
+    log_path = "#{ENV["CIRCLE_ARTIFACTS"]}/logs/#{log_name}"
+    File.open(log_path, 'wb') { |file| file.write(FERRUM_LOGGER.string) }
+  end
 end

spec/support/global_helpers.rb

@@ -0,0 +1,25 @@
+RSpec.shared_context "Global helpers" do
+  def server
+    Ferrum::Server.server
+  end
+
+  def base_url(*args)
+    server.base_url(*args)
+  end
+
+  def browser
+    @browser
+  end
+
+  def with_external_browser(host: "127.0.0.1", port: 32001)
+    options = { host: host, port: port, window_size: [1400, 1400], headless: true }
+    process = Ferrum::Browser::Process.new(options)
+
+    begin
+      process.start
+      yield "http://#{host}:#{port}"
+    ensure
+      process.stop
+    end
+  end
+end