run_loop 1.5.5 → 1.5.6.pre1

data/lib/run_loop/directory.rb

@@ -42,27 +42,114 @@ module RunLoop
       debug = RunLoop::Environment.debug?
 
       sha = OpenSSL::Digest::SHA256.new
-      self.recursive_glob_for_entries(path).each do |file|
-        if File.directory?(file)
-          # skip directories
-        elsif !Pathname.new(file).exist?
-          # skip broken symlinks
-        else
-          case File.ftype(file)
-            when 'fifo'
-              RunLoop.log_warn("SHA1 SKIPPING FIFO #{file}") if debug
-            when 'socket'
-              RunLoop.log_warn("SHA1 SKIPPING SOCKET #{file}") if debug
-            when 'characterSpecial'
-              RunLoop.log_warn("SHA1 SKIPPING CHAR SPECIAL #{file}") if debug
-            when 'blockSpecial'
-              RunLoop.log_warn("SHA1 SKIPPING BLOCK SPECIAL #{file}") if debug
-            else
-              sha << File.read(file)
+      entries.each do |file|
+        unless self.skip_file?(file, 'SHA1', debug)
+          begin
+            sha << File.read(file)
+          rescue => e
+            if debug
+              RunLoop.log_warn(%Q{
+RunLoop::Directory.directory_digest raised an error:
+
+#{e}
+
+while trying to find the SHA of this file:
+
+#{file}
+
+Please report this here:
+
+https://github.com/calabash/run_loop/issues
+
+})
+            end
           end
         end
       end
       sha.hexdigest
     end
+
+    def self.size(path, format)
+
+      allowed_formats = [:bytes, :kb, :mb, :gb]
+      unless allowed_formats.include?(format)
+        raise ArgumentError, "Expected '#{format}' to be one of #{allowed_formats.join(', ')}"
+      end
+
+      unless File.exist?(path)
+        raise ArgumentError, "Expected '#{path}' to exist"
+      end
+
+      unless File.directory?(path)
+        raise ArgumentError, "Expected '#{path}' to be a directory"
+      end
+
+      entries = self.recursive_glob_for_entries(path)
+
+      if entries.empty?
+        raise ArgumentError, "Expected a non-empty dir at '#{path}' found '#{entries}'"
+      end
+
+      size = self.iterate_for_size(entries)
+
+      case format
+        when :bytes
+          size
+        when :kb
+          size/1000.0
+        when :mb
+          size/1000.0/1000.0
+        when :gb
+          size/1000.0/1000.0/1000.0
+        else
+          # Not expected to reach this.
+          size
+      end
+    end
+
+    private
+
+    def self.skip_file?(file, task, debug)
+      skip = false
+      if File.directory?(file)
+        # Skip directories
+        skip = true
+      elsif !Pathname.new(file).exist?
+        # Skip broken symlinks
+        skip = true
+      elsif !File.exist?(file)
+        # Skip files that don't exist
+        skip = true
+      else
+        case File.ftype(file)
+          when 'fifo'
+            RunLoop.log_warn("#{task} IS SKIPPING FIFO #{file}") if debug
+            skip = true
+          when 'socket'
+            RunLoop.log_warn("#{task} IS SKIPPING SOCKET #{file}") if debug
+            skip = true
+          when 'characterSpecial'
+            RunLoop.log_warn("#{task} IS SKIPPING CHAR SPECIAL #{file}") if debug
+            skip = true
+          when 'blockSpecial'
+            skip = true
+            RunLoop.log_warn("#{task} SKIPPING BLOCK SPECIAL #{file}") if debug
+          else
+
+        end
+      end
+      skip
+    end
+
+    def self.iterate_for_size(entries)
+      debug = RunLoop::Environment.debug?
+      size = 0
+      entries.each do |file|
+        unless self.skip_file?(file, "SIZE", debug)
+          size = size + File.size(file)
+        end
+      end
+      size
+    end
   end
 end

data/lib/run_loop/dot_dir.rb

@@ -0,0 +1,83 @@
+# A module for managing the ~/.run-loop directory.
+module RunLoop::DotDir
+
+  def self.directory
+    home = RunLoop::Environment.user_home_directory
+    dir = File.join(home, ".run-loop")
+    if !File.exist?(dir)
+      FileUtils.mkdir_p(dir)
+    end
+    dir
+  end
+
+  def self.make_results_dir
+    if RunLoop::Environment.xtc?
+      next_results_dir = Dir.mktmpdir("run_loop")
+    else
+      results_dir = File.join(self.directory, 'results')
+      next_results_dir = self.next_timestamped_dirname(results_dir)
+      FileUtils.mkdir_p(next_results_dir)
+    end
+
+    next_results_dir
+  end
+
+  def self.rotate_result_directories
+    return :xtc if RunLoop::Environment.xtc?
+
+    start = Time.now
+
+    glob = "#{self.directory}/results/*"
+
+    RunLoop.log_debug("Searching for run-loop results with glob: #{glob}")
+
+    directories = Dir.glob(glob).select do |path|
+      File.directory?(path)
+    end
+
+    oldest_first = directories.sort_by { |f| File.mtime(f) }
+
+    RunLoop.log_debug("Found #{oldest_first.count} previous run-loop results")
+    oldest_first.pop(5)
+
+    RunLoop.log_debug("Will delete #{oldest_first.count} previous run-loop results")
+
+    oldest_first.each do |path|
+      FileUtils.rm_rf(path)
+    end
+
+    elapsed = Time.now - start
+
+    RunLoop.log_debug("Deleted #{oldest_first.count} previous results in #{elapsed} seconds")
+  rescue StandardError => e
+    RunLoop.log_error("While rotating previous results, encounterd: #{e}")
+  end
+
+  private
+
+  def self.timestamped_dirname(plus_seconds = 0)
+    (Time.now + plus_seconds).strftime("%Y-%m-%d_%H-%M-%S")
+  end
+
+  def self.next_timestamped_dirname(base_dir)
+    dir = File.join(base_dir, self.timestamped_dirname)
+    return dir if !File.exist?(dir)
+
+    # Rather than wait, just increment the second.  Per-second accuracy
+    # is not important; uniqueness is.
+    counter = 0
+    loop do
+      break if !File.exist?(dir)
+      break if counter == 4
+      counter = counter + 1
+      dir = File.join(base_dir, self.timestamped_dirname(counter))
+    end
+
+    # If all else fails, just return a unique UUID
+    if File.exist?(dir)
+      dir = File.join(base_dir, SecureRandom.uuid)
+    end
+    dir
+  end
+end
+

data/lib/run_loop/environment.rb

@@ -1,6 +1,18 @@
 module RunLoop
   class Environment
 
+    # Returns the user home directory
+    def self.user_home_directory
+      if self.xtc?
+         home = File.join("./", "tmp", "home")
+         FileUtils.mkdir_p(home)
+         home
+      else
+        require 'etc'
+        Etc.getpwuid.dir
+      end
+    end
+
     # Returns true if debugging is enabled.
     def self.debug?
       ENV['DEBUG'] == '1'
@@ -51,13 +63,13 @@ module RunLoop
       if !value || value == ''
         nil
       else
-        value
+        File.expand_path(value)
       end
     end
 
     # Returns the value of DEVELOPER_DIR
     #
-    # @note Never call this directly.  Always create an XCTool instance
+    # @note Never call this directly.  Always create an Xcode instance
     #   and allow it to derive the path to the Xcode toolchain.
     def self.developer_dir
       value = ENV['DEVELOPER_DIR']
@@ -96,13 +108,20 @@ module RunLoop
       end
     end
 
-    def self.with_debugging(&block)
-      original_value = ENV['DEBUG']
-      ENV['DEBUG'] = '1'
-      begin
+    # !@visibility private
+    def self.with_debugging(debug, &block)
+      if debug
+        original_value = ENV['DEBUG']
+
+        begin
+          ENV['DEBUG'] = '1'
+          block.call
+        ensure
+          ENV['DEBUG'] = original_value
+        end
+
+      else
         block.call
-      ensure
-        ENV['DEBUG'] = original_value
       end
     end
   end

data/lib/run_loop/instruments.rb

@@ -7,6 +7,73 @@ module RunLoop
 
     include RunLoop::Regex
 
+    # @!visibility private
+    #
+    # Rotates xrtmp__ directories in /Library/Caches/com.apple.dt.instruments
+    # keeping the last 5.  On CI systems these can be hundreds of gigabytes.
+    def self.rotate_cache_directories
+
+      # Never run on the XTC
+      return :xtc if RunLoop::Environment.xtc?
+
+      cache = self.library_cache_dir
+
+      # If the directory does not exist, do nothing.
+      return :no_cache if !cache || !File.exist?(cache)
+
+      start = Time.now
+
+      glob = "#{cache}/xrtmp__*"
+
+      RunLoop.log_debug("Searching for instruments caches with glob: #{glob}")
+
+      directories = Dir.glob(glob).select do |path|
+        File.directory?(path)
+      end
+
+      log_progress = false
+      if directories.count > 25
+        RunLoop.log_info2("Found #{directories.count} instruments caches: ~#{20 * directories.count} Mb")
+        RunLoop.log_info2("Deleting them could take a long time.")
+        RunLoop.log_info2("This delay will only happen once!")
+        RunLoop.log_info2("Please be patient and allow the directories to be deleted")
+        log_progress = true
+      else
+        RunLoop.log_debug("Found #{directories.count} instruments caches")
+      end
+
+      if log_progress
+        RunLoop.log_info2("Sorting instruments caches by modification time...")
+      end
+
+      oldest_first = directories.sort_by { |f| File.mtime(f) }
+
+      oldest_first.pop(5)
+
+      if log_progress
+        RunLoop.log_info2("Will delete #{oldest_first.count} instruments caches...")
+      else
+        RunLoop.log_debug("Will delete #{oldest_first.count} instruments caches")
+      end
+
+      oldest_first.each do |path|
+        FileUtils.rm_rf(path)
+        if log_progress
+          printf "."
+        end
+      end
+
+      elapsed = Time.now - start
+
+      if log_progress
+        puts ""
+        RunLoop.log_info2("Deleted #{oldest_first.count} instruments caches in #{elapsed} seconds")
+      else
+        RunLoop.log_debug("Deleted #{oldest_first.count} instruments caches in #{elapsed} seconds")
+      end
+      true
+    end
+
     attr_reader :xcode
 
     def pbuddy
@@ -192,7 +259,8 @@ Please update your sources to pass an instance of RunLoop::Xcode))
         fetch_devices[:out].chomp.split("\n").map do |line|
           stripped = line.strip
           if line_is_simulator?(stripped) &&
-                !line_is_simulator_paired_with_watch?(stripped)
+                !line_is_simulator_paired_with_watch?(stripped) &&
+                !line_is_apple_tv?(stripped)
 
             version = stripped[VERSION_REGEX, 0]
 
@@ -402,6 +470,11 @@ Please update your sources to pass an instance of RunLoop::Xcode))
       line[CORE_SIMULATOR_UDID_REGEX, 0] && line[/Apple Watch/, 0]
     end
 
+    # @!visibility private
+    def line_is_apple_tv?(line)
+      line[/Apple TV/, 0]
+    end
+
     # @!visibility private
     def path_to_instruments_app_plist
       @path_to_instruments_app_plist ||=
@@ -412,5 +485,20 @@ Please update your sources to pass an instance of RunLoop::Xcode))
                                  'Contents',
                                  'Info.plist'))
     end
+
+    # @!visibility private
+    #
+    # Instruments caches files in this directory and it can become quite large
+    # over time; particularly on CI system.
+    def self.library_cache_dir
+      path = "/Library/Caches/com.apple.dt.instruments"
+
+      if File.exist?(path)
+        path
+      else
+        nil
+      end
+    end
   end
 end
+

data/lib/run_loop/logging.rb

@@ -59,6 +59,12 @@ module RunLoop
     end
   end
 
+  # .log_info is already taken by the XTC logger. (>_O)
+  # green
+  def self.log_info2(msg)
+    puts self.green(" INFO: #{msg}") if msg
+  end
+
   # red
   def self.log_error(msg)
     puts self.red("ERROR: #{msg}") if msg
@@ -101,4 +107,9 @@ module RunLoop
   def self.cyan(string)
     colorize(string, 36)
   end
+
+  # @!visibility private
+  def self.green(string)
+    colorize(string, 32)
+  end
 end

data/lib/run_loop/process_terminator.rb

@@ -55,32 +55,22 @@ module RunLoop
     def kill_process
       return true unless process_alive?
 
-      debug_logging = RunLoop::Environment.debug?
       begin
-        if debug_logging
-          puts "Sending '#{kill_signal}' to #{display_name} process '#{pid}'"
-        end
+        RunLoop.log_debug("Sending '#{kill_signal}' to #{display_name} process '#{pid}'")
         Process.kill(kill_signal, pid.to_i)
         # Don't wait.
         # We might not own this process and a WNOHANG would be a nop.
         # Process.wait(pid, Process::WNOHANG)
       rescue Errno::ESRCH
-        if debug_logging
-          puts "Process with pid '#{pid}' does not exist; nothing to do."
-        end
+        RunLoop.log_debug("Process with pid '#{pid}' does not exist; nothing to do.")
         # Return early; there is no need to wait if the process does not exist.
         return true
       rescue Errno::EPERM
