RubyGems - percy-capybara - Versions diffs - 0.3.0 → 0.4.0 - Mend

percy-capybara 0.3.0 → 0.4.0

Files changed (22) hide show

checksums.yaml +4 -4
data/lib/percy/capybara.rb +2 -2
data/lib/percy/capybara/client.rb +20 -0
data/lib/percy/capybara/client/builds.rb +22 -2
data/lib/percy/capybara/client/snapshots.rb +16 -238
data/lib/percy/capybara/loaders/base_loader.rb +71 -0
data/lib/percy/capybara/loaders/native_loader.rb +209 -0
data/lib/percy/capybara/loaders/sprockets_loader.rb +50 -0
data/lib/percy/capybara/rspec.rb +5 -0
data/lib/percy/capybara/version.rb +1 -1
data/percy-capybara.gemspec +2 -1
data/spec/lib/percy/capybara/client/builds_spec.rb +50 -1
data/spec/lib/percy/capybara/client/snapshots_spec.rb +31 -220
data/spec/lib/percy/capybara/client/testdata/index.html +1 -1
data/spec/lib/percy/capybara/client_spec.rb +13 -0
data/spec/lib/percy/capybara/loaders/base_loader_spec.rb +52 -0
data/spec/lib/percy/capybara/loaders/native_loader_spec.rb +224 -0
data/spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb +58 -0
data/spec/lib/percy/capybara_spec.rb +0 -1
data/spec/spec_helper.rb +26 -0
data/spec/support/test_helpers.rb +21 -0
metadata +30 -6

data/spec/lib/percy/capybara/client/testdata/index.html CHANGED Viewed

	@@ -1 +1 @@
1	- <html><body>Hello World!</body~~><head~~></~~head></~~html>
1	+ <html><head></head><body>Hello World!</body></html>

data/spec/lib/percy/capybara/client_spec.rb CHANGED Viewed

@@ -28,5 +28,18 @@ RSpec.describe Percy::Capybara::Client do
       expect(Percy::Capybara::Client.new.enabled?).to be_truthy
     end
   end
+  describe '#initialize_loader' do
+    let(:capybara_client) { Percy::Capybara::Client.new }
+    it 'returns a NativeLoader if no sprockets config' do
+      expect(capybara_client.initialize_loader.class).to eq(Percy::Capybara::Loaders::NativeLoader)
+    end
+    it 'returns a SprocketsLoader if sprockets is configured' do
+      capybara_client.sprockets_environment = double('sprockets_environment')
+      capybara_client.sprockets_options = double('sprockets_options')
+      loader = capybara_client.initialize_loader
+      expect(loader.class).to eq(Percy::Capybara::Loaders::SprocketsLoader)
+    end
+  end
 end

data/spec/lib/percy/capybara/loaders/base_loader_spec.rb ADDED Viewed

@@ -0,0 +1,52 @@
+RSpec.describe Percy::Capybara::Loaders::BaseLoader do
+  let(:loader) { described_class.new }
+  describe '#root_html_resource', type: :feature, js: true do
+    it 'includes the root DOM HTML' do
+      visit '/'
+      loader = described_class.new(page: page)
+      resource = loader.root_html_resource
+      expect(resource.is_root).to be_truthy
+      expect(resource.mimetype).to eq('text/html')
+      expect(resource.resource_url).to match('/')
+      expect(resource.content).to include('Hello World!')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+    end
+  end
+  describe '#build_resources' do
+    it 'raises a NotImplementedError' do
+      expect { loader.build_resources }.to raise_error(NotImplementedError)
+    end
+  end
+  describe '#snapshot_resources' do
+    it 'raises a NotImplementedError' do
+      expect { loader.snapshot_resources }.to raise_error(NotImplementedError)
+    end
+  end
+  describe '#current_path' do
+    it 'returns the current path of the page, stripping the domain if it exists' do
+      page_double = double('page')
+      expect(page_double).to receive(:current_url).and_return('/')
+      loader = described_class.new(page: page_double)
+      expect(loader.current_path).to eq('/')
+      expect(page_double).to receive(:current_url).and_return('/test')
+      loader = described_class.new(page: page_double)
+      expect(loader.current_path).to eq('/test')
+      expect(page_double).to receive(:current_url).and_return('/test/a')
+      loader = described_class.new(page: page_double)
+      expect(loader.current_path).to eq('/test/a')
+      # Rack::Test returns a full example.com URL, so we want to make sure it is stripped:
+      expect(page_double).to receive(:current_url).and_return('http://www.example.com/')
+      loader = described_class.new(page: page_double)
+      expect(loader.current_path).to eq('/')
+    end
+  end
+end

data/spec/lib/percy/capybara/loaders/native_loader_spec.rb ADDED Viewed

@@ -0,0 +1,224 @@
+RSpec.describe Percy::Capybara::Loaders::NativeLoader do
+  let(:loader) { described_class.new(page: nil) }
+  describe '#build_resources' do
+    it 'returns an empty list' do
+      expect(loader.build_resources).to eq([])
+    end
+  end
+  describe '#snapshot_resources', type: :feature, js: true do
+    it 'returns the root HTML' do
+      visit '/'
+      loader = described_class.new(page: page)
+      expect(loader.snapshot_resources.collect(&:resource_url)).to match_array(['/'])
+    end
+    it 'returns the root HTML and CSS resources' do
+      visit '/test-css.html'
+      loader = described_class.new(page: page)
+      resource_urls = loader.snapshot_resources.collect(&:resource_url).map do |url|
+        url.gsub(/localhost:\d+/, 'localhost')
+      end
+      expect(resource_urls).to match_array([
+        "/test-css.html",
+        "http://localhost/css/base.css",
+        "http://localhost/css/imports.css",
+        "http://localhost/css/level0-imports.css",
+        "http://localhost/css/level1-imports.css",
+        "http://localhost/css/level2-imports.css",
+        "http://localhost/css/simple-imports.css",
+      ])
+    end
+    it 'returns the root HTML and image resources' do
+      visit '/test-images.html'
+      loader = described_class.new(page: page)
+      resource_urls = loader.snapshot_resources.collect(&:resource_url).map do |url|
+        url.gsub(/localhost:\d+/, 'localhost')
+      end
+      expect(resource_urls).to match_array([
+        "/test-images.html",
+        "http://localhost/images/img-relative.png",
+        "http://localhost/images/img-relative-to-root.png",
+        "http://localhost/images/percy.svg",
+        "http://localhost/images/srcset-base.png",
+        "http://localhost/images/srcset-first.png",
+        "http://localhost/images/srcset-second.png",
+        "http://localhost/images/bg-relative.png",
+        "http://localhost/images/bg-relative-to-root.png",
+        "http://localhost/images/bg-stacked.png"
+      ])
+    end
+  end
+  describe '#_should_include_url?' do
+    it 'returns true for valid, local URLs' do
+      expect(loader._should_include_url?('http://localhost/')).to eq(true)
+      expect(loader._should_include_url?('http://localhost:123/')).to eq(true)
+      expect(loader._should_include_url?('http://localhost/foo')).to eq(true)
+      expect(loader._should_include_url?('http://localhost:123/foo')).to eq(true)
+      expect(loader._should_include_url?('http://localhost/foo/test.html')).to eq(true)
+      expect(loader._should_include_url?('http://127.0.0.1/')).to eq(true)
+      expect(loader._should_include_url?('http://127.0.0.1:123/')).to eq(true)
+      expect(loader._should_include_url?('http://127.0.0.1/foo')).to eq(true)
+      expect(loader._should_include_url?('http://127.0.0.1:123/foo')).to eq(true)
+      expect(loader._should_include_url?('http://127.0.0.1/foo/test.html')).to eq(true)
+      expect(loader._should_include_url?('http://0.0.0.0/foo/test.html')).to eq(true)
+      # Also works for paths:
+      expect(loader._should_include_url?('/')).to eq(true)
+      expect(loader._should_include_url?('/foo')).to eq(true)
+      expect(loader._should_include_url?('/foo/test.png')).to eq(true)
+    end
+    it 'returns false for invalid URLs' do
+      expect(loader._should_include_url?('')).to eq(false)
+      expect(loader._should_include_url?('http://local host/foo')).to eq(false)
+      expect(loader._should_include_url?('bad-url/')).to eq(false)
+      expect(loader._should_include_url?('bad-url/foo/test.html')).to eq(false)
+    end
+    it 'returns false for data URLs' do
+      expect(loader._should_include_url?('data:image/gif;base64,R0')).to eq(false)
+    end
+    it 'returns false for remote URLs' do
+      expect(loader._should_include_url?('http://foo/')).to eq(false)
+      expect(loader._should_include_url?('http://example.com/')).to eq(false)
+      expect(loader._should_include_url?('http://example.com/foo')).to eq(false)
+      expect(loader._should_include_url?('https://example.com/foo')).to eq(false)
+    end
+  end
+  describe '#_get_css_resources', type: :feature, js: true do
+    it 'includes all linked and imported stylesheets' do
+      visit '/test-css.html'
+      loader = described_class.new(page: page)
+      resources = loader.send(:_get_css_resources)
+      resource = find_resource(resources, '/css/base.css')
+      expect(resource.content).to include('.colored-by-base { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+      resource = find_resource(resources, '/css/simple-imports.css')
+      expect(resource.content).to include("@import url('imports.css');")
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+      resource = find_resource(resources, '/css/imports.css')
+      expect(resource.content).to include('.colored-by-imports { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+      resource = find_resource(resources, '/css/level0-imports.css')
+      expect(resource.content).to include("@import url('level1-imports.css')")
+      expect(resource.content).to include('.colored-by-level0-imports { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+      resource = find_resource(resources, '/css/level1-imports.css')
+      expect(resource.content).to include("@import url('level2-imports.css')")
+      expect(resource.content).to include('.colored-by-level1-imports { color: red; }')
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+      resource = find_resource(resources, '/css/level2-imports.css')
+      expect(resource.content).to include(".colored-by-level2-imports { color: red; }")
+      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
+      expect(resources.length).to eq(6)
+      expect(resources.collect(&:mimetype).uniq).to eq(['text/css'])
+      expect(resources.collect(&:is_root).uniq).to match_array([nil])
+    end
+  end
+  describe '#_get_image_resources', type: :feature, js: true do
+    it 'includes all images' do
+      visit '/test-images.html'
+      loader = described_class.new(page: page)
+      resources = loader.send(:_get_image_resources)
+      # The order of these is just for convenience, they match the order in test-images.html.
+      resource = find_resource(resources, '/images/img-relative.png')
+      path = File.expand_path('../../client/testdata/images/img-relative.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/img-relative-to-root.png')
+      path = File.expand_path('../../client/testdata/images/img-relative-to-root.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/percy.svg')
+      path = File.expand_path('../../client/testdata/images/percy.svg', __FILE__)
+      content = File.read(path)
+      # In Ruby 1.9.3 the SVG mimetype is not registered so our mini ruby webserver doesn't serve
+      # the correct content type. Allow either to work here so we can test older Rubies fully.
+      expect(resource.mimetype).to match(/image\/svg\+xml|application\/octet-stream/)
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/bg-relative.png')
+      path = File.expand_path('../../client/testdata/images/bg-relative.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/bg-relative-to-root.png')
+      path = File.expand_path('../../client/testdata/images/bg-relative-to-root.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/bg-stacked.png')
+      path = File.expand_path('../../client/testdata/images/bg-stacked.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/srcset-base.png')
+      path = File.expand_path('../../client/testdata/images/srcset-base.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/srcset-first.png')
+      path = File.expand_path('../../client/testdata/images/srcset-first.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource = find_resource(resources, '/images/srcset-second.png')
+      path = File.expand_path('../../client/testdata/images/srcset-second.png', __FILE__)
+      content = File.read(path)
+      expect(resource.mimetype).to eq('image/png')
+      expected_sha = Digest::SHA256.hexdigest(content)
+      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
+      expect(resource.sha).to eq(expected_sha)
+      resource_urls = resources.collect(&:resource_url).map do |url|
+        url.gsub(/localhost:\d+/, 'localhost')
+      end
+      expect(resource_urls).to match_array([
+        "http://localhost/images/img-relative.png",
+        "http://localhost/images/img-relative-to-root.png",
+        "http://localhost/images/percy.svg",
+        "http://localhost/images/srcset-base.png",
+        "http://localhost/images/srcset-first.png",
+        "http://localhost/images/srcset-second.png",
+        "http://localhost/images/bg-relative.png",
+        "http://localhost/images/bg-relative-to-root.png",
+        "http://localhost/images/bg-stacked.png"
+      ])
+      expect(resources.collect(&:is_root).uniq).to match_array([nil])
+    end
+  end
+end

data/spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb ADDED Viewed

@@ -0,0 +1,58 @@
+require 'sprockets'
+class SimpleRackApp
+  def self.call(env)
+    [200, {}, 'Hello World']
+  end
+end
+RSpec.describe Percy::Capybara::Loaders::SprocketsLoader do
+  let(:loader) do
+    described_class.new(
+      page: page,
+      sprockets_environment: environment,
+      sprockets_options: sprockets_options,
+    )
+  end
+  let(:environment) do
+    root = File.expand_path("../../client/testdata", __FILE__)
+    environment = Sprockets::Environment.new(root)
+    environment.append_path '.'
+    environment
+  end
+  let(:sprockets_options) do
+    options = double('options')
+    allow(options).to receive(:precompile).and_return([/(?:\/|\\|\A)base\.(css|js)$/])
+    options
+  end
+  describe '#snapshot_resources' do
+    context 'Rack::Test', type: :feature do
+      before(:each) { Capybara.app = SimpleRackApp }
+      it 'returns the root HTML resource' do
+        visit '/'
+        resources = loader.snapshot_resources
+        expect(resources.map { |r| r.resource_url }).to eq(["/"])
+        expect(resources.first.is_root).to eq(true)
+        expect(resources.first.content).to include('Hello World')
+      end
+    end
+    context 'Capybara::Webkit', type: :feature, js: true do
+      it 'returns the root HTML resource' do
+        visit '/'
+        resources = loader.snapshot_resources
+        expect(resources.map { |r| r.resource_url }).to eq(["/"])
+        expect(resources.first.is_root).to eq(true)
+        expect(resources.first.content).to include('Hello World!</body></html>')
+      end
+    end
+  end
+  describe '#build_resources', type: :feature do
+    it 'returns "build resources" from filtered sprockets paths' do
+      resources = loader.build_resources
+      expect(resources.map { |r| r.resource_url }).to eq(["/assets/css/base.css"])
+      expect(resources.first.content).to include('.colored-by-base')
+    end
+  end
+end

data/spec/lib/percy/capybara_spec.rb CHANGED Viewed

@@ -10,7 +10,6 @@ RSpec.describe Percy::Capybara do
     ENV['PERCY_ENABLE'] = nil
   end
   describe '#capybara_client' do
     it 'returns the current client or creates a new one' do
       capybara_client = Percy::Capybara.capybara_client

data/spec/spec_helper.rb CHANGED Viewed

@@ -5,6 +5,11 @@ require 'support/test_helpers'
 require 'percy'
 require 'percy/capybara'
+Capybara::Webkit.configure do |config|
+  # config.allow_url("*")
+  config.block_unknown_urls
+end
 RSpec.configure do |config|
   config.include TestHelpers
@@ -41,4 +46,25 @@ RSpec.configure do |config|
   config.before(:each, type: :feature) do
     WebMock.disable_net_connect!(allow_localhost: true, allow: [/i.imgur.com/])
   end
+  # Start a temp webserver that serves the testdata directory.
+  # You can test this server manually by running:
+  # ruby -run -e httpd spec/lib/percy/capybara/client/testdata/ -p 9090
+  config.before(:all, type: :feature) do
+    port = get_random_open_port
+    Capybara.app = nil
+    Capybara.app_host = "http://localhost:#{port}"
+    Capybara.run_server = false
+    # Note: using this form of popen to keep stdout and stderr silent and captured.
+    dir = File.expand_path('../lib/percy/capybara/client/testdata/', __FILE__)
+    @process = IO.popen([
+      'ruby', '-run', '-e', 'httpd', dir, '-p', port.to_s, err: [:child, :out]
+    ].flatten)
+    # Block until the server is up.
+    WebMock.disable_net_connect!(allow_localhost: true)
+    verify_server_up(Capybara.app_host)
+  end
+  config.after(:all, type: :feature) { Process.kill('INT', @process.pid) }
 end

data/spec/support/test_helpers.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require 'socket'
 require 'timeout'
+require 'sprockets'
 module TestHelpers
   class ServerDown < Exception; end
@@ -24,4 +25,24 @@ module TestHelpers
     end
     raise ServerDown, "Server failed to start: #{host}"
   end
+  def find_resource(resources, regex)
+    begin
+      resources.select { |resource| resource.resource_url.match(regex) }.fetch(0)
+    rescue IndexError
+      raise "Missing expected image with resource_url that matches: #{regex}"
+    end
+  end
+  def setup_sprockets(capybara_client)
+    root = File.expand_path("../../lib/percy/capybara/client/testdata", __FILE__)
+    environment = Sprockets::Environment.new(root)
+    environment.append_path '.'
+    sprockets_options = double('sprockets_options')
+    allow(sprockets_options).to receive(:precompile).and_return([/(?:\/|\\|\A)base\.(css|js)$/])
+    capybara_client.sprockets_environment = environment
+    capybara_client.sprockets_options = sprockets_options
+  end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -84,16 +84,16 @@ dependencies:
   name: capybara-webkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: ''
 email:
 - team@percy.io
@@ -157,6 +171,10 @@ files:
 - lib/percy/capybara/client/builds.rb
 - lib/percy/capybara/client/snapshots.rb
 - lib/percy/capybara/httpfetcher.rb
+- lib/percy/capybara/loaders/base_loader.rb
+- lib/percy/capybara/loaders/native_loader.rb
+- lib/percy/capybara/loaders/sprockets_loader.rb
+- lib/percy/capybara/rspec.rb
 - lib/percy/capybara/version.rb
 - percy-capybara.gemspec
 - spec/lib/percy/capybara/client/builds_spec.rb
@@ -181,6 +199,9 @@ files:
 - spec/lib/percy/capybara/client/testdata/test-images.html
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
+- spec/lib/percy/capybara/loaders/base_loader_spec.rb
+- spec/lib/percy/capybara/loaders/native_loader_spec.rb
+- spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb
 - spec/lib/percy/capybara_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_helpers.rb
@@ -231,6 +252,9 @@ test_files:
 - spec/lib/percy/capybara/client/testdata/test-images.html
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
+- spec/lib/percy/capybara/loaders/base_loader_spec.rb
+- spec/lib/percy/capybara/loaders/native_loader_spec.rb
+- spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb
 - spec/lib/percy/capybara_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_helpers.rb