sshkit 0.0.1

data/test/unit/core_ext/test_string.rb

@@ -0,0 +1,12 @@
+class String
+
+  def unindent
+    indent = self.split("\n").select do |line| 
+      !line.strip.empty?
+    end.map do |line| 
+      line.index(/[^\s]/)
+    end.compact.min || 0
+    self.gsub(/^[[:blank:]]{#{indent}}/, '')
+  end
+
+end

data/test/unit/test_command.rb

@@ -0,0 +1,113 @@
+require 'helper'
+
+module SSHKit
+  class TestCommand < UnitTest
+
+    def test_maps_a_command
+      c = Command.new('example')
+      assert_equal '/usr/bin/env example', String(c)
+    end
+
+    def test_not_mapping_a_builtin
+      %w{if test time}.each do |builtin|
+        c = Command.new(builtin)
+        assert_equal builtin, String(c)
+      end
+    end
+
+    def test_using_a_heredoc
+      c = Command.new <<-EOHEREDOC
+        if test ! -d /var/log; then
+          echo "Example"
+        fi
+      EOHEREDOC
+      assert_equal "if test ! -d /var/log; then; echo \"Example\"; fi", String(c)
+    end
+
+    def test_including_the_env
+      c = Command.new(:rails, 'server', env: {rails_env: :production})
+      assert_equal "( RAILS_ENV=production /usr/bin/env rails server )", String(c)
+    end
+
+    def test_working_in_a_given_directory
+      c = Command.new(:ls, '-l', in: "/opt/sites")
+      assert_equal "cd /opt/sites && /usr/bin/env ls -l", String(c)
+    end
+
+    def test_working_in_a_given_directory_with_env
+      c = Command.new(:ls, '-l', in: "/opt/sites", env: {a: :b})
+      assert_equal "cd /opt/sites && ( A=b /usr/bin/env ls -l )", String(c)
+    end
+
+    def test_having_a_host_passed
+      refute Command.new(:date).host
+      assert Command.new(:date, host: :foo)
+      assert_equal :foo, Command.new(host: :foo).host
+    end
+
+    def test_working_as_a_given_user
+      c = Command.new(:whoami, user: :anotheruser)
+      assert_equal "sudo su anotheruser -c /usr/bin/env whoami", String(c)
+    end
+
+    def test_complete?
+      c = Command.new(:whoami)
+      refute c.complete?
+      c.exit_status = 1
+      assert c.complete?
+      c.exit_status = 0
+      assert c.complete?
+    end
+
+    def test_successful?
+      c = Command.new(:whoami)
+      refute c.successful?
+      refute c.success?
+      c.exit_status = 0
+      assert c.successful?
+      assert c.success?
+    end
+
+    def test_failure?
+      c = Command.new(:whoami)
+      refute c.failure?
+      refute c.failed?
+      c.exit_status = 1
+      assert c.failure?
+      assert c.failed?
+      c.exit_status = 127
+      assert c.failure?
+      assert c.failed?
+    end
+
+    def test_appending_stdout
+      c = Command.new(:whoami)
+      assert c.stdout += "test\n"
+      assert_equal "test\n", c.stdout
+    end
+
+    def test_appending_stderr
+      c = Command.new(:whoami)
+      assert c.stderr += "test\n"
+      assert_equal "test\n", c.stderr
+    end
+
+    def test_setting_exit_status
+      c = Command.new(:whoami)
+      assert_equal nil, c.exit_status
+      assert c.exit_status = 1
+      assert_equal 1, c.exit_status
+    end
+
+    def test_command_has_a_guid
+      assert Command.new(:whosmi).uuid
+    end
+
+    def test_wont_take_no_args
+      assert_raises ArgumentError do
+        Command.new
+      end
+    end
+
+  end
+end

data/test/unit/test_configuration.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+module SSHKit
+
+  class TestConfiguration < UnitTest
+
+    def setup
+      SSHKit.config = nil
+      SSHKit.config.command_map.clear
+    end
+
+    def test_output
+      assert_equal $stdout, SSHKit.config.output
+      assert SSHKit.config.output = $stderr
+      assert_equal $stderr, SSHKit.config.output
+    end
+
+    def test_runner
+      assert_equal :parallel, SSHKit.config.runner
+      assert SSHKit.config.runner = :sequence
+      assert_equal :sequence, SSHKit.config.runner
+    end
+
+    def test_format
+      assert_equal :dot, SSHKit.config.format
+      assert SSHKit.config.format = :pretty
+      assert_equal :pretty, SSHKit.config.format
+    end
+
+    def test_backend
+      assert_equal SSHKit::Backend::Netssh, SSHKit.config.backend
+      assert SSHKit.config.backend = SSHKit::Backend::Printer
+      assert_equal SSHKit::Backend::Printer, SSHKit.config.backend
+    end
+
+    def test_command_map
+      cm = Hash.new { |h,k| h[k] = "/opt/sites/example/current/bin #{k}"}
+      assert_equal Hash.new, SSHKit.config.command_map
+      assert_equal "/usr/bin/env ruby", SSHKit.config.command_map[:ruby]
+      assert SSHKit.config.command_map = cm
+      assert_equal cm, SSHKit.config.command_map
+      assert_equal "/opt/sites/example/current/bin ruby", SSHKit.config.command_map[:ruby]
+    end
+
+  end
+
+end

data/test/unit/test_connection_manager.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+module SSHKit
+
+  class TestConnectionManager < UnitTest
+
+    def setup
+      SSHKit.config.backend = SSHKit::Backend::Abstract
+    end
+
+    def test_connection_manager_handles_a_single_argument
+      h = Host.new('1.example.com')
+      Host.expects(:new).with('1.example.com').once().returns(h)
+      ConnectionManager.new '1.example.com'
+    end
+
+    def test_connection_manager_resolves_hosts
+      h = Host.new('n.example.com')
+      Host.expects(:new).times(3).returns(h)
+      ConnectionManager.new %w{1.example.com 2.example.com 3.example.com}
+    end
+
+    def test_connection_manager_removes_duplicates_after_resolving_hosts
+      cm = ConnectionManager.new %w{user@1.example.com:22 user@1.example.com}
+      assert_equal ['user@1.example.com:22'], cm.hosts.map(&:to_s)
+    end
+
+    def test_the_connection_manager_yields_the_host_to_each_connection_instance
+      spy = lambda do |host, connection|
+        assert_equal host, Host.new("1.example.com")
+      end
+      ConnectionManager.new(%w{1.example.com}).each &spy
+    end
+
+    def test_the_connection_manaager_runs_things_in_parallel_by_default
+      results = []
+      command = lambda do |host,connection|
+        results << Time.now
+      end
+      ConnectionManager.new(%w{1.example.com 2.example.com}).each &command
+      assert_equal 2, results.length
+      assert_equal *results.map(&:to_i)
+    end
+
+    def test_the_connection_manager_can_run_things_in_sequence
+      results = []
+      command = lambda do |host,connection|
+        results << Time.now
+      end
+      ConnectionManager.new(%w{1.example.com 2.example.com}).each(in: :sequence, &command)
+      assert_equal 2, results.length
+      assert_operator results.first.to_i, :<, results.last.to_i
+    end
+
+    def test_the_connection_manager_can_run_things_in_groups
+      results = []
+      command = lambda do |host,connection|
+        debugger
+        results << Time.now
+      end
+      ConnectionManager.new(%w{1.example.com 2.example.com 3.example.com
+                               4.example.com 5.example.com 6.example.com}).each(in: :groups, &command)
+      assert_equal 6, results.length
+      assert_equal *results[0..1].map(&:to_i)
+      assert_equal *results[2..3].map(&:to_i)
+      assert_equal *results[4..5].map(&:to_i)
+      assert_operator results[0].to_i, :<, results[2].to_i
+      assert_operator results[3].to_i, :<, results[4].to_i
+    end
+
+    def test_slow_host_timeout
+      # Ensure that we throw an error and rollback if one host takes an
+      # exceptional length of time longer than the others
+    end
+
+  end
+
+end

data/test/unit/test_host.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+module SSHKit
+
+  class TestHost < UnitTest
+
+    def test_raises_on_unparsable_string
+      assert_raises UnparsableHostStringError do
+        Host.new(":@hello@:")
+      end
+    end
+
+    def test_regular_hosts
+      h = Host.new 'example.com'
+      assert_equal 22,             h.port
+      assert_equal `whoami`.chomp, h.username
+      assert_equal 'example.com',  h.hostname
+    end
+
+    def test_host_with_port
+      h = Host.new 'example.com:2222'
+      assert_equal 2222,          h.port
+      assert_equal 'example.com', h.hostname
+    end
+
+    def test_host_with_username
+      h = Host.new 'root@example.com'
+      assert_equal 'root',        h.username
+      assert_equal 'example.com', h.hostname
+    end
+
+    def test_host_with_username_and_port
+      h = Host.new 'user@example.com:123'
+      assert_equal 123,           h.port
+      assert_equal 'user',        h.username
+      assert_equal 'example.com', h.hostname
+    end
+
+    def test_does_not_confuse_ipv6_hosts_with_port_specification
+      h = Host.new '[1fff:0:a88:85a3::ac1f]:8001'
+      assert_equal 8001,                    h.port
+      assert_equal '1fff:0:a88:85a3::ac1f', h.hostname
+    end
+
+    def testing_host_casting_to_a_key
+      assert_equal :"user@example.com:1234", Host.new('user@example.com:1234').to_key
+    end
+
+    def testing_host_casting_to_a_string
+      assert_equal "user@example.com:1234", Host.new('user@example.com:1234').to_s
+    end
+
+    def test_assert_hosts_hash_equally
+      assert_equal Host.new('example.com').hash, Host.new('example.com').hash
+    end
+
+    def test_assert_hosts_compare_equal
+      assert Host.new('example.com') == Host.new('example.com')
+      assert Host.new('example.com').eql? Host.new('example.com')
+      assert Host.new('example.com').equal? Host.new('example.com')
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,301 @@
+--- !ruby/object:Gem::Specification
+name: sshkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lee Hambley
+- Tom Clements
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-16 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: 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
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: autotest
+  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: 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
+  manner on groups of servers.
+email:
+- lee.hambley@gmail.com
+- seenmyfate@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardoc/checksums
+- .yardoc/object_types
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
+- .yardopts
+- CHANGELOG.md
+- EXAMPLES.md
+- FAQ.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- Vagrantfile
+- assets/images/logo.png
+- example.rb
+- lib/core_ext/array.rb
+- lib/core_ext/hash.rb
+- lib/sshkit.rb
+- lib/sshkit/all.rb
+- lib/sshkit/backends/abstract.rb
+- lib/sshkit/backends/netssh.rb
+- lib/sshkit/backends/printer.rb
+- lib/sshkit/command.rb
+- lib/sshkit/configuration.rb
+- lib/sshkit/connection_manager.rb
+- lib/sshkit/dsl.rb
+- lib/sshkit/host.rb
+- lib/sshkit/version.rb
+- sshkit.gemspec
+- test/functional/test_connection_manager.rb
+- test/functional/test_ssh_server_comes_up_for_functional_tests.rb
+- test/helper.rb
+- test/integration/backends/test_netssh.rb
+- test/unit/backends/test_netssh.rb
+- test/unit/backends/test_printer.rb
+- test/unit/core_ext/test_string.rb
+- test/unit/test_command.rb
+- test/unit/test_configuration.rb
+- test/unit/test_connection_manager.rb
+- test/unit/test_host.rb
+homepage: http://wacku.github.com/sshkit
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
+test_files:
+- test/functional/test_connection_manager.rb
+- test/functional/test_ssh_server_comes_up_for_functional_tests.rb
+- test/helper.rb
+- test/integration/backends/test_netssh.rb
+- test/unit/backends/test_netssh.rb
+- test/unit/backends/test_printer.rb
+- test/unit/core_ext/test_string.rb
+- test/unit/test_command.rb
+- test/unit/test_configuration.rb
+- test/unit/test_connection_manager.rb
+- test/unit/test_host.rb
+has_rdoc: