sshkit 0.0.25 → 0.0.26

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbb3f36f6373d515b4313fc92514655ba7ca36e0
+  data.tar.gz: 484fd64e12a264d5bdaffe1e0a680194739930c5
+SHA512:
+  metadata.gz: e2d81fb0548c2a2d66763cb9a3ca7afa71753955264da34a8d5c9c6b83cefbaa2a073970f3a4059d87597f3c6998d57c687cdedbf596dbcd6a7efb099725e675
+  data.tar.gz: 3c2e49e6cff7cc951097ece2084824ea7350a3d36bb34008a82ce3b14af31b420d9019c5e71c6b9a5cae0217f30f0a70cc70264ea437b994345bd3609391798f

data/.travis.yml

@@ -2,5 +2,6 @@ before_install: echo 'yes' | gem uninstall ffi -a -I || true
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
   - jruby-19mode
   - rbx-19mode

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.26
+
+  * Pretty output no longer prints white text. ("Command.....")
+  * Fixed a double-output bug, where upon receiving the exit status from a
+    remote command, the last data packet that it sent would be re-printed
+    by the pretty formatter.
+  * Integration tests now use an Ubuntu Precise 64 Vagrant base box.
+  * Additional host declaration syntax, `SSHKit::Host` can now take a hash of
+    host properties in addition to a number of new (common sense) DSN type
+    syntaxes.
+  * Changes to the constants used for logging, we no longer re-define a
+    `Logger::TRACE` constant on the global `Logger` class, rather everyhing
+    now uses `SSHKit::Logger` (Thanks to Rafa Garcia)
+  * Various syntax and documentation fixes.
+
 ## 0.0.25
 
   * `upload!` and `download!` now log to different levels depending on
@@ -34,7 +49,7 @@ appear at the top.
   * `upload!` and `download!` now print progress reports at the `Logger::INFO`
      verbosity level.
 
-## 0.0.23
+## 0.0.23
 
   * Explicitly rely on `net-scp` gem.
 
@@ -166,7 +181,7 @@ appear at the top.
    can be used to set, for example a umask of `007` for allowing users with
    the same primary group to share code without stepping on eachother's toes.
 
-## 0.0.13
+## 0.0.13
 
  * Correctly quote `as(user)` commands, previously it would expand to:
    `sudo su user -c /usr/bin/env echo "Hello World"`, in which the command to
@@ -220,7 +235,7 @@ descriptors and redirecting them. Programs that re-open, or otherwise
 manipulate their own file descriptors may lock up when the SSH session is
 disconnected, often they block writing to, or reading from stdin/out.
 
-## 0.0.7
+## 0.0.7
 
 * DSL method `execute()` will now raise `SSHKit::Command::Failed` when the
   exit status is non-zero. The message of the exception will be whatever the
@@ -314,7 +329,7 @@ version `0.0.5`.
 
 * Refactor the runner classes into an abstract heirarchy.
 
-## 0.0.2
+## 0.0.2
 
 * Include a *Pretty* formatter
 * Modify example to use Pretty formatter.

data/Vagrantfile

@@ -5,15 +5,15 @@
 Vagrant::Config.run do |config|
 
   config.vm.define :one do |one|
-    one.vm.box = "lucid32"
+    one.vm.box = "precise64"
   end
 
   config.vm.define :two do |one|
-    one.vm.box = "lucid32"
+    one.vm.box = "precise64"
   end
 
   config.vm.define :three do |one|
-    one.vm.box = "lucid32"
+    one.vm.box = "precise64"
   end
 
 end

data/lib/sshkit/all.rb

@@ -8,6 +8,7 @@ require_relative 'command'
 require_relative 'configuration'
 require_relative 'coordinator'
 
+require_relative 'logger'
 require_relative 'log_message'
 
 require_relative 'formatters/abstract'

data/lib/sshkit/backends/abstract.rb

@@ -42,6 +42,10 @@ module SSHKit
         output << LogMessage.new(Logger::DEBUG, messages)
       end
 
+      def trace(messages)
+        output << LogMessage.new(Logger::TRACE, messages)
+      end
+
       def make(commands=[])
         raise MethodUnavailableError
       end

data/lib/sshkit/backends/netssh.rb

@@ -2,6 +2,27 @@ require 'net/ssh'
 require 'net/scp'
 
 module SSHKit
+
+  class Logger
+
+    class Net::SSH::LogLevelShim
+      attr_reader :output
+      def initialize(output)
+        @output = output
+      end
+      def debug(args)
+        output << LogMessage.new(Logger::TRACE, args)
+      end
+      def error(args)
+        output << LogMessage.new(Logger::ERROR, args)
+      end
+      def lwarn(args)
+        output << LogMessage.new(Logger::WARN, args)
+      end
+    end
+
+  end
+
   module Backend
 
     class Netssh < Printer
@@ -90,8 +111,9 @@ module SSHKit
                 output << cmd
               end
               chan.on_request("exit-status") do |ch, data|
-                exit_status = data.read_long
-                cmd.exit_status = exit_status
+                cmd.stdout = ''
+                cmd.stderr = ''
+                cmd.exit_status = data.read_long
                 output << cmd
               end
               #chan.on_request("exit-signal") do |ch, data|
@@ -124,8 +146,7 @@ module SSHKit
           Net::SSH.start(
             host.hostname,
             host.username,
-            port: host.port,
-            password: host.password,
+            host.netssh_options
           )
         end
       end

data/lib/sshkit/command.rb

@@ -106,8 +106,8 @@ module SSHKit
         args:        args,
         options:     options,
         exit_status: exit_status,
-        stdout:      stdout,
-        stderr:      stderr,
+        stdout:      full_stdout,
+        stderr:      full_stderr,
         started_at:  @started_at,
         finished_at: @finished_at,
         runtime:     runtime,

data/lib/sshkit/formatters/pretty.rb

@@ -23,7 +23,7 @@ module SSHKit
         unless command.started?
           original_output << level(command.verbosity) + uuid(command) + "Running #{c.yellow(c.bold(String(command)))} on #{c.blue(command.host.to_s)}\n"
           if SSHKit.config.output_verbosity == Logger::DEBUG
-            original_output << level(Logger::DEBUG) + uuid(command) + c.white("Command: #{c.blue(command.to_command)}") + "\n"
+            original_output << level(Logger::DEBUG) + uuid(command) + "Command: #{c.blue(command.to_command)}" + "\n"
           end
         end
 

data/lib/sshkit/host.rb

@@ -1,3 +1,4 @@
+require 'etc'
 require 'ostruct'
 
 module SSHKit
@@ -6,34 +7,58 @@ module SSHKit
 
   class Host
 
-    attr_reader :hostname, :port, :username
+    attr_accessor :password, :hostname, :port, :user
 
-    attr_accessor :password
+    def key=(new_key)
+      @keys = [new_key]
+    end
 
-    def initialize(host_string)
+    def keys=(new_keys)
+      @keys = new_keys
+    end
 
-      suitable_parsers = [
-        SimpleHostParser,
-        HostWithPortParser,
-        IPv6HostWithPortParser,
-        HostWithUsernameParser,
-        HostWithUsernameAndPortParser
-      ].select do |p|
-        p.suitable?(host_string)
-      end
+    def keys
+      Array(@keys)
+    end
+
+    def initialize(host_string_or_options_hash)
+
+      unless host_string_or_options_hash.is_a?(Hash)
+        suitable_parsers = [
+          SimpleHostParser,
+          HostWithPortParser,
+          HostWithUsernameAndPortParser,
+          IPv6HostWithPortParser,
+          HostWithUsernameParser,
+          HostWithUsernameAndPortParser
+        ].select do |p|
+          p.suitable?(host_string_or_options_hash)
+        end
 
-      if suitable_parsers.any?
-        suitable_parsers.first.tap do |parser|
-          @username, @hostname, @port = parser.new(host_string).attributes
+        if suitable_parsers.any?
+          suitable_parsers.first.tap do |parser|
+            @user, @hostname, @port = parser.new(host_string_or_options_hash).attributes
+          end
+        else
+          raise UnparsableHostStringError, "Cannot parse host string #{host_string_or_options_hash}"
         end
       else
-        raise UnparsableHostStringError, "Cannot parse host string #{host_string}"
+        host_string_or_options_hash.each do |key, value|
+          if self.respond_to?("#{key}=")
+            send("#{key}=", value)
+          else
+            raise ArgumentError, "Unknown host property #{key}"
+          end
+        end
       end
-
     end
 
     def hash
-      username.hash ^ hostname.hash ^ port.hash
+      user.hash ^ hostname.hash ^ port.hash
+    end
+
+    def username
+      user
     end
 
     def eql?(other_host)
@@ -50,6 +75,15 @@ module SSHKit
       sprintf("%s@%s:%d", username, hostname, port)
     end
 
+    def netssh_options
+      {
+        keys:     keys,
+        port:     port,
+        user:     user,
+        password: password
+      }
+    end
+
     def properties
       @properties ||= OpenStruct.new
     end
@@ -69,7 +103,7 @@ module SSHKit
     end
 
     def username
-      `whoami`.chomp
+      Etc.getlogin
     end
 
     def port
@@ -88,6 +122,26 @@ module SSHKit
 
   # @private
   # :nodoc:
+  class HostWithUsernameAndPortParser < SimpleHostParser
+
+    def self.suitable?(host_string)
+      !host_string.match /.*@.*\:.*/
+    end
+
+    def username
+      @host_string.split('@').last.to_i
+    end
+
+    def port
+      @host_string.split(':').last.to_i
+    end
+
+    def hostname
+      @host_string.split(/@|\:/)[1]
+    end
+
+  end
+
   class HostWithPortParser < SimpleHostParser
 
     def self.suitable?(host_string)

data/lib/sshkit/logger.rb

@@ -0,0 +1,10 @@
+module SSHKit
+  class Logger
+    TRACE = -1
+    DEBUG = 0
+    INFO  = 1
+    WARN  = 2
+    ERROR = 3
+    FATAL = 4
+  end
+end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.25"
+  VERSION = "0.0.26"
 end

data/test/unit/test_host.rb

@@ -17,6 +17,13 @@ module SSHKit
       assert_equal 'example.com',  h.hostname
     end
 
+    def test_ipv4_with_username_and_port
+      h = Host.new 'user@127.0.0.1:2222'
+      assert_equal 2222,        h.port
+      assert_equal 'user',      h.username
+      assert_equal '127.0.0.1', h.hostname
+    end
+
     def test_host_with_port
       h = Host.new 'example.com:2222'
       assert_equal 2222,          h.port
@@ -67,6 +74,31 @@ module SSHKit
       assert_equal [:web, :app], h.properties.roles
     end
 
+    def test_setting_up_a_host_with_a_hash
+      h = Host.new(hostname: 'example.com', port: 1234, key: "~/.ssh/example_com.key")
+      assert_equal "example.com", h.hostname
+      assert_equal 1234, h.port
+      assert_equal "~/.ssh/example_com.key", h.keys.first
+    end
+
+    def test_setting_up_a_host_with_a_hash_raises_on_unknown_keys
+      assert_raises ArgumentError do
+        Host.new({this_key_doesnt_exist: nil})
+      end
+    end
+
+    def test_turning_a_host_into_ssh_options
+      Host.new('someuser@example.com:2222').tap do |host|
+        host.password = "andthisdoesntevenmakeanysense"
+        host.keys     = ["~/.ssh/some_key_here"]
+        host.netssh_options.tap do |sho|
+          assert_equal 2222, sho.fetch(:port)
+          assert_equal 'andthisdoesntevenmakeanysense', sho.fetch(:password)
+          assert_equal ['~/.ssh/some_key_here'], sho.fetch(:keys)
+        end
+      end
+    end
+
   end
 
 end

data/test/unit/test_logger.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+module SSHKit
+
+  class TestLogger < UnitTest
+
+    def test_logger_severity_constants
+      assert_equal Logger::TRACE, -1
+      assert_equal Logger::DEBUG,  0
+      assert_equal Logger::INFO,   1
+      assert_equal Logger::WARN,   2
+      assert_equal Logger::ERROR,  3
+      assert_equal Logger::FATAL,  4
+    end
+
+  end
+
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.25
-  prerelease: 
+  version: 0.0.26
 platform: ruby
 authors:
 - Lee Hambley
@@ -10,62 +9,55 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.11.3
     - - <
@@ -74,9 +66,8 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.11.3
     - - <
@@ -85,129 +76,113 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: unindent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vagrant
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A comprehensive toolkit for remotely running commands in a structured
@@ -251,6 +226,7 @@ files:
 - lib/sshkit/formatters/pretty.rb
 - lib/sshkit/host.rb
 - lib/sshkit/log_message.rb
+- lib/sshkit/logger.rb
 - lib/sshkit/runners/abstract.rb
 - lib/sshkit/runners/group.rb
 - lib/sshkit/runners/parallel.rb
@@ -269,29 +245,29 @@ files:
 - test/unit/test_configuration.rb
 - test/unit/test_coordinator.rb
 - test/unit/test_host.rb
+- test/unit/test_logger.rb
 homepage: http://wacku.github.com/sshkit
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
 test_files:
 - test/functional/backends/test_netssh.rb
@@ -306,4 +282,5 @@ test_files:
 - test/unit/test_configuration.rb
 - test/unit/test_coordinator.rb
 - test/unit/test_host.rb
+- test/unit/test_logger.rb
 has_rdoc: