linux_admin 3.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55478e58c9aaa8793bc1ba5df8216e89e68bbb30cc81faee45393b2ccf61bce9
-  data.tar.gz: f41a819b7bc0cd0ec5c6ba8a89bec5a779b3a3ca4884e49fb9e792f25d8c5599
+  metadata.gz: de3cd5883d8dee83ce8db19f61bb2b6b47cf8a057a00f37488ce809110d8d158
+  data.tar.gz: f6bc420d4a091ce5cb42150e8ec7d2b6fe149c38b3a9c0bf6981ee76ff582302
 SHA512:
-  metadata.gz: e661c3f97fe45c92730cc9afefb0c98ea7d70f6ee2c5d7a492319cded40e5e963a7c014c1179b1a9dce17392e1ff6150dde248e9103b5b62b3a6bfb982c481a2
-  data.tar.gz: 83772108b1940c6c1aba6e7c17f87ebd657505b0ea38960adef8d319e61d2d14b858c9d99d32a5d20f2216196df4f02c04236cdcbff2b9d192f4e57a0fbe4828
+  metadata.gz: 21a1d96a14181e0bd6d0c74d654f3588dab524d5a2ab0a0adda21e88b134e013be8e78927e5e912be729071459c6ac1cb72add42ae328e499e2ab92a8223078d
+  data.tar.gz: 78fb390e5faf124d4dd27e001464854cbcafcf0346bb9eaebd5a98591257bae9ac8b00a0d34dec0ebcb05979553bb973f672f0d4061095090d7e75960ffec977

data/README.md

@@ -2,8 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/linux_admin.svg)](http://badge.fury.io/rb/linux_admin)
 [![CI](https://github.com/ManageIQ/linux_admin/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/linux_admin/actions/workflows/ci.yaml)
-[![Code Climate](https://codeclimate.com/github/ManageIQ/linux_admin.svg)](https://codeclimate.com/github/ManageIQ/linux_admin)
-[![Test Coverage](https://codeclimate.com/github/ManageIQ/linux_admin/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/linux_admin/coverage)
 
 LinuxAdmin is a module to simplify management of linux systems.
 It should be a single place to manage various system level configurations,

data/lib/linux_admin/distro.rb

@@ -18,8 +18,12 @@ module LinuxAdmin
       @ubuntu ||= Distro.new(:ubuntu, nil, ['ubuntu'], LinuxAdmin::Deb)
     end
 
+    def self.darwin
+      @darwin ||= Distro.new(:darwin, "/System/Library/CoreServices/SystemVersion.plist", ['darwin'], LinuxAdmin::Homebrew)
+    end
+
     def self.all
-      @distros ||= [rhel, fedora, ubuntu, generic]
+      @distros ||= [rhel, fedora, ubuntu, darwin, generic]
     end
 
     def self.local

data/lib/linux_admin/homebrew.rb

@@ -0,0 +1,21 @@
+module LinuxAdmin
+  class Homebrew < Package
+    extend Logging
+
+    def self.homebrew_cmd
+      Common.cmd("brew")
+    end
+
+    def self.list_installed
+      info(nil)
+    end
+
+    def self.info(pkg)
+      out = Common.run!(homebrew_cmd, :params => ["list", :versions, pkg]).output
+      out.split("\n").each_with_object({}) do |line, pkg_hash|
+        name, ver = line.split[0..1] # only take the latest version
+        pkg_hash[name] = ver
+      end
+    end
+  end
+end

data/lib/linux_admin/network_interface/network_interface_darwin.rb

@@ -0,0 +1,19 @@
+module LinuxAdmin
+  class NetworkInterfaceDarwin < NetworkInterface
+    # Runs the command `ip -[4/6] route` and returns the output
+    #
+    # @param version [Fixnum] Version of IP protocol (4 or 6)
+    # @return [String] The command output
+    # @raise [NetworkInterfaceError] if the command fails
+    #
+    # macs use ip route get while others use ip route show
+    def ip_route(version, route = "default")
+      output = Common.run!(Common.cmd("ip"), :params => ["--json", "-#{version}", "route", "get", route]).output
+      return {} if output.blank?
+
+      JSON.parse(output).first
+    rescue AwesomeSpawn::CommandResultError => e
+      raise NetworkInterfaceError.new(e.message, e.result)
+    end
+  end
+end

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
 
@@ -12,21 +13,39 @@ module LinuxAdmin
     def self.dist_class(clear_cache = false)
       @dist_class = nil if clear_cache
       @dist_class ||= begin
-        if [Distros.rhel, Distros.fedora].include?(Distros.local)
+        case Distros.local
+        when Distros.rhel, Distros.fedora
           NetworkInterfaceRH
+        when Distros.darwin
+          NetworkInterfaceDarwin
         else
           NetworkInterfaceGeneric
         end
       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 +64,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 +179,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 +197,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 +209,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.1.0".freeze
 end

data/lib/linux_admin.rb

@@ -9,6 +9,7 @@ require 'linux_admin/package'
 require 'linux_admin/registration_system'
 require 'linux_admin/rpm'
 require 'linux_admin/deb'
+require 'linux_admin/homebrew'
 require 'linux_admin/version'
 require 'linux_admin/yum'
 require 'linux_admin/ssh'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linux_admin
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Brandon Dunne
@@ -27,10 +27,9 @@ authors:
 - whitesource-bolt-for-github[bot]
 - Adam Grare
 - renovate[bot]
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: manageiq-style
@@ -162,19 +161,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.1
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 7.2.3
   type: :runtime
@@ -182,6 +190,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 7.2.3
 - !ruby/object:Gem::Dependency
@@ -296,12 +307,14 @@ files:
 - lib/linux_admin/exceptions.rb
 - lib/linux_admin/fstab.rb
 - lib/linux_admin/hardware.rb
+- lib/linux_admin/homebrew.rb
 - lib/linux_admin/hosts.rb
 - lib/linux_admin/ip_address.rb
 - lib/linux_admin/logging.rb
 - lib/linux_admin/logical_volume.rb
 - lib/linux_admin/mountable.rb
 - lib/linux_admin/network_interface.rb
+- lib/linux_admin/network_interface/network_interface_darwin.rb
 - lib/linux_admin/network_interface/network_interface_generic.rb
 - lib/linux_admin/network_interface/network_interface_rh.rb
 - lib/linux_admin/null_logger.rb
@@ -328,7 +341,6 @@ homepage: http://github.com/ManageIQ/linux_admin
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -336,15 +348,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: LinuxAdmin is a module to simplify management of linux systems.
 test_files: []