aruba 1.0.0.pre.alpha.2 → 1.0.0.pre.alpha.3

data/Rakefile

@@ -6,46 +6,31 @@ require 'aruba/platform'
 require 'bundler'
 Bundler.setup
 
-task :default => :test
+task default: [:lint, :test]
 
-desc 'Run the whole test suite. Any failure will stop rake going on'
-task :test => %w(lint:travis lint:coding_guidelines lint:licenses test:rspec test:cucumber test:cucumber_wip)
+desc 'Run all linters.'
+task lint: %w(lint:travis lint:coding_guidelines lint:licenses)
 
-task :cucumber do
-  Aruba.platform.deprecated 'The use of task "cucumber" is deprecated. Please use "test:cucumber"'
-  Rake::Task['test:cucumber'].invoke
-end
-
-task :cucumber_wip do
-  Aruba.platform.deprecated 'The use of task "cucumber_wip" is deprecated. Please use "test:cucumber_wip"'
-  Rake::Task['test:cucumber_wip'].invoke
-end
+desc 'Run the whole test suite.'
+task test: %w(test:rspec test:cucumber test:cucumber_wip)
 
-task :spec do
-  Aruba.platform.deprecated 'The use of task "spec" is deprecated. Please use "test:rspec"'
-  Rake::Task['test:rspec'].invoke
-end
-
-task :rubocop do
-  Aruba.platform.deprecated 'The use of task "rubocop" is deprecated. Please use "lint:coding_guidelines"'
-  Rake::Task['test:coding_guidelines'].invoke
-end
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
 
 namespace :test do
-  desc 'Run cucumber tests'
-  task :cucumber do
-    sh 'bundle exec cucumber'
+  Cucumber::Rake::Task.new do |t|
+    t.cucumber_opts = %w{--format progress}
   end
 
-  desc 'Run cucumber tests which are "WORK IN PROGRESS" and are allowed to fail'
-  task :cucumber_wip do
-    sh 'bundle exec cucumber -p wip'
+  Cucumber::Rake::Task.new(:cucumber_wip, 'Run Cucumber features '\
+                           'which are "WORK IN PROGRESS" and '\
+                           'are allowed to fail') do |t|
+    t.cucumber_opts = %w{--format progress}
+    t.profile = 'wip'
   end
 
-  desc 'Run rspec tests'
-  task :rspec do
-    sh 'bundle exec rspec'
-  end
+  desc 'Run RSpec tests'
+  RSpec::Core::RakeTask.new(:rspec)
 end
 
 namespace :lint do
@@ -63,12 +48,27 @@ namespace :lint do
 
   desc 'Lint our code with "rubocop"'
   task :coding_guidelines do
-    sh 'bundle exec rubocop --fail-level E'
+    if RUBY_VERSION >= '2'
+      sh 'bundle exec rubocop --fail-level E'
+    else
+      warn 'Your ruby version is not supported for code linting'
+    end
   end
 
   desc 'Check for relevant licenses in project'
   task :licenses do
-    sh 'bundle exec license_finder'
+    if RUBY_VERSION >= '2.3'
+      sh 'bundle exec license_finder'
+    else
+      warn 'Your ruby version is not supported for license checking'
+    end
+  end
+
+  begin
+    require 'yard-junk/rake'
+    YardJunk::Rake.define_task
+  rescue LoadError
+    warn 'yard-junk requires Ruby 2.3.0. Rake task lint:yard:junk not loaded.'
   end
 end
 
@@ -79,8 +79,8 @@ end
 namespace :docker do
   desc 'Build docker image'
   task :build, :cache, :version do |_, args|
-    args.with_defaults(:version => 'latest')
-    args.with_defaults(:cache => true)
+    args.with_defaults(version: 'latest')
+    args.with_defaults(cache: true)
 
     docker_compose_file = Aruba::DockerComposeFile.new(File.expand_path('../docker-compose.yml', __FILE__))
     docker_run_instance = Aruba::DockerRunInstance.new(docker_compose_file, :base)

data/appveyor.yml

@@ -6,6 +6,7 @@ version: "{build}"
 branches:
   only:
     - master
+    - still
 
 # Disable normal Windows builds in favor of our test script.
 build: off
@@ -14,18 +15,18 @@ install:
   - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
   - ruby --version
   - gem --version
-  - gem install bundler
   - bundler --version
   - bundle install
   - cinst ansicon
 
 test_script:
-  - bundle exec rake test --trace
+  - bundle exec rake test:rspec --trace
 
 environment:
   matrix:
-    - ruby_version: '19'
-    - ruby_version: '20'
-    - ruby_version: '21'
     - ruby_version: '22'
+    - ruby_version: '23'
+    - ruby_version: '24'
+    - ruby_version: '25'
+    - ruby_version: '26'
 

data/aruba.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 lib = ::File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'aruba/version'
@@ -6,33 +7,30 @@ require 'aruba/version'
 Gem::Specification.new do |spec|
   spec.name        = 'aruba'
   spec.version     = Aruba::VERSION
-  spec.author      = "Aslak Hellesøy, Matt Wynne and other Aruba Contributors"
+  spec.author      = 'Aslak Hellesøy, Matt Wynne and other Aruba Contributors'
   spec.description = 'Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing commandline applications meaningful, easy and fun.'
   spec.summary     = "aruba-#{spec.version}"
   spec.license     = 'MIT'
   spec.email       = 'cukes@googlegroups.com'
-  spec.homepage    = 'http://github.com/cucumber/aruba'
+  spec.homepage    = 'https://github.com/cucumber/aruba'
 
-  spec.add_runtime_dependency 'cucumber', '~> 2.4', '>= 2.4.0'
-  spec.add_runtime_dependency 'childprocess', '~> 0.7.1'
-  spec.add_runtime_dependency 'ffi', '~> 1.9', '>= 1.9.10'
-  spec.add_runtime_dependency 'rspec-expectations', '~> 3.4', '>= 3.4.0'
-  spec.add_runtime_dependency 'contracts', '~> 0.14'
+  spec.add_runtime_dependency 'childprocess', '~> 1.0'
+  spec.add_runtime_dependency 'contracts', '~> 0.13'
+  spec.add_runtime_dependency 'cucumber', '~> 2.4'
+  spec.add_runtime_dependency 'ffi', '~> 1.9'
+  spec.add_runtime_dependency 'rspec-expectations', '~> 3.4'
   spec.add_runtime_dependency 'thor', '~> 0.19'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.rubygems_version = ">= 1.6.1"
-  spec.required_ruby_version = '>= 1.9.3'
-
-  # spec.post_install_message = <<-EOS
-  # EOS
+  spec.add_development_dependency 'bundler', ['>= 1.7.0', '< 3.0']
+  spec.rubygems_version = '>= 1.6.1'
+  spec.required_ruby_version = '>= 2.2'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.rdoc_options  = ["--charset=UTF-8"]
-  spec.bindir        = "exe"
-  spec.require_paths = ["lib"]
+  spec.rdoc_options  = ['--charset=UTF-8']
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
 end

data/bin/console

@@ -2,15 +2,6 @@
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'pry'
+require 'aruba/console'
 
-require 'aruba/api'
-
-module Aruba
-  class MyConsole
-    include Aruba::Api
-  end
-end
-
-include Aruba
-Pry.start MyConsole.new
+Aruba::Console.new.start

data/cucumber.yml

@@ -11,13 +11,6 @@ java_wip_opts     = "--tags @wip-jruby-java-1.6:3" if defined?(JRUBY_VERSION) &&
 
 ignore_opts = []
 ignore_opts <<  '--tags ~@ignore'
-ignore_opts <<  '--tags ~@unsupported-on-platform-java'    if RUBY_PLATFORM.include? 'java'
-ignore_opts <<  '--tags ~@unsupported-on-platform-mri'     if !RUBY_PLATFORM.include? 'java'
-ignore_opts <<  '--tags ~@unsupported-on-platform-windows' if FFI::Platform.windows?
-ignore_opts <<  '--tags ~@unsupported-on-platform-unix'    if FFI::Platform.unix?
-ignore_opts <<  '--tags ~@unsupported-on-platform-mac'     if FFI::Platform.mac?
-ignore_opts <<  '--tags ~@unsupported-on-ruby-older-2'     if RUBY_VERSION < '2'
-ignore_opts <<  '--tags ~@requires-aruba-version-1'        if Aruba::VERSION < '1'
 ignore_opts = ignore_opts.join(' ')
 %>
 default: <%= std_opts %> --tags ~@wip <%= java_default_opts %> <%= ignore_opts %>

data/fixtures/cli-app/README.md

@@ -31,7 +31,7 @@ cli
 
 ### Library
 
-You can use `bin/console` to load your library.
+You can use `script/console` to load your library.
 
 ### Fixture
 

data/fixtures/cli-app/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/fixtures/cli-app/cli-app.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cli/app/version'

data/fixtures/cli-app/lib/cli/app/suppress_simple_cov_output.rb

@@ -2,12 +2,12 @@ module SimpleCov
   module Formatter
     class HTMLFormatter
       def format(result)
-        Dir[File.join(File.dirname(__FILE__), "../public/*")].each do |path|
+        Dir[File.join(File.dirname(__FILE__), '../public/*')].each do |path|
           FileUtils.cp_r(path, asset_output_path)
         end
 
-        File.open(File.join(output_path, "index.html"), "wb") do |file|
-          file.puts template("layout").result(binding)
+        File.open(File.join(output_path, 'index.html'), 'wb') do |file|
+          file.puts template('layout').result(binding)
         end
       end
     end

data/fixtures/cli-app/lib/cli/app/version.rb

@@ -1,5 +1,5 @@
 module Cli
   module App
-    VERSION = "0.1.0".freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/fixtures/empty-app/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/fixtures/empty-app/cli-app.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cli/app/version'

data/fixtures/empty-app/lib/cli/app/version.rb

@@ -1,5 +1,5 @@
 module Cli
   module App
-    VERSION = "0.1.0".freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/fixtures/getting-started-app/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'cucumber'
 gem 'aruba', path: File.expand_path('../../../../', __FILE__)
+gem 'cucumber'

data/lib/aruba/api.rb

@@ -6,16 +6,12 @@ require 'aruba/extensions/string/strip'
 
 require 'aruba/platform'
 require 'aruba/api/core'
-require 'aruba/api/command'
-
-if Aruba::VERSION <= '1.1.0'
-  require 'aruba/api/deprecated'
-end
+require 'aruba/api/commands'
 
 require 'aruba/api/environment'
 require 'aruba/api/filesystem'
 require 'aruba/api/text'
-require 'aruba/api/rvm'
+require 'aruba/api/bundler'
 
 Aruba.platform.require_matching_files('../matchers/**/*.rb', __FILE__)
 
@@ -27,10 +23,7 @@ module Aruba
     include Aruba::Api::Commands
     include Aruba::Api::Environment
     include Aruba::Api::Filesystem
-    include Aruba::Api::Rvm
-    if Aruba::VERSION <= '1.1.0'
-      include Aruba::Api::Deprecated
-    end
     include Aruba::Api::Text
+    include Aruba::Api::Bundler
   end
 end

data/lib/aruba/api/bundler.rb

@@ -0,0 +1,16 @@
+require 'aruba/api/environment'
+
+module Aruba
+  module Api
+    module Bundler
+      include Environment
+
+      # Unset variables used by bundler
+      def unset_bundler_env_vars
+        %w[RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE].each do |key|
+          delete_environment_variable(key)
+        end
+      end
+    end
+  end
+end

data/lib/aruba/api/commands.rb

@@ -0,0 +1,249 @@
+require 'pathname'
+
+require 'aruba/platform'
+require 'aruba/command'
+
+# require 'win32/file' if File::ALT_SEPARATOR
+
+# Aruba
+module Aruba
+  # Api
+  module Api
+    # Command module
+    module Commands
+      # Resolve path for command using the PATH-environment variable
+      #
+      # @param [#to_s] program
+      #   The name of the program which should be resolved
+      #
+      # @param [String] path
+      #   The PATH, a string concatenated with ":", e.g. /usr/bin/:/bin on a
+      #   UNIX-system
+      def which(program, path = nil)
+        with_environment do
+          # ENV is set within this block
+          path = ENV['PATH'] if path.nil?
+
+          Aruba.platform.which(program, path)
+        end
+      end
+
+      # Pipe data in file
+      #
+      # @param [String] file_name
+      #   The file which should be used to pipe in data
+      def pipe_in_file(file_name)
+        file_name = expand_path(file_name)
+
+        File.open(file_name, 'r').each_line do |line|
+          last_command_started.write(line)
+        end
+      end
+
+      # Return all commands
+      #
+      # @return [Array]
+      #   List of commands
+      def all_commands
+        aruba.command_monitor.registered_commands
+      end
+
+      # Last command started
+      def last_command_started
+        aruba.command_monitor.last_command_started
+      end
+
+      # Last command stopped
+      def last_command_stopped
+        aruba.command_monitor.last_command_stopped
+      end
+
+      # Stop all commands
+      #
+      # @yield [Command]
+      #   If block is given use it to filter the commands which should be
+      #   stoppend.
+      def stop_all_commands(&block)
+        cmds = if block_given?
+                 all_commands.select(&block)
+               else
+                 all_commands
+               end
+
+        cmds.each(&:stop)
+
+        self
+      end
+
+      # Terminate all commands
+      #
+      # @yield [Command]
+      #   If block is given use it to filter the commands which should be
+      #   terminated.
+      def terminate_all_commands(&block)
+        cmds = if block_given?
+                 all_commands.select(&block)
+               else
+                 all_commands
+               end
+
+        cmds.each(&:terminate)
+
+        self
+      end
+
+      # Find a started command
+      #
+      # @param [String, Command] commandline
+      #   The commandline
+      def find_command(commandline)
+        aruba.command_monitor.find(commandline)
+      end
+
+      # Run given command and stop it if timeout is reached
+      #
+      # @param [String] cmd
+      #   The command which should be executed
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option opts [Numeric] exit_timeout
+      #   If the timeout is reached the command will be killed
+      #
+      # @option opts [Numeric] io_wait_timeout
+      #   Wait for IO to finish
+      #
+      # @option opts [Numeric] startup_wait_time
+      #   Wait for a command to start
+      #
+      # @option opts [String] stop_signal
+      #   Use signal to stop command
+      #
+      # @yield [SpawnProcess]
+      #   Run block with process
+      #
+      def run_command(cmd, opts = {})
+        command = prepare_command(cmd, opts)
+
+        unless command.interactive?
+          raise NotImplementedError,
+            'Running interactively is not supported with this process launcher.'
+        end
+
+        start_command(command)
+
+        block_given? ? yield(command) : command
+      end
+
+      # Run a command with aruba
+      #
+      # Checks for error during command execution and checks the output to detect
+      # an timeout error.
+      #
+      # @param [String] cmd
+      #   The command to be executed
+      #
+      # @param [Hash] options
+      #   Options for aruba
+      #
+      # @option options [Boolean] fail_on_error
+      #   Should aruba fail on error?
+      #
+      # @option options [Numeric] exit_timeout
+      #   Timeout for execution
+      #
+      # @option options [Numeric] io_wait_timeout
+      #   Timeout for IO - STDERR, STDOUT
+      #
+      def run_command_and_stop(cmd, opts = {})
+        fail_on_error = if opts.key?(:fail_on_error)
+                          opts.delete(:fail_on_error) == true
+                        else
+                          true
+                        end
+
+        command = prepare_command(cmd, opts)
+        start_command(command)
+        command.stop
+
+        return unless fail_on_error
+
+        begin
+          expect(command).to have_finished_in_time
+          expect(command).to be_successfully_executed
+        rescue ::RSpec::Expectations::ExpectationNotMetError => e
+          aruba.announcer.activate(aruba.config.activate_announcer_on_command_failure)
+          aruba.event_bus.notify Events::CommandStopped.new(command)
+          raise e
+        end
+      end
+
+      # Provide data to command via stdin
+      #
+      # @param [String] input
+      #   The input for the command
+      def type(input)
+        return close_input if input == "\u0004"
+
+        last_command_started.write(input << "\n")
+      end
+
+      # Close stdin
+      def close_input
+        last_command_started.close_io(:stdin)
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+      def prepare_command(cmd, opts)
+        exit_timeout      = opts[:exit_timeout].nil? ? aruba.config.exit_timeout : opts[:exit_timeout]
+        io_wait_timeout   = opts[:io_wait_timeout].nil? ? aruba.config.io_wait_timeout : opts[:io_wait_timeout]
+        stop_signal       = opts[:stop_signal].nil? ? aruba.config.stop_signal : opts[:stop_signal]
+        startup_wait_time = opts[:startup_wait_time].nil? ? aruba.config.startup_wait_time : opts[:startup_wait_time]
+
+        cmd = replace_variables(cmd)
+
+        @commands ||= []
+        @commands << cmd
+
+        environment       = aruba.environment
+        working_directory = expand_path('.')
+        event_bus         = aruba.event_bus
+
+        cmd = Aruba.platform.detect_ruby(cmd)
+
+        mode = aruba.config.command_launcher
+
+        main_class = aruba.config.main_class
+
+        Command.new(
+          cmd,
+          mode: mode,
+          exit_timeout: exit_timeout,
+          io_wait_timeout: io_wait_timeout,
+          working_directory: working_directory,
+          environment: environment.to_hash,
+          main_class: main_class,
+          stop_signal: stop_signal,
+          startup_wait_time: startup_wait_time,
+          event_bus: event_bus
+        )
+      end
+
+      # rubocop:enable Metrics/MethodLength
+
+      def start_command(command)
+        aruba.config.before(:command, self, command)
+
+        command.start
+
+        stop_signal = command.stop_signal
+        aruba.announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal
+
+        aruba.config.after(:command, self, command)
+      end
+    end
+  end
+end