zucchini-ios 0.5.7 → 0.5.8

data/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright (c) Vasily Mikhaylichenko and PlayUp USA, LLC.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -8,7 +8,8 @@ Pre-requisites
  4. A few command line tools:
 
 ```
-brew update && brew install imagemagick && brew install coffee-script
+brew update && brew install imagemagick node
+npm install -g coffee-script
 ```
 
 Start using Zucchini

data/bin/zucchini

@@ -8,12 +8,15 @@ require 'lib/config'
 require 'lib/screenshot'
 require 'lib/report'
 require 'lib/feature'
+require 'lib/detector'
 require 'lib/runner'
 require 'lib/generator'
+require 'lib/approver'
                 
 class Zucchini::App < Clamp::Command
   subcommand "generate", "Generate a project scaffold", Zucchini::Generator
   subcommand "run", "Run zucchini", Zucchini::Runner
+  subcommand "approve", "Update reference screenshots", Zucchini::Approver
 end
 
 Zucchini::App.run

data/lib/approver.rb

@@ -0,0 +1,14 @@
+class Zucchini::Approver < Zucchini::Detector
+  parameter "PATH", "a path to feature or a directory"
+  
+  option %W(-p --pending), :flag, "update pending screenshots instead"
+
+  def run_command
+    reference_type = pending? ? "pending" : "reference"
+    features.each do |f|
+      f.device = @device
+      f.approve reference_type
+    end
+    features.inject(true){ |result, feature| result &= feature.succeeded }
+  end
+end

data/lib/detector.rb

@@ -0,0 +1,61 @@
+class Zucchini::Detector < Clamp::Command
+  attr_reader :features
+    
+  parameter "PATH", "a path to feature or a directory"
+  
+  def execute
+    raise "Directory #{path} does not exist" unless File.exists?(path)
+
+    @path = File.expand_path(path)
+    Zucchini::Config.base_path = File.exists?("#{path}/feature.zucchini") ? File.dirname(path) : path
+
+    raise "ZUCCHINI_DEVICE environment variable not set" unless ENV['ZUCCHINI_DEVICE']
+    @device = Zucchini::Config.device(ENV['ZUCCHINI_DEVICE'])
+    
+    @template = detect_template
+
+    exit run_command
+  end
+  
+  def run_command; end
+  
+  def features
+    @features ||= detect_features(@path)
+  end
+
+  def detect_features(path)
+    features = []
+    if File.exists?("#{path}/feature.zucchini")
+      features << Zucchini::Feature.new(path)
+    else
+      raise detection_error(path) if Dir["#{path}/*"].empty?
+
+      Dir.glob("#{path}/*").each do |dir|
+          unless dir.match /support/
+          if File.exists?("#{dir}/feature.zucchini")
+            features << Zucchini::Feature.new(dir)
+          else
+            raise detection_error(dir)
+          end
+        end
+      end
+    end
+    features
+  end
+
+  def detection_error(path)
+    "#{path} is not a feature directory"
+  end
+
+  def detect_template
+    locations = [
+      `xcode-select -print-path`.gsub(/\n/, '') + "/Platforms/iPhoneOS.platform/Developer/Library/Instruments",
+       "/Applications/Xcode.app/Contents/Applications/Instruments.app/Contents" # Xcode 4.5
+    ].map do |start_path|
+      "#{start_path}/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate"
+    end
+
+    locations.each { |path| return path if File.exists?(path) }
+    raise "Can't find Instruments template (tried #{locations.join(', ')})"
+  end
+end

data/lib/feature.rb

@@ -27,11 +27,13 @@ class Zucchini::Feature
     end
   end
   
-  def screenshots
+  def screenshots(process = true)
     @screenshots ||= Dir.glob("#{run_data_path}/Run\ 1/*.png").map do |file|
       screenshot = Zucchini::Screenshot.new(file, @device)
-      screenshot.mask
-      screenshot.compare
+      if process
+        screenshot.mask
+        screenshot.compare
+      end
       screenshot
     end + unmatched_pending_screenshots
   end
@@ -92,4 +94,14 @@ class Zucchini::Feature
       yield
     end
   end
+
+  def approve(reference_type)
+    raise "Directory #{path} doesn't contain previous run data" unless File.exists?("#{run_data_path}/Run\ 1")
+
+    screenshots(false).each do |s|
+      reference_file_path = "#{File.dirname(s.file_path)}/../../#{reference_type}/#{device[:screen]}/#{s.file_name}"
+      FileUtils.mkdir_p File.dirname(reference_file_path)
+      @succeeded = FileUtils.copy_file(s.file_path, reference_file_path)
+    end
+  end
 end

data/lib/runner.rb

@@ -1,7 +1,5 @@
-class Zucchini::Runner < Clamp::Command
-  attr_reader :features
-
-  parameter "PATH", "a path to feature or a directory to run"
+class Zucchini::Runner < Zucchini::Detector
+  parameter "PATH", "a path to feature or a directory"
 
   option %W(-c --collect), :flag, "only collect the screenshots from the device"
   option %W(-p --compare), :flag, "perform screenshots comparison based on the last collection"
@@ -9,21 +7,7 @@ class Zucchini::Runner < Clamp::Command
 
   option "--ci",           :flag, "produce a CI version of the report after comparison"
 
-  def execute
-    raise "Directory #{path} does not exist" unless File.exists?(path)
-
-    @path = File.expand_path(path)
-    Zucchini::Config.base_path = File.exists?("#{path}/feature.zucchini") ? File.dirname(path) : path
-
-    raise "ZUCCHINI_DEVICE environment variable not set" unless ENV['ZUCCHINI_DEVICE']
-    @device = Zucchini::Config.device(ENV['ZUCCHINI_DEVICE'])
-
-    @template = detect_template
-
-    exit run_features
-  end
-
-  def run_features
+  def run_command
     compare_threads = {}
 
     features.each do |f|
@@ -45,44 +29,4 @@ class Zucchini::Runner < Clamp::Command
 
     features.inject(true){ |result, feature| result &= feature.succeeded }
   end
-
-  def features
-    @features ||= detect_features(@path)
-  end
-
-  def detect_features(path)
-    features = []
-    if File.exists?("#{path}/feature.zucchini")
-      features << Zucchini::Feature.new(path)
-    else
-      raise detection_error(path) if Dir["#{path}/*"].empty?
-
-      Dir.glob("#{path}/*").each do |dir|
-          unless dir.match /support/
-          if File.exists?("#{dir}/feature.zucchini")
-            features << Zucchini::Feature.new(dir)
-          else
-            raise detection_error(dir)
-          end
-        end
-      end
-    end
-    features
-  end
-
-  def detection_error(path)
-    "#{path} is not a feature directory"
-  end
-
-  def detect_template
-    locations = [
-      `xcode-select -print-path`.gsub(/\n/, '') + "/Platforms/iPhoneOS.platform/Developer/Library/Instruments",
-       "/Applications/Xcode.app/Contents/Applications/Instruments.app/Contents" # Xcode 4.5
-    ].map do |start_path|
-      "#{start_path}/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate"
-    end
-
-    locations.each { |path| return path if File.exists?(path) }
-    raise "Can't find Instruments template (tried #{locations.join(', ')})"
-  end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Zucchini
-  VERSION = "0.5.7"
+  VERSION = "0.5.8"
 end

data/spec/lib/{runner_spec.rb → detector_spec.rb}

@@ -1,29 +1,29 @@
 require 'spec_helper'
 
-describe Zucchini::Runner do
-  before (:each) do
-    runner.path = "spec/sample_setup/feature_one"
+describe Zucchini::Detector do
+  before do
+    detector.path = "spec/sample_setup/feature_one"
     ENV['ZUCCHINI_DEVICE'] = 'My iDevice'
   end 
    
-  let (:runner) { Zucchini::Runner.new(nil) }
-  
+  let (:detector) { Zucchini::Detector.new(nil) }
+
   describe "execute" do
-    subject { lambda { runner.execute } }
+    subject { lambda { detector.execute } }
     
     context "feature directory doesn't exist" do
-      before { runner.path = "spec/sample_setup/erroneous_feature" }
+      before { detector.path = "spec/sample_setup/erroneous_feature" }
       it     { should raise_error "Directory spec/sample_setup/erroneous_feature does not exist" }
     end
-    
+
     context "device hasn't been found" do
       before { ENV['ZUCCHINI_DEVICE'] = 'My Android Phone' }
       it     { should raise_error "Device not listed in config.yml" }
     end
   end
-  
+
   describe "detect features" do
-    subject { lambda { runner.detect_features(@path) } }
+    subject { lambda { detector.detect_features(@path) } }
     
     context "path to a single feature" do
       before { @path = "spec/sample_setup/feature_one" }
@@ -35,7 +35,7 @@ describe Zucchini::Runner do
     context "path to a directory with features" do
       before { @path = File.expand_path("spec/sample_setup") }
       it "should detect all features in it" do
-        subject.call.length.should eq 2
+        subject.call.length.should eq 3
       end
     end
     

data/spec/lib/feature_spec.rb

@@ -29,4 +29,41 @@ describe Zucchini::Feature do
       end
     end
   end
