simulacrum 0.1.1 → 0.3.0

data/examples/basic/script/start

@@ -0,0 +1,4 @@
+#!/bin/sh -xe
+
+bundle --quiet
+rackup --port 8000

data/examples/basic/spec/simulacrum_helper.rb

@@ -0,0 +1,9 @@
+require 'capybara'
+require 'simulacrum'
+require './example_app'
+
+Capybara.app = ExampleApp
+
+Simulacrum.configure do |simulacrum|
+  simulacrum.component.delta_threshold = 1.0 # 1.0% change allowed
+end

data/examples/basic/spec/ui/button_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'simulacrum_helper'
+
+describe 'My Button' do
+  component :my_button do |options|
+    options.url = '/button.html'
+  end
+
+  it { is_expected.to look_the_same }
+end

data/exe/simulacrum

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'simulacrum/cli'
+Simulacrum::CLI.execute!(ARGV.dup)

data/features/command_line/help.feature

@@ -0,0 +1,8 @@
+Feature: `--help` option
+
+  The `--help` option should display usage information for simulacrum
+
+  Scenario: Using `--help`
+    When I run `simulacrum --help`
+    Then the output should contain "Usage: simulacrum [options] [files or directories]"
+    And the exit status should be 0

data/features/exit_codes/failing.feature

@@ -0,0 +1,24 @@
+Feature: Failure exit code
+
+  The exit code should always be non-zero (1) when there are failing tests
+
+  Background:
+    Given a fixture application
+    And a file named "spec/ui/ui_component_spec.rb" with:
+      """ruby
+      require 'simulacrum_helper'
+
+      describe 'UI Component' do
+        component :ui_component do |options|
+          options.url = '/ui_component.html'
+        end
+        it { should look_the_same }
+      end
+      """
+
+  Scenario: There are failing tests
+    Given a reference image for "ui_component" with content: "diff.png"
+    When I run `simulacrum`
+    Then the exit status should be 1
+    And the output should contain "Failure/Error: it { should look_the_same }"
+    And the output should contain "1 example, 1 failure"

data/features/exit_codes/passing.feature

@@ -0,0 +1,24 @@
+Feature: Passing exit code
+
+  The exit code should always be zero when the tests pass
+
+  Background:
+    Given a fixture application
+    And a file named "spec/ui/ui_component_spec.rb" with:
+      """ruby
+      require 'simulacrum_helper'
+
+      describe 'UI Component' do
+        component :ui_component do |options|
+          options.url = '/ui_component.html'
+        end
+        it { should look_the_same }
+      end
+      """
+
+  Scenario: Passing tests
+    Given a reference image for "ui_component" with content: "a1.png"
+    When I run `simulacrum`
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures"
+    And the output should not contain "pending"

data/features/exit_codes/pending.feature

@@ -0,0 +1,22 @@
+Feature: Pending exit code
+
+  The exit code should always be zero when there were pending tests
+
+  Background:
+    Given a fixture application
+    And a file named "spec/ui/ui_component_spec.rb" with:
+      """ruby
+      require 'simulacrum_helper'
+
+      describe 'UI Component' do
+        component :ui_component do |options|
+          options.url = '/ui_component.html'
+        end
+        it { should look_the_same }
+      end
+      """
+
+  Scenario: There is a pending test
+    When I run `simulacrum`
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures, 1 pending"

data/features/output/candidate.feature

@@ -0,0 +1,32 @@
+Feature: candidate image output
+
+  A candidate image should be produced when there is no reference image present
+  or if the diff threshold is met.
+
+  Background:
+    Given a fixture application
+    And a file named "spec/ui/ui_component_spec.rb" with:
+      """ruby
+      require 'simulacrum_helper'
+
+      describe 'UI Component' do
+        component :ui_component do |options|
+          options.url = '/ui_component.html'
+        end
+        it { should look_the_same }
+      end
+      """
+
+  Scenario: There is already a reference, and there is no diff so a candidate should not be created
+    Given a reference image for "ui_component" with content: "a1.png"
+    When I run `simulacrum`
+    Then a candidate for "ui_component" should not exist
+
+  Scenario: There is no reference present so a candidate should be created
+    When I run `simulacrum`
+    Then a candidate for "ui_component" should exist
+
+  Scenario: There is a diff when the test is run so a candidate should be created
+    Given a reference image for "ui_component" with content: "diff.png"
+    When I run `simulacrum`
+    Then a candidate for "ui_component" should exist

data/features/output/diff.feature

@@ -0,0 +1,5 @@
+Feature: diff image output
+
+  A diff image should be produced when the diff threshold is met.
+
+  Scenario: There is a diff when the test is run

data/features/step_definitions/dummy_steps.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'fileutils'
+
+Given(/^a fixture application$/) do
+  step %Q(a directory named "app")
+  target_path = File.join(ENV['PROJECT_ROOT_PATH'], 'fixtures', 'app')
+  FileUtils.cp_r(target_path, current_dir)
+  step %Q(I cd to "app")
+end
+
+When(/^I debug$/) do
+  # rubocop:disable Debugger
+  require 'pry'
+  binding.pry
+end

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+Given(/^a (reference|candidate) image for "([^"]*)" with content: "([^"]*)"$/) do |type, component_name, fixture_path|
+  fixture_path = File.join(ENV['PROJECT_ROOT_PATH'], 'fixtures', fixture_path)
+  destination_path = File.join('spec/ui/references/', component_name, 'test_driver', "#{type}.png")
+  rel_destination_path = File.join(current_dir, destination_path)
+  FileUtils.mkdir_p(File.dirname(rel_destination_path))
+  FileUtils.cp(fixture_path, rel_destination_path)
+  step %Q(a #{type} for "#{component_name}" should exist)
+end
+
+Then(/^a (reference|candidate) for "(.*?)" should not exist$/) do |type, component_name|
+  path = File.join('spec/ui/references/', component_name, 'test_driver', "#{type}.png")
+  step %Q(a file named "#{path}" should not exist)
+end
+
+Then(/^a (reference|candidate) for "(.*?)" should exist$/) do |type, component_name|
+  path = File.join('spec/ui/references/', component_name, 'test_driver', "#{type}.png")
+  step %Q(a file named "#{path}" should exist)
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'aruba'
+require 'aruba/cucumber'
+require 'fileutils'
+require 'dotenv'
+Dotenv.load
+
+ENV['PROJECT_ROOT_PATH'] = File.expand_path('../../../', __FILE__)
+
+Dir.glob('features/step_definitions/**/*steps.rb') { |f| load f, true }
+
+Before do
+  @aruba_timeout_seconds = (ENV['CI']) ? 240 : 120
+  @aruba_io_wait_seconds = (ENV['CI']) ? 240 : 120
+end

data/fixtures/app/fixture_app.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+require 'sinatra/base'
+
+# Fixture application
+class FixtureApp < Sinatra::Application
+  set :public_folder, File.dirname(__FILE__) + '/public'
+
+  if app_file == $PROGRAM_NAME
+    puts '[fixture app] Booting...' * 100
+    run!
+  end
+end

data/fixtures/app/public/ui_component.html

@@ -0,0 +1,10 @@
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Simulacrum Example — Index</title>
+    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no,user-scalable=0">
+  </head>
+  <body>
+    <img src="/images/a1.png" id="test-capture-selector">
+  </body>
+</html>

data/fixtures/app/spec/component_spec.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require 'simulacrum_helper'
+
+describe 'UI Component' do
+  component :ui_component do |options|
+    options.url = '/ui_component.html'
+  end
+  it { should look_the_same }
+end

data/fixtures/app/spec/simulacrum_helper.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+ENV['RAILS_ENV'] = 'test'
+ENV['RACK_ENV'] = 'test'
+
+require './fixture_app'
+require 'capybara'
+require 'sauce/capybara'
+require 'simulacrum'
+
+Capybara.app = FixtureApp
+Capybara.run_server = true
+Capybara.app_host = "http://0.0.0.0:#{Capybara.server_port}"
+Capybara.default_driver = :test_driver
+
+# Defines a custom driver so that we can assume a predictable output dir
+Capybara.register_driver :test_driver do |app|
+  if ENV['CI']
+    caps = Selenium::WebDriver::Remote::Capabilities.firefox
+    caps.platform = 'Linux'
+    caps.version = '31'
+    caps['name'] = 'Simulacrum'
+    if ENV['TRAVIS']
+      caps['build'] = "#{ENV['TRAVIS_JOB_NUMBER']} (#{ENV['TRAVIS_COMMIT']})"
+      caps['tunnel-identifier'] = ENV['TRAVIS_JOB_NUMBER']
+    end
+    caps['selenium-version'] = '2.41.0'
+    url = "http://#{ENV['SAUCE_USERNAME']}:#{ENV['SAUCE_ACCESS_KEY']}@ondemand.saucelabs.com:80/wd/hub"
+    Capybara::Selenium::Driver.new(app, browser: :remote, url: url, desired_capabilities: caps)
+  else
+    Capybara::Selenium::Driver.new(app, browser: :firefox)
+  end
+end
+
+Simulacrum.configure do |config|
+  config.component.capture_selector = '#test-capture-selector'
+  config.component.delta_threshold = 0.1  # allow for colour-space differences between platforms
+end

data/lib/simulacrum.rb

@@ -1,37 +1,96 @@
+# encoding: UTF-8
+require 'yaml'
 require 'ostruct'
 require 'capybara'
-require_relative './simulacrum/methods'
-require_relative './simulacrum/matchers'
-require_relative './simulacrum/configuration'
+require 'logger'
+require 'simulacrum/configuration'
+require 'simulacrum/runner'
 
 # Gem module
 module Simulacrum
-  @browsers = {}
+  CONFIG_FILE = './.simulacrum.yml'
+
   @components = {}
   @current_browser = nil
   @configuration = Simulacrum::Configuration.new
+  @logger = Logger.new($stdout)
+
+  def logger
+    @logger
+  end
+  module_function :logger
 
-  def self.components
+  def components
     @components
   end
+  module_function :components
 
-  def self.configuration
+  def configuration
     @configuration
   end
+  module_function :configuration
+
+  def runner_options
+    @runner_options
+  end
+  module_function :runner_options
 
-  def self.configure(&block)
-    options = OpenStruct.new(defaults: OpenStruct.new)
+  def root
+    File.expand_path('../..', __FILE__)
+  end
+  module_function :root
+
+  def run(options)
+    @runner_options = options
+    configure_logger
+    configure_runner.run
+  end
+  module_function :run
+
+  def configure(&block)
+    options = OpenStruct.new(component: OpenStruct.new)
     yield options
-    @configuration.configure(options.to_h)
+    configuration.configure(options.to_h)
   end
+  module_function :configure
 
-  def self.included(receiver, &block)
-    receiver.extend         Simulacrum::Methods
-    receiver.send :include, Simulacrum::Matchers
+  def config_file
+    YAML.load_file(Simulacrum.config_file_path)
+  end
+  module_function :config_file
 
-    if defined?(Rails)
-      receiver.send :include, Rails.application.routes.url_helpers
-      receiver.send :include, Rails.application.routes.mounted_helpers
+  def config_file?
+    File.exist?(Simulacrum.config_file_path)
+  end
+  module_function :config_file?
+
+  def config_file_path
+    if defined? Rails
+      Rails.root.join(CONFIG_FILE)
+    else
+      CONFIG_FILE
+    end
+  end
+  module_function :config_file_path
+
+  def self.configure_runner
+    case Simulacrum.runner_options.runner
+    when nil
+      Simulacrum::Runner.new
+    when :browserstack
+      use_browserstack_runner
     end
   end
+
+  def self.use_browserstack_runner
+    gem 'simulacrum-browserstack', '>= 0.0.1'
+    require 'simulacrum-browserstack'
+    Simulacrum::Browserstack::Runner.new
+  rescue Gem::LoadError
+    raise
+  end
+
+  def self.configure_logger
+    @logger.level = @runner_options.verbose ? Logger::DEBUG : Logger::INFO
+  end
 end

data/lib/simulacrum/cli.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+require 'simulacrum/cli/parser'
+
+module Simulacrum
+  # Command-line interface for driving Simulacrum
+  module CLI
+    def execute!(argv)
+      Command.new(argv).run_and_exit
+    end
+    module_function :execute!
+
+    # Class for wrappin up logic for running the process and handling exit
+    class Command
+      def initialize(argv, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = Kernel)
+        @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+      end
+
+      def run_and_exit
+        @exit_code = run
+        @kernel.exit(@exit_code)
+      end
+
+      private
+
+      def run
+        if parsed_argv == true
+          0
+        else
+          Simulacrum.run(parsed_argv)
+        end
+      end
+
+      def parsed_argv
+        @parsed_argv ||= CLI::Parser.parse(@argv)
+      end
+    end
+  end
+end