calabash-extras 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in calabash-extras.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    calabash-extras (0.0.1)
+      PriorityQueue
+      calabash-android
+      calabash-cucumber
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.2.7)
+    PriorityQueue (0.1.2)
+    awesome_print (1.1.0)
+    blankslate (2.1.2.4)
+    builder (3.0.4)
+    calabash-android (0.4.19.pre1)
+      awesome_print
+      cucumber
+      escape (~> 0.0.4)
+      httpclient (~> 2.3.2)
+      json
+      retriable (~> 1.3.3.1)
+      rubyzip (~> 0.9.9)
+      slowhandcuke
+      xamarin-test-cloud (>= 0.9.23)
+    calabash-common (0.0.1)
+      cucumber (~> 1.3.0)
+    calabash-cucumber (0.9.167)
+      CFPropertyList
+      awesome_print
+      bundler (~> 1.1)
+      calabash-common (~> 0.0.1)
+      cucumber (~> 1.3.0)
+      edn
+      geocoder (~> 1.1.8)
+      httpclient (~> 2.3.3)
+      json
+      run_loop (~> 0.1.4)
+      sim_launcher (= 0.4.6)
+      slowhandcuke
+      xamarin-test-cloud (~> 0.9.27)
+    cucumber (1.3.10)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    edn (1.0.2)
+      parslet (~> 1.4.0)
+    escape (0.0.4)
+    geocoder (1.1.9)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    httpclient (2.3.4.1)
+    json (1.8.0)
+    mime-types (1.24)
+    multi_json (1.7.9)
+    multi_test (0.0.2)
+    parslet (1.4.0)
+      blankslate (~> 2.0)
+    rack (1.5.2)
+    rack-protection (1.5.2)
+      rack
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    retriable (1.3.3.1)
+    rubyzip (0.9.9)
+    run_loop (0.1.4)
+      json
+      thor
+    sim_launcher (0.4.6)
+      sinatra
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slowhandcuke (0.0.3)
+      cucumber
+    thor (0.18.1)
+    tilt (1.4.1)
+    xamarin-test-cloud (0.9.29)
+      bundler (>= 1.3.0, < 2.0)
+      json
+      mime-types (< 2.0)
+      rest-client (~> 1.6.7)
+      retriable (~> 1.3.3.1)
+      rubyzip (~> 0.9.9)
+      thor (>= 0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  calabash-extras!
+  rake

data/README.md

@@ -0,0 +1,23 @@
+# Calabash::Extras
+
+Utils for using Calabash and page object pattern with minitest framework
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'calabash-extras'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install calabash-extras
+
+## Usage
+
+1. Extend your testcases from Calabash::Extras::TestCase
+2. Add Calabash::Extras::PageObjectComparator page objects for Android and Ios (read more on https://github.com/calabash/x-platform-example)
+3. Link pages of mobile application and use Calabash::Extras::Walker to navigate

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/calabash-extras.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'calabash-extras'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Sergey Galkin']
+  spec.email         = ['sergey@galkin.me']
+  spec.description   = %q{TestCase and page traversal tool for writing xunit tests for Android and Ios apps}
+  spec.summary       = %q{Utils for writing xunit tests with calabash and page objects}
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'calabash-android'
+  spec.add_dependency 'calabash-cucumber'
+  spec.add_dependency 'PriorityQueue'
+end

data/lib/android_runner.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'net/telnet'
+require 'calabash-android/operations'
+require 'calabash-android/abase'
+
+module Calabash
+  module Extras
+    class AndroidRunner
+
+      include Calabash::Android::Operations
+
+      attr_reader :default_device
+
+      def initialize(config)
+        @config = config
+      end
+
+      def start
+        load Gem.bin_path('calabash-android', 'calabash-android')
+
+        path = File.expand_path(@config['apk_path'])
+
+        Emulator.launch(@config['emulator']) if @config['start_emulator']
+
+        build_test_server_if_needed(path)
+        set_default_device(Device.new(self, @config['name'], nil, path, test_server_path(path)))
+      end
+
+      def reinstall_app
+        reinstall_apps
+        sleep 1
+        start_test_server_in_background
+        reinstall_hook if defined? self.reinstall_hook
+      end
+
+      private
+
+      def test_server_path(apk_file_path)
+        @config['test_server_dir'] + "test_servers/#{checksum(apk_file_path)}_#{Calabash::Android::VERSION}.apk"
+      end
+
+      class Emulator
+        def self.launch(config)
+          inst = self.new(config)
+          inst.kill_old
+          inst.run
+        end
+
+        def initialize(config)
+          @cfg = config
+        end
+
+        def run
+          @pid = fork { exec(@cfg['run']) }
+          sleep(@cfg['wait_for_emulator'])
+          unlock
+          sleep(@cfg['sleep_after_launch'])
+        end
+
+        def is_running?
+          defined? @pid && !@pid.nil? && @pid > 0
+        end
+
+        def unlock
+          emulator_cli = Net::Telnet::new('Host' => @cfg['host'], 'Port' => @cfg['port'])
+          emulator_cli.puts('event send EV_KEY:KEY_MENU:1 EV_KEY:KEY_MENU:0')
+          emulator_cli.close
+        end
+
+        def kill
+          Process.kill('QUIT', @pid) if is_running?
+        end
+
+        def kill_old
+          find_pids.each { |pid| Process.kill('QUIT', pid) }
+        end
+
+        protected
+
+        def find_pids
+          #TODO find all pids, not just one
+          command = 'ps ax | grep "/opt/android_sdk/tools/emulator64-x86" | grep -v grep |awk \'{print $1}\''
+          pid = %x(#{command})
+          if pid != '' && pid.to_i > 0
+            [pid.to_i]
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/lib/application_handler.rb

@@ -0,0 +1,41 @@
+module Calabash
+  module Extras
+    class ApplicationHandler
+
+      def initialize(config)
+        @conf = config
+        ENV['SCREENSHOT_PATH'] = @conf['screen_shot_dir']
+        start_device unless defined? @@device
+      end
+
+      def page (clz, *args)
+        @@device.page(clz, *args)
+      end
+
+      def reinstall
+        @@device.reinstall_app
+      end
+
+      def device
+        @@device
+      end
+
+      private
+
+      def start_device
+        case @conf['os']
+          when 'android'
+            require 'android_runner'
+            @@device = Calabash::Extras::AndroidRunner.new(@conf['android'])
+          when 'ios'
+            require 'ios_runner'
+            @@device = Calabash::Extras::IosRunner.new(@conf['ios'])
+          else
+            raise 'Unsupported os type: "%s"' % @conf['os']
+        end
+
+        @@device.start
+      end
+    end
+  end
+end

data/lib/ios_runner.rb

@@ -0,0 +1,35 @@
+require 'calabash-cucumber/operations'
+require 'calabash-cucumber/launcher'
+require 'calabash-cucumber/launch/simulator_helper'
+require 'sim_launcher'
+
+module Calabash
+  module Extras
+    class IosRunner
+
+      include Calabash::Cucumber::Core
+      include Calabash::Cucumber::Operations
+
+      def initialize(config)
+        @config = config
+
+        ENV['DEVICE'] = @config['DEVICE']
+        ENV['PROJECT_DIR'] = @config['PROJECT_DIR']
+        ENV['DEVICE_ENDPOINT'] = @config['DEVICE_ENDPOINT']
+        ENV['BUNDLE_ID'] = @config['BUNDLE_ID']
+      end
+
+      def start
+        reinstall_app
+      end
+
+      def reinstall_app
+        calabash_launcher = Calabash::Cucumber::Launcher.new
+        calabash_launcher.reset_app_jail
+        start_test_server_in_background
+
+        reinstall_hook if defined? self.reinstall_hook
+      end
+    end
+  end
+end

data/lib/page_object_comparator.rb

@@ -0,0 +1,25 @@
+module Calabash
+  module Extras
+    module PageObjectComparator
+      def name
+        self.class.name.rpartition('::').last
+      end
+
+      def ==(other)
+        name == other.name
+      end
+
+      def eql?(other)
+        name == other.name
+      end
+
+      def hash
+        name.hash
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/test_case.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'yaml'
+require 'application_handler'
+
+module Calabash
+  module Extras
+    class TestCase < Test::Unit::TestCase
+      def initialize(name)
+        super name
+        raise 'Config location not found in ENV' unless ENV.has_key? 'config_location'
+        @conf = YAML.load_file ENV['config_location']
+        @runner = Calabash::Extras::ApplicationHandler.new(@conf)
+      end
+
+      def page (clz, *args)
+        @runner.page(clz, *args)
+      end
+
+      def reinstall_force #todo rename
+        @runner.reinstall
+      end
+
+      def platform
+        @conf['os']
+      end
+    end
+  end
+end

data/lib/walker.rb

@@ -0,0 +1,95 @@
+require 'priority_queue'
+
+module Calabash
+  module Extras
+    class Walker
+
+      MAX_INT = (2**(0.size * 8 -2) -1)
+
+      def initialize(sleep_interval, matrix, log_callback)
+        @sleep_interval = sleep_interval
+        @matrix = matrix
+        @logger = log_callback
+      end
+
+      def go(to)
+        start_point = get_current_page
+
+        @end_point = to
+
+        raise 'Page "%s" does not exist' % [to] if @matrix[to].nil?
+
+        return if start_point == @end_point
+
+        path = find_path start_point, @end_point
+
+        raise 'Unable to find path from "%s" to "%s"' % [start_point, @end_point] if path.last != @end_point
+
+        resolve_path path
+      end
+
+      def last
+        @end_point
+      end
+
+      def get_current_page
+        sleep @sleep_interval
+        all_page_elements = @matrix.keys.first.all_elements
+        @matrix.keys.find { |page| page.match all_page_elements} || raise('Unable to determine current page') #todo replace with match method
+      end
+
+      def resolve_path(path)
+        raise 'Empty path given' if path.empty?
+
+        for i in 0..(path.length - 2)
+          @logger.call('transition from %s to %s' % [path[i], path[i+1]])
+          @matrix[path[i]][path[i+1]].call
+        end
+      end
+
+      def find_path(start, finish)
+        distances = {}
+        previous = {}
+        nodes = PriorityQueue.new
+
+        @matrix.each_key do |point|
+          if point == start
+            distances[point] = 0
+            nodes[point] = 0
+          else
+            distances[point] = MAX_INT
+            nodes[point] = MAX_INT
+          end
+          previous[point] = nil
+        end
+
+        while nodes
+          smallest = nodes.delete_min_return_key
+
+          if smallest == finish
+            path = []
+            while previous[smallest]
+              path.push(smallest)
+              smallest = previous[smallest]
+            end
+            return path.push(start).reverse
+          end
+
+          if smallest.nil? or distances[smallest] == MAX_INT
+            break
+          end
+
+          @matrix[smallest].each_key do |neighbor|
+            alt = distances[smallest] + 1
+            if alt < distances[neighbor]
+              distances[neighbor] = alt
+              previous[neighbor] = smallest
+              nodes[neighbor] = alt
+            end
+          end
+        end
+        distances.inspect
+      end
+    end
+  end
+end

data/test/page_object_comparator_test.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require 'page_object_comparator'
+
+class PageObjectComparatorTest < Test::Unit::TestCase
+
+  class DummyBasePage
+
+    include Calabash::Extras::PageObjectComparator
+
+    def initialize(value)
+      @value = value
+    end
+  end
+
+  class Page1 < DummyBasePage; end
+  class Page2 < DummyBasePage; end
+
+  def test_instances_of_same_class
+    page1 = Page1.new 'value'
+    page2 = Page1.new 'other'
+
+    assert_equal page1.hash, page2.hash, 'Hash should be unique per class, not instance'
+    assert_equal page1, page2, 'Object should be compared by class, not instance'
+  end
+
+  def test_instances_of_different_classes
+    page1 = Page1.new 'same value'
+    page2 = Page2.new 'same value'
+
+    refute_equal page1.hash, page2.hash, 'Hash should be unique per class, not instance'
+    refute_equal page1, page2, 'Object should be compared by class, not instance'
+  end
+end

data/test/walker_test.rb

@@ -0,0 +1,144 @@
+require 'test/unit'
+require 'walker'
+require 'page_object_comparator'
+
+class WalkerTest < Test::Unit::TestCase
+
+  class BaseDummyPage
+    include Calabash::Extras::PageObjectComparator
+    attr_accessor :will_match, :called, :back_called
+
+    def initialize
+      @called = false
+      @back_called = false
+    end
+
+    def all_elements
+      'list of all elements in string'
+    end
+
+    def match(all_elements)
+      @will_match
+    end
+
+    def go
+      @called = true
+    end
+
+    def back
+      @back_called = true
+    end
+  end
+
+  class EulaDummyPage < BaseDummyPage; end
+  class LoginDummyPage < BaseDummyPage; end
+  class MainMenuDummyPage < BaseDummyPage; end
+  class UnreachablePage < BaseDummyPage; end
+  class DeadEndPage < BaseDummyPage; end
+  class NonExistentPage < BaseDummyPage; end
+  class RefundDummyPage < BaseDummyPage; end
+  class OrderHistoryDummyPage < BaseDummyPage; end
+  class OrderInfoDummyPage < BaseDummyPage; end
+
+  def setup
+    @eula = EulaDummyPage.new
+    @login = LoginDummyPage.new
+    @main_menu = MainMenuDummyPage.new
+    @unreachable = UnreachablePage.new
+    @not_existent = NonExistentPage.new
+    @order_history = OrderHistoryDummyPage.new
+    @order_info = OrderInfoDummyPage.new
+    @refund = RefundDummyPage.new
+
+    @matrix = {
+        @eula => {
+            @login => lambda { @eula.go },
+        },
+        @login => {
+            @main_menu => lambda { @login.go },
+            @eula => lambda { @main_menu.back }
+        },
+        @main_menu => {
+            @login => lambda { @main_menu.back },
+            @order_history => lambda { @main_menu.go }
+        },
+        @order_history => {
+            @main_menu => lambda { @order_history.back },
+            @order_info => lambda { @order_history.go }
+        },
+        @order_info => {
+            @order_history => lambda { @order_info.back },
+            @refund => lambda { @order_info.go }
+        },
+        @refund => {
+            @order_info => lambda { @refund.back }
+        },
+        @unreachable => {
+            # unreachable
+        }
+    }
+
+    @walker = Calabash::Extras::Walker.new(0, @matrix, lambda { |str| } )
+  end
+
+  def test_refund_to_main_menu
+    @refund.will_match = true
+    @walker.go @main_menu
+
+    assert_back_called @refund
+    assert_back_called @order_info
+    assert_back_called @order_history
+  end
+
+  def test_eula_to_refund_page
+    @eula.will_match = true
+    @walker.go @refund
+
+    assert_called @eula
+    assert_called @login
+    assert_called @main_menu
+    assert_called @order_history
+    assert_called @order_info
+    assert_called @order_info
+  end
+
+  def test_unreachable
+    @eula.will_match = true
+
+    err = assert_raise RuntimeError do
+      @walker.go @unreachable
+    end
+
+    assert_equal 'Unable to find path from "%s" to "%s"' % [@eula, @unreachable.name], err.message
+  end
+
+  def test_not_found
+    @eula.will_match = true
+
+    err = assert_raise RuntimeError do
+      @walker.go @not_existent
+    end
+
+    assert_equal 'Page "%s" does not exist' % [@not_existent], err.message
+  end
+
+  def test_unable_to_determine_current_page
+
+  end
+
+  private
+
+  def assert_called (page, method = :go)
+    assert page.called, 'Call to method "%s" of page %s was expected' % [method, page.name]
+  end
+
+  def assert_back_called (page)
+    assert page.back_called, 'Call to method "back" of page %s was expected' % [page.name]
+  end
+end
+
+
+
+
+
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: calabash-extras
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey Galkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: calabash-android
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: calabash-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: PriorityQueue
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: TestCase and page traversal tool for writing xunit tests for Android
+  and Ios apps
+email:
+- sergey@galkin.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- calabash-extras.gemspec
+- lib/android_runner.rb
+- lib/application_handler.rb
+- lib/ios_runner.rb
+- lib/page_object_comparator.rb
+- lib/test_case.rb
+- lib/walker.rb
+- test/page_object_comparator_test.rb
+- test/walker_test.rb
+homepage: 
+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.23
+signing_key: 
+specification_version: 3
+summary: Utils for writing xunit tests with calabash and page objects
+test_files:
+- test/page_object_comparator_test.rb
+- test/walker_test.rb