run_loop_tcc 2.1.3

data/lib/run_loop/environment.rb

@@ -0,0 +1,361 @@
+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 Windows environment
+    def self.windows_env?
+      if @@windows_env.nil?
+        @@windows_env = Environment.host_os_is_win?
+      end
+
+      @@windows_env
+    end
+
+    # Returns true if debugging is enabled.
+    def self.debug?
+      ENV['DEBUG'] == '1'
+    end
+
+    # Returns true if read debugging is enabled.
+    def self.debug_read?
+      ENV['DEBUG_READ'] == '1'
+    end
+
+    # Returns true if we are running on the XTC
+    def self.xtc?
+      ENV['XAMARIN_TEST_CLOUD'] == '1'
+    end
+
+    # Returns the value of DEVICE_TARGET
+    def self.device_target
+      value = ENV["DEVICE_TARGET"]
+      if value.nil? || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of DEVICE_ENDPOINT
+    def self.device_endpoint
+      value = ENV["DEVICE_ENDPOINT"]
+      if value.nil? || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Should the app data be reset between Scenarios?
+    def self.reset_between_scenarios?
+      ENV["RESET_BETWEEN_SCENARIOS"] == "1"
+    end
+
+    # Returns the value of XCODEPROJ which can be used to specify an Xcode
+    # project directory (my.xcodeproj).
+    #
+    # This is useful if your project has multiple xcodeproj directories.
+    #
+    # Most users should not set this variable.
+    def self.xcodeproj
+      value = ENV["XCODEPROJ"]
+      if value.nil? || value == ""
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of DERIVED_DATA which can be used to specify an
+    # alternative DerivedData directory.
+    #
+    # The default is ~/Library/Xcode/DerivedData, but Xcode allows you to
+    # change this value.
+    def self.derived_data
+      value = ENV["DERIVED_DATA"]
+      if value.nil? || value == ""
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of SOLUTION which can be used to specify a
+    # Xamarin Studio .sln
+    #
+    # This is useful if your project has multiple solutions (.sln)
+    # and Calabash cannot detect the correct one.
+    def self.solution
+      value = ENV["SOLUTION"]
+      if value.nil? || value == ""
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of TRACE_TEMPLATE; the Instruments template to use
+    # during testing.
+    def self.trace_template
+      value = ENV['TRACE_TEMPLATE']
+      if value.nil? || value == ""
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of UIA_TIMEOUT.  Use this control how long to wait
+    # for instruments to launch and attach to your application.
+    #
+    # Non-empty values are converted to a float.
+    def self.uia_timeout
+      timeout = ENV['UIA_TIMEOUT']
+      timeout ? timeout.to_f : nil
+    end
+
+    # Returns the value of BUNDLE_ID
+    def self.bundle_id
+      value = ENV['BUNDLE_ID']
+      if !value || value == ''
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns to the path to the app bundle (simulator builds).
+    #
+    # Both APP_BUNDLE_PATH and APP are checked and in that order.
+    #
+    # Use of APP_BUNDLE_PATH is deprecated and will be removed.
+    def self.path_to_app_bundle
+      value = ENV['APP_BUNDLE_PATH'] || ENV['APP']
+      if !value || value == ''
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of DEVELOPER_DIR
+    #
+    # @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']
+      if !value || value == ''
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of CODESIGN_IDENTITY
+    def self.codesign_identity
+      value = ENV["CODESIGN_IDENTITY"]
+      if !value || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of KEYCHAIN
+    #
+    # Use this to specify a non-default KEYCHAIN for code signing.
+    #
+    # The default KEYCHAIN is login.keychain.
+    def self.keychain
+      value = ENV["KEYCHAIN"]
+      if !value || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of XCTESTCTL
+    #
+    # Use this to specify a non-default xctestctl binary.
+    #
+    # The default xctestctl binary is bundled with this gem.
+    def self.xctestctl
+      value = ENV["XCTESTCTL"]
+      if !value || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of CBXDEVICE
+    #
+    # Use this to specify a non-default CBX-Runner for physical devices.
+    #
+    # The default CBX-Runner is bundled with this gem.
+    def self.cbxdevice
+      value = ENV["CBXDEVICE"]
+      if !value || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of CBXSIM
+    #
+    # Use this to specify a non-default CBX-Runner for simulators.
+    #
+    # The default CBX-Runner is bundled with this gem.
+    def self.cbxsim
+      value = ENV["CBXSIM"]
+      if !value || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns the value of DEVICE_ENDPOINT
+    def self.device_agent_url
+      value = ENV["DEVICE_AGENT_URL"]
+      if value.nil? || value == ""
+        nil
+      else
+        value
+      end
+    end
+
+    # Returns true if running in Jenkins CI
+    #
+    # Checks the value of JENKINS_HOME
+    def self.jenkins?
+      value = ENV["JENKINS_HOME"]
+      !!value && value != ''
+    end
+
+    # Returns true if running in Travis CI
+    #
+    # Checks the value of TRAVIS
+    def self.travis?
+      value = ENV["TRAVIS"]
+      !!value && value != ''
+    end
+
+    # Returns true if running in Circle CI
+    #
+    # Checks the value of CIRCLECI
+    def self.circle_ci?
+      value = ENV["CIRCLECI"]
+      !!value && value != ''
+    end
+
+    # Returns true if running in Teamcity
+    #
+    # Checks the value of TEAMCITY_PROJECT_NAME
+    def self.teamcity?
+      value = ENV["TEAMCITY_PROJECT_NAME"]
+      !!value && value != ''
+    end
+
+    # Returns true if running in Teamcity
+    #
+    # Checks the value of GITLAB_CI
+    def self.gitlab?
+      value = ENV["GITLAB_CI"]
+      !!value && value != ''
+    end
+
+    # Returns true if running in a CI environment
+    def self.ci?
+      [
+        self.ci_var_defined?,
+        self.travis?,
+        self.jenkins?,
+        self.circle_ci?,
+        self.teamcity?,
+        self.gitlab?
+      ].any?
+    end
+
+    # !@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
+      end
+    end
+
+    private
+
+    # !@visibility private
+    def self.ci_var_defined?
+      value = ENV["CI"]
+      !!value && value != ''
+    end
+
+    # !@visibility private
+    # Returns the value of CBXWS.  This can be used to override the default
+    # CBXDriver.xcworkspace.  You should only set this if you are actively
+    # developing the CBXDriver.
+    def self.cbxws
+      value = ENV["CBXWS"]
+      if value.nil? || value == ""
+        nil
+      else
+        path = File.expand_path(value)
+        if !File.directory?(path)
+          raise RuntimeError, %Q[CBXWS is set, but there is no workspace at
+#{path}
+
+Only set CBXWS if you are developing new features in the CBXRunner.
+
+Check your environment.]
+        end
+        path
+      end
+    end
+
+    private
+
+    # @visibility private
+    WIN_PATTERNS = [
+      /bccwin/i,
+      /cygwin/i,
+      /djgpp/i,
+      /mingw/i,
+      /mswin/i,
+      /wince/i,
+    ]
+
+    # @!visibility private
+    @@windows_env = nil
+
+    # @!visibility private
+    def self.host_os_is_win?
+      ruby_platform = RbConfig::CONFIG["host_os"]
+      !!WIN_PATTERNS.find { |r| ruby_platform =~ r }
+    end
+  end
+end

data/lib/run_loop/fifo.rb

@@ -0,0 +1,40 @@
+require 'timeout'
+module RunLoop
+  module Fifo
+    BUFFER_SIZE = 4096
+
+    class NoReaderConfiguredError < RuntimeError
+    end
+
+    class WriteTimedOut < RuntimeError
+    end
+
+    def self.write(pipe, msg, options={})
+      msg = "#{msg}\n"
+      timeout = options[:timeout] || 10
+      begin_at = Time.now
+      begin
+        open(pipe, File::WRONLY | File::NONBLOCK) do |pipe_io|
+          bytes_written = 0
+          bytes_to_write = msg.length
+          until bytes_written >= bytes_to_write do
+            begin
+              wrote = pipe_io.write_nonblock msg
+              bytes_written += wrote
+              msg = msg[wrote..-1]
+            rescue IO::WaitWritable, Errno::EINTR, Errno::EPIPE
+              timeout_left = timeout - (Time.now - begin_at)
+              raise WriteTimedOut if timeout_left <= 0
+              IO.select nil, [pipe_io], nil, timeout_left
+            end
+          end
+        end
+      rescue Errno::ENXIO
+        sleep(0.5)
+        timeout_left = timeout - (Time.now - begin_at)
+        raise NoReaderConfiguredError if timeout_left <= 0
+        retry
+      end
+    end
+  end
+end

data/lib/run_loop/host_cache.rb

