aruba 0.14.9 → 1.0.0

data/lib/aruba/processes/spawn_process.rb

@@ -19,24 +19,38 @@ module Aruba
     # @private
     class SpawnProcess < BasicProcess
       # Use as default launcher
-      def self.match?(mode)
+      def self.match?(_mode)
         true
       end
 
       # Create process
       #
-      # @params [String] cmd
+      # @param [String] cmd
       #   Command string
       #
-      # @params [Integer] exit_timeout
+      # @param [Numeric] exit_timeout
       #   The timeout until we expect the command to be finished
       #
-      # @params [Integer] io_wait_timeout
+      # @param [Numeric] io_wait_timeout
       #   The timeout until we expect the io to be finished
       #
-      # @params [String] working_directory
+      # @param [String] working_directory
       #   The directory where the command will be executed
-      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
+      #
+      # @param [Hash] environment
+      #   Environment variables
+      #
+      # @param [Class] main_class
+      #   E.g. Cli::App::Runner
+      #
+      # @param [String] stop_signal
+      #   Name of signal to send to stop process. E.g. 'HUP'.
+      #
+      # @param [Numeric] startup_wait_time
+      #   The amount of seconds to wait after Aruba has started a command.
+      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory,
+                     environment = Aruba.platform.environment_variables.hash_from_env,
+                     main_class = nil, stop_signal = nil, startup_wait_time = 0)
         super
 
         @process      = nil
@@ -51,21 +65,27 @@ module Aruba
       #
       # rubocop:disable Metrics/MethodLength
       def start
-        # rubocop:disable Metrics/LineLength
-        fail CommandAlreadyStartedError, %(Command "#{commandline}" has already been started. Please `#stop` the command first and `#start` it again. Alternatively use `#restart`.\n#{caller.join("\n")}) if started?
-        # rubocop:enable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
+        if started?
+          error_message = %(Command "#{commandline}" has already been started. Please `#stop` the command first and `#start` it again. Alternatively use `#restart`.\n#{caller.join("\n")})
+          fail CommandAlreadyStartedError, error_message
+        end
+
+        # rubocop:enable Layout/LineLength
 
         @started = true
 
-        @process = ChildProcess.build(*[command_string.to_a, arguments].flatten)
+        @process = ChildProcess.build(*command_string.to_a)
         @stdout_file = Tempfile.new('aruba-stdout-')
         @stderr_file = Tempfile.new('aruba-stderr-')
 
         @stdout_file.sync = true
         @stderr_file.sync = true
 
-        @stdout_file.binmode
-        @stderr_file.binmode
+        if RUBY_VERSION >= '1.9'
+          @stdout_file.set_encoding('ASCII-8BIT')
+          @stderr_file.set_encoding('ASCII-8BIT')
+        end
 
         @exit_status = nil
         @duplex      = true
@@ -86,7 +106,7 @@ module Aruba
             sleep startup_wait_time
           end
         rescue ChildProcess::LaunchError => e
-          raise LaunchError, "It tried to start #{cmd}. " + e.message
+          raise LaunchError, "It tried to start #{commandline}. " + e.message
         end
 
         after_run
@@ -140,14 +160,6 @@ module Aruba
         end
       end
 
-      def read_stdout
-        # rubocop:disable Metrics/LineLength
-        Aruba.platform.deprecated('The use of "#read_stdout" is deprecated. Use "#stdout" instead. To reduce the time to wait for io, pass `:wait_for_io => 0` or some suitable for your use case')
-        # rubocop:enable Metrics/LineLength
-
-        stdout(:wait_for_io => 0)
-      end
-
       def write(input)
         return if stopped?
 
@@ -161,11 +173,7 @@ module Aruba
       def close_io(name)
         return if stopped?
 
-        if RUBY_VERSION < '1.9'
-          @process.io.send(name.to_sym).close
-        else
-          @process.io.public_send(name.to_sym).close
-        end
+        @process.io.public_send(name.to_sym).close
       end
 
       # Stop command
@@ -197,18 +205,19 @@ module Aruba
             # ... and set the exit status
             wait
           else
-            @process.stop
+            begin
+              @process.stop
+            rescue Errno::EPERM # This can occur on MacOS
+              nil
+            end
           end
         end
 
-        @exit_status  = @process.exit_code
+        @exit_status = @process.exit_code
 
         @stdout_cache = read_temporary_output_file @stdout_file
         @stderr_cache = read_temporary_output_file @stderr_file
 
-        # @stdout_file = nil
-        # @stderr_file = nil
-
         @started = false
 
         @exit_status
@@ -226,11 +235,12 @@ module Aruba
       # @param [String] signal
       #   The signal, i.e. 'TERM'
       def send_signal(signal)
-        fail CommandAlreadyStoppedError, %(Command "#{commandline}" with PID "#{pid}" has already stopped.) if @process.exited?
+        error_message = %(Command "#{commandline}" with PID "#{pid}" has already stopped.)
+        fail CommandAlreadyStoppedError, error_message if @process.exited?
 
         Process.kill signal, pid
       rescue Errno::ESRCH
-        raise CommandAlreadyStoppedError, %(Command "#{commandline}" with PID "#{pid}" has already stopped.)
+        raise CommandAlreadyStoppedError, error_message
       end
 
       # Return file system stats for the given command
@@ -238,7 +248,7 @@ module Aruba
       # @return [Aruba::Platforms::FilesystemStatus]
       #   This returns a File::Stat-object
       def filesystem_status
-        Aruba.platform.filesystem_status.new(command_string.to_s)
+        Aruba.platform.filesystem_status.new(command_path)
       end
 
       # Content of command
@@ -247,22 +257,27 @@ module Aruba
       #   The content of the script/command. This might be binary output as
       #   string if your command is a binary executable.
       def content
-        File.read command_string.to_s
+        File.read command_path
+      end
+
+      def interactive?
+        true
       end
 
       private
 
       def command_string
-        # gather fully qualified path
-        cmd = Aruba.platform.which(command, environment['PATH'])
+        fail LaunchError, %(Command "#{command}" not found in PATH-variable "#{environment['PATH']}".) if command_path.nil?
 
-        fail LaunchError, %(Command "#{command}" not found in PATH-variable "#{environment['PATH']}".) if cmd.nil?
+        Aruba.platform.command_string.new(command_path, *arguments)
+      end
 
-        Aruba.platform.command_string.new(cmd)
+      def command_path
+        @command_path ||= (Aruba.platform.builtin_shell_commands.include?(command) ? command : Aruba.platform.which(command, environment['PATH']))
       end
 
-      def wait_for_io(time_to_wait, &block)
-        sleep time_to_wait.to_i
+      def wait_for_io(time_to_wait)
+        sleep time_to_wait
         yield
       end
 
@@ -272,11 +287,7 @@ module Aruba
         data = file.read
         file.close
 
-        if RUBY_VERSION >= '1.9'
-          data.force_encoding('UTF-8')
-        else
-          data
-        end
+        data.force_encoding('UTF-8')
       end
     end
   end

data/lib/aruba/rspec.rb

@@ -4,32 +4,36 @@ require 'aruba'
 require 'aruba/api'
 require 'aruba/version'
 
-if Aruba::VERSION >= '1.0.0'
-  Aruba.configure do |config|
-    config.working_directory = 'tmp/rspec'
-  end
-end
-
 RSpec.configure do |config|
-  config.include Aruba::Api, :type => :aruba
+  config.include Aruba::Api, type: :aruba
 
   # Setup environment for aruba
   config.around :each do |example|
     if self.class.include? Aruba::Api
       setup_aruba
+
+      # Modify PATH to include project/bin
+      prepend_environment_variable 'PATH',
+                                   aruba.config.command_search_paths.join(File::PATH_SEPARATOR) + File::PATH_SEPARATOR
+
+      # Use configured home directory as HOME
+      set_environment_variable 'HOME', aruba.config.home_directory
     end
 
     example.run
 
     next unless self.class.include? Aruba::Api
+
     stop_all_commands
   end
 
-  if Aruba::VERSION >= '1.0.0'
-    config.around :each do |example|
-      Aruba.platform.with_environment do
+  config.around :each do |example|
+    if self.class.include? Aruba::Api
+      with_environment do
         example.run
       end
+    else
+      example.run
     end
   end
 
@@ -43,21 +47,9 @@ RSpec.configure do |config|
   config.before :each do |example|
     next unless self.class.include?(Aruba::Api)
 
-    if example.metadata[:announce_environment]
-      Aruba.platform.deprecated 'announce_environment is deprecated. Use announce_changed_environment instead'
-
-      aruba.announcer.activate(:changed_environment)
-    end
-
     aruba.announcer.activate(:full_environment)     if example.metadata[:announce_full_environment]
     aruba.announcer.activate(:changed_environment)  if example.metadata[:announce_changed_environment]
 
-    if example.metadata[:announce_modified_environment]
-      Aruba.platform.deprecated 'announce_modified_environment is deprecated. Use announce_changed_environment instead'
-
-      aruba.announcer.activate(:changed_environment)
-    end
-
     aruba.announcer.activate(:command)                   if example.metadata[:announce_command]
     aruba.announcer.activate(:directory)                 if example.metadata[:announce_directory]
     aruba.announcer.activate(:full_environment)          if example.metadata[:announce_full_environment]
@@ -89,18 +81,4 @@ RSpec.configure do |config|
       aruba.announcer.activate(:command_filesystem_status)
     end
   end
-
-  # Modify PATH to include project/bin
-  config.before :each do
-    next unless self.class.include? Aruba::Api
-
-    prepend_environment_variable 'PATH', aruba.config.command_search_paths.join(':') + ':'
-  end
-
-  # Use configured home directory as HOME
-  config.before :each do |example|
-    next unless self.class.include? Aruba::Api
-
-    set_environment_variable 'HOME', aruba.config.home_directory
-  end
 end

data/lib/aruba/runtime.rb

@@ -1,4 +1,4 @@
-require 'aruba/config'
+require 'aruba/configuration'
 require 'aruba/aruba_path'
 require 'aruba/config_wrapper'
 require 'aruba/events'
@@ -49,11 +49,7 @@ module Aruba
 
       @environment.update(@config.command_runtime_environment)
 
-      @command_monitor = if Aruba::VERSION < '1'
-                           opts.fetch(:command_monitor, Aruba.platform.command_monitor.new(:announcer => @announcer))
-                         else
-                           opts.fetch(:command_monitor, Aruba.platform.command_monitor.new)
-                         end
+      @command_monitor = opts.fetch(:command_monitor, Aruba.platform.command_monitor.new(announcer: @announcer))
 
       @logger = opts.fetch(:logger, Aruba.platform.logger.new)
       @logger.mode = @config.log_level
@@ -86,6 +82,7 @@ module Aruba
         directory = candidates.find { |d| Aruba.platform.directory? d }
 
         fail "No existing fixtures directory found in #{candidates.map { |d| format('"%s"', d) }.join(', ')}." unless directory
+
         directory
       end
 

data/lib/aruba/setup.rb

@@ -25,7 +25,7 @@ module Aruba
 
     def working_directory(clobber = true)
       if clobber
-        Aruba.platform.rm File.join(runtime.config.root_directory, runtime.config.working_directory), :force => true
+        Aruba.platform.rm File.join(runtime.config.root_directory, runtime.config.working_directory), force: true
       end
       Aruba.platform.mkdir File.join(runtime.config.root_directory, runtime.config.working_directory)
       Aruba.platform.chdir runtime.config.root_directory
@@ -36,11 +36,11 @@ module Aruba
       runtime.event_bus.register(
         :command_started,
         proc do |event|
-          runtime.announcer.announce :command, event.entity.commandline
-          runtime.announcer.announce :timeout, 'exit', event.entity.exit_timeout
-          runtime.announcer.announce :timeout, 'io wait', event.entity.io_wait_timeout
-          runtime.announcer.announce :wait_time, 'startup wait time', event.entity.startup_wait_time
-          runtime.announcer.announce :full_environment, event.entity.environment
+          runtime.announcer.announce(:command) { event.entity.commandline }
+          runtime.announcer.announce(:timeout, 'exit') { event.entity.exit_timeout }
+          runtime.announcer.announce(:timeout, 'io wait') { event.entity.io_wait_timeout }
+          runtime.announcer.announce(:wait_time, 'startup wait time') { event.entity.startup_wait_time }
+          runtime.announcer.announce(:full_environment) { event.entity.environment }
         end
       )
 

data/lib/aruba/tasks/docker_helpers.rb

@@ -0,0 +1,154 @@
+require 'psych'
+
+module Aruba
+  class DockerRunInstance
+    protected
+
+    attr_reader :file, :instance
+
+    public
+
+    def initialize(file, instance)
+      @file     = file
+      @instance = instance
+    end
+
+    def method_missing(m, *_args)
+      @file.public_send m, instance
+    end
+
+    def respond_to_missing?(m)
+      @file.respond_to? m
+    end
+  end
+
+  class DockerBuildCommandLineBuilder
+    protected
+
+    attr_reader :run_instance, :opts
+
+    public
+
+    def initialize(run_instance, opts = {})
+      @run_instance = run_instance
+      @opts = opts
+    end
+
+    def to_cli
+      cache               = opts[:cache]
+      application_version = opts[:version]
+      docker_file         = run_instance.docker_file
+      docker_image        = run_instance.image
+
+      cmdline = []
+      cmdline << 'docker'
+      cmdline << 'build'
+      cmdline << '--no-cache=true' if cache == 'false'
+
+      %w(http_proxy https_proxy HTTP_PROXY HTTPS_PROXY).each do |var|
+        next unless ENV.key? var
+
+        proxy_uri = URI(ENV[var])
+        proxy_uri.host = '172.17.0.1'
+        cmdline << "--build-arg #{var}=#{proxy_uri}"
+      end
+
+      cmdline << "-t #{docker_image}:#{application_version}"
+      cmdline << "-f #{docker_file}"
+      cmdline << File.dirname(docker_file)
+
+      cmdline.join(' ')
+    end
+  end
+
+  class DockerRunCommandLineBuilder
+    protected
+
+    attr_reader :run_instance, :opts
+
+    public
+
+    def initialize(run_instance, opts = {})
+      @run_instance = run_instance
+      @opts         = opts
+    end
+
+    def to_cli
+      volumes = run_instance.volumes
+      image   = run_instance.image
+      command = opts[:command]
+
+      cmdline = []
+      cmdline << 'docker'
+      cmdline << 'run'
+      cmdline << '-it'
+      cmdline << '--rm'
+      cmdline << "--name #{run_instance.container_name}"
+
+      volumes.each do |v|
+        cmdline << "-v #{expand_volume_paths(v)}"
+      end
+
+      cmdline << image
+      cmdline << command if command
+
+      cmdline.join(' ')
+    end
+
+    private
+
+    def expand_volume_paths(volume_paths)
+      volume_paths.split(':').map { |path| File.expand_path(path) }.join(':')
+    end
+  end
+
+  class DockerComposeFile
+    protected
+
+    attr_reader :data
+
+    public
+
+    def initialize(path)
+      @data = Psych.load_file(path)['services']
+    end
+
+    def volumes(instance)
+      fetch(instance)['volumes']
+    end
+
+    def build_context(instance)
+      fetch(instance).fetch('build', {})['context']
+    end
+
+    def build_arguments(instance)
+      fetch(instance).fetch('build', {})['args']
+    end
+
+    def docker_file(instance)
+      fetch(instance).fetch('build', {})['dockerfile']
+    end
+
+    def image(instance)
+      fetch(instance)['image']
+    end
+
+    def container_name(instance)
+      fetch(instance)['container_name']
+    end
+
+    def command(instance)
+      fetch(instance)['command']
+    end
+
+    def working_directory(instance)
+      fetch(instance)['working_dir']
+    end
+
+    private
+
+    def fetch(instance)
+      Hash(data).fetch(instance.to_s)
+    end
+  end
+end

data/lib/aruba/version.rb

@@ -1,3 +1,3 @@
 module Aruba
-  VERSION = '0.14.9'.freeze
+  VERSION = '1.0.0'.freeze
 end