ssh-exec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f844d74dbe8f77a4c90f389a4f00861fc3f24cf5
+  data.tar.gz: 9abbaf177bee624d48c84145d37b4da7c1a971e4
+SHA512:
+  metadata.gz: c97bc264e675ab1dd2c8b9d74afbb7514055c23b39521a0f0ec37d8c168e2735fd64394fe8cedb01b957256f5948cae5da0c69481f9ed0f056008fdeb4f1bc9c
+  data.tar.gz: a3102b7edea0db1f107de5317a9d0bad60863a0cd7b22da5efae5cf404e64291ff2292ded919ac8fd41f632b503caaad9a8ebd340cb610bdaa74ef906a66a392

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private --protected lib/**/*.rb -m markdown - README.md
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+## ssh-exec
+
+`ssh-exec` is a wrapper around Net::SSH based on a
+[StackOverflow answer](http://stackoverflow.com/questions/3386233/how-to-get-exit-status-with-rubys-netssh-library/3386375#3386375),
+allowing to easily capture standard output, standard error, and the exit code
+of a command executed over [Net::SSH](https://github.com/net-ssh/net-ssh).
+
+### Examples
+
+```ruby
+require 'net/ssh'
+require 'ssh-exec'
+
+Net::SSH.start('somehost', 'someuser') do |ssh|
+  result = SshExec.ssh_exec!(ssh, 'echo I am remote host')
+  puts result.stdout  # "I am remote host"
+  puts result.stderr  # ""
+  puts result.exit_status  # 0
+
+  result = SshExec.ssh_exec!(ssh, 'false')
+  puts result.exit_status  # 1
+end
+```
+
+### License
+
+[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
+

data/Rakefile

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :build do
+  system "gem build #{GEM_NAME}.gemspec"
+end
+
+task :release => :build do
+  system "gem push #{GEM_NAME}-#{SshExec::VERSION}"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ssh-exec.rb

@@ -0,0 +1,103 @@
+# @markup markdown
+
+require 'net/ssh'
+require 'ostruct'
+require 'logger'
+
+module SshExec
+
+  @@log = Logger.new(STDOUT)
+  @@log.level = Logger::INFO
+
+
+  class ExecutionError < StandardError
+    attr_reader :object
+
+    def initialize(object)
+      @object = object
+    end
+  end
+
+  # Execute the given command using the given ssh object and capture its standard output, standard
+  # error, and exit status. The implementation is based on this
+  # {http://stackoverflow.com/questions/3386233/how-to-get-exit-status-with-rubys-netssh-library/3386375#3386375
+  # StackOveflow answer}.
+  # @param ssh the {Net::SSH} shell to run the command in
+  # @param options [Hash] optional settings:
+  #   `echo_stdout` - whether to echo standard output from the subcommand,
+  #   `echo_stderr` - whether to echo standard error from the subcommand
+  # @return [OpenStruct] a struct containing `stdout`, `stderr`, `exit_status`, and `exit_signal`
+  def self.ssh_exec!(ssh, command, options = {})
+    options = options.clone
+    echo_stdout = options[:echo_stdout]
+    echo_stderr = options[:echo_stderr]
+    raise "Invalid options: #{options}" unless options.empty?
+
+    stdout_data = ""
+    stderr_data = ""
+    exit_code = nil
+    exit_signal = nil
+    ssh.open_channel do |channel|
+      channel.exec(command) do |ch, success|
+        unless success
+          raise "FAILED: couldn't execute command #{command}"
+        end
+        channel.on_data do |ch, data|
+          stdout_data += data
+          $stdout.write(data) if echo_stdout
+        end
+
+        channel.on_extended_data do |ch, type, data|
+          stderr_data += data
+          $stderr.write(data) if echo_stderr
+        end
+
+        channel.on_request("exit-status") do |ch, data|
+          exit_code = data.read_long
+        end
+
+        channel.on_request("exit-signal") do |ch, data|
+          exit_signal = data.read_long
+        end
+      end
+    end
+    ssh.loop
+    OpenStruct.new(
+      :stdout => stdout_data,
+      :stderr => stderr_data,
+      :exit_status => exit_code,
+      :exit_signal => exit_signal
+    )
+  end
+
+  # Runs the given command in the given SSH shell, and raises {ExecutionError}
+  # in case of failure (nonzero exit status). Logs the command in all cases.
+  # Logs the command, exit status, standard output and standard error in case of failure.
+  # @param ssh the {Net::SSH} shell to run the command in
+  # @param options [Hash] optional settings:
+  #   `echo_stdout` - whether to echo stdout from the subcommand,
+  #   `echo_stderr` - whether to echo stderr from the subcommand,
+  #   `quiet` - to suppress logging the command and the error in case of non-zero exit status
+  # @return [OpenStruct] a struct containing `stdout`, `stderr`, `exit_status`, and `exit_signal`
+  def self.ensure_exec(ssh, command, options = {})
+    result = ssh_exec!(ssh, command, options)
+
+    options = options.clone
+    quiet = options.delete(:quiet)
+
+    @@log.info("Running on #{ssh.host}: #{command}") unless quiet
+
+    if result.exit_status  != 0
+      @@log.error(
+        ("Failed running command #{command}: exit status #{result.exit_status}. " +
+        (result.stdout.empty? ? "" : "Standard output:\n#{result.stdout}\n") +
+        (result.stderr.empty? ? "" : "Standard error:\n#{result.stderr}")).strip
+      ) unless quiet
+      raise ExecutionError.new(
+        "Failed running command #{command}: exit status #{result.exit_status}"
+      )
+    end
+    result
+  end
+
+end

data/lib/ssh-exec/version.rb

@@ -0,0 +1,4 @@
+module SshExec
+  VERSION = IO.read(File.expand_path("../../../VERSION", __FILE__)).strip
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'net/ssh'
+require 'etc'
+
+require 'ssh-exec'
+
+module SshHelpers
+
+  def ssh_localhost(&block)
+    Net::SSH.start('localhost', Etc.getlogin) do |ssh|
+      yield ssh
+    end
+  end
+
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/ssh-exec_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'SshExec' do
+  include SshHelpers
+
+  describe 'SshExec.ssh_exec!' do
+
+    it 'capture_streams' do
+      ssh_localhost do |ssh|
+        result = SshExec.ssh_exec!(ssh,
+          'echo Hello Stdout; echo Hello Stderr >&2'
+        )
+        expect(result.stdout).to eq("Hello Stdout\n")
+        expect(result.stderr).to eq("Hello Stderr\n")
+        expect(result.exit_status).to eq(0)
+        expect(result.exit_signal).to be_nil
+      end
+    end
+
+    it 'exit_status' do
+      ssh_localhost do |ssh|
+        [0, 1, 127, 128, 255].each do |status|
+          expect(SshExec.ssh_exec!(ssh, "exit #{status}").exit_status).to eq(status)
+        end
+      end
+    end
+
+  end
+
+  describe 'SshExec.ensure_exec' do
+    it 'not_raise_on_success' do
+      ssh_localhost do |ssh|
+        result = SshExec.ensure_exec(ssh, 'echo Hello Stdout; echo Hello Stderr >&2')
+        expect(result.stdout).to eq("Hello Stdout\n")
+        expect(result.stderr).to eq("Hello Stderr\n")
+        expect(result.exit_status).to eq(0)
+        expect(result.exit_signal).to be_nil
+      end
+    end
+
+    it 'raise_on_failure' do
+      ssh_localhost do |ssh|
+        expect { SshExec.ensure_exec(ssh, 'exit 1') }.to raise_error(SshExec::ExecutionError)
+      end
+    end
+  end
+
+end

data/ssh-exec.gemspec

@@ -0,0 +1,26 @@
+GEM_NAME = 'ssh-exec'
+
+require File.expand_path("../lib/#{GEM_NAME}/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Mikhail Bautin']
+  gem.email         = ['mbautin@gmail.com']
+  gem.summary       = 'A library allowing to execute commands over SSH using Net::SSH'
+  gem.description   = gem.summary
+  gem.homepage      = "http://github.com/mbautin/#{GEM_NAME}"
+  gem.licenses      = ['Apache 2.0']
+
+  gem.executables   = `git ls-files -- bin/*`.split('\n').map{ |f| File.basename(f.strip) }
+  gem.files         = `git ls-files`.split("\n").map(&:strip)
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split('\n').map(&:strip)
+  gem.name          = GEM_NAME
+  gem.require_paths = ['lib']
+  gem.version       = SshExec::VERSION
+
+  gem.add_dependency 'net-ssh', '~> 2.0'
+
+  gem.add_development_dependency 'rake', '~> 10.1'
+
+  gem.add_development_dependency 'rspec', '~> 2.14'
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ssh-exec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikhail Bautin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: A library allowing to execute commands over SSH using Net::SSH
+email:
+- mbautin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- lib/ssh-exec.rb
+- lib/ssh-exec/version.rb
+- spec/spec_helper.rb
+- spec/ssh-exec_spec.rb
+- ssh-exec.gemspec
+homepage: http://github.com/mbautin/ssh-exec
+licenses:
+- Apache 2.0
+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.2.1
+signing_key: 
+specification_version: 4
+summary: A library allowing to execute commands over SSH using Net::SSH
+test_files: []