janus-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48d541d4807829c7904dd94f3c490782ac384a8e
-  data.tar.gz: e6a8dee5095f4f7bfb37534e9e51c21015db496e
+  metadata.gz: 937b8709825ebcdb797849676eb8828953b18ce3
+  data.tar.gz: 2359bd29a0b4a314918215693a98b68d4682212b
 SHA512:
-  metadata.gz: dad2010d9f66f0e98abeeb55cf025b36151c187367b26498a556b834271e3c2d509b63fa06658033f3f506f797348f28224b52b7bd54d4bd3bcdfe04a70d9fc1
-  data.tar.gz: 1393f2a3b1bd0349d6c300ad5b7dd31f3ecda5f3a2a3c4ed3c18af21528a6f30a7756dec9e711f503fa9fef9dca2c39b2a32caf5fa8e05be59eb87560f6c661a
+  metadata.gz: 32799bec8eab0f1460b418a14b20c0a1f08ba10594d0a461c9964b9545b367e8c27de752f534c26cc132cf33552d10767cb419e5b0b3fa7bcafd1c8444a6d504
+  data.tar.gz: a9a8fc7030531eac97a34c327c9cb206790ec1c2fc6891a827bc9827ab8bd65a3acb7a1f993c44731341ce3afece9dcaf68e87d587f2e44a693cbb9903f75b38

data/.gitignore

@@ -1,3 +1,4 @@
 /coverage
 /pkg
 Gemfile.lock
+sauce_connect.log

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --format progress
---require spec_helper
+--require unit/spec_helper

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## v0.2.0 (March 19, 2014)
+- Add console reporting.
+- Add multi-browser support.
+- Add threshold-based comparison.
+
+## v0.1.0 (March 8, 2014)
+- Initial Release

data/Guardfile

@@ -1,6 +1,6 @@
 guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/unit/spec_helper.rb')  { "spec/unit" }
 end
 

data/README.md

@@ -49,23 +49,10 @@ directory for an example of Janus in action.
 
 ## Configuring Janus
 
-**directory** (required)
-
-The location where Janus screenshots are stored.
-
-**url** (optional)
-
-The base URL for all screenshots. All test URLs will be relative to this URL.
-
-**threshold** (optional)
-
-The percentage of change that is allowed in a screenshot. This value can be
-overridden for each individual test.
-
-**resolution** (optional)
+**tests** (required)
 
-The browser resolution at which screenshots should be taken. This value is limited
-by the options available on Sauce Labs.
+An array of screenshots to take. Each entry in the array contains a name and
+URL. All URLs are relative to the specified base URL.
 
 **browsers** (required)
 
