kanrisuru 0.16.17 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e31b687d1a4fbd77c62a502ffe4e3ec6e7c314c9e8335fc1964e8fcaca75f554
-  data.tar.gz: e36de3bb37966123d08c25aa6023be77f932705e49d005590f63a45d6a8c2d1b
+  metadata.gz: a2f4308d14c64ac5f78a9f459623671d0d91901b679570ab72466c5176c22035
+  data.tar.gz: 734a54c6d1d147bf4e2ae67be7b3569331849cf9cb2df458d15dbe3effcc9292
 SHA512:
-  metadata.gz: fb5549794cf62990bd0026c315b5c9828884b814f28ea82a7e04f944d12d2d52a77131d72b64e1d2c3d9d9c525f3bd468d020d69f0539304818f78b8b070b5ef
-  data.tar.gz: dd58f2d707f62615d4a7cc997dea5f27ca0a1678e6d60478f5548c4953685b469f61f8928c879b4965a56c51de4ec8ddb722980bd14cb9f1793355b001f60678
+  metadata.gz: bb982b8fa4cb1c313ec4111770498ee9ff2bd75676bc2a5c57da71b3ef5f3dc01a9c016848939ef92bb0b84ed990f64684d7825bc93febd4a7d5e8def44ec5a8
+  data.tar.gz: b97a3b67ef2b3be719d967adf2e3bf54ac583da368d96a95ea18d415961f46a5368768f022f160a4de3f7de6f9d2787f5c68b66e547e2c4c7ee1b931b2f3d9ec

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## Kanrisuru 0.19.1 (February 02, 2022) ##
+*  Fix `load_env` command with parsing output, use `to_a` for cleaner newline parsing.
+
+## Kanrisuru 0.19.0 (January 25, 2022) ##
+*  Add readonly version of `sysctl` command with test cases.
+
+## Kanrisuru 0.18.0 (January 23, 2022) ##
+*  Add `history` command with test cases.
+
+## Kanrisuru 0.17.0 (January 20, 2022) ##
+*  Add `nproc` command with test cases.
+
 ## Kanrisuru 0.16.17 (January 10, 2022) ##
 *  Add additional options to `wget` command.
 *  Rename some options to better reflect options from wget program.

data/lib/kanrisuru/core/mount/commands/umount.rb

@@ -16,7 +16,7 @@ module Kanrisuru
 
         command.append_flag('-l', opts[:lazy])
         command.append_flag('-f', opts[:force])
-        
+
         command.append_flag('--all-targets', opts[:all_targets])
         command.append_flag('--recursive', opts[:recursive])
 

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def history(opts = {})
+        histfile = opts[:histfile] || '~/.bash_history'
+
+        command = Kanrisuru::Command.new("HISTFILE=#{histfile}; history -r; history")
+
+        if Kanrisuru::Util.present?(opts[:delete])
+          command.append_arg('-d', Kanrisuru::Util.array_join_string(opts[:delete], ' '))
+        elsif Kanrisuru::Util.present?(opts[:clear])
+          command.append_flag('-c')
+        elsif Kanrisuru::Util.present?(opts[:n])
+          command << opts[:n]
+        end
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          return if Kanrisuru::Util.present?(opts[:delete]) || Kanrisuru::Util.present?(opts[:clear])
+
+          Parser::History.parse(cmd)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def nproc(opts = {})
+        command = Kanrisuru::Command.new('nproc')
+        command.append_flag('--all', opts[:all])
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command, &:to_i)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def sysctl(variable = nil)
+        command = Kanrisuru::Command.new('sysctl')
+
+        ## Some older versions have a bug with 255 exit code being returned
+        command.append_valid_exit_code(255)
+
+        if Kanrisuru::Util.present?(variable)
+          command << variable
+        else
+          command.append_flag('--all')
+        end
+        
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Sysctl.parse(cmd)
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@
 
 require_relative 'commands/cpu_info'
 require_relative 'commands/free'
+require_relative 'commands/history'
 require_relative 'commands/kernel_statistics'
 require_relative 'commands/kill'
 require_relative 'commands/last'
@@ -9,9 +10,11 @@ require_relative 'commands/load_average'
 require_relative 'commands/load_env'
 require_relative 'commands/lscpu'
 require_relative 'commands/lsof'
+require_relative 'commands/nproc'
 require_relative 'commands/poweroff'
 require_relative 'commands/ps'
 require_relative 'commands/reboot'
+require_relative 'commands/sysctl'
 require_relative 'commands/uptime'
 require_relative 'commands/w'
 

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'parsers/kernel_statistics'
+require_relative 'parsers/history'
 require_relative 'parsers/last'
 require_relative 'parsers/load_average'
 require_relative 'parsers/load_env'
 require_relative 'parsers/lscpu'
 require_relative 'parsers/lsof'
 require_relative 'parsers/ps'
+require_relative 'parsers/sysctl'
 require_relative 'parsers/uptime'
 require_relative 'parsers/w'

data/lib/kanrisuru/core/system/parsers/history.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      module Parser
+        class History
+          def self.parse(command)
+            lines = command.to_a
+            lines.map do |line|
+              line.split(/^\d+\s+/)[1]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/parsers/load_env.rb

@@ -6,12 +6,11 @@ module Kanrisuru
       module Parser
         class LoadEnv
           def self.parse(command)
-            string = command.to_s
+            rows = command.to_a
             hash = {}
 
-            rows = string.split("\n")
             rows.each do |row|
-              key, value = row.split('=', 2)
+              key, value = row.split('=')
               hash[key] = value
             end
 

data/lib/kanrisuru/core/system/parsers/sysctl.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+module Kanrisuru
+  module Core
+    module System
+      module Parser
+        class Sysctl 
+          class << self
+            def parse(command)
+              result = {}
+
+              lines = command.to_a
+              lines.each do |line|
+                next if line.include?("permission denied on key")
+
+                keys, value = parse_line(line)
+                next if Kanrisuru::Util.blank?(value)
+
+                hash = build_nested_hash(keys, value)
+                result = merge_recursively(result, hash)
+              end
+
+              build_struct(result)
+            end
+
+            def build_struct(hash)
+              struct = Struct.new(*hash.keys).new
+
+              hash.keys.each do |key|
+                struct[key] = hash[key].is_a?(Hash) ? build_struct(hash[key]) : hash[key]
+              end
+
+              struct
+            end
+
+            def merge_recursively(h1, h2)
+              h1.merge(h2) do |k, v1, v2|
+                if v1.is_a?(Hash) && v2.is_a?(Hash)
+                  merge_recursively(v1, v2)
+                else
+                  [v1, v2].flatten
+                end
+              end
+            end
+
+            def build_nested_hash(array, value)
+              array.reverse.inject(value) { |assigned_value, key| { key => assigned_value } }
+            end
+
+            def parse_line(line)
+              string, value = line.split(' =')
+              return if Kanrisuru::Util.blank?(value)
+
+              string = string.strip
+              value = value.strip
+
+              if Kanrisuru::Util.numeric?(value)
+                value = value.to_i
+              elsif /\t+/.match(value)
+                ## Split tab delimited strings
+                value = value.split(/\t/)
+              end
+
+              [string.split('.').map(&:to_sym), value]
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/system_spec.rb

@@ -43,6 +43,20 @@ RSpec.describe Kanrisuru::Core::System do
     end.to raise_error(ArgumentError)
   end
 
+  it 'prepares history command' do
+    expect_command(host.history, 'HISTFILE=~/.bash_history; history -r; history')
+    expect_command(host.history(histfile: '~/.history', n: 100),
+                   'HISTFILE=~/.history; history -r; history 100')
+    expect_command(host.history(clear: true),
+                   'HISTFILE=~/.bash_history; history -r; history -c')
+    expect_command(host.history(delete: 5),
+                   'HISTFILE=~/.bash_history; history -r; history -d 5')
+    expect_command(host.history(delete: [23, 30]),
+                   'HISTFILE=~/.bash_history; history -r; history -d 23 30')
+    expect_command(host.history(delete: '-7'),
+                   'HISTFILE=~/.bash_history; history -r; history -d -7')
+  end
+
   it 'prepares kernel_statistics command' do
     expect_command(host.kernel_statistics, 'cat /proc/stat')
   end
