lineup 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 067fafb3cf9ae7850aa9cd76e2ab536ae3db4253
-  data.tar.gz: b8e613c3b5802b45a0aa5e59a52b8c8a518a1547
+  metadata.gz: 89ea9b6e95a25a526e1bb6317ec204a8518d4e4d
+  data.tar.gz: 01f7795b66bb5b652c0f01925307b5fa6af6ea2e
 SHA512:
-  metadata.gz: 8cefe37fc7a30fb1551bda59558cb536d6ddc585ff0f4df76af0d1a4538b3b80be6b1bac914ffd3b774680dc7e505749d05a2753dc448c69883423e986573ea1
-  data.tar.gz: 5748e11a87ca7960bc73ad4458c7a6e70ad8446313657438871540aac843c53302e6dea58fcf30b179974938ed99d792817defbd8df7955b3a687d8222612c02
+  metadata.gz: 774b8f2777cd26e9609875e34a29336dcda9a5c254e3c78acf153a48d320b0a0587d2332c15090bdb8be10ed2daccec3c848f1fed0cbd8ccc1b662208aa5a5fb
+  data.tar.gz: bfd830aa1e580998ba50c87bfbea26004a76202b97e46418607de0358bb22b52827bba433ef5d3af474ce3d52f785bc447b882d4b1564b345415cb1fe7d2d5c3

data/Gemfile.lock

@@ -2,46 +2,46 @@ PATH
   remote: .
   specs:
     lineup (0.2.1)
-      chunky_png (>= 1.3.4)
-      dimensions (>= 1.3.0)
-      headless (>= 0.1.1)
-      oily_png (>= 1.2.0)
-      pxdoppelganger (>= 0.1.1)
+      chunky_png (~> 1.3)
+      dimensions (~> 1.3)
+      headless (~> 0.1)
+      oily_png (~> 1.2)
+      pxdoppelganger (~> 0.1)
       rspec (~> 3.2)
