kanrisuru 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 584b31f227df31d0a5e45ae8abd18a4a8f87f73622b78cf7a59b66878ac79d4b
-  data.tar.gz: c0917335ccd0955398574ad61756604e6f3516fd2e73958da733b711c16a152a
+  metadata.gz: 40303a0de6eed7d5c10708a31ebf33ee7aed8701a21b3118e9bad5cdc751376b
+  data.tar.gz: 9daec56c51d0a4d6929fbcbbb585744215a61d877993e67453899ccf2db81717
 SHA512:
-  metadata.gz: f950255db2459f0ead9452c026059723da0deca9e8688dc0efae3c11bf00f3ddc3787f246d99f3ab9cc3893b12915309d91ce2f35c3bd22b8c905a9f5d387387
-  data.tar.gz: 105d7d7193a037f357e14b31cc7af353a494810287b2dd557861077c27ec83cb64be3e64d2b9f49104438d0c5fe233d79374256c1a098bec8a50de335c3b20ba
+  metadata.gz: 11a75804f677a0b72c88ab944c475646eebe68ed64a1fed15acb349e423215f98ddfcdd626681867eee82bb9092cd349ead6f7a44da142937bf329f300a877b0
+  data.tar.gz: 2605bbf322b06ae28d49d25b7d65970d5e5632527b79e12c6c7d2988173602ed126eab6d263106d866bda146153513573f702e210a36b4a3ee0e812caae06c79

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Kanrisuru 0.10.0 (December 03, 2021) ##
+* Add `stub_command` and `unstub_command` to mock indvidual command results from a remote server.
+* Add `count` and `delete` to `Kanrisuru::Remote::Env` class for managing environment variables.
+* Add unit and functional test cases for `Kanrisuru::Remote::Env`.
+* Add functional test cases for the `archive` command.
+* Fix typo bugs in the `archive` command. Fix `--exclude` opt field in `archive` command.
+* Add unit test cases for `Kanrisuru::Mode` class.
+
 ## Kanrisuru 0.9.2 (November 30, 2021) ##
 * Add unit test cases for all core commands.
 * Add unit test cases for `cluster` class. 

data/lib/kanrisuru/core/archive.rb

@@ -50,7 +50,7 @@ module Kanrisuru
           command.append_flag('--same-owner', opts[:same_owners])
           command.append_flag('--multi-volume', opts[:multi_volume])
           command.append_flag('--label', opts[:label])
-          command.append_flag('--one-file-system ', opts[:one_file_system])
+          command.append_flag('--one-file-system', opts[:one_file_system])
           command.append_flag('--keep-old-files', opts[:keep_old_files])
           command.append_flag('--skip-old-files', opts[:skip_old_files])
           command.append_flag('--overwrite', opts[:overwrite])
@@ -59,7 +59,7 @@ module Kanrisuru
           command.append_flag('--recursive-unlink', opts[:recursive_unlink])
 
           if Kanrisuru::Util.present?(paths)
-            paths = paths.instance_of(String) ? [paths] : paths
+            paths = paths.instance_of?(String) ? [paths] : paths
             command << paths.join(' ')
           end
 
@@ -70,8 +70,10 @@ module Kanrisuru
           command.append_flag('--multi-volume', opts[:multi_volume])
 
           if Kanrisuru::Util.present?(exclude)
-            exclude = exclude.instance_of?(String) ? [exclude] : exclude
-            command.append_arg('--exclude', exclude.join(' '))
+            exclude_options = exclude.instance_of?(String) ? [exclude] : exclude
+            exclude_options.each do |exclude_option|
+              command << "--exclude=#{exclude_option}"
+            end
           end
 
           if Kanrisuru::Util.present?(paths)
@@ -80,7 +82,6 @@ module Kanrisuru
           end
 
           execute_shell(command)
-
           Kanrisuru::Result.new(command)
         when 'append', 'r'
           command.append_flag('-r')

data/lib/kanrisuru/remote/env.rb

@@ -25,6 +25,14 @@ module Kanrisuru
         string
       end
 
+      def count
+        @env.count
+      end
+
+      def delete(key)
+        @env.delete(key.to_s.upcase)
+      end
+
       def [](key)
         @env[key.to_s.upcase]
       end

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/archive_spec.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Apt do
+  before(:all) do
+    StubNetwork.stub!
+    StubNetwork.stub_command!(:realpath) do |args|
+      Kanrisuru::Core::Path::FilePath.new(directory)
+    end
+  end
+
+  after(:all) do
+    StubNetwork.unstub_command!(:realpath)
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  let(:directory) { '/home/ubuntu/dir' }
+
+  it 'prepares tar list command' do
+    ['list', 't'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'file.txt'), 
+        'tar --restrict -f file.txt -t'
+      )
+
+      expect_command(host.tar(action_variant, '~/file.txt', 
+          compress: 'bzip2',
+          directory: directory,
+          occurrence: 1,
+          label: true,
+          multi_volume: true
+        ), 
+        'tar --restrict -C /home/ubuntu/dir -f ~/file.txt -j -t --occurrence 1 --label --multi-volume'
+      )
+    end
+  end
+
+  it 'prepares tar extract command' do
+    ['extract', 'get', 'x'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'archive.tar'), 
+        'tar --restrict -f archive.tar -x'
+      )
+
+      expect_command(host.tar(action_variant, 'archive.tar',
+          compress: 'xz',
+          directory: directory,
+          occurrence: 2,
+          no_same_owner: true,
+          no_same_permissions: true,
+          no_selinux: true,
+          no_xattrs: true,
+          multi_volume: true,
+          label: true,
+          skip_old_files: true,
+          overwrite: true,
+          overwrite_dir: true,
+          unlink_first: true,
+          recursive_unlink: true,
+          paths: 'file.txt'
+        ), 
+        'tar --restrict -C /home/ubuntu/dir -f archive.tar -J -x --occurrence 2 --no-same-owner --no-same-permissions --no-selinux --no-xattrs --multi-volume --label --skip-old-files --overwrite --overwrite-dir --unlink-first --recursive-unlink file.txt'
+      )
+
+      expect_command(host.tar(action_variant, 'archive.tar',
+          preserve_permissions: true,
+          same_owners: true,
+          one_file_system: true,
+          keep_old_files: true,
+          paths: ['file1.txt', 'file2.txt']
+        ),
+        'tar --restrict -f archive.tar -x --preserve-permissions --same-owner --one-file-system --keep-old-files file1.txt file2.txt'
+      )
+    end
+  end
+
+  it 'prepares tar create command' do
+    ['create', 'c'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'archive.lzma', compress: 'lzma'), 'tar --restrict -f archive.lzma --lzma -c')
+      expect_command(host.tar(action_variant, 'archive.gz'), 'tar --restrict -f archive.gz -c') 
+
+      expect_command(host.tar(action_variant, 'archive.gz', 
+          directory: directory,
+          compress: 'gzip',
+          exclude: 'file2.txt',
+          paths: 'file1.txt' 
+        ),
+        'tar --restrict -C /home/ubuntu/dir -f archive.gz -z -c --exclude=file2.txt file1.txt'
+      )
+
+      expect_command(host.tar(action_variant, 'archive.gz', 
+          compress: 'gzip',
+          exclude: ['file2.txt', 'file4.txt'],
+          paths: ['file1.txt', 'file3.txt']
+        ),
+        'tar --restrict -f archive.gz -z -c --exclude=file2.txt --exclude=file4.txt file1.txt file3.txt'
+      )
+    end
+  end
+
+  it 'prepares tar append command' do
+    ['append', 'r'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'archive.tar'), 'tar --restrict -f archive.tar -r')
+
+      expect_command(host.tar(action_variant, 'archive.tar', 
+          directory: directory,
+          paths: 'main.conf'
+        ), 
+        'tar --restrict -C /home/ubuntu/dir -f archive.tar -r main.conf'
+      )
+
+      expect_command(host.tar(action_variant, 'archive.tar', 
+          paths: ['main.conf', 'main2.conf']
+        ), 
+        'tar --restrict -f archive.tar -r main.conf main2.conf'
+      ) 
+    end 
+  end
+
+  it 'prepares tar concat command' do
+    ['catenate', 'concat', 'A'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'archive.tar'), 'tar --restrict -f archive.tar -A')
+      expect_command(host.tar(action_variant, 'archive.tar',
+          directory: directory,
+          paths: 'archive2.tar'
+        ),
+        'tar --restrict -C /home/ubuntu/dir -f archive.tar -A archive2.tar'
+      )
+
+      expect_command(host.tar(action_variant, 'archive.tar',
+          directory: directory,
+          paths: ['archive2.tar', 'archive3.tar']
+        ),
+        'tar --restrict -C /home/ubuntu/dir -f archive.tar -A archive2.tar archive3.tar'
+      )
+    end
+  end
+
+  it 'prepares tar update command' do
+    ['update', 'u'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'archive',
+          paths: 'file1.txt'
+        ),
+        'tar --restrict -f archive -u file1.txt'
+      )
+
+      expect_command(host.tar(action_variant, 'archive',
+          directory: directory,
+          paths: ['file1.txt', 'file2.txt']
+        ),
+        'tar --restrict -C /home/ubuntu/dir -f archive -u file1.txt file2.txt'
+      )
+    end
+  end
+
+  it 'prepares tar diff command' do
+    ['diff', 'compare', 'd'].each do |action_variant|
+      expect_command(host.tar(action_variant, 'archive.tar', directory: directory), 'tar --restrict -C /home/ubuntu/dir -f archive.tar -d')
+      expect_command(host.tar(action_variant, 'archive.tar', 
+          directory: directory,
+          occurrence: 4
+        ), 
+        'tar --restrict -C /home/ubuntu/dir -f archive.tar -d --occurrence 4'
+      )
+    end
+  end
+
+  it 'prepares tar delete command' do
+    expect_command(host.tar('delete', 'archive.tar', paths: 'file1.txt'), 'tar --restrict -f archive.tar --delete file1.txt')
+    expect_command(host.tar('delete', 'archive.tar', 
+        paths: ['file1.txt', 'file2.txt'],
+        occurrence: 3
+      ), 
+      'tar --restrict -f archive.tar --delete --occurrence 3 file1.txt file2.txt'
+    )
+  end
+
+  it 'prepares invalid tar command' do
+    expect {
+      host.tar('abc', 'file1.txt')
+    }.to raise_error(ArgumentError)
+
+    expect {
+      host.tar('create', 'archive.tar', compress: 'xip')
+    }.to raise_error(ArgumentError)
+  end
+end

data/spec/functional/remote/env_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Remote::Env do
+
+  let (:env) { Kanrisuru::Remote::Env.new }
+
+  it 'adds a environment variable' do
+    env['VAR1'] = 'hello'
+    expect(env.count).to eq(1)
+    expect(env.to_h).to eq({'VAR1' => 'hello'})
+    expect(env.to_s).to eq('export VAR1=hello;')
+    expect(env['VAR1']).to eq('hello')
+  end
+
+  it 'adds multiple environment variables' do
+    env['var1'] = 'hello'
+    env['var2'] = 'world'
+
+    expect(env.count).to eq(2)
+    expect(env.to_h).to eq({'VAR1' => 'hello', 'VAR2' => 'world'})
+    expect(env.to_s).to eq('export VAR1=hello; export VAR2=world;')
+    expect(env['VAR1']).to eq('hello')
+    expect(env['VAR2']).to eq('world')
+  end
+
+  it 'deletes a variable' do
+    env[:var1] = 'foo'
+    expect(env.count).to eq(1)
+    expect(env[:var1]).to eq('foo')
+    env.delete(:var1)
+    expect(env.count).to eq(0)
+    expect(env.to_s).to eq('')
+  end
+
+  it 'clears the environment' do
+    env['VERSION'] = 1
+    env['SHELL'] = '/bin/zsh'
+    env['USER'] = 'ubuntu'
+    env['HOSTNAME'] = 'ubuntu'
+    expect(env.to_s).to eq('export VERSION=1; export SHELL=/bin/zsh; export USER=ubuntu; export HOSTNAME=ubuntu;')
+
+    expect(env.count).to eq(4)
+    env.clear
+
+    expect(env.count).to eq(0)
+  end
+
+end

data/spec/helper/stub_network.rb

@@ -45,6 +45,22 @@ class StubNetwork
       end
     end
 
+    def stub_command!(method, &block)
+      Kanrisuru::Remote::Host.class_eval do
+        alias_method "#{method}_alias", method
+
+        define_method(method) do |*args|
+          block.call(args)
+        end
+      end
+    end
+
+    def unstub_command!(method)
+      Kanrisuru::Remote::Host.class_eval do
+        alias_method method, "#{method}_alias"
+      end
+    end
+
     def unstub!
       Kanrisuru::Remote::Host.class_eval do
         alias_method :execute_with_retries, :execute_with_retries_alias

data/spec/unit/command_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Command do
+  it 'responds to methods' do
+    command = Kanrisuru::Command.new('ls')
+    expect(command).to respond_to(:exit_status)
+    expect(command).to respond_to(:raw_result)
+    expect(command).to respond_to(:program)
+    expect(command).to respond_to(:success?)
+    expect(command).to respond_to(:failure?)
+    expect(command).to respond_to(:to_i)
+    expect(command).to respond_to(:to_s)
+    expect(command).to respond_to(:to_a)
+    expect(command).to respond_to(:to_json)
+    expect(command).to respond_to(:prepared_command)
+    expect(command).to respond_to(:raw_command)
+    expect(command).to respond_to(:handle_status)
+    expect(command).to respond_to(:handle_data)
+    expect(command).to respond_to(:handle_signal)
+    expect(command).to respond_to(:+)
+    expect(command).to respond_to(:<<)
+    expect(command).to respond_to(:|)
+    expect(command).to respond_to(:pipe)
+    expect(command).to respond_to(:append_value)
+    expect(command).to respond_to(:append_arg)
+    expect(command).to respond_to(:append_flag)
+    expect(command).to respond_to(:append_valid_exit_code)
+  end
+end

