network.rb in ohai-8.9.0

- old
+ new

@@ -1,16 +1,16 @@
 #
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# Author:: Adam Jacob (<adam@chef.io>)
+# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
@@ -24,62 +24,64 @@
 
   provides "ipaddress", "ip6address", "macaddress"
 
   depends "network/interfaces"
 
+  # from interface data create array of hashes with ipaddress, scope, and iface
+  # sorted by scope, prefixlen and then ipaddress where longest prefixes first
   def sorted_ips(family = "inet")
-    raise "bad family #{family}" unless [ "inet", "inet6" ].include? family
+    fail "bad family #{family}" unless %w(inet inet6).include? family
 
-    # going to use that later to sort by scope
+    # priority of ipv6 link scopes to sort by later
     scope_prio = [ "global", "site", "link", "host", "node", nil ]
 
+    # grab ipaddress, scope, and iface for sorting later
     ipaddresses = []
-    # ipaddresses going to hold #{family} ipaddresses and their scope
     Mash[network['interfaces']].each do |iface, iface_v|
-      next if iface_v.nil? or not iface_v.has_key? 'addresses'
+      next if iface_v.nil? || !iface_v.has_key?('addresses')
       iface_v['addresses'].each do |addr, addr_v|
         next if addr_v.nil? or not addr_v.has_key? "family" or addr_v['family'] != family
-        ipaddresses <<  {
+        ipaddresses << {
           :ipaddress => addr_v["prefixlen"] ? IPAddress("#{addr}/#{addr_v["prefixlen"]}") : IPAddress("#{addr}/#{addr_v["netmask"]}"),
           :scope => addr_v["scope"].nil? ? nil : addr_v["scope"].downcase,
           :iface => iface
         }
       end
     end
 
     # sort ip addresses by scope, by prefixlen and then by ip address
     # 128 - prefixlen: longest prefixes first
     ipaddresses.sort_by do |v|
-      [ ( scope_prio.index(v[:scope]) or 999999 ),
+      [ ( scope_prio.index(v[:scope]) || 999999 ),
         128 - v[:ipaddress].prefix.to_i,
         ( family == "inet" ? v[:ipaddress].to_u32 : v[:ipaddress].to_u128 )
       ]
     end
   end
 
+  # finds ip address / interface for interface with default route based on
+  # passed in family.  returns [ipaddress, interface] uses 1st ip if no default
+  # route is found
   def find_ip(family = "inet")
-    ips=sorted_ips(family)
+    ips = sorted_ips(family)
 
-    # return if there isn't any #{family} address !
+    # return if there aren't any #{family} addresses!
     return [ nil, nil ] if ips.empty?
 
     # shortcuts to access default #{family} interface and gateway
     int_attr = Ohai::Mixin::NetworkConstants::FAMILIES[family] +"_interface"
     gw_attr = Ohai::Mixin::NetworkConstants::FAMILIES[family] + "_gateway"
 
-    # If we have a default interface that has addresses,
-    # populate the short-cut attributes ipaddress, ip6address and macaddress
     if network[int_attr]
-
       # working with the address(es) of the default network interface
       gw_if_ips = ips.select do |v|
         v[:iface] == network[int_attr]
       end
       if gw_if_ips.empty?
         Ohai::Log.warn("[#{family}] no ip address on #{network[int_attr]}")
-      elsif network[gw_attr] and
-          network["interfaces"][network[int_attr]] and
+      elsif network[gw_attr] &&
+          network["interfaces"][network[int_attr]] &&
           network["interfaces"][network[int_attr]]["addresses"]
         if [ "0.0.0.0", "::", /^fe80:/ ].any? { |pat| pat === network[gw_attr] }
           # link level default route
           Ohai::Log.debug("link level default #{family} route, picking ip from #{network[gw_attr]}")
           r = gw_if_ips.first
@@ -107,70 +109,75 @@
     return [ nil, nil ] if r.nil? or r.empty?
 
     [ r[:ipaddress].to_s, r[:iface] ]
   end
 
+  # select mac address of first interface with family of lladdr
   def find_mac_from_iface(iface)
-    r = network["interfaces"][iface]["addresses"].select{|k,v| v["family"]=="lladdr"}
-    r.nil? or r.first.nil? ? nil : r.first.first
+    r = network["interfaces"][iface]["addresses"].select{|k,v| v["family"] == "lladdr"}
+    r.nil? || r.first.nil? ? nil : r.first.first
   end
 
+  # address_to_match: String
+  # ipaddress: IPAddress
+  # iface: String
   def network_contains_address(address_to_match, ipaddress, iface)
-    # address_to_match: String
-    # ipaddress: IPAddress
-    # iface: String
     if peer = network["interfaces"][iface]["addresses"][ipaddress.to_s][:peer]
       IPAddress(peer) == IPAddress(address_to_match)
     else
       ipaddress.include? IPAddress(address_to_match)
     end
   end
 
-  # ipaddress, ip6address and macaddress can be set by the #{os}::network plugin
-  # atm it is expected macaddress is set at the same time than ipaddress
-  # if ipaddress is set and macaddress is nil, that means the interface
-  # ipaddress is bound to has the NOARP flag
-
+  # ipaddress, ip6address and macaddress are set for each interface by the
+  # #{os}::network plugin. atm it is expected macaddress is set at the same
+  # time as ipaddress. if ipaddress is set and macaddress is nil, that means
+  # the interface ipaddress is bound to has the NOARP flag
   collect_data do
     results = {}
 
     network Mash.new unless network
     network[:interfaces] = Mash.new unless network[:interfaces]
     counters Mash.new unless counters
     counters[:network] = Mash.new unless counters[:network]
 
-    # inet family is treated before inet6
+    # inet family is processed before inet6 to give ipv4 precedence
     Ohai::Mixin::NetworkConstants::FAMILIES.keys.sort.each do |family|
       r = {}
-      ( r["ip"], r["iface"] ) = find_ip(family)
+      # find the ip/interface with the default route for this family
+      (r["ip"], r["iface"]) = find_ip(family)
       r["mac"] = find_mac_from_iface(r["iface"]) unless r["iface"].nil?
       # don't overwrite attributes if they've already been set by the "#{os}::network" plugin
-      if family == "inet" and ipaddress.nil?
+      if (family == "inet") && ipaddress.nil?
         if r["ip"].nil?
           Ohai::Log.warn("unable to detect ipaddress")
-          # i don't issue this warning if r["ip"] exists and r["mac"].nil?
-          # as it could be a valid setup with a NOARP default_interface
-          Ohai::Log.warn("unable to detect macaddress")
         else
           ipaddress r["ip"]
-          macaddress r["mac"]
         end
-      elsif family == "inet6" and ip6address.nil?
+      elsif (family == "inet6") && ip6address.nil?
         if r["ip"].nil?
           Ohai::Log.debug("unable to detect ip6address")
         else
           ip6address r["ip"]
-          if r["mac"] and macaddress.nil? and ipaddress.nil?
-            Ohai::Log.debug("macaddress set to #{r["mac"]} from the ipv6 setup")
-            macaddress r["mac"]
-          end
         end
       end
+
+      # set the macaddress [only if we haven't already]. this allows the #{os}::network plugin to set macaddress
+      # otherwise we set macaddress on a first-found basis (and we started with ipv4)
+      if macaddress.nil?
+        if r["mac"]
+          Ohai::Log.debug("setting macaddress to '#{r["mac"]}' from interface '#{r["iface"]}' for family '#{family}'")
+          macaddress r["mac"]
+        else
+          Ohai::Log.debug("unable to detect macaddress for family '#{family}'")
+        end
+      end
+
       results[family] = r
     end
 
-    if results["inet"]["iface"] and results["inet6"]["iface"] and
-        results["inet"]["iface"] != results["inet6"]["iface"]
-      Ohai::Log.debug("ipaddress and ip6address are set from different interfaces (#{results["inet"]["iface"]} & #{results["inet6"]["iface"]}), macaddress has been set using the ipaddress interface")
+    if results["inet"]["iface"] && results["inet6"]["iface"] &&
+        (results["inet"]["iface"] != results["inet6"]["iface"])
+      Ohai::Log.debug("ipaddress and ip6address are set from different interfaces (#{results["inet"]["iface"]} & #{results["inet6"]["iface"]})")
     end
   end
 end