kanrisuru 0.16.10 → 0.16.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deee19d7cfafee6dd2ab48a0400ba7b18909de35a0c6f60e9e8c17c6c9ac3eab
-  data.tar.gz: 59a153f5f7b94fedfa06baf22a7a47d70a3fce9b66a04705dce91e58f063140a
+  metadata.gz: b7e691e6227ba9b1c056be999461a641fd28a425a4d75cb02af41265b724b0af
+  data.tar.gz: a44f3470adab298c100ada9e954e775df42a38f933bf6533f6f54de096158745
 SHA512:
-  metadata.gz: 0a4413a7e8da493e0059e15fc2742c17ae19977c830a77f2c3aea9432677fcecdb7f9191f4342fbc9a4d4159f2897c873f993de9db6d4f9bee0ce349251850a9
-  data.tar.gz: f6c9c82523ddad69b3b8db6ecdc9a6032d1e85e693892516a65295905b3cc2911bd484fbaeb859d5e9fe70ae660012326d01ed6da81cf7bb50dd73608f9b3e66
+  metadata.gz: 631d251e1833edc36568eb00907850a45f39bf623e85b4bc2f45806800ce71de97f1f60e129d4f452d7696f265de1aaa9a8228a67c013edadbd3bdcee94c1f85
+  data.tar.gz: fee6dcab58110f2addc66c93394b679d6dcc5ac0b83fb619102dd3aed1556a3a4a224f34ad87cda7be79cc8e0d39fd3248e2c7340bc50b64ec5130b79ee640fe

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Kanrisuru 0.16.11 (December 28, 2021) ##
+*  Add functional and integration test cases for the `Kanrisuru::Remote::Cluster` class.
+*  Allow for passing a command instance into `execute` and `execute_shell` on a cluster instance, by deep copying a command object. 
+
 ## Kanrisuru 0.16.10 (December 28, 2021) ##
 *  Add `iname` and `iregex` params to `find` command.
 

data/lib/kanrisuru/command.rb

@@ -7,6 +7,7 @@ module Kanrisuru
 
     def initialize(command)
       @valid_exit_codes = [0]
+
       @raw_command = command
       @raw_result = []
     end

data/lib/kanrisuru/remote/cluster.rb

@@ -32,7 +32,7 @@ module Kanrisuru
       def execute(command)
         @hosts.map do |host_addr, host|
           ## Need to evaluate each host independently for the command.
-          cmd = Kanrisuru::Command.new(command)
+          cmd = create_command(command)
 
           { host: host_addr, result: host.execute(cmd) }
         end
@@ -41,7 +41,7 @@ module Kanrisuru
       def execute_shell(command)
         @hosts.map do |host_addr, host|
           ## Need to evaluate each host independently for the command.
-          cmd = Kanrisuru::Command.new(command)
+          cmd = create_command(command)
 
           { host: host_addr, result: host.execute_shell(cmd) }
         end
@@ -83,6 +83,17 @@ module Kanrisuru
 
       private
 
+      def create_command(command)
+        case command
+        when String
+          Kanrisuru::Command.new(command)
+        when Kanrisuru::Command
+          command.clone
+        else
+          raise ArgumentError, 'Invalid command type'
+        end
+      end
+
       def map_host_results(action)
         @hosts.map do |host_addr, host|
           { host: host_addr, result: host.send(action) }

data/lib/kanrisuru/version.rb

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

data/spec/functional/remote/cluster_spec.rb

@@ -40,6 +40,19 @@ RSpec.describe Kanrisuru::Remote::Cluster do
     expect(cluster[host2.host]).to eq(host2)
     expect(cluster.hosts).to include(host1)
     expect(cluster.hosts).to include(host2)
+
+    cluster << {
+      host: 'centos-host',
+      username: 'centos',
+      keys: ['id_rsa']
+    }
+
+    expect(cluster.hosts.length).to eq(3)
+    expect(cluster.count).to eq(3)
+    expect(cluster.count).to eq(3)
+    expect(cluster['centos-host'].username).to eq('centos')
+    expect(cluster.hosts).to include(host1)
+    expect(cluster.hosts).to include(host2)
   end
 
   it 'fails to add host to a cluster' do
@@ -51,6 +64,62 @@ RSpec.describe Kanrisuru::Remote::Cluster do
     expect(cluster.count).to eq(0)
   end
 
+  it 'creates a new command instance' do
+    cluster = described_class.new
+    cluster << host1
+    cluster << host2
+
+    expect(cluster.send(:create_command, 'hello')).to be_instance_of(Kanrisuru::Command)
+
+    command = Kanrisuru::Command.new('ls')
+    command.remote_user = 'root'
+    command.remote_shell = '/bin/bash'
+    cloned_command = cluster.send(:create_command, command)
+
+    expect(cloned_command).to be_instance_of(Kanrisuru::Command)
+    expect(cloned_command.object_id).not_to eq(command.object_id)
+
+    expect(command.raw_command).to eq('ls')
+    expect(cloned_command.raw_command).to eq('ls')
+
+    expect(command.prepared_command).to eq('sudo -u root /bin/bash -c "ls"')
+    expect(cloned_command.prepared_command).to eq('sudo -u root /bin/bash -c "ls"')
+
+    expect {
+      cluster.send(:create_command, 1)
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'runs execute for a command on a cluster' do
+    cluster = described_class.new
+    cluster << host1
+    cluster << host2
+
+    command = Kanrisuru::Command.new('pwd')
+
+    results = cluster.execute(command)
+    results.each do |result|
+      expect(result).to have_key(:host)
+      expect(result).to have_key(:result)
+    end
+  end
+
+  it 'runs execute_shell for a command on a cluster' do
+    cluster = described_class.new
+    cluster << host1
+    cluster << host2
+
+    command = Kanrisuru::Command.new('pwd')
+    command.remote_user = 'root'
+    command.remote_shell = '/bin/zsh'
+
+    results = cluster.execute_shell(command)
+    results.each do |result|
+      expect(result).to have_key(:host)
+      expect(result).to have_key(:result)
+    end
+  end
+
   it 'removes a host from a cluster' do
     cluster = described_class.new(host1, host2)
     expect(cluster.count).to eq(2)
@@ -63,4 +132,84 @@ RSpec.describe Kanrisuru::Remote::Cluster do
     expect(cluster.count).to eq(0)
     expect(cluster.hosts).not_to include(host1)
   end
+
+  it 'fetches the hostname for each host in a cluster' do
+    allow_any_instance_of(Kanrisuru::Remote::Host).to receive(:hostname).and_return('ubuntu')
+    cluster = described_class.new(host1, host2)
+
+    results = cluster.hostname
+    results.each do |result|
+      expect(result).to have_key(:host)
+      expect(result).to have_key(:result)
+      expect(result[:result]).to eq('ubuntu')
+    end
+  end
+
+  it 'pings the host for each host in a cluster' do
+    allow_any_instance_of(Kanrisuru::Remote::Host).to receive(:ping?).and_return(true)
+    cluster = described_class.new(host1, host2)
+
+    results = cluster.ping?
+    results.each do |result|
+      expect(result).to have_key(:host)
+      expect(result).to have_key(:result)
+      expect(result[:result]).to eq(true)
+    end
+  end
+
+  it 'switches user for each host in a cluster' do
+    cluster = described_class.new(host1, host2)
+
+    cluster.su('root')
+    cluster.each do |host|
+      expect(host.remote_user).to eq('root')
+    end
+  end
+
+  it 'changes current working directory for each host in a cluster' do
+    cluster = described_class.new(host1, host2)
+
+    StubNetwork.stub_command!(:pwd) do
+      Kanrisuru::Core::Path::FilePath.new('/etc')
+    end
+    StubNetwork.stub_command!(:realpath) do
+      Kanrisuru::Core::Path::FilePath.new('/etc')
+    end
+
+    cluster.cd('/etc')
+    cluster.each do |host|
+      expect(host.instance_variable_get(:@current_dir)).to eq('/etc') 
+    end 
+
+    StubNetwork.unstub_command!(:pwd)
+    StubNetwork.unstub_command!(:realpath)
+  end
+
+  it 'changes current working directory for each host in a cluster' do
+    cluster = described_class.new(host1, host2)
+
+    StubNetwork.stub_command!(:pwd) do
+      Kanrisuru::Core::Path::FilePath.new('/etc')
+    end
+
+    StubNetwork.stub_command!(:realpath) do
+      Kanrisuru::Core::Path::FilePath.new('/etc')
+    end
+
+    cluster.chdir('/etc')
+    cluster.each do |host|
+      expect(host.instance_variable_get(:@current_dir)).to eq('/etc') 
+    end 
+
+    StubNetwork.unstub_command!(:pwd)
+    StubNetwork.unstub_command!(:realpath)
+  end
+  
+  it 'fails to remove a host from a cluster' do
+    cluster = described_class.new(host1, host2)
+
+    expect {
+      cluster.delete(1)
+    }.to raise_error(ArgumentError)
+  end
 end

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

@@ -2,8 +2,24 @@
 
 require 'spec_helper'
 
-RSpec.shared_examples 'cluster' do |os_name, _host_json, _spec_dir|
+RSpec.shared_examples 'cluster' do |os_name, host_json, spec_dir|
   context "with #{os_name}" do
+    let(:host1) do
+      Kanrisuru::Remote::Host.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+    end
+
+    let(:host2) do
+      Kanrisuru::Remote::Host.new(
+        host: 'localhost',
+        username: 'ubuntu',
+        keys: ['~/.ssh/id_rsa']
+      )
+    end
+
     it 'gets hostname for cluster' do
       cluster = described_class.new({
                                       host: 'localhost',
@@ -41,5 +57,14 @@ RSpec.shared_examples 'cluster' do |os_name, _host_json, _spec_dir|
 
       cluster.disconnect
     end
+
+    it 'disconnects all hosts' do
+      cluster = described_class.new(host1, host2)
+      cluster.disconnect
+
+      cluster.each do |host|
+        expect(host.ssh.closed).to be_truthy
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.16.10
+  version: 0.16.11
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests