kanrisuru 0.12.0 → 0.15.0

data/spec/functional/core/ip/ip_maddress_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::IP do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  %w[maddress maddr m].each do |object_variant|
+    context "with ip #{object_variant}" do
+      context 'with json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant, action_variant), 'ip -json maddress show')
+            expect_command(host.ip(object_variant, action_variant, {
+                                     dev: 'eth0',
+                                     family: 'inet'
+                                   }), 'ip -json -family inet maddress show dev eth0')
+          end
+        end
+      end
+
+      context 'without json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION - 23
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant, action_variant), 'ip maddress show')
+            expect_command(host.ip(object_variant, action_variant, {
+                                     dev: 'eth0',
+                                     family: 'inet'
+                                   }), 'ip -family inet maddress show dev eth0')
+          end
+        end
+      end
+
+      %w[add delete del].each do |action_variant|
+        it "prepares #{action_variant} command" do
+          expect_command(host.ip(object_variant, action_variant, {
+                                   address: '01:80:c2:00:00:0e',
+                                   dev: 'eth0'
+                                 }), "ip maddress #{action_variant} address 01:80:c2:00:00:0e dev eth0")
+        end
+      end
+    end
+  end
+end

data/spec/functional/core/ip/ip_neighbour_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::IP do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  %w[neighbour neigh n].each do |object_variant|
+    context "with ip #{object_variant}" do
+      context 'with json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant), 'ip -json neighbour show')
+            expect_command(host.ip(object_variant, {
+                                     stats: true,
+                                     to: '10.10.10.10',
+                                     dev: 'ens3',
+                                     vrf: 'red',
+                                     proxy: true,
+                                     unused: true,
+                                     nud: 'all'
+                                   }), 'ip -json -s neighbour show to 10.10.10.10 dev ens3 nud all proxy unused')
+          end
+        end
+      end
+
+      context 'without json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION - 10
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant), 'ip neighbour show')
+            expect_command(host.ip(object_variant, {
+                                     stats: true,
+                                     to: '10.10.10.10',
+                                     dev: 'ens3',
+                                     vrf: 'red',
+                                     proxy: true,
+                                     unused: true,
+                                     nud: 'all'
+                                   }), 'ip -s neighbour show to 10.10.10.10 dev ens3 nud all proxy unused')
+          end
+        end
+      end
+
+      %w[add change replace].each do |action_variant|
+        it "prepares #{action_variant} command" do
+          expect_command(host.ip(object_variant, action_variant, {
+                                   to: '192.168.16.14',
+                                   dev: 'eno1',
+                                   proxy: true,
+                                   router: true,
+                                   extern_learn: true,
+                                   permanent: true,
+                                   nud: 'probe',
+                                   lladdr: '17:39:D1:24:53:CF'
+                                 }), "ip neighbour #{action_variant} to 192.168.16.14 dev eno1 lladdr 17:39:D1:24:53:CF nud probe proxy router extern_learn")
+        end
+      end
+
+      %w[delete del].each do |action_variant|
+        it "prepares #{action_variant} command" do
+          expect_command(host.ip(object_variant, action_variant, {
+                                   to: '192.168.16.14',
+                                   dev: 'eno1',
+                                   proxy: true,
+                                   router: true,
+                                   extern_learn: true,
+                                   permanent: true
+                                 }), "ip neighbour #{action_variant} to 192.168.16.14 dev eno1 proxy router extern_learn")
+        end
+      end
+
+      it 'prepares flush command' do
+        expect_command(host.ip(object_variant, 'flush', {
+                                 stats: true,
+                                 to: '10.10.10.10',
+                                 dev: 'ens3',
+                                 vrf: 'red',
+                                 proxy: true,
+                                 unused: true,
+                                 nud: 'all'
+                               }), 'ip -s neighbour flush to 10.10.10.10 dev ens3 nud all unused')
+      end
+    end
+  end
+end

