wukong 3.0.0.pre3 → 3.0.0

data/lib/wukong/runner/deploy_pack_loader.rb

@@ -0,0 +1,75 @@
+module Wukong
+  class Runner
+
+    # Lets Wukong bootstrap by requiring an enclosing deploy pack's
+    # environment file if available.
+    #
+    # We use a simple heuristic (presence of 'Gemfile' and
+    # 'config/environment.rb' in a non-root parent directory) to
+    # determine whether or not we are in a deploy pack.
+    module DeployPackLoader
+
+      # Load the actual deploy pack environment.  Will not swallow any
+      # load errors.
+      def load_deploy_pack
+        load_ruby_file(environment_file) if in_deploy_pack?
+      end
+      
+      # Is execution likely happening within a deploy pack?
+      #
+      # See Wukong::Deploy for more information on deploy packs.
+      #
+      # @return [true, false]
+      def in_deploy_pack?
+        return @in_deploy_pack unless @in_deploy_pack.nil?
+        @in_deploy_pack = (deploy_pack_dir != '/')
+      end
+      
+      # Have we already loaded the environment of a deploy pack?
+      #
+      # See Wukong::Deploy for more information on deploy packs.
+      #
+      # @return [true, false]
+      def loaded_deploy_pack?
+        in_deploy_pack? && defined?(::Wukong::Deploy)
+      end
+
+      # The default environment file that will be require'd when
+      # booting.
+      #
+      # @return [String]
+      def environment_file
+        File.join(deploy_pack_dir, 'config', 'environment.rb')
+      end
+      
+      # Return the directory of the enclosing deploy pack.  Will return
+      # the root ('/') if no deeper directory is identified as a deploy
+      # pack.
+      #
+      # @return [String]
+      def deploy_pack_dir
+        return File.dirname(ENV["BUNDLE_GEMFILE"]) if ENV["BUNDLE_GEMFILE"] && is_deploy_pack_dir?(File.dirname(ENV["BUNDLE_GEMFILE"]))
+        return @deploy_pack_dir if @deploy_pack_dir
+        wd     = Dir.pwd
+        parent = File.dirname(wd)
+        until wd == parent
+          return wd if is_deploy_pack_dir?(wd)
+          wd     = parent
+          parent = File.dirname(wd)
+        end
+        @deploy_pack_dir = wd
+      end
+
+      private
+
+      # Could `dir` be a deploy pack dir?
+      #
+      # @param [String] dir
+      # @return [true, false]
+      def is_deploy_pack_dir? dir
+        dir && !dir.empty? && File.directory?(dir) && File.exist?(File.join(dir, 'Gemfile')) && File.exist?(File.join(dir, 'config', 'environment.rb'))
+      end
+    end
+    
+  end
+end

data/lib/wukong/runner/help_message.rb

@@ -0,0 +1,42 @@
+module Wukong
+  class Runner
+
+    # Defines methods for handling help messages.
+    #
+    # Runners which want to modify how help messages are generated
+    # should override the `contextualize_help_message!` instance method.
+    module HelpMessage
+
+      # Was the `--help` option specified on the command line?
+      #
+      # The boot sequence for a Runner strips out the `--help` option to
+      # allow individual Runner classes to customize their help
+      # messages.
+      #
+      # @return [true, false]
+      def help_given?
+        !!@help_given
+      end
+
+      # Strip the `--help` message from the original ARGV, storing
+      # whether or not it was given for later.
+      def strip_help_param!
+        @help_given = ARGV.delete('--help')
+      end
+
+      # Print a help message.
+      def dump_help
+        settings.dump_help
+      end
+
+      # Print a help message and exit.
+      #
+      # @raise [SystemExit]
+      def dump_help_and_exit!
+        dump_help
+        exit(1)
+      end
+        
+    end
+  end
+end

data/lib/wukong/spec_helpers.rb

@@ -1,10 +1,6 @@
 require 'wukong'
-require 'wukong/boot'
-require_relative('spec_helpers/processor_helpers')
-require_relative('spec_helpers/processor_methods')
-require_relative('spec_helpers/spec_driver_matchers')
-require_relative('spec_helpers/integration_driver')
-require_relative('spec_helpers/integration_driver_matchers')
+require_relative('spec_helpers/unit_tests')
+require_relative('spec_helpers/integration_tests')
 require_relative('spec_helpers/shared_examples')
 
 module Wukong