-        if debug_logging
-          puts "Cannot kill process '#{pid}' with '#{kill_signal}'; not a child of this process"
-        end
+        RunLoop.log_debug("Cannot kill process '#{pid}' with '#{kill_signal}'; not a child of this process")
       rescue SignalException => e
         raise e.message
       end
-
-      if debug_logging
-        puts "Waiting for #{display_name} '#{pid}' to terminate"
-      end
+      RunLoop.log_debug("Waiting for #{display_name} with pid '#{pid}' to terminate")
       wait_for_process_to_terminate
     end
 
@@ -127,9 +117,7 @@ module RunLoop
         sleep delay
       end
 
-      if RunLoop::Environment.debug?
-        puts "Waited for #{Time.now - now} seconds for #{display_name} with '#{pid}' to terminate"
-      end
+      RunLoop.log_debug("Waited for #{Time.now - now} seconds for #{display_name} with pid '#{pid}' to terminate")
 
       if @options[:raise_on_no_terminate] and !has_terminated
         raise "Waited #{options[:timeout]} seconds for #{display_name} (#{ps_details}) to terminate"

data/lib/run_loop/sim_control.rb

@@ -52,6 +52,10 @@ module RunLoop
       xcode.developer_dir
     end
 
+    def xcrun
+      @xcrun ||= RunLoop::Xcrun.new
+    end
+
     # Return an instance of PlistBuddy.
     # @return [RunLoop::PlistBuddy] The plist buddy instance that is used internally.
     def pbuddy
@@ -1137,55 +1141,61 @@ module RunLoop
     #  base sdk version.
     # @see #simctl_list
     def simctl_list_devices
-      args = 'simctl list devices'.split(' ')
-      Open3.popen3('xcrun', *args) do  |_, stdout,  stderr, _|
-        out = stdout.read.strip
-        err = stderr.read.strip
-        if ENV['DEBUG_UNIX_CALLS'] == '1'
-          cmd = "xcrun #{args.join(' ')}"
-          puts "#{cmd} => stdout: '#{out}' | stderr: '#{err}'"
-        end
+      args = ['simctl', 'list', 'devices']
+      hash = xcrun.exec(args)
 
-        current_sdk = nil
-        res = {}
-        out.split("\n").each do |line|
+      current_sdk = nil
+      simulators = {}
 
-          possible_sdk = line[VERSION_REGEX,0]
-          if possible_sdk
-            current_sdk = possible_sdk
-            res[current_sdk] = []
-            next
-          end
+      out = hash[:out]
 
-          unavailable_sdk = line[/Unavailable/, 0]
-          if unavailable_sdk
-            current_sdk = nil
-            next
-          end
+      out.split("\n").each do |line|
 
-          watch_os = line[/watchOS/, 0]
-          if watch_os
-            current_sdk = nil
-            next
-          end
+        possible_sdk = line[VERSION_REGEX,0]
+        if possible_sdk
+          current_sdk = possible_sdk
+          simulators[current_sdk] = []
+          next
+        end
 
-          watch = line[/Apple Watch/, 0]
-          if watch
-            current_sdk = nil
-            next
-          end
+        unavailable_sdk = line[/Unavailable/, 0]
+        if unavailable_sdk
+          current_sdk = nil
+          next
+        end
 
-          if current_sdk
-            unless line[/unavailable/,0]
-              name = line.split('(').first.strip
-              udid = line[CORE_SIMULATOR_UDID_REGEX,0]
-              state = line[/(Booted|Shutdown)/,0]
-              res[current_sdk] << {:name => name, :udid => udid, :state => state}
-            end
+        watch_os = line[/watchOS/, 0]
+        if watch_os
+          current_sdk = nil
+          next
+        end
+
+        watch = line[/Apple Watch/, 0]
+        if watch
+          current_sdk = nil
+          next
+        end
+
+        tv = line[/Apple TV/, 0]
+        if tv
+          current_sdk = nil
+          next
+        end
+
+        if current_sdk
+          unless line[/unavailable/,0]
+            name = line.split('(').first.strip
+            udid = line[CORE_SIMULATOR_UDID_REGEX,0]
+            state = line[/(Booted|Shutdown)/,0]
+            simulators[current_sdk] << {
+                  :name => name,
+                  :udid => udid,
+                  :state => state
+            }
           end
         end
-        res
       end
+      simulators
     end
 
     # @!visibility private
@@ -1193,48 +1203,75 @@ module RunLoop
     #
     # @example
     #  RunLoop::SimControl.new.simctl_list :runtimes
-    #  {
-    #        "7.0" => {
-    #              :sdk => "7.0.3",
-    #              :runtime => "com.apple.CoreSimulator.SimRuntime.iOS-7-0"
-    #        },
-    #        "7.1" => {
-    #              :sdk => "7.1",
-    #              :runtime => "com.apple.CoreSimulator.SimRuntime.iOS-7-1"
+    #    :iOS => {
+    #       <Version 8.1> => {
+    #         :name => "iOS",
+    #         :runtime => "com.apple.CoreSimulator.SimRuntime.iOS-8-1",
+    #         :complete => "iOS 8.1 (8.1 - 12B411) (com.apple.CoreSimulator.SimRuntime.iOS-8-1)"
     #        },
-    #        "8.0" => {
-    #              :sdk => "8.0",
-    #              :runtime => "com.apple.CoreSimulator.SimRuntime.iOS-8-0"
-    #        }
-    #  }
+    #       ...
+    #    },
+    #
+    #   :tvOS => {
+    #      <Version 9.0> => {
+    #       :name => "tvOS",
+    #       :runtime => "com.apple.CoreSimulator.SimRuntime.tvOS-9-0",
+    #       :complete => "tvOS 9.0 (9.0 - 13T5365h) (com.apple.CoreSimulator.SimRuntime.tvOS-9-0)"
+    #      },
+    #     ...
+    #   },
+    #
+    #   :watchOS => {
+    #      <Version 2.0> => {
+    #       :name => "watchOS",
+    #       :runtime => "com.apple.CoreSimulator.SimRuntime.watchOS-2-0",
+    #       :complete => "watchOS 2.0 (2.0 - 13S343) (com.apple.CoreSimulator.SimRuntime.watchOS-2-0)"
+    #      },
+    #     ...
+    #   }
+    #
     # @see #simctl_list
     def simctl_list_runtimes
-      # The 'com.apple.CoreSimulator.SimRuntime.iOS-7-0' is the runtime-id,
-      # which can be used to create devices.
-      args = 'simctl list runtimes'.split(' ')
-      Open3.popen3('xcrun', *args) do  |_, stdout,  stderr, _|
-        out = stdout.read.strip
-        err = stderr.read.strip
-        if ENV['DEBUG_UNIX_CALLS'] == '1'
-          cmd = "xcrun #{args.join(' ')}"
-          puts "#{cmd}  => stdout: '#{out}' | stderr: '#{err}'"
-        end
-        # Ex.
-        # == Runtimes ==
-        # iOS 7.0 (7.0.3 - 11B507) (com.apple.CoreSimulator.SimRuntime.iOS-7-0)
-        # iOS 7.1 (7.1 - 11D167) (com.apple.CoreSimulator.SimRuntime.iOS-7-1)
-        # iOS 8.0 (8.0 - 12A4331d) (com.apple.CoreSimulator.SimRuntime.iOS-8-0)
-        lines = out.split("\n").delete_if { |line| not line =~ /com.apple.CoreSimulator.SimRuntime/ }
-        res = {}
-        lines.each do |line|
-          key = line[/iOS (\d.\d)/,1]
-          sdk_version = line[/(\d.\d)(.\d)?\s-/, 0].tr(' -','')
-          runtime = line[/com.apple.CoreSimulator.SimRuntime.iOS-\d-\d/,0]
-          value = {:sdk => sdk_version,  :runtime => runtime}
-          res[key] = value
+      args = ['simctl', 'list', 'runtimes']
+      hash = xcrun.exec(args)
+
+      # Ex.
+      # == Runtimes ==
+      # iOS 7.0 (7.0.3 - 11B507) (com.apple.CoreSimulator.SimRuntime.iOS-7-0)
+      # iOS 7.1 (7.1 - 11D167) (com.apple.CoreSimulator.SimRuntime.iOS-7-1)
+      # iOS 8.0 (8.0 - 12A4331d) (com.apple.CoreSimulator.SimRuntime.iOS-8-0)
+
+      out = hash[:out]
+
+      runtimes = {}
+
+      out.split("\n").each do |line|
+        next if line[/unavailable/, 0]
+        next if !line[/com.apple.CoreSimulator.SimRuntime/,0]
+
+        tokens = line.split(' ')
+
+        name = tokens.first
+
+        key = name.to_sym
+
+        unless runtimes[key]
+          runtimes[key] = {}
         end
-        res
+
+        version_str = tokens[1]
+        version = RunLoop::Version.new(version_str)
+
+        runtime = line[/com.apple.CoreSimulator.SimRuntime.*/, 0].chomp(')')
+
+        runtimes[key][version] =
+              {
+                    :name => name,
+                    :runtime => runtime,
+                    :complete => line
+              }
       end
+      runtimes
     end
   end
 end