kanrisuru 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29120990eb0245c731d92af7b9905b1357309e157938274f87032ead18230c42
-  data.tar.gz: 03a75d2d70f1aa5f72f1c9d2039e9f4002d06ca13eb0ad8b67d7e60e41a9a2e4
+  metadata.gz: e77a2eee0eb08495f947f9dc3b130a7c47cd713ab2f970dcc8fd17b7b52cd8b3
+  data.tar.gz: 76d3ec684fe307aafce2f3be2c594f47a38c50f2b0bb394998c1c83c06d8a47b
 SHA512:
-  metadata.gz: f3f0a9244cf44b5d722662b56afefa823f305e3f86eda08224369bd70fce5f88cdf84fad7dd9222a60d143a7b3bcc61f27ef57a9e54076b551655223d9e94a15
-  data.tar.gz: 4cfa00635d6daeeb0d4bbaa97c5a7c09ccd001b9dc53072d55ddd025086209701dbd3c3739650eb501cf22f94c3aaf471f877016cc6870add3c2b4a075c58dc2
+  metadata.gz: cdd8b0d400e2557525fca889bbd3ef8b8eef67774f0143ea925fa9c5ac091acabe2986de25d0f69a7005185425cf94edcd873b19cacbe56aa823c9c64fa607b3
+  data.tar.gz: c1d802b26491e276ffbcdc3e3dd4e4272c9b48ab63a5e6b7283fb5e5f7b706ce64d5216728946aa3783f88396a0ec9a0582c045571cd78de050f42496479a392

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Kanrisuru 0.15.0 (December 13, 2021) ##
+*  Add opts for `ip` command.
+*  Refactor `ip` object commands into smaller methods. Refactor `version` for consistent use and stub ability in funcitonal test cases.
+*  Add functional test cases for `ip` command.
+*  Add `append_flag_no` to `Kanrisuru::Command` class. Adds no to value for `falsey` statements. The `no` flag is commonly appended to indicate a deactived state for many arguments passed to programs on the command line.
+*  Fix test case `transfer` by appending the osname to the filename to avoid parallel overwrite.
+
 ## Kanrisuru 0.14.0 (December 08, 2021) ##
 *  Add additional unit test cases for `util` methods.
 *  Refactor the `core` module commands into smaller files, with each command split up. Also refactor parsing code into separate `Parser` class.

data/README.md

@@ -7,12 +7,12 @@
     <img src="https://img.shields.io/gem/v/kanrisuru?style=flat-square" alt="Latest version" />
   </a> 
   <a href="https://github.com/avamia/kanrisuru/blob/main/LICENSE.txt">
-    <img src="https://img.shields.io/github/license/avamia/kanrisuru" alt="Latest version" />
+    <img src="https://img.shields.io/github/license/avamia/kanrisuru?style=flat-square" alt="Latest version" />
   </a> 
-  <img src="https://img.shields.io/github/repo-size/avamia/kanrisuru" alt="GitHub repo size" />
-  <img src="https://img.shields.io/codecov/c/gh/avamia/kanrisuru?token=2Q1BE106B2" alt="Codecov" /> 
-  <img src="https://img.shields.io/codacy/grade/9e839eb160bc445ea4e81b64cef22b27" alt="Codacy grade" />
-  <img src="https://img.shields.io/codeclimate/maintainability/avamia/kanrisuru" alt="Code Climate maintainability" />
+  <img src="https://img.shields.io/github/repo-size/avamia/kanrisuru?style=flat-square" alt="GitHub repo size" />
+  <img src="https://img.shields.io/codecov/c/gh/avamia/kanrisuru?token=2Q1BE106B2&style=flat-square" alt="Codecov" /> 
+  <img src="https://img.shields.io/codacy/grade/9e839eb160bc445ea4e81b64cef22b27?style=flat-square" alt="Codacy grade" />
+  <img src="https://img.shields.io/codeclimate/maintainability/avamia/kanrisuru?style=flat-square" alt="Code Climate maintainability" />
 </p>
 
 # Kanrisuru

data/lib/kanrisuru/command.rb

@@ -103,6 +103,16 @@ module Kanrisuru
       @raw_command = Kanrisuru::Util.present?(boolean) ? "#{@raw_command} #{arg}" : @raw_command
     end
 
+    def append_flag_no(arg, boolean = 'true')
+      return if boolean.nil?
+
+      if boolean
+        append_flag(arg, true)
+      else
+        append_flag("no#{arg}", true)
+      end
+    end
+
     def append_valid_exit_code(code)
       @valid_exit_codes << code if code.instance_of?(Integer)
       @valid_exit_codes.concat(code) if code.instance_of?(Array)

data/lib/kanrisuru/core/apt/parsers/base.rb

@@ -16,7 +16,7 @@ module Kanrisuru
 
             def parse_apt_sources(string)
               url, dist, architecture, = string.split
-              Source.new(url, dist, architecture)
+              Kanrisuru::Core::Apt::Source.new(url, dist, architecture)
             end
 
             def parse_apt_line(line)

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

@@ -4,58 +4,16 @@ module Kanrisuru
   module Core
     module IP
       def ip_address(action, opts)
-        command = nil
-
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-          command.append_flag('-s', opts[:stats])
-          command.append_arg('-family', opts[:family])
-          command << 'address show'
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('scope', opts[:scope])
-          command.append_arg('to', opts[:prefix])
-          command.append_arg('label', opts[:label])
-
-          command.append_flag('dynamic', opts[:dynamic])
-          command.append_flag('permanent', opts[:permanent])
-          command.append_flag('tenative', opts[:tenative])
-          command.append_flag('deprecated', opts[:deprecated])
-          command.append_flag('primary', opts[:primary])
-          command.append_flag('secondary', opts[:secondary])
-          command.append_flag('up', opts[:up])
+          version = ip_version.to_i
+          command = ip_address_show(opts, version)
         when 'add'
-          command = Kanrisuru::Command.new('ip address add')
-          command << opts[:address]
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
-          command.append_arg('scope', opts[:scope])
+          command = ip_address_add(opts)
         when 'del', 'delete'
-          command = Kanrisuru::Command.new('ip address del')
-          command << opts[:address]
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
-          command.append_arg('scope', opts[:scope])
+          command = ip_address_delete(opts)
         when 'flush'
-          command = Kanrisuru::Command.new('ip address flush')
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('scope', opts[:scope])
-          command.append_arg('to', opts[:prefix])
-          command.append_arg('label', opts[:label])
-
-          command.append_flag('dynamic', opts[:dynamic])
-          command.append_flag('permanent', opts[:permanent])
-          command.append_flag('tenative', opts[:tenative])
-          command.append_flag('deprecated', opts[:deprecated])
-          command.append_flag('primary', opts[:primary])
-          command.append_flag('secondary', opts[:secondary])
+          command = ip_address_flush(opts)
         end
 
         execute_shell(command)
@@ -64,6 +22,65 @@ module Kanrisuru
           Parser::Address.parse(cmd, action, version)
         end
       end
+
+      def ip_address_show(opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+        command.append_flag('-s', opts[:stats])
+        command.append_arg('-family', opts[:family])
+        command << 'address show'
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('scope', opts[:scope])
+        command.append_arg('to', opts[:prefix])
+        command.append_arg('label', opts[:label])
+
+        command.append_flag('dynamic', opts[:dynamic])
+        command.append_flag('permanent', opts[:permanent])
+        command.append_flag('tenative', opts[:tenative])
+        command.append_flag('deprecated', opts[:deprecated])
+        command.append_flag('primary', opts[:primary])
+        command.append_flag('secondary', opts[:secondary])
+        command.append_flag('up', opts[:up])
+        command
+      end
+
+      def ip_address_add(opts)
+        command = Kanrisuru::Command.new('ip address add')
+        command << opts[:address]
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command.append_arg('scope', opts[:scope])
+        command
+      end
+
+      def ip_address_delete(opts)
+        command = Kanrisuru::Command.new('ip address del')
+        command << opts[:address]
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command.append_arg('scope', opts[:scope])
+        command
+      end
+
+      def ip_address_flush(opts)
+        command = Kanrisuru::Command.new('ip address flush')
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('scope', opts[:scope])
+        command.append_arg('to', opts[:prefix])
+        command.append_arg('label', opts[:label])
+
+        command.append_flag('dynamic', opts[:dynamic])
+        command.append_flag('permanent', opts[:permanent])
+        command.append_flag('tenative', opts[:tenative])
+        command.append_flag('deprecated', opts[:deprecated])
+        command.append_flag('primary', opts[:primary])
+        command.append_flag('secondary', opts[:secondary])
+        command
+      end
     end
   end
 end

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

@@ -4,27 +4,16 @@ module Kanrisuru
   module Core
     module IP
       def ip_address_label(action, opts)
-        command = nil
-
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-          command << 'addrlabel list'
+          version = ip_version.to_i
+          command = ip_address_label_show(opts, version)
         when 'flush'
-          command = Kanrisuru::Command.new('ip addrlabel flush')
+          command = ip_address_label_flush(opts)
         when 'add'
-          command = Kanrisuru::Command.new('ip addrlabel add')
-          command.append_arg('prefix', opts[:prefix])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
+          command = ip_address_label_add(opts)
         when 'del'
-          command = Kanrisuru::Command.new('ip addrlabel del')
-          command.append_arg('prefix', opts[:prefix])
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('label', opts[:label])
+          command = ip_address_label_delete(opts)
         end
 
         execute_shell(command)
@@ -33,6 +22,33 @@ module Kanrisuru
           Parser::AddressLabel.parse(cmd, action, version)
         end
       end
+
+      def ip_address_label_delete(opts)
+        command = Kanrisuru::Command.new('ip addrlabel del')
+        command.append_arg('prefix', opts[:prefix])
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command
+      end
+
+      def ip_address_label_add(opts)
+        command = Kanrisuru::Command.new('ip addrlabel add')
+        command.append_arg('prefix', opts[:prefix])
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('label', opts[:label])
+        command
+      end
+
+      def ip_address_label_flush(_opts)
+        Kanrisuru::Command.new('ip addrlabel flush')
+      end
+
+      def ip_address_label_show(_opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+        command << 'addrlabel list'
+        command
+      end
     end
   end
 end

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

@@ -4,63 +4,16 @@ module Kanrisuru
   module Core
     module IP
       def ip_link(action, opts)
-        command = nil
-
         case action
         when 'show', 'list'
-          version = ip_version
-
-          command = Kanrisuru::Command.new('ip')
-          command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
-          command.append_flag('-s', opts[:stats])
-          command.append_arg('-family', opts[:family])
-          command << 'link show'
-
-          command.append_arg('dev', opts[:dev])
-          command.append_arg('group', opts[:group])
-          command.append_arg('master', opts[:master])
-          command.append_arg('type', opts[:type])
-          command.append_arg('vrf', opts[:vrf])
-
-          command.append_flag('up', opts[:up])
+          version = ip_version.to_i
+          command = ip_link_show(opts, version)
+        when 'add', 'a'
+          command = ip_link_add(opts)
+        when 'delete', 'del'
+          command = ip_link_delete(opts)
         when 'set'
-          command = Kanrisuru::Command.new('ip link set')
-
-          raise ArgumentError, 'no device defined' unless opts[:dev]
-
-          command.append_arg('dev', opts[:dev])
-
-          case opts[:direction]
-          when 'up'
-            command.append_flag('up')
-          when 'down'
-            command.append_flag('down')
-          end
-
-          command.append_arg('arp', opts[:arp])
-          command.append_arg('multicast', opts[:multicast])
-          command.append_arg('dynamic', opts[:dynamic])
-          command.append_arg('name', opts[:name])
-          command.append_arg('txqueuelen', opts[:txqueuelen])
-          command.append_arg('txqlen', opts[:txqlen])
-          command.append_arg('mtu', opts[:mtu])
-          command.append_arg('address', opts[:address])
-          command.append_arg('broadcast', opts[:broadcast])
-          command.append_arg('brd', opts[:brd])
-          command.append_arg('peer', opts[:peer])
-          command.append_arg('netns', opts[:netns])
-
-          if Kanrisuru::Util.present?(opts[:vf])
-            command.append_arg('vf', opts[:vf])
-            command.append_arg('mac', opts[:mac])
-
-            if Kanrisuru::Util.present?(opts[:vlan])
-              command.append_arg('vlan', opts[:vlan])
-              command.append_arg('qos', opts[:qos])
-            end
-
-            command.append_arg('rate', opts[:rate])
-          end
+          command = ip_link_set(opts)
         end
 
         execute_shell(command)
@@ -69,6 +22,95 @@ module Kanrisuru
           Parser::Link.parse(cmd, action, version)
         end
       end
+
+      def ip_link_show(opts, version)
+        command = Kanrisuru::Command.new('ip')
+        command.append_flag('-json') if version >= IPROUTE2_JSON_VERSION
+        command.append_flag('-s', opts[:stats])
+        command.append_arg('-family', opts[:family])
+        command << 'link show'
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('group', opts[:group])
+        command.append_arg('master', opts[:master])
+        command.append_arg('type', opts[:type])
+        command.append_arg('vrf', opts[:vrf])
+
+        command.append_flag('up', opts[:up])
+        command
+      end
+
+      def ip_link_add(opts)
+        command = Kanrisuru::Command.new('ip link add')
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('name', opts[:name])
+        command.append_arg('mtu', opts[:mtu])
+        command.append_arg('index', opts[:index])
+
+        command.append_arg('numtxqueues', opts[:numtxqueues])
+        command.append_arg('numrxqueues', opts[:numrxqueues])
+        command.append_arg('gso_max_size', opts[:gso_max_size])
+        command.append_arg('gso_max_segs', opts[:gso_max_segs])
+
+        if Kanrisuru::Util.present?(opts[:type])
+          raise ArgumentError, 'invalid link type' unless IP_LINK_TYPES.include?(opts[:type])
+
+          command.append_arg('type', opts[:type])
+
+          ip_link_type_opts(command, opts) if Kanrisuru::Util.present?(opts[:type_opts])
+        end
+
+        command
+      end
+
+      def ip_link_delete(opts)
+        command = Kanrisuru::Command.new('ip link delete')
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('group', opts[:group])
+        command.append_arg('type', opts[:type])
+        command
+      end
+
+      def ip_link_set(opts)
+        command = Kanrisuru::Command.new('ip link set')
+        raise ArgumentError, 'no device defined' unless opts[:dev]
+
+        command.append_arg('dev', opts[:dev])
+        command.append_arg('group', opts[:group])
+
+        case opts[:direction]
+        when 'up'
+          command.append_flag('up')
+        when 'down'
+          command.append_flag('down')
+        end
+
+        ip_link_common_opts(command, opts)
+
+        ip_link_vf_opts(command, opts) if Kanrisuru::Util.present?(opts[:vf])
+
+        ip_link_xdp_opts(command, opts) if Kanrisuru::Util.present?(opts[:xdp])
+
+        if opts[:master] == false
+          command.append_flag('nomaster')
+        else
+          command.append_arg('master', opts[:master])
+        end
+
+        command.append_arg('addrgenmode', opts[:addrgenmode])
+        command.append_flag('link-netnsid', opts[:link_netnsid])
+
+        if Kanrisuru::Util.present?(opts[:type])
+          raise ArgumentError, 'invalid link type' unless IP_LINK_TYPES.include?(opts[:type])
+
+          command.append_arg('type', opts[:type])
+
+          ip_link_type_opts(command, opts) if Kanrisuru::Util.present?(opts[:type_opts])
+        end
+
+        command
+      end
     end
   end
 end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module IP
+      def ip_link_common_opts(command, opts)
+        command.append_arg('arp', opts[:arp])
+        command.append_arg('multicast', opts[:multicast])
+        command.append_arg('allmulticast', opts[:allmulticast])
+        command.append_arg('promisc', opts[:promisc])
+        command.append_arg('protodown', opts[:protodown])
+        command.append_arg('protodown_reason', opts[:protodown_reason])
+        command.append_arg('dynamic', opts[:dynamic])
+        command.append_arg('name', opts[:name])
+        command.append_arg('txqueuelen', opts[:txqueuelen])
+        command.append_arg('txqlen', opts[:txqlen])
+        command.append_arg('mtu', opts[:mtu])
+        command.append_arg('address', opts[:address])
+        command.append_arg('broadcast', opts[:broadcast])
+        command.append_arg('brd', opts[:brd])
+        command.append_arg('peer', opts[:peer])
+        command.append_arg('netns', opts[:netns])
+        command.append_arg('alias', opts[:alias])
+      end
+
+      def ip_link_xdp_opts(command, opts)
+        command.append_arg('xdp', opts[:xdp])
+
+        case opts[:xdp]
+        when 'object'
+          command << opts[:object]
+          command.append_arg('section', opts[:section])
+          command.append_flag('verbose', opts[:verbose])
+        when 'pinned'
+          command << opts[:pinned]
+        end
+      end
+
+      def ip_link_vf_opts(command, opts)
+        command.append_arg('vf', opts[:vf])
+        command.append_arg('mac', opts[:mac])
+
+        if Kanrisuru::Util.present?(opts[:vlan])
+          command.append_arg('vlan', opts[:vlan])
+          command.append_arg('qos', opts[:qos])
+        end
+
+        command.append_arg('proto', opts[:proto])
+        command.append_arg('rate', opts[:rate])
+        command.append_arg('max_tx_rate', opts[:max_tx_rate])
+        command.append_arg('min_tx_rate', opts[:min_tx_rate])
+        command.append_arg('spoofchk', opts[:spoofchk])
+        command.append_arg('query_rss', opts[:query_rss])
+        command.append_arg('state', opts[:state])
+        command.append_arg('trust', opts[:trust])
+        command.append_arg('node_guid', opts[:node_guid])
+        command.append_arg('port_guid', opts[:port_guid])
+      end
+    end
+  end
+end