kanrisuru 0.14.0 → 0.15.0

data/lib/kanrisuru/core/ip/commands/route.rb

@@ -6,109 +6,146 @@ module Kanrisuru
       def ip_route(action, opts)
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-          command.append_arg('-family', opts[:family])
-          command << 'route show'
-
-          command.append_arg('to', opts[:to])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('proto', opts[:proto])
-          command.append_arg('type', opts[:type])
-          command.append_arg('via', opts[:via])
-          command.append_arg('src', opts[:src])
-          command.append_arg('realms', opts[:realms])
+          version = ip_version.to_i
+          command = ip_route_show(opts, version)
         when 'flush'
-          command = Kanrisuru::Command.new('ip')
-          command.append_arg('-family', opts[:family])
-          command << 'route flush'
-
-          command.append_arg('to', opts[:to])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('proto', opts[:proto])
-          command.append_arg('type', opts[:type])
-          command.append_arg('via', opts[:via])
-          command.append_arg('src', opts[:src])
-          command.append_arg('realm', opts[:realm])
-          command.append_arg('realms', opts[:realm])
-        when 'add', 'change', 'append', 'del', 'delete'
-          command = Kanrisuru::Command.new('ip route')
-          command << action
-
-          command.append_arg('to', opts[:to])
-          command.append_arg('tos', opts[:tos])
-          command.append_arg('dsfield', opts[:dsfield])
-          command.append_arg('metric', opts[:metric])
-          command.append_arg('preference', opts[:preference])
-          command.append_arg('table', opts[:table])
-          command.append_arg('vrf', opts[:vrf])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('via', opts[:via])
-          command.append_arg('src', opts[:src])
-          command.append_arg('realm', opts[:realm])
-
-          command.append_arg('mtu', opts[:mtu])
-          command.append_arg('window', opts[:window])
-          command.append_arg('rtt', opts[:rtt])
-          command.append_arg('rttvar', opts[:rttvar])
-          command.append_arg('rto_min', opts[:rto_min])
-          command.append_arg('ssthresh', opts[:ssthresh])
-          command.append_arg('cwnd', opts[:cwnd])
-          command.append_arg('initcwnd', opts[:initcwnd])
-          command.append_arg('initrwnd', opts[:initrwnd])
-          command.append_arg('features', opts[:features])
-          command.append_arg('quickack', opts[:quickack])
-          command.append_arg('fastopen_no_cookie', opts[:fastopen_no_cookie])
-
-          if Kanrisuru::Util.present?(opts[:congctl])
-            if Kanrisuru::Util.present?(opts[:congctl_lock])
-              command.append_arg('congctl', opts[:congctl])
-            else
-              command.append_arg('congctl lock', opts[:congctl])
-            end
-          end
+          command = ip_route_flush(opts)
+        when 'add', 'change', 'append', 'del', 'delete', 'replace'
+          command = ip_route_modify(action, opts)
+        when 'get'
+          command = ip_route_get(opts)
+        end
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Route.parse(cmd, action, version)
+        end
+      end
+
+      def ip_route_show(opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+        command.append_arg('-family', opts[:family])
+        command << 'route show'
+
+        ip_route_common_opts(command, opts)
+
+        command
+      end
 
-          command.append_arg('advmss', opts[:advmss])
-          command.append_arg('reordering', opts[:reordering])
+      def ip_route_modify(action, opts)
+        command = Kanrisuru::Command.new('ip route')
+        command << action
 
-          if Kanrisuru::Util.present?(opts[:next_hop])
-            next_hop = opts[:next_hop]
+        command.append_arg('to', opts[:to])
+        command.append_arg('tos', opts[:tos])
+        command.append_arg('dsfield', opts[:dsfield])
+        command.append_arg('metric', opts[:metric])
+        command.append_arg('preference', opts[:preference])
+        command.append_arg('table', opts[:table])
+        command.append_arg('vrf', opts[:vrf])
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('via', opts[:via])
+        command.append_arg('src', opts[:src])
+        command.append_arg('realm', opts[:realm])
 
-            command << 'next_hop'
-            command.append_arg('via', next_hop[:via])
-            command.append_arg('dev', next_hop[:dev])
-            command.append_arg('weight', next_hop[:weight])
+        if Kanrisuru::Util.present?(opts[:mtu])
+          if Kanrisuru::Util.present?(opts[:mtu_lock])
+            command.append_arg('mtu lock', opts[:mtu])
+          else
+            command.append_arg('mtu', opts[:mtu])
           end
+        end
 
-          command.append_arg('scope', opts[:scope])
-          command.append_arg('protocol', opts[:protocol])
-          command.append_flag('onlink', opts[:onlink])
-          command.append_arg('pref', opts[:pref])
-        when 'get'
-          command = Kanrisuru::Command.new('ip route get')
-
-          command.append_arg('to', opts[:to])
-          command.append_arg('from', opts[:from])
-          command.append_arg('tos', opts[:tos])
-          command.append_arg('dsfield', opts[:dsfield])
-          command.append_arg('iif', opts[:iif])
-          command.append_arg('oif', opts[:oif])
-          command.append_arg('mark', opts[:mark])
-          command.append_arg('vrf', opts[:vrf])
-          command.append_arg('ipproto', opts[:ipproto])
-          command.append_arg('sport', opts[:sport])
-          command.append_arg('dport', opts[:dport])
-
-          command.append_flag('connected', opts[:connected])
+        command.append_arg('window', opts[:window])
+        command.append_arg('rtt', opts[:rtt])
+        command.append_arg('rttvar', opts[:rttvar])
+        command.append_arg('rto_min', opts[:rto_min])
+        command.append_arg('ssthresh', opts[:ssthresh])
+        command.append_arg('cwnd', opts[:cwnd])
+        command.append_arg('initcwnd', opts[:initcwnd])
+        command.append_arg('initrwnd', opts[:initrwnd])
+        command.append_arg('features', opts[:features])
+        command.append_arg('quickack', opts[:quickack])
+        command.append_arg('fastopen_no_cookie', opts[:fastopen_no_cookie])
+
+        if Kanrisuru::Util.present?(opts[:congctl])
+          if Kanrisuru::Util.present?(opts[:congctl_lock])
+            command.append_arg('congctl lock', opts[:congctl])
+          else
+            command.append_arg('congctl', opts[:congctl])
+          end
         end
 
-        execute_shell(command)
+        command.append_arg('advmss', opts[:advmss])
+        command.append_arg('reordering', opts[:reordering])
 
-        Kanrisuru::Result.new(command) do |cmd|
-          Parser::Route.parse(cmd, action, version)
+        if Kanrisuru::Util.present?(opts[:next_hop])
+          next_hop = opts[:next_hop]
+
+          command << 'next_hop'
+          command.append_arg('via', next_hop[:via])
+          command.append_arg('dev', next_hop[:dev])
+          command.append_arg('weight', next_hop[:weight])
         end
+
+        command.append_arg('scope', opts[:scope])
+        command.append_arg('protocol', opts[:protocol])
+        command.append_flag('onlink', opts[:onlink])
+        command.append_arg('pref', opts[:pref])
+        command.append_arg('nhid', opts[:nhid])
+        command
+      end
+
+      def ip_route_flush(opts)
+        command = Kanrisuru::Command.new('ip')
+        command.append_arg('-family', opts[:family])
+        command << 'route flush'
+
+        ip_route_common_opts(command, opts)
+
+        command
+      end
+
+      def ip_route_get(opts)
+        command = Kanrisuru::Command.new('ip route get')
+
+        command.append_flag('fibmatch', opts[:fibmatch])
+        command.append_arg('to', opts[:to])
+        command.append_arg('from', opts[:from])
+        command.append_arg('tos', opts[:tos])
+        command.append_arg('dsfield', opts[:dsfield])
+        command.append_arg('iif', opts[:iif])
+        command.append_arg('oif', opts[:oif])
+        command.append_arg('mark', opts[:mark])
+        command.append_arg('vrf', opts[:vrf])
+        command.append_arg('ipproto', opts[:ipproto])
+        command.append_arg('sport', opts[:sport])
+        command.append_arg('dport', opts[:dport])
+
+        command.append_flag('connected', opts[:connected])
+        command
+      end
+
+      def ip_route_common_opts(command, opts)
+        command.append_arg('to', opts[:to])
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('protocol', opts[:protocol])
+        command.append_arg('type', opts[:type])
+        command.append_arg('table', opts[:table])
+        command.append_arg('tos', opts[:tos])
+        command.append_arg('dsfield', opts[:dsfield])
+        command.append_arg('via', opts[:via])
+        command.append_arg('vrf', opts[:vrf])
+        command.append_arg('src', opts[:src])
+
+        command.append_arg('realm', opts[:realm])
+        command.append_arg('realms', opts[:realms])
+        command.append_arg('scope', opts[:scope])
+
+        command.append_flag('cloned', opts[:cloned])
+        command.append_flag('cached', opts[:cached])
       end
     end
   end

data/lib/kanrisuru/core/ip/commands/rule.rb

@@ -6,29 +6,12 @@ module Kanrisuru
       def ip_rule(action, opts)
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-
-          command << 'rule show'
+          version = ip_version.to_i
+          command = ip_rule_show(opts, version)
         when 'flush'
-          command = Kanrisuru::Command.new('ip rule flush')
-        when 'add', 'delete'
-          command = Kanrisuru::Command.new('ip rule')
-          command << action
-
-          command.append_arg('type', opts[:type])
-          command.append_arg('from', opts[:from])
-          command.append_arg('to', opts[:to])
-          command.append_arg('iif', opts[:iif])
-          command.append_arg('tos', opts[:tos])
-          command.append_arg('dsfield', opts[:dsfield])
-          command.append_arg('fwmark', opts[:fwmark])
-          command.append_arg('priority', opts[:priority])
-          command.append_arg('table', opts[:table])
-          command.append_arg('realms', opts[:realms])
-          command.append_arg('nat', opts[:nat])
+          command = ip_rule_flush(opts)
+        when 'add', 'delete', 'del'
+          command = ip_rule_modify(action, opts)
         end
 
         execute_shell(command)
@@ -37,6 +20,38 @@ module Kanrisuru
           Parser::Rule.parse(cmd, action, version)
         end
       end
+
+      def ip_rule_modify(action, opts)
+        command = Kanrisuru::Command.new('ip rule')
+        command << action
+
+        command.append_arg('type', opts[:type])
+        command.append_arg('from', opts[:from])
+        command.append_arg('to', opts[:to])
+        command.append_arg('iif', opts[:iif])
+        command.append_arg('tos', opts[:tos])
+        command.append_arg('dsfield', opts[:dsfield])
+        command.append_arg('fwmark', opts[:fwmark])
+        command.append_arg('priority', opts[:priority])
+        command.append_arg('table', opts[:table])
+        command.append_arg('realms', opts[:realms])
+        command.append_arg('nat', opts[:nat])
+        command
+      end
+
+      def ip_rule_flush(opts)
+        command = Kanrisuru::Command.new('ip rule flush')
+        command.append_arg('protocol', opts[:protocol])
+        command
+      end
+
+      def ip_rule_show(_opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+
+        command << 'rule show'
+        command
+      end
     end
   end
 end

data/lib/kanrisuru/core/ip/commands.rb

@@ -2,6 +2,8 @@
 
 require_relative 'commands/address'
 require_relative 'commands/address_label'
+require_relative 'commands/link_type_opts'
+require_relative 'commands/link_set_opts'
 require_relative 'commands/link'
 require_relative 'commands/maddress'
 require_relative 'commands/neighbour'
@@ -15,9 +17,9 @@ module Kanrisuru
         command = Kanrisuru::Command.new('ip -V')
         execute_shell(command)
 
-        raise 'ip command not found' if command.failure?
-
-        command.to_s.split('ip utility, iproute2-ss')[1].to_i
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Version.parse(cmd)
+        end
       end
     end
   end

data/lib/kanrisuru/core/ip/constants.rb

@@ -4,10 +4,22 @@ module Kanrisuru
   module Core
     module IP
       IPROUTE2_JSON_VERSION = 180_129
+
       IP_ROUTE_TYPES = %w[
         unicast unreachable blackhole prohibit local
         broadcast throw nat via anycast multicast
       ].freeze
+
+      IP_FAMILIES = %w[inet inet6 link].freeze
+      IP_SCOPES = %w[global site link host].freeze
+      IP_LINK_TYPES = %w[
+        vlan veth vcan vxcan dummy ifb macvlan macvtap
+        bridge bond team ipoib ip6tnl ipip sit vxlan
+        gre gretap erspan ip6gre ip6gretap ip6erspan
+        vti nlmon team_slave bond_slave bridge_slave
+        ipvlan ipvtap geneve vrf macsec netdevsim rmnet
+        xfrm bareudp hsr
+      ].freeze
     end
   end
 end

data/lib/kanrisuru/core/ip/parser.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'parsers/base'
+require_relative 'parsers/version'
 require_relative 'parsers/address'
 require_relative 'parsers/address_label'
 require_relative 'parsers/link'

data/lib/kanrisuru/core/ip/parsers/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module IP
+      module Parser
+        class Version < Base
+          def self.parse(command)
+            command.to_s.split('ip utility, iproute2-ss')[1].to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/ip.rb

@@ -16,25 +16,28 @@ module Kanrisuru
 
       def ip(object, action = nil, opts = {})
         if action.instance_of?(Hash)
-          opts = action
+          opts = action || {}
           action = 'show'
+        elsif action.nil?
+          action = 'show'
+          opts = {}
         end
 
         case object
-        when 'link', 'l'
-          ip_link(action, opts)
         when 'address', 'addr', 'a'
           ip_address(action, opts)
         when 'addrlabel', 'addrl'
           ip_address_label(action, opts)
+        when 'link', 'l'
+          ip_link(action, opts)
+        when 'maddress', 'maddr', 'm'
+          ip_maddress(action, opts)
+        when 'neighbour', 'neigh', 'n'
+          ip_neighbour(action, opts)
         when 'route', 'r', 'ro', 'rou', 'rout'
           ip_route(action, opts)
         when 'rule', 'ru'
           ip_rule(action, opts)
-        when 'neighbour', 'neigh', 'n'
-          ip_neighbour(action, opts)
-        when 'maddress', 'maddr', 'm'
-          ip_maddress(action, opts)
         end
       end
     end

data/lib/kanrisuru/version.rb

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

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

@@ -0,0 +1,81 @@
+# 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[addrlabel addrl].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 addrlabel list')
+          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, action_variant), 'ip addrlabel list')
+          end
+        end
+      end
+
+      it 'prepares flush command' do
+        expect_command(host.ip(object_variant, 'flush'), 'ip addrlabel flush')
+      end
+
+      it 'prepares add command' do
+        expect_command(host.ip(object_variant, 'add', {
+                                 prefix: '0.0.0.0/96',
+                                 dev: 'eno2',
+                                 label: 'eno2'
+                               }), 'ip addrlabel add prefix 0.0.0.0/96 dev eno2 label eno2')
+      end
+
+      it 'prepares del command' do
+        expect_command(host.ip(object_variant, 'del', {
+                                 prefix: '0.0.0.0/96',
+                                 dev: 'eno2',
+                                 label: 'eno2'
+                               }), 'ip addrlabel del prefix 0.0.0.0/96 dev eno2 label eno2')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# 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[address addr a].each do |object_variant|
+    context "with ip #{object_variant}" 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 address show')
+          expect_command(host.ip(object_variant, action_variant, {
+                                   stats: true,
+                                   family: 'inet',
+                                   dev: 'lo',
+                                   scope: 'host',
+                                   prefix: '127.0.0.1',
+                                   label: 'lo'
+                                 }), 'ip -json -s -family inet address show dev lo scope host to 127.0.0.1 label lo')
+
+          expect_command(host.ip(object_variant, action_variant, {
+                                   dynamic: true,
+                                   permanent: true,
+                                   deprecated: true,
+                                   primary: true,
+                                   secondary: true,
+                                   up: true
+                                 }), 'ip -json address show dynamic permanent deprecated primary secondary up')
+        end
+      end
+
+      it 'prepares add command' do
+        expect_command(host.ip(object_variant, 'add', {
+                                 address: '10.0.0.1',
+                                 dev: 'eno1',
+                                 label: 'eno1',
+                                 scope: 'link'
+                               }), 'ip address add 10.0.0.1 dev eno1 label eno1 scope link')
+      end
+
+      %w[del delete].each do |action_variant|
+        it "prepares #{action_variant} command" do
+          expect_command(host.ip(object_variant, action_variant, {
+                                   address: '10.0.0.1',
+                                   dev: 'eno1',
+                                   label: 'eno1',
+                                   scope: 'link'
+                                 }), 'ip address del 10.0.0.1 dev eno1 label eno1 scope link')
+        end
+      end
+
+      it 'prepares flush command' do
+        expect_command(host.ip(object_variant, 'flush', {
+                                 dev: 'eno1',
+                                 scope: 'link',
+                                 prefix: 'eno1',
+                                 label: 'eno1'
+                               }), 'ip address flush dev eno1 scope link to eno1 label eno1')
+
+        expect_command(host.ip(object_variant, 'flush', {
+                                 dynamic: true,
+                                 permanent: true,
+                                 deprecated: true,
+                                 primary: true,
+                                 secondary: true
+                               }), 'ip address flush dynamic permanent deprecated primary secondary')
+      end
+    end
+  end
+end