sshake 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f07fcd2695da038870ae9a7c15715524ed1cbd1912a38c9cbd4c3d3d9f39d96
-  data.tar.gz: c941f1f5ae3dd0348da4c694f769fdad2fcaa026777cf0c8a5cd6278d179a87a
+  metadata.gz: 95a0f6a6db803ff62826997e18e0b5d5ec81977046833bc32c10e29ebdbfd883
+  data.tar.gz: 8a2c9aa526b96827b3d50d25cd8b479bf3310eb6857822790410e79a38ac8423
 SHA512:
-  metadata.gz: 0c7636ffe034fc59aa89043bfb44d6e78d156567283f5a77b82eeb98df91f8977e561c2435f2512261166a0242fe0d75b5c7ca8369b9babd6f96729f29323dc5
-  data.tar.gz: bc5eb231a03e4e207a9c478bdb4b3764366f48d82576d6d60b2daa3571cce7383c9f8d6d4d49d786b8c6fbf6582fee132cdb7039f7a40c9a90a44ffd5083856f
+  metadata.gz: dc53e93b8e027f96c6078acb1626a056512dbf932a5650a1e4e4dfa53d28d72c219cff4acb392ca3d46fcbd5cd136aa7114b3edca27884817f86ace0648ec0c5
+  data.tar.gz: 25e70b953ed507800fa3f1a0531c926023d383f8a73caf8de201e12db2b4dd4e864af0080bf657952ad00112528572368e6c9eced39adf254858897e9487a6e3

data/lib/sshake/base_session.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'securerandom'
-require 'sshake/logger'
+require 'klogger'
+require 'sshake/klogger'
 require 'sshake/execution_options'
 
 module SSHake
@@ -9,8 +10,8 @@ module SSHake
 
     # A logger for this session
     #
-    # @return [Logger, nil]
-    attr_accessor :logger
+    # @return [Klogger, nil]
+    attr_accessor :klogger
 
     # An ID for this session
     #
@@ -22,8 +23,9 @@ module SSHake
     # @return [Boolean]
     attr_accessor :raise_on_error
 
-    def initialize(*_args)
+    def initialize(*_args, klogger: nil)
       @id = SecureRandom.hex(4)
+      @klogger = klogger || SSHake.klogger
     end
 
     # Connect to the SSH server
@@ -88,17 +90,6 @@ module SSHake
       end
     end
 
-    def log(type, text, _options = {})
-      logger = @logger || SSHake.logger
-      return unless logger
-
-      prefix = "[#{@id}] [#{@host}] "
-
-      text.split(/\n/).each do |line|
-        logger.send(type, prefix + line)
-      end
-    end
-
     def prepare_commands(commands, execution_options, **options)
       commands = [commands] unless commands.is_a?(Array)
 

data/lib/sshake/error.rb

@@ -19,7 +19,7 @@ module SSHake
 
     def message
       "Failed to execute command: #{@response.command} " \
-      "(stderr: #{@response.stderr}) (exit code: #{@response.exit_code})"
+        "(stderr: #{@response.stderr}) (exit code: #{@response.exit_code})"
     end
 
   end

data/lib/sshake/klogger.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SSHake
+
+  class << self
+
+    def klogger
+      @klogger ||= Klogger.new(:ssh, destination: $stdout, formatter: :go)
+    end
+    attr_writer :klogger
+
+  end
+
+end

data/lib/sshake/mock/environment.rb

@@ -12,11 +12,11 @@ module SSHake
       attr_accessor :command, :options, :captures
 
       def store
-        @session ? @session.store : nil
+        @session&.store
       end
 
       def written_files
-        @session ? @session.written_files : nil
+        @session&.written_files
       end
 
     end

data/lib/sshake/session.rb

@@ -23,23 +23,19 @@ module SSHake
     # Create a new SSH session
     #
     # @return [Sshake::Session]
-    def initialize(host, username_or_options = {}, options_with_username = {})
+    def initialize(host, username = nil, **options)
       super
       @host = host
-      if username_or_options.is_a?(String)
-        @user = username_or_options
-        @session_options = options_with_username
-      else
-        @user = username_or_options.delete(:user)
-        @session_options = username_or_options
-      end
+      @username = username
+      @session_options = options
+      @session_options.delete(:klogger)
     end
 
     # Return the username for the connection
     #
     # @return [String]
     def user
-      @user || ENV['USER']
+      @user || ENV.fetch('USER', nil)
     end
 
     # Return the port that will be connected to
@@ -53,8 +49,7 @@ module SSHake
     #
     # @return [void]
     def connect
-      log :debug, "Creating connection to #{@host}"
-      log :debug, "Session options: #{@session_options.inspect}"
+      klogger.debug 'Connecting', id: @id, host: @host, user: @user, port: @session_options[:port] || 22
       @session = Net::SSH.start(@host, user, @session_options)
       true
     end
@@ -73,11 +68,11 @@ module SSHake
       return false if @session.nil?
 
       begin
-        log :debug, 'Closing connectiong'
+        klogger.debug 'Closing connection', id: @id, host: @host
         @session.close
-        log :debug, 'Connection closed successfully'
+        klogger.debug 'Connection closed', id: @id, host: @host
       rescue StandardError => e
-        log :debug, "Connection not closed: #{e.message} (#{e.class})"
+        logger.exception(e, 'Connection not closed')
         nil
       end
       @session = nil
@@ -86,12 +81,13 @@ module SSHake
 
     # Kill the underlying connection
     def kill!
-      log :debug, 'Attempting kill/shutdown of session'
+      klogger.debug 'Attemping to shutdown', id: @id, host: @host
       @session.shutdown!
-      log :debug, 'Session shutdown success'
+      klogger.debug 'Shutdown success', id: @id, host: @host
       @session = nil
     end
 
+    # rubocop:disable Metrics/AbcSize
     def execute(commands, options = nil, &block)
       options = create_options(options, block)
       command_to_execute = prepare_commands(commands, options)
@@ -101,83 +97,86 @@ module SSHake
       response.command = command_to_execute
       connect unless connected?
 
-      # Log the command
-      log :info, "Executing: #{command_to_execute}"
-      log :debug, "Timeout: #{options.timeout}"
+      klogger.group(id: @id, host: @host) do
+        klogger.info 'Executing command', command: command_to_execute, timeout: options.timeout
 
-      begin
-        channel = nil
-        Timeout.timeout(options.timeout) do
-          channel = @session.open_channel do |ch|
-            response.start_time = Time.now
-            channel.exec(command_to_execute) do |_, success|
-              raise "Command \"#{command_to_execute}\" was unable to execute" unless success
-
-              ch.send_data(options.stdin) if options.stdin
-
-              if options.file_to_stream.nil? && options.sudo_password.nil?
-                log :debug, 'Sending EOF to channel'
-                ch.eof!
-              end
+        begin
+          channel = nil
 
-              ch.on_data do |_, data|
-                response.stdout += data
-                options.stdout&.call(data)
-                log :debug, data.gsub(/\r/, '')
-              end
+          Timeout.timeout(options.timeout) do
+            channel = @session.open_channel do |ch|
+              response.start_time = Time.now
 
-              ch.on_extended_data do |_, _, data|
-                response.stderr += data.delete("\r")
-                options.stderr&.call(data)
-                log :debug, data
-                if options.sudo_password && data =~ /^\[sshake-sudo-password\]:\s\z/
-                  log :debug, 'Sending sudo password'
-                  ch.send_data "#{options.sudo_password}\n"
-
-                  if options.file_to_stream.nil?
-                    log :debug, 'Sending EOF after sudo password because no file'
-                    ch.eof!
-                  end
-                end
-              end
+              channel.exec(command_to_execute) do |_, success|
+                raise "Command \"#{command_to_execute}\" was unable to execute" unless success
 
-              ch.on_request('exit-status') do |_, data|
-                response.exit_code = data.read_long&.to_i
-                log :debug, "Exit code: #{response.exit_code}"
-              end
+                ch.send_data(options.stdin) if options.stdin
 
-              ch.on_request('exit-signal') do |_, data|
-                response.exit_signal = data.read_long
-              end
+                if options.file_to_stream.nil? && options.sudo_password.nil?
+                  klogger.debug 'Sending EOF to channel'
+                  ch.eof!
+                end
 
-              if options.file_to_stream
-                ch.on_process do |_, data|
-                  next if ch.eof?
+                ch.on_data do |_, data|
+                  response.stdout += data
+                  options.stdout&.call(data)
+                  klogger.debug "[stdout] #{data.gsub(/\r/, '').strip}"
+                end
+
+                ch.on_extended_data do |_, _, data|
+                  response.stderr += data.delete("\r")
+                  options.stderr&.call(data)
+                  klogger.debug "[stderr] #{data.gsub(/\r/, '').strip}"
+                  if options.sudo_password && data =~ /^\[sshake-sudo-password\]:\s\z/
+                    klogger.debug 'Sending sudo password', length: options.sudo_password.length
+                    ch.send_data "#{options.sudo_password}\n"
 
-                  if ch.output.length < 128 * 1024
-                    if data = options.file_to_stream.read(1024 * 1024)
-                      ch.send_data(data)
-                      response.bytes_streamed += data.bytesize
-                    else
+                    if options.file_to_stream.nil?
+                      klogger.debug 'Sending EOF after password'
                       ch.eof!
                     end
                   end
                 end
+
+                ch.on_request('exit-status') do |_, data|
+                  response.exit_code = data.read_long&.to_i
+                  klogger.info 'Exited', exit_code: response.exit_code
+                end
+
+                ch.on_request('exit-signal') do |_, data|
+                  response.exit_signal = data.read_long
+                end
+
+                if options.file_to_stream
+                  ch.on_process do |_, data|
+                    next if ch.eof?
+
+                    if ch.output.length < 128 * 1024
+                      if data = options.file_to_stream.read(1024 * 1024)
+                        ch.send_data(data)
+                        response.bytes_streamed += data.bytesize
+                      else
+                        ch.eof!
+                      end
+                    end
+                  end
+                end
               end
             end
+            channel.wait
           end
-          channel.wait
+        rescue Timeout::Error
+          klogger.debug 'Command timed out'
+          kill!
+          response.timeout!
+        ensure
+          response.finish_time = Time.now
         end
-      rescue Timeout::Error
-        log :debug, 'Got timeout error while executing command'
-        kill!
-        response.timeout!
-      ensure
-        response.finish_time = Time.now
       end
 
       handle_response(response, options)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def write_data(path, data, options = nil, &block)
       connect unless connected?

data/lib/sshake/version.rb

@@ -2,6 +2,6 @@
 
 module SSHake
 
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: sshake
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Cooke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: klogger-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +70,7 @@ files:
 - lib/sshake/error.rb
 - lib/sshake/execution_options.rb
 - lib/sshake/execution_options_dsl.rb
-- lib/sshake/logger.rb
+- lib/sshake/klogger.rb
 - lib/sshake/mock/command.rb
 - lib/sshake/mock/command_set.rb
 - lib/sshake/mock/environment.rb
@@ -66,8 +86,9 @@ files:
 homepage: https://github.com/adamcooke/sshake
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A wrapper for net/ssh to make running commands more fun
 test_files: []

data/lib/sshake/logger.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module SSHake
-
-  class << self
-
-    attr_accessor :logger
-
-  end
-
-end