web_console 0.5.8

data/lib/start.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+require 'rubygems'
+require 'spec' # https://github.com/bootstraponline/spec
+require 'selenium-webdriver'
+require 'page-object' # https://github.com/cheezy/page-object
+
+$driver = Selenium::WebDriver.for :firefox
+$driver.manage.timeouts.implicit_wait = 30 # seconds
+
+# Load minitest
+begin
+  require 'minitest'
+  require 'minitest/spec'
+  # set current_spec. fixes:
+  # NoMethodError: undefined method `assert_equal' for nil:NilClass
+  Minitest::Spec.new 'pry'
+rescue
+end
+
+module Pages; end
+
+# Promote methods to top level for Pry
+# Pages module is hard coded.
+def promote_page_object_methods
+  ::Pages.constants.each do |class_name|
+    puts "Promoting class_name as method #{class_name.to_s.downcase}"
+    Kernel.send(:define_method, class_name.to_s.downcase) do
+      Pages.const_get(class_name)
+    end
+  end
+end
+
+def reload
+  Pry.send :_reload
+  promote_page_object_methods
+  nil
+end
+
+def set_wait seconds
+  $driver.manage.timeouts.implicit_wait = seconds
+end
+
+# -- helper methods
+module Kernel
+  def id id
+    $driver.find_elements(:id, id).detect { |ele| ele.displayed? }
+  end
+
+  def css css
+    $driver.find_elements(:css, css).detect { |ele| ele.displayed? }
+  end
+
+  def xpath xpath
+    $driver.find_elements(:xpath, xpath).detect { |ele| ele.displayed? }
+  end
+
+  def link text
+    xpath("//a[text()='#{text}']")
+  end
+
+  def input input
+    xpath("//input[@value='#{input}']")
+  end
+end
+# --
+
+def x
+  $driver.quit if $driver
+  exit
+end
+
+# Ensure page objects are loaded
+reload
+# Default wait to 0
+set_wait 0
+
+# Don't print page objects
+# default print code from https://github.com/pry/pry/blob/master/lib/pry.rb
+# pry-0.9.12.3
+Pry.config.print = proc do |output, value|
+  unless value.nil? || value.inspect.to_s.include?('SeleniumWebDriver::PageObject')
+    Pry::output_with_default_format(output, value, :hashrocket => true)
+  end
+end
+
+# loop through all pages and output the methods
+def page
+  Pages.constants.each do |page|
+    methods = Pages.const_get(page).singleton_methods
+    methods.each { |m| puts "#{page.to_s.downcase}.#{m}" }
+  end
+  nil
+end

data/lib/web_console.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'rubygems'
+Gem::Specification.class_eval { def self.warn( args ); end }
+require 'pry'
+require 'awesome_print'
+
+module Appium; end unless defined? Appium
+
+def define_reload paths
+  Pry.send(:define_singleton_method, :_reload) do
+    paths.each do |p|
+      # If a page obj is deleted then load will error.
+      begin
+        load p
+      rescue # LoadError: cannot load such file
+      end
+    end
+  end
+  nil
+end
+
+module Appium::Console
+  AwesomePrint.pry!
+  pwd = Dir.pwd
+  to_require = pwd + '/appium.txt'
+
+  start = File.expand_path '../start.rb', __FILE__
+  cmd = ['-r', start]
+
+  if File.exists?(to_require)
+    to_require = File.read(to_require).split("\n").map do |line|
+      unless File.exists?(line)
+        line = File.join(pwd, line)
+      end
+
+      if File.exists?(line)
+        if File.directory?(line)
+          found = []
+          Dir.glob(File.join(line, '**/*.rb')) { |f| found << File.expand_path(f) }
+          found
+        else
+          File.expand_path line
+        end
+      else
+        nil
+      end
+    end.flatten.compact # remove nested arrays & nils
+
+    define_reload to_require
+  else
+    puts "This folder doesn't contain an appium.txt listing page objects"
+    exit
+  end
+
+  $stdout.puts "pry #{cmd.join(' ')}"
+  Pry::CLI.parse_options cmd
+end # module Appium::Console

data/lib/web_console/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+# Define Appium module so version can be required directly.
+module Appium; end unless defined? Appium
+module Appium::Console
+  VERSION = '0.5.8' unless defined? ::Appium::Console::VERSION
+  DATE = '2013-12-11' unless defined? ::Appium::Console::DATE
+end