@@ -79,6 +93,11 @@ RSpec.describe Kanrisuru::Core::System do
     expect_command(host.lsof, 'lsof -F pcuftDsin')
   end
 
+  it 'prepares sysctl command' do
+    expect_command(host.sysctl, 'sysctl --all')
+    expect_command(host.sysctl('net.ipv4.conf.all'), 'sysctl net.ipv4.conf.all')
+  end
+
   it 'prepares poweroff command' do
     expect_command(host.poweroff, 'shutdown')
     expect_command(host.poweroff(cancel: true), 'shutdown -c')
@@ -124,6 +143,11 @@ RSpec.describe Kanrisuru::Core::System do
     end.to raise_error(ArgumentError)
   end
 
+  it 'prepares nproc command' do
+    expect_command(host.nproc, 'nproc')
+    expect_command(host.nproc(all: true), 'nproc --all')
+  end
+
   it 'prepares uptime command' do
     expect_command(host.uptime, 'cat /proc/uptime')
   end

data/spec/functional/core/transfer_spec.rb

@@ -127,7 +127,7 @@ RSpec.describe Kanrisuru::Core::Stat do
                    "wget --certificate ~/cert.pem --certificate-type PEM --private-key ~/key.pem --private-key-type PEM --ca-certificate ~/ca.pem --random-file ~/random --https-only #{url}")
 
     ## FTP