@@ -0,0 +1,128 @@
+require 'fileutils'
+require 'digest/sha1'
+
+module RunLoop
+
+  # @!visibility private
+  # A class for managing an on-disk hash table that represents the current
+  # state of the :host strategy run-loop.  It is used by Calabash iOS
+  # `console_attach` method.
+  # @see http://calabashapi.xamarin.com/ios/Calabash/Cucumber/Core.html#console_attach-instance_method
+  #
+  # Marshal is safe to use here because:
+  # 1. This code is not executed on the XTC.
+  # 2. Users who muck about with this cache can only hurt themselves.
+  class HostCache
+
+    # The path to the cache file.
+    #
+    # @!attribute [r] path
+    # @return [String] An expanded path to the cache file.
+    attr_reader :path
+
+    # The directory where the cache is stored.
+    # @return [String] Expanded path to the default cache directory.
+    # @raise [RuntimeError] When the ~/.run_loop exists, but is not a directory.
+    def self.default_directory
+      run_loop_dir = File.join(RunLoop::Environment.user_home_directory, ".run-loop")
+      if !File.exist?(run_loop_dir)
+        FileUtils.mkdir(run_loop_dir)
+      elsif !File.directory?(run_loop_dir)
+        raise %Q[
+Expected ~/.run_loop to be a directory.
+
+RunLoop requires this directory to cache files
+]
+
+      end
+      run_loop_dir
+    end
+
+    # The default cache.
+    def self.default
+      RunLoop::HostCache.new(self.default_directory)
+    end
+
+    # Creates a new HostCache that is ready for IO.
+    #
+    # @param [String] directory The directory where the cache file is located.
+    #  If the directory does not exist, it will be created.
+    # @options [Hash] options Options to control the state of the new object.
+    # @option [String] filename (host_run_loop.hash) The cache filename.
+    # @option [Boolean] clear (false) If true, the current cache will be cleared.
+    # @return [RunLoop::HostCache] A cache that is ready for IO.
+    def initialize(directory, options = {})
+      sha1 = Digest::SHA1.hexdigest 'host_run_loop.hash'
+      default_opts = {:filename => sha1,
+                      :clear => false}
+      merged_opts = default_opts.merge(options)
+
+      dir_expanded = File.expand_path(directory)
+      unless Dir.exist?(dir_expanded)
+        FileUtils.mkdir_p(dir_expanded)
+      end
+
+      @path = File.join(dir_expanded, merged_opts[:filename])
+
+      if merged_opts[:clear] && File.exist?(@path)
+        FileUtils.rm_rf @path
+      end
+    end
+
+    # @!visibility private
+    def to_s
+      "#<HostCache #{path}>"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
+    # Reads the current cache.
+    # @return [Hash] A hash representation of the current state of the run-loop.
+    def read
+      if File.exist? path
+        File.open(path) do |file|
+          Marshal.load(file)
+        end
+      else
+        self.write({})
+        self.read
+      end
+    end
+
+    # @!visibility private
+    #
+    # Writes `hash` as a serial object.  The existing data is overwritten.
+    #
+    # @param [Hash] hash The hash to write.
+    # @raise [ArgumentError] The `hash` parameter must not be nil and it must
+    #  be a Hash.
+    # @raise [TypeError] If the hash contains objects that cannot be written
+    #  by Marshal.dump.
+    #
+    # @return [Boolean] Returns true if `hash` was successfully Marshal.dump'ed.
+    def write(hash)
+      if hash.nil?
+        raise ArgumentError, 'Expected the hash parameter to be non-nil'
+      end
+
+      unless hash.is_a?(Hash)
+        raise ArgumentError, "Expected #{hash} to a Hash, but it is a #{hash.class}"
+      end
+
+      File.open(path, 'w+') do |file|
+        Marshal.dump(hash, file)
+      end
+      true
+    end
+
+    # @!visibility private
+    # Clears the current cache.
+    # @return [Boolean] Returns true if the hash was cleared.
+    def clear
+      self.write({})
+    end
+  end
+end

data/lib/run_loop/http/error.rb

@@ -0,0 +1,15 @@
+module RunLoop
+  module HTTP
+
+    # Raised when there is a problem communicating with the Calabash test
+    # server.
+    class Error < StandardError
+
+    end
+
+    # Raised when there is a problem creating an HTTP request.
+    class RequestError < StandardError
+
+    end
+  end
+end

data/lib/run_loop/http/request.rb

@@ -0,0 +1,44 @@
+module RunLoop
+  module HTTP
+
+    # A representation of an HTTP request that can be passed passed to the HTTP
+    # client as an argument for `get` or `post`.
+    # @!visibility private
+    class Request
+      attr_reader :route, :params
+
+      def initialize(route, params={})
+        @route = route
+        @params = params
+      end
+
+      # Create a new Request from `route` and `parameters`.
+      #
+      # @param [String] route The http route for the new request.
+      # @param [Array, Hash] parameters An Array or Hash of parameters.
+      # @return [Request] A new Request for `route` with `parameters`.
+      # @raise [RequestError] Raises an error if the parameters cannot be
+      #   converted to JSON
+      def self.request(route, parameters)
+        Request.new(route, Request.data(parameters))
+      end
+
+      private
+
+      # Converts `parameters` to JSON.
+      #
+      # @param [Array, Hash] parameters An Array or Hash of parameters.
+      # @return [String] A JSON formatted string that represents the parameters.
+      # @raise [RequestError] Raises an error if the parameters cannot be
+      #   converted to JSON
+      def self.data(parameters)
+        begin
+          JSON.generate(parameters)
+        rescue *[TypeError, JSON::GeneratorError] => e
+          raise RequestError, "#{e}: could not generate JSON from '#{parameters}'"
+        end
+      end
+    end
+  end
+end
+