train 0.31.0 → 0.31.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfe0c95ba3361d579100ba1b832fb9f01f584267
-  data.tar.gz: d8449a2875c73e05e5e1f188eb530e25d184a89e
+  metadata.gz: 45cc6cfd826d49507368b99a990fed0eeba925af
+  data.tar.gz: b1dd4839b1a46ac0c246cdd0d7a00e8adda03150
 SHA512:
-  metadata.gz: b1239cd1ece638eb4273037034fe1ba7e3c1c864674f53d89f7a7dfdf6f4683eaf54445b5ff92ab1b2e482fbb5743143365111f516bcd1f4f0f3ae4e6f150a0b
-  data.tar.gz: 9c6d7296f8396a5dbac8323ef29eeb247af3c2cf4cd285ee44dafddaf7e515af921d7288360381ebfb3ac5bcca9edee08663efd0ea570353d6fa1562840bed94
+  metadata.gz: ab1770e2b5e06c10cc21dfb327c934acc4b9a2a38f8a016584e426a0d1da27b4cfcf794da4777bda6c51d251092848b538de98236b03d55d30dce0cfdd9b53e9
+  data.tar.gz: 3c98eba3d01ab9f934e613a4d9ce6bd566f7a97fefa38b4e7986f1894e1e8428ac52807e3c9ace7dfe1cf2cacb0364eb3fda9735676ac1aa8d6a8a0040d92cb5

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Change Log
 
-## [0.31.0](https://github.com/chef/train/tree/0.31.0) (2017-12-05)
-[Full Changelog](https://github.com/chef/train/compare/v0.30.0...0.31.0)
+## [0.31.1](https://github.com/chef/train/tree/0.31.1) (2017-12-06)
+[Full Changelog](https://github.com/chef/train/compare/v0.31.0...0.31.1)
+
+**Merged pull requests:**
+
+- Allow runner specifications for local connections [\#225](https://github.com/chef/train/pull/225) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+
+## [v0.31.0](https://github.com/chef/train/tree/v0.31.0) (2017-12-05)
+[Full Changelog](https://github.com/chef/train/compare/v0.30.0...v0.31.0)
 
 **Fixed bugs:**
 
@@ -9,6 +16,7 @@
 
 **Merged pull requests:**
 
+- Release 0.31.0 [\#224](https://github.com/chef/train/pull/224) ([adamleff](https://github.com/adamleff))
 - Use named pipe to decrease local Windows runtime [\#220](https://github.com/chef/train/pull/220) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
 
 ## [v0.30.0](https://github.com/chef/train/tree/v0.30.0) (2017-12-04)

data/lib/train/transports/local.rb

@@ -10,8 +10,6 @@ module Train::Transports
   class Local < Train.plugin(1)
     name 'local'
 
-    include_options Train::Extras::CommandWrapper
-
     class PipeError < ::StandardError; end
 
     def connection(_ = nil)
@@ -22,18 +20,11 @@ module Train::Transports
       def initialize(options)
         super(options)
 
-        # While OS is being discovered, use the GenericRunner
-        @runner = GenericRunner.new
-        @runner.cmd_wrapper = CommandWrapper.load(self, options)
-
-        if os.windows?
-          # Attempt to use a named pipe but fallback to ShellOut if that fails
-          begin
-            @runner = WindowsPipeRunner.new
-          rescue PipeError
-            @runner = WindowsShellRunner.new
-          end
-        end
+        @runner = if options[:command_runner]
+                    force_runner(options[:command_runner])
+                  else
+                    select_runner(options)
+                  end
       end
 
       def local?
@@ -50,8 +41,42 @@ module Train::Transports
 
       private
 
+      def select_runner(options)
+        if os.windows?
+          # Attempt to use a named pipe but fallback to ShellOut if that fails
+          begin
+            WindowsPipeRunner.new
+          rescue PipeError
+            WindowsShellRunner.new
+          end
+        else
+          GenericRunner.new(self, options)
+        end
+      end
+
+      def force_runner(command_runner)
+        case command_runner
+        when :generic
+          GenericRunner.new(self, options)
+        when :windows_pipe
+          WindowsPipeRunner.new
+        when :windows_shell
+          WindowsShellRunner.new
+        else
+          fail "Runner type `#{command_runner}` not supported"
+        end
+      end
+
       def run_command_via_connection(cmd)
-        @runner.run_command(cmd)
+        # Use the runner if it is available
+        return @runner.run_command(cmd) if defined?(@runner)
+
+        # If we don't have a runner, such as at the beginning of setting up the
+        # transport and performing the first few steps of OS detection, fall
+        # back to shelling out.
+        res = Mixlib::ShellOut.new(cmd)
+        res.run_command
+        Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
       rescue Errno::ENOENT => _
         CommandResult.new('', '', 1)
       end
@@ -65,7 +90,11 @@ module Train::Transports
       end
 
       class GenericRunner
-        attr_writer :cmd_wrapper
+        include_options Train::Extras::CommandWrapper
+
+        def initialize(connection, options)
+          @cmd_wrapper = Local::CommandWrapper.load(connection, options)
+        end
 
         def run_command(cmd)
           if defined?(@cmd_wrapper) && !@cmd_wrapper.nil?

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = '0.31.0'.freeze
+  VERSION = '0.31.1'.freeze
 end

data/test/unit/transports/local_test.rb

@@ -13,7 +13,7 @@ class TransportHelper
     plat.family_hierarchy = opts[:family_hierarchy]
     plat.add_platform_methods
     Train::Platforms::Detect.stubs(:scan).returns(plat)
-    @transport = Train::Transports::Local.new
+    @transport = Train::Transports::Local.new(user_opts)
   end
 end
 
@@ -55,6 +55,58 @@ describe 'local transport' do
     methods.include?(:file_via_connection).must_equal true
   end
 
+  describe 'when overriding runner selection' do
+    it 'can select the `GenericRunner`' do
+      Train::Transports::Local::Connection::GenericRunner
+        .expects(:new)
+
+      Train::Transports::Local::Connection::WindowsPipeRunner
+        .expects(:new)
+        .never
+
+      Train::Transports::Local::Connection::WindowsShellRunner
+        .expects(:new)
+        .never
+
+      Train::Transports::Local::Connection.new(command_runner: :generic)
+    end
+
+    it 'can select the `WindowsPipeRunner`' do
+      Train::Transports::Local::Connection::GenericRunner
+        .expects(:new)
+        .never
+
+      Train::Transports::Local::Connection::WindowsPipeRunner
+        .expects(:new)
+
+      Train::Transports::Local::Connection::WindowsShellRunner
+        .expects(:new)
+        .never
+
+      Train::Transports::Local::Connection.new(command_runner: :windows_pipe)
+    end
+
+    it 'can select the `WindowsShellRunner`' do
+      Train::Transports::Local::Connection::GenericRunner
+        .expects(:new)
+        .never
+
+      Train::Transports::Local::Connection::WindowsPipeRunner
+        .expects(:new)
+        .never
+
+      Train::Transports::Local::Connection::WindowsShellRunner
+        .expects(:new)
+
+      Train::Transports::Local::Connection.new(command_runner: :windows_shell)
+    end
+
+    it 'throws a RuntimeError when an invalid runner type is passed' do
+      proc { Train::Transports::Local::Connection.new(command_runner: :nope ) }
+        .must_raise(RuntimeError, "Runner type `:nope` not supported")
+    end
+  end
+
   describe 'when running a local command' do
     let(:cmd_runner) { Minitest::Mock.new }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.31.1
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2017-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json