kanrisuru 0.19.4 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef72387ee3392fab30d54254e7226e066d943757b686bd1e66fea0fc1bd58181
-  data.tar.gz: eb829fe3e5d90968c17cfa9922161505f4fbdce4a44da5524f35ad23967c7335
+  metadata.gz: 767ab1b59818ddd394ef7f4bb96435e5be43d2bf89c2c4469419f20a8a5f4a0c
+  data.tar.gz: 4c370eb4c60270ed707a78606976b391d098c1298de026558c80a543e28d8326
 SHA512:
-  metadata.gz: 9e6b315320713f79f5693b6a21269dcadbf6327efae5ab8dc4287165ebfd6f0c05cc221cb351911f669f71b1812ac3a43884ed978ef64422f07a3beab835ec4a
-  data.tar.gz: 21e425b548076e932aa9770f4a0827e3252b6dba3869e90d219bbf3e70d983fadb87f14b7ed1747f3c4c569c109901e4da708211816573c963c96bd3977bee24
+  metadata.gz: 8cacf38cbfc427dfe1c3a1980a8c52e3c004f119b13473380f0eaeeb0eba39c5c495bed0a2a2be37add8b8d148505f6a34ff7f0455b6a6c4c6b71f2e80849c75
+  data.tar.gz: fbf05703912544955455f75af13ce799e0a039ee7269e7106bb3e2db9e1882cc2b2d90ee535c85e3bd0f259bffe4cfc4684ef49f97bf76884eaa61e1b8d3bc72

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Kanrisuru 0.20.0 (February 21, 2022) ##
+*  Allow hosts to be connected via proxy host. This is much like using a bastion / jump server. 
+*  Add integration test cases for proxy host connection. 
+
 ## Kanrisuru 0.19.4 (February 19, 2022) ##
 *  Add additional family types to `ss` command.
 

data/kanrisuru.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'net-ping', '~> 2.0'
   gem.add_runtime_dependency 'net-scp', '~> 3.0'
   gem.add_runtime_dependency 'net-ssh', '~> 6.1'
+  gem.add_runtime_dependency 'net-ssh-gateway', '~> 2.0'
 
   gem.files         = `git ls-files`.split("\n")
   gem.require_paths = ['lib']

data/lib/kanrisuru/core/system/commands/sysctl.rb

@@ -14,7 +14,7 @@ module Kanrisuru
         else
           command.append_flag('--all')
         end
-        
+
         execute_shell(command)
 
         Kanrisuru::Result.new(command) do |cmd|

data/lib/kanrisuru/core/system/parsers/sysctl.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
+
 require 'ostruct'
 
 module Kanrisuru
   module Core
     module System
       module Parser
-        class Sysctl 
+        class Sysctl
           class << self
             def parse(command)
               result = {}
 
               lines = command.to_a
               lines.each do |line|
-                next if line.include?("permission denied on key")
+                next if line.include?('permission denied on key')
 
                 keys, value = parse_line(line)
                 next if Kanrisuru::Util.blank?(value)
@@ -27,7 +28,7 @@ module Kanrisuru
             def build_struct(hash)
               struct = Struct.new(*hash.keys).new
 
-              hash.keys.each do |key|
+              hash.each_key do |key|
                 struct[key] = hash[key].is_a?(Hash) ? build_struct(hash[key]) : hash[key]
               end
 
@@ -35,7 +36,7 @@ module Kanrisuru
             end
 
             def merge_recursively(h1, h2)
-              h1.merge(h2) do |k, v1, v2|
+              h1.merge(h2) do |_k, v1, v2|
                 if v1.is_a?(Hash) && v2.is_a?(Hash)
                   merge_recursively(v1, v2)
                 else
@@ -64,7 +65,6 @@ module Kanrisuru
 
               [string.split('.').map(&:to_sym), value]
             end
-
           end
         end
       end

data/lib/kanrisuru/remote/cluster.rb

@@ -60,9 +60,7 @@ module Kanrisuru
       end
 
       def su(user)
-        @hosts.each do |_host_addr, host|
-          host.su(user)
-        end
+        @hosts.each { |_, host| host.su(user) }
       end
 
       def chdir(path = '~')
@@ -70,15 +68,11 @@ module Kanrisuru
       end
 
       def cd(path = '~')
-        @hosts.each do |_host_addr, host|
-          host.cd(path)
-        end
+        @hosts.each { |_, host| host.cd(path) }
       end
 
       def disconnect
-        @hosts.each do |_host_addr, host|
-          host.disconnect
-        end
+        @hosts.each { |_, host| host.disconnect }
       end
 
       private

data/lib/kanrisuru/remote/host.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'net/ssh'
+require 'net/ssh/gateway'
 require 'net/scp'
 require 'net/ping'
 
@@ -12,6 +13,8 @@ module Kanrisuru
       attr_reader :host, :username, :password, :port, :keys
 
       def initialize(opts = {})
+        @opts = opts
+
         @host = opts[:host]
         @username = opts[:username]
         @login_user = @username
@@ -84,7 +87,11 @@ module Kanrisuru
       end
 
       def ssh
-        @ssh ||= Net::SSH.start(@host, @username, keys: @keys, password: @password, port: @port)
+        @ssh ||= init_ssh
+      end
+
+      def proxy
+        @proxy ||= init_proxy
       end
 
       def ping?
@@ -110,6 +117,7 @@ module Kanrisuru
 
       def disconnect
         ssh.close
+        proxy&.close(ssh.transport.port)
       end
 
       private
@@ -158,6 +166,35 @@ module Kanrisuru
         end
       end
 
+      def init_ssh
+        if proxy&.active?
+          proxy.ssh(@host, @username,
+                    keys: @keys, password: @password, port: @port)
+        else
+          Net::SSH.start(@host, @username,
+                         keys: @keys, password: @password, port: @port)
+        end
+      end
+
+      def init_proxy
+        return unless @opts[:proxy]
+
+        proxy = @opts[:proxy]
+
+        case proxy
+        when Hash
+          Net::SSH::Gateway.new(proxy[:host], proxy[:username],
+                                keys: proxy[:keys], password: proxy[:password], port: proxy[:port])
+        when Kanrisuru::Remote::Host
+          Net::SSH::Gateway.new(proxy.host, proxy.username,
+                                keys: proxy.keys, password: proxy.password, port: proxy.port)
+        when Net::SSH::Gateway
+          proxy
+        else
+          raise ArgumentError, 'Invalid proxy type'
+        end
+      end
+
       def init_hostname
         command = Kanrisuru::Command.new('hostname')
         execute(command)

data/lib/kanrisuru/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanrisuru
-  VERSION = '0.19.4'
+  VERSION = '0.20.0'
 end

data/spec/helper/hosts.json

@@ -8,6 +8,15 @@
 		"kernel": "Linux",
 		"home": "/home/ubuntu"
 	},
+  {
+    "name": "proxy",
+    "port": 22,
+    "username": "ubuntu",
+    "ssh_key": "~/.ssh/id_rsa",
+    "hostname": "proxy-host",
+    "kernel": "Linux",
+    "home": "/home/ubuntu"
+  },
 	{
 		"name": "ubuntu",
 		"port": 22,

data/spec/helper/test_hosts.rb

@@ -20,6 +20,11 @@ class TestHosts
       hosts(name)
     end
 
+    def resolve(hostname)
+      s = Socket.getaddrinfo(hostname, nil)
+      s[0][2]
+    end
+
     def spec_dir(host_json)
       random_string = SecureRandom.hex
       "#{host_json['home']}/.kanrisuru_spec_files_#{random_string[0..5]}"

data/spec/support/shared_examples/integration/core/system.rb

@@ -103,7 +103,7 @@ RSpec.shared_examples 'system' do |os_name, host_json, _spec_dir|
     it 'gets kernel sysctl info' do
       result = host.sysctl
       expect(result).to be_success
-      expect(result).to respond_to :net 
+      expect(result).to respond_to :net
       expect(result).to respond_to :kernel
       expect(result).to respond_to :dev
 

data/spec/support/shared_examples/integration/remote/host.rb

@@ -24,6 +24,47 @@ RSpec.shared_examples 'host' do |os_name, host_json, _spec_dir|
       expect(host.hostname).to eq(host_json['hostname'])
     end
 
+    it 'connects with proxy host' do
+      config = TestHosts.host('proxy')
+      proxy = Kanrisuru::Remote::Host.new(
+        host: config['hostname'],
+        username: config['username'],
+        keys: [config['ssh_key']]
+      )
+
+      expect(proxy).to be_ping
+
+      host = Kanrisuru::Remote::Host.new(
+        host: TestHosts.resolve(host_json['hostname']),
+        username: host_json['username'],
+        keys: [host_json['ssh_key']],
+        proxy: proxy
+      )
+
+      ## Test instiation
+      expect(host.proxy).to be_instance_of(Net::SSH::Gateway)
+      expect(host.ssh).to be_instance_of(Net::SSH::Connection::Session)
+
+      ## Test basic commands
+      expect(host.hostname).to eq(host_json['hostname'])
+
+      host.cd('../')
+      expect(host.pwd.path).to eq('/home')
+
+      expect(host.whoami.user).to eq(host_json['username'])
+      host.su 'root'
+      expect(host.whoami.user).to eq('root')
+
+      ## Test download
+      src_path = '/etc/hosts'
+      result = host.download(src_path)
+      expect(result).to be_instance_of(String)
+      lines = result.split("\n")
+      expect(lines.length).to be >= 1
+
+      ## Test upload
+    end
+
     it 'changes directories' do
       expect(host.pwd.path).to eq(host_json['home'])
 

data/spec/unit/remote/host_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+RSpec.describe Kanrisuru::Remote::Host do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    described_class.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'responds to methods' do
+    expect(host).to respond_to(:remote_user)
+    expect(host).to respond_to(:hostname)
+    expect(host).to respond_to(:os)
+    expect(host).to respond_to(:env)
+    expect(host).to respond_to(:template)
+    expect(host).to respond_to(:fstab)
+    expect(host).to respond_to(:chdir)
+    expect(host).to respond_to(:cd)
+    expect(host).to respond_to(:cpu)
+    expect(host).to respond_to(:memory)
+    expect(host).to respond_to(:su)
+    expect(host).to respond_to(:file)
+    expect(host).to respond_to(:ssh)
+    expect(host).to respond_to(:proxy)
+    expect(host).to respond_to(:ping?)
+    expect(host).to respond_to(:execute)
+    expect(host).to respond_to(:execute_shell)
+    expect(host).to respond_to(:disconnect)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.19.4
+  version: 0.20.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-19 00:00:00.000000000 Z
+date: 2022-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: "    Kanrisuru helps manage remote servers with objected oriented ruby.
   \n    Results come back as structured data, parsed, prepared and ready.\n"
 email: ryan@avamia.com
@@ -687,6 +701,7 @@ files:
 - spec/unit/remote/cpu_spec.rb
 - spec/unit/remote/env_spec.rb
 - spec/unit/remote/fstab_spec.rb
+- spec/unit/remote/host_spec.rb
 - spec/unit/template_spec.rb
 - spec/unit/util_spec.rb
 homepage: https://kanrisuru.com