data/spec/unit/mode_spec.rb

@@ -3,6 +3,18 @@
 require 'spec_helper'
 
 RSpec.describe Kanrisuru::Mode do
+  it 'responds to methods' do
+    mode = described_class.new('644')
+    expect(mode).to respond_to(:directory?)
+    expect(mode).to respond_to(:symbolic)
+    expect(mode).to respond_to(:symbolic=)
+    expect(mode).to respond_to(:numeric)
+    expect(mode).to respond_to(:numeric=)
+    expect(mode).to respond_to(:inspect)
+    expect(mode).to respond_to(:to_s)
+    expect(mode).to respond_to(:to_i)
+  end
+
   it 'parses int mode' do
     mode = described_class.new('644')
     expect(mode.directory?).to eq(false)
@@ -205,4 +217,23 @@ RSpec.describe Kanrisuru::Mode do
     mode.symbolic = '-w'
     expect(mode.symbolic).to eq('---xr-xr--')
   end
+
+  context Kanrisuru::Mode::Permission do
+    it 'responds to methods' do
+      mode = Kanrisuru::Mode::Permission.new('644', 'rw-rw-r--')
+      expect(mode).to respond_to(:to_i)
+      expect(mode).to respond_to(:to_s)
+      expect(mode).to respond_to(:all?)
+      expect(mode).to respond_to(:numeric)
+      expect(mode).to respond_to(:numeric=)
+      expect(mode).to respond_to(:symbolic=)
+      expect(mode).to respond_to(:symbolic)
+      expect(mode).to respond_to(:read=)
+      expect(mode).to respond_to(:read?)
+      expect(mode).to respond_to(:write=)
+      expect(mode).to respond_to(:write?)
+      expect(mode).to respond_to(:execute=)
+      expect(mode).to respond_to(:execute?)
+    end
+  end
 end

data/spec/unit/remote/env_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Remote::Env do
+
+  it 'responds to methods' do
+    env = Kanrisuru::Remote::Env.new
+    expect(env).to respond_to(:to_h)
+    expect(env).to respond_to(:to_s)
+    expect(env).to respond_to(:clear)
+    expect(env).to respond_to(:count)
+    expect(env).to respond_to(:count)
+    expect(env).to respond_to(:delete)
+    expect(env).to respond_to(:[])
+    expect(env).to respond_to(:[]=)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -189,6 +189,7 @@ files:
 - lib/kanrisuru/util/signal.rb
 - lib/kanrisuru/version.rb
 - spec/functional/core/apt_spec.rb
+- spec/functional/core/archive_spec.rb
 - spec/functional/core/find_spec.rb
 - spec/functional/core/path_spec.rb
 - spec/functional/core/socket_spec.rb
@@ -196,8 +197,8 @@ files:
 - spec/functional/core/stream_spec.rb
 - spec/functional/core/transfer_spec.rb
 - spec/functional/core/yum_spec.rb
-- spec/functional/os_package_spec.rb
 - spec/functional/remote/cluster_spec.rb
+- spec/functional/remote/env_spec.rb
 - spec/helper/expect_helpers.rb
 - spec/helper/stub_network.rb
 - spec/helper/test_hosts.rb
@@ -219,6 +220,7 @@ files:
 - spec/integration/core/user_spec.rb
 - spec/integration/core/yum_spec.rb
 - spec/integration/core/zypper_spec.rb
+- spec/integration/os_package_spec.rb
 - spec/integration/remote/cluster_spec.rb
 - spec/integration/remote/cpu_spec.rb
 - spec/integration/remote/env_spec.rb
@@ -228,6 +230,7 @@ files:
 - spec/integration/remote/os_spec.rb
 - spec/integration/remote/remote_file_spec.rb
 - spec/spec_helper.rb
+- spec/unit/command_spec.rb
 - spec/unit/core/apt_spec.rb
 - spec/unit/core/archive_spec.rb
 - spec/unit/core/disk_spec.rb
@@ -248,6 +251,7 @@ files:
 - spec/unit/mode_spec.rb
 - spec/unit/remote/cluster_spec.rb
 - spec/unit/remote/cpu_spec.rb
+- spec/unit/remote/env_spec.rb
 - spec/unit/remote/fstab_spec.rb
 - spec/unit/template_spec.rb
 - spec/unit/util_spec.rb