kanrisuru 0.8.15 → 0.8.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 522ae1903fe51ff350abc0fafa252d1b66f970710d4bed41748be03cc25ead3d
-  data.tar.gz: 501c4b568aeed1bca4e22658291ebab44e9cb9ebb84c23f5154dc4c97e5daf08
+  metadata.gz: 90fafd703817d1e16744262817dd0b5e5a51ea942f2853b154f4bd2746295fd7
+  data.tar.gz: 0e0b35e325d3237faacbb71f22873b1c661495af0d93830e7ad91babbb060b3c
 SHA512:
-  metadata.gz: 59fbae207747c7b7c93461a48f12cd959d8dcd2b2853619cb15624627534bca2a84fdf88c068285ef2cbb7a1ac48c74d592f784374847e3f89b35faa85de5366
-  data.tar.gz: 8981e523f2373b7eb4740e1c6b1af2318cb45ba960a92e620f368d502a5359f68402fa23c2607f449e563c451b6b5d0efce9cba8ef45ffa4252b4158bd9a09a8
+  metadata.gz: 76e116b83a5c119c0672b8ec5f1bac8f23307e1e06d3b393804df912f6110faf63527ca126ed4eb164d6ba58ef4ba92f3d1c3e15b252dc703058e39fc3ab4ba3
+  data.tar.gz: 8e80e6457fd848d4dee5a31e33881c91458402df16cc82845b6300afc2543fe583fe48aeb2914e4329de9d9a668b6afbc2dd533d56886bd6fe0656ede58e5c95

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## Kanrisuru 0.8.19 (October 31, 2021)
+* Add functional test cases for `ss` command.
+* Enforce contraints on `family` parameter for `ss` command.
+* Deprecating `string_join_array` in favor of `array_join_string`. Both methods do the same thing, and the `array_join_string` has a better nameing interface; will be removed in the next major release.
+* Replace `string_join_array` method calls in `apt`, `transfer`, `yum`, and `zypper` with `array_join_string`. 
+
+## Kanrisuru 0.8.18 (October 19, 2021)
+* Add functional test cases for `find` commmand.
+* Add `regex_type` option for `find` command.
+* Fix bug with `size` option when using number in a string format, regex testing has been simplified on matching correctness for size with options like `100`, `+100`, `-100M` for comparitive fields.
+
+## Kanrisuru 0.8.17 (October 16, 2021)
+* Add functional test cases for `transfer` module
+* Update wget command to accept hash for `headers` opt.
+
+## Kanrisuru 0.8.16 (October 14, 2021)
+* Add functional test cases for `stream` and `path` modules
+* Create `expect_command`  helper for quick testing on raw command result
+
 ## Kanrisuru 0.8.15 (October 12, 20201)
 * Move functional specs to integration. Anything that performs an actual network request will be under the integrations test.
 * Create a `StubNetwork` to quickly monkey patch the `Kanrisuru::Remote::Host` to simulate a `Net::SSH` channel request. Will add additional functionality for different simulations later on.

data/lib/kanrisuru/core/apt.rb

@@ -142,7 +142,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('apt-get purge')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -153,7 +153,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('apt-get remove')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -168,7 +168,7 @@ module Kanrisuru
         command.append_flag('--only-upgrade', opts[:only_upgrade])
         command.append_flag('--reinstall', opts[:reinstall])
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -200,7 +200,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('apt show')
         command.append_flag('-a')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)

data/lib/kanrisuru/core/disk.rb

@@ -23,7 +23,7 @@ module Kanrisuru
         :name, :label, :uuid, :type, :uuid_sub, :label_fatboot, :version, :usage,
         :part_uuid, :part_entry_scheme, :part_entry_uuid, :part_entry_type,
         :part_entry_number, :part_entry_offset, :part_entry_size, :part_entry_disk,
-        :minimum_io_size, :physical_sector_size, :logical_sector_size, 
+        :minimum_io_size, :physical_sector_size, :logical_sector_size
       )
 
       def du(opts = {})

data/lib/kanrisuru/core/find.rb

@@ -10,6 +10,7 @@ module Kanrisuru
       os_define :linux, :find
 
       FilePath = Struct.new(:path)
+      REGEX_TYPES = ['emacs', 'posix-awk', 'posix-basic', 'posix-egrep', 'posix-extended']
 
       def find(opts = {})
         paths      = opts[:paths]
@@ -32,7 +33,7 @@ module Kanrisuru
           if paths.instance_of?(Array)
             paths = paths.join(' ')
           elsif paths.class != String
-            raise 'Invalid paths type'
+            raise ArgumentError, 'Invalid paths type'
           end
 
           command << paths
@@ -64,13 +65,19 @@ module Kanrisuru
         command.append_arg('-cmin', opts[:cmin])
         command.append_arg('-mmin', opts[:mmin])
 
-        command.append_arg('-regex', "'#{regex}'") if Kanrisuru::Util.present?(regex)
+        if Kanrisuru::Util.present?(opts[:regex_type])
+          unless REGEX_TYPES.include?(opts[:regex_type])
+            raise ArgumentError, 'invalid regex type'
+          end
 
-        if size.instance_of?(String)
-          match = Regexp.new(/^([-+]+)\s*?(\d+)([bcwkMG])$/).match(size)
+          command.append_arg('-regextype', opts[:regex_type])
+        end
 
-          raise ArgumentError, "invalid size string: '#{@size}'" if match.nil? || match.captures.include?(nil)
+        command.append_arg('-regex', "'#{regex}'") if Kanrisuru::Util.present?(regex)
 
+        if size.instance_of?(String)
+          regex = Regexp.new(/^([-+])?(\d+)([bcwkMG])*$/)
+          raise ArgumentError, "invalid size string: '#{@size}'" unless regex.match?(size) 
           command.append_arg('-size', size)
         elsif size.instance_of?(Integer)
           command.append_arg('-size', size)

data/lib/kanrisuru/core/socket.rb

@@ -38,9 +38,14 @@ module Kanrisuru
         'LAST-ACK' => 'last-ack', 'CLOSING' => 'closing'
       }.freeze
 
+      NETWORK_FAMILIES = %w[
+        unix inet inet6 link netlink
+      ].freeze
+
       def ss(opts = {})
         state = opts[:state]
         expression = opts[:expression]
+        family = opts[:family]
 
         command = Kanrisuru::Command.new('ss')
 
@@ -53,7 +58,10 @@ module Kanrisuru
         command.append_flag('-x', opts[:unix])
         command.append_flag('-w', opts[:raw])
 
-        command.append_arg('-f', opts[:family])
+        if Kanrisuru::Util.present?(family)
+          raise ArgumentError, 'invalid family type' if !NETWORK_FAMILIES.include?(family)
+          command.append_arg('-f', family)
+        end
 
         if Kanrisuru::Util.present?(state)
           raise ArgumentError, 'invalid filter state' if !TCP_STATES.include?(state) && !OTHER_STATES.include?(state)

data/lib/kanrisuru/core/transfer.rb

@@ -87,7 +87,7 @@ module Kanrisuru
         command.append_arg('--quota', opts[:quota])
 
         if Kanrisuru::Util.present?(opts[:restrict_file_names])
-          command.append_arg('--restrict-file-names', Kanrisuru::Util.string_join_array(opts[:restrict_file_names]))
+          command.append_arg('--restrict-file-names', Kanrisuru::Util.array_join_string(opts[:restrict_file_names]))
         end
 
         case opts[:family]
@@ -124,7 +124,6 @@ module Kanrisuru
         command.append_flag('--no-cookies', opts[:no_cookies])
         command.append_flag('--keep-session-cookies', opts[:keep_session_cookies])
         command.append_flag('--ignore-length', opts[:ignore_length])
-        command.append_arg('--header', opts[:header])
         command.append_arg('--max-redirect', opts[:max_redirect])
         command.append_arg('--proxy-user', opts[:proxy_user])
         command.append_arg('--proxy-password', opts[:proxy_password])
@@ -132,6 +131,18 @@ module Kanrisuru
         command.append_flag('--save-headers', opts[:save_headers])
         command.append_arg('--user-agent', opts[:user_agent])
 
+        headers = opts[:headers]
+        if Kanrisuru::Util.present?(headers)
+          if headers.instance_of?(Hash)
+            headers.each do |key, value|
+              header = "'#{key}: #{value}'"
+              command.append_arg('--header', header)
+            end
+          elsif headers.instance_of?(String)
+            command.append_arg('--header', headers)
+          end
+        end
+
         post_data = opts[:post_data]
 
         if Kanrisuru::Util.present?(post_data)

data/lib/kanrisuru/core/yum.rb

@@ -78,7 +78,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum install')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -91,7 +91,7 @@ module Kanrisuru
         command.append_flag('-y')
 
         if Kanrisuru::Util.present?(opts[:repos])
-          repos = Kanrisuru::Util.string_join_array(opts[:repos], ' ')
+          repos = Kanrisuru::Util.array_join_string(opts[:repos], ' ')
           command << repos
         end
 
@@ -136,7 +136,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum remove')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         raise ArugmentError, "can't remove yum" if packages.include?('yum')
 
         command << packages
@@ -172,7 +172,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum erase')
         command.append_flag('-y')
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         raise ArugmentError, "can't erase yum" if packages.include?('yum')
 
         command << packages
@@ -198,7 +198,7 @@ module Kanrisuru
       def yum_search(opts)
         command = Kanrisuru::Command.new('yum search')
         command.append_flag('all', opts[:all])
-        command << Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        command << Kanrisuru::Util.array_join_string(opts[:packages], ' ')
 
         pipe_output_newline(command)
 
@@ -228,7 +228,7 @@ module Kanrisuru
         command = Kanrisuru::Command.new('yum repolist')
         command.append_flag('--verbose')
 
-        command << Kanrisuru::Util.string_join_array(opts[:repos], ' ') if opts[:repos]
+        command << Kanrisuru::Util.array_join_string(opts[:repos], ' ') if opts[:repos]
 
         execute_shell(command)
 
@@ -287,7 +287,7 @@ module Kanrisuru
         command.append_flag('--quiet')
         command.append_flag('installed', opts[:installed])
 
-        command << Kanrisuru::Util.string_join_array(opts[:packages], ' ') if opts[:packages]
+        command << Kanrisuru::Util.array_join_string(opts[:packages], ' ') if opts[:packages]
 
         execute_shell(command)
 

data/lib/kanrisuru/core/zypper.rb

@@ -567,7 +567,7 @@ module Kanrisuru
         zypper_repos_opt(command, opts)
         zypper_package_type_opt(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -663,7 +663,7 @@ module Kanrisuru
         zypper_download_and_install_opts(command, opts)
         zypper_expert_opts(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -714,7 +714,7 @@ module Kanrisuru
         zypper_package_type_opt(command, opts)
         zypper_solver_opts(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)
@@ -783,7 +783,7 @@ module Kanrisuru
         zypper_repos_opt(command, opts)
         zypper_package_type_opt(command, opts)
 
-        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        packages = Kanrisuru::Util.array_join_string(opts[:packages], ' ')
         command << packages
 
         execute_shell(command)

data/lib/kanrisuru/util.rb

@@ -21,6 +21,10 @@ module Kanrisuru
     end
 
     def self.string_join_array(arg, field = ',')
+      Kanrisuru.logger.info do
+        'DEPRECATION WARNING: string_join_array will be removed in the upcoming major release. Use array_join_string instead.'
+      end
+      
       array = arg.instance_of?(String) ? [arg] : arg
       array.join(field)
     end

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/find_spec.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+StubNetwork.stub!
+
+RSpec.describe Kanrisuru::Core::Find do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares find command' do
+    expect_command(host.find, "find")
+
+    expect_command(host.find(follow: 'never'), "find -P")
+    expect_command(host.find(follow: 'always'), "find -L")
+    expect_command(host.find(follow: 'command'), "find -H")
+
+    expect_command(host.find(paths: '/etc'), "find /etc")
+    expect_command(host.find(paths: ['/etc', '/var', '/home']), "find /etc /var /home")
+
+    expect {
+      host.find(paths: 1)
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.find(paths: '/', 
+        executable: true,
+        empty: true,
+        readable: true,
+        writeable: true,
+        nogroup: true,
+        nouser: true,
+        mount: true
+      ), 
+      "find / -executable -empty -readable -nogroup -nouser -mount"
+    )
+
+    expect_command(host.find(paths: '/', 
+        path: "/lib",
+        name: '*.so',
+        gid: 0,
+        uid: 0,
+        user: 'root',
+        group: 'root',
+        links: 2,
+        mindepth: 0,
+        maxdepth: 100   
+      ),
+      "find / -path /lib -name *.so -gid 0 -uid 0 -user root -group root -links 2 -maxdepth 100 -mindepth 0"
+    )
+
+    expect_command(host.find(paths: '/var/log',
+        atime: '+1',
+        ctime: '+2',
+        mtime: '+3',
+        amin: '100',
+        cmin: '200',
+        mmin: '300'
+      ),
+      "find /var/log -atime +1 -ctime +2 -mtime +3 -amin 100 -cmin 200 -mmin 300"
+    )
+
+    expect_command(host.find(
+        paths: '/dev', 
+        regex: '/dev/tty[0-9]*'
+      ), 
+      "find /dev -regex '/dev/tty[0-9]*'"
+    )
+
+    expect_command(host.find(
+        paths: '/dev', 
+        regex_type: 'posix-egrep',
+        regex: '/dev/tty[0-9]*'
+      ), 
+      "find /dev -regextype posix-egrep -regex '/dev/tty[0-9]*'"
+    )
+
+    expect_command(host.find(
+        paths: '/var/log',
+        size: 100
+      ),
+      "find /var/log -size 100"
+    )
+
+    expect_command(host.find(
+        paths: '/var/log',
+        size: "100"
+      ),
+      "find /var/log -size 100"
+    )
+    
+    expect {
+      host.find(size: "100n")
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.find(
+        paths: '/var/log',
+        size: "-100k"
+      ),
+      "find /var/log -size -100k"
+    )
+
+    expect_command(host.find(
+        paths: '/var/log',
+        size: "+10M"
+      ),
+      "find /var/log -size +10M"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'directory' 
+      ),
+      "find /dev -type d"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'file' 
+      ),
+      "find /dev -type f"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'symlinks' 
+      ),
+      "find /dev -type l"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'block'
+      ),
+      "find /dev -type b"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'character'
+      ),
+      "find /dev -type c"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'pipe'
+      ),
+      "find /dev -type p"
+    )
+
+    expect_command(host.find(
+        paths: "/dev",
+        type: 'socket'
+      ),
+      "find /dev -type s"
+    )
+  end
+end

data/spec/functional/core/path_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+StubNetwork.stub!
+
+RSpec.describe Kanrisuru::Core::Path do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares ls command' do
+    expect_command(host.ls(path: '/etc'), 'ls -i -l /etc')
+    expect_command(host.ls(path: '/var/log', all: true, id: true), 'ls -i -l -a -n /var/log')
+  end
+
+  it 'prepares pwd command' do
+    expect_command(host.pwd, 'pwd')
+  end
+
+  it 'prepares whoami command' do
+    expect_command(host.whoami, 'whoami')
+  end
+
+  it 'prepares which command' do
+    expect_command(host.which('which'), 'which which')
+    expect_command(host.which('pwd', all: true), 'which -a pwd')
+  end
+
+  it 'prepares realpath command' do
+    expect_command(host.realpath('/etc/os-release'), 'realpath /etc/os-release')
+    expect_command(host.realpath('/etc/os-release', strip: true), 'realpath /etc/os-release -s')
+  end
+
+  it 'prepares readlink command' do
+    expect_command(host.readlink('/etc/os-release'), 'readlink /etc/os-release')
+    expect_command(host.readlink('/etc/os-release', canonicalize: true), 'readlink -f /etc/os-release')
+    expect_command(host.readlink('/etc/os-release', canonicalize_existing: true), 'readlink -e /etc/os-release')
+    expect_command(host.readlink('/etc/os-release', canonicalize_missing: true), 'readlink -m /etc/os-release')
+  end
+end

