illuminator 0.1.0

data/gem/lib/illuminator/listeners/trace-error-detector.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+
+module TraceErrorDetectorEventSink
+
+  # fatal means that restarting instruments won't fix it
+  def trace_error_detector_triggered(fatal, message)
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+end
+
+# TraceErrorDetector monitors the logs for things that indicate a transient failure to start instruments
+#  - "unable to install app"
+#  - etc
+class TraceErrorDetector < InstrumentsListener
+
+  attr_accessor :event_sink
+
+  def trigger(fatal, message)
+    @event_sink.trace_error_detector_triggered(fatal, message)
+  end
+
+  def receive message
+    itr = "Instruments Trace Error : Target failed to run:"
+    if message.full_line =~ /#{itr} Unable to install app with path:/
+      trigger(false, "Failed to install app because #{message.full_line.split(': ')[-1]}")
+    elsif message.full_line =~ /#{itr} The operation couldn’t be completed./
+      trigger(false, "An operation couldn't be completed because #{message.full_line.split(': ')[-1]}")
+    elsif message.full_line =~ /Instruments Trace Error/i
+      trigger(false, message.full_line.split(' : ')[1..-1].join)
+    end
+
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/options.rb

@@ -0,0 +1,96 @@
+
+require 'ostruct'
+
+class RecursiveOpenStruct < OpenStruct
+
+  def initialize(hash=nil)
+    # preprocess hash objects into openstruct objects
+    unless hash.nil?
+      hash.each do |k, v|
+        hash[k] = RecursiveOpenStruct.new(v) if v.is_a? Hash
+      end
+    end
+
+    super
+  end
+
+  # recursively translate the openstruct hierarchy to a hash hierarchy
+  def to_h
+    ret = super
+
+    ret.each do |k, v|
+      ret[k] = v.to_h if v.is_a? RecursiveOpenStruct
+    end
+
+    return ret
+  end
+end
+
+module Illuminator
+  class Options < RecursiveOpenStruct
+
+    def initialize(hash=nil)
+      super
+      return unless hash.nil?
+
+      # stub out all the branches
+      self.xcode        = RecursiveOpenStruct.new
+      self.instruments  = RecursiveOpenStruct.new
+      self.simulator    = RecursiveOpenStruct.new
+      self.javascript   = RecursiveOpenStruct.new
+      self.illuminator  = RecursiveOpenStruct.new
+      self.app_specific = nil    # all unknown options will go here
+      self.build_artifacts_dir = nil
+
+      self.illuminator.clean  = RecursiveOpenStruct.new
+      self.illuminator.task   = RecursiveOpenStruct.new
+      self.illuminator.test   = RecursiveOpenStruct.new
+
+      self.illuminator.test.tags   = RecursiveOpenStruct.new
+      self.illuminator.test.retest = RecursiveOpenStruct.new
+
+      # name all the keys (just for visibiilty)
+      self.xcode.project_dir = nil
+      self.xcode.project = nil
+      self.xcode.app_name = nil
+      self.xcode.sdk = nil
+      self.xcode.workspace = nil
+      self.xcode.scheme = nil
+      self.xcode.environment_vars = nil
+
+      self.illuminator.entry_point = nil
+      self.illuminator.test.random_seed = nil
+      self.illuminator.test.tags.any = nil
+      self.illuminator.test.tags.all = nil
+      self.illuminator.test.tags.none = nil
+      self.illuminator.test.names = nil
+      self.illuminator.test.retest.attempts = nil
+      self.illuminator.test.retest.solo = nil
+      self.illuminator.clean.xcode = nil
+      self.illuminator.clean.derived = nil
+      self.illuminator.clean.artifacts = nil
+      self.illuminator.clean.no_delay = nil
+      self.illuminator.task.build = nil
+      self.illuminator.task.automate = nil
+      self.illuminator.task.set_sim = nil
+      self.illuminator.task.coverage = nil
+      self.illuminator.hardware_id = nil
+
+      self.simulator.device = nil
+      self.simulator.version = nil
+      self.simulator.language = nil
+      self.simulator.kill_after = nil
+
+      self.instruments.do_verbose = nil
+      self.instruments.timeout = nil
+      self.instruments.max_silence = nil
+      self.instruments.attempts = nil
+      self.instruments.app_location = nil  # normally, this is where we build to
+
+      self.javascript.test_path = nil
+      self.javascript.implementation = nil
+      self.javascript.app_specific_config = nil
+    end
+
+  end
+end