data/spec/functional/core/ip/ip_route_spec.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::IP do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  %w[route r ro rou rout].each do |object_variant|
+    context "with ip #{object_variant}" do
+      context 'with json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant), 'ip -json route show')
+            expect_command(host.ip(object_variant, {
+                                     family: 'inet',
+                                     to: '10.0/16',
+                                     from: '10.1/16',
+                                     dev: 'eno4',
+                                     protocol: 'kernel',
+                                     dsfield: '0x30',
+                                     table: 'all',
+                                     vrf: 'blue',
+                                     cloned: true,
+                                     cached: true,
+                                     via: '10.0.0.1',
+                                     src: '10.5.5.5',
+                                     realms: '6'
+                                   }), 'ip -json -family inet route show to 10.0/16 dev eno4 protocol kernel table all dsfield 0x30 via 10.0.0.1 vrf blue src 10.5.5.5 realms 6 cloned cached')
+          end
+        end
+      end
+
+      context 'without json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION - 33
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant), 'ip route show')
+            expect_command(host.ip(object_variant, {
+                                     family: 'inet',
+                                     to: '10.0/16',
+                                     from: '10.1/16',
+                                     dev: 'eno4',
+                                     protocol: 'kernel',
+                                     dsfield: '0x30',
+                                     table: 'all',
+                                     vrf: 'blue',
+                                     cloned: true,
+                                     cached: true,
+                                     via: '10.0.0.1',
+                                     src: '10.5.5.5',
+                                     realms: '6'
+                                   }), 'ip -family inet route show to 10.0/16 dev eno4 protocol kernel table all dsfield 0x30 via 10.0.0.1 vrf blue src 10.5.5.5 realms 6 cloned cached')
+          end
+        end
+      end
+
+      %w[add change append del delete replace].each do |action_variant|
+        it "prepares #{action_variant} command" do
+          expect_command(host.ip(object_variant, action_variant, {
+                                   dev: 'eno2',
+                                   mtu: 1600,
+                                   congctl: 'test'
+                                 }), "ip route #{action_variant} dev eno2 mtu 1600 congctl test")
+
+          expect_command(host.ip(object_variant, action_variant, {
+                                   to: '0/0',
+                                   tos: '0x28',
+                                   dsfield: '0x98',
+                                   metric: 32,
+                                   table: 254,
+                                   vrf: 'green',
+                                   src: '172.3.3.3',
+                                   realm: '6',
+                                   mtu: 1600,
+                                   mtu_lock: true,
+                                   window: 3,
+                                   rtt: 4,
+                                   rttvar: 12,
+                                   rto_min: 1,
+                                   sshthresh: 0,
+                                   cwnd: 12,
+                                   initcwnd: 5,
+                                   initrwnd: 5,
+                                   features: 'ecn',
+                                   quickack: 'true',
+                                   fastopen_no_cookie: 'true',
+                                   congctl: 'test',
+                                   congctl_lock: true,
+                                   advmss: 7,
+                                   reordering: 3,
+                                   next_hop: {
+                                     via: '172.0.0.0',
+                                     dev: 'gateway',
+                                     weight: 100
+                                   },
+                                   scope: 0,
+                                   protocol: 'static',
+                                   onlink: true,
+                                   pref: 'high'
+                                 }), "ip route #{action_variant} to 0/0 tos 0x28 dsfield 0x98 metric 32 table 254 vrf green src 172.3.3.3 realm 6 mtu lock 1600 window 3 rtt 4 rttvar 12 rto_min 1 cwnd 12 initcwnd 5 initrwnd 5 features ecn quickack true fastopen_no_cookie true congctl lock test advmss 7 reordering 3 next_hop via 172.0.0.0 dev gateway weight 100 scope 0 protocol static onlink pref high")
+        end
+      end
+
+      it 'prepares flush command' do
+        expect_command(host.ip(object_variant, 'flush', {
+                                 family: 'inet',
+                                 to: '10.0/16',
+                                 from: '10.1/16',
+                                 dev: 'eno4',
+                                 protocol: 'kernel',
+                                 dsfield: '0x30',
+                                 table: 'all',
+                                 vrf: 'blue',
+                                 cloned: true,
+                                 cached: true,
+                                 via: '10.0.0.1',
+                                 src: '10.5.5.5',
+                                 realms: '6'
+                               }), 'ip -family inet route flush to 10.0/16 dev eno4 protocol kernel table all dsfield 0x30 via 10.0.0.1 vrf blue src 10.5.5.5 realms 6 cloned cached')
+      end
+
+      it 'prepares get command' do
+        expect_command(host.ip(object_variant, 'get', {
+                                 dev: 'eth1',
+                                 to: '10.0/16',
+                                 from: '10.1/16',
+                                 fibmatch: true,
+                                 tos: '0x28',
+                                 dsfield: '0x30',
+                                 iif: 'eth0',
+                                 oif: 'eth1',
+                                 mark: '0x20',
+                                 ipproto: 'tcp',
+                                 dport: 80,
+                                 sport: 80,
+                                 connected: true
+                               }), 'ip route get fibmatch to 10.0/16 from 10.1/16 tos 0x28 dsfield 0x30 iif eth0 oif eth1 mark 0x20 ipproto tcp sport 80 dport 80 connected')
+      end
+    end
+  end
+end

