sshkit-backends-netssh_global 0.0.1

data/test/helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'turn'
+require 'minitest/unit'
+require 'mocha/setup'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Dir[File.expand_path('test/support/*.rb')].each { |file| require file }
+
+class UnitTest < MiniTest::Unit::TestCase
+  # def setup
+  #   SSHKit.reset_configuration!
+  # end
+end
+
+class FunctionalTest < MiniTest::Unit::TestCase
+  def setup
+    unless VagrantWrapper.running?
+      warn "Vagrant VMs are not running. Please, start it manually with `vagrant up`"
+    end
+  end
+end
+
+#
+# Force colours in Autotest
+#
+Turn.config.ansi = true
+Turn.config.format = :pretty
+
+MiniTest::Unit.autorun

data/test/support/vagrant_wrapper.rb

@@ -0,0 +1,63 @@
+# Copy of VagrantWrapper from SSHKit
+require 'json'
+require 'sshkit'
+
+class VagrantWrapper
+  class << self
+    def hosts
+      @vm_hosts ||= begin
+        result = {}
+
+        boxes = boxes_list
+
+        unless running?
+          boxes.map! do |box|
+            box['user'] = ENV['USER']
+            box['port'] = '22'
+            box
+          end
+        end
+
+        boxes.each do |vm|
+          result[vm['name']] = vm_host(vm)
+        end
+
+        result
+      end
+    end
+
+    def reset!
+      @vm_hosts = nil
+    end
+
+    def running?
+      @running ||= begin
+        status = `#{vagrant_binary} status`
+        status.include?('running')
+      end
+    end
+
+    def boxes_list
+      json_config_path = File.join('test', 'boxes.json')
+      boxes = File.open(json_config_path).read
+      JSON.parse(boxes)
+    end
+
+    def vagrant_binary
+      'vagrant'
+    end
+
+    private
+
+    def vm_host(vm)
+      host_options = {
+          user: vm['user'] || 'vagrant',
+          hostname: vm['hostname'] || 'localhost',
+          port: vm['port'] || '22',
+          password: vm['password'] || 'vagrant'
+      }
+
+      SSHKit::Host.new(host_options)
+    end
+  end
+end

data/test/unit/backends/test_netssh_global.rb

@@ -0,0 +1,59 @@
+require 'helper'
+require 'sshkit/backends/netssh_global'
+
+module SSHKit
+  module Backend
+    class TestNetsshGlobalUnit < UnitTest
+      def backend
+        @backend ||= NetsshGlobal
+      end
+
+      def test_net_ssh_configuration_options
+        backend.configure do |ssh|
+          ssh.pty = true
+          ssh.connection_timeout = 30
+          ssh.owner = 'fred'
+          ssh.ssh_options = {
+            keys: %w(/home/user/.ssh/id_rsa),
+            forward_agent: false,
+            auth_methods: %w(publickey password)
+          }
+        end
+
+        assert_equal 30, backend.config.connection_timeout
+        assert_equal true, backend.config.pty
+        assert_equal 'fred', backend.config.owner
+
+        assert_equal %w(/home/user/.ssh/id_rsa),  backend.config.ssh_options[:keys]
+        assert_equal false,                       backend.config.ssh_options[:forward_agent]
+        assert_equal %w(publickey password),      backend.config.ssh_options[:auth_methods]
+
+      end
+
+      def test_netssh_ext
+        assert_includes  Net::SSH::Config.default_files, "#{Dir.pwd}/.ssh/config"
+      end
+
+      def test_transfer_summarizer
+        netssh_as_global = backend.new(Host.new('fake'))
+
+        summarizer = netssh_as_global.send(:transfer_summarizer,'Transferring')
+
+        [
+         [1,    1000, :debug, 'Transferring afile 0.1%'],
+         [1,    100,  :debug, 'Transferring afile 1.0%'],
+         [99,   1000, :debug, 'Transferring afile 9.9%'],
+         [15,   100,  :info,  'Transferring afile 15.0%'],
+         [1,    3,    :info,  'Transferring afile 33.33%'],
+         [0,    1,    :debug, 'Transferring afile 0.0%'],
+         [1,    2,    :info,  'Transferring afile 50.0%'],
+         [0,    0,    :warn,  'percentage 0/0'],
+         [1023, 343,  :info,  'Transferring'],
+        ].each do |transferred,total,method,substring|
+          netssh_as_global.expects(method).with { |msg| msg.include?(substring) }
+          summarizer.call(nil,'afile',transferred,total)
+        end
+      end
+    end
+  end
+end

data/test/unit/test_command_sudo_ssh_forward.rb

@@ -0,0 +1,239 @@
+require 'helper'
+require 'sshkit/command_sudo_ssh_forward'
+
+module SSHKit
+  class TestCommandSudoSshForward < UnitTest
+    def setup
+      SSHKit.reset_configuration!
+    end
+
+    def test_maps_a_command
+      c = CommandSudoSshForward.new('example')
+      assert_equal '/usr/bin/env example', c.to_command
+    end
+
+    def test_not_mapping_a_builtin
+      %w{if test time}.each do |builtin|
+        c = CommandSudoSshForward.new(builtin)
+        assert_equal builtin, c.to_command
+      end
+    end
+
+    def test_using_a_heredoc
+      c = CommandSudoSshForward.new <<-EOHEREDOC
+        if test ! -d /var/log; then
+          echo "Example"
+        fi
+      EOHEREDOC
+      assert_equal "if test ! -d /var/log; then; echo \"Example\"; fi", c.to_command
+    end
+
+    def test_including_the_env
+      SSHKit.config = nil
+      c = CommandSudoSshForward.new(:rails, 'server', env: {rails_env: :production})
+      assert_equal "( RAILS_ENV=production /usr/bin/env rails server )", c.to_command
+    end
+
+    def test_including_the_env_with_multiple_keys
+      SSHKit.config = nil
+      c = CommandSudoSshForward.new(:rails, 'server', env: {rails_env: :production, foo: 'bar'})
+      assert_equal "( RAILS_ENV=production FOO=bar /usr/bin/env rails server )", c.to_command
+    end
+
+    def test_including_the_env_with_string_keys
+      SSHKit.config = nil
+      c = CommandSudoSshForward.new(:rails, 'server', env: {'FACTER_env' => :production, foo: 'bar'})
+      assert_equal "( FACTER_env=production FOO=bar /usr/bin/env rails server )", c.to_command
+    end
+
+    def test_including_the_env_doesnt_addressively_escape
+      SSHKit.config = nil
+      c = CommandSudoSshForward.new(:rails, 'server', env: {path: '/example:$PATH'})
+      assert_equal "( PATH=/example:$PATH /usr/bin/env rails server )", c.to_command
+    end
+
+    def test_global_env
+      SSHKit.config = nil
+      SSHKit.config.default_env = { default: 'env' }
+      c = CommandSudoSshForward.new(:rails, 'server', env: {})
+      assert_equal "( DEFAULT=env /usr/bin/env rails server )", c.to_command
+    end
+
+    def test_default_env_is_overwritten_with_locally_defined
+      SSHKit.config.default_env = { foo: 'bar', over: 'under' }
+      c = CommandSudoSshForward.new(:rails, 'server', env: { over: 'write'})
+      assert_equal "( FOO=bar OVER=write /usr/bin/env rails server )", c.to_command
+    end
+
+    def test_working_in_a_given_directory
+      c = CommandSudoSshForward.new(:ls, '-l', in: "/opt/sites")
+      assert_equal "cd /opt/sites && /usr/bin/env ls -l", c.to_command
+    end
+
+    def test_working_in_a_given_directory_with_env
+      c = CommandSudoSshForward.new(:ls, '-l', in: "/opt/sites", env: {a: :b})
+      assert_equal "cd /opt/sites && ( A=b /usr/bin/env ls -l )", c.to_command
+    end
+
+    def test_having_a_host_passed
+      refute CommandSudoSshForward.new(:date).host
+      assert CommandSudoSshForward.new(:date, host: :foo)
+      assert_equal :foo, CommandSudoSshForward.new(host: :foo).host
+    end
+
+    def test_working_as_a_given_user
+      c = CommandSudoSshForward.new(:whoami, user: :anotheruser)
+      assert_equal "sudo -u anotheruser -- sh -c '/usr/bin/env whoami'", c.to_command
+    end
+
+    def test_working_as_a_given_user_with_a_custom_shell
+      c = CommandSudoSshForward.new(:whoami, user: :anotheruser, shell: 'bash -l')
+      assert_equal "sudo -u anotheruser -- bash -l -c '/usr/bin/env whoami'", c.to_command
+    end
+
+    def test_working_as_a_given_group
+      c = CommandSudoSshForward.new(:whoami, group: :devvers)
+      assert_equal "sg devvers -c \\\"/usr/bin/env whoami\\\"", c.to_command
+    end
+
+    def test_working_as_a_given_user_and_group
+      c = CommandSudoSshForward.new(:whoami, user: :anotheruser, group: :devvers)
+      assert_equal "sudo -u anotheruser -- sh -c 'sg devvers -c \\\"/usr/bin/env whoami\\\"'", c.to_command
+    end
+
+    def test_umask
+      SSHKit.config.umask = '007'
+      c = CommandSudoSshForward.new(:touch, 'somefile')
+      assert_equal "umask 007 && /usr/bin/env touch somefile", c.to_command
+    end
+
+    def test_umask_with_working_directory
+      SSHKit.config.umask = '007'
+      c = CommandSudoSshForward.new(:touch, 'somefile', in: '/opt')
+      assert_equal "cd /opt && umask 007 && /usr/bin/env touch somefile", c.to_command
+    end
+
+    def test_umask_with_working_directory_and_user
+      SSHKit.config.umask = '007'
+      c = CommandSudoSshForward.new(:touch, 'somefile', in: '/var', user: 'alice')
+      assert_equal "cd /var && umask 007 && sudo -u alice -- sh -c '/usr/bin/env touch somefile'", c.to_command
+    end
+
+    def test_umask_with_env_and_working_directory_and_user
+      SSHKit.config.umask = '007'
+      c = CommandSudoSshForward.new(:touch, 'somefile', user: 'bob', env: {a: 'b'}, in: '/var')
+      assert_equal "cd /var && umask 007 && sudo -u bob A=b -- sh -c '/usr/bin/env touch somefile'", c.to_command
+    end
+
+    def test_verbosity_defaults_to_logger_info
+      assert_equal Logger::INFO, CommandSudoSshForward.new(:ls).verbosity
+    end
+
+    def test_overriding_verbosity_level_with_a_constant
+      assert_equal Logger::DEBUG, CommandSudoSshForward.new(:ls, verbosity: Logger::DEBUG).verbosity
+    end
+
+    def test_overriding_verbosity_level_with_a_symbol
+      assert_equal Logger::DEBUG, CommandSudoSshForward.new(:ls, verbosity: :debug).verbosity
+    end
+
+    def test_complete?
+      c = CommandSudoSshForward.new(:whoami, raise_on_non_zero_exit: false)
+      refute c.complete?
+      c.exit_status = 1
+      assert c.complete?
+      c.exit_status = 0
+      assert c.complete?
+    end
+
+    def test_successful?
+      c = CommandSudoSshForward.new(:whoami)
+      refute c.successful?
+      refute c.success?
+      c.exit_status = 0
+      assert c.successful?
+      assert c.success?
+    end
+
+    def test_failure?
+      c = CommandSudoSshForward.new(:whoami, raise_on_non_zero_exit: false)
+      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 = CommandSudoSshForward.new(:whoami)
+      assert c.stdout += "test\n"
+      assert_equal "test\n", c.stdout
+    end
+
+    def test_appending_stderr
+      c = CommandSudoSshForward.new(:whoami)
+      assert c.stderr += "test\n"
+      assert_equal "test\n", c.stderr
+    end
+
+    def test_setting_exit_status
+      c = CommandSudoSshForward.new(:whoami, raise_on_non_zero_exit: false)
+      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 CommandSudoSshForward.new(:whoami).uuid
+    end
+
+    def test_wont_take_no_args
+      assert_raises ArgumentError do
+        CommandSudoSshForward.new
+      end
+    end
+
+    def test_command_raises_command_failed_error_when_non_zero_exit
+      error = assert_raises SSHKit::CommandSudoSshForward::Failed do
+        CommandSudoSshForward.new(:whoami).exit_status = 1
+      end
+      assert_equal "whoami exit status: 1\nwhoami stdout: Nothing written\nwhoami stderr: Nothing written\n", error.message
+    end
+
+    def test_does_not_forward_ssh_when_host_supports_it_but_sudo_not_required
+      host = Host.new('user@example.com')
+      host.ssh_options = {forward_agent: true}
+      c = CommandSudoSshForward.new(:whoami, host: host, ssh_commands: [:whoami])
+      assert_equal "/usr/bin/env whoami", c.to_command
+    end
+
+    def test_does_not_forward_ssh_when_host_does_not_forward_agent
+      host = Host.new('user@example.com')
+      host.ssh_options = {forward_agent: false, ssh_commands: [:whoami]}
+      c = CommandSudoSshForward.new(:whoami, host: host)
+      assert_equal "/usr/bin/env whoami", c.to_command
+    end
+
+    def test_forwards_ssh_when_host_supports_it_and_sudo_required
+      host = Host.new('user@example.com')
+      host.ssh_options = {forward_agent: true}
+      c = CommandSudoSshForward.new(:whoami, host: host, user: 'fred', ssh_commands: [:whoami])
+      assert_equal(
+        'setfacl -m fred:x $(dirname $SSH_AUTH_SOCK) && '\
+        'setfacl -m fred:rw $SSH_AUTH_SOCK && '\
+        "sudo -u fred SSH_AUTH_SOCK=$SSH_AUTH_SOCK -- sh -c '/usr/bin/env whoami'", c.to_command
+      )
+    end
+
+    def test_does_not_forward_ssh_when_command_is_not_ssh_command
+      host = Host.new('user@example.com')
+      host.ssh_options = {forward_agent: true}
+      c = CommandSudoSshForward.new(:whoami, host: host, user: 'fred', ssh_commands: [:something_else])
+
+      assert_equal "sudo -u fred -- sh -c '/usr/bin/env whoami'", c.to_command
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: sshkit-backends-netssh_global
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Theo Cushion
+- Dennis Ideler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  A backend to be used in conjunction with Capistrano 3
+  and SSHKit to allow deployment on setups where users login as one identity and
+  then need to sudo to a different identity for each command.
+email:
+- tcushion@pivotal.io
+- dennis.ideler@fundingcircle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Brewfile
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/sshkit/backends/netssh_global.rb
+- lib/sshkit/backends/version.rb
+- lib/sshkit/command_sudo_ssh_forward.rb
+- sshkit-backends-netssh_global.gemspec
+- test/boxes.json
+- test/functional/backends/test_netssh_global.rb
+- test/helper.rb
+- test/support/vagrant_wrapper.rb
+- test/unit/backends/test_netssh_global.rb
+- test/unit/test_command_sudo_ssh_forward.rb
+homepage: http://github.com/fundingcircle/sshkit-backends-netssh_global
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: SSHKit backend for globally sudoing commands
+test_files:
+- test/boxes.json
+- test/functional/backends/test_netssh_global.rb
+- test/helper.rb
+- test/support/vagrant_wrapper.rb
+- test/unit/backends/test_netssh_global.rb
+- test/unit/test_command_sudo_ssh_forward.rb