data/spec/functional/core/socket_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+StubNetwork.stub!
+
+RSpec.describe Kanrisuru::Core::Socket do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares ss command' do
+    expect_command(host.ss, 'ss -a -m')
+
+    expect_command(host.ss(
+        numeric: true,
+        tcp: true,
+        udp: true,
+        unix: true,
+        raw: true
+      ),
+      'ss -a -m -n -t -u -x -w'
+    )
+
+    expect_command(host.ss(
+        family: 'inet'
+      ),
+      'ss -a -m -f inet'
+    )
+
+    expect {
+      host.ss(family: 'inet5')
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.ss(
+        state: 'established'
+      ),
+      'ss -a -m state established'
+    )
+
+    expect_command(host.ss(
+        state: 'connected'
+      ),
+      'ss -a -m state connected'
+    )
+
+    expect {
+      host.ss(state: 'test')
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.ss(
+        expression: "'( dport = :ssh or sport = :ssh )'"
+      ),
+      "ss -a -m '( dport = :ssh or sport = :ssh )'"
+    )
+  end
+end

data/spec/functional/core/stat_spec.rb

@@ -8,21 +8,16 @@ RSpec.describe Kanrisuru::Core::Stat do
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',
-      username: 'ubuntu', 
+      username: 'ubuntu',
       keys: ['id_rsa']
     )
   end
 
   it 'prepares stat command' do
-    result = host.stat('~/file1.txt')
-    expect(result.command.raw_command).to eq(
-      'stat -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt'
-    )
+    expect_command(host.stat('~/file1.txt'),
+                   'stat -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt')
 
-    result = host.stat('~/file2.txt', follow: true)
-    expect(result.command.raw_command).to eq(
-      'stat -L -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt'
-    )
+    expect_command(host.stat('~/file2.txt', follow: true),
+                   'stat -L -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file2.txt')
   end
-
 end

data/spec/functional/core/stream_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+StubNetwork.stub!
+
+RSpec.describe Kanrisuru::Core::Stream do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares head command' do
+    result = host.head('/var/log/syslog')
+    expect_command(result, 'head /var/log/syslog')
+
+    result = host.head('/var/log/syslog', bytes: 1024)
+    expect_command(result, 'head -c 1024 /var/log/syslog')
+
+    result = host.head('/var/log/syslog', lines: 50)
+    expect_command(result, 'head -n 50 /var/log/syslog')
+  end
+
+  it 'prepares tail command' do
+    result = host.tail('/var/log/syslog')
+    expect_command(result, 'tail /var/log/syslog')
+
+    result = host.tail('/var/log/syslog', bytes: 1024)
+    expect_command(result, 'tail -c 1024 /var/log/syslog')
+
+    result = host.tail('/var/log/syslog', lines: 50)
+    expect_command(result, 'tail -n 50 /var/log/syslog')
+  end
+
+  it 'prepares read_file_chunk command' do
+    result = host.read_file_chunk('/var/log/apache2/access.log', 10, 20)
+    expect_command(result, 'tail -n +10 /var/log/apache2/access.log | head -n 11')
+
+    result = host.read_file_chunk('/var/log/apache2/access.log', 0, 0)
+    expect_command(result, 'tail -n +0 /var/log/apache2/access.log | head -n 1')
+
+    expect do
+      host.read_file_chunk('file.log', 10, '20')
+    end.to raise_error(ArgumentError)
+
+    expect do
+      host.read_file_chunk('file.log', '10', 20)
+    end.to raise_error(ArgumentError)
+
+    expect do
+      host.read_file_chunk('file.log', 10, 9)
+    end.to raise_error(ArgumentError)
+
+    expect do
+      host.read_file_chunk('file.log', -1, 1)
+    end.to raise_error(ArgumentError)
+
+    expect do
+      host.read_file_chunk('file.log', 10, -2)
+    end.to raise_error(ArgumentError)
+  end
+
+  it 'prepares sed command' do
+    result = host.sed('~/file.txt', 'Cat', 'Dog')
+    expect_command(result, "sed 's/Cat/Dog/g' '~/file.txt'")
+
+    result = host.sed('~/file.txt', 'Cat', 'Doggz', in_place: true, new_file: '~/file2.txt', mode: 'write')
+    expect_command(result, "sed -i 's/Cat/Doggz/g' '~/file.txt' > ~/file2.txt")
+
+    result = host.sed('~/file.txt', 'Cat', 'Dogo', regexp_extended: true, new_file: '~/file2.txt', mode: 'append')
+    expect_command(result, "sed -r 's/Cat/Dogo/g' '~/file.txt' >> ~/file2.txt")
+  end
+
+  it 'prepares echo command' do
+    expect_command(host.echo('Hello world'), "echo 'Hello world'")
+    expect_command(host.echo('Hello\\n world', backslash: true), "echo -e 'Hello\\n world'")
+
+    expect_command(host.echo('Hello world', new_file: '~/file1.txt', mode: 'write'),
+      "echo 'Hello world' > ~/file1.txt")
+    
+    expect_command(host.echo('Goodbye', new_file: '~/file1.txt', mode: 'append'),
+      "echo 'Goodbye' >> ~/file1.txt")
+  end
+
+  it 'prepares cat command' do
+    expect_command(host.cat('/etc/group'), 'cat /etc/group')
+    expect_command(host.cat('/etc/group', show_all: true), 'cat -A /etc/group')
+    expect_command(host.cat('/etc/group',
+      show_tabs: true,
+      number: true,
+      squeeze_blank: true,
+      show_nonprinting: true,
+      show_ends: true,
+      number_nonblank: true), 'cat -T -n -s -v -E -b /etc/group')
+
+    expect_command(host.cat(['~/file1.txt', '~/file2.txt', '~/file3.txt']),
+      'cat ~/file1.txt ~/file2.txt ~/file3.txt')
+
+    expect_command(host.cat(['~/file1.txt', '~/file2.txt', '~/file3.txt'], mode: 'write', new_file: 'combined.txt'),
+      'cat ~/file1.txt ~/file2.txt ~/file3.txt > combined.txt')
+
+    expect_command(host.cat(['~/file1.txt', '~/file2.txt', '~/file3.txt'], mode: 'append', new_file: 'combined.txt'),
+      'cat ~/file1.txt ~/file2.txt ~/file3.txt >> combined.txt')
+  end
+end