data/spec/functional/core/ip/ip_rule_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::IP do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  %w[rule ru].each do |object_variant|
+    context "with ip #{object_variant}" do
+      context 'with json support' do
+        before(:all) do
+          StubNetwork.stub_command!(:ip_version) do
+            Kanrisuru::Core::IP::IPROUTE2_JSON_VERSION
+          end
+        end
+
+        after(:all) do
+          StubNetwork.unstub_command!(:ip_version)
+        end
+
+        %w[show list].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant, action_variant), 'ip -json rule show')
+          end
+        end
+
+        %w[add delete del].each do |action_variant|
+          it "prepares #{action_variant} command" do
+            expect_command(host.ip(object_variant, action_variant, {
+                                     type: 'unicast',
+                                     from: '0/0',
+                                     to: '0/0',
+                                     iif: 'eth0',
+                                     oif: 'eth1',
+                                     tos: '0x28',
+                                     dsfield: '0x30',
+                                     fwmark: 2,
+                                     uidrange: '1-10',
+                                     ipproto: 'tcp',
+                                     sport: 80,
+                                     dport: 80,
+                                     priority: 1,
+                                     table: 5,
+                                     protocol: 'kernel',
+                                     suppress_prefixlength: 8,
+                                     suppress_ifgroup: 6,
+                                     realms: '1',
+                                     nat: '10.1.1.1'
+                                   }), "ip rule #{action_variant} type unicast from 0/0 to 0/0 iif eth0 tos 0x28 dsfield 0x30 fwmark 2 priority 1 table 5 realms 1 nat 10.1.1.1")
+          end
+        end
+
+        it 'prepares flush command' do
+          expect_command(host.ip(object_variant, 'flush', {
+                                   protocol: 'kernel'
+                                 }), 'ip rule flush protocol kernel')
+        end
+      end
+    end
+  end
+end

data/spec/functional/core/ip/ip_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::IP do
+  before(:all) do
+    StubNetwork.stub!
+  end
+
+  after(:all) do
+    StubNetwork.unstub!
+  end
+
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu',
+      keys: ['id_rsa']
+    )
+  end
+
+  context 'with ip version' do
+    it 'prepares ip_version command' do
+      expect_command(host.ip_version, 'ip -V')
+    end
+  end
+end

