bwoken 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Bendyworks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Bwoken
+
+Runs your UIAutomation tests from the command line for both iPhone and iPad. ![build status](https://secure.travis-ci.org/bendyworks/bwoken.png?branch=master)
+
+Supports coffeescript.
+
+![screenshot](https://raw.github.com/bendyworks/bwoken/master/doc/screenshot.png)
+
+
+## Usage
+
+Make sure bwoken is properly installed via one of the methods below. Then, build your project and run all your tests via:
+
+    $ rake
+
+
+## Installation with rvm (recommended)
+
+Ensure Xcode is up-to-date.
+
+Add an .rvmrc file to your project, such as:
+
+    $ echo 'rvm use 1.9.3@MyProject --create' >> .rvmrc
+
+Install bundler and init:
+
+    $ gem install bundler
+    $ bundle init
+
+Add this line to your application's Gemfile:
+
+    gem 'bwoken'
+
+And then execute:
+
+    $ bundle --binstubs=bundler_bin
+
+Ensure your after_cd_bundler rvm hook is enabled:
+
+    $ chmod u+x ~/.rvm/hooks/after_cd_bundler
+
+Then, add the following line to your `Rakefile`:
+
+    require 'bwoken/tasks'
+
+Initialize your bwoken file structure:
+
+    $ rake bwoken:init
+
+Ensure your project is in a workspace rather than simply a project:
+
+* In Xcode, select File -> Save as workspace...
+* Save the workspace in the same directory as your .xcodeproj file
+
+
+## Installation without rvm (not recommended)
+
+Ensure Xcode is up-to-date.
+
+Install bundler and init:
+
+    $ gem install bundler
+    $ bundle init
+
+Add this line to your application's Gemfile:
+
+    gem 'bwoken'
+
+And then execute:
+
+    $ bundle --binstubs=bundler_bin
+
+Ensure your $PATH variable has bundler_bin at the front. This is usually done with .bash_profile:
+
+    $ echo 'export PATH=bundler_bin:$PATH' >> ~/.bash_profile
+
+Then, add the following line to your `Rakefile`:
+
+    require 'bwoken/tasks'
+
+Initialize your bwoken file structure:
+
+    $ rake bwoken:init
+
+Ensure your project is in a workspace rather than simply a project:
+
+* In Xcode, select File -> Save as workspace...
+* Save the workspace in the same directory as your .xcodeproj file
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/unix_instruments.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+#
+# unix_instruments
+#
+# A wrapper around `instruments` that returns a proper unix status code
+# depending on whether the run failed or not. Alas, Apple's instruments tool
+# doesn't care about unix status codes, so I must grep for the "Fail:" string
+# and figure it out myself. As long as the command doesn't output that string
+# anywhere else inside it, then it should work.
+#
+# I use a tee pipe to capture the output and deliver it to stdout
+#
+# Author: Jonathan Penn (jonathan@cocoamanifest.net)
+#
+
+set -e  # Bomb on any script errors
+
+run_instruments() {
+  # Because instruments buffers it's output if it determines that it is being
+  # piped to another process, we have to use ptys to get around that so that we
+  # can use `tee` to save the output for grepping and print to stdout in real
+  # time at the same time.
+  #
+  # I don't like this because I'm hard coding a tty/pty pair in here. Suggestions
+  # to make this cleaner?
+
+  output=$(mktemp -t unix-instruments)
+  instruments $@ &> /dev/ttyvf & pid_instruments=$!
+
+  # Cat the instruments output to tee which outputs to stdout and saves to
+  # $output at the same time
+  cat < /dev/ptyvf | tee $output
+
+  # Clear the process id we saved when forking instruments so the cleanup
+  # function called on exit knows it doesn't have to kill anything
+  pid_instruments=0
+
+  # Process the instruments output looking for anything that resembles a fail
+  # message
+  cat $output | get_error_status
+}
+
+get_error_status() {
+  # Catch "00-00-00 00:00:00 +000 Fail:"
+  # Catch "Instruments Trace Error"
+  ruby -e 'exit 1 if STDIN.read =~ /Instruments Trace Error|^\d+-\d+-\d+ \d+:\d+:\d+ [-+]\d+ Fail:/'
+}
+
+trap cleanup_instruments EXIT
+function cleanup_instruments() {
+  # Because we fork instruments in this script, we need to clean up if it's
+  # still running because of an error or the user pressed Ctrl-C
+  if [[ $pid_instruments -gt 0 ]]; then
+    kill $pid_instruments
+  fi
+}
+
+if [[ $1 == "----test" ]]; then
+  get_error_status
+else
+  run_instruments $@
+fi

data/lib/bwoken/build.rb

@@ -0,0 +1,67 @@
+require 'open3'
+
+module Bwoken
+  class Build
+
+    def scheme
+      Bwoken.app_name
+    end
+
+    def configuration
+      'Debug'
+    end
+
+    def sdk
+      'iphonesimulator5.1'
+    end
+
+    def env_variables
+      {
+        'GCC_PREPROCESSOR_DEFINITIONS' => 'TEST_MODE=1',
+        'CONFIGURATION_BUILD_DIR' => Bwoken.build_path
+      }
+    end
+
+    def variables_for_cli
+      env_variables.map{|key,val| "#{key}=#{val}"}.join(' ')
+    end
+
+    def cmd
+      "xcodebuild \
+        -workspace #{Bwoken.workspace} \
+        -scheme #{scheme} \
+        -configuration #{configuration} \
+        -sdk #{sdk} \
+        #{variables_for_cli} \
+        clean build"
+    end
+
+    def compile
+      exit_status = 0
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+
+        print "Building"
+        out_string = ""
+
+        stdout.each_line do |line|
+          out_string << line
+          print "."
+        end
+
+        exit_status = wait_thr.value if wait_thr
+        puts
+
+        if exit_status == 0
+          puts
+          puts "## Build Successful ##"
+          puts
+        else
+          puts out_string
+          puts 'Build failed'
+          return exit_status
+        end
+      end
+      exit_status
+    end
+  end
+end

data/lib/bwoken/coffeescript.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+require 'coffee_script/source'
+require 'json' if RUBY_VERSION =~ /^1\.8\./
+require 'execjs'
+
+module Bwoken
+  class Coffeescript
+    class << self
+
+      def source_folder
+        File.join(Bwoken.path, 'coffeescript')
+      end
+
+      def test_files
+        "#{source_folder}/**/*.coffee"
+      end
+
+      def coffee_script_source
+        IO.read(CoffeeScript::Source.bundled_path)
+      end
+
+      def context
+        @context ||= ExecJS.compile(coffee_script_source)
+      end
+
+      def compile_all
+
+        Dir[test_files].each do |filename|
+          new(filename).make
+        end
+      end
+
+      def clean
+        FileUtils.rm_rf compiled_javascript_path
+      end
+
+      def compiled_javascript_path
+        File.join(Bwoken.tmp_path, 'javascript')
+      end
+
+    end
+
+    attr_accessor :import_strings
+
+    def initialize path
+      @source_file = path
+    end
+
+    def destination_folder
+      subpath = File.dirname(@source_file.sub(Regexp.new(self.class.source_folder + '/'), '')).sub('.','')
+      File.join(self.class.compiled_javascript_path, subpath)
+    end
+
+    def destination_file
+      basename = File.basename(@source_file, '.coffee')
+      "#{self.destination_folder}/#{basename}.js"
+    end
+
+    def make
+      FileUtils.mkdir_p(destination_folder)
+      javascript = compile
+      save javascript
+    end
+
+    def source_contents
+      IO.read(@source_file)
+    end
+
+    def compile
+      source = precompile(source_contents)
+      self.class.context.call('CoffeeScript.compile', source, :bare => true)
+    end
+
+    def precompile coffeescript
+      capture_imports coffeescript
+      remove_imports coffeescript
+    end
+
+    def capture_imports raw_coffeescript
+      self.import_strings = raw_coffeescript.scan(/#import .*$/)
+    end
+
+    def remove_imports raw_coffeescript
+      raw_coffeescript.gsub(/#import .*$/,'')
+    end
+
+    def save javascript
+      File.open(destination_file, 'w') do |io|
+        import_strings.each do |import_string|
+          io.puts import_string
+        end unless import_strings.nil?
+        io.puts javascript
+      end
+    end
+
+  end
+end

data/lib/bwoken/formatter.rb

@@ -0,0 +1,55 @@
+module Bwoken
+  class Formatter
+
+    class << self
+      def format stdout
+        new.format stdout
+      end
+
+      def on name, &block
+        define_method "_on_#{name}_callback" do |line|
+          block.call(line)
+        end
+      end
+
+    end
+
+    def line_demuxer line, exit_status
+      if line =~ /Instruments Trace Error/
+        exit_status = 1
+        _on_fail_callback(line)
+      elsif line =~ /^\d{4}/
+        tokens = line.split(' ')
+
+        if tokens[3] =~ /Pass/
+          _on_pass_callback(line)
+        elsif tokens[3] =~ /Fail/ || line =~ /Script threw an uncaught JavaScript error/
+          exit_status = 1
+          _on_fail_callback(line)
+        else
+          _on_debug_callback(line)
+        end
+      else
+        _on_other_callback(line)
+      end
+      exit_status
+    end
+
+    %w(pass fail debug other).each do |log_level|
+      on log_level.to_sym do |line|
+        puts line
+      end
+    end
+
+    def format stdout
+      exit_status = 0
+
+      stdout.each_line do |line|
+        exit_status = line_demuxer line, exit_status
+      end
+
+      exit_status
+    end
+
+  end
+end

data/lib/bwoken/formatters/colorful_formatter.rb

@@ -0,0 +1,24 @@
+require 'colorful'
+
+require 'bwoken/formatter'
+
+module Bwoken
+  class ColorfulFormatter < Formatter
+
+    on :debug do |line|
+      tokens = line.split(' ')
+      puts "#{tokens[1]} #{tokens[3].yellow}\t#{tokens[4..-1].join(' ')}"
+    end
+
+    on :fail do |line|
+      tokens = line.split(' ')
+      puts "#{tokens[1]} #{tokens[3].red}\t#{tokens[4..-1].join(' ')}"
+    end
+
+    on :pass do |line|
+      tokens = line.split(' ')
+      puts "#{tokens[1]} #{tokens[3].green}\t#{tokens[4..-1].join(' ')}"
+    end
+
+  end
+end

data/lib/bwoken/script.rb

@@ -0,0 +1,74 @@
+require 'fileutils'
+require 'open3'
+
+require 'bwoken/formatters/colorful_formatter'
+
+module Bwoken
+
+  class ScriptFailedError < RuntimeError; end
+
+  class Script
+
+    attr_accessor :path
+
+    class << self
+
+      def run_all device_family
+        Simulator.device_family = device_family
+
+        Dir["#{Bwoken.test_suite_path}/#{device_family}/**/*.js"].each do |javascript|
+          run(javascript)
+        end
+      end
+
+      def run javascript_path
+        script = new
+        script.path = javascript_path
+        script.run
+      end
+
+      def trace_file_path
+        File.join(Bwoken.tmp_path, 'trace')
+      end
+
+    end
+
+    def env_variables
+      {
+        'UIASCRIPT' => path,
+        'UIARESULTSPATH' => Bwoken.results_path
+      }
+    end
+
+    def env_variables_for_cli
+      env_variables.map{|key,val| "-e #{key} #{val}"}.join(' ')
+    end
+
+    def cmd
+      "#{File.expand_path('../../../bin', __FILE__)}/unix_instruments.sh \
+        -D #{self.class.trace_file_path} \
+        -t #{Bwoken.path_to_automation_template} \
+        #{Bwoken.app_dir} \
+        #{env_variables_for_cli}"
+    end
+
+    def formatter
+      Bwoken::ColorfulFormatter
+    end
+
+    def make_results_path_dir
+      FileUtils.mkdir_p Bwoken.results_path
+    end
+
+    def run
+      make_results_path_dir
+
+      exit_status = 0
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+        exit_status = formatter.format stdout
+      end
+      raise ScriptFailedError.new('Test Script Failed') unless exit_status == 0
+    end
+
+  end
+end

data/lib/bwoken/simulator.rb

@@ -0,0 +1,36 @@
+module Bwoken
+  class Simulator
+
+    def self.plist_buddy; '/usr/libexec/PlistBuddy'; end
+    def self.plist_file; "#{Bwoken.app_dir}/Info.plist"; end
+
+    def self.device_family= device_family
+      update_device_family_in_plist :delete_array
+      update_device_family_in_plist :add_array
+      update_device_family_in_plist :add_scalar, device_family
+    end
+
+    def self.update_device_family_in_plist action, args = nil
+      system_cmd = lambda {|command| Kernel.system "#{plist_buddy} -c '#{command}' #{plist_file}" }
+
+      case action
+      when :delete_array then system_cmd['Delete :UIDeviceFamily']
+      when :add_array    then system_cmd['Add :UIDeviceFamily array']
+      when :add_scalar
+        command = lambda {|scalar| "Add :UIDeviceFamily:0 integer #{scalar == 'iphone' ? 1 : 2}"}
+
+        case args
+        when /iphone/i
+          system_cmd[command['iphone']]
+        when /ipad/i
+          system_cmd[command['ipad']]
+        when /universal/i
+          system_cmd[command['ipad']]
+          system_cmd[command['iphone']]
+        end
+
+      end
+    end
+
+  end
+end

data/lib/bwoken/tasks/bwoken.rake

@@ -0,0 +1,77 @@
+require 'bwoken'
+
+namespace :bwoken do
+  desc 'Create bwoken skeleton folders'
+  task :init do
+    paths = []
+    paths << Bwoken.results_path
+    paths << Bwoken.test_suite_path
+    paths << "#{Bwoken::Coffeescript.source_folder}/iphone"
+    paths << "#{Bwoken::Coffeescript.source_folder}/ipad"
+
+    paths.each do |path|
+      puts "Creating #{path}"
+      FileUtils.mkdir_p path
+    end
+
+    example = "#{Bwoken::Coffeescript.source_folder}/iphone/example.coffee"
+    unless File.file?(example)
+      puts "Creating #{example}"
+      open(example, 'w') do |io|
+        io.puts 'target = UIATarget.localTarget()'
+        io.puts 'window = target.frontMostApp().mainWindow()'
+      end
+    end
+
+  end
+end
+
+desc 'Remove result and trace files'
+task :clean do
+  print "Removing #{Bwoken.results_path}/* & #{Bwoken::Script.trace_file_path}/* ... "
+  system "rm -rf #{Bwoken.results_path}/* #{Bwoken::Script.trace_file_path}/*"
+  puts 'done.'
+end
+
+# task :clean_db do
+  # puts "Cleaning the application's sqlite cache database"
+  # system 'rm -rf ls -1d ~/Library/Application\ Support/iPhone\ Simulator/**/Applications/**/Library/Caches/TravisCI*.sqlite'
+# end
+
+desc 'Compile the workspace'
+task :build do
+  Bwoken::Build.new.compile
+end
+
+task :coffeescript do
+  Bwoken::Coffeescript.clean
+  Bwoken::Coffeescript.compile_all
+end
+
+device_families = %w(iphone ipad)
+
+device_families.each do |device_family|
+
+  namespace device_family do
+    task :test => :coffeescript do
+      Bwoken::Script.run_all device_family
+    end
+  end
+
+  desc "Run tests for #{device_family}"
+  task device_family => "#{device_family}:test"
+
+end
+
+desc 'Run all tests without compiling first'
+task :test do
+  if ENV['FAMILY']
+    Rake::Task[ENV['FAMILY']].invoke
+  else
+    device_families.each do |device_family|
+      Rake::Task[device_family].invoke
+    end
+  end
+end
+
+task :default => [:build, :test]

data/lib/bwoken/tasks.rb

@@ -0,0 +1 @@
+load 'bwoken/tasks/bwoken.rake'

data/lib/bwoken/version.rb

@@ -0,0 +1,3 @@
+module Bwoken
+  VERSION = "0.0.1" unless defined?(::Bwoken::VERSION)
+end

data/lib/bwoken.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+
+require 'bwoken/version'
+require 'bwoken/simulator'
+require 'bwoken/build'
+require 'bwoken/script'
+require 'bwoken/coffeescript'
+
+module Bwoken
+  class << self
+    def path
+      File.join(project_path, 'integration')
+    end
+
+    def tmp_path
+      File.join(path, 'tmp')
+    end
+
+    def app_name
+      File.basename(project_path)
+    end
+
+    def app_dir
+      File.join(build_path, "#{app_name}.app")
+    end
+
+    def project_path
+      Dir.pwd
+    end
+
+    def test_suite_path
+      Bwoken::Coffeescript.compiled_javascript_path
+    end
+
+    def path_to_automation_template
+      '/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Instruments/PlugIns/AutomationInstrument.bundle/Contents/Resources/Automation.tracetemplate'
+    end
+
+    def build_path
+      File.join(project_path, 'build').tap do |dir_name|
+        FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+      end
+    end
+
+    def workspace
+      File.join(project_path, "#{app_name}.xcworkspace")
+    end
+
+    def results_path
+      File.join(tmp_path, 'results').tap do |dir_name|
+        FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: bwoken
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brad Grzesiak
+- Jaymes Waters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coffee-script-source
+  requirement: &70256891126900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256891126900
+- !ruby/object:Gem::Dependency
+  name: colorful
+  requirement: &70256891126240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256891126240
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: &70256891125660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256891125660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70256891103760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256891103760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70256891101500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256891101500
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70256891099820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256891099820
+description: iOS UIAutomation Test Runner
+email:
+- brad@bendyworks.com
+- jaymes@bendyworks.com
+executables:
+- unix_instruments.sh
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/unix_instruments.sh
+- lib/bwoken/formatters/colorful_formatter.rb
+- lib/bwoken/tasks/bwoken.rake
+- lib/bwoken/build.rb
+- lib/bwoken/coffeescript.rb
+- lib/bwoken/formatter.rb
+- lib/bwoken/script.rb
+- lib/bwoken/simulator.rb
+- lib/bwoken/tasks.rb
+- lib/bwoken/version.rb
+- lib/bwoken.rb
+- LICENSE
+- README.md
+homepage: https://github.com/bendyworks/bwoken
+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'
+      segments:
+      - 0
+      hash: 2085165610847558799
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2085165610847558799
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Runs your UIAutomation tests from the command line for both iPhone and iPad;
+  supports coffeescript
+test_files: []