@@ -71,12 +67,8 @@ module Wukong
   #     processor(:similar_tokenizer, :json => true).given("hi there").should emit(2).records
   #   end
   module SpecHelpers
-    include ProcessorHelpers
-    include SpecMatchers
-    include IntegrationRunner
-    include IntegrationMatchers
+    include UnitTests
+    include IntegrationTests
   end
-
-  Processor.class_eval { include SpecHelpers::ProcessorSpecMethods }
 end
 

data/lib/wukong/spec_helpers/integration_tests.rb

@@ -0,0 +1,150 @@
+require_relative('integration_tests/integration_test_runner')
+require_relative('integration_tests/integration_test_matchers')
+
+module Wukong
+  module SpecHelpers
+    
+    # This module defines methods that are helpful to use in
+    # integration tests which require reading files from the local
+    # repository.
+    #
+    # Integration tests will spawn new system processes with their own
+    # environments.  This module provides methods and hooks for
+    # customizing that environment.
+    module IntegrationTests
+
+      # The directory to add to the `RUBYLIB` environment variable for
+      # the spawned processes.
+      #
+      # If `args` are given, return a path within this directory.
+      #
+      # @param [Array<String>] args
+      # @return [String]
+      def lib_dir *args
+        root.join('lib', *args).to_s
+      end
+
+      # The directory to add to the `PATH` environment variable for
+      # the spawned processes.
+      #
+      # If `args` are given, return a path within this directory.
+      #
+      # @param [Array<String>] args
+      # @return [String]
+      def bin_dir *args
+        root.join('bin', *args).to_s
+      end
+
+      # The directory to use for examples for the spawned process.
+      #
+      # If `args` are given, return a path within this directory.
+      #
+      # @param [Array<String>] args
+      # @return [String]
+      def examples_dir *args
+        root.join('examples', *args).to_s
+      end
+
+      # A Hash of environment variables to use for the spawned
+      # process.
+      #
+      # By default, will put the IntegrationHelper#lib_dir on the
+      # `RUBYLIB` and the IntegrationHelper#bin_dir on the `PATH`.
+      #
+      # @return [Hash]
+      def integration_env
+        {
+          "PATH"    => [bin_dir.to_s, ENV["PATH"]].compact.join(':'),
+          "RUBYLIB" => [lib_dir.to_s, ENV["RUBYLIB"]].compact.join(':')
+        }
+      end
+
+      # The directory to spawn new processes in.
+      #
+      # @return [String]
+      def integration_cwd
+        root.to_s
+      end
+
+      # Checks that each `expectation` appears in the STDOUT of the
+      # command.  Order is irrelevant and each `expectation` can be
+      # either a String to check for inclusion or a Regexp to match
+      # with.
+      #
+      # @param [Array<String,Regexp>] expectations
+      def have_stdout *expectations
+        StdoutMatcher.new(*expectations)
+      end
+
+      # Checks that each `expectation` appears in the STDERR of the
+      # command.  Order is irrelevant and each `expectation` can be
+      # either a String to check for inclusion or a Regexp to match
+      # with.
+      #
+      # @param [Array<String,Regexp>] expectations
+      def have_stderr *expectations
+        StderrMatcher.new(*expectations)
+      end
+
+      # Checks that the command exits with the given `code`.
+      #
+      # @param [Integer] code
+      def exit_with code
+        ExitCodeMatcher.new(code)
+      end
+      
+      # Spawn a command and capture its STDOUT, STDERR, and exit code.
+      #
+      # The `args` will be joined together into a command line.
+      #
+      # It is expected that you will use the matchers defined in
+      # IntegrationMatchers in your integration tests:
+      #
+      # @example Check output of 'ls' includes a string 'foo.txt'
+      #   it "lists files" do
+      #     command('ls').should have_output('foo.txt')
+      #   end
+      #
+      # @example More complicated
+      #   context "long format" do
+      #     it "lists files with timestamps" do
+      #       command('ls', '-l').should have_output('foo.txt', /\w+ \d+ \d+:\d+/)
+      #     end
+      #   end
+      #
+      # @param [Array<String>] args
+      #
+      # @overload command(*args, options={})
+      #   If the last element of `args` is a Hash it will be used for
+      #   options.
+      #
+      #   The :env option specifies the command line environment to
+      #   use for the command.  By default this will be the value of
+      #   the Ruby process's own `ENV` variable.  If running in a
+      #   context in which the `integration_env` method is defined,
+      #   its return value will be merged on top of `ENV`.  An
+      #   explicitly provided :env option will again be merged on top.
+      #
+      #   The :cwd option specifies the working directory to start in.
+      #   It defaults to the value of <tt>Dir.pwd</tt>
+      #
+      #   @param [Array<String>] args
+      #   @param [Hash] options
+      #   @option options [Hash] env the shell environment to spawn the command with
+      #   @option options [Hash] cwd the directory to execute the command in
+      def command *args
+        a = args.flatten.compact
+        options = (a.last.is_a?(Hash) ? a.pop : {})
+
+        env = ENV.to_hash.dup
+        env.merge!(integration_env) if respond_to?(:integration_env)
+        env.merge!(options[:env] || {})
+
+        cwd   = options[:cwd]
+        cwd ||= (respond_to?(:integration_cwd) ? integration_cwd : Dir.pwd)
+
+        IntegrationTestRunner.new(a, cwd: cwd, env: env)
+      end
+    end
+  end
+end

