sshkit 0.0.18 → 0.0.19

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.19
+
+ * Modified the `Pretty` formatter to include the log level in front of
+   executed commands.
+
+ * Modified the `Pretty` formatter not to print stdout and stderr by default,
+   the log level must be raised to Logger::DEBUG to see the command outputs.
+
+ * Modified the `Pretty` formatter to use `Command#to_s` when printing the
+   command, this prints the short form (without modifications/wrappers applied
+   to the command for users, groups, directories, umasks, etc).
+
 ## 0.0.18
 
  * Enable `as()` to take either a string/symbol as previously, but also now

data/lib/sshkit/backends/netssh.rb

@@ -53,7 +53,7 @@ module SSHKit
           cmd.started = true
           ssh.open_channel do |chan|
             chan.request_pty if config.pty
-            chan.exec cmd.to_s do |ch, success|
+            chan.exec cmd.to_command do |ch, success|
               chan.on_data do |ch, data|
                 cmd.stdout += data
                 output << cmd

data/lib/sshkit/backends/printer.rb

@@ -10,7 +10,7 @@ module SSHKit
       end
 
       def execute(*args)
-        output << String(command(*args)) + "\n"
+        output << command(*args).to_command + "\n"
       end
 
       def capture(command, args=[])

data/lib/sshkit/command.rb

@@ -178,17 +178,15 @@ module SSHKit
       #"newgrp #{options[:group]} <<EOC \\\"%s\\\" EOC" % %Q{#{yield}}
     end
 
-    def to_s
-
+    def to_command
       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(' ')
+                  to_s
                 end
               end
             end
@@ -197,6 +195,10 @@ module SSHKit
       end
     end
 
+    def to_s
+      [SSHKit.config.command_map[command.to_sym], *Array(args)].join(' ')
+    end
+
     private
 
     def default_options

data/lib/sshkit/formatters/pretty.rb

@@ -12,23 +12,28 @@ module SSHKit
           return if obj.verbosity < SSHKit.config.output_verbosity
 
           unless obj.started?
-            original_output << "[#{c.green(obj.uuid)}] Running #{c.yellow(c.bold(String(obj)))} on #{c.yellow(obj.host.to_s)}\n"
+            original_output << level(obj.verbosity) + uuid(obj) + "Running #{c.yellow(c.bold(String(obj)))} on #{c.blue(obj.host.to_s)}\n"
+            if SSHKit.config.output_verbosity = Logger::DEBUG
+              original_output << level(Logger::DEBUG) + uuid(obj) + c.white("Command: #{c.blue(obj.to_command)}") + "\n"
+            end
           end
 
-          if obj.complete? && !obj.stdout.empty?
-            obj.stdout.lines.each do |line|
-              original_output << c.green("\t" + line)
+          if SSHKit.config.output_verbosity == Logger::DEBUG
+            if obj.complete? && !obj.stdout.empty?
+              obj.stdout.lines.each do |line|
+                original_output << level(Logger::DEBUG) + uuid(obj) + c.green("\t" + line)
+              end
             end
-          end
 
-          if obj.complete? && !obj.stderr.empty?
-            obj.stderr.lines.each do |line|
-              original_output << c.red("\t" + line)
+            if obj.complete? && !obj.stderr.empty?
+              obj.stderr.lines.each do |line|
+                original_output << level(Logger::DEBUG) + uuid(obj) + c.red("\t" + line)
+              end
             end
           end
 
           if obj.finished?
-            original_output << "[#{c.green(obj.uuid)}] Finished in #{sprintf('%5.3f seconds', obj.runtime)} command #{c.bold { obj.failure? ? c.red('failed') : c.green('successful') }}.\n"
+            original_output << level(obj.verbosity) + uuid(obj) + "Finished in #{sprintf('%5.3f seconds', obj.runtime)} command #{c.bold { obj.failure? ? c.red('failed') : c.green('successful') }}.\n"
           end
 
         else
@@ -43,6 +48,24 @@ module SSHKit
         @c ||= Term::ANSIColor
       end
 
+      def uuid(obj)
+        "[#{c.green(obj.uuid)}] "
+      end
+
+      def level(verbosity)
+        # Insane number here accounts for the control codes added
+        # by term-ansicolor
+        sprintf "%14s ", c.send(level_formatting(verbosity), level_names(verbosity))
+      end
+
+      def level_formatting(level_num)
+        %w{black blue yellow red red }[level_num]
+      end
+
+      def level_names(level_num)
+        %w{DEBUG INFO WARN ERROR FATAL}[level_num]
+      end
+
     end
 
   end

data/lib/sshkit/version.rb

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

data/test/unit/test_command.rb