@@ -73,11 +60,15 @@ An array of browsers to run your tests against. Each entry in the array contains
 a platform, browser, and optional version. See the [Sauce Labs platform documentation](https://saucelabs.com/docs/platforms)
 for more information on the valid browsers.
 
-**tests** (required)
+**directory** (required)
+
+The location where Janus screenshots are stored.
+
+**threshold** (optional)
+
+The percentage of change that is allowed in a screenshot. This value can be
+overridden for each individual test. *Defaults to 0*.
 
-An array of screenshots to take. Each entry in the array contains a name, URL,
-and optional threshold. All URLs are relative to the specified base URL. If a
-threshold is defined, it will override the global theshold.
 
 ## Best Practices
 

data/Rakefile

@@ -1,6 +1,16 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+task :spec => ['spec:unit', 'spec:integration']
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/**/*_spec.rb'
+  end
+end
 
 task :default => :spec

data/bin/janus

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'colored'
+require 'colorize'
 require 'gli'
 require 'janus/version'
 require 'janus/command/initialize'

data/janus.gemspec

@@ -16,8 +16,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency('colored', '~> 1.2')
+  spec.add_dependency('colorize', '~> 0.7.0')
   spec.add_dependency('gli', '~> 2.8')
+  spec.add_dependency('oily_png', '~> 1.1')
+  spec.add_dependency('sauce-connect', '~> 3.3.1')
   spec.add_dependency('selenium-webdriver', '~> 2.37')
 
   spec.add_development_dependency('bundler', '~> 1.3')

data/lib/janus.rb

@@ -1,3 +1,2 @@
 module Janus
-
 end

data/lib/janus/browser.rb

@@ -0,0 +1,19 @@
+module Janus
+  class Browser
+    attr_reader :platform, :name, :version
+
+    def initialize(attributes = {})
+      @platform = attributes['platform']
+      @name = attributes['name']
+      @version = attributes['version']
+    end
+
+    def eql?(other)
+      platform == other.platform && name == other.name && version == other.version
+    end
+
+    def to_s
+      "#{platform}, #{name} #{version}".strip
+    end
+  end
+end

data/lib/janus/command/record.rb

@@ -1,3 +1,9 @@
+# coding: utf-8
+
+require 'colorize'
+require 'sauce/connect'
+require 'janus/io/directory'
+require 'janus/io/selenium'
 require 'janus/screenshot'
 
 module Janus
@@ -8,14 +14,39 @@ module Janus
       end
 
       def execute
+        Sauce::Connect.connect!(quiet: true) if @configuration.tunnel?
+
+        puts 'Recording screenshots...'
+        puts ''
+
+        @configuration.browsers.each do |browser|
+          record_screenshots_for_browser(browser)
+        end
+      end
+
+      def record_screenshots_for_browser(browser)
+        puts "#{browser}"
+        puts ''
+
         @configuration.tests.each do |test|
-          record_screenshot(test)
+          record_screenshot(browser, test)
         end
+
+        puts ''
       end
 
-      def record_screenshot(test)
-        screenshot = Janus::Screenshot.capture(test, username: @configuration.username, access_key: @configuration.access_key)
-        screenshot.save('output')
+      def record_screenshot(browser, test)
+        selenium = Janus::IO::Selenium.new(@configuration.username, @configuration.access_key, browser)
+        screenshot = selenium.read(test)
+
+        directory = Janus::IO::Directory.new(@configuration.directory, browser)
+        directory.write(test, screenshot)
+
+        print '✔ '.green
+      rescue
+        print '✖ '.red
+      ensure
+        puts test.name
       end
     end
   end

data/lib/janus/command/validate.rb

@@ -1,3 +1,11 @@
+# coding: utf-8
+
+require 'colorize'
+require 'sauce/connect'
+require 'janus/core/engine'
+require 'janus/io/directory'
+require 'janus/io/selenium'
+
 module Janus
   module Command
     class Validate
@@ -6,16 +14,42 @@ module Janus
       end
 
       def execute
+        Sauce::Connect.connect!(quiet: true) if @configuration.tunnel?
+
+        puts 'Validating screenshots...'
+        puts ''
+
+        @configuration.browsers.each do |browser|
+          validate_screenshots_for_browser(browser)
+        end
+      end
+
+      def validate_screenshots_for_browser(browser)
+        puts "#{browser}"
+        puts ''
+
         @configuration.tests.each do |test|
-          validate_screenshot(test)
+          validate_screenshot(browser, test)
         end
+
+        puts ''
       end
 
-      def validate_screenshot(test)
-        original = Janus::Screenshot.load(test, path: 'output')
-        fresh = Janus::Screenshot.capture(test, username: @configuration.username, access_key: @configuration.access_key)
+      def validate_screenshot(browser, test)
+        selenium = Janus::IO::Selenium.new(@configuration.username, @configuration.access_key, browser)
+        fresh = selenium.read(test)
+
+        directory = Janus::IO::Directory.new(@configuration.directory, browser)
+        original = directory.read(test)
+
+        engine = Janus::Core::Engine.create(@configuration)
+        engine.execute(original, fresh)
 
-        raise "#{test.name}: Screenshots did not match!" unless original.image == fresh.image
+        print '✔ '.green
+      rescue
+        print '✖ '.red
+      ensure
+        puts test.name
       end
     end
   end

data/lib/janus/configuration.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'janus/browser'
 require 'janus/test'
 
 module Janus
@@ -12,7 +13,7 @@ module Janus
       Janus::Configuration.new(options)
     end
 
-    def initialize(options)
+    def initialize(options = {})
       @options = options
     end
 
@@ -24,6 +25,24 @@ module Janus
       @options['access_key']
     end
 
+    def tunnel?
+      @options['tunnel']
+    end
+
+    def directory
+      @options['directory']
+    end
+
+    def threshold
+      @options['threshold'] || 0
+    end
+
+    def browsers
+      @options['browsers'].map do |browser|
+        Janus::Browser.new(browser)
+      end
+    end
+
     def tests
       @options['tests'].map do |test|
         Janus::Test.new(test)
@@ -34,7 +53,7 @@ module Janus
 
     def self.load_configuration_file
       if File.exists?('Janusfile')
-        YAML.load(IO.read('Janusfile'))
+        YAML.load(::IO.read('Janusfile'))
       else
         raise 'Could not find Janus configuration file!'
       end

data/lib/janus/core/engine.rb

@@ -0,0 +1,26 @@
+require 'janus/core/rule'
+
+module Janus
+  module Core
+    class Engine
+      def self.create(configuration)
+        engine = Engine.new
+        engine.add_rule(Janus::Core::DimensionsRule.new(configuration))
+        engine.add_rule(Janus::Core::ThresholdRule.new(configuration))
+        engine
+      end
+
+      def initialize
+        @rules = []
+      end
+
+      def add_rule(rule)
+        @rules << rule
+      end
+
+      def execute(original, fresh)
+        @rules.each { |r| r.execute(original, fresh) }
+      end
+    end
+  end
+end

data/lib/janus/core/error.rb

@@ -0,0 +1,6 @@
+module Janus
+  module Core
+    class ComparisonError < StandardError
+    end
+  end
+end

data/lib/janus/core/rule.rb

@@ -0,0 +1,46 @@
+require 'oily_png'
+require 'janus/core/error'
+
+module Janus
+  module Core
+    class Rule
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def execute(original, fresh)
+      end
+    end
+
+    class DimensionsRule < Rule
+      def execute(original, fresh)
+        raise Janus::Core::ComparisonError unless original.dimensions == fresh.dimensions
+      end
+    end
+
+    class ThresholdRule < Rule
+      def execute(original, fresh)
+        difference = calculate_total_difference(original, fresh)
+        raise Janus::Core::ComparisonError unless difference <= @configuration.threshold
+      end
+
+      private
+
+      def calculate_total_difference(original, fresh)
+        pixels = original.pixels.zip(fresh.pixels)
+        pixel_differences = pixels.map do |a, b|
+          calculate_pixel_difference(a, b)
+        end
+
+        pixel_differences.reduce { |sum, value| sum + value } / pixels.length
+      end
+
+      def calculate_pixel_difference(original, fresh)
+        r = (ChunkyPNG::Color.r(fresh) - ChunkyPNG::Color.r(original)) ** 2
+        g = (ChunkyPNG::Color.g(fresh) - ChunkyPNG::Color.g(original)) ** 2
+        b = (ChunkyPNG::Color.b(fresh) - ChunkyPNG::Color.b(original)) ** 2
+        Math.sqrt(r + g + b) / Math.sqrt(ChunkyPNG::Color::MAX ** 2 * 3)
+      end
+    end
+  end
+end

data/lib/janus/io/directory.rb

@@ -0,0 +1,40 @@
+require 'oily_png'
+require 'janus/screenshot'
+
+module Janus
+  module IO
+    class Directory
+      def initialize(directory, browser)
+        @directory = directory
+        @browser = browser
+      end
+
+      def read(test)
+        path = image_path(test)
+        image = ChunkyPNG::Image.from_file(path)
+        Janus::Screenshot.new(image)
+      end
+
+      def write(test, screenshot)
+        directory = image_directory(test)
+        FileUtils.mkpath(directory) unless Dir.exists?(directory)
+
+        path = image_path(test)
+        screenshot.image.save(path)
+      end
+
+      private
+
+      def image_path(test)
+        segments = [@browser.platform, @browser.name, @browser.version]
+        file_name = segments.compact.join('-')
+
+        File.join(image_directory(test), "#{file_name}.png")
+      end
+
+      def image_directory(test)
+        File.join(@directory, "#{test.name}.janus")
+      end
+    end
+  end
+end