specinfra-backend-extension-ssh_su 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52dffdc170754fa45004d759043258607a1a021e
+  data.tar.gz: 549874669dedd12abddb0bfd95cec8bbe0efb001
+SHA512:
+  metadata.gz: 1d6fbd5879bb7b673636f049547dbb80282a462b15285c627b5557d6cea780388708ed4494441fc5314840e183076f4aba6d621d125df92536b4904134711d85
+  data.tar.gz: 92905e3611b85e1eb8e9b2535c179b72cde01e1bf477e62056beaa6cb46d4ece70f88a88f5c4146b8791f097daf4c22ee1ea1da600acafcf21ab44a4d18414df

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in specinfra-backend-extension-ssh_su.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Specinfra::Backend::Extension::SshSu
+
+SSH + su backend for specinfra.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'specinfra-backend-extension-ssh_su'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install specinfra-backend-extension-ssh_su
+
+## Usage
+
+```ruby
+require 'specinfra'
+require 'specinfra/helper/set'
+require 'specinfra/backend/extension/ssh_su'
+require 'highline/import'
+
+include Specinfra::Helper::Set
+include Specinfra::Helper::Os
+
+host = ARGV[0]
+
+set :host, host
+set :backend, :ssh_su
+
+options = Net::SSH::Config.for(host)
+options[:user] = ask("Enter ssh user: ")
+options[:password] = ask("Enter ssh password: ") { |q| q.echo = false }
+set :ssh_options, options
+
+set :su_password, ask("Enter su password: ") { |q| q.echo = false }
+
+puts Specinfra::Runner::run_command('whoami').stdout
+puts Specinfra::Runner::run_command('cat /etc/passwd | grep `whoami`').stdout
+
+set :os, os
+if Specinfra.configuration.os[:family] == 'redhat'
+  puts Specinfra::Runner::install_package('epel-release').stdout
+end
+
+puts Specinfra::Runner::install_package('nginx').stdout
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/specinfra-backend-extension-ssh_su/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/specinfra/backend/extension/ssh_su.rb

@@ -0,0 +1,117 @@
+require "specinfra/backend/extension/ssh_su/version"
+require "specinfra/backend/ssh"
+
+module Specinfra
+  module Backend
+    module Extension
+      module SshSu
+      end
+    end
+
+    class SshSu < Ssh
+      def initialize
+        Specinfra.configuration.disable_sudo = true
+      end
+
+      def run_command(cmd, opt={})
+        cmd = build_command(cmd)
+        res = super(cmd)
+
+        if su?
+          stdout = res.instance_variable_get(:@stdout).gsub!(/\A\n/, "")
+
+          if @example
+            @example.metadata[:stdout] = stdout
+          end
+        end
+
+        res
+      end
+
+      def build_command(cmd)
+        cmd = super(cmd)
+        if su?
+          su_user = Specinfra.configuration.su_user || 'root'
+          cmd = "#{su} - #{su_user} -c #{cmd.shellescape}"
+        end
+        cmd
+      end
+
+      private
+      def prompt
+        Specinfra.configuration.su_prompt || 'Password: '
+      end
+
+      def ssh_exec!(command)
+        stdout_data = ''
+        stderr_data = ''
+        exit_status = nil
+        exit_signal = nil
+
+        if Specinfra.configuration.ssh.nil?
+          Specinfra.configuration.ssh = create_ssh
+        end
+
+        ssh = Specinfra.configuration.ssh
+        ssh.open_channel do |channel|
+          if Specinfra.configuration.su_password or Specinfra.configuration.request_pty
+            channel.request_pty do |ch, success|
+              abort "Could not obtain pty " if !success
+            end
+          end
+          channel.exec("#{command}") do |ch, success|
+            abort "FAILED: couldn't execute command (ssh.channel.exec)" if !success
+            channel.on_data do |ch, data|
+              if data.match /^#{prompt}/
+                channel.send_data "#{Specinfra.configuration.su_password}\n"
+              else
+                stdout_data += data
+              end
+            end
+
+            channel.on_extended_data do |ch, type, data|
+              if data.match /(standard in must be a tty|must be run from a terminal)/
+                abort 'Please write "set :request_pty, true" in your spec_helper.rb or other appropriate file.'
+              end
+
+              stderr_data += data
+            end
+
+            channel.on_request("exit-status") do |ch, data|
+              exit_status = data.read_long
+            end
+
+            channel.on_request("exit-signal") do |ch, data|
+              exit_signal = data.read_long
+            end
+          end
+        end
+        ssh.loop
+        { :stdout => stdout_data, :stderr => stderr_data, :exit_status => exit_status, :exit_signal => exit_signal }
+      end
+
+      def su
+        if su_path = Specinfra.configuration.su_path
+          su_path += '/su'
+        else
+          su_path = 'su'
+        end
+
+        su_options = Specinfra.configuration.su_options
+        if su_options
+          su_options = su_options.shelljoin if su_options.is_a?(Array)
+          su_options = ' ' + su_options
+        end
+
+        "#{su_path.shellescape}#{su_options}"
+      end
+
+      def su?
+        user = Specinfra.configuration.ssh_options[:user]
+        disable_su = Specinfra.configuration.disable_su
+        user != 'root' && !disable_su
+      end
+    end
+
+  end
+end

data/lib/specinfra/backend/extension/ssh_su/version.rb

@@ -0,0 +1,9 @@
+module Specinfra
+  module Backend
+    module Extension
+      module SshSu
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

data/spec/build_command_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+set :backend, :ssh_su
+
+describe Specinfra::Backend::Ssh do
+  describe '#build_command' do
+    context 'with root user' do
+      before do
+        RSpec.configure do |c|
+          set :ssh_options, :user => 'root'
+          c.ssh = double(:ssh, Specinfra.configuration.ssh_options)
+        end
+      end
+
+      it 'should not prepend sudo' do
+        expect(Specinfra.backend.build_command('test -f /etc/passwd')).to eq '/bin/sh -c test\ -f\ /etc/passwd'
+      end
+
+      it 'should escape special characters' do
+        expect(Specinfra.backend.build_command('test ! -f /etc/selinux/config || (getenforce | grep -i -- disabled && grep -i -- ^SELINUX=disabled$ /etc/selinux/config)')).to eq '/bin/sh -c test\ \!\ -f\ /etc/selinux/config\ \|\|\ \(getenforce\ \|\ grep\ -i\ --\ disabled\ \&\&\ grep\ -i\ --\ \^SELINUX\=disabled\$\ /etc/selinux/config\)'
+      end
+    end
+
+    context 'with non-root user' do
+      before do
+        RSpec.configure do |c|
+          set :ssh_options, :user => 'foo'
+          c.ssh = double(:ssh, Specinfra.configuration.ssh_options)
+        end
+      end
+
+      it 'should prepend su' do
+        expect(Specinfra.backend.build_command('test -f /etc/passwd')).to eq 'su - root -c /bin/sh\\ -c\\ test\\\\\\ -f\\\\\\ /etc/passwd'
+      end
+
+      it 'should escape special characters' do
+        expect(Specinfra.backend.build_command('test ! -f /etc/selinux/config || (getenforce | grep -i -- disabled && grep -i -- ^SELINUX=disabled$ /etc/selinux/config)')).to eq 'su - root -c /bin/sh\\ -c\\ test\\\\\\ \\\\\\!\\\\\\ -f\\\\\\ /etc/selinux/config\\\\\\ \\\\\\|\\\\\\|\\\\\\ \\\\\\(getenforce\\\\\\ \\\\\\|\\\\\\ grep\\\\\\ -i\\\\\\ --\\\\\\ disabled\\\\\\ \\\\\\&\\\\\\&\\\\\\ grep\\\\\\ -i\\\\\\ --\\\\\\ \\\\\\^SELINUX\\\\\\=disabled\\\\\\$\\\\\\ /etc/selinux/config\\\\\\)'
+      end
+    end
+
+    context 'with custom su user' do before do
+        RSpec.configure do |c|
+          set :ssh_options, :user => 'foo'
+          c.ssh = double(:ssh, Specinfra.configuration.ssh_options)
+          c.su_user = 'bar'
+        end
+      end
+
+      after do
+        RSpec.configure do |c|
+          c.su_user = nil
+        end
+      end
+
+      it 'command pattern 1a' do
+        expect(Specinfra.backend.build_command('test -f /etc/passwd')).to eq 'su - bar -c /bin/sh\\ -c\\ test\\\\\\ -f\\\\\\ /etc/passwd'
+      end
+
+      it 'command pattern 2a' do
+        expect(Specinfra.backend.build_command('test ! -f /etc/selinux/config || (getenforce | grep -i -- disabled && grep -i -- ^SELINUX=disabled$ /etc/selinux/config)')).to eq 'su - bar -c /bin/sh\\ -c\\ test\\\\\\ \\\\\\!\\\\\\ -f\\\\\\ /etc/selinux/config\\\\\\ \\\\\\|\\\\\\|\\\\\\ \\\\\\(getenforce\\\\\\ \\\\\\|\\\\\\ grep\\\\\\ -i\\\\\\ --\\\\\\ disabled\\\\\\ \\\\\\&\\\\\\&\\\\\\ grep\\\\\\ -i\\\\\\ --\\\\\\ \\\\\\^SELINUX\\\\\\=disabled\\\\\\$\\\\\\ /etc/selinux/config\\\\\\)'
+      end
+    end
+
+    context 'with custom su path' do before do
+        RSpec.configure do |c|
+          set :ssh_options, :user => 'foo'
+          c.ssh = double(:ssh, Specinfra.configuration.ssh_options)
+          c.su_path = '/usr/local/bin'
+        end
+      end
+
+      after do
+        RSpec.configure do |c|
+          c.sudo_path = nil
+        end
+      end
+
+      it 'command pattern 1a' do
+        expect(Specinfra.backend.build_command('test -f /etc/passwd')).to eq '/usr/local/bin/su - root -c /bin/sh\\ -c\\ test\\\\\\ -f\\\\\\ /etc/passwd'
+      end
+
+      it 'command pattern 2a' do
+        expect(Specinfra.backend.build_command('test ! -f /etc/selinux/config || (getenforce | grep -i -- disabled && grep -i -- ^SELINUX=disabled$ /etc/selinux/config)')).to eq '/usr/local/bin/su - root -c /bin/sh\\ -c\\ test\\\\\\ \\\\\\!\\\\\\ -f\\\\\\ /etc/selinux/config\\\\\\ \\\\\\|\\\\\\|\\\\\\ \\\\\\(getenforce\\\\\\ \\\\\\|\\\\\\ grep\\\\\\ -i\\\\\\ --\\\\\\ disabled\\\\\\ \\\\\\&\\\\\\&\\\\\\ grep\\\\\\ -i\\\\\\ --\\\\\\ \\\\\\^SELINUX\\\\\\=disabled\\\\\\$\\\\\\ /etc/selinux/config\\\\\\)'
+      end
+    end
+
+    context 'without su' do
+      before do
+        RSpec.configure do |c|
+          set :ssh_options, :user => 'foo'
+          c.ssh = double(:ssh, Specinfra.configuration.ssh_options)
+          c.disable_su = true
+        end
+      end
+
+      after do
+        RSpec.configure do |c|
+          c.disable_su = false
+        end
+      end
+
+      it 'command pattern 1b' do
+        expect(Specinfra.backend.build_command('test -f /etc/passwd')).to eq '/bin/sh -c test\ -f\ /etc/passwd'
+      end
+
+      it 'command pattern 2b' do
+        expect(Specinfra.backend.build_command('test ! -f /etc/selinux/config || (getenforce | grep -i -- disabled && grep -i -- ^SELINUX=disabled$ /etc/selinux/config)')).to eq '/bin/sh -c test\ \!\ -f\ /etc/selinux/config\ \|\|\ \(getenforce\ \|\ grep\ -i\ --\ disabled\ \&\&\ grep\ -i\ --\ \^SELINUX\=disabled\$\ /etc/selinux/config\)'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'specinfra'
+require 'specinfra/backend/extension/ssh_su'
+require 'rspec/mocks/standalone'
+require 'rspec/its'
+require 'specinfra/helper/set'
+include Specinfra::Helper::Set
+
+set :backend, :ssh_su
+
+module Specinfra
+  module Backend
+    class Ssh
+      def run_command(cmd, opts={})
+        CommandResult.new :stdout => nil, :exit_status => 0
+      end
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.add_setting :su_user,    :deafult => nil
+  c.add_setting :su_path,    :deafult => nil
+  c.add_setting :disable_su, :deafult => false
+end

data/specinfra-backend-extension-ssh_su.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'specinfra/backend/extension/ssh_su/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "specinfra-backend-extension-ssh_su"
+  spec.version       = Specinfra::Backend::Extension::SshSu::VERSION
+  spec.authors       = ["hayajo"]
+  spec.email         = ["hayajo@cpan.org"]
+  spec.summary       = %q{SSH + su backend for specinfra.}
+  spec.description   = %q{SSH + su backend for specinfra.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "specinfra", "~> 2.11.5"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: specinfra-backend-extension-ssh_su
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hayajo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: specinfra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-its
+  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: SSH + su backend for specinfra.
+email:
+- hayajo@cpan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/specinfra/backend/extension/ssh_su.rb
+- lib/specinfra/backend/extension/ssh_su/version.rb
+- spec/build_command_spec.rb
+- spec/spec_helper.rb
+- specinfra-backend-extension-ssh_su.gemspec
+homepage: ''
+licenses:
+- MIT
+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.5
+signing_key: 
+specification_version: 4
+summary: SSH + su backend for specinfra.
+test_files:
+- spec/build_command_spec.rb
+- spec/spec_helper.rb