uiauto 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b13ad5de892dd0145639a2f46bfc12a3d6555535
-  data.tar.gz: 0b3a7d825433f830e6bb0ced19bce989d033a28b
+  metadata.gz: 3afb5260e2a269072122eb099792ea8a95b27547
+  data.tar.gz: c120b7d250ce0524788a53404df05eac9321842e
 SHA512:
-  metadata.gz: 8334839a2bf68692b91729130c0951d4d97837020709a23b32acf21d70ad2ee809c5d1c9644332e38f3fad2ed438983787c7071ed281043cfe17ec8957f845fc
-  data.tar.gz: eacf0342d04567d12ee38caf0402567631f9ad46a31ca0a6d77aa4307cf685cc24121363d6d37483d3ddf4db54de742a2d79b080b55f93014828e562c815fa8d
+  metadata.gz: 1184ac99f15aae6feadb3332fb1122e451190c29f36d165228e69e82edc6b6ae2925bdc6de5529311d9f12b979eee5350b6efa8221ef88404783adfad27cf4a6
+  data.tar.gz: 37a0d0f6b8fb720379560cca0649fe4555f6547da3f7739e4834ec00d834b9d3800efb1badd2760d707519b8e6c5d81c77c4303c3fd08926a7bbe517bb3f43cc

data/README.md

@@ -4,6 +4,8 @@ UIAuto is a command line tool for running UI Automation scripts. It improves App
 
 UIAuto also facilitates the setup of simulator data for running scripts in a repeatable and known state.
 
