kanrisuru 0.12.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c96681bd051bc264f5433c668dee375c164232f3a417048789a5ae843118cebe
-  data.tar.gz: ba00a05d965d89c442e7d7c316899dd29fcfdfaa24ac44497fa7aa20eac359e3
+  metadata.gz: 7dcfedf8792427fccd9a7210d3f8dab6f95d2f1ba1b196ed90205c0d4a5b2c4f
+  data.tar.gz: 9e5d940a569f7b4c964aaf2a8869a07b4194a2aa9699dff9de780184403f65a2
 SHA512:
-  metadata.gz: b4cd7a7ff5f45ce2d498b16f4b7c65d87e961956fb7139034d908547b638fe8aa060f4dfa5c1bd6cacc05c2a250ab10f0c93126679cd2b628bf67020c17829fe
-  data.tar.gz: '01837cd7224fcb08a9497d3f60ebd00b71d62d5c47db81af976b39f4fdef87ed60e0abd07b3f6d39dacbdf089c0874dc75c8c3eebc94ce4468a3f1766f170ba2'
+  metadata.gz: 8f90832958572df546c18e49f8354b3014dea58b780a4540bbd204196be96562652ea0768283912005aa025fc97a85d39ff9d96dd0c48f104f89bb10d086fb64
+  data.tar.gz: df414f1782efeb27eef49133c3af0c13e6966489adc19115403e3d78c69b6fe07aedaca8b21f78417bdd921860d455df9dbe7735823f2cdaeb427c55576e8a4d

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 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.
+ 
+## Kanrisuru 0.13.0 (December 06, 2021) ##
+*  Add functional test cases for `Kanrisuru::Result` class.
+*  Refactor integration tests for better parallelization with the `parallel_tests` gem. This dropped overall test time from 35 minutes, to 22 minutes after first integration with 1 processor. After scaling upto 8 core machine, the run time dropped to 16 minutes, but was still sending the entire test file to a processor. By splitting up each host test into a seperate file, the run time dropped to a little over 9 minutes. There's probably a way to optimize which test gets run together, but overall a much better scenario.
+
 ## Kanrisuru 0.12.1 (December 05, 2021) ##
 *  Fix typo in spec.
 *  Cleanup bad code style.

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
@@ -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
 
@@ -103,6 +107,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/commands/autoclean.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_autoclean(_opts)
+        command = Kanrisuru::Command.new('apt-get autoclean')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/autoremove.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_autoremove(_opts)
+        command = Kanrisuru::Command.new('apt-get autoremove')
+        command.append_flag('-y')
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/clean.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_clean(_opts)
+        command = Kanrisuru::Command.new('apt-get clean')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/full_upgrade.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_full_upgrade(_opts)
+        command = Kanrisuru::Command.new('apt full-upgrade')
+        command.append_flag('-y')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/install.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_install(opts)
+        command = Kanrisuru::Command.new('apt-get install')
+        command.append_flag('-y')
+
+        command.append_flag('--no-upgrade', opts[:no_upgrade])
+        command.append_flag('--only-upgrade', opts[:only_upgrade])
+        command.append_flag('--reinstall', opts[:reinstall])
+
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/list.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_list(opts)
+        command = Kanrisuru::Command.new('apt list')
+        command.append_flag('--installed', opts[:installed])
+        command.append_flag('--upgradeable', opts[:upgradeable])
+        command.append_flag('--all-versions', opts[:all_versions])
+        command.append_arg('-a', opts[:package_name])
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::List.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/purge.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_purge(opts)
+        command = Kanrisuru::Command.new('apt-get purge')
+        command.append_flag('-y')
+
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/remove.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_remove(opts)
+        command = Kanrisuru::Command.new('apt-get remove')
+        command.append_flag('-y')
+
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/search.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_search(opts)
+        command = Kanrisuru::Command.new('apt search')
+        command << opts[:query]
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Search.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/show.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_show(opts)
+        command = Kanrisuru::Command.new('apt show')
+        command.append_flag('-a')
+
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Show.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/update.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_update(_opts)
+        command = Kanrisuru::Command.new('apt-get update')
+        command.append_flag('-y')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/commands/upgrade.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      def apt_upgrade(_opts)
+        command = Kanrisuru::Command.new('apt-get upgrade')
+        command.append_flag('-y')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'commands/autoclean'
+require_relative 'commands/autoremove'
+require_relative 'commands/clean'
+require_relative 'commands/full_upgrade'
+require_relative 'commands/install'
+require_relative 'commands/list'
+require_relative 'commands/purge'
+require_relative 'commands/remove'
+require_relative 'commands/search'
+require_relative 'commands/show'
+require_relative 'commands/update'
+require_relative 'commands/upgrade'

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/base'
+require_relative 'parsers/list'
+require_relative 'parsers/search'
+require_relative 'parsers/show'

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      module Parser
+        class Base
+          class << self
+            def extract_single_line(line)
+              line.split(': ')[1]
+            end
+
+            def parse_comma_values(string)
+              string.split(', ')
+            end
+
+            def parse_apt_sources(string)
+              url, dist, architecture, = string.split
+              Kanrisuru::Core::Apt::Source.new(url, dist, architecture)
+            end
+
+            def parse_apt_line(line)
+              values = line.split('/')
+              return if values.length < 2
+
+              package = values[0]
+
+              values = values[1].split
+              suites = values[0].split(',')
+              version = values[1]
+              architecture = values[2]
+
+              installed = false
+              upgradeable = false
+              automatic = false
+
+              if values.length > 3
+                installed = values[3].include?('installed')
+                upgradeable = values[3].include?('upgradeable')
+                automatic = values[3].include?('automatic')
+              end
+
+              Kanrisuru::Core::Apt::PackageOverview.new(package, version, suites, architecture, installed, upgradeable,
+                                                        automatic)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      module Parser
+        class List < Base
+          class << self
+            def parse(command)
+              lines = command.to_a
+              lines.shift
+
+              result = []
+              lines.each do |line|
+                item = parse_apt_line(line)
+                next unless item
+
+                result << item
+              end
+
+              result
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      module Parser
+        class Search < Base
+          class << self
+            def parse(command)
+              lines = command.to_a
+              lines.shift
+              lines.shift
+
+              result = []
+
+              lines.each do |line|
+                next unless line.include?('/')
+
+                item = parse_apt_line(line)
+                next unless item
+
+                result << item
+              end
+
+              result
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      module Parser
+        class Show < Base
+          class << self
+            def parse(command)
+              lines = command.to_a
+              rows = []
+
+              current_row = nil
+              description = ''
+
+              lines.each do |line|
+                next if line == 'WARNING: apt does not have a stable CLI interface. Use with caution in scripts.'
+                next if ['', nil, '.'].include?(line)
+
+                case line
+                when /^Package:/
+                  unless current_row.nil?
+                    current_row.description = description.strip
+                    description = ''
+                    rows << current_row
+                  end
+
+                  current_row = Kanrisuru::Core::Apt::PackageDetail.new
+                  current_row.package = extract_single_line(line)
+                when /^Version:/
+                  current_row.version = extract_single_line(line)
+                when /^Priority:/
+                  current_row.priority = extract_single_line(line)
+                when /^Section:/
+                  current_row.section = extract_single_line(line)
+                when /^Origin:/
+                  current_row.origin = extract_single_line(line)
+                when /^Maintainer:/
+                  current_row.maintainer = extract_single_line(line)
+                when /^Original-Maintainer:/
+                  current_row.original_maintainer = extract_single_line(line)
+                when /^Bugs:/
+                  current_row.bugs = extract_single_line(line)
+                when /^Installed-Size:/
+                  size = Kanrisuru::Util::Bits.normalize_size(extract_single_line(line))
+                  current_row.install_size = size
+                when /^Download-Size:/
+                  size = Kanrisuru::Util::Bits.normalize_size(extract_single_line(line))
+                  current_row.download_size = size
+                when /^Depends:/
+                  current_row.dependencies = parse_comma_values(extract_single_line(line))
+                when /^Provides:/
+                  current_row.provides = parse_comma_values(extract_single_line(line))
+                when /^Recommends:/
+                  current_row.recommends = parse_comma_values(extract_single_line(line))
+                when /^Suggests:/
+                  current_row.suggests = parse_comma_values(extract_single_line(line))
+                when /^Breaks:/
+                  current_row.breaks = parse_comma_values(extract_single_line(line))
+                when /^Conflicts:/
+                  current_row.conflicts = parse_comma_values(extract_single_line(line))
+                when /^Replaces:/
+                  current_row.replaces = parse_comma_values(extract_single_line(line))
+                when /^Homepage:/
+                  current_row.homepage = extract_single_line(line)
+                when /^Task:/
+                  current_row.task = parse_comma_values(extract_single_line(line))
+                when /^Supported:/
+                  current_row.supported = extract_single_line(line)
+                when /^APT-Sources:/
+                  current_row.apt_sources = parse_apt_sources(extract_single_line(line))
+                when /^APT-Manual-Installed:/
+                  current_row.apt_manual_installed = extract_single_line(line) == 'yes'
+                when /^Description:/
+                  current_row.summary = extract_single_line(line)
+                else
+                  description += " #{line.strip}"
+                end
+              end
+
+              current_row.description = description.strip
+              rows << current_row
+              rows
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/apt/types.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      Source = Struct.new(:url, :dist, :architecture)
+      PackageOverview = Struct.new(:package, :version, :suites, :architecture, :installed, :upgradeable, :automatic)
+      PackageDetail = Struct.new(
+        :package,
+        :version,
+        :priority,
+        :section,
+        :origin,
+        :maintainer,
+        :original_maintainer,
+        :bugs,
+        :install_size,
+        :dependencies,
+        :recommends,
+        :provides,
+        :suggests,
+        :breaks,
+        :conflicts,
+        :replaces,
+        :homepage,
+        :task,
+        :supported,
+        :download_size,
+        :apt_manual_installed,
+        :apt_sources,
+        :description,
+        :summary
+      )
+    end
+  end
+end