data/spec/functional/result_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Result do
+  let(:command) { Kanrisuru::Command.new('hello') }
+
+  it 'initializes result' do
+    command.handle_status(0)
+
+    result = described_class.new(command)
+    expect(result).to be_instance_of(described_class)
+  end
+
+  it 'initializes with block and return struct fields' do
+    command.handle_status(0)
+    command.handle_data('world')
+
+    result = described_class.new(command) do |cmd|
+      Struct.new(:output).new(cmd.to_s)
+    end
+
+    expect(result).to respond_to(:output)
+    expect(result[:output]).to eq('world')
+    expect(result.data.output).to eq('world')
+  end
+
+  it 'is success from command' do
+    command.handle_status(0)
+    result = described_class.new(command)
+    expect(result).to be_success
+  end
+
+  it 'is failure from command' do
+    command.handle_status(1)
+    result = described_class.new(command)
+    expect(result).to be_failure
+  end
+
+  it 'returns exit status' do
+    command.handle_status(0)
+    result = described_class.new(command)
+    expect(result.status).to eq(0)
+
+    command.handle_status(1)
+
+    result = described_class.new(command)
+    expect(result.status).to eq(1)
+  end
+
+  it 'returns to_s on string result' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      'output'
+    end
+
+    expect(result.to_s).to eq('output')
+  end
+
+  it 'returns to_a on array result' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      [0, 1, 2, 3]
+    end
+
+    expect(result.to_a).to eq([0, 1, 2, 3])
+  end
+
+  it 'returns to_a on non-array result' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      'output'
+    end
+
+    expect(result.to_a).to eq(['output'])
+  end
+
+  it 'returns to_i on integer return value' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      55
+    end
+
+    expect(result.to_i).to eq(55)
+  end
+
+  it 'returns to_i on non-integer return value' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      '100'
+    end
+
+    expect(result.to_i).to eq(100)
+
+    result = described_class.new(command) do |_cmd|
+      'hello'
+    end
+
+    expect(result.to_i).to eq(0)
+
+    result = described_class.new(command) do |_cmd|
+      [0, 1, 2, 3]
+    end
+
+    expect(result.to_i).to eq([0, 1, 2, 3])
+
+    result = described_class.new(command) do |_cmd|
+      %w[0 1 2 3]
+    end
+
+    expect(result.to_i).to eq([0, 1, 2, 3])
+
+    result = described_class.new(command)
+    expect(result.to_i).to be_nil
+  end
+
+  it 'raises error on to_i for invalid data type' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      { 'hello' => 'world' }
+    end
+
+    expect do
+      result.to_i
+    end.to raise_error(NoMethodError)
+  end
+
+  it 'returns success string variant on inspect' do
+    command.handle_status(0)
+    result = described_class.new(command) do |_cmd|
+      'hello'
+    end
+
+    expect(result.inspect).to eq(
+      "#<Kanrisuru::Result:0x#{result.object_id} @status=0 @data=\"hello\" @command=#{command.prepared_command}>"
+    )
+  end
+
+  it 'returns error string variant on inspect' do
+    command.handle_status(1)
+    command.handle_data('error: this is an error')
+    result = described_class.new(command) do |_cmd|
+      'hello'
+    end
+
+    expect(result.inspect).to eq(
+      "#<Kanrisuru::Result:0x#{result.object_id} @status=1 @error=[\"error: this is an error\"] @command=#{command.prepared_command}>"
+    )
+  end
+end

data/spec/helper/simplecov.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov-cobertura'
+
+SimpleCov.start do
+  command_name "kanrisuru-tests#{ENV['TEST_ENV_NUMBER'] || ''}"
+  merge_timeout 2400
+
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+                                                       SimpleCov::Formatter::HTMLFormatter,
+                                                       SimpleCov::Formatter::CoberturaFormatter
+                                                     ])
+end
+
+if ENV['TEST_ENV_NUMBER'] # parallel specs
+  SimpleCov.at_exit do
+    result = SimpleCov.result
+    result.format! if ParallelTests.number_of_running_processes <= 1
+  end
+end

data/spec/helper/test_hosts.rb

@@ -10,7 +10,7 @@ class TestHosts
         next if opts[:only] && !only?(opts, os_name)
 
         host_json = TestHosts.host(os_name)
-        spec_dir = spec_dir(os_name, host_json)
+        spec_dir = spec_dir(host_json)
 
         block.call(os_name, host_json, spec_dir)
       end
@@ -20,7 +20,7 @@ class TestHosts
       hosts(name)
     end
 
-    def spec_dir(os_name, host_json)
+    def spec_dir(host_json)
       random_string = SecureRandom.hex
       "#{host_json['home']}/.kanrisuru_spec_files_#{random_string[0..5]}"
     end
@@ -66,7 +66,7 @@ class TestHosts
     end
 
     def hosts_list
-      json_config_path = File.join('spec', 'hosts.json')
+      json_config_path = File.join('spec', 'helper', 'hosts.json')
       hosts_data = File.open(json_config_path).read
       JSON.parse(hosts_data)
     end

data/spec/integration/core/apt/debian_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+TestHosts.each_os(only: %w[debian]) do |os_name, host_json, spec_dir|
+  RSpec.describe Kanrisuru::Core::Apt do
+    include_examples 'apt', os_name, host_json, spec_dir
+  end
+end