+![screencast](http://enriquez.me/uiauto/uiauto.gif)
+
 ## Prerequisites
 
 * Xcode command line tools
@@ -14,7 +16,7 @@ UIAuto also facilitates the setup of simulator data for running scripts in a rep
 
 ## Usage
 
-First, you need to build your app to run on the simulator. By default, `uiauto` will look for the most recently built app bundle in derived data based on your current working directory. UIAuto also provides commands and can read speical comment headers to setup simulator data. More details below.
+First, you need to build your app. By default, `uiauto` will look for the most recently built app bundle in derived data based on your current working directory. UIAuto also provides commands and can read speical comment headers to setup simulator data. More details below.
 
 ### Build your project
 
@@ -48,6 +50,11 @@ In the same directory as your project's .xcworkspace or .xcodeproj run the follo
 
 This will run `path_to_your_script.js` using the app bundle located in derivated data that you just built. The results and trace file are placed in `./uiauto/results` and `./uiauto/results/trace`.
 
+By placing your scripts in `./uiauto/scripts/`, then you can execute them by running the following command.
+
+    # This is the same as `uiauto exec uiauto/scripts/`
+    $ uiauto exec
+
 #### Advanced options
 
 Running `uiauto help exec` prints the following message.
@@ -56,18 +63,29 @@ Running `uiauto help exec` prints the following message.
       uiauto exec [FILE_OR_DIRECTORY]
 
     Options:
-      [--results=RESULTS]
-
-      [--trace=TRACE]
-
-      [--app=APP]
-
-      [--device=DEVICE]
+      [--results=RESULTS]      # Location where results should be saved. A directory named "Run ##" is created in here.
+                               # Default: ./uiauto/results
+      [--trace=TRACE]          # Location of trace file. Created if it doesn't exist.
+                               # Default: ./uiauto/results/trace
+      [--app=APP]              # Location of your application bundle. Defaults to your project's most recent build located in the standard location.
+      [--device=DEVICE]        # Run scripts on a connected device. Specify a UDID to target a specific device.
+      [--simulator=SIMULATOR]  # Run the simulator for a specific device.
+                               # Possible values: iPad, iPad (Retina), iPhone, iPhone (Retina 3.5-inch), iPhone (Retina 4-inch)
+      [--format=FORMAT]        # Formatter to use for output. Combine with --require to include a custom formatter. Built-in Formatters:
+                               # ColorIndentFormatter: Adds readability to instruments output by filtering noise and adding color and indents.
+                               # InstrumentsFormatter: Unmodified instruments output.
+                               # Default: ColorIndentFormatter
+      [--listeners=LISTENERS]  # Space separated list of class names used to listen to instruments output events. Combine with --require to include custom listeners.
+      [--require=REQUIRE]      # Path to a ruby file. Used to require custom formatters or listeners.
+
+##### `--app` option
 
 If you build your app outside of derived data, then you can specify the `--app` flag to tell uiauto where to find the `*.app`. You can also override the default locations for the trace file and results. For example, if your build your app in a build directory you can run the following
 
     uiauto exec uiauto/scripts/script_to_run.js --app=build/MyApp.app
 
+##### `--device` option
+
 Pass the `--device` flag to run on the device.
 
     # Run on a connected device
@@ -76,6 +94,14 @@ Pass the `--device` flag to run on the device.
     # Run on a connected device with a specific udid
     $ uiauto exec uiauto/scripts/script_to_run.js --device=UDID
 
+##### Custom formatters and listeners
+
+UIAuto supports custom formats and custom listeners. They can be made available with the `--require` option. The difference between a formatter and listener is that a formatter is a specific kind of listener that writes to `STDOUT`. There can only be one formatter active at a time. There may be more than one listener active at a time, and a listener must not write to `STDOUT`.
+
+See [lib/uiauto/formatters/README.md](https://github.com/enriquez/uiauto/tree/master/lib/uiauto/formatters/) for details on how to implement a custom formatter.
+
+See [lib/uiauto/listeners/README.md](https://github.com/enriquez/uiauto/tree/master/lib/uiauto/listeners/) for details on how to implement a custom listener.
+
 ### Simulator data
 
 UIAuto's `simulator` subcommand allows you to setup the simulator's applications, settings, and data. This is done by taking a "snapshot" of the simulator's current data by saving the `~/Library/Application Support/iPhone Simulator/(SDK VERSION)/` directory somewhere, then loading it back in when needed.

data/helpers/choose_sim_device

@@ -0,0 +1,68 @@
+#!/usr/bin/env osascript
+
+(*
+Copyright (c) 2012 Jonathan Penn (http://cocoamanifest.net/)
+
+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.
+
+Chooses a device type from the iPhone Simulator using menu
+selection events.
+
+To use, make sure this file is executable, then run from the terminal:
+
+  bin/choose_sim_device "iPad (Retina)"
+
+Originally, I tried to do this by editing the Preference file for the
+simulator, and it worked under Xcode 4.3, but now it ignores those changes
+often enough that I chose to use this menu-selection route.
+
+*)
+
+on run argv
+  set simType to item 1 of argv
+
+  activate application "iPhone Simulator"
+  tell application "System Events"
+    tell process "iOS Simulator"
+      tell menu bar 1
+        -- Hardware menu bar item
+        tell menu bar item 5
+          -- Hardware menu
+          tell menu 1
+            -- Device menu item
+            tell menu item 1
+              -- Device sub menu
+              tell menu 1
+                click menu item simType
+              end tell
+            end tell
+          end tell
+        end tell
+      end tell
+    end tell
+  end tell
+
+  -- Need to show the simulator again after changing device,
+  -- or else the simulator be hidden when launched by instruments
+  -- for some odd reason.
+  tell application "System Events"
+    set visible of process "iOS Simulator" to true
+  end tell
+
+end run

data/lib/uiauto/cli.rb

@@ -28,8 +28,11 @@ module UIAuto
     end
 
     desc "open", "Opens the simulator"
+    method_option :simulator,
+      :enum => Simulator::DEVICES,
+      :desc => %q{Run the simulator for a specific device.}
     def open
-      Simulator.open
+      Simulator.open(options[:simulator])
     end
 
     desc "close", "Closes the simulator"
@@ -40,15 +43,35 @@ module UIAuto
 
   class CLI < Thor
     desc "exec FILE_OR_DIRECTORY", "Runs the given script or directory of scripts through UI Automation"
-    method_option :results, :default => File.expand_path("./uiauto/results")
-    method_option :trace,   :default => File.expand_path("./uiauto/results/trace")
-    method_option :app
-    method_option :device
+    method_option :results,
+      :default => File.expand_path("./uiauto/results"),
+      :desc  => %q{Location where results should be saved. A directory named "Run ##" is created in here.}
+    method_option :trace,
+      :default => File.expand_path("./uiauto/results/trace"),
+      :desc  => %q{Location of trace file. Created if it doesn't exist.}
+    method_option :app,
+      :desc => %q{Location of your application bundle. Defaults to your project's most recent build located in the standard derived data location.}
+    method_option :device,
+      :desc => %q{Run scripts on a connected device. Specify a UDID to target a specific device.}
+    method_option :simulator,
+      :enum => Simulator::DEVICES,
+      :desc => %q{Run the simulator for a specific device.}
+    method_option :format,
+      :default => "ColorIndentFormatter",
+      :desc => %q{Formatter to use for output. Combine with --require to include a custom formatter. Built-in Formatters:
+                           # ColorIndentFormatter: Adds readability to instruments output by filtering noise and adding color and indents.
+                           # InstrumentsFormatter: Unmodified instruments output.}
+    method_option :listeners,
+      :type => :array,
+      :banner => "LISTENERS",
+      :desc => %q{Space separated list of class names used to listen to instruments output events. Combine with --require to include custom listeners.}
+    method_option :require,
+      :desc => %q{Path to a ruby file. Used to require custom formatters or listeners.}
     def exec(file_or_dir = "./uiauto/scripts/")
       Runner.run(file_or_dir, options)
     end
 
-    desc "simulator SUBCOMMAND ...ARGS", "manage simulator data"
+    desc "simulator SUBCOMMAND ...ARGS", "Manage simulator data"
     subcommand "simulator", SimulatorCLI
   end
 end

data/lib/uiauto/formatters.rb

@@ -0,0 +1,6 @@
+require 'uiauto/formatters/base_formatter'
+require 'uiauto/formatters/instruments_formatter'
+require 'uiauto/formatters/color_indent_formatter'
+
+module UIAuto::Formatters
+end

data/lib/uiauto/formatters/README.md

@@ -0,0 +1,30 @@
+# UIAuto Formatters
+
+A formatter is a special type of listener that writes to `STDOUT`. To create a custom formatter, inherit from `UIAuto::Formatters::BaseFormatter` and place it in the `UIAuto::Formatters` namespace. Then override the methods important to your formatter.
+
+Below is an example of a basic progress formatter.
+
+    # progress_formatter.rb
+    require 'uiauto/formatters/base_formatter'
+
+    module UIAuto
+      module Formatters
+        class ProgressFormatter < BaseFormatter
+          def log_debug(message)
+            output.print "."
+          end
+
+          def log_fail(message)
+            output.print "F"
+          end
+        end
+      end
+    end
+
+This formatter can be used by requiring the script and setting the format.
+
+    $ uiauto exec uiauto/scripts/script_to_run.js --require=./progress_formatter.rb --format=ProgressFormatter
+
+See [lib/uiauto/listeners/base_listener.rb](https://github.com/enriquez/uiauto/tree/master/lib/uiauto/listeners/base_listener.rb) for the available methods and their description.
+
+See [lib/uiauto/formatters/](https://github.com/enriquez/uiauto/tree/master/lib/uiauto/formatters/) for examples of built in formatters.

data/lib/uiauto/formatters/base_formatter.rb

@@ -0,0 +1,11 @@
+require 'uiauto/listeners/base_listener'
+
+module UIAuto
+  module Formatters
+    class BaseFormatter < Listeners::BaseListener
+      def output
+        STDOUT
+      end
+    end
+  end
+end

data/lib/uiauto/formatters/color_indent_formatter.rb

@@ -0,0 +1,123 @@
+require 'uiauto/formatters/base_formatter'
+require 'rainbow'
+
+module UIAuto
+  module Formatters
+    class ColorIndentFormatter < BaseFormatter
+      def initialize
+        @passes   = []
+        @failures = []
+        @current_script = ''
+      end
+
+      def script_start(script)
+        output.puts
+        output.puts "Script: #{script}"
+        @current_script = script
+      end
+
+      def load_simulator_data(path)
+        output.puts
+        output.puts "  Simulator Data: #{path}"
+      end
+
+      def log_start(message)
+        output.puts
+        output.puts "  Test: \"#{message}\""
+      end
+
+      def log_pass(message)
+        output.puts "    Test: \"#{message}\" Passed".foreground(:green)
+        @passes << message
+      end
+
+      def log_fail(message)
+        output.puts "    Test: \"#{message}\" Failed".foreground(:red)
+        @failures << "#{@current_script} \"#{message}\""
+      end
+
+      def log_issue(message)
+        output.puts "    Test: \"#{message}\" Issue".foreground(:yellow)
+      end
+
+      def log_debug(message)
+        if output.tty?
+          colored_message = message.foreground(:cyan)
+          colored_message = colored_message.gsub(/"((?:[^"\\]|\\.)*)"/) do
+            # hack to ensure ansi start/end codes for cyan are matched between bright cyan
+            "\e[0m#{"\"#{$1}\"".bright.foreground(:cyan)}\e[36m"
+          end
+
+          message = colored_message
+        end
+        output.puts "    #{message}"
+      end
+
+      def log_error(message)
+        output.puts "    Error: #{message}".foreground(:red)
+      end
+
+      def log_default(message)
+        output.puts message
+      end
+
+      def log_warning(message)
+        output.puts "    Warning: #{message}".foreground(:yellow)
+      end
+
+      def log_none(message)
+        output.puts "    #{message}".foreground(:red)
+        @failures << @current_script unless @failures.include?(@current_script)
+      end
+
+      def log_stopped(message)
+        output.puts "    #{message}".foreground(:red)
+        @failures << @current_script unless @failures.include?(@current_script)
+      end
+
+      def element_tree_start
+        output.puts "    Element Tree:".color("333333")
+      end
+
+      def element_tree_line(line)
+        output.puts "    #{line}".color("333333")
+      end
+
+      def run_finish
+        if @failures.count > 0
+          output.puts
+          output.puts "Failing Tests:".foreground(:red)
+          @failures.each do |failure|
+            output.puts failure.foreground(:red)
+          end
+        end
+
+        output.puts
+        output.puts "#{@passes.count + @failures.count} tests #{summary}"
+      end
+
+      protected
+
+      def summary
+        failures = ''
+        passes   = ''
+
+        if @failures.count > 0
+          failures = "#{@failures.count} failed".foreground(:red)
+        end
+
+        if @passes.count > 0
+          passes = "#{@passes.count} passed".foreground(:green)
+        end
+
+        if failures.length > 0 && passes.length > 0
+          "(#{failures}, #{passes})"
+        elsif failures.length > 0
+          "(#{failures})"
+        elsif passes.length > 0
+          "(#{passes})"
+        end
+      end
+    end
+  end
+end

data/lib/uiauto/formatters/instruments_formatter.rb

@@ -0,0 +1,11 @@
+require 'uiauto/formatters/base_formatter'
+
+module UIAuto
+  module Formatters
+    class InstrumentsFormatter < BaseFormatter
+      def instruments_line(line)
+        output.puts line
+      end
+    end
+  end
+end

data/lib/uiauto/instruments.rb

@@ -1,17 +1,21 @@
-require 'pty'
+require 'childprocess'
 require 'fileutils'
 require 'cfpropertylist'
+require 'pty'
+require 'uiauto/simulator'
 
 module UIAuto
   class Instruments
-    attr_accessor :trace, :app, :results, :script, :device
+    attr_accessor :trace, :app, :results, :script, :device, :simulator
 
-    def initialize(script, opts = {})
-      @script  = script
-      @trace   = opts[:trace]
-      @results = opts[:results]
-      @device  = opts[:device]
-      @app     = opts[:app] || default_application
+    def initialize(script, reporter, opts = {})
+      @reporter  = reporter
+      @script    = script
+      @trace     = opts[:trace]
+      @results   = opts[:results]
+      @device    = opts[:device]
+      @simulator = opts[:simulator]
+      @app       = opts[:app] || default_application
 
       FileUtils.mkdir_p(@results) unless File.exists?(@results)
     end
@@ -29,27 +33,31 @@ module UIAuto
     end
 
     def execute
-      exit_status = 0
-      read, write = PTY.open
-      pid = spawn(command, :in => STDIN, :out => write, :err => write)
-      write.close
+      launch_simulator
+      select_device_family
+
+      instruments = ChildProcess.build(*command.split(" "))
+      master, slave = if PTY.respond_to?(:open)
+                        PTY.open
+                      else
+                        [File.new("/dev/ptyuf", "w"), File.open("/dev/ttyuf", "r")]
+                      end
+      instruments.io.stdout = master
+      instruments.io.stderr = master
+      instruments.duplex = true
+      instruments.start
+      master.close
 
       begin
         loop do
-          buffer = read.readpartial(8192)
-          lines  = buffer.split("\n")
-          lines.each do |line|
-            puts line
-            exit_status = 1 if line =~ /Fail:/ && exit_status != 2
-            exit_status = 2 if line =~ /Instruments Usage Error|Instruments Trace Error|^\d+-\d+-\d+ \d+:\d+:\d+ [-+]\d+ (Error:|None: Script threw an uncaught JavaScript error)/
-          end
+          buffer = slave.readpartial(8192)
+          @reporter.parse_instruments_output(buffer)
         end
       rescue EOFError
+        @reporter.script_finish(@script)
       ensure
-        read.close
+        slave.close
       end
-
-      exit_status
     end
 
     protected
@@ -100,5 +108,24 @@ module UIAuto
       end
     end
 
+    def launch_simulator
+      Simulator.open(@simulator)
+    end
+
+    def select_device_family
+      if @simulator && !@simulator.empty?
+        info_plist = CFPropertyList::List.new(:file => File.join(@app, "Info.plist"))
+        data       = CFPropertyList.native_types(info_plist.value)
+        if @simulator.start_with?("iPhone")
+          data["UIDeviceFamily"] = [1]
+        elsif @simulator.start_with?("iPad")
+          data["UIDeviceFamily"] = [2]
+        end
+
+        info_plist.value = CFPropertyList.guess(data)
+        info_plist.save
+      end
+    end
+
   end
 end

data/lib/uiauto/listeners.rb

@@ -0,0 +1,5 @@
+require 'uiauto/listeners/base_listener'
+require 'uiauto/listeners/exit_status_listener'
+
+module UIAuto::Listeners
+end

data/lib/uiauto/listeners/README.md

@@ -0,0 +1,15 @@
+# UIAuto Listeners
+
+Listeners receive events from instruments. Listeners may be used for anything other than writing to `STDOUT`. Use a formatter if you plan on writing to `STDOUT`. To create a custom listener, inherit from `UIAuto::Formatters::BaseListener` and place it in the `UIAuto::Listeners` namespace. Then override the methods important to your listener.
+
+A custom listener can be used by requiring the script and setting the listener.
+
+    $ uiauto exec uiauto/scripts/script_to_run.js --require=./custom_listener.rb --listeners=CustomListener
+
+More than one listener may be used, but you can only require one file. That file must implement multiple listeners or require other files.
+
+    $ uiauto exec uiauto/scripts/script_to_run.js --require=./listeners.rb --listeners=CustomListener1 CustomListener2
+
+See [lib/uiauto/listeners/base_listener.rb](https://github.com/enriquez/uiauto/tree/master/lib/uiauto/listeners/base_listener.rb) for the available methods and their description.
+
+See [lib/uiauto/listeners/](https://github.com/enriquez/uiauto/tree/master/lib/uiauto/listeners/) for examples of built in listeners.

data/lib/uiauto/listeners/base_listener.rb

@@ -0,0 +1,93 @@
+module UIAuto
+  module Listeners
+    class BaseListener
+      # Before a run is started. A run contains one or more scripts.
+      def run_start
+      end
+
+      # Before a script is started.
+      def script_start(script)
+      end
+
+      # Called if a script contains a comment header to load simulator data.
+      def load_simulator_data(path)
+      end
+
+      # Message printed by UI Automation's logStart.
+      def log_start(message)
+      end
+
+      # Message printed by UI Automation's logPass.
+      def log_pass(message)
+      end
+
+      # Message printed by UI Automation's logFail.
+      def log_fail(message)
+      end
+
+      # Message printed by UI Automation's logIssue.
+      def log_issue(message)
+      end
+
+      # Message printed by UI Automation's logDebug. Also prints actions such as tap, typeString, etc...
+      def log_debug(message)
+      end
+
+      # Message printed by UI Automation's logError.
+      def log_error(message)
+      end
+
+      # Message printed by UI Automation's logMessage.
+      def log_default(message)
+      end
+
+      # Message printed by UI Automation's logWarning.
+      def log_warning(message)
+      end
+
+      # An uncategorized log type. Typically uncaught javascript errors.
+      def log_none(message)
+      end
+
+      # Typically reports a script was stopped by user, but is caused by a failed import
+      def log_stopped(message)
+      end
+
+      # UI Automation's logElementTree was called. element_tree contains the entire tree.
+      def element_tree(element_tree)
+      end
+
+      # Before an element tree starts.
+      def element_tree_start
+      end
+
+      # A line from an element tree.
+      def element_tree_line(line)
+      end
+
+      # After an element tree is finished.
+      def element_tree_finish
+      end
+
+      # After a script is finished. Duration and trace location as reported by instruments.
+      def script_summary(duration, trace_location)
+      end
+
+      # After a script is finished.
+      def script_finish(script)
+      end
+
+      # Misc lines from instruments that are not called in above methods.
+      def unknown(line)
+      end
+
+      # Raw instruments output.
+      def instruments_line(line)
+      end
+
+      # After a run finished.
+      def run_finish
+      end
+    end
+  end
+end

data/lib/uiauto/listeners/exit_status_listener.rb

@@ -0,0 +1,25 @@
+require 'uiauto/listeners/base_listener'
+
+module UIAuto
+  module Listeners
+    class ExitStatusListener < BaseListener
+
+      def initialize
+        @result = 0
+      end
+
+      def log_fail(message)
+        @result = 1 unless @result == 2
+      end
+
+      def log_error(message)
+        @result = 2
+      end
+
+      def result
+        @result
+      end
+
+    end
+  end
+end

data/lib/uiauto/reporter.rb

@@ -0,0 +1,83 @@
+module UIAuto
+  class Reporter
+    def initialize
+      @listeners = []
+      @element_tree = ""
+    end
+
+    def add_listener(listener)
+      @listeners << listener
+    end
+
+    def formatter=(formatter)
+      add_listener(formatter)
+    end
+
+    def parse_instruments_output(output)
+      lines = output.split("\n")
+      lines.each do |line|
+        notify_listeners(:instruments_line, line)
+        case line
+        when /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} \+\d{4} (\w+): (.*)$/
+          log_type = $1
+          message  = $2
+
+          notify_listeners("log_#{log_type.downcase}".to_sym, message)
+        when /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} \+\d{4} logElementTree:$/
+          @element_tree = ""
+          notify_listeners(:element_tree_start)
+        when /^UIATarget .+$/
+          @element_tree << line + "\n"
+          notify_listeners(:element_tree_line, line)
+        when /^elements: \{$/
+          @element_tree << line + "\n"
+          notify_listeners(:element_tree_line, line)
+        when /^\t+.+$/
+          @element_tree << line + "\n"
+          notify_listeners(:element_tree_line, line)
+        when /^\}$/
+          @element_tree << line
+
+          notify_listeners(:element_tree, @element_tree)
+          notify_listeners(:element_tree_line, line)
+          notify_listeners(:element_tree_finish)
+        when /^Instruments Trace Complete \(Duration : (.+); Output : (.+)$/
+          duration       = $1
+          trace_location = $2
+
+          notify_listeners(:script_summary, duration, trace_location)
+        else
+          notify_listeners(:unknown, line)
+        end
+      end
+    end
+
+    def run_start
+      notify_listeners(:run_start)
+    end
+
+    def run_finish
+      notify_listeners(:run_finish)
+    end
+
+    def script_start(script)
+      notify_listeners(:script_start, script)
+    end
+
+    def script_finish(script)
+      notify_listeners(:script_finish, script)
+    end
+
+    def load_simulator_data(data)
+      notify_listeners(:load_simulator_data, data)
+    end
+
+    protected
+
+    def notify_listeners(event, *args)
+      @listeners.each do |listener|
+        listener.send(event, *args)
+      end
+    end
+  end
+end

data/lib/uiauto/runner.rb

@@ -1,42 +1,60 @@
 require 'uiauto/instruments'
 require 'uiauto/simulator'
+require 'uiauto/reporter'
+require 'uiauto/formatters'
+require 'uiauto/listeners'
 
 module UIAuto
   class Runner
     def self.run(file_or_dir, options = {})
+      if options[:require]
+        require File.expand_path(options[:require])
+      end
+
+      @reporter = Reporter.new
+      @exit_status_listener = Listeners::ExitStatusListener.new
+      @reporter.add_listener(@exit_status_listener)
+
+      listeners = options[:listeners] || []
+      listeners.each do |listener|
+        @reporter.add_listener(listener)
+      end
+
+      formatter = eval("Formatters::#{options[:format]}.new")
+      @reporter.formatter = formatter
+
+      @reporter.run_start
+
       exit_status = 0
       if file_or_dir.nil?
-        exit_status = self.run_one options
+        self.run_one options
       elsif File.directory?(file_or_dir)
-        exit_status = self.run_all(file_or_dir, options)
+        self.run_all(file_or_dir, options)
       else
-        exit_status = self.run_one(file_or_dir, options)
+        self.run_one(file_or_dir, options)
       end
 
-      exit exit_status
+      @reporter.run_finish
+
+      exit @exit_status_listener.result
     end
 
     private
 
     def self.run_one(script, options)
+      relative_path = File.expand_path(script).sub(File.expand_path('.') + '/', '')
+      @reporter.script_start(relative_path)
       self.process_comment_header script
-      instruments = Instruments.new(script, options)
-      exit_status = instruments.execute
-
-      exit_status
+      instruments = Instruments.new(script, @reporter, options)
+      instruments.execute
+      @reporter.script_finish(relative_path)
     end
 
     def self.run_all(dir, options)
-      exit_status = 0
       scripts = Dir.glob(File.join(dir, "*.js"))
       scripts.each do |script|
-        script_exit_status = self.run_one(script, options)
-        if script_exit_status > exit_status
-          exit_status = script_exit_status
-        end
+        self.run_one(script, options)
       end
-
-      exit_status
     end
 
     def self.process_comment_header(script)
@@ -48,6 +66,8 @@ module UIAuto
             full_path = File.expand_path(File.join(File.dirname(script), path))
           end
 
+          relative_path = full_path.sub(File.expand_path('.') + '/', '')
+          @reporter.load_simulator_data(relative_path)
           simulator = Simulator.new
           simulator.load full_path
         end

data/lib/uiauto/simulator.rb

@@ -3,6 +3,13 @@ require 'fileutils'
 module UIAuto
   class Simulator
     CURRENT_IOS_SDK_VERSION = "6.1"
+    DEVICES = [
+      "iPad",
+      "iPad (Retina)",
+      "iPhone",
+      "iPhone (Retina 3.5-inch)",
+      "iPhone (Retina 4-inch)"
+    ]
 
     def initialize(sdk_version = CURRENT_IOS_SDK_VERSION)
       @sdk_version = sdk_version
@@ -35,11 +42,19 @@ module UIAuto
       `killall "iPhone Simulator" &> /dev/null || true`
     end
 
-    def self.open
+    def self.open(simulator = nil)
       xcode_path     = `xcode-select -p`.strip
       simulator_path = File.join(xcode_path, "/Platforms/iPhoneSimulator.platform/Developer/Applications/iPhone Simulator.app")
 
       `open "#{simulator_path}"`
+
+      if DEVICES.include?(simulator)
+        uiauto_root = Gem::Specification.find_by_name("uiauto").gem_dir
+        choose_sim_device = File.join(uiauto_root, "helpers/choose_sim_device")
+        `#{choose_sim_device} "#{simulator}"`
+      elsif !simulator.nil?
+        puts "Invalid simulator: \"#{simulator}\""
+      end
     end
 
     private

data/lib/uiauto/version.rb

@@ -1,3 +1,3 @@
 module UIAuto
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/uiauto.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "CFPropertyList"
   spec.add_dependency "thor"
+  spec.add_dependency "childprocess"
+  spec.add_dependency "rainbow"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uiauto
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Enriquez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: UI Automation script runner.
 email:
 - mike@enriquez.me
@@ -80,9 +108,20 @@ files:
 - README.md
 - Rakefile
 - bin/uiauto
+- helpers/choose_sim_device
 - lib/uiauto.rb
 - lib/uiauto/cli.rb
+- lib/uiauto/formatters.rb
+- lib/uiauto/formatters/README.md
+- lib/uiauto/formatters/base_formatter.rb
+- lib/uiauto/formatters/color_indent_formatter.rb
+- lib/uiauto/formatters/instruments_formatter.rb
 - lib/uiauto/instruments.rb
+- lib/uiauto/listeners.rb
+- lib/uiauto/listeners/README.md
+- lib/uiauto/listeners/base_listener.rb
+- lib/uiauto/listeners/exit_status_listener.rb
+- lib/uiauto/reporter.rb
 - lib/uiauto/runner.rb
 - lib/uiauto/simulator.rb
 - lib/uiauto/version.rb