kanrisuru 0.16.14 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8db62531b521e5f8606ed7bb2520100d2f2f1fe20d78c1c8ae43759926e44ee
-  data.tar.gz: d3372a41fe3058ffaf938ce8ca31e7458f71fe981b380ac14143c46f2be9692b
+  metadata.gz: b3f695ef2a1f50c24f7e2c8a06a107202c72e36a19b4952a4af9fbe3bdda93d3
+  data.tar.gz: e4ec5a94e1b24ff564fc46d909ddfd93bcb0d3e2baa916137c07740a896d8a6e
 SHA512:
-  metadata.gz: 8bfafcc5e78e8545a1a2c6565bdbd9f5e581186c40b97696c1c4cd5b80426b03306f98a400db289293e86f4b919ee1b9cad622323c03b63264344a73c555f777
-  data.tar.gz: a1166a9650b3f3fe95a270abfa4950afb2b36fa3acde33ad4ed237944a44eddef6c4cc1d85352b87c0f672aed69d50dd60801295127c88ffc8b56a3ebd3e35e9
+  metadata.gz: a02f65e7d962e2e02594bee48b8a8662bf29a936a02e9e938332340d695618bd92a2a3b6fc26c7324ecb0af236d6d6dc11475fd8205ee6cc77d97ff57f39cbdf
+  data.tar.gz: 047b7235f156d77085a413d2af37ce09367d1eb68b33ae0b96b1e2a0ed8f79ba9b8111f3933e02dd37245393fd4c6333455407187fb62ba6ad524dfc42ec1f54

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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.
+
+## Kanrisuru 0.16.15 (January 07, 2022) ##
+*  Add recursive and all_targets opts to `umount` command.
+
 ## Kanrisuru 0.16.14 (January 02, 2022) ##
 *  Fix `get_user` command by parsing output to get user name if uid is passed in. 
 

data/README.md

@@ -1,5 +1,5 @@
 <h1>
-  <img src="./logo/kanrisuru-logo.png" alt="Kanrisuru" width="400" height="100%"/>  
+  <img src="https://s3.us-east-2.amazonaws.com/kanrisuru.com/kanrisuru-logo.png" alt="Kanrisuru" width="400" height="100%"/>  
 </h1>
 
 <p>

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

@@ -126,8 +126,7 @@ module Kanrisuru
               field = field.downcase
               field = field.gsub(/\s/, '_')
               field = field.gsub('-', '_')
-              field = field.gsub(':', '')
-              field
+              field.gsub(':', '')
             end
 
             def dmi_type_to_struct(type)

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

@@ -17,6 +17,9 @@ 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])
+
         if Kanrisuru::Util.present?(all)
           command.append_flag('-a')
           add_type(command, type)

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.rb

@@ -9,6 +9,7 @@ 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'

data/lib/kanrisuru/core/transfer/commands/download.rb

@@ -4,21 +4,41 @@ module Kanrisuru
   module Core
     module Transfer
       def download(remote_path, local_path = nil, opts = {})
+        recursive = opts[:recursive] || false
+
+        remote_path += '/' if !remote_path.end_with?('/') && recursive
+        local_path += '/' if !local_path.nil? && !local_path.end_with?('/') && recursive
+
         if local_path.instance_of?(Hash)
           opts = local_path
           local_path = nil
         end
 
-        tmp_path = "/tmp/kanrisuru-tmp-#{Time.now.to_i}-#{object_id}"
+        tmp_name = "kanrisuru-tmp-#{Time.now.to_i}-#{object_id}"
+        tmp_path = "/tmp/#{tmp_name}"
 
         begin
-          result = cp(remote_path, tmp_path, force: true)
+          result = cp(remote_path, tmp_path, force: true, follow: true, recursive: recursive)
           raise 'Unable to copy remote file to temp path' unless result.success?
 
+          result = chown(tmp_path, owner: @username, group: @username, recursive: recursive)
+          raise 'Unable to update owner or group for temp path' unless result.success?
+
+          result = chmod(tmp_path, 'u+r', recursive: true)
+          raise 'Unable to update owner permission read access' unless result.success?
+
+          local_path = ::File.expand_path(local_path) if local_path
           result = ssh.scp.download!(tmp_path, local_path, opts)
-          Kanrisuru::Util.blank?(local_path) ? result : local_path
+          return false unless result
+
+          if Kanrisuru::Util.present?(local_path) && recursive
+            remote_dirname = remote_path.split('/').last
+            FileUtils.mv("#{local_path}/#{tmp_name}", "#{local_path}/#{remote_dirname}")
+          else
+            result
+          end
         ensure
-          rm(tmp_path, force: true) if inode?(tmp_path)
+          rm(tmp_path, force: true, recursive: recursive) if inode?(tmp_path)
         end
       end
     end

data/lib/kanrisuru/core/transfer/commands/upload.rb

@@ -12,9 +12,7 @@ module Kanrisuru
 
           ## Need to copy internal dir contents, not the tmp dir itself
           if opts[:recursive]
-            unless dir?(remote_path)
-              mkdir(remote_path, silent: true)
-            end
+            mkdir(remote_path, silent: true) unless dir?(remote_path)
 
             result = cp("#{tmp_path}/*", remote_path, recursive: true)
           else
@@ -22,6 +20,7 @@ module Kanrisuru
           end
 
           raise "Unable to move file to remote path - #{result.command.raw_result}" unless result.success?
+
           stat(remote_path)
         ensure
           rm(tmp_path, force: true) if inode?(tmp_path)

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/core/user/commands/get_user.rb

@@ -10,11 +10,12 @@ module Kanrisuru
         Kanrisuru::Result.new(command) do |cmd|
           if Kanrisuru::Util.numeric?(user)
             uid = user.to_i
-            user = Parser::User.parse(cmd) 
+            user = Parser::User.parse(cmd)
           else
             ## Get user id
             result = get_uid(user)
             break if result.failure?
+
             uid = result.to_i
           end
 

data/lib/kanrisuru/core/user/parsers/user.rb

@@ -8,7 +8,7 @@ module Kanrisuru
           def self.parse(command)
             string = command.to_s
             string = string.split[0]
-            
+
             matches = string.match(/uid=\d+\((.+)\)/)
             return if !matches || !matches.captures
 

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/find_spec.rb

@@ -68,7 +68,7 @@ RSpec.describe Kanrisuru::Core::Find do
                      paths: '/dev',
                      iname: 'tty*'
                    ),
-                   "find /dev -iname tty*")
+                   'find /dev -iname tty*')
 
     expect_command(host.find(
                      paths: '/dev',

data/spec/functional/core/group_spec.rb

@@ -22,11 +22,9 @@ RSpec.describe Kanrisuru::Core::Group do
   it 'prepares create_group command' do
     expect_command(host.create_group('admin'), 'groupadd admin')
     expect_command(host.create_group('admin',
-        gid: 9000, 
-        non_unique: true
-      ), 
-      'groupadd admin -g 9000 -o'
-    )
+                                     gid: 9000,
+                                     non_unique: true),
+                   'groupadd admin -g 9000 -o')
 
     expect_command(host.create_group('admin', gid: 12, system: true), 'groupadd admin -g 12 -r')
   end

data/spec/functional/core/mount_spec.rb

@@ -95,6 +95,8 @@ RSpec.describe Kanrisuru::Core::Mount do
 
   it 'prepares umount command' do
     expect_command(host.umount, 'umount')
+    expect_command(host.umount(recursive: true, all_targets: true), 'umount --all-targets --recursive')
+
     expect_command(host.umount(
                      fake: true,
                      no_canonicalize: true,

data/spec/functional/core/system_spec.rb

@@ -124,6 +124,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/functional/remote/cluster_spec.rb

@@ -85,9 +85,9 @@ RSpec.describe Kanrisuru::Remote::Cluster do
     expect(command.prepared_command).to eq('sudo -u root /bin/bash -c "ls"')
     expect(cloned_command.prepared_command).to eq('sudo -u root /bin/bash -c "ls"')
 
-    expect {
+    expect do
       cluster.send(:create_command, 1)
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
   end
 
   it 'runs execute for a command on a cluster' do
@@ -178,8 +178,8 @@ RSpec.describe Kanrisuru::Remote::Cluster do
 
     cluster.cd('/etc')
     cluster.each do |host|
-      expect(host.instance_variable_get(:@current_dir)).to eq('/etc') 
-    end 
+      expect(host.instance_variable_get(:@current_dir)).to eq('/etc')
+    end
 
     StubNetwork.unstub_command!(:pwd)
     StubNetwork.unstub_command!(:realpath)
@@ -198,18 +198,18 @@ RSpec.describe Kanrisuru::Remote::Cluster do
 
     cluster.chdir('/etc')
     cluster.each do |host|
-      expect(host.instance_variable_get(:@current_dir)).to eq('/etc') 
-    end 
+      expect(host.instance_variable_get(:@current_dir)).to eq('/etc')
+    end
 
     StubNetwork.unstub_command!(:pwd)
     StubNetwork.unstub_command!(:realpath)
   end
-  
+
   it 'fails to remove a host from a cluster' do
     cluster = described_class.new(host1, host2)
 
-    expect {
+    expect do
       cluster.delete(1)
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
   end
 end

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

@@ -108,6 +108,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/support/shared_examples/integration/core/transfer.rb

@@ -34,6 +34,7 @@ RSpec.shared_examples 'transfer' do |os_name, host_json, spec_dir|
         keys: [host_json['ssh_key']]
       )
 
+      FileUtils.rm_rf("../test-output-#{os_name}")
       host.rmdir(spec_dir)
       host.disconnect
     end
@@ -80,7 +81,7 @@ RSpec.shared_examples 'transfer' do |os_name, host_json, spec_dir|
       src_path = '/etc/hosts'
 
       result = host.download(src_path, path)
-      expect(result).to eq(path)
+      expect(result).to be_truthy
       FileUtils.rm(path)
     end
 
@@ -93,6 +94,22 @@ RSpec.shared_examples 'transfer' do |os_name, host_json, spec_dir|
       expect(lines.length).to be >= 1
     end
 
+    it 'downloads a dir' do
+      remote_path = '/var/log'
+      local_path  = "../test-output-#{os_name}"
+      FileUtils.mkdir(local_path)
+
+      host.su('root')
+      result = host.download(remote_path, local_path, recursive: true)
+      expect(result).not_to be nil
+
+      paths = host.ls(path: '/var/log').map(&:path)
+      Dir.glob("#{local_path}/log/*").each do |file|
+        name = File.basename(file)
+        expect(paths).to include(name)
+      end
+    end
+
     it 'wgets url' do
       result = host.wget('https://example.com', directory_prefix: spec_dir)
       expect(result).to be_success

data/spec/support/shared_examples/integration/remote/cluster.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.shared_examples 'cluster' do |os_name, host_json, spec_dir|
+RSpec.shared_examples 'cluster' do |os_name, host_json, _spec_dir|
   context "with #{os_name}" do
     let(:host1) do
       Kanrisuru::Remote::Host.new(

data/spec/unit/core/system_spec.rb

@@ -30,6 +30,7 @@ RSpec.describe Kanrisuru::Core::System do
     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(:uptime)
     expect(host).to respond_to(:w)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.16.14
+  version: 0.17.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-02 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests
@@ -314,6 +314,7 @@ 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
@@ -706,7 +707,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.