data/spec/functional/core/transfer_spec.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+StubNetwork.stub!
+
+RSpec.describe Kanrisuru::Core::Stat do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu', 
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares wget command' do
+    url = 'https://rubygems.org'
+
+    expect_command(host.wget(url),
+      "wget #{url}"
+    )
+
+    ## Output options
+    expect_command(host.wget(url, 
+      quiet: true, verbose: false, log_file: '/var/log/wget.log'),
+      "wget --quiet --no-verbose --output-file /var/log/wget.log #{url}"
+    )
+
+    expect_command(host.wget(url, 
+      verbose: true, append_log_file: '/var/log/wget.log'),
+      "wget --verbose --append-output /var/log/wget.log #{url}"
+    )
+
+    ## Download options
+    expect_command(host.wget(url,
+        bind_address: '0.0.0.0', 
+        retries: 3, 
+        output_document: '/home/ubuntu/index.html',
+        no_clobber: true,
+        timeout: 30,
+        dns_timeout: 60,
+        connect_timeout: 60,
+        read_timeout: 15,
+        limit_rate: '120k',
+        wait: 5, 
+        waitretry: 15,
+        random_wait: true, 
+        no_proxy: true,
+        no_dns_cache: true
+      ),
+      "wget --bind-address 0.0.0.0 --tries 3 --output-document /home/ubuntu/index.html --no-clobber --timeout 30 --dns-timeout 60 --connect-timeout 60 --read-timeout 15 --limit-rate 120k --wait 5 --waitretry 15 --random-wait --no-proxy --no-dns-cache https://rubygems.org"
+    )
+
+    ## Other Options
+    expect_command(host.wget(url,
+        quota: 'inf',
+        family: 'inet',
+        restrict_file_names: ['unix', 'ascii', 'lowercase', 'uppercase'],
+        retry_connrefused: true,
+        user: 'admin',
+        password: 'admin',
+        no_iri: true,
+      ),
+      "wget --quota inf --restrict-file-names unix,ascii,lowercase,uppercase --inet4-only --retry-connrefused --user admin --password admin --no-iri #{url}"
+    )
+
+    ## Directories
+    expect_command(host.wget(url,
+        no_directories: true,
+        no_host_directories: true,
+        cut_dirs: 3,
+        directory_prefix: '~/downloads/'
+      ),
+    "wget --no-directories --no-host-directories --cut-dirs 3 --directory-prefix ~/downloads/ #{url}"
+    )
+
+    ## HTTP
+    expect_command(host.wget(url,
+        default_page: 'index.html',
+        adjust_extension: true,
+        http_user: 'admin',
+        http_password: 'admin',
+        load_cookies: '~/cookies.txt',
+        save_cookies: '~/cookies.txt',
+        no_cache: true,
+        keep_session_cookies: true,
+        ignore_length: true,
+        headers: {
+          'Accept-Language' => 'hr',
+          'Authorization' => 'Bearer 1234' 
+        },
+        max_redirect: 5,
+        proxy_user: 'admin',
+        proxy_password: '12345678'
+      ),
+      "wget --default-page index.html --adjust-extension --http-user admin --http-password admin --load-cookies ~/cookies.txt --save-cookies ~/cookies.txt --no-cache --keep-session-cookies --ignore-length --max-redirect 5 --proxy-user admin --proxy-password 12345678 --header 'Accept-Language: hr' --header 'Authorization: Bearer 1234' #{url}"
+    )
+
+    expect_command(host.wget(url,
+        post_data: {
+          url: "https://example.com?param=123"
+        },
+        content_disposition: true,
+        secure_protocol: 'SSLv3',
+        no_check_certificate: true,
+      ),
+      "wget --post-data url=https%3A%2F%2Fexample.com%3Fparam%3D123 --content-disposition --secure-protocol SSLv3 --no-check-certificate #{url}"
+    )
+
+    expect {
+      host.wget(url, secure_protocol: 'SSL')
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.wget(url,
+        certificate: '~/cert.pem',
+        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}"
+    )
+
+    expect_command(host.wget(url,
+        certificate: '~/cert.pem',
+        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}"
+    )
+
+    ## FTP
+    expect_command(host.wget(url, 
+        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}"
+    )
+
+    ## Recursive Retrieval
+    expect_command(host.wget(url,
+        recursive: true,
+        depth: 10,
+        delete_after: true,
+        convert_links: true,
+        backup_converted: true,
+        mirror: true,
+        page_requisites: true,
+        strict_comments: true
+      ),
+      "wget --recursive --level 10 --delete-after --convert-links --backup-converted --mirror --page-requisites --strict-comments #{url}"
+    )
+
+    ## Recursive Accept/Reject
+    expect_command(host.wget(url,
+        accept_list: ['.txt', '.html'],
+        reject_list: ['.csv'],
+        domain_list: ['example.com'],
+        exclude_domain_list: ['hackernews.com'],
+        follow_tags: ['a', 'div', 'span'],
+        ignore_tags: ['area', 'link'],
+        include_directories: ['/gems'],
+        exclude_directories: ['/releases'],
+        follow_ftp: true,
+        ignore_case: true,
+        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}"
+    )
+  end
+end

