illuminator 0.1.0

data/gem/lib/illuminator/javascript-runner.rb

@@ -0,0 +1,98 @@
+require 'erb'
+require 'pathname'
+require 'json'
+require 'socket'
+require 'digest/sha1'
+
+require_relative './build-artifacts'
+require_relative './host-utils'
+require_relative './xcode-utils'
+
+# Class to handle all configuration relating to the javascript environment
+# "runner" is a bit of a misnomer (this runs as part of instruments) but without this code, nothing runs
+class JavascriptRunner
+
+  attr_reader   :saltinel # the salted sentinel
+  attr_accessor :target_device_id
+  attr_accessor :is_hardware
+  attr_accessor :entry_point
+  attr_accessor :test_path
+  attr_accessor :implementation
+  attr_accessor :sim_device
+  attr_accessor :sim_version
+  attr_accessor :random_seed
+  attr_accessor :tags_any
+  attr_accessor :tags_all
+  attr_accessor :tags_none
+  attr_accessor :scenario_list
+  attr_accessor :scenario_number_offset # for consistent numbering after restarts
+  attr_accessor :app_specific_config
+
+  def initialize
+    @tags_any        = Array.new(0)
+    @tags_all        = Array.new(0)
+    @tags_none       = Array.new(0)
+    @scenario_list   = nil
+  end
+
+
+  def assemble_config
+    @full_config = {}
+
+    # a mapping of the full config key name to the local value that corresponds to it
+    key_defs = {
+      'saltinel'                     => @saltinel,
+      'entryPoint'                   => @entry_point,
+      'implementation'               => @implementation,
+      'automatorDesiredSimDevice'    => @sim_device,
+      'automatorDesiredSimVersion'   => @sim_version,
+      'targetDeviceID'               => @target_device_id,
+      'isHardware'                   => @is_hardware,
+      'xcodePath'                    => Illuminator::XcodeUtils.instance.get_xcode_path,
+      'automatorSequenceRandomSeed'  => @random_seed,
+      'automatorTagsAny'             => @tags_any,
+      'automatorTagsAll'             => @tags_all,
+      'automatorTagsNone'            => @tags_none,
+      'automatorScenarioNames'       => @scenario_list,
+      'automatorScenarioOffset'      => @scenario_number_offset,
+      'customConfig'                 => (@app_specific_config.is_a? Hash) ? @app_specific_config : @app_specific_config.to_h,
+    }
+
+    key_defs.each do |key, value|
+        @full_config[key] = value unless value.nil?
+    end
+
+  end
+
+
+  def write_configuration()
+    # instance variables required for render_template
+    @saltinel                     = Digest::SHA1.hexdigest (Time.now.to_i.to_s + Socket.gethostname)
+    @illuminator_root             = Illuminator::HostUtils.realpath(File.join(File.dirname(__FILE__), "../../resources/js/"))
+    @illuminator_scripts          = Illuminator::HostUtils.realpath(File.join(File.dirname(__FILE__), "../../resources/scripts/"))
+    @artifacts_root               = Illuminator::BuildArtifacts.instance.root
+    @illuminator_instruments_root = Illuminator::BuildArtifacts.instance.instruments
+    @environment_file             = Illuminator::BuildArtifacts.instance.illuminator_js_environment
+
+    # prepare @full_config
+    assemble_config
+
+    render_template('/resources/IlluminatorGeneratedRunnerForInstruments.erb',
+                    Illuminator::BuildArtifacts.instance.illuminator_js_runner)
+    render_template('/resources/IlluminatorGeneratedEnvironment.erb',
+                    Illuminator::BuildArtifacts.instance.illuminator_js_environment)
+
+    Illuminator::HostUtils.save_json(@full_config, Illuminator::BuildArtifacts.instance.illuminator_config_file)
+  end
+
+
+  def render_template source_file, destination_file
+    contents = File.open(File.dirname(__FILE__) + source_file, 'r') { |f| f.read }
+
+    renderer = ERB.new(contents)
+    new_file = File.open(destination_file, 'w')
+    new_file.write(renderer.result(binding))
+    new_file.close
+  end
+
+end

data/gem/lib/illuminator/listeners/console-logger.rb

@@ -0,0 +1,32 @@
+
+require 'logger'
+require_relative '../build-artifacts'
+require_relative './instruments-listener'
+
+class ConsoleLogger < InstrumentsListener
+
+  def initialize
+    @run_number = 0
+    @logger = nil
+  end
+
+  def prepare_logger
+    return unless @logger.nil?
+    @run_number += 1
+    filename = File.join(Illuminator::BuildArtifacts.instance.console, "instruments#{@run_number.to_s.rjust(3, "0")}.log")
+    FileUtils.rmtree filename
+    @logger = Logger.new(filename)
+  end
+
+  def receive (message)
+    prepare_logger
+    @logger << message.full_line
+    @logger << "\n"
+  end
+
+  def on_automation_finished
+    @logger.close unless @logger.nil?
+    @logger = nil
+  end
+
+end

data/gem/lib/illuminator/listeners/full-output.rb

@@ -0,0 +1,13 @@
+
+require_relative './instruments-listener'
+
+class FullOutput < InstrumentsListener
+
+  def receive (message)
+    puts message.full_line
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/listeners/instruments-listener.rb

@@ -0,0 +1,22 @@
+
+class InstrumentsListener
+
+  def receive (message)
+    puts message.full_line
+    puts "  date:    #{message.date}"
+    puts "  time:    #{message.time}"
+    puts "  tz:      #{message.tz}"
+    puts "  status:  #{message.status}"
+    puts "  message: #{message.message}"
+    puts "  --- If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+    puts
+  end
+
+  def on_automation_finished
+    puts " ==="
+    puts " === If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+    puts " ==="
+    puts
+  end
+
+end

data/gem/lib/illuminator/listeners/intermittent-failure-detector.rb

@@ -0,0 +1,49 @@
+
+require_relative './saltinel-listener'
+
+module IntermittentFailureDetectorEventSink
+
+  def intermittent_failure_detector_triggered message
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+end
+
+# IntermittentFailureDetector monitors the logs for things that indicate a transient failure to start instruments
+#  - UIATargetHasGoneAWOLException
+#  - etc
+class IntermittentFailureDetector < SaltinelListener
+
+  attr_accessor :event_sink
+
+  def on_init
+    @already_started = false
+  end
+
+  def trigger message
+    @event_sink.intermittent_failure_detector_triggered message
+  end
+
+  def receive message
+    super # run the SaltinelListener processor
+
+    # error cases that should trigger a restart
+    p = /Automation Instrument ran into an exception while trying to run the script.  UIATargetHasGoneAWOLException/
+    if p =~ message.full_line
+      trigger "UIATargetHasGoneAWOLException"
+    end
+
+    p = /Fail: Could not start script, target application is not frontmost./
+    if p =~ message.full_line
+      trigger "Could not start script, target application is not frontmost"
+    end
+  end
+
+  def on_saltinel inner_message
+    # no cases yet
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/listeners/pretty-output.rb

@@ -0,0 +1,26 @@
+
+require_relative './instruments-listener'
+
+class PrettyOutput < InstrumentsListener
+
+  def receive (message)
+    case message.status
+    when :start
+      puts "Start: #{message.message}".green
+    when :pass
+      puts "Pass: #{message.message}".green
+      puts
+    when :fail, :error, :issue
+      puts "Fail: #{message.message}".red
+    when :warning
+      puts "Warn: #{message.message}".yellow
+    when :default
+      puts "      #{message.message}"
+    end
+
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/listeners/saltinel-agent.rb

@@ -0,0 +1,66 @@
+
+require_relative './saltinel-listener'
+
+module SaltinelAgentEventSink
+
+  def saltinel_agent_got_scenario_list jsonPath
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+  def saltinel_agent_got_scenario_definitions jsonPath
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+  def saltinel_agent_got_stacktrace_hint
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+  def saltinel_agent_got_restart_request
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+end
+
+# Saltinel Agent handles all known saltinel messages and runs callbacks
+class SaltinelAgent < SaltinelListener
+
+  attr_accessor :event_sink
+
+  def on_init
+    @recognizers = {
+      "recognize_test_list"       => /Saved intended test list to: (.*)/,
+      "recognize_test_defs"       => /Saved scenario definitions to: (.*)/,
+      "recognize_stacktrace"      => /Stack trace follows:/,
+      "recognize_restart_request" => /Request instruments restart/,
+    }
+  end
+
+  def recognize_test_list regexResult
+    # assume developer has set event_sink already
+    @event_sink.saltinel_agent_got_scenario_list(regexResult.to_a[1])
+  end
+
+  def recognize_test_defs regexResult
+    # assume developer has set event_sink already
+    @event_sink.saltinel_agent_got_scenario_definitions(regexResult.to_a[1])
+  end
+
+  def recognize_stacktrace _
+    @event_sink.saltinel_agent_got_stacktrace_hint
+  end
+
+  def recognize_restart_request _
+    @event_sink.saltinel_agent_got_restart_request
+  end
+
+  def on_saltinel inner_message
+    @recognizers.each do |fn, regex|
+      result = regex.match(inner_message)
+      send(fn, result) unless result.nil?
+    end
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/listeners/saltinel-listener.rb

@@ -0,0 +1,26 @@
+
+require_relative './instruments-listener'
+
+# A listener class that just looks for saltinel messages and parses them,
+#  sending them off to a subclassable handler
+class SaltinelListener < InstrumentsListener
+
+  def initialize saltinel
+    @saltinel = saltinel
+    on_init
+  end
+
+  def on_init
+  end
+
+  def receive (message)
+    unsalted = /^#{@saltinel} (.*) #{@saltinel}/.match(message.message)
+    on_saltinel(unsalted.to_a[1]) unless unsalted.nil?
+  end
+
+  def on_saltinel inner_message
+    puts "CAUGHT SALTINEL MESSAGE in #{self.class.name}.on_saltinel".red
+    puts inner_message.green
+  end
+
+end

data/gem/lib/illuminator/listeners/start-detector.rb

@@ -0,0 +1,52 @@
+
+require_relative './saltinel-listener'
+
+module StartDetectorEventSink
+
+  def start_detector_triggered
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+end
+
+# StartDetector monitors the logs for things that indicate a successful startup of instruments
+#  - the saltinel for the intended test list
+#  - a javascript error
+#  - etc
+class StartDetector < SaltinelListener
+
+  attr_accessor :event_sink
+
+  def on_init
+    @already_started = false
+  end
+
+  def trigger
+    # assume developer has set event_sink already
+    @event_sink.start_detector_triggered unless @already_started
+    @already_started = true
+  end
+
+  def receive message
+    super # run the SaltinelListener processor
+
+    # error cases that indicate successful start but involve errors that won't be fixed by a restart
+    trigger if :error == message.status and /Script threw an uncaught JavaScript error:/ =~ message.message
+
+    # Instruments usage error generally means we can't recover... unless it's a device booting issue
+    if /^Instruments Usage Error :/ =~ message.full_line
+      unless /^Instruments Usage Error : Timed out waiting for device to boot:/ =~ message.full_line
+        trigger
+      end
+    end
+  end
+
+  def on_saltinel inner_message
+    trigger if /Saved intended test list to/ =~ inner_message
+    trigger if /Successful launch/ =~ inner_message
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/listeners/stop-detector.rb

@@ -0,0 +1,46 @@
+
+require_relative 'instruments-listener'
+
+module StopDetectorEventSink
+
+  # fatal means that restarting instruments won't fix it
+  def stop_detector_triggered(fatal, message)
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+end
+
+# StopDetector monitors the logs for things that indicate that instruments should be stopped (user errors)
+#  - a message that automation has stopped
+#  - a message that the user needs to enter credentials
+#  - etc
+class StopDetector < InstrumentsListener
+
+  attr_accessor :event_sink
+
+  def trigger(fatal, message)
+    # assume developer has set event_sink already
+    @event_sink.stop_detector_triggered(fatal, message)
+  end
+
+  def receive message
+    # error cases that indicate successful stop but involve errors that won't be fixed by a restart
+
+    # like if instruments says it stopped
+    trigger(false, message.message) if :stopped == message.status
+
+    # or if instruments prompts for username/password
+    p1 = "instruments: Instruments wants permission to analyze other processes."
+    p2 = "Please enter an administrator username and password to allow this."
+
+    p = /#{p1} #{p2}/
+    if p =~ message.full_line
+      trigger(true, "Instruments needs permission to analyze other processes.  Please run instruments manually to permit this.")
+    end
+
+  end
+
+  def on_automation_finished
+  end
+
+end

data/gem/lib/illuminator/listeners/test-listener.rb

@@ -0,0 +1,58 @@
+require 'date'
+
+require_relative './instruments-listener'
+
+module TestListenerEventSink
+
+  def test_listener_got_test_start name
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+  def test_listener_got_test_pass name
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+  def test_listener_got_test_fail message
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+  def test_listener_got_test_error message
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+
+  def test_listener_got_line(status, message)
+    puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
+  end
+
+end
+
+
+class TestListener < InstrumentsListener
+
+  attr_accessor :event_sink
+
+  def receive(message)
+    # assume developer has set event_sink already
+
+    # signal test starts before general logging
+    @event_sink.test_listener_got_test_start message.message if message.status == :start
+
+    # log all lines
+    if message.status == :unknown
+      @event_sink.test_listener_got_line nil, message.full_line
+    else
+      @event_sink.test_listener_got_line message.status, message.message
+    end
+
+    # signal test ends after logs
+    @event_sink.test_listener_got_test_pass message.message if message.status == :pass
+    @event_sink.test_listener_got_test_fail message.message if message.status == :fail
+    @event_sink.test_listener_got_test_error message.message if message.status == :error
+
+  end
+
+  def on_automation_finished
+  end
+
+end