sshkit 0.0.16 → 0.0.18

data/CHANGELOG.md

@@ -3,6 +3,65 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.18
+
+ * Enable `as()` to take either a string/symbol as previously, but also now
+   accepts a hash of `{user: ..., group: ...}`. In case that your host system
+   supports the command `sg` (`man 1 sg`) to switch your effective group ID
+   then one can work on files as a team group user.
+
+        on host do |host|
+          as user: :peter, group: griffin do
+            execute :touch, 'somefile'
+          end
+        end
+
+    will result in a file with the following permissions:
+
+        -rw-r--r-- 1 peter griffin 0 Jan 27 08:12 somefile
+
+    This should make it much easier to share deploy scripts between team
+    members.
+
+    **Note:** `sg` has some very strict user and group password requirements
+    (the user may not have a password (`passwd username -l` to lock an account
+    that already has a password), and the group may not have a password.)
+
+    Additionally, and unsurprisingly *the user must also be a member of the
+    group.*
+
+    `sg` was chosen over `newgrp` as it's easier to embed in a one-liner
+    command, `newgrp` could be used with a heredoc, but my research suggested
+    that it might be better to use sg, as it better represents my intention, a
+    temporary switch to a different effective group.
+
+ * Fixed a bug with environmental variables and umasking introduced in 0.0.14.
+   Since that version the environmental variables were being presented to the
+   umask command's subshell, and not to intended command's subshell.
+
+       incorrect: `ENV=var umask 002 && env`
+       correct:   `umask 002 && ENV=var env`
+
+ * Changed the exception handler, if a command returns with a non-zero exit
+   status then the output will be prefixed with the command name and which
+   channel any output was written to, for example:
+
+       Command.new("echo ping; false")
+       => echo stdout: ping
+          echo stderr: Nothing written
+
+   In this contrived example that's more or less useless, however with badly
+   behaved commands that write errors to stdout, and don't include their name
+   in the program output, it can help a lot with debugging.
+
+## 0.0.17
+
+ * Fixed a bug introduced in 0.0.16 where the capture() helper returned
+   the name of the command that had been run, not it's output.
+
+ * Classify the pre-directory switch, and pre-user switch command guards
+   as having a DEBUG log level to exclude them from the logs.
+
 ## 0.0.16
 
  * Fixed a bug introduced in 0.0.15 where the capture() helper returned

data/EXAMPLES.md

@@ -50,6 +50,23 @@ This will output:
 **Note:** This example is a bit misleading, as the `www-data` user doesn't
 have a shell defined, one cannot switch to that user.
 
+## Run a command with a different effective group ID
+
+
+    on hosts do |host|
+      as user: 'www-data', group: 'project-group' do
+        in '/var/log' do
+          execute :touch, 'somefile'
+          execute :ls, '-l'
+        end
+      end
+
+One will see that the created file is owned by the user `www-data` and the
+group `project-group`.
+
+When combined with the `umask` configuration option, it is easy to share
+scripts for deployment between team members without sharing logins.
+
 ## Stack directory nestings
 
     on hosts do

data/lib/sshkit/backends/abstract.rb

@@ -43,7 +43,7 @@ module SSHKit
 
       def within(directory, &block)
         (@pwd ||= []).push directory.to_s
-        execute <<-EOTEST
+        execute <<-EOTEST, verbosity: Logger::DEBUG
           if test ! -d #{File.join(@pwd)}
             then echo "Directory does not exist '#{File.join(@pwd)}'" 1>&2
             false
@@ -63,24 +63,31 @@ module SSHKit
         remove_instance_variable(:@_env)
       end
 
-      def as(user, &block)
-        @user = user
-        execute <<-EOTEST
-          if ! sudo su #{user} -c whoami > /dev/null
-            then echo "You cannot switch to user '#{user}' using sudo, please check the sudoers file" 1>&2
+      def as(who, &block)
+        if who.is_a? Hash
+          @user  = who[:user]  || who["user"]
+          @group = who[:group] || who["group"]
+        else
+          @user  = who
+          @group = nil
+        end
+        execute <<-EOTEST, verbosity: Logger::DEBUG
+          if ! sudo su #{@user} -c whoami > /dev/null
+            then echo "You cannot switch to user '#{@user}' using sudo, please check the sudoers file" 1>&2
             false
           fi
         EOTEST
         yield
       ensure
         remove_instance_variable(:@user)