data/spec/helper/expect_helpers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+def expect_command(result, string)
+  puts result.command.raw_command
+  expect(result.command.raw_command).to eq(
+    string
+  )
+end

data/spec/helper/stub_network.rb

@@ -2,15 +2,14 @@
 
 class StubNetwork
   class << self
-
     def stub!
-      ## Stub out the execute_with_retries method to 
-      ## test functionality of host commands 
+      ## Stub out the execute_with_retries method to
+      ## test functionality of host commands
       Kanrisuru::Remote::Host.class_eval do
         private
 
         def execute_with_retries(command)
-          command.handle_status(0) 
+          command.handle_status(0)
           command.handle_data(nil)
 
           command
@@ -24,22 +23,21 @@ class StubNetwork
           @kernel_name       = 'Linux'
           @kernel_version    = '#91-Ubuntu SMP Thu Jul 15 19:09:17 UTC 2021'
           @operating_system  = 'GNU/Linux'
-          @hardware_platform = "x86_64"
-          @processor         = "x86_64"
-          @release           = "ubuntu"
+          @hardware_platform = 'x86_64'
+          @processor         = 'x86_64'
+          @release           = 'ubuntu'
           @version           = 20.0
         end
       end
 
       Kanrisuru::Result.class_eval do
-        def initialize(command, &block)
+        def initialize(command)
           @command = command
           @data = nil
 
           @error = @command.to_a if @command.failure?
         end
       end
-    end 
-
+    end
   end
 end

