capybara-box 0.1.0

data/spec/lib/capybara_box/base/apply_arguments_spec.rb

@@ -0,0 +1,33 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.apply_arguments' do
+  subject { described_class.new parameters }
+
+  before do
+    allow(subject).to receive(:arguments) { ['--argument'] }
+  end
+
+  context 'when is not chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'applies' do
+      expect(subject.options.args).to eq []
+
+      subject.apply_arguments
+
+      expect(subject.options.args).to eq ['--argument']
+    end
+  end
+
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'applies' do
+      expect(subject.options.args).to eq []
+
+      subject.apply_arguments
+
+      expect(subject.options.args).to eq ['--argument', '--headless']
+    end
+  end
+end

data/spec/lib/capybara_box/base/apply_bin_path_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.apply_bin_path' do
+  subject { described_class.new parameters }
+
+  before :all do
+    File.open('/tmp/bin', 'w') { |file| file.write 'echo "capybara-box/bin"' }
+    FileUtils.chmod 0755, '/tmp/bin'
+  end
+
+  context 'when is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'does not apply' do
+      expect(subject.apply_bin_path('/tmp/bin')).to be_nil
+    end
+  end
+
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'does not apply' do
+      expect(subject.apply_bin_path('/tmp/bin')).to be_nil
+    end
+  end
+
+  context 'when is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'does not applies options' do
+      expect(subject.apply_bin_path('/tmp/bin')).to eq '/tmp/bin'
+    end
+  end
+end

data/spec/lib/capybara_box/base/apply_preferences_spec.rb

@@ -0,0 +1,43 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.apply_preferences' do
+  subject { described_class.new parameters }
+
+  before do
+    allow(subject).to receive(:preferences) { { key: :value } }
+  end
+
+  context 'when is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'applies' do
+      expect(subject.options.prefs).to eq({})
+
+      subject.apply_preferences
+
+      expect(subject.options.prefs).to eq(key: :value)
+    end
+  end
+
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'applies' do
+      expect(subject.options.prefs).to eq({})
+
+      subject.apply_preferences
+
+      expect(subject.options.prefs).to eq(key: :value)
+    end
+  end
+
+  context 'when is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'does not applies options' do
+      subject.apply_preferences
+
+      expect(subject.options).to be_nil
+    end
+  end
+end

data/spec/lib/capybara_box/base/apply_version_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.apply_version' do
+  subject { described_class.new parameters }
+
+  context 'when browser is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'is used' do
+      subject.apply_version '2.31'
+
+      expect(subject.version).to eq '2.31'
+    end
+  end
+
+  context 'when browser is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'is used' do
+      subject.apply_version '2.31'
+
+      expect(subject.version).to eq '2.31'
+    end
+  end
+
+  context 'when browser is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'does not applies options' do
+      subject.apply_preferences
+
+      expect(subject.options).to be_nil
+    end
+  end
+end

data/spec/lib/capybara_box/base/arguments_spec.rb

@@ -0,0 +1,72 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.arguments' do
+  subject { described_class.new parameters }
+
+  let!(:chrome_family_arguments) do
+    %w[
+      --disable-default-apps
+      --disable-extensions
+      --disable-infobars
+      --disable-notifications
+      --disable-password-generation
+      --disable-password-manager-reauthentication
+      --disable-password-separated-signin-flow
+      --disable-popup-blocking
+      --disable-save-password-bubble
+      --disable-translate
+      --incognito
+      --mute-audio
+      --no-default-browser-check
+      --start-fullscreen
+    ]
+  end
+
+  context 'when is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'receives the right arguments' do
+      expect(subject.arguments).to eq chrome_family_arguments
+    end
+
+    context 'when arguments is given' do
+      let!(:parameters) { { arguments: ['--custom'], browser: :firefox } }
+
+      it 'is used' do
+        expect(subject.arguments).to eq ['--custom']
+      end
+    end
+  end
+
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'receives the right arguments' do
+      expect(subject.arguments).to eq chrome_family_arguments
+    end
+
+    context 'when arguments is given' do
+      let!(:parameters) { { arguments: ['--custom'], browser: :chrome_headless } }
+
+      it 'is used' do
+        expect(subject.arguments).to eq ['--custom']
+      end
+    end
+  end
+
+  context 'when is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'receives the right arguments' do
+      expect(subject.arguments).to eq []
+    end
+
+    context 'when arguments is given' do
+      let!(:parameters) { { arguments: ['--custom'], browser: :firefox } }
+
+      it 'is used' do
+        expect(subject.arguments).to eq ['--custom']
+      end
+    end
+  end
+end

data/spec/lib/capybara_box/base/browser_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.browser' do
+  context 'when :browser is chrome family' do
+    before do
+      allow(subject).to receive(:chrome_family?) { true }
+    end
+
+    it 'is considered chrome' do
+      expect(subject.browser).to eq :chrome
+    end
+  end
+
+  context 'when :browser is not chrome family' do
+    subject { described_class.new parameters }
+
+    let!(:parameters) { { browser: :original_name } }
+
+    before do
+      allow(subject).to receive(:chrome_family?) { false }
+    end
+
+    it 'returns the original name' do
+      expect(subject.browser).to eq :original_name
+    end
+  end
+end

data/spec/lib/capybara_box/base/chrome_family_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.chrome_family?' do
+  subject { described_class.new parameters }
+
+  context 'when :browser is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    specify { expect(subject).to be_chrome_family }
+  end
+
+  context 'when :browser is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    specify { expect(subject).to be_chrome_family }
+  end
+
+  context 'when :browser is not chrome nor chrome headless' do
+    let!(:parameters) { { browser: :firefox } }
+
+    specify { expect(subject).not_to be_chrome_family }
+  end
+end

data/spec/lib/capybara_box/base/chrome_headless_spec.rb

@@ -0,0 +1,17 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.chrome_headless?' do
+  subject { described_class.new parameters }
+
+  context 'when :browser is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    specify { expect(subject).to be_chrome_headless }
+  end
+
+  context 'when :browser is not chrome headless' do
+    let!(:parameters) { { browser: :not_chrome_headless } }
+
+    specify { expect(subject).not_to be_chrome_headless }
+  end
+end

data/spec/lib/capybara_box/base/chrome_spec.rb

@@ -0,0 +1,17 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.chrome?' do
+  subject { described_class.new parameters }
+
+  context 'when :browser is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    specify { expect(subject).to be_chrome }
+  end
+
+  context 'when :browser is not chrome' do
+    let!(:parameters) { { browser: :not_chrome } }
+
+    specify { expect(subject).not_to be_chrome }
+  end
+end

data/spec/lib/capybara_box/base/configure_screenshot_spec.rb

@@ -0,0 +1,83 @@
+require 'rails_helper'
+require 'capybara-screenshot'
+
+RSpec.describe CapybaraBox::Base, '.configure_screenshot' do
+  subject { described_class.new parameters }
+
+  context 'when enabled tag is false' do
+    let!(:parameters) { { screenshot: { enabled: false } } }
+
+    specify { expect(subject.configure_screenshot).to eq false }
+  end
+
+  context 'when enabled tag is "false"' do
+    let!(:parameters) { { screenshot: { enabled: 'false' } } }
+
+    specify { expect(subject.configure_screenshot).to eq false }
+  end
+
+  context 'when enabled' do
+    let!(:parameters) { { screenshot: {} } }
+
+    it 'does not appends timestamp' do
+      subject.configure_screenshot
+
+      expect(Capybara::Screenshot.append_timestamp).to eq false
+    end
+
+    it 'prunes as keep_last_run' do
+      subject.configure_screenshot
+
+      expect(Capybara::Screenshot.prune_strategy).to eq :keep_last_run
+    end
+
+    it 'does not add link to screenshot on example description' do
+      subject.configure_screenshot
+
+      expect(Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples).to eq false
+    end
+
+    it 'configures a file name format for rspec' do
+      subject.configure_screenshot
+
+      example_object = OpenStruct.new(full_description: 'name#of file')
+      block_object   = Capybara::Screenshot.filename_prefix_formatters[:rspec]
+
+      expect(block_object.call example_object).to eq 'name--of-file'
+    end
+
+    it 'register a driver for given browser' do
+      driver = double
+      path   = '/tmp'
+
+      subject.configure_screenshot
+
+      expect(driver).to receive_message_chain(:browser, :save_screenshot).with path
+
+      Capybara::Screenshot.registered_drivers[:chrome].call driver, path
+    end
+
+    context 'when s3 store is configured' do
+      before do
+        parameters[:screenshot][:s3] = {
+          access_key_id:     :access_key_id,
+          bucket:            :bucket,
+          secret_access_key: :secret_access_key
+        }
+      end
+
+      it 'configures the s3 metadata' do
+        subject.configure_screenshot
+
+        expect(Capybara::Screenshot.s3_configuration).to eq(
+          s3_client_credentials: {
+            access_key_id:     :access_key_id,
+            secret_access_key: :secret_access_key
+          },
+
+          bucket_name: :bucket
+        )
+      end
+    end
+  end
+end

data/spec/lib/capybara_box/base/configure_spec.rb

@@ -0,0 +1,33 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.configure' do
+  subject { described_class.new parameters }
+
+  let!(:parameters) { { browser: :driver } }
+
+  it 'configure the javascript driver' do
+    subject.configure
+
+    expect(Capybara.javascript_driver).to eq :driver
+  end
+
+  context 'when max wait time is not given' do
+    it 'does not writes and uses the default' do
+      default = Capybara.default_max_wait_time
+
+      subject.configure
+
+      expect(Capybara.default_max_wait_time).to eq default
+    end
+  end
+
+  context 'when max wait time is given' do
+    before { parameters[:max_wait_time] = 7 }
+
+    it 'is used' do
+      subject.configure
+
+      expect(Capybara.default_max_wait_time).to eq 7
+    end
+  end
+end

data/spec/lib/capybara_box/base/create_spec.rb

@@ -0,0 +1,77 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '#create' do
+  context 'with no parameters' do
+    it 'applies the arguments' do
+      expect(subject).to receive(:apply_arguments)
+
+      subject.create
+    end
+
+    it 'applies the preferences' do
+      expect(subject).to receive(:apply_preferences)
+
+      subject.create
+    end
+
+    it 'register chrome browser as default' do
+      expect(subject).to receive(:register).with :chrome
+
+      subject.create
+    end
+
+    it 'applies the capybara configurations' do
+      expect(subject).to receive :configure
+
+      subject.create
+    end
+  end
+
+  context 'when :bin_path is given' do
+    subject { described_class.new parameters }
+
+    let!(:parameters) { { bin_path: '/tmp/bin' } }
+
+    it 'applies the bin path' do
+      expect(subject).to receive(:apply_bin_path)
+
+      subject.create
+    end
+  end
+
+  context 'when :version is given' do
+    subject { described_class.new parameters }
+
+    let!(:parameters) { { version: '2.31' } }
+
+    it 'applies the version' do
+      expect(subject).to receive(:apply_version)
+
+      subject.create
+    end
+  end
+
+  context 'when :screenshot config is given' do
+    subject { described_class.new parameters }
+
+    let!(:parameters) { { screenshot: {} } }
+
+    it 'applies the screenshot' do
+      expect(subject).to receive(:configure_screenshot)
+
+      subject.create
+    end
+  end
+
+  context 'when :browser is given' do
+    subject { described_class.new parameters }
+
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'registers the given browser' do
+      expect(subject).to receive(:register).with :firefox
+
+      subject.create
+    end
+  end
+end