+        remove_instance_variable(:@group)
       end
 
       private
 
       def command(*args)
         options = args.extract_options!
-        SSHKit::Command.new(*[*args, options.merge({in: @pwd.nil? ? nil : File.join(@pwd), env: @env, host: @host, user: @user})])
+        SSHKit::Command.new(*[*args, options.merge({in: @pwd.nil? ? nil : File.join(@pwd), env: @env, host: @host, user: @user, group: @group})])
       end
 
       def connection

data/lib/sshkit/backends/netssh.rb

@@ -34,7 +34,7 @@ module SSHKit
 
       def capture(*args)
         options = args.extract_options!.merge(verbosity: Logger::DEBUG)
-        _execute(*[*args, options])
+        _execute(*[*args, options]).stdout.strip
       end
 
       def configure

data/lib/sshkit/command.rb

@@ -22,9 +22,9 @@ module SSHKit
 
     private
 
-      def map(command)
-        SSHKit.config.command_map[command.to_sym]
-      end
+    def map(command)
+      SSHKit.config.command_map[command.to_sym]
+    end
 
   end
 
@@ -87,8 +87,8 @@ module SSHKit
       @exit_status = new_exit_status
       if options[:raise_on_non_zero_exit] && exit_status > 0
         message = ""
-        message += (stdout.strip.empty? ? "No messages written to stdout\n" : stdout.strip)
-        message += (stderr.strip.empty? ? "No messages written to stderr\n" : stderr.strip)
+        message += "#{command} stdout: " + (stdout.strip.empty? ? "Nothing written" : stdout.strip) + "\n"
+        message += "#{command} stderr: " + (stderr.strip.empty? ? "Nothing written" : stderr.strip) + "\n"
         raise Failed, message
       end
     end
@@ -132,69 +132,91 @@ module SSHKit
       end
     end
 