data/osx.md

@@ -0,0 +1,274 @@
+### Getting Started
+
+This document is written for OS X 10.8.4 or better. iOS testing requires OS X. Android testing works on OS X, Windows, and Linux. 
+
+For OS X, there is rake script which will attempt to do most of this for you, with
+```
+rake -f osx_install.rake
+```
+The rake script will not install Xcode, etc., nor Java, but should take care of everything else. 
+Changes to these instructions might imply changes to that script as well.
+
+#### Steps to install
+
+Install `Xcode` 4.6.3 (iOS 6) or 5.0.0 (iOS 7).
+
+- Xcode 5.0.0 shouldn't be used for iOS 6 as it's flaky.
+- Xcode 5.0.1 is broken.
+- Xcode 4.6.3 doesn't support iOS 7.
+
+After that, install the command line build tools (Xcode -> Preferences -> Downloads).
+ 
+If you're testing iOS 6, then install `Xcode 4.6.3` from [Apple](https://developer.apple.com/downloads/index.action).
+For iOS 7+ make sure to use Xcode 5.
+
+That done, you'll need to create a symlink for
+`gcc` to get the ruby build (particularly FFI) to install properly. This isn't required on OS X 10.9.
+If `/usr/local/bin` is in your path, you can do:
+```
+ln -s /usr/bin/gcc /usr/local/bin/gcc-4.2
+```
+Otherwise
+```
+sudo ln -s /usr/bin/gcc /usr/bin/gcc-4.2
+```
+Reinstall Ruby if you didn't set this symlink and have FFI issues.
+
+- Install Java 7 if there's no Java on the system.
+  - [JDK 7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+
+- Install the latest stable patch release of Ruby 2.0.
+
+`$ \curl -L https://get.rvm.io | bash -s stable --ruby=2.0.0`
+
+- Make sure RVM is using the correct Ruby by default
+
+```
+$ rvm list
+$ rvm --default use 2.0.0
+```
+
+- If you have an old ruby, you can installing Ruby 2.0 instead
+
+```
+$ rvm get head
+$ rvm autolibs homebrew
+$ rvm install 2.0.0
+```
+
+- Check that it's installed properly by printing the ruby version.
+
+`$ ruby --version`
+
+- Update RubyGems and Bundler.
+
+```ruby
+gem update --system ;\
+gem install --no-rdoc --no-ri bundler ;\
+gem update ;\
+gem cleanup
+```
+
+- Check that RubyGems is >= 2.1.5
+
+```bash
+$ gem --version
+2.1.5
+```
+
+- Install appium_console gem.
+
+```ruby
+gem uninstall -aIx appium_lib ;\
+gem uninstall -aIx appium_console ;\
+gem install --no-rdoc --no-ri appium_console
+```
+
+- Install [flaky](https://github.com/appium/flaky) gem.
+
+```ruby
+gem uninstall -aIx flaky ;\
+gem install --no-rdoc --no-ri flaky
+```
+
+- Install [brew](http://mxcl.github.io/homebrew/)
+
+`ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"`
+
+- Install [nodejs](http://nodejs.org/) using brew.
+
+```
+brew update ;\
+brew upgrade node ;\
+brew install node
+```
+
+- Node should be `v0.10.5` or better.
+Don't use the big green install button on nodejs.org or all npm commands will require sudo.
+
+`$ node --version`
+
+`$ npm --version`
+
+- Install grunt.
+
+`npm install -g grunt grunt-cli`
+
+- Run the version command from the appium folder. If you're not in that folder, the grunt version will not display.
+
+```bash
+$ grunt --version
+grunt-cli v0.1.6
+grunt v0.4.1
+```
+
+- Install [ant](http://ant.apache.org/) if it's not already installed.
+- Install [maven 3.0.5](http://maven.apache.org/download.cgi) if it's not already installed. Do not use maven 3.1.1.
+
+```
+$ ant -version
+Apache Ant(TM) version 1.8.2 compiled on June 20 2012
+$ mvn -version
+Apache Maven 3.0.3 (r1075438; 2011-02-28 12:31:09-0500)
+```
+
+- Clone appium
+
+`$ git clone git://github.com/appium/appium.git`
+
+- Run reset.sh. When running reset.sh, make sure to be on Xcode 5.0.2 for best results. You may have problems if you reset on Xcode 4.6.3 and then switch to a newer Xcode.
+
+`cd appium; ./reset.sh`
+
+If you see config errors, try cleaning git. `git clean -dfx; git reset --hard`
+
+You can also reset by platform. `./reset.sh --android`
+
+If npm is having issues, you may have to disable https. I don't recommend this, however if you must this is how to do so:
+
+`npm config set registry http://registry.npmjs.org/`
+
+
+- Authorize for iOS testing. Must run reset.sh as mentioned above before running the grunt task.
+
+> sudo \`which grunt\` authorize
+
+- Start appium.
+
+`node server.js`
+
+
+#### Bash Profile
+- Add the Android SDK tools folder to your path so you can run `android`.
+- Define the `ANDROID_HOME` env var pointing to SDK root. On OSX place it in `~/.bash_profile`
+- You may have to add grunt as well `/usr/local/share/npm/bin/grunt`
+
+```
+# ~/.bash_profile
+export ANDROID_HOME=$HOME/Downloads/android-sdk-macosx
+export ANDROID_SDK=$ANDROID_HOME
+PATH=$PATH:/Applications/apache-ant-1.8.4/bin
+PATH=$PATH:/usr/local/share/npm/bin/
+PATH=$PATH:$ANDROID_HOME/build-tools
+PATH=$PATH:$ANDROID_HOME/platform-tools
+PATH=$PATH:$ANDROID_HOME/tools
+export JAVA_HOME="`/System/Library/Frameworks/JavaVM.framework/Versions/Current/Commands/java_home`"
+export APP_PATH="/path/to/MyiOS.app"
+export APK_PATH="/path/to/my.apk"
+export APP_PACKAGE="com.example.Package"
+export APP_ACTIVITY="StartActivity"
+export APP_WAIT_ACTIVITY="SplashActivity"
+
+export PATH
+```
+
+- Run `android` to open the SDK manager. 
+- Install `Intel x86 Emulator Accelerator (HAXM)` under Extras
+- Install API 18 `SDK Platform`, `Intel x86 Atom System Image`, `Google APIs`
+If there are any problems viewing or downloading the packages, go to `Packages -> Reload` and try again.
+
+- Create a new Android virtual device that uses the Intel image. Ensure `Use Host GPU` is checked. Set `VM Heap` to `64`. `32` is too small.
+
+![](img/avd_settings.png)
+
+`android avd`
+
+- Check that `hax is working` If it's not, install hax [directly from Intel](http://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager)
+
+```bash
+$ emulator @t18
+HAX is working and emulator runs in fast virt mode
+```
+
+- Launch the emulator with `emulator @t18`
+
+- After launching the emulator, check that it's listed in adb devices. Run the following commands a few times until it's listed.
+
+`adb kill-server; adb devices`
+
+If you see `error: protocol fault (no status)` just keep running the command until the emulator is detected.
+
+- With both the Android emulator running and the Appium server started, it's time to launch the appium console. Make sure the ENV vars are exported.
+
+- Echo the values to make sure they're set correctly
+
+`$ echo $APP_PATH $APP_PACKAGE $APP_ACTIVITY $APP_WAIT_ACTIVITY`
+
+- Start appium console
+
+`arc`
+
+- See [running on OS X](https://github.com/appium/appium/blob/master/docs/running-on-osx.md)
+
+#### Troubleshooting
+
+- If install fails, keep trying to install a few times.
+
+When using `Appium.app` make sure to set Appium -> Preferences... -> Check "Use External Appium Package" and set it to the path of Appium cloned from GitHub.
+
+Fix permission errors. npm shouldn't require sudo.
+
+```bash
+brew uninstall node
+brew install node
+rm -rf ./node_modules # run from the appium folder
+rm -rf "/Users/`whoami`/.npm"
+rm -rf /usr/local/lib/node_modules/ 
+./reset.sh --ios
+./reset.sh --android
+```
+
+- [Helper bash methods](https://gist.github.com/bootstraponline/5580587)
+
+#### SSL Issues
+
+> Unable to download data from https://rubygems.org/ - SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed 
+
+- [Fix SSL issues](http://railsapps.github.io/openssl-certificate-verify-failed.html) with:
+
+```bash
+$ rvm osx-ssl-certs update all
+$ rvm osx-ssl-certs status all
+```
+
+#### Maven on OS X 10.9
+
+```bash
+$ cd /usr/local
+$ git reset --hard origin/master
+
+$ brew update
+$ brew install maven
+```
+
+#### HAXM on OS X 10.9
+
+Install the [HAXM 10.9 hotfix](http://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager-end-user-license-agreement-macos-hotfix
+).
+
+#### Restore dev tools on 10.9
+
+`xcode-select --install`
+
+
+- [Install specific node version](https://coderwall.com/p/lqphzg)

data/osx_install.rake

@@ -0,0 +1,135 @@
+# For OS X, installs all the dependencies for Appium's ruby console, per these instructions:
+#
+# https://github.com/appium/ruby_console/blob/master/osx.md
+#
+# Changes to this file might imply changes to those instructions as well.
+
+def sh_success(cmd)
+  success = false
+  begin
+    success, status = sh cmd
+  rescue
+    # do nothing  
+  end
+  
+  success
+end
+  
+def has_cmd(cmd)
+  sh_success "which #{cmd}"
+end
+
+THIS_DIR     = File.expand_path(File.dirname(__FILE__))
+APPIUM_DIR = "#{THIS_DIR}/appium"
+  
+GCC = '/usr/bin/gcc'
+GCC42_CMD = 'gcc-4.2'
+GCC42 = "/usr/local/bin/#{GCC42_CMD}"
+
+file GCC do
+	fail "#{GCC} does not exist. This is likely because you do not have Xcode command line tools installed."
+end
+
+file GCC42 => [GCC] do
+  sh "ln -s #{GCC} #{GCC42}"
+end
+
+task :gcc do
+  if !has_cmd('gcc-4.2') then
+    Rake::Task[GCC42].invoke
+  end
+end
+    
+task :java do
+  if !has_cmd('java') then
+    puts "You must install java to continue."
+    puts "cf. http://www.oracle.com/technetwork/java/javase/downloads/index.html"
+  end
+end
+
+task :ruby => [:gcc] do
+  if has_cmd('rvm') then
+    # doesn't hurt anything if already installed
+    sh 'rvm install 2.0.0'
+  else
+    sh '\curl -L https://get.rvm.io | bash -s stable --ruby=2.0.0'
+  end
+  
+  system '/bin/bash --login -i -c "rvm use --default 2.0.0"'
+  sh 'rvm osx-ssl-certs update all'
+end
+
+task :gems => [:ruby] do
+  sh 'gem update --system'
+  sh 'gem install --no-rdoc --no-ri bundler'
+  sh 'gem update'
+  sh 'gem cleanup'
+  sh 'gem uninstall -aIx appium_lib'
+  sh 'gem uninstall -aIx web_console'
+  sh 'gem install --no-rdoc --no-ri web_console'
+  sh 'gem uninstall -aIx flaky'
+  sh 'gem install --no-rdoc --no-ri flaky'
+end
+
+task :brew do
+  if has_cmd('brew') then
+    sh 'brew update'
+  else
+    sh 'ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"'
+  end
+end
+
+task :ant do
+  if !has_cmd('ant') then
+    fail "Ant must be installed to complete this setup."
+  end
+end
+
+task :maven do
+  if !has_cmd('mvn') then
+    Rake::Task[:brew].invoke    
+    sh 'brew install maven'
+  end
+end
+
+task :nodejs => [:brew] do
+  sh 'brew install node' # noop if already installed
+  if sh_success 'brew outdated | grep node' then
+    sh 'brew upgrade node'
+  end if
+
+  # make sure it's installed
+  sh 'node --version' 
+  sh 'npm --version'
+end
+
+task :grunt => [:nodejs] do
+  if !sh_success('grunt --version') then
+    sh 'npm install -g grunt grunt-cli'
+    sh 'grunt --version'
+  end
+end
+
+# we only clone when the directory doesn't already exist
+directory APPIUM_DIR do
+  cd THIS_DIR
+  sh 'git clone git://github.com/appium/appium.git'
+end
+
+# appium goes into the directory below where this Rakefile is
+desc 'Downloads appium and all dependencies, and starts up appium. May require a superuser password.'
+task :appium => [APPIUM_DIR, :grunt, :maven, :ant, :gems, :ruby, :java] do
+  cd APPIUM_DIR
+  sh 'git pull origin master'
+  sh './reset.sh'
+
+  begin
+    sh 'sudo `which grunt` authorize'
+  rescue
+    # grunt errors if it has already been authorized, so ... I guess we'll ignore errors then
+  end
+
+  sh 'node server.js'
+end
+
+task :default => :appium