kanrisuru 0.14.0 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29120990eb0245c731d92af7b9905b1357309e157938274f87032ead18230c42
-  data.tar.gz: 03a75d2d70f1aa5f72f1c9d2039e9f4002d06ca13eb0ad8b67d7e60e41a9a2e4
+  metadata.gz: a6038052274021235b996bc9f7ade893cd10d6881c86e563f2b2d382abb16d60
+  data.tar.gz: cdec7058f5ed36cb0e1132be77c01085eed95267249f36458c6a591e02f27fbc
 SHA512:
-  metadata.gz: f3f0a9244cf44b5d722662b56afefa823f305e3f86eda08224369bd70fce5f88cdf84fad7dd9222a60d143a7b3bcc61f27ef57a9e54076b551655223d9e94a15
-  data.tar.gz: 4cfa00635d6daeeb0d4bbaa97c5a7c09ccd001b9dc53072d55ddd025086209701dbd3c3739650eb501cf22f94c3aaf471f877016cc6870add3c2b4a075c58dc2
+  metadata.gz: a3ef7552d342a0b2fd0cf85fd1bbc03752d24803052feb9639c59d0244f3340edc85f038b2d3d296e0a2d85d468d45bcdde61b79cfd8d9ca8027cc217bf2f615
+  data.tar.gz: a6a4f401e579ff750ca46b5580b259eeb8e25998c76e98612a5123daf4ecef4fbe22fb5bf3f6a19337190afae86a0c87d5319757205e99dfcc8faa2a5de11376

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## Kanrisuru 0.16.2 (December 19, 2021) ##
+*  Organize functional ip specs
+*  Log in realtime, debug output the stdout from the remote server, as opposed to waiting until after the command is done.
+*  Fix the `opensuse_leap` for the stubnetwork rspec helper.
+*  Refactor and cleanup the `append_array` method for the `Kanrisuru::Command` instance
+*  Move `gpg_opts` for `zypper` command into re-usable method
+*  Add functional test cases for `zypper` command. 
+
+## Kanrisuru 0.16.1 (December 16, 2021) ##
+*  Fix require class for `os_package`.
+
+## 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.
+*  Add functional test cases for `ip` command.
+*  Add `append_flag_no` to `Kanrisuru::Command` class. Adds no to value for `falsey` statements. The `no` flag is commonly appended to indicate a deactived state for many arguments passed to programs on the command line.
+*  Fix test case `transfer` by appending the osname to the filename to avoid parallel overwrite.
+
 ## Kanrisuru 0.14.0 (December 08, 2021) ##
 *  Add additional unit test cases for `util` methods.
 *  Refactor the `core` module commands into smaller files, with each command split up. Also refactor parsing code into separate `Parser` class.

data/README.md

@@ -7,12 +7,12 @@
     <img src="https://img.shields.io/gem/v/kanrisuru?style=flat-square" alt="Latest version" />
   </a> 
   <a href="https://github.com/avamia/kanrisuru/blob/main/LICENSE.txt">
-    <img src="https://img.shields.io/github/license/avamia/kanrisuru" alt="Latest version" />
+    <img src="https://img.shields.io/github/license/avamia/kanrisuru?style=flat-square" alt="Latest version" />
   </a> 
-  <img src="https://img.shields.io/github/repo-size/avamia/kanrisuru" alt="GitHub repo size" />
-  <img src="https://img.shields.io/codecov/c/gh/avamia/kanrisuru?token=2Q1BE106B2" alt="Codecov" /> 
-  <img src="https://img.shields.io/codacy/grade/9e839eb160bc445ea4e81b64cef22b27" alt="Codacy grade" />
-  <img src="https://img.shields.io/codeclimate/maintainability/avamia/kanrisuru" alt="Code Climate maintainability" />
+  <img src="https://img.shields.io/github/repo-size/avamia/kanrisuru?style=flat-square" alt="GitHub repo size" />
+  <img src="https://img.shields.io/codecov/c/gh/avamia/kanrisuru?token=2Q1BE106B2&style=flat-square" alt="Codecov" /> 
+  <img src="https://img.shields.io/codacy/grade/9e839eb160bc445ea4e81b64cef22b27?style=flat-square" alt="Codacy grade" />
+  <img src="https://img.shields.io/codeclimate/maintainability/avamia/kanrisuru?style=flat-square" alt="Code Climate maintainability" />
 </p>
 
 # Kanrisuru

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
@@ -84,11 +88,10 @@ module Kanrisuru
       append_value("| #{value}")
     end
 
-    def append_array(value)
+    def append_array(value, separator = ' ')
       return unless Kanrisuru::Util.present?(value)
 
-      value = [value] if value.instance_of?(String)
-      append_value(value.join(' '))
+      append_value(Kanrisuru::Util.array_join_string(value, separator))
     end
 
     def append_value(value)
@@ -103,6 +106,16 @@ module Kanrisuru
       @raw_command = Kanrisuru::Util.present?(boolean) ? "#{@raw_command} #{arg}" : @raw_command
     end
 
+    def append_flag_no(arg, boolean = 'true')
+      return if boolean.nil?
+
+      if boolean
+        append_flag(arg, true)
+      else
+        append_flag("no#{arg}", true)
+      end
+    end
+
     def append_valid_exit_code(code)
       @valid_exit_codes << code if code.instance_of?(Integer)
       @valid_exit_codes.concat(code) if code.instance_of?(Array)

data/lib/kanrisuru/core/apt/parsers/base.rb

@@ -16,7 +16,7 @@ module Kanrisuru
 
             def parse_apt_sources(string)
               url, dist, architecture, = string.split
-              Source.new(url, dist, architecture)
+              Kanrisuru::Core::Apt::Source.new(url, dist, architecture)
             end
 
             def parse_apt_line(line)

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/ip/commands/address.rb

@@ -4,58 +4,16 @@ module Kanrisuru
   module Core
     module IP
       def ip_address(action, opts)
-        command = nil
-
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-          command.append_flag('-s', opts[:stats])
-          command.append_arg('-family', opts[:family])
-          command << 'address show'
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('scope', opts[:scope])
-          command.append_arg('to', opts[:prefix])
-          command.append_arg('label', opts[:label])
-
-          command.append_flag('dynamic', opts[:dynamic])
-          command.append_flag('permanent', opts[:permanent])
-          command.append_flag('tenative', opts[:tenative])
-          command.append_flag('deprecated', opts[:deprecated])
-          command.append_flag('primary', opts[:primary])
-          command.append_flag('secondary', opts[:secondary])
-          command.append_flag('up', opts[:up])
+          version = ip_version.to_i
+          command = ip_address_show(opts, version)
         when 'add'
-          command = Kanrisuru::Command.new('ip address add')
-          command << opts[:address]
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
-          command.append_arg('scope', opts[:scope])
+          command = ip_address_add(opts)
         when 'del', 'delete'
-          command = Kanrisuru::Command.new('ip address del')
-          command << opts[:address]
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
-          command.append_arg('scope', opts[:scope])
+          command = ip_address_delete(opts)
         when 'flush'
-          command = Kanrisuru::Command.new('ip address flush')
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('scope', opts[:scope])
-          command.append_arg('to', opts[:prefix])
-          command.append_arg('label', opts[:label])
-
-          command.append_flag('dynamic', opts[:dynamic])
-          command.append_flag('permanent', opts[:permanent])
-          command.append_flag('tenative', opts[:tenative])
-          command.append_flag('deprecated', opts[:deprecated])
-          command.append_flag('primary', opts[:primary])
-          command.append_flag('secondary', opts[:secondary])
+          command = ip_address_flush(opts)
         end
 
         execute_shell(command)
@@ -64,6 +22,65 @@ module Kanrisuru
           Parser::Address.parse(cmd, action, version)
         end
       end
+
+      def ip_address_show(opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+        command.append_flag('-s', opts[:stats])
+        command.append_arg('-family', opts[:family])
+        command << 'address show'
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('scope', opts[:scope])
+        command.append_arg('to', opts[:prefix])
+        command.append_arg('label', opts[:label])
+
+        command.append_flag('dynamic', opts[:dynamic])
+        command.append_flag('permanent', opts[:permanent])
+        command.append_flag('tenative', opts[:tenative])
+        command.append_flag('deprecated', opts[:deprecated])
+        command.append_flag('primary', opts[:primary])
+        command.append_flag('secondary', opts[:secondary])
+        command.append_flag('up', opts[:up])
+        command
+      end
+
+      def ip_address_add(opts)
+        command = Kanrisuru::Command.new('ip address add')
+        command << opts[:address]
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command.append_arg('scope', opts[:scope])
+        command
+      end
+
+      def ip_address_delete(opts)
+        command = Kanrisuru::Command.new('ip address del')
+        command << opts[:address]
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command.append_arg('scope', opts[:scope])
+        command
+      end
+
+      def ip_address_flush(opts)
+        command = Kanrisuru::Command.new('ip address flush')
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('scope', opts[:scope])
+        command.append_arg('to', opts[:prefix])
+        command.append_arg('label', opts[:label])
+
+        command.append_flag('dynamic', opts[:dynamic])
+        command.append_flag('permanent', opts[:permanent])
+        command.append_flag('tenative', opts[:tenative])
+        command.append_flag('deprecated', opts[:deprecated])
+        command.append_flag('primary', opts[:primary])
+        command.append_flag('secondary', opts[:secondary])
+        command
+      end
     end
   end
 end

data/lib/kanrisuru/core/ip/commands/address_label.rb

@@ -4,27 +4,16 @@ module Kanrisuru
   module Core
     module IP
       def ip_address_label(action, opts)
-        command = nil
-
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-          command << 'addrlabel list'
+          version = ip_version.to_i
+          command = ip_address_label_show(opts, version)
         when 'flush'
-          command = Kanrisuru::Command.new('ip addrlabel flush')
+          command = ip_address_label_flush(opts)
         when 'add'
-          command = Kanrisuru::Command.new('ip addrlabel add')
-          command.append_arg('prefix', opts[:prefix])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
+          command = ip_address_label_add(opts)
         when 'del'
-          command = Kanrisuru::Command.new('ip addrlabel del')
-          command.append_arg('prefix', opts[:prefix])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
+          command = ip_address_label_delete(opts)
         end
 
         execute_shell(command)
@@ -33,6 +22,33 @@ module Kanrisuru
           Parser::AddressLabel.parse(cmd, action, version)
         end
       end
+
+      def ip_address_label_delete(opts)
+        command = Kanrisuru::Command.new('ip addrlabel del')
+        command.append_arg('prefix', opts[:prefix])
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command
+      end
+
+      def ip_address_label_add(opts)
+        command = Kanrisuru::Command.new('ip addrlabel add')
+        command.append_arg('prefix', opts[:prefix])
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command
+      end
+
+      def ip_address_label_flush(_opts)
+        Kanrisuru::Command.new('ip addrlabel flush')
+      end
+
+      def ip_address_label_show(_opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+        command << 'addrlabel list'
+        command
+      end
     end
   end
 end