spectre-ssh 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba7f13a54fa1b81b4a1421363753173b28e1d270c9285a33e1ecb08047739e21
+  data.tar.gz: a927c8e8685d729de0f3aeb663411e1bafe7f32371ec8d8fc34139495bae1f5f
+SHA512:
+  metadata.gz: 04a3a857cbccfc082535fd0e8342bcd269a978227652b0be4818a134793538bd52f491d16503f560b0f9e06aae3615a26dc4790f67a995c82091b28290368718
+  data.tar.gz: cf1340384a2d2da1bf70def699e85ab5c10f21ced75f75d766a044160c9dfb3666a700c9d92e0ee3bccaaef45ad5000ec02ca0dea7368befdbf6d20dc41a1a12

data/lib/spectre/ssh.rb

@@ -0,0 +1,149 @@
+require 'net/ssh'
+require 'logger'
+
+
+module Spectre
+  module SSH
+    @@cfg = {}
+
+    class SSHConnection < DslClass
+      def initialize host, username, opts, logger
+        opts[:non_interactive] = true
+
+        @__logger = logger
+        @__host = host
+        @__username = username
+        @__opts = opts
+        @__session = nil
+        @__exit_code = nil
+        @__output = ''
+      end
+
+      def file_exists path
+        exec "ls #{path}"
+        exit_code == 0
+      end
+
+      def owner_of path
+        exec "stat -c %U #{path}"
+        output.chomp
+      end
+
+      def connect!
+        return unless @__session == nil or @__session.closed?
+        @__session = Net::SSH.start(@__host, @__username, @__opts)
+      end
+
+      def close
+        return unless @__session and not @__session.closed?
+        @__session.close
+      end
+
+      def can_connect?
+        @__output = nil
+
+        begin
+          connect!
+          @__session.open_channel.close
+          @__output = "successfully connected to #{@__host} with user #{@__username}"
+          @__exit_code = 0
+          return true
+        rescue Exception => e
+          @__logger.error e.message
+          @__output = "unable to connect to #{@__host} with user #{@__username}"
+          @__exit_code = 1
+        end
+
+        return false
+      end
+
+      def exec command
+        connect!
+
+        log_str = "#{@__session.options[:user]}@#{@__session.host} -p #{@__session.options[:port]} #{command}"
+
+        @channel = @__session.open_channel do |channel|
+          channel.exec(command) do |ch, success|
+            abort "could not execute #{command} on #{@__session.host}" unless success
+
+            @__output = ''
+
+            channel.on_data do |ch, data|
+              @__output += data
+            end
+
+            channel.on_extended_data do |ch,type,data|
+              @__output += data
+            end
+
+            channel.on_request('exit-status') do |ch, data|
+              @__exit_code = data.read_long
+            end
+
+            # channel.on_request('exit-signal') do |ch, data|
+            #   exit_code = data.read_long
+            # end
+          end
+
+        end
+
+        @channel.wait
+        @__session.loop
+
+        log_str += "\n" + @__output
+        @__logger.info log_str
+      end
+
+      def output
+        @__output
+      end
+
+      def exit_code
+        @__exit_code
+      end
+    end
+
+
+    class << self
+      def ssh name, config = {}, &block
+        raise "SSH connection '#{name}' not configured" unless @@cfg.key?(name) or config.count > 0
+
+        cfg = @@cfg[name] || {}
+
+        host = cfg['host'] || name
+        username = config[:username] || cfg['username']
+        password = config[:password] || cfg['password']
+
+        opts = {}
+        opts[:password] = password
+        opts[:port] = config[:port] || cfg['port'] || 22
+        opts[:keys] = [cfg['key']] if cfg.key? 'key'
+        opts[:passphrase] = cfg['passphrase'] if cfg.key? 'passphrase'
+
+        opts[:auth_methods] = []
+        opts[:auth_methods].push 'publickey' if opts[:keys]
+        opts[:auth_methods].push 'password' if opts[:password]
+
+        ssh_con = SSHConnection.new(host, username, opts, @@logger)
+
+        begin
+          ssh_con.instance_eval &block
+        ensure
+          ssh_con.close
+        end
+      end
+    end
+
+    Spectre.register do |config|
+      @@logger = ::Logger.new config['log_file'], progname: 'spectre/ssh'
+
+      if config.key? 'ssh'
+        config['ssh'].each do |name, cfg|
+          @@cfg[name] = cfg
+        end
+      end
+    end
+
+    Spectre.delegate :ssh, to: self
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: spectre-ssh
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Neubauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: spectre-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Adds SSH access functionality to the spectre framework
+email:
+- me@christianneubauer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spectre/ssh.rb
+homepage: https://bitbucket.org/cneubaur/spectre-ssh
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://bitbucket.org/cneubaur/spectre-ssh
+  source_code_uri: https://bitbucket.org/cneubaur/spectre-ssh
+  changelog_uri: https://bitbucket.org/cneubaur/spectre-ssh/src/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: SSH module for spectre
+test_files: []