cezanne 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b042161b943e9c613765446eb96de02c932c1ed
-  data.tar.gz: ea2b8b6803ed4cb416da7dc9d031265f8ce368f4
+  metadata.gz: 891c5e89caa9580135d9536f8406e58e50f6e994
+  data.tar.gz: 8d7762429284a5570dbe0d219894a50ebaa85c13
 SHA512:
-  metadata.gz: f839e12234ddb4d54248264aa6d974191d129c705652eb01f98d860463e6a9e47d1f68e9bf77c981e7e41253aecd4546fceb3f86002d3fe6a290a8643a372b3f
-  data.tar.gz: 42f2832a17ce4a8cc10bed8ae5bedaca3c334ef953da157a8e30751e90597b26605a53cc2b9eb9ef3966290a0fef77533b01c2e8e7ef0d7e05fbbc4e2ee875e5
+  metadata.gz: 71972499b7cf750c379041e50728cf8088ddf23b7caa860e8bed713cda0fa288c1b14e8a572662a5e374d8bf8c696f0a03b5d56fc98f7faf28ff4686f79de302
+  data.tar.gz: 4540b47068fb2e735337656082c3bd6f825d85c88626bb5c6fc4061efd36822489d95cafd9e320e88ed56ccfd568565c59abdb56e051d0cf29f7cca65bbeef8f

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+    - 2.1.2

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/bskyb-commerce/cezanne.svg?branch=master)](https://travis-ci.org/bskyb-commerce/cezanne)
+
 # Cezanne
 
 Visual regression testing tool
@@ -16,9 +18,66 @@ Or install it yourself as:
 
     $ gem install cezanne
 
-## Usage
+## Usage - RSpec
+
+In your spec_helper.rb
+    
+    require 'cezanne/rspec'
+    
+    RSpec.configure do |config|
+      config.include Cezanne
+      config.cezanne = { uid: ENV['build_number'], project_name: 'awesome_app' }
+    end
+
+The uid should be a unique identifier. We use the build number, but it can be a static string if you don't need
+to keep multiple versions of the screenshots.
+
+In your tests
+
+    
+    describe 'Mont Sainte-Victoire', screenshots: true do
+      it 'is a masterpiece' do
+        visit 'url-to-painting'
+        check_visual_regression_for 'mont-sainte-victoire'
+      end
+    end
+
+Make sure to use a unique name for each screenshot. 
+The associate file will be a gif image named after the parameter ('mont-sainte-victoire' in the example above)
+and the browser name & version, to make it easy to check visual regressions on multiple browsers.
+
+## Dependencies
+
+Cezanne uses ImageMagick to compare images. Check with your package manager.
 
-coming soon
+Screenshots are stored on Dropbox through the Dropscreen gem. Follow the instructions at https://github.com/bskyb-commerce/dropscreen and make sure to export the access_token
+
+    export DROPBOX_ACCESS_TOKEN=**insert dropbox access token here**
+
+Screenshots are taken using Capybara.
+
+## (Opinionated) Workflow
+
+* Reference screenshots are stored on Dropbox
+* New and different screenshots will be synced to Dropbox at the end of the test suite 
+
+
+    ```
+    project_name
+    |
+    +-- reference_screenshots
+    |
+    +-- uid
+    |   |
+    |   +-- new_screenshots
+    |   |
+    |   +-- different_screenshots
+    |
+    |
+    +-- uid_2
+        |
+        ...
+    ```
 
 ## Contributing
 
@@ -27,3 +86,7 @@ coming soon
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Authors
+
+Made with <3 by the Sky Haiku team

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--tag ~integration'  
+end
+
+task :default => :spec

data/lib/cezanne/version.rb

@@ -1,3 +1,3 @@
 module Cezanne
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/cezanne.rb

@@ -39,7 +39,7 @@ module Cezanne
     end
 
     def file_name_for page_name
-      "#{page_name}_#{page.driver.browser.browser.to_s}.gif"
+      "#{page_name}_#{page.driver.browser.capabilities.browser_name}_#{page.driver.browser.capabilities.version}.gif"
     end
 
     def mark_as_new screenshot

data/spec/cezanne_image_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Cezanne::Image do
 
-  let(:image) { Cezanne::Image.new('spec/images/page_name_browser.gif') }
+  let(:image) { Cezanne::Image.new('spec/images/page_name_browser_version.gif') }
 
   describe '#initialize' do 
     

data/spec/cezanne_rspec_spec.rb

@@ -12,7 +12,7 @@ RSpec.configure do |config|
   config.cezanne = { uid: 'test', project_name: 'cezanne' }
 end
 
-describe 'Cezanne RSpec integration', type: :feature, screenshots: true do
+describe 'Cezanne RSpec integration', type: :feature, screenshots: true, integration: true do
  
   # wrap each test with before(:all) and after(:all) 
 
@@ -44,8 +44,8 @@ describe 'Cezanne RSpec integration', type: :feature, screenshots: true do
  
 
     it 'pull reference_screenshots' do 
-      expect(File.exist?('artifacts/reference_screenshots/similar_firefox.gif')).to be true
-      expect(File.exist?('artifacts/reference_screenshots/different_firefox.gif')).to be true
+      expect(File.exist?('artifacts/reference_screenshots/similar_firefox_31.0.gif')).to be true
+      expect(File.exist?('artifacts/reference_screenshots/different_firefox_31.0.gif')).to be true
     end
  
   end 

data/spec/cezanne_spec.rb

@@ -7,14 +7,17 @@ describe Cezanne do
   let(:page) { double('page') }
   let(:driver) { double('driver') }
   let(:browser) { double('browser') }
+  let(:capabilities) { double('capabilities') }
   # RMagick mocks
   let(:picture) { double('Magick::Image') }
   # Cezanne classes mocks
   let(:local_files) { double('local_files') }
   let(:image) { double('Cezanne::Image') }
-
+  
   before(:each) do
-    allow(browser).to receive('browser').and_return(:browser)
+    allow(capabilities).to receive('browser_name').and_return('browser')
+    allow(capabilities).to receive('version').and_return('version')
+    allow(browser).to receive('capabilities').and_return(capabilities)
     allow(browser).to receive('save_screenshot')
     allow(driver).to receive('browser').and_return(browser)
     allow(page).to receive('driver').and_return(driver)
@@ -91,8 +94,8 @@ describe Cezanne do
 
   describe '#file_name_for' do
 
-    it 'contains page_name and browser' do
-      expect(class_with_cezanne.send(:file_name_for, 'fancy_page_name')).to eq('fancy_page_name_browser.gif')
+    it 'contains page_name, browser and version' do
+      expect(class_with_cezanne.send(:file_name_for, 'fancy_page_name')).to eq('fancy_page_name_browser_version.gif')
     end
   
   end
@@ -102,7 +105,7 @@ describe Cezanne do
     let(:screenshot) { image }
 
     before(:each) do
-      allow(image).to receive('path').and_return('spec/images/page_name_browser.gif')    
+      allow(image).to receive('path').and_return('spec/images/page_name_browser_version.gif')    
     end 
 
     it 'moves screenshot to the diff folder' do
@@ -112,7 +115,7 @@ describe Cezanne do
     end
 
     after(:each) do
-      FileUtils.mv('spec/images/different.gif', 'spec/images/page_name_browser.gif')
+      FileUtils.mv('spec/images/different.gif', 'spec/images/page_name_browser_version.gif')
     end
 
   end
@@ -123,7 +126,7 @@ describe Cezanne do
     let(:screenshot) { image }
 
     before(:each) do
-      allow(image).to receive('path').and_return('spec/images/page_name_browser.gif')    
+      allow(image).to receive('path').and_return('spec/images/page_name_browser_version.gif')    
     end 
 
     it 'moves screenshot to the new folder' do
@@ -133,7 +136,7 @@ describe Cezanne do
     end
 
     after(:each) do
-      FileUtils.mv('spec/images/new.gif', 'spec/images/page_name_browser.gif')
+      FileUtils.mv('spec/images/new.gif', 'spec/images/page_name_browser_version.gif')
     end
 
   end
@@ -145,7 +148,7 @@ describe Cezanne do
     end
 
     it 'return a Cezanne::Image' do
-      path = 'spec/images/page_name_browser.gif'
+      path = 'spec/images/page_name_browser_version.gif'
       expect(class_with_cezanne.send(:image, path)).to be_instance_of(Cezanne::Image)
     end
     
@@ -154,13 +157,13 @@ describe Cezanne do
   describe '#check_visual_regression_for' do
 
     before(:each) do
-      allow(class_with_cezanne).to receive('get_reference_screenshot_for').and_return(Cezanne::Image.new('spec/images/page_name_browser.gif'))
+      allow(class_with_cezanne).to receive('get_reference_screenshot_for').and_return(Cezanne::Image.new('spec/images/page_name_browser_version.gif'))
     end
 
     context 'succesful match' do
 
       it 'does not raise an error' do
-        allow(class_with_cezanne).to receive('take_screenshot').and_return(Cezanne::Image.new('spec/images/page_name_browser.gif'))
+        allow(class_with_cezanne).to receive('take_screenshot').and_return(Cezanne::Image.new('spec/images/page_name_browser_version.gif'))
         expect { class_with_cezanne.check_visual_regression_for 'page_name' }.not_to raise_error
       end
 
@@ -168,7 +171,7 @@ describe Cezanne do
 
     context 'failed match' do
 
-      let(:screenshot) { Cezanne::Image.new('spec/images/page_name_2_browser.gif') }
+      let(:screenshot) { Cezanne::Image.new('spec/images/page_name_2_browser_version.gif') }
 
       before(:each) do
         allow(class_with_cezanne).to receive('take_screenshot').and_return(screenshot)
@@ -190,7 +193,7 @@ describe Cezanne do
 
     context 'new screenshot' do 
 
-      let(:screenshot) { Cezanne::Image.new('spec/images/page_name_browser.gif') }
+      let(:screenshot) { Cezanne::Image.new('spec/images/page_name_browser_version.gif') }
 
       before(:each) do
         allow(class_with_cezanne).to receive('get_reference_screenshot_for').and_return(false)

data/spec/images/different.html

@@ -4,6 +4,6 @@
     <title>DIFFERENT</title>
   </head>
   <body>
-    <img src="page_name_browser.gif" />
+    <img src="page_name_browser_version.gif" />
   </body>
 </html>

data/spec/images/new.html

@@ -4,6 +4,6 @@
     <title>NEW</title>
   </head>
   <body>
-    <img src="page_name_2_browser.gif" />
+    <img src="page_name_2_browser_version.gif" />
   </body>
 </html>

data/spec/images/similar.html

@@ -4,6 +4,6 @@
     <title>SIMILAR</title>
   </head>
   <body>
-    <img src="page_name_browser.gif" />
+    <img src="page_name_browser_version.gif" />
   </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cezanne
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sky Haiku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -148,8 +149,8 @@ files:
 - spec/cezanne_spec.rb
 - spec/images/different.html
 - spec/images/new.html
-- spec/images/page_name_2_browser.gif
-- spec/images/page_name_browser.gif
+- spec/images/page_name_2_browser_version.gif
+- spec/images/page_name_browser_version.gif
 - spec/images/similar.html
 - spec/spec_helper.rb
 homepage: ''
@@ -183,7 +184,7 @@ test_files:
 - spec/cezanne_spec.rb
 - spec/images/different.html
 - spec/images/new.html
-- spec/images/page_name_2_browser.gif
-- spec/images/page_name_browser.gif
+- spec/images/page_name_2_browser_version.gif
+- spec/images/page_name_browser_version.gif
 - spec/images/similar.html
 - spec/spec_helper.rb