-    def to_s(expanded=false)
-      return command.to_s if command.match /\s/
-      String.new.tap do |cs|
-        if options[:in]
-          cs << sprintf("cd %s && ", options[:in])
-        end
-        unless SSHKit.config.default_env.empty?
-          if options[:env].is_a? Hash
-            options[:env] = SSHKit.config.default_env.merge(options[:env])
-          end
-        end
-        if options[:env]
-          cs << '( '
-          options[:env].each do |k,v|
-            cs << k.to_s.upcase
-            cs << "="
-            cs << v.to_s
-            cs << ' '
+    def should_map?
+      !command.match /\s/
+    end
+
+    def within(&block)
+      return yield unless options[:in]
+      "cd #{options[:in]} && %s" % yield
+    end
+
+    def environment_hash
+      (SSHKit.config.default_env || {}).merge(options[:env] || {})
+    end
+
+    def envivonment_string
+      environment_hash.collect do |key,value|
+        "#{key.to_s.upcase}=#{value}"
+      end.join(' ')
+    end
+
+    def with(&block)
+      return yield unless environment_hash.any?
+      "( #{envivonment_string} %s )" % yield
+    end
+
+    def user(&block)
+      return yield unless options[:user]
+      "sudo su #{options[:user]} -c \"%s\"" % %Q{#{yield}}
+    end
+
+    def in_background(&block)
+      return yield unless options[:run_in_background]
+      "nohup %s > /dev/null &" % yield
+    end
+
+    def umask(&block)
+      return yield unless SSHKit.config.umask
+      "umask #{SSHKit.config.umask} && %s" % yield
+    end
+
+    def group(&block)
+      return yield unless options[:group]
+      "sg #{options[:group]} -c \\\"%s\\\"" % %Q{#{yield}}
+      # We could also use the so-called heredoc format perhaps:
+      #"newgrp #{options[:group]} <<EOC \\\"%s\\\" EOC" % %Q{#{yield}}
+    end
+
+    def to_s
+
+      return command.to_s unless should_map?
+
+      within do
+        umask do
+          with do
+            user do
+              in_background do
+                group do
+                  [SSHKit.config.command_map[command.to_sym], *Array(args)].join(' ')
+                end
+              end
+            end
           end
         end
-        if options[:user]
-          cs << "sudo su #{options[:user]} -c \""
-        end
-        if options[:run_in_background]
-          cs << 'nohup '
-        end
-        if umask = SSHKit.config.umask
-          cs << "umask #{umask} && "
-        end
-        cs << SSHKit.config.command_map[command.to_sym]
-        if args.any?
-          cs << ' '
-          cs << args.join(' ')
-        end
-        if options[:run_in_background]
-          cs << ' > /dev/null &'
-        end
-        if options[:user]
-          cs << "\""
-        end
-        if options[:env]
-          cs << ' )'
-        end
       end
     end
 
     private
 
-      def default_options
-        { raise_on_non_zero_exit: true, run_in_background: false }
-      end
+    def default_options
+      {
+        raise_on_non_zero_exit: true,
+        run_in_background:      false
+      }
+    end
 
-      def sanitize_command!
-        command.to_s.strip!
-        if command.to_s.match("\n")
-          @command = String.new.tap do |cs|
-            command.to_s.lines.each do |line|
-              cs << line.strip
-              cs << '; ' unless line == command.to_s.lines.to_a.last
-            end
+    def sanitize_command!
+      command.to_s.strip!
+      if command.to_s.match("\n")
+        @command = String.new.tap do |cs|
+          command.to_s.lines.each do |line|
+            cs << line.strip
+            cs << '; ' unless line == command.to_s.lines.to_a.last
           end
         end
       end
+    end
 
   end
 

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.16"
+  VERSION = "0.0.18"
 end

data/test/functional/backends/test_netssh.rb

@@ -62,13 +62,13 @@ module SSHKit
         end
       end
 
-      def test_execute_raises_on_non_zero_exit_status_and_captures_stderr
+      def test_execute_raises_on_non_zero_exit_status_and_captures_stdout_and_stderr
         err = assert_raises SSHKit::Command::Failed do
           Netssh.new(a_host) do |host|
             execute :echo, "'Test capturing stderr' 1>&2; false"
           end.run
         end
-        assert_equal "Test capturing stderr", err.message
+        assert_equal "echo stdout: Nothing written\necho stderr: Test capturing stderr\n", err.message
       end
 
       def test_test_does_not_raise_on_non_zero_exit_status

data/test/unit/test_command.rb

@@ -81,6 +81,16 @@ module SSHKit
       assert_equal "sudo su anotheruser -c \"/usr/bin/env whoami\"", String(c)
     end
 
+    def test_working_as_a_given_group
+      c = Command.new(:whoami, group: :devvers)
+      assert_equal "sg devvers -c \\\"/usr/bin/env whoami\\\"", String(c)
+    end
+
+    def test_working_as_a_given_user_and_group
+      c = Command.new(:whoami, user: :anotheruser, group: :devvers)
+      assert_equal "sudo su anotheruser -c \"sg devvers -c \\\"/usr/bin/env whoami\\\"\"", String(c)
+    end
+
     def test_backgrounding_a_task
       c = Command.new(:sleep, 15, run_in_background: true)
       assert_equal "nohup /usr/bin/env sleep 15 > /dev/null &", String(c)
@@ -111,13 +121,13 @@ module SSHKit
     def test_umask_with_working_directory_and_user
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', in: '/var', user: 'alice')
-      assert_equal "cd /var && sudo su alice -c \"umask 007 && /usr/bin/env touch somefile\"", String(c)
+      assert_equal "cd /var && umask 007 && sudo su alice -c \"/usr/bin/env touch somefile\"", String(c)
     end
 
     def test_umask_with_env_and_working_directory_and_user
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', user: 'bob', env: {a: 'b'}, in: '/var')
-      assert_equal "cd /var && ( A=b sudo su bob -c \"umask 007 && /usr/bin/env touch somefile\" )", String(c)
+      assert_equal "cd /var && umask 007 && ( A=b sudo su bob -c \"/usr/bin/env touch somefile\" )", String(c)
     end
 
     def test_verbosity_defaults_to_logger_info
@@ -195,7 +205,7 @@ module SSHKit
       error = assert_raises SSHKit::Command::Failed do
         Command.new(:whoami).exit_status = 1
       end
-      assert_equal "No messages written to stdout\nNo messages written to stderr\n", error.message
+      assert_equal "whoami stdout: Nothing written\nwhoami stderr: Nothing written\n", error.message
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh