remote-exec 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca220332149439af73e75f9c632cf6387ae16970
-  data.tar.gz: 7f5b2ac70fb84011a475b9bfee2d4e079103ec2b
+  metadata.gz: 800fd883b998fcc94053517f9bf51024abb432dc
+  data.tar.gz: f45137d8cd9ba56550ab77f572c502821cc818e2
 SHA512:
-  metadata.gz: aa812243644b3eebfda7b71741ba1f9556090835cc7759b1a84e09edbbbfbbd9f5f904e2a07e792f598cc876b94170bddebe8f4c561d51cfb68204454bb55e82
-  data.tar.gz: f731278f988714a0232ee75ca89653caae39519f0f04ea25a1f9b1ddd84e7fad2898aa227a7d676e04954d4bf5cbba3bf08230da4d7956aaa94a935a85528b50
+  metadata.gz: 6860b263ee359578a023e7068e6d44b3b6767b39af3b1f9479739f32b4c2d84ba5586e46f1f8841c615f3490666a97294168b795ce224c9aa68c41540c217435
+  data.tar.gz: 9637678910d64aa18f0299bcc32938520ea23b9c77f2f4a35c6915885912f9a426c01d6b137a107f95726956adb16aa0140262f29213a181397aaf7246469692

data/lib/remote-exec.rb

@@ -1,4 +1,10 @@
-require "remote_exec/version"
-require "remote_exec/fake"
-require "remote_exec/local"
-require "remote_exec/ssh"
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "remote-exec/version"
+require "remote-exec/fake"
+require "remote-exec/local"
+require "remote-exec/ssh"

data/lib/remote-exec/base.rb

@@ -0,0 +1,70 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require 'ruby-hooks'
+require "remote-exec/version"
+
+# Define minimal interface for execution handlers
+class RemoteExec::Base
+  extend RubyHooks::InstanceHooks
+
+  # called before connection attempt will be made, used when connection may fail
+  # @notify_param object [Object] the target that invoked the method
+  define_hook :before_connect
+
+  # called when connection attempt failed and we are about to sleep and retry
+  # @notify_param object    [Object]    the target that invoked the method
+  # @notify_param exception [Exception] exception that made the connection attempt fail
+  # @notify_param retries   [Integer]   number of retries left
+  define_hook :on_connect_retry
+
+  # called when connection attempt failed and no more retries left
+  # @notify_param object    [Object]    the target that invoked the method
+  # @notify_param exception [Exception] exception that made the connection attempt fail
+  define_hook :on_connect_fail
+
+  # called after connection / session is esatablished
+  # @notify_param object [Object] the target that invoked the method
+  define_hook :after_connect
+
+  # called before terminating connection - only when needed
+  # @notify_param object [Object] the target that invoked the method
+  define_hook :before_shutdown
+
+  # called before executing command
+  # @notify_param object  [Object] the target that invoked the method
+  # @notify_param command [String] the command to execute
+  define_hook :before_execute
+
+  # called before executing command
+  # @notify_param object [Object] the target that invoked the method
+  # @notify_param stdout [String] standard output of the command, can be nil
+  # @notify_param stderr [String] standard error output of the command, can be nil
+  define_hook :on_execute_data
+
+  # called after executing command
+  # @notify_param object  [Object]  the target that invoked the method
+  # @notify_param command [String]  the executed command
+  # @notify_param result  [Integer] the executed command status code (0 - ok, >0 - fail)
+  define_hook :after_execute
+
+  # standard in place handler that ensures shutdown is called
+  def initialize
+    if block_given?
+      begin
+        yield self
+      ensure
+        shutdown
+      end
+    end
+  end
+
+  # minimal handler for shutdown
+  def shutdown
+    before_shutdown.changed_and_notify(self)
+  end
+
+end

data/lib/{remote_exec → remote-exec}/fake.rb

@@ -1,4 +1,10 @@
-require "remote_exec/base"
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "remote-exec/base"
 
 # Class to fake running commands and transfering files.
 class RemoteExec::Fake < RemoteExec::Base
@@ -10,15 +16,15 @@ class RemoteExec::Fake < RemoteExec::Base
   #
   #   [1, [[nil,"error\n"]]
   #
-  # consist of an array: [ return_status, [[ stdout, stderr],...] ]
+  # @return [Array] story to run in execute, format: [ return_status, [[ stdout, stderr],...] ]
 
   attr_accessor :story
 
   # Constructs a new Fake object.
   #
-  # @yield       [self]   if a block is given then the constructed
-  # object yields itself and calls `#shutdown` at the end, closing the
-  # remote connection
+  # @yield [self] if a block is given then the constructed  object
+  #               yields itself and calls `#shutdown` at the end,
+  #               closing the remote connection
 
   def initialize
     after_connect.changed_and_notify(self)

data/lib/{remote_exec → remote-exec}/local.rb

@@ -1,5 +1,11 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
 require 'session'
-require "remote_exec/base"
+require "remote-exec/base"
 
 # Class to run local commands and transfer files localy.
 class RemoteExec::Local < RemoteExec::Base
@@ -10,8 +16,8 @@ class RemoteExec::Local < RemoteExec::Base
   #
   # @param shell [String] name of the shell to run
   # @yield       [self]   if a block is given then the constructed
-  # object yields itself and calls `#shutdown` at the end, closing the
-  # remote connection
+  #                       object yields itself and calls `#shutdown`
+  #                       at the end, closing the remote connection
 
   def initialize(shell = "sh")
     @shell = shell

data/lib/{remote_exec → remote-exec}/ssh.rb

@@ -8,8 +8,7 @@ License: https://github.com/test-kitchen/test-kitchen/blob/459238b88c/LICENSE
 =end
 
 require 'net/ssh'
-require 'ruby/hooks'
-require "remote_exec/base"
+require "remote-exec/base"
 
 # Class to help establish SSH connections, issue remote commands, and
 # transfer files between a local system and remote node.
@@ -27,8 +26,8 @@ class RemoteExec::Ssh < RemoteExec::Base
   # @param username [String] the username for the remote host
   # @param options  [Hash]   configuration options for ssh
   # @yield          [self]   if a block is given then the constructed
-  # object yields itself and calls `#shutdown` at the end, closing the
-  # remote connection
+  #                          object yields itself and calls `#shutdown`
+  #                          at the end, closing the remote connection
   def initialize(hostname, username, options = {})
     @hostname = hostname
     @username = username
@@ -39,10 +38,10 @@ class RemoteExec::Ssh < RemoteExec::Base
   # Shuts down the session connection, if it is still active.
   def shutdown
     super
-    return if @ssh.nil?
-    ssh.shutdown!
+    return if @session.nil?
+    session.shutdown!
   ensure
-    @ssh = nil
+    @session = nil
   end
 
   ##
@@ -55,8 +54,8 @@ class RemoteExec::Ssh < RemoteExec::Base
     # TODO: make it run in one session
     @last_status = nil
     @command     = command
-    ssh.open_channel(&method(:execute_open_channel))
-    ssh.loop
+    session.open_channel(&method(:execute_open_channel))
+    session.loop
     @last_status
   end
 
@@ -64,7 +63,7 @@ private
 
   def execute_open_channel(channel)
     before_execute.changed_and_notify(self, @command)
-    channel.request_pty
+    channel.request_pty unless options[:ssh_request_pty] == false
     channel.exec(@command, &method(:execute_channel_exec))
     channel.wait
     after_execute.changed_and_notify(self, @command, @last_status)
@@ -93,8 +92,8 @@ private
     end
   end
 
