kanrisuru 0.8.11 → 0.8.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aa4c218e69710bd9ce035eca337448c240efc8e9b3e505dc1d70c4dea3e3190
-  data.tar.gz: 488db0a56c43a223031ef657f21413aa0852f6edd2afb68b0c5f5eac97d81cd3
+  metadata.gz: 522ae1903fe51ff350abc0fafa252d1b66f970710d4bed41748be03cc25ead3d
+  data.tar.gz: 501c4b568aeed1bca4e22658291ebab44e9cb9ebb84c23f5154dc4c97e5daf08
 SHA512:
-  metadata.gz: b8c45c70ddfdfedb3dcad6698e9f1228ff1ce05aa222972f29e5979e33ef85dc7227dbe8532a50755a61342fec067fdde7303dfd4cba5048de9d44d4f6a27f65
-  data.tar.gz: d417cbc907dd714ffc2385e13f6547b5fd0f42bd5e3f5c83531ace728e355a19a12d2156f4f7cb52b51d608984fe65966f0d287e72655c4088f4b24299d3afc3
+  metadata.gz: 59fbae207747c7b7c93461a48f12cd959d8dcd2b2853619cb15624627534bca2a84fdf88c068285ef2cbb7a1ac48c74d592f784374847e3f89b35faa85de5366
+  data.tar.gz: 8981e523f2373b7eb4740e1c6b1af2318cb45ba960a92e620f368d502a5359f68402fa23c2607f449e563c451b6b5d0efce9cba8ef45ffa4252b4158bd9a09a8

data/CHANGELOG.md

@@ -1,5 +1,19 @@
+## Kanrisuru 0.8.15 (October 12, 20201)
+* Move functional specs to integration. Anything that performs an actual network request will be under the integrations test.
+* Create a `StubNetwork` to quickly monkey patch the `Kanrisuru::Remote::Host` to simulate a `Net::SSH` channel request. Will add additional functionality for different simulations later on.
+* Start with testing the `stat` command as a functional test.
+
+## Kanrisuru 0.8.14 (October 8, 20201)
+* Update `Kanrisuru::Remote::Cluster` instantiation method to use array splat instead of passing array directly.
+
+## Kanrisuru 0.8.13 (October 4, 20201)
+* Fix `wc` command. Ensure result parsing is cast to integer values.
+
+## Kanrisuru 0.8.12 (October 4, 20201)
+* Refactor `rmdir` command to only work on empty directories. 
+
 ## Kanrisuru 0.8.11 (October 1, 20201)
-* Allow `Kanrisuru::Mode` as mode option in mkdir method.
+* Allow `Kanrisuru::Mode` as mode type option in mkdir method.
 
 ## Kanrisuru 0.8.10 (August 24, 20201)
 * Fix bug with rspec test case.

data/README.md

@@ -48,7 +48,7 @@ result.path 					# => /home/ubuntu
 
 ### Cluster 
 ```ruby
-cluster = Kanrisuru::Remote::Cluster.new([{
+cluster = Kanrisuru::Remote::Cluster.new({
   host: 'host1', username: 'ubuntu', keys: ['~/.ssh/id_rsa']
 }, {
   host: 'host2', username: 'alice', keys: ['~/.ssh/id_rsa']
@@ -72,7 +72,7 @@ host.execute(command)
 command.success? #=> true
 command.to_s  #=> Linux
 
-cluster = Kanrisuru::Remote::Cluster.new([host, {host: 'host2', username: 'alice', keys: ['~/.ssh/id_rsa']}])
+cluster = Kanrisuru::Remote::Cluster.new(host, {host: 'host2', username: 'alice', keys: ['~/.ssh/id_rsa']})
 
 cluster.execute('uname') #=> {host: 'host1', result: 'Linux'}, {host: 'host2', result: 'Linux'}
 ```

data/lib/kanrisuru/core/file.rb

@@ -206,10 +206,19 @@ module Kanrisuru
         Kanrisuru::Result.new(command)
       end
 
-      def rmdir(path)
-        return false unless dir?(path)
+      def rmdir(paths, opts = {})
+        paths = [paths] if paths.instance_of?(String)
+        paths.each do |path|
+          raise ArgumentError, "Can't delete root path" if path == '/' || realpath(path).path == '/'
+        end
 
-        rm(path, force: true, recursive: true)
+        command = Kanrisuru::Command.new("rmdir #{paths.join(' ')}")
+        command.append_flag('--ignore-fail-on-non-empty', opts[:silent])
+        command.append_flag('--parents', opts[:parents])
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command)
       end
 
       def mkdir(path, opts = {})
@@ -323,7 +332,7 @@ module Kanrisuru
         execute_shell(command)
 
         Kanrisuru::Result.new(command) do |cmd|
-          items = cmd.to_a
+          items = cmd.to_s.split
           FileCount.new(items[0].to_i, items[1].to_i, items[2].to_i)
         end
       end

data/lib/kanrisuru/core/stat.rb

@@ -66,10 +66,8 @@ module Kanrisuru
       end
 
       def stat(path, opts = {})
-        follow = opts[:follow]
-
         command = Kanrisuru::Command.new('stat')
-        command.append_flag('-L', follow)
+        command.append_flag('-L', opts[:follow])
         command.append_arg('-c', '%A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z')
         command << path
 

data/lib/kanrisuru/remote/cluster.rb

@@ -6,7 +6,7 @@ module Kanrisuru
       extend OsPackage::Collection
       include Enumerable
 
-      def initialize(hosts)
+      def initialize(*hosts)
         @hosts = {}
         hosts.each do |host_opts|
           add_host(host_opts)

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/stat_spec.rb

@@ -2,97 +2,27 @@
 
 require 'spec_helper'
 
-RSpec.describe Kanrisuru::Core::Stat do
-  TestHosts.each_os do |os_name|
-    context "with #{os_name}" do
-      let(:host_json) { TestHosts.host(os_name) }
-      let(:host) do
-        Kanrisuru::Remote::Host.new(
-          host: host_json['hostname'],
-          username: host_json['username'],
-          keys: [host_json['ssh_key']]
-        )
-      end
-
-      after do
-        host.disconnect
-      end
-
-      it 'checks file type correctly' do
-        expect(host.dir?('/')).to eq(true)
-        expect(host.file?('/etc/hosts')).to eq(true)
-
-        case os_name
-        when 'sles'
-          expect(host.block_device?('/dev/xvda')).to eq(true)
-        else
-          expect(host.block_device?('/dev/vda')).to eq(true)
-        end
-
-        expect(host.char_device?('/dev/tty')).to eq(true)
-        expect(host.symlink?('/etc/mtab')).to eq(true)
-        expect(host.inode?('/proc/uptime')).to eq(true)
-      end
-
-      it 'gets file stat' do
-        result = host.stat(host_json['home'])
-
-        expect(result.mode).to be_instance_of(Kanrisuru::Mode)
-        expect(result.mode.directory?).to eq(true)
-
-        case os_name
-        when 'centos', 'rhel', 'fedora'
-          expect(result.mode.numeric).to eq('700')
-          expect(result.mode.to_i).to eq(0o700)
-
-          expect(result.mode.group.read?).to eq(false)
-          expect(result.mode.group.write?).to eq(false)
-          expect(result.mode.group.execute?).to eq(false)
-
-          expect(result.mode.other.read?).to eq(false)
-          expect(result.mode.other.write?).to eq(false)
-          expect(result.mode.other.execute?).to eq(false)
+StubNetwork.stub!
 
-          expect(result.mode.owner.read?).to eq(true)
-          expect(result.mode.owner.write?).to eq(true)
-          expect(result.mode.owner.execute?).to eq(true)
-
-          expect(result.mode.symbolic).to eq('drwx------')
-        else
-          expect(result.mode.numeric).to eq('755')
-          expect(result.mode.to_i).to eq(0o755)
-
-          expect(result.mode.group.read?).to eq(true)
-          expect(result.mode.group.write?).to eq(false)
-          expect(result.mode.group.execute?).to eq(true)
-
-          expect(result.mode.other.read?).to eq(true)
-          expect(result.mode.other.write?).to eq(false)
-          expect(result.mode.other.execute?).to eq(true)
-
-          expect(result.mode.owner.read?).to eq(true)
-          expect(result.mode.owner.write?).to eq(true)
-          expect(result.mode.owner.execute?).to eq(true)
-
-          expect(result.mode.symbolic).to eq('drwxr-xr-x')
-        end
-
-        expect(result.file_type).to eq('directory')
-
-        case os_name
-        when 'opensuse', 'sles'
-          expect(result.gid).to eq(100)
-          expect(result.group).to eq('users')
-        else
-          expect(result.gid).to eq(1000)
-          expect(result.group).to eq(host_json['username'])
-        end
+RSpec.describe Kanrisuru::Core::Stat do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu', 
+      keys: ['id_rsa']
+    )
+  end
 
-        expect(result.uid).to eq(1000)
-        expect(result.user).to eq(host_json['username'])
+  it 'prepares stat command' do
+    result = host.stat('~/file1.txt')
+    expect(result.command.raw_command).to eq(
+      'stat -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt'
+    )
 
-        expect(result.fsize).to be >= 0
-      end
-    end
+    result = host.stat('~/file2.txt', follow: true)
+    expect(result.command.raw_command).to eq(
+      'stat -L -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt'
+    )
   end
+
 end

data/spec/functional/os_package_spec.rb

@@ -111,7 +111,7 @@ RSpec.describe Kanrisuru::OsPackage do
     host = Kanrisuru::Remote::Host.new(host: '127.0.0.1', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
     host2 = Kanrisuru::Remote::Host.new(host: 'localhost', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
 
-    cluster = Kanrisuru::Remote::Cluster.new([host, host2])
+    cluster = Kanrisuru::Remote::Cluster.new(host, host2)
 
     expect(host).to respond_to(:tester)
     expect(host.tester).to eq('hello ubuntu')
@@ -125,7 +125,7 @@ RSpec.describe Kanrisuru::OsPackage do
     host = Kanrisuru::Remote::Host.new(host: '127.0.0.1', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
     host2 = Kanrisuru::Remote::Host.new(host: 'localhost', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
 
-    cluster = Kanrisuru::Remote::Cluster.new([host, host2])
+    cluster = Kanrisuru::Remote::Cluster.new(host, host2)
 
     expect(host).to respond_to(:asdf)
     expect(host.asdf).to respond_to(:tester)
@@ -151,7 +151,7 @@ RSpec.describe Kanrisuru::OsPackage do
     host2 = Kanrisuru::Remote::Host.new(host: 'centos-host', username: 'centos', keys: ['~/.ssh/id_rsa'])
     host3 = Kanrisuru::Remote::Host.new(host: 'opensuse-host', username: 'opensuse', keys: ['~/.ssh/id_rsa'])
 
-    cluster = Kanrisuru::Remote::Cluster.new([host1, host2, host3])
+    cluster = Kanrisuru::Remote::Cluster.new(host1, host2, host3)
 
     expect(host1).to respond_to(:output)
     expect(host2).to respond_to(:output)

data/spec/helper/stub_network.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class StubNetwork
+  class << self
+
+    def stub!
+      ## Stub out the execute_with_retries method to 
+      ## test functionality of host commands 
+      Kanrisuru::Remote::Host.class_eval do
+        private
+
+        def execute_with_retries(command)
+          command.handle_status(0) 
+          command.handle_data(nil)
+
+          command
+        end
+      end
+
+      Kanrisuru::Remote::Os.class_eval do
+        def initialize(host)
+          @host = host
+
+          @kernel_name       = 'Linux'
+          @kernel_version    = '#91-Ubuntu SMP Thu Jul 15 19:09:17 UTC 2021'
+          @operating_system  = 'GNU/Linux'
+          @hardware_platform = "x86_64"
+          @processor         = "x86_64"
+          @release           = "ubuntu"
+          @version           = 20.0
+        end
+      end
+
+      Kanrisuru::Result.class_eval do
+        def initialize(command, &block)
+          @command = command
+          @data = nil
+
+          @error = @command.to_a if @command.failure?
+        end
+      end
+    end 
+
+  end
+end

data/spec/{functional → integration}/core/file_spec.rb

@@ -40,8 +40,8 @@ RSpec.describe Kanrisuru::Core::File do
           keys: [host_json['ssh_key']]
         )
 
-        host.rmdir("#{host_json['home']}/.kanrisuru_spec_files")
-        host.rmdir("#{host_json['home']}/extract-tar-files") if host.dir?("#{host_json['home']}/extract-tar-files")
+        host.rm("#{host_json['home']}/.kanrisuru_spec_files", force: true, recursive: true)
+        host.rm("#{host_json['home']}/extract-tar-files", force: true, recursive: true) if host.dir?("#{host_json['home']}/extract-tar-files")
         host.disconnect
       end
 
@@ -322,16 +322,44 @@ RSpec.describe Kanrisuru::Core::File do
         expect(host.empty_file?(path)).to eq(false)
       end
 
+      it 'removes directories' do
+        result = host.mkdir("#{spec_dir}/directory/1", silent: true)
+        expect(result).to be_success
+
+        result = host.mkdir("#{spec_dir}/directory/2", silent: true)
+        expect(result).to be_success
+
+        result = host.mkdir("#{spec_dir}/directory/3", silent: true)
+        expect(result).to be_success
+
+        result = host.rmdir(["#{spec_dir}/directory/1", "#{spec_dir}/directory/2"])
+        expect(result).to be_success
+
+        ## Can't delete non empty dir
+        result = host.rmdir("#{spec_dir}/directory")
+        expect(result).to be_failure
+       
+        result = host.rmdir("#{spec_dir}/directory/3")
+        expect(result).to be_success
+      end
+
       it 'counts a file' do
         result = host.wc('/etc/hosts')
 
         expect(result.success?).to eq(true)
         expect(result).to respond_to(:lines, :words, :characters)
 
-        lines = result.lines
-        result = host.cat('/etc/hosts')
+        ## Need to remap data including newline chars to get byte size
+        data = host.cat('/etc/hosts').command.raw_result
+        doc = data.map(&:lines).flatten
+
+        lines = doc.length
+        words = doc.map(&:split).flatten
+        chars = doc.map(&:length).flatten 
 
-        expect(lines).to eq(result.to_a.length)
+        expect(result.lines).to eq(doc.length)
+        expect(result.words).to eq(words.length)
+        expect(result.characters).to eq(chars.sum)
       end
     end
   end

data/spec/integration/core/stat_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Stat do
+  TestHosts.each_os do |os_name|
+    context "with #{os_name}" do
+      let(:host_json) { TestHosts.host(os_name) }
+      let(:host) do
+        Kanrisuru::Remote::Host.new(
+          host: host_json['hostname'],
+          username: host_json['username'],
+          keys: [host_json['ssh_key']]
+        )
+      end
+
+      after do
+        host.disconnect
+      end
+
+      it 'checks file type correctly' do
+        expect(host.dir?('/')).to eq(true)
+        expect(host.file?('/etc/hosts')).to eq(true)
+
+        case os_name
+        when 'sles'
+          expect(host.block_device?('/dev/xvda')).to eq(true)
+        else
+          expect(host.block_device?('/dev/vda')).to eq(true)
+        end
+
+        expect(host.char_device?('/dev/tty')).to eq(true)
+        expect(host.symlink?('/etc/mtab')).to eq(true)
+        expect(host.inode?('/proc/uptime')).to eq(true)
+      end
+
+      it 'gets file stat' do
+        result = host.stat(host_json['home'])
+
+        expect(result.mode).to be_instance_of(Kanrisuru::Mode)
+        expect(result.mode.directory?).to eq(true)
+
+        case os_name
+        when 'centos', 'rhel', 'fedora'
+          expect(result.mode.numeric).to eq('700')
+          expect(result.mode.to_i).to eq(0o700)
+
+          expect(result.mode.group.read?).to eq(false)
+          expect(result.mode.group.write?).to eq(false)
+          expect(result.mode.group.execute?).to eq(false)
+
+          expect(result.mode.other.read?).to eq(false)
+          expect(result.mode.other.write?).to eq(false)
+          expect(result.mode.other.execute?).to eq(false)
+
+          expect(result.mode.owner.read?).to eq(true)
+          expect(result.mode.owner.write?).to eq(true)
+          expect(result.mode.owner.execute?).to eq(true)
+
+          expect(result.mode.symbolic).to eq('drwx------')
+        else
+          expect(result.mode.numeric).to eq('755')
+          expect(result.mode.to_i).to eq(0o755)
+
+          expect(result.mode.group.read?).to eq(true)
+          expect(result.mode.group.write?).to eq(false)
+          expect(result.mode.group.execute?).to eq(true)
+
+          expect(result.mode.other.read?).to eq(true)
+          expect(result.mode.other.write?).to eq(false)
+          expect(result.mode.other.execute?).to eq(true)
+
+          expect(result.mode.owner.read?).to eq(true)
+          expect(result.mode.owner.write?).to eq(true)
+          expect(result.mode.owner.execute?).to eq(true)
+
+          expect(result.mode.symbolic).to eq('drwxr-xr-x')
+        end
+
+        expect(result.file_type).to eq('directory')
+
+        case os_name
+        when 'opensuse', 'sles'
+          expect(result.gid).to eq(100)
+          expect(result.group).to eq('users')
+        else
+          expect(result.gid).to eq(1000)
+          expect(result.group).to eq(host_json['username'])
+        end
+
+        expect(result.uid).to eq(1000)
+        expect(result.user).to eq(host_json['username'])
+
+        expect(result.fsize).to be >= 0
+      end
+    end
+  end
+end

data/spec/{functional → integration}/remote/cluster_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe Kanrisuru::Remote::Cluster do
   context 'with ubuntu' do
     it 'gets hostname for cluster' do
-      cluster = described_class.new([{
+      cluster = described_class.new({
                                       host: 'localhost',
                                       username: 'ubuntu',
                                       keys: ['~/.ssh/id_rsa']
@@ -13,7 +13,7 @@ RSpec.describe Kanrisuru::Remote::Cluster do
                                       host: '127.0.0.1',
                                       username: 'ubuntu',
                                       keys: ['~/.ssh/id_rsa']
-                                    }])
+                                    })
 
       expect(cluster.hostname).to match([
                                           { host: 'localhost', result: 'ubuntu' },
@@ -24,7 +24,7 @@ RSpec.describe Kanrisuru::Remote::Cluster do
     end
 
     it 'can ping host cluster' do
-      cluster = described_class.new([{
+      cluster = described_class.new({
                                       host: 'localhost',
                                       username: 'ubuntu',
                                       keys: ['~/.ssh/id_rsa']
@@ -32,7 +32,7 @@ RSpec.describe Kanrisuru::Remote::Cluster do
                                       host: '127.0.0.1',
                                       username: 'ubuntu',
                                       keys: ['~/.ssh/id_rsa']
-                                    }])
+                                    })
 
       expect(cluster.ping?).to match([
                                        { host: 'localhost', result: true },

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ SimpleCov.start
 
 require 'kanrisuru'
 require_relative 'helper/test_hosts'
+require_relative 'helper/stub_network'
 
 Kanrisuru.logger.level = Logger::WARN
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.8.11
+  version: 0.8.15
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -173,34 +173,36 @@ files:
 - lib/kanrisuru/util/os_family.rb
 - lib/kanrisuru/util/signal.rb
 - lib/kanrisuru/version.rb
-- spec/functional/core/apt_spec.rb
-- spec/functional/core/archive_spec.rb
-- spec/functional/core/disk_spec.rb
-- spec/functional/core/dmi_spec.rb
-- spec/functional/core/file_spec.rb
-- spec/functional/core/find_spec.rb
-- spec/functional/core/group_spec.rb
-- spec/functional/core/ip_spec.rb
-- spec/functional/core/path_spec.rb
-- spec/functional/core/socket_spec.rb
 - spec/functional/core/stat_spec.rb
-- spec/functional/core/stream_spec.rb
-- spec/functional/core/system_spec.rb
-- spec/functional/core/transfer_spec.rb
-- spec/functional/core/user_spec.rb
-- spec/functional/core/yum_spec.rb
-- spec/functional/core/zypper_spec.rb
 - spec/functional/os_package_spec.rb
-- spec/functional/remote/cluster_spec.rb
-- spec/functional/remote/cpu_spec.rb
-- spec/functional/remote/env_spec.rb
-- spec/functional/remote/fstab_spec.rb
-- spec/functional/remote/host_spec.rb
-- spec/functional/remote/memory_spec.rb
-- spec/functional/remote/os_spec.rb
-- spec/functional/remote/remote_file_spec.rb
+- spec/helper/stub_network.rb
 - spec/helper/test_hosts.rb
 - spec/hosts.json
+- spec/integration/core/apt_spec.rb
+- spec/integration/core/archive_spec.rb
+- spec/integration/core/disk_spec.rb
+- spec/integration/core/dmi_spec.rb
+- spec/integration/core/file_spec.rb
+- spec/integration/core/find_spec.rb
+- spec/integration/core/group_spec.rb
+- spec/integration/core/ip_spec.rb
+- spec/integration/core/path_spec.rb
+- spec/integration/core/socket_spec.rb
+- spec/integration/core/stat_spec.rb
+- spec/integration/core/stream_spec.rb
+- spec/integration/core/system_spec.rb
+- spec/integration/core/transfer_spec.rb
+- spec/integration/core/user_spec.rb
+- spec/integration/core/yum_spec.rb
+- spec/integration/core/zypper_spec.rb
+- spec/integration/remote/cluster_spec.rb
+- spec/integration/remote/cpu_spec.rb
+- spec/integration/remote/env_spec.rb
+- spec/integration/remote/fstab_spec.rb
+- spec/integration/remote/host_spec.rb
+- spec/integration/remote/memory_spec.rb
+- spec/integration/remote/os_spec.rb
+- spec/integration/remote/remote_file_spec.rb
 - spec/spec_helper.rb
 - spec/unit/core/apt_spec.rb
 - spec/unit/core/archive_spec.rb