zucchini-ios 0.5.3

data/lib/uia/base.coffee

@@ -0,0 +1,63 @@
+Function::bind = (context) ->
+  return this unless context
+  fun = this
+  ->
+    fun.apply context, arguments
+    
+String::camelCase = ->
+  @replace /([\-\ ][A-Za-z])/g, ($1) ->
+    $1.toUpperCase().replace /[\-\ ]/g, ""
+
+extend = (obj, mixin) ->
+  obj[name] = method for name, method of mixin        
+  obj
+
+puts = (text) ->
+  UIALogger.logMessage text
+
+target = UIATarget.localTarget()
+view   = target.frontMostApp().mainWindow()
+
+target.waitForElement = (element) ->
+  return  unless element
+  found = false
+  counter = 0
+  while not found and (counter < 10)
+    if element.isValid() and element.isVisible()
+      found = true
+      puts "Got the awaited element: #{element}"
+      @delay 1
+    else
+      @delay 0.5
+      counter++
+
+screensCount = 0
+target.captureScreenWithName_ = target.captureScreenWithName
+target.captureScreenWithName = (screenName) ->
+  screensCountText = (if (++screensCount < 10) then "0" + screensCount else screensCount)
+  @captureScreenWithName_ screensCountText + "_" + screenName
+                                                         
+class Zucchini
+  @run: (featureText) ->
+    sections = featureText.trim().split(/\n\s*\n/)
+
+    for section in sections
+      lines = section.split(/\n/)
+
+      screenMatch = lines[0].match(/.+ on the "([^"]*)" screen:$/)
+      throw "Line '#{lines[0]}' doesn't define a screen context" unless screenMatch
+
+      screenName = screenMatch[1]
+      try
+        screen = eval("new #{screenName.camelCase()}Screen")
+      catch error
+        throw "Screen '#{screenName}' not defined"
+
+      for line in lines.slice(1)
+         functionFound = false
+         for regExpText, func of screen.actions
+            match = line.trim().match(new RegExp(regExpText))
+            if match
+              functionFound = true
+              func.bind(screen)(match[1])
+         throw "Action for line '#{line}' not defined" unless functionFound

data/lib/uia/screen.coffee

@@ -0,0 +1,21 @@
+class Screen
+  constructor: (@name) ->
+    if @anchor then target.waitForElement @anchor()
+  
+  elements: {}                           
+  actions :
+    'Take a screenshot$' : ->
+      target.captureScreenWithName(@name)
+
+    'Take a screenshot named "([^"]*)"$' : (name) ->
+      target.captureScreenWithName(name)
+
+    'Tap "([^"]*)"$' : (element) ->
+      throw "Element '#{element}' not defined for the screen '#{@name}'" unless @elements[element]
+      @elements[element]().tap()
+
+    'Wait for "([^"]*)" second[s]*$' : (seconds) ->
+      target.delay(seconds)
+
+    'Confirm "([^"]*)"$' : (element) ->
+      @actions['Tap "([^"]*)"$'].bind(this)(element)

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Zucchini
+  VERSION = "0.5.3"
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Zucchini::Config do
+  before(:all) { Zucchini::Config.base_path = "spec/sample_setup" }
+  
+  describe "device" do
+   context "device present in config.yml" do
+    it "should return the device hash" do
+      Zucchini::Config.device("My iDevice").should eq({:name =>"My iDevice", :udid =>"lolffb28d74a6fraj2156090784avasc50725dd0", :screen =>"ipad_ios5"})
+    end
+   end
+   
+   context "device not present in config.yml" do
+     it "should raise an error" do
+       expect { Zucchini::Config.device("My Android Phone")}.to raise_error "Device not listed in config.yml"
+     end
+    end
+  end
+  
+  describe "url" do
+    it "should return a full URL string for a given server name" do
+      Zucchini::Config.url('backend', '/api').should eq "http://192.168.1.2:8080/api"
+    end
+  end
+end