@@ -10,13 +10,13 @@ module SSHKit
 
     def test_maps_a_command
       c = Command.new('example')
-      assert_equal '/usr/bin/env example', String(c)
+      assert_equal '/usr/bin/env example', c.to_command
     end
 
     def test_not_mapping_a_builtin
       %w{if test time}.each do |builtin|
         c = Command.new(builtin)
-        assert_equal builtin, String(c)
+        assert_equal builtin, c.to_command
       end
     end
 
@@ -26,48 +26,48 @@ module SSHKit
           echo "Example"
         fi
       EOHEREDOC
-      assert_equal "if test ! -d /var/log; then; echo \"Example\"; fi", String(c)
+      assert_equal "if test ! -d /var/log; then; echo \"Example\"; fi", c.to_command
     end
 
     def test_including_the_env
       SSHKit.config = nil
       c = Command.new(:rails, 'server', env: {rails_env: :production})
-      assert_equal "( RAILS_ENV=production /usr/bin/env rails server )", String(c)
+      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 = Command.new(:rails, 'server', env: {rails_env: :production, foo: 'bar'})
-      assert_equal "( RAILS_ENV=production FOO=bar /usr/bin/env rails server )", String(c)
+      assert_equal "( RAILS_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 = Command.new(:rails, 'server', env: {path: '/example:$PATH'})
-      assert_equal "( PATH=/example:$PATH /usr/bin/env rails server )", String(c)
+      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 = Command.new(:rails, 'server', env: {})
-      assert_equal "( DEFAULT=env /usr/bin/env rails server )", String(c)
+      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 = Command.new(:rails, 'server', env: { over: 'write'})
-      assert_equal "( FOO=bar OVER=write /usr/bin/env rails server )", String(c)
+      assert_equal "( FOO=bar OVER=write /usr/bin/env rails server )", c.to_command
     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)
+      assert_equal "cd /opt/sites && /usr/bin/env ls -l", c.to_command
     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)
+      assert_equal "cd /opt/sites && ( A=b /usr/bin/env ls -l )", c.to_command
     end
 
     def test_having_a_host_passed
@@ -78,56 +78,56 @@ module SSHKit
 
     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)
+      assert_equal "sudo su anotheruser -c \"/usr/bin/env whoami\"", c.to_command
     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)
+      assert_equal "sg devvers -c \\\"/usr/bin/env whoami\\\"", c.to_command
     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)
+      assert_equal "sudo su anotheruser -c \"sg devvers -c \\\"/usr/bin/env whoami\\\"\"", c.to_command
     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)
+      assert_equal "nohup /usr/bin/env sleep 15 > /dev/null &", c.to_command
     end
 
     def test_backgrounding_a_task_as_a_given_user
       c = Command.new(:sleep, 15, run_in_background: true, user: :anotheruser)
-      assert_equal "sudo su anotheruser -c \"nohup /usr/bin/env sleep 15 > /dev/null &\"", String(c)
+      assert_equal "sudo su anotheruser -c \"nohup /usr/bin/env sleep 15 > /dev/null &\"", c.to_command
     end
 
     def test_backgrounding_a_task_as_a_given_user_with_env
       c = Command.new(:sleep, 15, run_in_background: true, user: :anotheruser, env: {a: :b})
-      assert_equal "( A=b sudo su anotheruser -c \"nohup /usr/bin/env sleep 15 > /dev/null &\" )", String(c)
+      assert_equal "( A=b sudo su anotheruser -c \"nohup /usr/bin/env sleep 15 > /dev/null &\" )", c.to_command
     end
 
     def test_umask
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile')
-      assert_equal "umask 007 && /usr/bin/env touch somefile", String(c)
+      assert_equal "umask 007 && /usr/bin/env touch somefile", c.to_command
     end
 
     def test_umask_with_working_directory
       SSHKit.config.umask = '007'
       c = Command.new(:touch, 'somefile', in: '/opt')
-      assert_equal "cd /opt && umask 007 && /usr/bin/env touch somefile", String(c)
+      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 = Command.new(:touch, 'somefile', in: '/var', user: 'alice')
-      assert_equal "cd /var && umask 007 && sudo su alice -c \"/usr/bin/env touch somefile\"", String(c)
+      assert_equal "cd /var && umask 007 && sudo su alice -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 = Command.new(:touch, 'somefile', user: 'bob', env: {a: 'b'}, in: '/var')
-      assert_equal "cd /var && umask 007 && ( A=b sudo su bob -c \"/usr/bin/env touch somefile\" )", String(c)
+      assert_equal "cd /var && umask 007 && ( A=b sudo su bob -c \"/usr/bin/env touch somefile\" )", c.to_command
     end
 
     def test_verbosity_defaults_to_logger_info

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors: