kanrisuru 0.8.18 → 0.8.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e813c072c86f8c0b076a90d2b8136fb9bc64271df996c6c54c4e2bf6c7b5806
-  data.tar.gz: a763991aa4979eb17c1c0e123d80c2057552b2caf9be24358b39659a292e241d
+  metadata.gz: 610fa46fc1f2af6ea5b805092f9528858c586cfad6c9754b18bdad109eaa9e77
+  data.tar.gz: 210c27c89350d4b5cbbba4b5677711d2032f8d4bbbc7bac79a2c2a722f0c6caa
 SHA512:
-  metadata.gz: 52be23f3a72de4d6f9633e8b01470949035aec9be4123a87bbfc2e4a93120c463fa1470a69030ad696fbabb389ce60890b64925d129654f513a4baa392846ca8
-  data.tar.gz: 749dfdd773a1256575ab262a73f56be48ec6caaef21e8499ea9fb42d9cb2ae79e569d3f8b9581aa153d9d7031eef88d46c64a9a68900d27e00cf85e28885d45d
+  metadata.gz: cd1f29eb444fe67904563cc2f0edaf3480c068e374f75242f7d802d94588c7023549186ddce860f9ac1b79a66413435f18b57f36b3b53cfa5f688ca32689ba8f
+  data.tar.gz: 3e784e517b5fa233c97b14dee47ab7f58562ebf2b484c602bd6d59ce1853a8749d7c53268574368269be7b4a711eac02bf6ce60bed1454232bf4d6a8a18b389d

data/CHANGELOG.md

@@ -1,4 +1,24 @@
-## Kanrisuru 0.8.17 (October 16 2021)
+## Kanrisuru 0.8.22 (November 18, 2021)
+* Add functional test cases for `apt` command
+
+## Kanrisuru 0.8.21 (November 15, 2021)
+* Fix bug with `Kanrisuru::Mode` class, lookup table had incorrect value for execute only symbolic to numeric field.
+
+## Kanrisuru 0.8.20 (November 13, 2021)
+* Unstub network requests for full rspec test-suite run
+
+## Kanrisuru 0.8.19 (October 31, 2021)
+* Add functional test cases for `ss` command.
+* Enforce contraints on `family` parameter for `ss` command.
+* Deprecating `string_join_array` in favor of `array_join_string`. Both methods do the same thing, and the `array_join_string` has a better nameing interface; will be removed in the next major release.
+* Replace `string_join_array` method calls in `apt`, `transfer`, `yum`, and `zypper` with `array_join_string`. 
+
+## Kanrisuru 0.8.18 (October 19, 2021)
+* Add functional test cases for `find` commmand.
+* Add `regex_type` option for `find` command.
+* Fix bug with `size` option when using number in a string format, regex testing has been simplified on matching correctness for size with options like `100`, `+100`, `-100M` for comparitive fields.
+
+## Kanrisuru 0.8.17 (October 16, 2021)
 * Add functional test cases for `transfer` module
 * Update wget command to accept hash for `headers` opt.
 

data/lib/kanrisuru/core/apt.rb

@@ -142,7 +142,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('apt-get purge')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -153,7 +153,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('apt-get remove')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -168,7 +168,7 @@ module Kanrisuru
         command.append_flag('--only-upgrade', opts[:only_upgrade])
         command.append_flag('--reinstall', opts[:reinstall])
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -200,7 +200,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('apt show')
         command.append_flag('-a')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)

data/lib/kanrisuru/core/socket.rb

@@ -38,9 +38,14 @@ module Kanrisuru
         'LAST-ACK' => 'last-ack', 'CLOSING' => 'closing'
       }.freeze
 
+      NETWORK_FAMILIES = %w[
+        unix inet inet6 link netlink
+      ].freeze
+
       def ss(opts = {})
         state = opts[:state]
         expression = opts[:expression]
+        family = opts[:family]
 
         command = Kanrisuru::Command.new('ss')
 
@@ -53,7 +58,10 @@ module Kanrisuru
         command.append_flag('-x', opts[:unix])
         command.append_flag('-w', opts[:raw])
 
-        command.append_arg('-f', opts[:family])
+        if Kanrisuru::Util.present?(family)
+          raise ArgumentError, 'invalid family type' if !NETWORK_FAMILIES.include?(family)
+          command.append_arg('-f', family)
+        end
 
         if Kanrisuru::Util.present?(state)
           raise ArgumentError, 'invalid filter state' if !TCP_STATES.include?(state) && !OTHER_STATES.include?(state)

data/lib/kanrisuru/core/transfer.rb

@@ -87,7 +87,7 @@ module Kanrisuru
         command.append_arg('--quota', opts[:quota])
 
         if Kanrisuru::Util.present?(opts[:restrict_file_names])
-          command.append_arg('--restrict-file-names', Kanrisuru::Util.string_join_array(opts[:restrict_file_names]))
+          command.append_arg('--restrict-file-names', Kanrisuru::Util.array_join_string(opts[:restrict_file_names]))
         end
 
         case opts[:family]

data/lib/kanrisuru/core/yum.rb

@@ -78,7 +78,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum install')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -91,7 +91,7 @@ module Kanrisuru
         command.append_flag('-y')
 
         if Kanrisuru::Util.present?(opts[:repos])
-          repos = Kanrisuru::Util.string_join_array(opts[:repos], ' ')
+          repos = Kanrisuru::Util.array_join_string(opts[:repos], ' ')
           command << repos
         end
 
@@ -136,7 +136,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum remove')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         raise ArugmentError, "can't remove yum" if packages.include?('yum')
 
         command << packages
@@ -172,7 +172,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum erase')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         raise ArugmentError, "can't erase yum" if packages.include?('yum')
 
         command << packages
@@ -198,7 +198,7 @@ module Kanrisuru
       def yum_search(opts)
         command = Kanrisuru::Command.new('yum search')
         command.append_flag('all', opts[:all])
-        command << Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        command << Kanrisuru::Util.array_join_string(opts[:packages], ' ')
 
         pipe_output_newline(command)
 
@@ -228,7 +228,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum repolist')
         command.append_flag('--verbose')
 
-        command << Kanrisuru::Util.string_join_array(opts[:repos], ' ') if opts[:repos]
+        command << Kanrisuru::Util.array_join_string(opts[:repos], ' ') if opts[:repos]
 
         execute_shell(command)
 
@@ -287,7 +287,7 @@ module Kanrisuru
         command.append_flag('--quiet')
         command.append_flag('installed', opts[:installed])
 
-        command << Kanrisuru::Util.string_join_array(opts[:packages], ' ') if opts[:packages]
+        command << Kanrisuru::Util.array_join_string(opts[:packages], ' ') if opts[:packages]
 
         execute_shell(command)
 

data/lib/kanrisuru/core/zypper.rb

@@ -567,7 +567,7 @@ module Kanrisuru
         zypper_repos_opt(command, opts)
         zypper_package_type_opt(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -663,7 +663,7 @@ module Kanrisuru
         zypper_download_and_install_opts(command, opts)
         zypper_expert_opts(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -714,7 +714,7 @@ module Kanrisuru
         zypper_package_type_opt(command, opts)
         zypper_solver_opts(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -783,7 +783,7 @@ module Kanrisuru
         zypper_repos_opt(command, opts)
         zypper_package_type_opt(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)

data/lib/kanrisuru/mode.rb

@@ -247,7 +247,7 @@ module Kanrisuru
     def symbolic_to_numeric(ref)
       conversions = {
         '---' => 0,
-        '---x' => 1,
+        '--x' => 1,
         '-w-' => 2,
         '-wx' => 3,
         'r--' => 4,

data/lib/kanrisuru/util.rb

@@ -21,6 +21,10 @@ module Kanrisuru
     end
 
     def self.string_join_array(arg, field = ',')
+      Kanrisuru.logger.info do
+        'DEPRECATION WARNING: string_join_array will be removed in the upcoming major release. Use array_join_string instead.'
+      end
+      
       array = arg.instance_of?(String) ? [arg] : arg
       array.join(field)
     end

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/apt_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Apt do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares apt list command' do
+    expect_command(host.apt('list'), 'apt list')
+    expect_command(host.apt('list',
+      installed: true,
+      upgradeable: true,
+      all_versions: true,
+    ), 'apt list --installed --upgradeable --all-versions')
+
+    expect_command(host.apt('list', package_name: 'nginx'), 'apt list -a nginx')
+  end
+
+  it 'prepares apt update command' do
+    expect_command(host.apt('update'), 'apt-get update -y')
+  end
+
+  it 'prepares apt upgrade command' do
+    expect_command(host.apt('upgrade'), 'apt-get upgrade -y')
+  end
+
+  it 'prepares apt full-upgrade command' do
+    expect_command(host.apt('full-upgrade'), 'apt full-upgrade -y')
+  end
+
+  it 'prepares apt install command' do
+    expect_command(host.apt('install', 
+        packages: 'nginx'
+      ),
+      'apt-get install -y nginx'
+    )
+
+    expect_command(host.apt('install', 
+        packages: 'monit',
+        no_upgrade: true,
+        reinstall: true
+      ),
+      'apt-get install -y --no-upgrade --reinstall monit'
+    )
+
+    expect_command(host.apt('install', 
+        packages: ['build-essential', 'manpages-dev'],
+        only_upgrade: true,
+      ),
+      'apt-get install -y --only-upgrade build-essential manpages-dev'
+    )
+  end
+  
+  it 'prepares apt remove command' do
+    expect_command(host.apt('remove', packages: ['python']), 'apt-get remove -y python')
+  end
+
+  it 'prepares apt purge command' do
+    expect_command(host.apt('purge', packages: ['python']), 'apt-get purge -y python')
+  end
+
+  it 'prepares apt autoremove command' do
+    expect_command(host.apt('autoremove'), 'apt-get autoremove -y')
+  end
+
+  it 'prepares apt search command' do
+    expect_command(host.apt('search', query: 'ruby'), 'apt search ruby')
+  end
+
+  it 'prepares apt show command' do
+    expect_command(host.apt('show', packages: 'ruby'), 'apt show -a ruby') 
+  end 
+
+  it 'prepares apt clean command' do
+    expect_command(host.apt('clean'), 'apt-get clean') 
+  end
+
+  it 'prepares apt autoclean command' do
+    expect_command(host.apt('autoclean'), 'apt-get autoclean') 
+  end
+
+end

data/spec/functional/core/find_spec.rb

@@ -2,9 +2,15 @@
 
 require 'spec_helper'
 
-StubNetwork.stub!
-
 RSpec.describe Kanrisuru::Core::Find do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',

data/spec/functional/core/path_spec.rb

@@ -2,9 +2,15 @@
 
 require 'spec_helper'
 
-StubNetwork.stub!
-
 RSpec.describe Kanrisuru::Core::Path do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',

data/spec/functional/core/socket_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Socket do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares ss command' do
+    expect_command(host.ss, 'ss -a -m')
+
+    expect_command(host.ss(
+        numeric: true,
+        tcp: true,
+        udp: true,
+        unix: true,
+        raw: true
+      ),
+      'ss -a -m -n -t -u -x -w'
+    )
+
+    expect_command(host.ss(
+        family: 'inet'
+      ),
+      'ss -a -m -f inet'
+    )
+
+    expect {
+      host.ss(family: 'inet5')
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.ss(
+        state: 'established'
+      ),
+      'ss -a -m state established'
+    )
+
+    expect_command(host.ss(
+        state: 'connected'
+      ),
+      'ss -a -m state connected'
+    )
+
+    expect {
+      host.ss(state: 'test')
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.ss(
+        expression: "'( dport = :ssh or sport = :ssh )'"
+      ),
+      "ss -a -m '( dport = :ssh or sport = :ssh )'"
+    )
+  end
+end

data/spec/functional/core/stat_spec.rb

@@ -2,9 +2,15 @@
 
 require 'spec_helper'
 
-StubNetwork.stub!
-
 RSpec.describe Kanrisuru::Core::Stat do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',

data/spec/functional/core/stream_spec.rb

@@ -2,9 +2,15 @@
 
 require 'spec_helper'
 
-StubNetwork.stub!
-
 RSpec.describe Kanrisuru::Core::Stream do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',

data/spec/functional/core/transfer_spec.rb

@@ -2,9 +2,15 @@
 
 require 'spec_helper'
 
-StubNetwork.stub!
-
 RSpec.describe Kanrisuru::Core::Stat do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',

data/spec/helper/expect_helpers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 def expect_command(result, string)
-  puts result.command.raw_command
+  # puts result.command.raw_command
   expect(result.command.raw_command).to eq(
     string
   )

data/spec/helper/stub_network.rb

@@ -3,41 +3,61 @@
 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)
+      unless Kanrisuru::Remote::Host.instance_methods(false).include?(:execute_with_retries_alias)
+        Kanrisuru::Remote::Host.class_eval do
+          alias_method :execute_with_retries_alias, :execute_with_retries
+          def execute_with_retries(command)
+            command.handle_status(0)
+            command.handle_data(nil)
 
-          command
+            command
+          end
         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
+      unless Kanrisuru::Remote::Os.instance_methods(false).include?(:initialize_alias)
+        Kanrisuru::Remote::Os.class_eval do
+          alias_method :initialize_alias, :initialize 
+          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
       end
 
-      Kanrisuru::Result.class_eval do
-        def initialize(command)
-          @command = command
-          @data = nil
+      unless Kanrisuru::Result.instance_methods(false).include?(:initialize_alias)
+        Kanrisuru::Result.class_eval do
+          alias_method :initialize_alias, :initialize 
+          def initialize(command)
+            @command = command
+            @data = nil
 
-          @error = @command.to_a if @command.failure?
+            @error = @command.to_a if @command.failure?
+          end
         end
       end
     end
+
+    def unstub!
+      Kanrisuru::Remote::Host.class_eval do
+        alias_method :execute_with_retries, :execute_with_retries_alias
+      end
+
+      Kanrisuru::Remote::Os.class_eval do
+        alias_method :initialize, :initialize_alias 
+      end
+
+      Kanrisuru::Result.class_eval do
+        alias_method :initialize, :initialize_alias 
+      end
+    end
+
   end
 end

data/spec/unit/core/socket_spec.rb

@@ -20,6 +20,11 @@ RSpec.describe Kanrisuru::Core::Socket do
         closed close-wait last-ack listening closing
       ]
     )
+    expect(Kanrisuru::Core::Socket::NETWORK_FAMILIES).to eq(
+      %w[
+        unix inet inet6 link netlink
+      ]
+    )
     expect(Kanrisuru::Core::Socket::OTHER_STATES).to eq(
       %w[
         all connected synchronized bucket syn-recv

data/spec/unit/mode_spec.rb

@@ -79,6 +79,31 @@ RSpec.describe Kanrisuru::Mode do
     expect(mode.other.all?).to eq(true)
     expect(mode.other.to_i).to eq(7)
     expect(mode.other.symbolic).to eq('rwx')
+
+    mode = described_class.new("---x--x--x")
+    expect(mode.directory?).to eq(false)
+    expect(mode.numeric).to eq("111")
+
+    expect(mode.owner.read?).to eq(false)
+    expect(mode.owner.write?).to eq(false)
+    expect(mode.owner.execute?).to eq(true)
+    expect(mode.owner.all?).to eq(false)
+    expect(mode.owner.to_i).to eq(1)
+    expect(mode.owner.symbolic).to eq('--x')
+
+    expect(mode.group.read?).to eq(false)
+    expect(mode.group.write?).to eq(false)
+    expect(mode.group.execute?).to eq(true)
+    expect(mode.group.all?).to eq(false)
+    expect(mode.group.to_i).to eq(1)
+    expect(mode.group.symbolic).to eq('--x')
+
+    expect(mode.other.read?).to eq(false)
+    expect(mode.other.write?).to eq(false)
+    expect(mode.other.execute?).to eq(true)
+    expect(mode.other.all?).to eq(false)
+    expect(mode.other.to_i).to eq(1)
+    expect(mode.other.symbolic).to eq('--x')
   end
 
   it 'changes mode numerically globally' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.8.18
+  version: 0.8.22
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -173,8 +173,10 @@ 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/find_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/transfer_spec.rb