data/gem/lib/illuminator/resources/IlluminatorGeneratedEnvironment.erb

@@ -0,0 +1,13 @@
+/**
+ * This file is generated automatically.
+ * It provides global path information that would be problematic to introduce through config values
+ *  (especially given that the config comes from a file)
+ */
+
+// Based on the way UIAutomation processes imports, this will be the first line of code to actually execute
+UIALogger.logDebug("Illuminator has launched.");
+
+var IlluminatorRootDirectory = "<%= @illuminator_root %>";
+var IlluminatorScriptsDirectory = "<%= @illuminator_scripts %>";
+var IlluminatorBuildArtifactsDirectory = "<%= @artifacts_root %>";
+var IlluminatorInstrumentsOutputDirectory = "<%= @illuminator_instruments_root %>";

data/gem/lib/illuminator/resources/IlluminatorGeneratedRunnerForInstruments.erb

@@ -0,0 +1,19 @@
+#import "<%= @environment_file %>";
+#import "<%= @illuminator_root %>/Preferences.js";
+#import "<%= @illuminator_root %>/Extensions.js";
+#import "<%= @illuminator_root %>/Base64.js";
+#import "<%= @illuminator_root %>/Config.js";
+#import "<%= @illuminator_root %>/AppMap.js";
+#import "<%= @illuminator_root %>/Automator.js";
+#import "<%= @illuminator_root %>/Bridge.js";
+#import "<%= @illuminator_root %>/Illuminator.js";
+#import "<%= @test_path %>";
+
+/**
+ * IlluminatorGeneratedRunnerForInstruments.js is generated from
+ *  IlluminatorGeneratedRunnerForInstruments.erb; it should not be hand-edited.
+ *
+ * This file is used to import your test definitions into the automation framework.
+ */
+
+IlluminatorIlluminate();

data/gem/lib/illuminator/test-definitions.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+# A class to hold the defintions of all automator tests, as defined in the (generated) automatorScenarios.json
+class TestDefinitions
+
+  def initialize automator_settings_json_path
+    raw_defs = JSON.parse( IO.read(automator_settings_json_path) )
+    @in_order = raw_defs["scenarios"].dup
+
+    # save test defs for use later (as lookups)
+    @by_name = {}
+    @in_order.each { |scen| @by_name[scen["title"]] = scen }
+  end
+
+  def by_name name
+    @by_name[name].dup
+  end
+
+  def by_index idx
+    @in_order[idx].dup
+  end
+
+end

data/gem/lib/illuminator/test-suite.rb

@@ -0,0 +1,155 @@
+require 'date'
+
+class TestSuite
+
+  attr_reader :test_cases
+  attr_reader :implementation
+
+  def initialize(implementation)
+    @implementation = implementation
+    @test_cases     = []
+    @case_lookup    = {}
+  end
+
+  def add_test_case(class_name, name)
+    test = TestCase.new(@implementation, class_name, name)
+    @test_cases << test
+    @case_lookup[name] = test
+  end
+
+  def [](test_case_name)
+    @case_lookup[test_case_name]
+  end
+
+  # TODO: fix naming, some of these return test cases and some return arrays of names
+
+  def unstarted_tests
+    @test_cases.reject { |t| t.ran? }.map { |t| t.name }
+  end
+
+  def finished_tests
+    @test_cases.select { |t| t.ran? } .map { |t| t.name }
+  end
+
+  def all_tests
+    @test_cases.dup
+  end
+
+  def passed_tests
+    @test_cases.select { |t| t.passed? }
+  end
+
+  def unpassed_tests
+    @test_cases.reject { |t| t.passed? }
+  end
+
+  def to_xml
+    output = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' << "\n"
+
+    output << "<testsuite>\n"
+    @test_cases.each { |test| output << test.to_xml }
+    output << "</testsuite>" << "\n"
+    output
+  end
+end
+
+class TestCase
+  attr_reader :name
+  attr_reader :class_name
+  attr_reader :implementation
+
+  attr_accessor :stacktrace
+
+  def initialize(implementation, class_name, name)
+    @implementation = implementation
+    @class_name     = class_name
+    @name           = name
+    reset!
+  end
+
+  def <<(stdoutLine)
+    @stdout << stdoutLine
+  end
+
+  def reset!
+    @stdout        = []
+    @stacktrace    = ""
+    @fail_message  = ""
+    @fail_tag      = nil
+    @time_start    = nil
+    @time_finish   = nil
+  end
+
+  def start!
+    @time_start = Time.now
+  end
+
+  def pass!
+    @time_finish = Time.now
+  end
+
+  def fail message
+    @time_finish  = Time.now
+    @fail_tag     = "failure"
+    @fail_message = message
+  end
+
+  def error message
+    @time_finish  = Time.now
+    @fail_tag     = "error"
+    @fail_message = message
+  end
+
+  def ran?
+    not (@time_start.nil? or @time_finish.nil?)
+  end
+
+  def passed?
+    @fail_tag.nil?
+  end
+
+  # this is NOT the opposite of passed!  this does not count errored tests
+  def failed?
+    @fail_tag == "failure"
+  end
+
+  def errored?
+    @fail_tag == "error"
+  end
+
+  def time
+    return 0 if @time_finish.nil?
+    @time_finish - @time_start
+  end
+
+  def to_xml
+    attrs = {
+      "name"      => @name,
+      "classname" => "#{@implementation}.#{@class_name}",
+      "time"      => time,
+    }
+
+    output = "  <testcase"
+    attrs.each { |key, value| output << " #{key}=#{value.to_s.encode(:xml => :attr)}" }
+    output << ">\n"
+
+    if not ran?
+      output << "    <skipped />\n"
+    elsif (not @fail_tag.nil?)
+      fattrs = {
+        "message" => @fail_message,
+      }
+
+      output << "    <#{@fail_tag}"
+      fattrs.each { |key, value| output << " #{key}=#{value.to_s.encode(:xml => :attr)}" }
+      output << ">#{@stacktrace.to_s.encode(:xml => :text)}" << "\n"
+      output << "    </#{@fail_tag}>" << "\n"
+    end
+
+    output << "    <system-out>#{@stdout.map { |m| m.encode(:xml => :text) }.join("\n")}" << "\n"
+    output << "    </system-out>" << "\n"
+
+    output << "  </testcase>" << "\n"
+
+  end
+end

data/gem/lib/illuminator/version.rb

@@ -0,0 +1,3 @@
+module Illuminator
+  VERSION = "0.1.0"
+end

data/gem/lib/illuminator/xcode-builder.rb

@@ -0,0 +1,144 @@
+require 'colorize'
+
+require_relative './build-artifacts'
+require_relative './host-utils'
+
+module Illuminator
+  class XcodeBuilder
+    attr_accessor :project
+    attr_accessor :configuration
+    attr_accessor :sdk
+    attr_accessor :arch
+    attr_accessor :scheme
+    attr_accessor :project_dir
+    attr_accessor :workspace
+    attr_accessor :destination
+    attr_accessor :xcconfig
+    attr_accessor :do_clean
+    attr_accessor :do_test
+    attr_accessor :do_build
+    attr_accessor :do_archive
+    attr_accessor :derived_data_is_artifact
+
+    attr_reader :exit_code
+
+    def initialize
+      @parameters       = Hash.new
+      @environment_vars = Hash.new
+      @project_dir      = nil
+      @do_clean         = FALSE
+      @do_test          = FALSE
+      @do_build         = TRUE
+      @do_archive       = FALSE
+      @exit_code        = nil
+
+      @derived_data_is_artifact = FALSE
+
+      result_path = Illuminator::BuildArtifacts.instance.xcode
+      add_environment_variable('CONFIGURATION_BUILD_DIR', "'#{result_path}'")
+      add_environment_variable('CONFIGURATION_TEMP_DIR', "'#{result_path}'")
+    end
+
+    def set_build_artifacts_root root_dir
+      Illuminator::BuildArtifacts.instance.set_root(root_dir)
+    end
+
+    def add_parameter(parameter_name = '',parameter_value = '')
+      @parameters[parameter_name] = parameter_value
+    end
+
+    def add_environment_variable(parameter_name = '',parameter_value = '')
+      @environment_vars[parameter_name] = parameter_value
+    end
+
+    def _assemble_config
+      # put standard parameters into parameters
+      key_defs = {
+        'project'       => @project,
+        'configuration' => @configuration,
+        'sdk'           => @sdk,
+        'arch'          => @arch,
+        'scheme'        => @scheme,
+        'destination'   => @destination,
+        'workspace'     => @workspace,
+        'xcconfig'      => @xcconfig,
+      }
+
+      # since derived data can take quite a lot of disk space, don't automatically store it
+      #  in build-specific directory
+      if @derived_data_is_artifact
+        key_defs['derivedDataPath'] = Illuminator::BuildArtifacts.instance.derived_data
+      end
+
+      key_defs.each do |key, value|
+        add_parameter(key, value) unless value.nil?
+      end
+    end
+
+
+    def _build_command
+      use_pipefail = false  # debug option
+      _assemble_config
+
+      parameters = ''
+      environment_vars = ''
+      tasks = ''
+
+      @parameters.each      { |name, value| parameters << " -#{name} \"#{value}\"" }
+      @environment_vars.each { |name, value| environment_vars << " #{name}=#{value}" }
+
+      tasks << ' clean'    if @do_clean
+      tasks << ' build'    if @do_build
+      tasks << ' archive'  if @do_archive
+      tasks << ' test'     if @do_test
+
+      command = ''
+      command << 'set -o pipefail && ' if use_pipefail
+      command << 'xcodebuild'
+      command << parameters << environment_vars << tasks
+      command << " | tee '#{logfile_path}'"
+      unless Illuminator::HostUtils.which("xcpretty").nil?  # use xcpretty if available
+        command << " | xcpretty -c -r junit -o \"#{BuildArtifacts.instance.xcpretty_report_file}\""
+      end
+      command << ' && exit ${PIPESTATUS[0]}' unless use_pipefail
+
+      command
+    end
+
+
+    def logfile_path
+      log_file = File.join(Illuminator::BuildArtifacts.instance.console, 'xcodebuild.log')
+    end
+
+
+    def _execute_build_command command
+      puts command.green
+      process = IO.popen(command) do |io|
+        io.each {|line| puts line}
+        io.close
+      end
+
+      ec = $?
+      @exit_code = ec.exitstatus
+      return @exit_code == 0
+    end
+
+
+    def build
+      command = _build_command
+
+      # switch to a directory (if desired) and build
+      directory = Dir.pwd
+      retval = nil
+      begin
+        Dir.chdir(@project_dir) unless @project_dir.nil?
+        retval = _execute_build_command command
+      ensure
+        Dir.chdir(directory) unless @project_dir.nil?
+      end
+
+      retval
+    end
+
+  end
+end