data/lib/wukong/spec_helpers/{integration_driver_matchers.rb → integration_tests/integration_test_matchers.rb}

@@ -1,48 +1,15 @@
 module Wukong
   module SpecHelpers
-
-    # Provides matchers for STDOUT, STDERR, and exit code when writing
-    # integration tests for Wukong's command-line APIs.
-    module IntegrationMatchers
-
-      # Checks that each `expectation` appears in the STDOUT of the
-      # command.  Order is irrelevant and each `expectation` can be
-      # either a String to check for inclusion or a Regexp to match
-      # with.
-      #
-      # @param [Array<String,Regexp>] expectations
-      def have_stdout *expectations
-        StdoutMatcher.new(*expectations)
-      end
-
-      # Checks that each `expectation` appears in the STDERR of the
-      # command.  Order is irrelevant and each `expectation` can be
-      # either a String to check for inclusion or a Regexp to match
-      # with.
-      #
-      # @param [Array<String,Regexp>] expectations
-      def have_stderr *expectations
-        StderrMatcher.new(*expectations)
-      end
-
-      # Checks that the command exits with the given `code`.
-      #
-      # @param [Integer] code
-      def exit_with code
-        ExitCodeMatcher.new(code)
-      end
-
-    end
-
+    
     # A class for running commands and capturing their STDOUT, STDERR,
     # and exit code.  This class is designed to work with the matchers
-    # defined in IntegrationMatchers.
-    class IntegrationMatcher
+    # defined in IntegrationTestMatchers.
+    class IntegrationTestMatcher
 
-      # The driver used to run the actual commands.
-      attr_accessor :driver
+      # The runner used to run the actual commands.
+      attr_accessor :runner
 
-      # An array of expectations about the output of the driver.
+      # An array of expectations about the output of the runner.
       attr_accessor :expectations
 
       # The expectation which caused failure.
@@ -54,11 +21,11 @@ module Wukong
       # If an expectation failes to match, the `failed_expectation`
       # attribute will be set accordingly.
       #
-      # @param [IntegrationDriver] driver
+      # @param [IntegrationTestRunner] runner
       # @return [true, false]
-      def matches?(driver)
-        self.driver = driver
-        driver.run!
+      def matches?(runner)
+        self.runner = runner
+        runner.run!
         expectations.each do |expectation|
           unless output.send(match_function(expectation), expectation)
             self.failed_expectation = expectation
@@ -80,12 +47,12 @@ module Wukong
 
       # :nodoc:
       def failure_message
-        "Ran\n\n#{formatted_env}\n#{formatted_command}\n\nand expected #{output_description}\n\n#{formatted_output}\n\nto #{match_type}\n\n  #{failed_expectation}#{formatted_error_output}"
+        "From within #{runner.cwd} ran\n\n#{formatted_env}\n#{formatted_command}\n\nand expected #{output_description}\n\n#{formatted_output}\n\nto #{match_type}\n\n  #{failed_expectation}#{formatted_error_output}"
       end
 
       # :nodoc:
       def negative_failure_message
