kanrisuru 0.16.16 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72c91f337408d0a7dee545cabeb07ba9fac668baf8d3c3dbb65d0e04a27e347
-  data.tar.gz: 28d8387d8081783dfd32031c202ffc5ec66e4a7fea3306e8cb35d117f2193c10
+  metadata.gz: 80ead7b757f8228b63f2908df9163f726e99ec27dcd2b88f7a5ff197e98f8008
+  data.tar.gz: 8393af4b3e03f583981b06eaa384b47527882870289df125d4887f98abb293b2
 SHA512:
-  metadata.gz: 8a0d66db59619c3cb9e69567ef0ed08e564c53ca3171dccc7acd31410288dfa06ebfc5a5daa2ff09aa14cbbacf433175352928b8a6e837f2ba43217de5fb70ac
-  data.tar.gz: 8bfc4a39d3bb5ab4c9f180dd4e5682057a7c1fe5c5bd93e25a6d88280a6e12c79831e0c5d9cb05b2b3211b91e3c6161d585fcc20c2d851da100037393dd17752
+  metadata.gz: 2268c08d84aa9cf09232900c7d2ccd489cb9de12aa77c3fdc9666eb8859d41b072a932d0afb0d6ed2818978e641dee1569ddeda30f417466f7bd1a8150206cb9
+  data.tar.gz: e4ef880302b200deafb4c69e703cfb79fc4162d20d6b6269a635e0277f790c4c872299513cab53edeb395f20e15660fda09ba7d0c135b8ebf97d67b7464e1859

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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.
+
 ## Kanrisuru 0.16.16 (January 08, 2022) ##
 *  Fix issue with `download` command when downloading directories from remote server.
 

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/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/core/transfer/commands/wget.rb

@@ -105,7 +105,12 @@ module Kanrisuru
         end
 
         command.append_arg('--post-file', opts[:post_file])
+        command.append_arg('--method', opts[:method])
+
         command.append_flag('--content-disposition', opts[:content_disposition])
+        command.append_flag('--content-on-error', opts[:content_on_error])
+        command.append_flag('--trust-server-names', opts[:trust_server_names])
+        command.append_flag('--retry-on-host-error', opts[:retry_on_host_error])
 
         ## SSL / TLS
         if Kanrisuru::Util.present?(opts[:secure_protocol])
@@ -123,18 +128,24 @@ module Kanrisuru
         command.append_arg('--ca-directory', opts[:ca_directory])
         command.append_arg('--random-file', opts[:random_file])
         command.append_arg('--egd-file', opts[:egd_file])
+        command.append_flag('--https-only', opts[:https_only])
 
-        ## FTP
+        ## FTP / FTPS
         command.append_arg('--ftp-user', opts[:ftp_user])
         command.append_arg('--ftp-password', opts[:ftp_password])
         command.append_flag('--no-remove-listing', opts[:no_remove_listing])
         command.append_flag('--no-glob', opts[:no_glob])
         command.append_flag('--no-passive-ftp', opts[:no_passive_ftp])
         command.append_flag('--retr-symlinks', opts[:retr_symlinks])
+        command.append_flag('--preserve-permissions', opts[:preserve_permissions])
+        command.append_flag('--ftps-implicit', opts[:ftps_implicit])
+        command.append_flag('--no-ftps-resume-ssl', opts[:no_ftps_resume_ssl])
+        command.append_flag('--ftps-clear-data-connection', opts[:ftps_clear_data_connection])
+        command.append_flag('--ftps-fallback-to-ftp', opts[:ftps_fallback_to_ftp])
 
         ## Recursive Retrieval
         command.append_flag('--recursive', opts[:recursive])
-        command.append_arg('--level', opts[:depth])
+        command.append_arg('--level', opts[:level])
         command.append_flag('--delete-after', opts[:delete_after])
         command.append_flag('--convert-links', opts[:convert_links])
         command.append_flag('--backup-converted', opts[:backup_converted])
@@ -143,10 +154,13 @@ module Kanrisuru
         command.append_flag('--strict-comments', opts[:strict_comments])
 
         ## Recursive Accept/Reject