-    expect_command(host.wget("ftp.example.com",
+    expect_command(host.wget('ftp.example.com',
                              ftp_user: 'admin',
                              ftp_password: '12345678',
                              no_remove_listing: true,
@@ -135,15 +135,15 @@ RSpec.describe Kanrisuru::Core::Stat do
                              no_passive_ftp: true,
                              retr_symlinks: true,
                              preserve_permissions: true),
-                   "wget --ftp-user admin --ftp-password 12345678 --no-remove-listing --no-glob --no-passive-ftp --retr-symlinks --preserve-permissions ftp.example.com")
+                   'wget --ftp-user admin --ftp-password 12345678 --no-remove-listing --no-glob --no-passive-ftp --retr-symlinks --preserve-permissions ftp.example.com')
 
-    expect_command(host.wget("ftps.example.com",
+    expect_command(host.wget('ftps.example.com',
                              ftp_user: 'admin',
                              ftp_password: '12345678',
                              ftps_implicit: true,
                              no_ftps_resume_ssl: true,
                              ftps_fallback_to_ftp: true,
-                             ftps_clear_data_connection: true), "wget --ftp-user admin --ftp-password 12345678 --ftps-implicit --no-ftps-resume-ssl --ftps-clear-data-connection --ftps-fallback-to-ftp ftps.example.com")
+                             ftps_clear_data_connection: true), 'wget --ftp-user admin --ftp-password 12345678 --ftps-implicit --no-ftps-resume-ssl --ftps-clear-data-connection --ftps-fallback-to-ftp ftps.example.com')
 
     ## Recursive Retrieval
     expect_command(host.wget(url,

data/spec/support/shared_examples/integration/core/system.rb

@@ -50,6 +50,12 @@ RSpec.shared_examples 'system' do |os_name, host_json, _spec_dir|
       expect(result.days).to be >= 0
     end
 
+    it 'gets history' do
+      result = host.history
+      expect(result).to be_success
+      expect(result.data).to be_instance_of(Array)
+    end
+
     it 'kills pids' do
       command = 'sleep 100000 > /dev/null 2>&1 &'
 
@@ -94,6 +100,20 @@ RSpec.shared_examples 'system' do |os_name, host_json, _spec_dir|
       expect(result.cpus.length).to eq(host.cpu.cores)
     end
 
+    it 'gets kernel sysctl info' do
+      result = host.sysctl
+      expect(result).to be_success
+      expect(result).to respond_to :net 
+      expect(result).to respond_to :kernel
+      expect(result).to respond_to :dev
+
+      result = host.sysctl('net.ipv4.conf')
+      expect(result).to be_success
+      expect(result).to respond_to :net
+      expect(result.net).to respond_to :ipv4
+      expect(result.net.ipv4).to respond_to :conf
+    end
+
     it 'gets login details' do
       host.su('root')
 
@@ -108,6 +128,12 @@ RSpec.shared_examples 'system' do |os_name, host_json, _spec_dir|
       expect(result).to be_success
     end
 
+    it 'gets nproc count' do
+      result = host.nproc
+      expect(result).to be_success
+      expect(result.to_i).to be > 0
+    end
+
     it 'gets process details' do
       result = host.ps
 

data/spec/unit/core/system_spec.rb

@@ -25,12 +25,15 @@ RSpec.describe Kanrisuru::Core::System do
     expect(host).to respond_to(:lscpu)
     expect(host).to respond_to(:load_average)
     expect(host).to respond_to(:free)
+    expect(host).to respond_to(:history)
     expect(host).to respond_to(:ps)
     expect(host).to respond_to(:kill)
     expect(host).to respond_to(:kernel_statistics)
     expect(host).to respond_to(:kstat)
     expect(host).to respond_to(:lsof)
+    expect(host).to respond_to(:nproc)
     expect(host).to respond_to(:last)
+    expect(host).to respond_to(:sysctl)
     expect(host).to respond_to(:uptime)
     expect(host).to respond_to(:w)
     expect(host).to respond_to(:who)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.16.17
+  version: 0.19.1
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests
@@ -307,6 +307,7 @@ files:
 - lib/kanrisuru/core/system/commands.rb
 - lib/kanrisuru/core/system/commands/cpu_info.rb
 - lib/kanrisuru/core/system/commands/free.rb
+- lib/kanrisuru/core/system/commands/history.rb
 - lib/kanrisuru/core/system/commands/kernel_statistics.rb
 - lib/kanrisuru/core/system/commands/kill.rb
 - lib/kanrisuru/core/system/commands/last.rb
@@ -314,12 +315,15 @@ files:
 - lib/kanrisuru/core/system/commands/load_env.rb
 - lib/kanrisuru/core/system/commands/lscpu.rb
 - lib/kanrisuru/core/system/commands/lsof.rb
+- lib/kanrisuru/core/system/commands/nproc.rb
 - lib/kanrisuru/core/system/commands/poweroff.rb
 - lib/kanrisuru/core/system/commands/ps.rb
 - lib/kanrisuru/core/system/commands/reboot.rb
+- lib/kanrisuru/core/system/commands/sysctl.rb
 - lib/kanrisuru/core/system/commands/uptime.rb
 - lib/kanrisuru/core/system/commands/w.rb
 - lib/kanrisuru/core/system/parser.rb
+- lib/kanrisuru/core/system/parsers/history.rb
 - lib/kanrisuru/core/system/parsers/kernel_statistics.rb
 - lib/kanrisuru/core/system/parsers/last.rb
 - lib/kanrisuru/core/system/parsers/load_average.rb
@@ -327,6 +331,7 @@ files:
 - lib/kanrisuru/core/system/parsers/lscpu.rb
 - lib/kanrisuru/core/system/parsers/lsof.rb
 - lib/kanrisuru/core/system/parsers/ps.rb
+- lib/kanrisuru/core/system/parsers/sysctl.rb
 - lib/kanrisuru/core/system/parsers/uptime.rb
 - lib/kanrisuru/core/system/parsers/w.rb
 - lib/kanrisuru/core/system/types.rb
@@ -706,7 +711,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Manage remote servers over ssh with ruby.