-      selenium-webdriver (>= 2.46.2)
-      watir (>= 5.0.0)
-      watir-webdriver (>= 0.8.0)
+      selenium-webdriver (~> 2.46)
+      watir (~> 5.0)
+      watir-webdriver (~> 0.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    childprocess (0.5.5)
+    childprocess (0.5.9)
       ffi (~> 1.0, >= 1.0.11)
-    chunky_png (1.3.4)
+    chunky_png (1.3.5)
     commonwatir (4.0.0)
     diff-lcs (1.2.5)
     dimensions (1.3.0)
-    ffi (1.9.6)
-    headless (2.0.0)
-    multi_json (1.11.0)
+    ffi (1.9.10)
+    headless (0.3.1)
+    multi_json (1.11.2)
     oily_png (1.2.0)
       chunky_png (~> 1.3.1)
     pxdoppelganger (0.1.1)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     rubyzip (1.1.7)
-    selenium-webdriver (2.46.2)
+    selenium-webdriver (2.50.0)
       childprocess (~> 0.5)
       multi_json (~> 1.0)
       rubyzip (~> 1.0)
@@ -49,9 +49,9 @@ GEM
     watir (5.0.0)
       commonwatir (~> 4)
       watir-webdriver
-    watir-webdriver (0.8.0)
-      selenium-webdriver (>= 2.45)
-    websocket (1.2.1)
+    watir-webdriver (0.9.1)
+      selenium-webdriver (>= 2.46.2)
+    websocket (1.2.2)
 
 PLATFORMS
   ruby
@@ -68,4 +68,4 @@ DEPENDENCIES
   watir-webdriver
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -1,5 +1,7 @@
 # Lineup
 
+![Logo](https://raw.githubusercontent.com/otto-de/lineup/master/doc/lineup_mini.png)
+
 Lineup is doing automated testing of webpage designs, eg. in continious delivery.
 If you push new code to production, you can evaluate the design of your page compared to a defined base design and
 get an analysis about the difference of the designs:

data/lib/controller/browser.rb

@@ -7,7 +7,7 @@ require_relative '../helper'
 
 class Browser
 
-  def initialize(baseurl, urls, resolutions, path, headless, wait)
+  def initialize(baseurl, urls, resolutions, path, headless, wait, cookie = false)
     @absolute_image_path = path
     FileUtils.mkdir_p @absolute_image_path
     @baseurl = baseurl
@@ -15,6 +15,7 @@ class Browser
     @resolutions = resolutions
     @headless = headless
     @wait = wait
+    @cookie = cookie
   end
 
   def record(version)
@@ -50,9 +51,14 @@ class Browser
   def screenshot_recorder(width, url, version)
     filename = Helper.filename(@absolute_image_path, url, width, version)
     @browser.driver.manage.window.resize_to(width, 1000)
-    @browser.cookies.clear
+
     url = Helper.url(@baseurl, url)
     @browser.goto url
+    if @cookie
+      @browser.cookies.clear
+      @browser.cookies.add(@cookie[:name], @cookie[:value], domain: @cookie[:domain], path: @cookie[:path], expires: Time.now + 7200, secure: @cookie[:secure])
+      @browser.goto url
+    end
     sleep @wait if @wait
     @browser.screenshot.save( File.expand_path(filename))
   end

data/lib/lineup/version.rb

@@ -1,8 +1,8 @@
 module Lineup
   class Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 1
+    MINOR = 3
+    PATCH = 0
 
     class << self
       def to_s

data/lib/lineup.rb

@@ -173,6 +173,34 @@ module Lineup
     end
 
 
+    def cookie_for_experiment(cookie)
+
+      # a hash for a cookie can be set here. this is optional.
+      #
+      # e.g {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
+      #
+      # if it is not nil it has to be an array:
+      if cookie
+        # generate :symbol => "value" hash map from "symbol" => "value"
+        cookie = cookie.inject({}){|element,(symbol,value)| element[symbol.to_sym] = value; element}
+
+        #Validation
+        (raise "Cookie must be a hash of format
+              {name: 'experiment', value: 'experiment_value', domain: 'domain.com', path: '/', expires: <Time>, secure: false}
+              " unless cookie.is_a? Hash)
+
+        raise "cookie must have value for :name" unless (cookie[:name]).is_a? String
+        raise "cookie must have value for :value" unless (cookie[:value]).is_a? String
+        raise "cookie must have value for :domain" unless (cookie[:domain]).is_a? String
+        raise "cookie must have value for :path" unless (cookie[:path]).is_a? String
+        raise "cookie must have value for :secure" if (cookie[:secure]) == nil
+      end
+
+      # assign the variable
+
+      @cookie_for_experiment = cookie
+    end
+
 
     def wait_for_asynchron_pages(wait)
 
@@ -190,8 +218,6 @@ module Lineup
       @wait_for_asynchron_pages = wait
     end
 
-
-
     def load_json_config(path)
 
       # loads all possible configs from a json file.
@@ -209,11 +235,12 @@ module Lineup
       use_phantomjs(configuration["use_phantomjs"])
       difference_path(configuration["difference_path"])
       wait_for_asynchron_pages(configuration["wait_for_asynchron_pages"])
+      cookie_for_experiment(configuration["cookie_for_experiment"])
 
       # the method calls set the variables for the parameters, we return an array with all of them.
       # for the example above it is:
       # [["/multimedia", "/sport"], [600, 800, 1200], "~/images/", true, "#/images/diff"]
-      [@urls, @resolutions, @screenshots_path, @headless, @difference_path, @wait_for_asynchron_pages]
+      [@urls, @resolutions, @screenshots_path, @headless, @difference_path, @wait_for_asynchron_pages, @cookie_for_experiment]
     end
 
 
@@ -230,7 +257,7 @@ module Lineup
       # and saves the screenshot in the file
       #   @screenshot_path
 
-      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages)
+      browser = Browser.new(@baseurl, @urls, @resolutions, @screenshots_path, @headless, @wait_for_asynchron_pages, @cookie_for_experiment)
 
       # the only argument missing is if this is the "base" or "new" screenshot, this can be
       # passed as an argument. The value does not need to be "base" or "new", but can be anything

data/tests/rspec/lineup_spec.rb

@@ -6,7 +6,7 @@ require_relative '../../lib/lineup'
 
 describe '#screeshot_recorder' do
 
-  BASE_URL = 'https://www.otto.de'
+  BASE_URL = 'https://www.google.de/'
   SCREENSHOTS = "#{Dir.pwd}/screenshots/"
 
   after(:each) { FileUtils.rmtree SCREENSHOTS }
@@ -15,7 +15,13 @@ describe '#screeshot_recorder' do
     # Given
     file = "#{Dir.pwd}/test_configuration.json"
     FileUtils.rm file if (File.exists? file)
-    json = '{"urls":"page1, page2","resolutions":"13,42","filepath_for_images":"some/path","use_phantomjs":true,"difference_path":"some/difference/image/path",  "wait_for_asynchron_pages":5}'
+    json = '{"urls":"page1, page2",
+             "resolutions":"13,42",
+             "filepath_for_images":"some/path",
+             "use_phantomjs":true,
+             "difference_path":"some/difference/image/path",
+             "wait_for_asynchron_pages":5
+             }'
     save_json(json, file)
 
     # When
@@ -24,7 +30,7 @@ describe '#screeshot_recorder' do
     # Then
     expect(
         lineup.load_json_config(file)
-    ).to eq([['page1', 'page2'], [13,42], 'some/path', true, 'some/difference/image/path', 5])
+    ).to eq([['page1', 'page2'], [13,42], 'some/path', true, 'some/difference/image/path', 5, nil])
 
     # cleanup:
     FileUtils.rm file if (File.exists? file)
@@ -54,7 +60,7 @@ describe '#screeshot_recorder' do
 
   it 'takes a screenshot a desired resolution' do
     # Given
-    width = '320' #min width firefox as of Sep 2015
+    width = '700'
     lineup = Lineup::Screenshot.new(BASE_URL)
 
     # When
@@ -74,7 +80,7 @@ describe '#screeshot_recorder' do
 
   it 'takes screenshots of different pages, if specified' do
     # Given
-    urls = '/, multimedia, sport'
+    urls = '/, flights'
     lineup = Lineup::Screenshot.new(BASE_URL)
     lineup.resolutions('1180')
     lineup.urls(urls)
@@ -88,7 +94,7 @@ describe '#screeshot_recorder' do
     ).to be(true)
 
     expect(
-        File.exist? ("#{Dir.pwd}/screenshots/multimedia_1180_base.png")
+        File.exist? ("#{Dir.pwd}/screenshots/flights_1180_base.png")
     ).to be(true)
 
   end
@@ -106,14 +112,22 @@ describe '#screeshot_recorder' do
 
       # Then
     }.to raise_error ArgumentError
-
   end
 
   it 'compares a base and a new screenshot and detects no difference if images are the same' do
     # Given
     lineup = Lineup::Screenshot.new(BASE_URL)
-    lineup.urls('/shoppages/begood')
+    lineup.urls('/')
     lineup.resolutions('400')
+    lineup.wait_for_asynchron_pages(5)
+    lineup.use_phantomjs(true)
+    cookie =  {"name" => "CONSENT",
+               "value" => "YES+DE.de+V7",
+               "domain" => ".google.de",
+               "path" => "/",
+               "secure" => false}
+    lineup.cookie_for_experiment(cookie)
+
     lineup.record_screenshot('base')
     lineup.record_screenshot('new')
 
@@ -126,11 +140,47 @@ describe '#screeshot_recorder' do
 
   end
 
+  it 'compares a base and a new screenshot when loading a json config and setting a cookie' do
+    # Given
+    file = "#{Dir.pwd}/test_configuration.json"
+    FileUtils.rm file if (File.exists? file)
+    json = '{"urls":"page1, page2",
+             "resolutions":"13,42",
+             "filepath_for_images":"some/path",
+             "use_phantomjs":true,
+             "difference_path":"some/difference/image/path",
+             "wait_for_asynchron_pages":5,
+             "cookie_for_experiment":{
+                                      "name":"CONSENT",
+                                      "value":"YES+DE.de+V7",
+                                      "domain":".google.de",
+                                      "path":"/",
+                                      "secure":false
+                                      }
+             }'
+    save_json(json, file)
+    lineup = Lineup::Screenshot.new(BASE_URL)
+    lineup.load_json_config(file)
+
+    lineup.record_screenshot('base')
+    lineup.record_screenshot('new')
+
+    expect(
+        # When
+        lineup.compare('base', 'new')
+
+        # Then
+    ).to eq([])
+
+    # cleanup:
+    FileUtils.rm file if (File.exists? file)
+  end
+
   it 'compares a base and a new screenshot and returns the difference if the images are NOT the same as json log' do
     # Given
-    width = '600'
-    base_site = 'multimedia'
-    new_site = 'sport'
+    width = '800'
+    base_site = '?q=test'
+    new_site = '?q=somethingelse'
     json_path = "#{Dir.pwd}"
     json_file = "#{json_path}/log.json"
 
@@ -152,41 +202,38 @@ describe '#screeshot_recorder' do
     # the output will be similar to the values here:
     # [
     #   {
-    #     :url => 'sport',
-    #     :width => 600,
+    #     :url => 'translate',
+    #     :width => 800,
     #     :difference => 0.7340442722738748,
-    #     :base_file => '/home/myname/lineup/tests/respec/screenshots/sport_600_base.png'
-    #     :new_file =>  '/home/myname/lineup/tests/respec/screenshots/sport_600_new.png'
-    #     :diff_file => '/home/myname/lineup/tests/rspec/screenshots/sport_600_DIFFERENCE.png'
+    #     :base_file => '/home/myname/lineup/tests/respec/screenshots/translate_600_base.png'
+    #     :new_file =>  '/home/myname/lineup/tests/respec/screenshots/translate_600_new.png'
+    #     :diff_file => '/home/myname/lineup/tests/rspec/screenshots/translate_600_DIFFERENCE.png'
     #   }
     # ]
     #
     expect(
         (lineup.compare('base', 'new').first)[:url]
-    ).to eq('sport')
+    ).to eq('?q=somethingelse')
     # And
     expect(
         (lineup.compare('base', 'new').first)[:width]
-    ).to eq(600)
+    ).to eq(800)
     # And
     result = (lineup.compare('base', 'new').first)[:difference]
     expect(
         result
-    ).to be_within(15).of(20) # 'compare' returns the difference of pixel between the screenshots in %
-    # 15-20% of pixel works toady (12.3 on 2015/09) for the difference between sport and multimedia page of OTTO.de,
-    # but the pages may some day look more or less alike, then these values can be changed
-    # And
+    ).to be > 0 # 'compare' returns the difference of pixel between the screenshots in %
     expect(
         (lineup.compare('base', 'new').first)[:base_file]
-    ).to include("/lineup/tests/rspec/screenshots/sport_600_base.png")
+    ).to include("/lineup/tests/rspec/screenshots/?q=somethingelse_#{width}_base.png")
     # And
     expect(
         (lineup.compare('base', 'new').first)[:new_file]
-    ).to include("/lineup/tests/rspec/screenshots/sport_600_new.png")
+    ).to include("/lineup/tests/rspec/screenshots/?q=somethingelse_#{width}_new.png")
     # And
     expect(
         (lineup.compare('base', 'new').first)[:difference_file]
-    ).to include("/lineup/tests/rspec/screenshots/sport_600_DIFFERENCE.png")
+    ).to include("/lineup/tests/rspec/screenshots/?q=somethingelse_#{width}_DIFFERENCE.png")
 
     # And When
     lineup.save_json(json_path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lineup
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Finn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -151,6 +151,8 @@ files:
 - README.md
 - bin/lineup
 - doc/example.png
+- doc/lineup.png
+- doc/lineup_mini.png
 - lib/controller/browser.rb
 - lib/controller/comparer.rb
 - lib/helper.rb