-        command.append_arg('--accept', Kanrisuru::Util.array_join_string(opts[:accept_list]))
-        command.append_arg('--reject', Kanrisuru::Util.array_join_string(opts[:reject_list]))
-        command.append_arg('--domains', Kanrisuru::Util.array_join_string(opts[:domain_list]))
-        command.append_arg('--exclude-domains', Kanrisuru::Util.array_join_string(opts[:exclude_domain_list]))
+        command.append_arg('--accept', Kanrisuru::Util.array_join_string(opts[:accept]))
+        command.append_arg('--reject', Kanrisuru::Util.array_join_string(opts[:reject]))
+        command.append_arg('--accept-regex', opts[:accept_regex])
+        command.append_arg('--reject-regex', opts[:reject_regex])
+        command.append_arg('--regex_type', opts[:regex_type])
+        command.append_arg('--domains', Kanrisuru::Util.array_join_string(opts[:domains]))
+        command.append_arg('--exclude-domains', Kanrisuru::Util.array_join_string(opts[:exclude_domains]))
         command.append_arg('--follow-tags', Kanrisuru::Util.array_join_string(opts[:follow_tags]))
         command.append_arg('--ignore-tags', Kanrisuru::Util.array_join_string(opts[:ignore_tags]))
         command.append_arg('--include-directories', Kanrisuru::Util.array_join_string(opts[:include_directories]))

data/lib/kanrisuru/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanrisuru
-  VERSION = '0.16.16'
+  VERSION = '0.19.0'
 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

@@ -97,8 +97,11 @@ RSpec.describe Kanrisuru::Core::Stat do
                              },
                              content_disposition: true,
                              secure_protocol: 'SSLv3',
+                             content_on_error: true,
+                             trust_server_names: true,
+                             retry_on_host_error: true,
                              no_check_certificate: true),
-                   "wget --post-data url=https%3A%2F%2Fexample.com%3Fparam%3D123 --content-disposition --secure-protocol SSLv3 --no-check-certificate #{url}")
+                   "wget --post-data url=https%3A%2F%2Fexample.com%3Fparam%3D123 --content-disposition --content-on-error --trust-server-names --retry-on-host-error --secure-protocol SSLv3 --no-check-certificate #{url}")
 
     expect do
       host.wget(url, secure_protocol: 'SSL')
@@ -115,27 +118,37 @@ RSpec.describe Kanrisuru::Core::Stat do
 
     expect_command(host.wget(url,
                              certificate: '~/cert.pem',
+                             https_only: true,
                              certificate_type: 'PEM',
                              private_key: '~/key.pem',
                              private_key_type: 'PEM',
                              ca_certificate: '~/ca.pem',
                              random_file: '~/random'),
-                   "wget --certificate ~/cert.pem --certificate-type PEM --private-key ~/key.pem --private-key-type PEM --ca-certificate ~/ca.pem --random-file ~/random #{url}")
+                   "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(url,
+    expect_command(host.wget('ftp.example.com',
                              ftp_user: 'admin',
                              ftp_password: '12345678',
                              no_remove_listing: true,
                              no_glob: true,
                              no_passive_ftp: true,
-                             retr_symlinks: true),
-                   "wget --ftp-user admin --ftp-password 12345678 --no-remove-listing --no-glob --no-passive-ftp --retr-symlinks #{url}")
+                             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')
+
+    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')
 
     ## Recursive Retrieval
     expect_command(host.wget(url,
                              recursive: true,
-                             depth: 10,
+                             level: 10,
                              delete_after: true,
                              convert_links: true,
                              backup_converted: true,
@@ -146,10 +159,13 @@ RSpec.describe Kanrisuru::Core::Stat do
 
     ## Recursive Accept/Reject
     expect_command(host.wget(url,
-                             accept_list: ['.txt', '.html'],
-                             reject_list: ['.csv'],
-                             domain_list: ['example.com'],
-                             exclude_domain_list: ['hackernews.com'],
+                             accept: ['.txt', '.html'],
+                             reject: ['.csv'],
+                             accept_regex: 'https://*',
+                             regect_regex: 'ftp*',
+                             regex_type: 'posix',
+                             domains: ['example.com'],
+                             exclude_domains: ['hackernews.com'],
                              follow_tags: %w[a div span],
                              ignore_tags: %w[area link],
                              include_directories: ['/gems'],
@@ -159,6 +175,6 @@ RSpec.describe Kanrisuru::Core::Stat do
                              span_hosts: true,
                              relative: true,
                              no_parent: true),
-                   "wget --accept .txt,.html --reject .csv --domains example.com --exclude-domains hackernews.com --follow-tags a,div,span --ignore-tags area,link --include-directories /gems --exclude-directories /releases --follow-ftp --ignore-case --span-hosts --relative --no-parent #{url}")
+                   "wget --accept .txt,.html --reject .csv --accept-regex https://* --regex_type posix --domains example.com --exclude-domains hackernews.com --follow-tags a,div,span --ignore-tags area,link --include-directories /gems --exclude-directories /releases --follow-ftp --ignore-case --span-hosts --relative --no-parent #{url}")
   end
 end

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.16
+  version: 0.19.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-01-25 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.