data/spec/lib/generator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Zucchini::Generator do
+  let(:project_path) { "/tmp/z_test_project" }
+  let(:feature_path) { "#{project_path}/features/rspec_feature" }
+  let(:generator)    { Zucchini::Generator.new(nil) }
+  
+  after(:all) { FileUtils.rm_rf(project_path) }
+  
+  context "generate a project" do
+    before { generator.path = project_path }
+    it "should create a project directory" do
+      generator.stub!(:project?).and_return(true)
+      generator.execute
+      File.exists?("#{project_path}/features/support/config.yml").should be_true
+    end
+  end
+  
+  context "generate a feature" do
+    before { generator.path = feature_path }
+    it "should create a feature directory" do
+      generator.stub!(:feature?).and_return(true)
+      generator.execute
+      File.exists?("#{feature_path}/feature.zucchini").should be_true
+    end
+  end
+end

data/spec/lib/report_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Zucchini::Report do
+  let (:device) { { :name => "iPad 2", :screen => "ipad_ios5", :udid => "rspec012345" } }
+  let (:feature) do
+    fake_screenshots = (1..7).to_a.map do |num|
+      screenshot = Zucchini::Screenshot.new("#{num}.screen_#{num}.png", device)
+      screenshot.diff = (num > 3) ? [:passed, nil] : [:failed, "120\n"]
+      screenshot
+    end
+    
+    feature = Zucchini::Feature.new("/my/sample/feature")
+    feature.device = device
+    feature.stub!(:screenshots).and_return(fake_screenshots)
+    feature
+  end
+  
+  describe "text" do
+    it "should return the correct summary text" do
+      Zucchini::Report.text([feature]).should eq "feature:\n4 passed, 3 failed, 0 pending\n\nFailed:\n   1.screen_1.png: 120\n   2.screen_2.png: 120\n   3.screen_3.png: 120\n"
+    end
+  end
+  
+  describe "HTML" do
+    let(:report_html_path) { "/tmp/zucchini_rspec_report.html" }
+    after { FileUtils.rm(report_html_path) }
+    
+    it "should produce a a correct HTML report" do
+      report = File.open(Zucchini::Report.html([feature], false, report_html_path)).read
+      report.scan(/<dl class="passed.*screen/).length.should eq 4
+      report.scan(/<dl class="failed.*screen/).length.should eq 3
+    end
+  end
+end

data/spec/lib/runner_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Zucchini::Runner do
+  before (:each) do
+    runner.path = "spec/sample_setup/feature_one"
+    ENV['ZUCCHINI_DEVICE'] = 'My iDevice'
+  end 
+   
+  let (:runner) { Zucchini::Runner.new(nil) }
+  
+  describe "execute" do
+    subject { lambda { runner.execute } }
+    
+    context "feature directory doesn't exist" do
+      before { runner.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) } }
+    
+    context "path to a single feature" do
+      before { @path = "spec/sample_setup/feature_one" }
+      it "should detect it" do
+        subject.call[0].path.should eq @path
+      end
+    end
+    
+    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
+      end
+    end
+    
+    context "path to a non-feature directory" do
+      before do
+        @path = File.expand_path("spec/sample_setup/bad_feature")
+        FileUtils.mkdir(@path)
+      end
+      
+      it    { should raise_error }
+      after { FileUtils.rmdir(@path) }
+    end
+  end
+end