-        "Expected #{output_description} of #{driver.cmd}\n\n#{output}\n\nto NOT #{match_type}\n\n#{self.failed_expectation}."
+        "Expected #{output_description} of #{runner.cmd}\n\n#{output}\n\nto NOT #{match_type}\n\n#{self.failed_expectation}."
       end
 
       # :nodoc:
@@ -95,18 +62,18 @@ module Wukong
 
       # :nodoc:
       def formatted_error_output
-        output_description.to_s =~ /stderr/ ? "\n\nSTDOUT was\n\n#{driver.stdout}" : "\n\nSTDERR was\n\n#{driver.stderr}"
+        output_description.to_s =~ /stderr/ ? "\n\nSTDOUT was\n\n#{runner.stdout}" : "\n\nSTDERR was\n\n#{runner.stderr}"
       end
 
       # :nodoc:
       def formatted_command
-        "  $ #{driver.cmd}"
+        "  $ #{runner.cmd}"
       end
 
       # :nodoc:
       def formatted_env
         ['  {'].tap do |lines|
-          driver.env.each_pair do |key, value|
+          runner.env.each_pair do |key, value|
             if key =~ /^(BUNDLE_GEMFILE|PATH|RUBYLIB)$/
               lines << "    #{key} => #{value},"
             end
@@ -128,11 +95,11 @@ module Wukong
     end
 
     # A matcher for the STDOUT of a command.
-    class StdoutMatcher < IntegrationMatcher
+    class StdoutMatcher < IntegrationTestMatcher
 
       # Picks the STDOUT of the command.
       def output
-        driver.stdout
+        runner.stdout
       end
 
       # :nodoc:
@@ -147,11 +114,11 @@ module Wukong
     end
 
     # A matcher for the STDOUT of a command.
-    class StderrMatcher < IntegrationMatcher
+    class StderrMatcher < IntegrationTestMatcher
 
       # Picks the STDOUT of the command.
       def output
-        driver.stderr
+        runner.stderr
       end
 
       # :nodoc:
@@ -165,7 +132,7 @@ module Wukong
     end
 
     # A matcher for the exit code of a command.
-    class ExitCodeMatcher < IntegrationMatcher
+    class ExitCodeMatcher < IntegrationTestMatcher
 
       # Initialize this matcher with the given `code`.
       #
@@ -184,27 +151,27 @@ module Wukong
       # Return whether or not the given command's exit code matches
       # the expectation.
       #
-      # @param [IntegrationDriver] driver
+      # @param [IntegrationTestRunner] runner
       # @return [true, false]
-      def matches?(driver)
-        self.driver = driver
-        driver.run!
+      def matches?(runner)
+        self.runner = runner
+        runner.run!
         if non_zero_exit_code?
-          @failed = true if driver.exit_code == 0
+          @failed = true if runner.exit_code == 0
         else
-          @failed = true if driver.exit_code != expected_exit_code
+          @failed = true if runner.exit_code != expected_exit_code
         end
         @failed ? false : true
       end
 
       # :nodoc:
       def failure_message
-        "Ran\n\n#{formatted_env}\n#{formatted_command}\n\nexpecting #{expected_exit_code_description}  Got #{driver.exit_code} instead.#{formatted_error_output}"
+        "From within #{runner.cwd} ran\n\n#{formatted_env}\n#{formatted_command}\n\nexpecting #{expected_exit_code_description}  Got #{runner.exit_code} instead.#{formatted_error_output}"
       end
 
       # :nodoc:
       def negative_failure_message
-        "Ran\n\n#{formatted_env}\n#{formatted_command}\n\nNOT expecting #{expected_exit_code_description}.#{formatted_error_output}"
+        "From within #{runner.cwd} ran\n\n#{formatted_env}\n#{formatted_command}\n\nNOT expecting #{expected_exit_code_description}.#{formatted_error_output}"
       end
 
       # :nodoc:
@@ -235,7 +202,6 @@ module Wukong
       def output_description
         "STDOUT"
       end
-
     end
   end
 end