+
+  describe "approve" do
+    subject { lambda { feature.approve "reference" } }
+
+    context "no previous run data" do
+      before { feature.path = './spec/sample_setup/feature_three' }
+      it { should raise_error "Directory ./spec/sample_setup/feature_three doesn't contain previous run data" }
+    end
+
+    context "copies screenshots to reference directory" do
+      before do
+        feature.path = './spec/sample_setup/feature_three'
+        feature.device = {screen: 'retina_ios5'}
+
+        # Copying some random image to run screenshots.
+        @screenshot_path = "#{feature.path}/run_data/Run\ 1/screenshot.png"
+        FileUtils.mkdir_p(File.dirname(@screenshot_path))
+        FileUtils.copy_file("./spec/sample_setup/feature_one/reference/retina_ios5/06_sign up_spinner.png", @screenshot_path)
+      end
+
+      it "should copy screenshot to reference directory" do
+        feature.approve "reference"
+        (File.exists? "#{feature.path}/reference/retina_ios5/screenshot.png").should eq true
+      end
+
+      it "should copy screenshot to pending directory" do
+        feature.approve "pending"
+        (File.exists? "#{feature.path}/pending/retina_ios5/screenshot.png").should eq true
+      end
+
+      after do
+        FileUtils.rm_rf("#{feature.path}/run_data")
+        FileUtils.rm_rf("#{feature.path}/reference")
+        FileUtils.rm_rf("#{feature.path}/pending")
+      end
+    end
+  end
 end

data/spec/sample_setup/feature_three/feature.zucchini

@@ -0,0 +1 @@
+# Start on the "Menu" screen

data/spec/spec_helper.rb

@@ -6,8 +6,10 @@ require 'lib/config'
 require 'lib/screenshot'
 require 'lib/report'
 require 'lib/feature'
+require 'lib/detector'
 require 'lib/runner'
 require 'lib/generator'
+require 'lib/approver'
 
 RSpec.configure do |config|
   config.color_enabled = true

data/zucchini-ios.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   s.date        = Date.today.to_s
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Vasily Mikhaylichenko", "Rajesh Kumar", "Kevin O'Neill"]
+  s.license     = "BSD"
   s.email       = ["vaskas@zucchiniframework.org"]
   s.homepage    = "http://www.zucchiniframework.org"
   s.summary     = %q{Functional testing framework for iOS-powered devices}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zucchini-ios
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -74,10 +74,13 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/zucchini
+- lib/approver.rb
 - lib/config.rb
+- lib/detector.rb
 - lib/feature.rb
 - lib/generator.rb
 - lib/report.rb
@@ -94,16 +97,17 @@ files:
 - lib/uia/screen.coffee
 - lib/version.rb
 - spec/lib/config_spec.rb
+- spec/lib/detector_spec.rb
 - spec/lib/feature_spec.rb
 - spec/lib/generator_spec.rb
 - spec/lib/report_spec.rb
-- spec/lib/runner_spec.rb
 - spec/lib/screenshot_spec.rb
 - spec/sample_setup/feature_one/feature.zucchini
 - spec/sample_setup/feature_one/masks/retina_ios5/06_sign up_spinner.png
 - spec/sample_setup/feature_one/reference/retina_ios5/06_sign up_spinner.png
 - spec/sample_setup/feature_one/reference/retina_ios5/06_sign up_spinner_error.png
 - spec/sample_setup/feature_one/run_data/Run 1/06_sign up_spinner.png
+- spec/sample_setup/feature_three/feature.zucchini
 - spec/sample_setup/feature_two/feature.zucchini
 - spec/sample_setup/feature_two/masks/retina_ios5/06_sign up_spinner.png
 - spec/sample_setup/feature_two/reference/retina_ios5/06_sign up_spinner.png
@@ -128,7 +132,8 @@ files:
 - templates/project/features/support/screens/welcome.coffee
 - zucchini-ios.gemspec
 homepage: http://www.zucchiniframework.org
-licenses: []
+licenses:
+- BSD
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -147,22 +152,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Functional testing framework for iOS-powered devices
 test_files:
 - spec/lib/config_spec.rb
+- spec/lib/detector_spec.rb
 - spec/lib/feature_spec.rb
 - spec/lib/generator_spec.rb
 - spec/lib/report_spec.rb
-- spec/lib/runner_spec.rb
 - spec/lib/screenshot_spec.rb
 - spec/sample_setup/feature_one/feature.zucchini
 - spec/sample_setup/feature_one/masks/retina_ios5/06_sign up_spinner.png
 - spec/sample_setup/feature_one/reference/retina_ios5/06_sign up_spinner.png
 - spec/sample_setup/feature_one/reference/retina_ios5/06_sign up_spinner_error.png
 - spec/sample_setup/feature_one/run_data/Run 1/06_sign up_spinner.png
+- spec/sample_setup/feature_three/feature.zucchini
 - spec/sample_setup/feature_two/feature.zucchini
 - spec/sample_setup/feature_two/masks/retina_ios5/06_sign up_spinner.png
 - spec/sample_setup/feature_two/reference/retina_ios5/06_sign up_spinner.png