kanrisuru 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e77a2eee0eb08495f947f9dc3b130a7c47cd713ab2f970dcc8fd17b7b52cd8b3
-  data.tar.gz: 76d3ec684fe307aafce2f3be2c594f47a38c50f2b0bb394998c1c83c06d8a47b
+  metadata.gz: 7dcfedf8792427fccd9a7210d3f8dab6f95d2f1ba1b196ed90205c0d4a5b2c4f
+  data.tar.gz: 9e5d940a569f7b4c964aaf2a8869a07b4194a2aa9699dff9de780184403f65a2
 SHA512:
-  metadata.gz: cdd8b0d400e2557525fca889bbd3ef8b8eef67774f0143ea925fa9c5ac091acabe2986de25d0f69a7005185425cf94edcd873b19cacbe56aa823c9c64fa607b3
-  data.tar.gz: c1d802b26491e276ffbcdc3e3dd4e4272c9b48ab63a5e6b7283fb5e5f7b706ce64d5216728946aa3783f88396a0ec9a0582c045571cd78de050f42496479a392
+  metadata.gz: 8f90832958572df546c18e49f8354b3014dea58b780a4540bbd204196be96562652ea0768283912005aa025fc97a85d39ff9d96dd0c48f104f89bb10d086fb64
+  data.tar.gz: df414f1782efeb27eef49133c3af0c13e6966489adc19115403e3d78c69b6fe07aedaca8b21f78417bdd921860d455df9dbe7735823f2cdaeb427c55576e8a4d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## Kanrisuru 0.16.0 (December 14, 2021) ##
+*  Fix `append_array` for the `Kanrisuru::Command` class with negated check on Array type.
+*  Add `to_f` method for `Kanrisuru::Command` and `Kanrisuru::Result` with unit test cases.
+*  Refactor `lsblk_version` into seperate command namespace with it's own parser.
+*  Add functional test cases for several core modules.
+*  Add `return_value` option to `stub_command!` method for non-result return methods. These are few and far between, but need to be tested appropriately. 
+*  Refactor several core modules with use of `command` calls for legibility.
+*  Fix several issues with `create_user`, `update_user`, and `delete_user`.
+
 ## Kanrisuru 0.15.0 (December 13, 2021) ##
 *  Add opts for `ip` command.
 *  Refactor `ip` object commands into smaller methods. Refactor `version` for consistent use and stub ability in funcitonal test cases.

data/kanrisuru.gemspec

@@ -8,9 +8,12 @@ Gem::Specification.new do |gem|
   gem.author      = 'Ryan Mammina'
   gem.email       = 'ryan@avamia.com'
   gem.license     = 'MIT'
-  gem.summary     = 'Manage remote servers over ssh with ruby.'
-  gem.description = 'Kanrisuru helps manage remote servers with objected oriented ruby. Results come back as structured data, parsed, prepared and ready.'
   gem.homepage    = 'https://github.com/avamia/kanrisuru'
+  gem.summary     = 'Manage remote servers over ssh with ruby.'
+  gem.description = <<-EOF
+    Kanrisuru helps manage remote servers with objected oriented ruby.#{' '}
+    Results come back as structured data, parsed, prepared and ready.
+  EOF
 
   gem.required_ruby_version = '>= 2.5.0'
 
@@ -30,6 +33,7 @@ Gem::Specification.new do |gem|
 
   gem.metadata = {
     'source_code_uri' => 'https://github.com/avamia/kanrisuru/',
-    'changelog_uri' => 'https://github.com/avamia/kanrisuru/blob/main/CHANGELOG.md'
+    'changelog_uri' => 'https://github.com/avamia/kanrisuru/blob/main/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true'
   }
 end

data/lib/kanrisuru/command.rb

@@ -23,6 +23,10 @@ module Kanrisuru
       to_a.join.to_i
     end
 
+    def to_f
+      to_a.join.to_f
+    end
+
     def to_s
       to_a.join(' ')
     end
@@ -87,7 +91,7 @@ module Kanrisuru
     def append_array(value)
       return unless Kanrisuru::Util.present?(value)
 
-      value = [value] if value.instance_of?(String)
+      value = [value] unless value.instance_of?(Array)
       append_value(value.join(' '))
     end
 

data/lib/kanrisuru/core/disk/commands/lsblk.rb

@@ -10,12 +10,12 @@ module Kanrisuru
 
         command = Kanrisuru::Command.new('lsblk')
 
-        version = lsblk_version
+        version = lsblk_version.to_f
 
         ## lsblk after version 2.26 handles json parsing.
         ## TODO: parse nested children for earlier version of lsblk
-        if version >= 2.27
-          command.append_flag('--json') if version >= 2.27
+        if version >= LSBK_VERSION
+          command.append_flag('--json') if version >= LSBK_VERSION
         else
           command.append_flag('-i')
           command.append_flag('-P')
@@ -40,14 +40,9 @@ module Kanrisuru
         command = Kanrisuru::Command.new('lsblk --version')
         execute(command)
 
-        version = 0.00
-        regex = Regexp.new(/\d+(?:[,.]\d+)?/)
-
-        raise 'lsblk command not found' if command.failure?
-
-        version = command.to_s.scan(regex)[0].to_f unless regex.match(command.to_s).nil?
-
-        version
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::LsblkVersion.parse(cmd)
+        end
       end
     end
   end

data/lib/kanrisuru/core/disk/constants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Disk
+      LSBK_VERSION = 2.27
+    end
+  end
+end

data/lib/kanrisuru/core/disk/parser.rb

@@ -3,4 +3,5 @@
 require_relative 'parsers/blkid'
 require_relative 'parsers/df'
 require_relative 'parsers/du'
+require_relative 'parsers/lsblk_version'
 require_relative 'parsers/lsblk'

data/lib/kanrisuru/core/disk/parsers/lsblk_version.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Disk
+      module Parser
+        class LsblkVersion
+          def self.parse(command)
+            version = 0.00
+            regex = Regexp.new(/\d+(?:[,.]\d+)?/)
+
+            raise 'lsblk command not found' if command.failure?
+
+            version = command.to_s.scan(regex)[0].to_f unless regex.match(command.to_s).nil?
+            version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/disk.rb

@@ -2,6 +2,7 @@
 
 require 'json'
 
+require_relative 'disk/constants'
 require_relative 'disk/types'
 require_relative 'disk/parser'
 require_relative 'disk/commands'

data/lib/kanrisuru/core/dmi/commands/dmi.rb

@@ -20,7 +20,7 @@ module Kanrisuru
         return unless Kanrisuru::Util.present?(opts[:types])
 
         types = opts[:types]
-        types = [types] if types.instance_of?(String)
+        types = [types] unless types.instance_of?(Array)
 
         types.each do |type|
           type = get_dmi_type(type)

data/lib/kanrisuru/core/file/commands/chmod.rb

@@ -7,7 +7,7 @@ module Kanrisuru
         recursive = opts[:recursive]
 
         command =
-          if mode.instance_of?(String) && (mode.include?(',') || /[=+-]/.match(mode))
+          if mode.instance_of?(String) && (mode.include?(',') || /[=+-]/.match(mode)) && mode.length < 10
             Kanrisuru::Command.new("chmod #{mode} #{path}")
           elsif mode.instance_of?(Kanrisuru::Mode)
             Kanrisuru::Command.new("chmod #{mode.numeric} #{path}")

data/lib/kanrisuru/core/file/commands/copy.rb

@@ -29,9 +29,7 @@ module Kanrisuru
         if opts[:preserve].instance_of?(TrueClass)
           command.append_flag('-p')
         elsif Kanrisuru::Util.present?(opts[:preserve])
-          preserve =
-            (opts[:preserve].join(',') if opts[:preserve].instance_of?(Array))
-
+          preserve = Kanrisuru::Util.array_join_string(opts[:preserve], ',')
           command << "--preserve=#{preserve}"
         end
 

data/lib/kanrisuru/core/file/commands/mkdir.rb

@@ -8,16 +8,21 @@ module Kanrisuru
         group     = opts[:group]
         recursive = opts[:recursive]
 
-        command = Kanrisuru::Command.new("mkdir #{path}")
+        command = Kanrisuru::Command.new('mkdir')
+
+        command.append_array(path)
         command.append_flag('-p', opts[:silent])
 
         if Kanrisuru::Util.present?(opts[:mode])
           mode = opts[:mode]
-          if mode.instance_of?(Kanrisuru::Mode)
-            mode = mode.numeric
-          elsif mode.instance_of?(String) && (mode.include?(',') || /[=+-]/.match(mode))
-            mode = Kanrisuru::Mode.new(mode).numeric
-          end
+
+          mode = if mode.instance_of?(Kanrisuru::Mode)
+                   mode.numeric
+                 elsif mode.instance_of?(String) && (mode.include?(',') || /[=+-]/.match(mode))
+                   mode
+                 else
+                   Kanrisuru::Mode.new(mode).numeric
+                 end
 
           command.append_arg('-m', mode)
         end

data/lib/kanrisuru/core/file/commands/rm.rb

@@ -10,7 +10,10 @@ module Kanrisuru
           raise ArgumentError, "Can't delete root path" if path == '/' || realpath(path).path == '/'
         end
 
-        command = Kanrisuru::Command.new("rm #{paths.join(' ')} --preserve-root")
+        command = Kanrisuru::Command.new('rm')
+        command.append_array(paths)
+
+        command.append_flag('--preserve-root')
         command.append_flag('-f', opts[:force])
         command.append_flag('-r', opts[:recursive])
 

data/lib/kanrisuru/core/file/commands/touch.rb

@@ -7,7 +7,8 @@ module Kanrisuru
         date = opts[:date]
 
         paths = [paths] if paths.instance_of?(String)
-        command = Kanrisuru::Command.new("touch #{paths.join(' ')}")
+        command = Kanrisuru::Command.new('touch')
+        command.append_array(paths)
 
         command.append_flag('-a', opts[:atime])
         command.append_flag('-m', opts[:mtime])

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

@@ -11,7 +11,7 @@ module Kanrisuru
 
         command = Kanrisuru::Command.new('kill')
         command << "-#{signal}"
-        command << (pids.instance_of?(Array) ? pids.join(' ') : pids)
+        command.append_array(pids)
 
         execute_shell(command)
 

data/lib/kanrisuru/core/user/commands/create_user.rb

@@ -4,33 +4,25 @@ module Kanrisuru
   module Core
     module User
       def create_user(user, opts = {})
-        uid           = opts[:uid]
         group         = opts[:group]
         groups        = opts[:groups]
-        home          = opts[:home]
         shell         = opts[:shell] || '/bin/false'
-        createhome    = opts[:createhome]
-        system_opt    = opts[:system]
-        skeleton      = opts[:skeleton]
-        non_unique    = opts[:non_unique]
-        password      = opts[:password]
-        expires       = opts[:expires] ## YYYY-MM-DD
 
         command = Kanrisuru::Command.new("useradd #{user}")
 
-        if Kanrisuru::Util.present?(uid)
-          command.append_arg('-u', uid)
-          command.append_flag('-o', non_unique)
+        if Kanrisuru::Util.present?(opts[:uid])
+          command.append_arg('-u', opts[:uid])
+          command.append_flag('-o', opts[:non_unique])
         end
 
-        command.append_flag('-r', system_opt)
+        command.append_flag('-r', opts[:system])
         command.append_arg('-s', shell)
-        command.append_arg('-d', home)
+        command.append_arg('-d', opts[:home])
 
-        case createhome
+        case opts[:createhome]
         when true
           command.append_flag('-m')
-          command.append_arg('-k', skeleton)
+          command.append_arg('-k', opts[:skeleton])
         when false
           command.append_flag('-M')
         end
@@ -43,8 +35,8 @@ module Kanrisuru
 
         command.append_arg('-G', groups.join(',')) if Kanrisuru::Util.present?(groups)
 
-        command.append_arg('-p', password)
-        command.append_arg('-e', expires)
+        command.append_arg('-p', opts[:password])
+        command.append_arg('-e', opts[:expires]) ## YYYY-MM-DD
 
         execute_shell(command)
 

data/lib/kanrisuru/core/user/commands/delete_user.rb

@@ -6,7 +6,7 @@ module Kanrisuru
       def delete_user(user, opts = {})
         force = opts[:force]
 
-        return false unless get_uid(user)
+        return false if get_uid(user).failure?
 
         command = Kanrisuru::Command.new("userdel #{user}")
         command.append_flag('-f', force)

data/lib/kanrisuru/core/user/commands/update_user.rb

@@ -4,52 +4,43 @@ module Kanrisuru
   module Core
     module User
       def update_user(user, opts = {})
-        uid           = opts[:uid]
         group         = opts[:group]
         groups        = opts[:groups]
-        append        = opts[:append]
-        home          = opts[:home]
-        move_home     = opts[:move_home]
-        shell         = opts[:shell] || '/bin/false'
-        non_unique    = opts[:non_unique]
-        password      = opts[:password]
-        expires       = opts[:expires] ## YYYY-MM-DD
-        locked        = opts[:locked]
 
         command = Kanrisuru::Command.new("usermod #{user}")
 
-        if Kanrisuru::Util.present?(home)
-          command.append_arg('-d', home)
-          command.append_flag('-m', move_home)
+        if Kanrisuru::Util.present?(opts[:home])
+          command.append_arg('-d', opts[:home])
+          command.append_flag('-m', opts[:move_home])
         end
 
-        command.append_arg('-s', shell)
+        command.append_arg('-s', opts[:shell])
 
-        if Kanrisuru::Util.present?(uid)
-          command.append_arg('-u', uid)
-          command.append_flag('-o', non_unique)
+        if Kanrisuru::Util.present?(opts[:uid])
+          command.append_arg('-u', opts[:uid])
+          command.append_flag('-o', opts[:non_unique])
         end
 
-        command.append_arg('-g', group) if Kanrisuru::Util.present?(group) && group_exists?(group)
+        command.append_arg('-g', group) if Kanrisuru::Util.present?(group) && group?(group)
 
         if Kanrisuru::Util.present?(groups)
-          command.append_arg('-G', groups.join(','))
-          command.append_flag('-a', append)
+          command.append_arg('-G', Kanrisuru::Util.array_join_string(groups, ','))
+          command.append_flag('-a', opts[:append])
         end
 
-        case locked
+        case opts[:locked]
         when true
           command.append_flag('-L')
           command.append_arg('-e', 1)
         when false
-          command.append_arg('-U')
+          command.append_flag('-U')
           command.append_arg('-e', 99_999)
         else
           ## Ensure expires isn't added twice.
-          command.append_arg('-e', expires)
+          command.append_arg('-e', opts[:expires]) ## YYYY-MM-DD
 
           ## Can't use password with lock / unlock flag.
-          command.append_arg('-p', password)
+          command.append_arg('-p', opts[:password])
         end
 
         execute_shell(command)

data/lib/kanrisuru/result.rb

@@ -39,6 +39,21 @@ module Kanrisuru
       @data.instance_of?(Array) ? @data : [@data]
     end
 
+    def to_f
+      case @data
+      when Numeric
+        @data
+      when String
+        @data.to_f
+      when Array
+        @data.map(&:to_f)
+      when NilClass
+        nil
+      else
+        raise NoMethodError, "(undefined method `to_f' for Kanrisuru::Result)"
+      end
+    end
+
     def to_i
       case @data
       when Integer

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/archive_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe Kanrisuru::Core::Archive do
   before(:all) do
     StubNetwork.stub!
-    StubNetwork.stub_command!(:realpath) do |_args|
+    StubNetwork.stub_command!(:realpath) do
       Kanrisuru::Core::Path::FilePath.new(directory)
     end
   end

data/spec/functional/core/disk_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Disk 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 blkid command' do
+    expect_command(host.blkid, 'blkid -o export')
+    expect_command(host.blkid(device: '/dev/vda1'), 'blkid -pio export /dev/vda1')
+    expect_command(host.blkid(label: 'UEFI'), 'blkid -L UEFI')
+    expect_command(host.blkid(uuid: '26F2-56F9'), 'blkid -U 26F2-56F9')
+    expect_command(host.blkid(label: 'UEFI', uuid: '26F2-56F9'), 'blkid -L UEFI -U 26F2-56F9')
+  end
+
+  it 'prepares df command' do
+    expect_command(host.df, "df -PT | awk '{print $1, $2, $3, $5, $6, $7}'")
+    expect_command(host.df(inodes: true, path: '/dev/vda1'),
+                   "df -PT -i /dev/vda1 | awk '{print $1, $2, $3, $5, $6, $7}'")
+  end
+
+  it 'prepares du command' do
+    expect_command(host.du, "du | awk '{print \\$1, \\$2}'")
+    expect_command(host.du(summarize: true, path: '/etc'), "du -s /etc | awk '{print \\$1, \\$2}'")
+  end
+
+  context 'with json support' do
+    before(:all) do
+      StubNetwork.stub_command!(:lsblk_version) do
+        Kanrisuru::Core::Disk::LSBK_VERSION
+      end
+    end
+
+    after(:all) do
+      StubNetwork.unstub_command!(:lsblk_version)
+    end
+
+    it 'prepares lsblk command' do
+      expect_command(host.lsblk, 'lsblk --json -o NAME,FSTYPE,MAJ:MIN,MOUNTPOINT,SIZE,UUID,RO,RM,OWNER,GROUP,MODE,TYPE')
+      expect_command(host.lsblk(all: true, paths: true, nodeps: true),
+                     'lsblk --json -a -p -d -o NAME,FSTYPE,MAJ:MIN,MOUNTPOINT,SIZE,UUID,RO,RM,OWNER,GROUP,MODE,TYPE')
+    end
+  end
+
+  context 'without json support' do
+    before(:all) do
+      StubNetwork.stub_command!(:lsblk_version) do
+        Kanrisuru::Core::Disk::LSBK_VERSION - 0.1
+      end
+    end
+
+    after(:all) do
+      StubNetwork.unstub_command!(:lsblk_version)
+    end
+
+    it 'prepares lsblk command' do
+      expect_command(host.lsblk,
+                     'lsblk -i -P --noheadings -o NAME,FSTYPE,MAJ:MIN,MOUNTPOINT,SIZE,UUID,RO,RM,OWNER,GROUP,MODE,TYPE')
+      expect_command(host.lsblk(all: true, paths: true, nodeps: true),
+                     'lsblk -i -P --noheadings -a -p -d -o NAME,FSTYPE,MAJ:MIN,MOUNTPOINT,SIZE,UUID,RO,RM,OWNER,GROUP,MODE,TYPE')
+    end
+  end
+end

data/spec/functional/core/dmi_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Dmi 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 dmi command' do
+    expect_command(host.dmi, 'dmidecode')
+    expect_command(host.dmi(types: 'BIOS'), 'dmidecode --type 0')
+    expect_command(host.dmi(types: 1), 'dmidecode --type 1')
+
+    expect do
+      host.dmi(types: 'hello')
+    end.to raise_error(ArgumentError)
+
+    expect_command(host.dmi(types: [
+                              'BIOS',
+                              'System',
+                              'Baseboard',
+                              'Chassis',
+                              'Processor',
+                              'Memory Controller',
+                              'Memory Module',
+                              'Cache',
+                              'Port Connector',
+                              'System Slots',
+                              'On Board Devices',
+                              'OEM Strings',
+                              'System Configuration Options',
+                              'BIOS Language',
+                              'Group Associations',
+                              'System Event Log',
+                              'Physical Memory Array',
+                              'Memory Device',
+                              '32-bit Memory Error',
+                              'Memory Array Mapped Address',
+                              'Memory Device Mapped Address',
+                              'Built-in Pointing Device',
+                              'Portable Battery',
+                              'System Reset',
+                              'Hardware Security',
+                              'System Power Controls',
+                              'Voltage Probe',
+                              'Cooling Device',
+                              'Temperature Probe',
+                              'Electrical Current Probe',
+                              'Out-of-band Remote Access',
+                              'Boot Integrity Services',
+                              'System Boot',
+                              '64-bit Memory Error',
+                              'Management Device',
+                              'Management Device Component',
+                              'Management Device Threshold Data',
+                              'Memory Channel',
+                              'IPMI Device',
+                              'System Power Supply',
+                              'Additional Information',
+                              'Onboard Devices Extended Information',
+                              'Management Controller Host Interface',
+                              'TPM Device'
+                            ]), 'dmidecode --type 0 --type 1 --type 2 --type 3 --type 4 --type 5 --type 6 --type 7 --type 8 --type 9 --type 10 --type 11 --type 12 --type 13 --type 14 --type 15 --type 16 --type 17 --type 18 --type 19 --type 20 --type 21 --type 22 --type 23 --type 24 --type 25 --type 26 --type 27 --type 28 --type 29 --type 30 --type 31 --type 32 --type 33 --type 34 --type 35 --type 36 --type 37 --type 38 --type 39 --type 40 --type 41 --type 42 --type 43')
+  end
+end