data/spec/integration/core/disk_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe Kanrisuru::Core::Disk do
           :name, :label, :uuid, :type, :uuid_sub, :label_fatboot, :version, :usage,
           :part_uuid, :part_entry_scheme, :part_entry_uuid, :part_entry_type,
           :part_entry_number, :part_entry_offset, :part_entry_size, :part_entry_disk,
-          :minimum_io_size, :physical_sector_size, :logical_sector_size,
+          :minimum_io_size, :physical_sector_size, :logical_sector_size
         )
       end
 

data/spec/integration/core/file_spec.rb

@@ -41,7 +41,10 @@ RSpec.describe Kanrisuru::Core::File do
         )
 
         host.rm("#{host_json['home']}/.kanrisuru_spec_files", force: true, recursive: true)
-        host.rm("#{host_json['home']}/extract-tar-files", force: true, recursive: true) if host.dir?("#{host_json['home']}/extract-tar-files")
+        if host.dir?("#{host_json['home']}/extract-tar-files")
+          host.rm("#{host_json['home']}/extract-tar-files", force: true,
+                                                            recursive: true)
+        end
         host.disconnect
       end
 
@@ -68,9 +71,9 @@ RSpec.describe Kanrisuru::Core::File do
         expect(mode.symbolic).to eq('-rwxr--r--')
         expect(mode.to_i).to eq(0o744)
 
-        expect {
+        expect do
           host.chmod(path, 600)
-        }.to raise_error(ArgumentError)
+        end.to raise_error(ArgumentError)
       end
 
       it 'changes file owner and group' do
@@ -338,7 +341,7 @@ RSpec.describe Kanrisuru::Core::File do
         ## Can't delete non empty dir
         result = host.rmdir("#{spec_dir}/directory")
         expect(result).to be_failure
-       
+
         result = host.rmdir("#{spec_dir}/directory/3")
         expect(result).to be_success
       end
@@ -355,7 +358,7 @@ RSpec.describe Kanrisuru::Core::File do
 
         lines = doc.length
         words = doc.map(&:split).flatten
-        chars = doc.map(&:length).flatten 
+        chars = doc.map(&:length).flatten
 
         expect(result.lines).to eq(doc.length)
         expect(result.words).to eq(words.length)

data/spec/spec_helper.rb

@@ -4,8 +4,10 @@ require 'simplecov'
 SimpleCov.start
 
 require 'kanrisuru'
+
 require_relative 'helper/test_hosts'
 require_relative 'helper/stub_network'
+require_relative 'helper/expect_helpers'
 
 Kanrisuru.logger.level = Logger::WARN
 

data/spec/unit/core/find_spec.rb

@@ -5,5 +5,8 @@ require 'spec_helper'
 RSpec.describe Kanrisuru::Core::Find do
   it 'responds to find fields' do
     expect(Kanrisuru::Core::Find::FilePath.new).to respond_to(:path)
+    expect(Kanrisuru::Core::Find::REGEX_TYPES).to(
+      eq(['emacs', 'posix-awk', 'posix-basic', 'posix-egrep', 'posix-extended'])
+    )
   end
 end

data/spec/unit/core/socket_spec.rb

@@ -20,6 +20,11 @@ RSpec.describe Kanrisuru::Core::Socket do
         closed close-wait last-ack listening closing
       ]
     )
+    expect(Kanrisuru::Core::Socket::NETWORK_FAMILIES).to eq(
+      %w[
+        unix inet inet6 link netlink
+      ]
+    )
     expect(Kanrisuru::Core::Socket::OTHER_STATES).to eq(
       %w[
         all connected synchronized bucket syn-recv

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.8.15
+  version: 0.8.19
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -173,8 +173,14 @@ files:
 - lib/kanrisuru/util/os_family.rb
 - lib/kanrisuru/util/signal.rb
 - lib/kanrisuru/version.rb
+- spec/functional/core/find_spec.rb
+- spec/functional/core/path_spec.rb
+- spec/functional/core/socket_spec.rb
 - spec/functional/core/stat_spec.rb
+- spec/functional/core/stream_spec.rb
+- spec/functional/core/transfer_spec.rb
 - spec/functional/os_package_spec.rb
+- spec/helper/expect_helpers.rb
 - spec/helper/stub_network.rb
 - spec/helper/test_hosts.rb
 - spec/hosts.json