-  def ssh
-    @ssh ||= establish_connection
+  def session
+    @session ||= establish_connection
   end
 
   RESCUE_EXCEPTIONS = [

data/lib/remote-exec/version.rb

@@ -0,0 +1,11 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+# Unified handling of remote execution and file transfer
+module RemoteExec
+  # Version of this gem
+  VERSION = '0.6.0'
+end

data/test/{remote_exec → remote-exec}/fake_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-require 'remote_exec/fake'
+require 'remote-exec/fake'
 
 describe RemoteExec::Fake do
   subject do

data/test/{remote_exec → remote-exec}/local_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-require 'remote_exec/local'
+require 'remote-exec/local'
 
 describe RemoteExec::Local do
   subject do

data/test/{remote_exec → remote-exec}/ssh_test.rb

@@ -8,7 +8,7 @@ License: https://github.com/test-kitchen/test-kitchen/blob/459238b88c/LICENSE
 =end
 
 require 'test_helper'
-require 'remote_exec/ssh'
+require 'remote-exec/ssh'
 require 'net/ssh/test'
 
 module Net
@@ -70,7 +70,7 @@ describe RemoteExec::Ssh do
 
   subject do
     RemoteExec::Ssh.allocate.tap do |ssh|
-      ssh.instance_variable_set(:@ssh, connection)
+      ssh.instance_variable_set(:@session, connection)
       ssh.instance_variable_set(:@options, {})
     end
   end
@@ -98,7 +98,6 @@ describe RemoteExec::Ssh do
     it "executes true" do
       story do |session|
         channel = session.opens_channel
-        channel.sends_request_pty
         channel.sends_exec "true"
         channel.gets_exit_status(0)
         channel.gets_close
@@ -106,6 +105,7 @@ describe RemoteExec::Ssh do
       end
 
       assert_scripted do
+        subject.options[:ssh_request_pty] = false
         subject.execute("true").must_equal 0
       end
     end
@@ -221,7 +221,6 @@ describe RemoteExec::Ssh do
           @error_counter = ErrorCounter.new
           Net::SSH.unstub(:start)
           Net::SSH.stubs(:start).raises(klass)
-          subject.instance_variable_set(:@ssh, nil)
           subject.options[:ssh_retries] = 2
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote-exec
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Michal Papis
@@ -16,113 +16,113 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: session
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: guard-yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: Invoke commands on remote hosts
+        version: '1.1'
+description: 
 email:
 - mpapis@gmail.com
 executables: []
@@ -130,14 +130,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/remote-exec.rb
-- lib/remote_exec/base.rb
-- lib/remote_exec/fake.rb
-- lib/remote_exec/local.rb
-- lib/remote_exec/ssh.rb
-- lib/remote_exec/version.rb
-- test/remote_exec/fake_test.rb
-- test/remote_exec/local_test.rb
-- test/remote_exec/ssh_test.rb
+- lib/remote-exec/base.rb
+- lib/remote-exec/fake.rb
+- lib/remote-exec/local.rb
+- lib/remote-exec/ssh.rb
+- lib/remote-exec/version.rb
+- test/remote-exec/fake_test.rb
+- test/remote-exec/local_test.rb
+- test/remote-exec/ssh_test.rb
 - test/test_helper.rb
 homepage: https://github.com/remote-exec/remote-exec
 licenses:
@@ -165,7 +165,7 @@ specification_version: 4
 summary: Invoke commands on remote hosts
 test_files:
 - test/test_helper.rb
-- test/remote_exec/local_test.rb
-- test/remote_exec/ssh_test.rb
-- test/remote_exec/fake_test.rb
+- test/remote-exec/local_test.rb
+- test/remote-exec/fake_test.rb
+- test/remote-exec/ssh_test.rb
 has_rdoc: 

data/lib/remote_exec/base.rb

@@ -1,70 +0,0 @@
-=begin
-Copyright 2014 Michal Papis <mpapis@gmail.com>
-
-See the file LICENSE for copying permission.
-=end
-
-require 'ruby/hooks'
-require "remote_exec/version"
-
-# Define minimal interface for execution handlers
-class RemoteExec::Base
-  extend Ruby::Hooks::InstanceHooks
-
-  # called before connection attempt will be made, used when connection may fail
-  # @param object [Object] the target that invoked the method
-  define_hook :before_connect
-
-  # called when connection attempt failed and we are about to sleep and retry
-  # @param object    [Object]    the target that invoked the method
-  # @param exception [Exception] exception that made the connection attempt fail
-  # @param retries   [Integer]   number of retries left
-  define_hook :on_connect_retry
-
-  # called when connection attempt failed and we no more retries left
-  # @param object    [Object]    the target that invoked the method
-  # @param exception [Exception] exception that made the connection attempt fail
-  define_hook :on_connect_fail
-
-  # called after connection / session is esatablished
-  # @param object [Object] the target that invoked the method
-  define_hook :after_connect
-
-  # called before terminating connection - only when needed
-  # @param object [Object] the target that invoked the method
-  define_hook :before_shutdown
-
-  # called before executing command
-  # @param object  [Object] the target that invoked the method
-  # @param command [String] the command to execute
-  define_hook :before_execute
-
-  # called before executing command
-  # @param object [Object] the target that invoked the method
-  # @param stdout [String] standard output of the command, can be nil
-  # @param stderr [String] standard error output of the command, can be nil
-  define_hook :on_execute_data
-
-  # called after executing command
-  # @param object  [Object]  the target that invoked the method
-  # @param command [String]  the executed command
-  # @param result  [Integer] the executed command status code (0 - ok, >0 - fail)
-  define_hook :after_execute
-
-  # standard in place handler that ensures shutdown is called
-  def initialize
-    if block_given?
-      begin
-        yield self
-      ensure
-        shutdown
-      end
-    end
-  end
-
-  # minimal handler for shutdown
-  def shutdown
-    before_shutdown.changed_and_notify(self)
-  end
-
-end

data/lib/remote_exec/version.rb

@@ -1,5 +0,0 @@
-# Unified handling of remote execution and file transfer
-module RemoteExec
-  # Version of this gem
-  VERSION = '0.5.0'
-end