data/spec/lib/screenshot_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'digest/md5'
+
+def md5(blob)
+  Digest::MD5.hexdigest(blob)
+end
+
+describe Zucchini::Screenshot do
+  let (:device)        { { :name => "iPhone 4S", :screen => "retina_ios5", :udid => "rspec987654" } }
+  let (:base_path)     { "spec/sample_setup/feature_one" }
+  let (:original_path) { "#{base_path}/run_data/Run\ 1/06_sign\ up_spinner.png" }
+  
+  let (:screenshot) do
+    screenshot = Zucchini::Screenshot.new(original_path, device)
+    screenshot.masked_paths = { :globally => "#{base_path}/globally_masked.png", :specifically => "#{base_path}/specifically_masked.png" }
+    screenshot.mask
+    screenshot
+  end
+  
+  after(:all) do
+    screenshot.masked_paths.each { |k, path| FileUtils.rm(path) }
+    FileUtils.rm_rf("#{base_path}/run_data/Masked")
+    FileUtils.rm_rf(screenshot.diff_path)
+  end
+  
+  describe "mask" do
+    before(:all) do
+      @md5 = {
+        :original            => md5(File.read(original_path)),
+        :globally_masked     => md5(File.read(screenshot.masked_paths[:globally])),
+        :specifically_masked => md5(File.read(screenshot.masked_paths[:specifically]))
+      }
+    end
+    
+    it "should apply a standard global mask based on the screen" do
+      File.exists?(screenshot.masked_paths[:globally]).should be true
+      @md5[:globally_masked].should_not be_equal @md5[:original]
+    end
+    
+    it "should apply a screenshot-specific mask if it exists" do
+      File.exists?(screenshot.masked_paths[:specifically]).should be true
+      @md5[:specifically_masked].should_not be_equal @md5[:original]
+      @md5[:specifically_masked].should_not be_equal @md5[:globally_masked]
+    end
+  end                                                        
+  
+  describe "compare" do
+    context "images are identical" do
+      it "should have a passed indicator in the diff" do
+        screenshot.compare
+        screenshot.diff.should eq [:passed, nil]
+      end
+    end
+    
+    context "images are different" do
+      it "should have a failed indicator in the diff" do
+        screenshot.stub!(:mask_reference)
+        screenshot.test_path = "#{base_path}/reference/#{device[:screen]}/06_sign\ up_spinner_error.png"
+        screenshot.compare
+        screenshot.diff.should eq [:failed, "3017\n"]
+      end
+    end
+  end
+  
+  describe "mask reference" do
+    it "should create masked versions of reference screenshots" do
+      screenshot.mask_reference
+      
+      File.exists?(screenshot.test_path).should be_true
+      md5(File.read(screenshot.test_path)).should_not be_equal md5(File.read("#{base_path}/reference/#{device[:screen]}/06_sign\ up_spinner.png"))
+    end
+  end
+end

data/spec/sample_setup/feature_one/feature.zucchini

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

data/spec/sample_setup/feature_two/feature.zucchini

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

data/spec/sample_setup/support/config.yml

@@ -0,0 +1,13 @@
+app: MyApp.app
+template: '/Developer/Platforms/iPhoneOS.platform/Developer/Library/Instruments/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate'
+
+devices:
+  My iDevice: 
+    UDID  : lolffb28d74a6fraj2156090784avasc50725dd0
+    screen: ipad_ios5
+
+
+servers:
+  backend:
+    host: 192.168.1.2
+    port: 8080

data/spec/sample_setup/support/screens/splash.coffee

@@ -0,0 +1,8 @@
+class SplashScreen extends Screen
+  anchor: -> view.elements()["Welcome"]
+  
+  constructor: ->
+    super 'splash'
+    
+    extend @elements,
+    'Go' : -> view.buttons()["Go"]

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'clamp'
+require 'fileutils'
+
+$LOAD_PATH << File.expand_path("#{File.dirname(__FILE__)}/..")
+require 'lib/config'
+require 'lib/screenshot'
+require 'lib/report'
+require 'lib/feature'
+require 'lib/runner'
+require 'lib/generator'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  #config.formatter = :documentation
+end

data/templates/feature/feature.zucchini

@@ -0,0 +1,6 @@
+# Start on the "Welcome" screen:
+# 	Take a screenshot named "welcome_first_boot"
+# 	Type "Zucchini" in the username field
+# 	Tap "Go"  
+	 
+	

data/templates/feature/run_data/.gitignore

@@ -0,0 +1,5 @@
+feature.*
+report.html
+Run\ *
+Diff/
+Masked/

data/templates/feature/setup.rb

@@ -0,0 +1,10 @@
+class Setup
+  def self.before
+    # do useful stuff
+    yield
+  end
+  
+  def self.after
+    # clean up
+  end
+end

data/templates/project/features/support/config.yml

@@ -0,0 +1,13 @@
+app: MyApp.app
+template: '/Developer/Platforms/iPhoneOS.platform/Developer/Library/Instruments/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate'
+
+devices:
+  My iDevice: 
+    UDID  : lolffb28d74a6fraj2156090784avasc50725dd0
+    screen: retina_ios5
+
+
+servers:
+  backend:
+    host: 192.168.1.2
+    port: 8080

data/templates/project/features/support/screens/welcome.coffee

@@ -0,0 +1,13 @@
+class WelcomeScreen extends Screen
+  anchor: -> view.elements()["Welcome to MyApp"]
+  
+  constructor: ->
+    super 'welcome'
+    
+    extend @elements,
+    'Go' : -> view.buttons()["Go"]
+    
+    extend @actions,
+    'Type "([^"]*)" in the username field$': (text) ->
+      field = view.elements()['Username']
+      field.setValue text

data/zucchini.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'version'
+
+Gem::Specification.new do |s|
+  s.name        = "zucchini-ios"
+  s.version     = Zucchini::VERSION
+  s.date        = Date.today.to_s
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Vasily Mikhaylichenko", "Rajesh Kumar", "Kevin O'Neill"]
+  s.email       = ["vasily@playup.com"]
+  s.homepage    = "http://www.zucchiniframework.org"
+  s.summary     = %q{Functional testing framework for iOS-powered devices}
+  s.description = %q{Zucchini follows simple walkthrough scenarios for your iOS app, takes screenshots and compares them to the reference ones.}
+
+  s.add_runtime_dependency "clamp"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "watchr"
+
+  s.files              = `git ls-files | grep -vE '(web|.watchr)'`.split("\n")
+  s.test_files         = `git ls-files -- spec/*`.split("\n")
+  s.executables        = %w(zucchini)
+  s.require_paths      = ["lib"]
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: zucchini-ios
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.5.3
+platform: ruby
+authors: 
+- Vasily Mikhaylichenko
+- Rajesh Kumar
+- Kevin O'Neill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: clamp
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Zucchini follows simple walkthrough scenarios for your iOS app, takes screenshots and compares them to the reference ones.
+email: 
+- vasily@playup.com
+executables: 
+- zucchini
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- bin/zucchini
+- lib/config.rb
+- lib/feature.rb
+- lib/generator.rb
+- lib/report.rb
+- lib/report/css/zucchini.report.css
+- lib/report/js/jquery.effects.core.js
+- lib/report/js/jquery.js
+- lib/report/js/jquery.ui.core.js
+- lib/report/js/zucchini.report.js
+- lib/report/template.erb
+- lib/report/view.rb
+- lib/runner.rb
+- lib/screenshot.rb
+- lib/uia/base.coffee
+- lib/uia/screen.coffee
+- lib/version.rb
+- spec/lib/config_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_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
+- spec/sample_setup/feature_two/reference/retina_ios5/06_sign up_spinner_error.png
+- spec/sample_setup/feature_two/run_data/Run 1/06_sign up_spinner.png
+- spec/sample_setup/support/config.yml
+- spec/sample_setup/support/masks/retina_ios5.png
+- spec/sample_setup/support/screens/splash.coffee
+- spec/spec_helper.rb
+- templates/feature/feature.zucchini
+- templates/feature/masks/retina_ios5/.gitkeep
+- templates/feature/pending/retina_ios5/.gitkeep
+- templates/feature/reference/retina_ios5/.gitkeep
+- templates/feature/run_data/.gitignore
+- templates/feature/setup.rb
+- templates/project/features/support/config.yml
+- templates/project/features/support/masks/ipad_ios5.png
+- templates/project/features/support/masks/low_ios4.png
+- templates/project/features/support/masks/retina_ios5.png
+- templates/project/features/support/screens/welcome.coffee
+- zucchini.gemspec
+homepage: http://www.zucchiniframework.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Functional testing framework for iOS-powered devices
+test_files: 
+- spec/lib/config_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_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
+- spec/sample_setup/feature_two/reference/retina_ios5/06_sign up_spinner_error.png
+- spec/sample_setup/feature_two/run_data/Run 1/06_sign up_spinner.png
+- spec/sample_setup/support/config.yml
+- spec/sample_setup/support/masks/retina_ios5.png
+- spec/sample_setup/support/screens/splash.coffee
+- spec/spec_helper.rb