linux_admin 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55478e58c9aaa8793bc1ba5df8216e89e68bbb30cc81faee45393b2ccf61bce9
-  data.tar.gz: f41a819b7bc0cd0ec5c6ba8a89bec5a779b3a3ca4884e49fb9e792f25d8c5599
+  metadata.gz: 5a68c70db030c6c422243f781a3500324a224ae653c7e04e6ebac3f5ad902d08
+  data.tar.gz: 2d1d363cd64e3c2ebf64616a0376752f2e04aa7b74c143856d89c1aa2bcd0a7e
 SHA512:
-  metadata.gz: e661c3f97fe45c92730cc9afefb0c98ea7d70f6ee2c5d7a492319cded40e5e963a7c014c1179b1a9dce17392e1ff6150dde248e9103b5b62b3a6bfb982c481a2
-  data.tar.gz: 83772108b1940c6c1aba6e7c17f87ebd657505b0ea38960adef8d319e61d2d14b858c9d99d32a5d20f2216196df4f02c04236cdcbff2b9d192f4e57a0fbe4828
+  metadata.gz: 24c97db1e87afbbb873c963eb0e5c45f54dd1de468b46e301ec44563bcc459ecc2a97c9219a4c221ec8703258328c0c2f476b6e27f91da4c6bb811945ea3cfe7
+  data.tar.gz: 9b1a31fbf403c5b0873dced35a8308870a382c907ae8ef3919a285151c878bebf9297d71179435c09bc4c4a182fffee053e3e1ee8b76b2a50f2e8e8bd2e3d1ee

data/lib/linux_admin/network_interface/network_interface_rh.rb

@@ -12,7 +12,15 @@ module LinuxAdmin
     def initialize(interface)
       @interface_file = self.class.path_to_interface_config_file(interface)
       super
+    end
+
+    # Gathers current network information for this interface
+    #
+    # @return [Boolean] true if network information was gathered successfully
+    def reload
+      super
       parse_conf
+      true
     end
 
     # Parses the interface configuration file into the @interface_config hash

data/lib/linux_admin/network_interface.rb

@@ -1,7 +1,8 @@
-require 'ipaddr'
-
 module LinuxAdmin
   class NetworkInterface
+    require "ipaddr"
+    require "json"
+
     # Cached class instance variable for what distro we are running on
     @dist_class = nil
 
@@ -20,13 +21,28 @@ module LinuxAdmin
       end
     end
 
+    def self.list
+      ip_link.pluck("ifname").map { |iface| new(iface) }
+    rescue AwesomeSpawn::CommandResultError => e
+      raise NetworkInterfaceError.new(e.message, e.result)
+    end
+
+    private_class_method def self.ip_link
+      require "json"
+
+      result = Common.run!(Common.cmd("ip"), :params => ["--json", "link"])
+      JSON.parse(result.output)
+    rescue AwesomeSpawn::CommandResultError, JSON::ParserError => e
+      raise NetworkInterfaceError.new(e.message, e.result)
+    end
+
     # Creates an instance of the correct NetworkInterface subclass for the local distro
     def self.new(*args)
       self == LinuxAdmin::NetworkInterface ? dist_class.new(*args) : super
     end
 
     # @return [String] the interface for networking operations
-    attr_reader :interface
+    attr_reader :interface, :link_type
 
     # @param interface [String] Name of the network interface to manage
     def initialize(interface)
@@ -45,18 +61,25 @@ module LinuxAdmin
         return false
       end
 
-      parse_ip4(ip_output)
-      parse_ip6(ip_output, :global)
-      parse_ip6(ip_output, :link)
+      @link_type = ip_output["link_type"]
+      addr_info  = ip_output["addr_info"]
+
+      parse_ip4(addr_info)
+      parse_ip6(addr_info, "global")
+      parse_ip6(addr_info, "link")
 
-      @network_conf[:mac] = parse_ip_output(ip_output, %r{link/ether}, 1)
+      @network_conf[:mac] = ip_output["address"]
 
       [4, 6].each do |version|
-        @network_conf["gateway#{version}".to_sym] = parse_ip_output(ip_route(version), /^default/, 2)
+        @network_conf["gateway#{version}".to_sym] = ip_route(version, "default")&.dig("gateway")
       end
       true
     end
 
+    def loopback?
+      @link_type == "loopback"
+    end
+
     # Retrieve the IPv4 address assigned to the interface
     #
     # @return [String] IPv4 address for the managed interface
@@ -153,23 +176,15 @@ module LinuxAdmin
 
     private
 
-    # Parses the output of `ip addr show`
-    #
-    # @param output [String] The command output
-    # @param regex  [Regexp] Regular expression to match the desired output line
-    # @param col    [Fixnum] The whitespace delimited column to be returned
-    # @return [String] The parsed data
-    def parse_ip_output(output, regex, col)
-      the_line = output.split("\n").detect { |l| l =~ regex }
-      the_line.nil? ? nil : the_line.strip.split(' ')[col]
-    end
-
     # Runs the command `ip addr show <interface>`
     #
     # @return [String] The command output
     # @raise [NetworkInterfaceError] if the command fails
     def ip_show
-      Common.run!(Common.cmd("ip"), :params => ["addr", "show", @interface]).output
+      output = Common.run!(Common.cmd("ip"), :params => ["--json", "addr", "show", @interface]).output
+      return {} if output.blank?
+
+      JSON.parse(output).first
     rescue AwesomeSpawn::CommandResultError => e
       raise NetworkInterfaceError.new(e.message, e.result)
     end
@@ -179,8 +194,11 @@ module LinuxAdmin
     # @param version [Fixnum] Version of IP protocol (4 or 6)
     # @return [String] The command output
     # @raise [NetworkInterfaceError] if the command fails
-    def ip_route(version)
-      Common.run!(Common.cmd("ip"), :params => ["-#{version}", 'route']).output
+    def ip_route(version, route = "default")
+      output = Common.run!(Common.cmd("ip"), :params => ["--json", "-#{version}", "route", "show", route]).output
+      return {} if output.blank?
+
+      JSON.parse(output).first
     rescue AwesomeSpawn::CommandResultError => e
       raise NetworkInterfaceError.new(e.message, e.result)
     end
@@ -188,26 +206,24 @@ module LinuxAdmin
     # Parses the IPv4 information from the output of `ip addr show <device>`
     #
     # @param ip_output [String] The command output
-    def parse_ip4(ip_output)
-      cidr_ip = parse_ip_output(ip_output, /inet /, 1)
-      return unless cidr_ip
+    def parse_ip4(addr_info)
+      inet = addr_info&.detect { |addr| addr["family"] == "inet" }
+      return if inet.nil?
 
-      parts = cidr_ip.split('/')
-      @network_conf[:address] = parts[0]
-      @network_conf[:prefix] = parts[1].to_i
+      @network_conf[:address] = inet["local"]
+      @network_conf[:prefix]  = inet["prefixlen"]
     end
 
     # Parses the IPv6 information from the output of `ip addr show <device>`
     #
     # @param ip_output [String] The command output
     # @param scope     [Symbol] The IPv6 scope (either `:global` or `:local`)
-    def parse_ip6(ip_output, scope)
-      cidr_ip = parse_ip_output(ip_output, /inet6 .* scope #{scope}/, 1)
-      return unless cidr_ip
+    def parse_ip6(addr_info, scope)
+      inet6 = addr_info&.detect { |addr| addr["family"] == "inet6" && addr["scope"] == scope }
+      return if inet6.nil?
 
-      parts = cidr_ip.split('/')
-      @network_conf["address6_#{scope}".to_sym] = parts[0]
-      @network_conf["prefix6_#{scope}".to_sym] = parts[1].to_i
+      @network_conf["address6_#{scope}".to_sym] = inet6["local"]
+      @network_conf["prefix6_#{scope}".to_sym]  = inet6["prefixlen"]
     end
   end
 end

data/lib/linux_admin/version.rb

@@ -1,3 +1,3 @@
 module LinuxAdmin
-  VERSION = "3.0.0".freeze
+  VERSION = "4.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linux_admin
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Brandon Dunne
@@ -30,7 +30,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: manageiq-style
@@ -343,7 +343,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: LinuxAdmin is a module to simplify management of linux systems.