(FACT-2864) Added support for secondary ips and vlans on linux platforms

Author: Bogdan Irimie

.gitignore

@@ -55,3 +55,5 @@ build-iPhoneSimulator/
 .rspec_status
 Gemfile.lock
 Gemfile.local
+acceptance/vendor
+.beaker

.rubocop_todo.yml

@@ -28,9 +28,9 @@ RSpec/FilePath:
     - 'spec/custom_facts/util/normalization_spec.rb'
     - 'spec/custom_facts/util/parser_spec.rb'
     - 'spec/custom_facts/util/resolution_spec.rb'
-    - 'spec/facter/facts_utils/uptime_parser_spec.rb'
-    - 'spec/facter/facts_utils/windows_release_finder_spec.rb'
-    - 'spec/facter/facts_utils/virtual_detector_spec.rb'
+    - 'spec/facter/util/facts/uptime_parser_spec.rb'
+    - 'spec/facter/util/facts/windows_release_finder_spec.rb'
+    - 'spec/facter/util/facts/virtual_detector_spec.rb'
     - 'spec/facter/model/fact_collection_spec.rb'
     - 'spec/facter/model/resolved_fact_spec.rb'
     - 'spec/facter/resolvers/aix/architecture_resolver_spec.rb'
@@ -54,7 +54,7 @@ RSpec/FilePath:
     - 'spec/facter/resolvers/system_profile_resolver_spec.rb'
     - 'spec/facter/resolvers/utils/aix/odm_query_spec.rb'
     - 'spec/facter/resolvers/utils/macosx/filesystem_helper_spec.rb'
-    - 'spec/facter/resolvers/utils/windows/win32ole_spec.rb'
+    - 'spec/facter/util/windows/win32ole_spec.rb'
     - 'spec/facter/resolvers/windows/dmi_bios_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/dmi_computersystem_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/hardware_architecture_resolver_spec.rb'
@@ -104,7 +104,7 @@ RSpec/LeakyConstantDeclaration:
     - 'spec/custom_facts/shared_contexts/platform.rb'
     - 'spec/custom_facts/util/collection_spec.rb'
     - 'spec/facter/resolvers/macosx/mountpoints_resolver_spec.rb'
-    - 'spec/facter/resolvers/utils/windows/network_utils_spec.rb'
+    - 'spec/facter/util/windows/network_utils_spec.rb'
 
 # Offense count: 93
 # Configuration parameters: EnforcedStyle.
@@ -159,7 +159,7 @@ RSpec/MessageSpies:
     - 'spec/facter/facts/windows/processors/physicalcount_spec.rb'
     - 'spec/facter/facts/windows/ruby/platform_spec.rb'
     - 'spec/facter/facts/windows/ruby/sitedir_spec.rb'
-    - 'spec/facter/resolvers/utils/aix/odm_query_spec.rb'
+    - 'spec/facter/util/aix/odm_query_spec.rb'
 
 # Offense count: 26
 RSpec/SubjectStub:
@@ -208,8 +208,8 @@ RSpec/VerifiedDoubles:
     - 'spec/facter/resolvers/freebsd/ffi_helper_spec.rb'
     - 'spec/facter/resolvers/macosx/mountpoints_resolver_spec.rb'
     - 'spec/facter/resolvers/mountpoints_resolver_spec.rb'
-    - 'spec/facter/resolvers/utils/windows/network_utils_spec.rb'
-    - 'spec/facter/resolvers/utils/windows/win32ole_spec.rb'
+    - 'spec/facter/util/windows/network_utils_spec.rb'
+    - 'spec/facter/util/windows/win32ole_spec.rb'
     - 'spec/facter/resolvers/windows/dmi_bios_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/dmi_computersystem_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/hardware_architecture_resolver_spec.rb'

acceptance/tests/facts/networking_facts.rb

@@ -1,90 +1,96 @@
 test_name 'C59029: networking facts should be fully populated' do
   tag 'risk:high'
 
-#
-# This test is intended to ensure that networking facts resolves
-# as expected across supported platforms.
-#
+  #
+  # This test is intended to ensure that networking facts resolve
+  # as expected across supported platforms.
+  #
 
   @ip_regex       = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/
   @netmask_regex  = /^(((128|192|224|240|248|252|254)\.0\.0\.0)|(255\.(0|128|192|224|240|248|252|254)\.0\.0)|(255\.255\.(0|128|192|224|240|248|252|254)\.0)|(255\.255\.255\.(0|128|192|224|240|248|252|254)))$/
 
   expected_networking = {
-      "networking.dhcp"     => agent['platform'] =~ /fedora-32|el-8-aarch64/ ? '' : @ip_regex, # https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/426
-      "networking.ip"       => @ip_regex,
-      "networking.ip6"      => /[a-f0-9]+:+/,
-      "networking.mac"      => /[a-f0-9]{2}:/,
-      "networking.mtu"      => /\d+/,
-      "networking.netmask"  => @netmask_regex,
-      "networking.netmask6" => /[a-f0-9]+:/,
-      "networking.network"  => @ip_regex,
-      "networking.network6" => /([a-f0-9]+)?:([a-f0-9]+)?/
+    %w[networking dhcp]     => agent['platform'] =~ /fedora-32|el-8-aarch64/ ? '' : @ip_regex, # https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/426
+    %w[networking ip]       => @ip_regex,
+    %w[networking ip6]      => /[a-f0-9]+:+/,
+    %w[networking mac]      => /[a-f0-9]{2}:/,
+    %w[networking mtu]      => /\d+/,
+    %w[networking netmask]  => @netmask_regex,
+    %w[networking netmask6] => /[a-f0-9]+:/,
+    %w[networking network]  => @ip_regex,
+    %w[networking network6] => /([a-f0-9]+)?:([a-f0-9]+)?/,
+    %w[networking scope6]   => /link|host|site|global|compat/
   }
 
   agents.each do |agent|
     primary_interface = fact_on(agent, 'networking.primary')
     refute_empty(primary_interface)
 
     expected_bindings = {
-        "networking.interfaces.#{primary_interface}.bindings.0.address" => @ip_regex,
-        "networking.interfaces.#{primary_interface}.bindings.0.netmask" => @netmask_regex,
-        "networking.interfaces.#{primary_interface}.bindings.0.network" => @ip_regex,
-        "networking.interfaces.#{primary_interface}.bindings6.0.address" => /[a-f0-9:]+/,
-        "networking.interfaces.#{primary_interface}.bindings6.0.netmask" => /[a-f0-9:]+/,
-        "networking.interfaces.#{primary_interface}.bindings6.0.network" => /[a-f0-9:]+/
+      ['networking', 'interfaces', primary_interface, 'bindings', 0, 'address'] => @ip_regex,
+      ['networking', 'interfaces', primary_interface, 'bindings', 0, 'netmask'] => @netmask_regex,
+      ['networking', 'interfaces', primary_interface, 'bindings', 0, 'network'] => @ip_regex,
+      ['networking', 'interfaces', primary_interface, 'bindings6', 0, 'address'] => /[a-f0-9:]+/,
+      ['networking', 'interfaces', primary_interface, 'bindings6', 0, 'netmask'] => /[a-f0-9:]+/,
+      ['networking', 'interfaces', primary_interface, 'bindings6', 0, 'network'] => /[a-f0-9:]+/,
+      ['networking', 'interfaces', primary_interface, 'bindings6', 0, 'scope6'] => /link|host|site|global|compat/
     }
 
     if agent['platform'] =~ /eos|solaris|aix|cisco/
       #remove the invalid networking facts on eccentric platforms
-      expected_networking.delete("networking.ip6")
-      expected_networking.delete("networking.netmask6")
-      expected_networking.delete("networking.network6")
+      expected_networking.delete(%w[networking ip6])
+      expected_networking.delete(%w[networking netmask6])
+      expected_networking.delete(%w[networking network6])
+      expected_networking.delete(%w[networking scope6])
 
       #remove invalid bindings for the primary networking interface eccentric platforms
-      expected_bindings.delete("networking.interfaces.#{primary_interface}.bindings6.0.address")
-      expected_bindings.delete("networking.interfaces.#{primary_interface}.bindings6.0.netmask")
-      expected_bindings.delete("networking.interfaces.#{primary_interface}.bindings6.0.network")
+      expected_bindings.delete(['networking', 'interfaces', primary_interface,  'bindings6', 0, 'address'])
+      expected_bindings.delete(['networking', 'interfaces', primary_interface,  'bindings6', 0, 'netmask'])
+      expected_bindings.delete(['networking', 'interfaces', primary_interface,  'bindings6', 0, 'network'])
+      expected_bindings.delete(['networking', 'interfaces', primary_interface,  'bindings6', 0, 'scope6'])
     end
 
     if agent['platform'] =~ /aix|sparc|cisco|huawei|sles|s390x/
       # some of our testing platforms do not use DHCP
-      expected_networking.delete("networking.dhcp")
+      expected_networking.delete(%w[networking dhcp])
     end
 
     if agent['platform'] =~ /cisco/
       # Cisco main interface does not define netmask or network
-      expected_networking.delete("networking.network")
-      expected_networking.delete("networking.netmask")
+      expected_networking.delete(%w[networking network])
+      expected_networking.delete(%w[networking netmask])
 
       #remove invalid bindings for Cisco's primary networking interface
-      expected_bindings.delete("networking.interfaces.#{primary_interface}.bindings.0.netmask")
-      expected_bindings.delete("networking.interfaces.#{primary_interface}.bindings.0.network")
+      expected_bindings.delete(['networking', 'interfaces', primary_interface, 'bindings', 0, 'netmask'])
+      expected_bindings.delete(['networking', 'interfaces', primary_interface, 'bindings', 0, 'network'])
     end
 
+    networking_facts = JSON.parse(on(agent, facter('networking --json')).stdout)
+
     step "Ensure the Networking fact resolves with reasonable values for at least one interface" do
-      expected_networking.each do |fact, value|
-        assert_match(value, fact_on(agent, fact).to_s)
+      expected_networking.each do |fact_tokens, regex|
+        assert_match(regex, networking_facts.dig(*fact_tokens).to_s)
       end
     end
 
     step "Ensure bindings for the primary networking interface are present" do
-      expected_bindings.each do |fact, value|
-        assert_match(value, fact_on(agent, fact).to_s)
+      expected_bindings.each do |fact_tokens, regex|
+        assert_match(regex, networking_facts.dig(*fact_tokens).to_s)
       end
     end
   end
 
   # Verify that IP Address v6 and network v6 is retrieved correctly and does not contain the interface identifier
   agents.each do |agent|
     if agent['platform'] =~ /windows/
-      step("verify that ipaddress6 is retrieved correctly") do
-        on(agent, facter("ipaddress6")) do |facter_result|
+      step "verify that ipaddress6 is retrieved correctly" do
+        on(agent, facter('ipaddress6')) do |facter_result|
           assert_match(/^[a-fA-F0-9:]+$/, facter_result.stdout.chomp)
         end
       end
 
-      step("verify that network6 is retrieved correctly") do
-        on(agent, facter("network6")) do |facter_result|
+      step "verify that network6 is retrieved correctly" do
+        on(agent, facter('network6')) do |facter_result|
           assert_match(/([a-fA-F0-9:]+)?:([a-fA-F0-9:]+)?$/, facter_result.stdout.chomp)
         end
       end

acceptance/tests/facts/networking_facts_with_secondary_ips.rb

@@ -0,0 +1,75 @@
+test_name 'networking facts with secondary ip' do
+  tag 'risk:high'
+
+  #
+  # This test is intended to ensure that networking facts resolve secondary ips
+  # as expected across supported platforms.
+  #
+
+  @ip_regex       = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/
+  @netmask_regex  = /^(((128|192|224|240|248|252|254)\.0\.0\.0)|(255\.(0|128|192|224|240|248|252|254)\.0\.0)|(255\.255\.(0|128|192|224|240|248|252|254)\.0)|(255\.255\.255\.(0|128|192|224|240|248|252|254)))$/
+
+  def expected_interfaces(interface, count)
+    expected_interfaces = {}
+    (1..count).each do |index|
+      expected_interfaces.merge!(expected_bindings(ip_name(interface, index), 1))
+      expected_interfaces.merge!(
+        {
+          ['networking', 'interfaces', "#{ip_name(interface, index)}", 'ip'] => @ip_regex,
+          ['networking', 'interfaces', "#{ip_name(interface, index)}", 'netmask'] => @netmask_regex,
+          ['networking', 'interfaces', "#{ip_name(interface, index)}", 'network'] => @ip_regex
+        }
+      )
+    end
+    expected_interfaces
+  end
+
+  def expected_bindings(interface, count)
+    expected_bindings = {}
+    (1..count).each do |index|
+      expected_bindings.merge!(
+        {
+          ['networking', 'interfaces', "#{interface}", 'bindings', index - 1, 'address'] => @ip_regex,
+          ['networking', 'interfaces', "#{interface}", 'bindings', index - 1, 'netmask'] => @netmask_regex,
+          ['networking', 'interfaces', "#{interface}", 'bindings', index - 1, 'network'] => @ip_regex
+        }
+      )
+    end
+    expected_bindings
+  end
+
+  def ip_name(interface, index)
+    "#{interface}:#{index}"
+  end
+
+  agents.each do |agent|
+    interface = fact_on(agent, 'networking.primary')
+
+    step "Add secondary ip without labels" do
+      on(agent, "ip addr add 11.0.0.0/24 dev #{interface}")
+    end
+
+    step "Add two secondary ips with label" do
+      on(agent, "ip addr add 11.0.0.1/24 dev #{interface} label #{ip_name(interface, 1)}")
+      on(agent, "ip addr add 11.0.0.2/24 dev #{interface} label #{ip_name(interface, 2)}")
+    end
+
+    networking_facts = JSON.parse(on(agent, facter('networking --json')).stdout)
+
+    step "Check secondary interfaces are found" do
+      expected_interfaces(interface, 2).each do |fact_tokens, regex|
+        assert_match(regex, networking_facts.dig(*fact_tokens).to_s)
+      end
+    end
+
+    step "Check secondary interfaces are inside the bindings of the primary interface" do
+      expected_bindings(interface, 4).each do |fact_tokens, regex|
+        assert_match(regex, networking_facts.dig(*fact_tokens).to_s)
+      end
+    end
+
+    teardown do
+      on(agent, "ip addr flush dev #{interface}")
+    end
+  end
+end

acceptance/tests/facts/networking_facts_with_vlans.rb

@@ -0,0 +1,58 @@
+test_name 'networking facts with vlans' do
+  tag 'risk:high'
+
+  #
+  # This test is intended to ensure that networking facts resolve vlans
+  # as expected across supported platforms.
+  #
+
+  @ip_regex       = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/
+  @netmask_regex  = /^(((128|192|224|240|248|252|254)\.0\.0\.0)|(255\.(0|128|192|224|240|248|252|254)\.0\.0)|(255\.255\.(0|128|192|224|240|248|252|254)\.0)|(255\.255\.255\.(0|128|192|224|240|248|252|254)))$/
+
+  def vlan(interface, index)
+    "#{interface}.#{index}"
+  end
+
+  def expected_bindings(interface, count)
+    expected_bindings = {}
+    (1..count).each do |index|
+      expected_bindings.merge!(
+        {
+          ['networking', 'interfaces', vlan(interface, index).to_s, 'bindings', 0, 'address'] => @ip_regex,
+          ['networking', 'interfaces', vlan(interface, index).to_s, 'bindings', 0, 'netmask'] => @netmask_regex,
+          ['networking', 'interfaces', vlan(interface, index).to_s, 'bindings', 0, 'network'] => @ip_regex,
+          %W[networking interfaces #{vlan(interface, index)} ip] => @ip_regex,
+          %W[networking interfaces #{vlan(interface, index)} mac] => /[a-f0-9]{2}:/,
+          %W[networking interfaces #{vlan(interface, index)} mtu] => /\d+/,
+          %W[networking interfaces #{vlan(interface, index)} netmask] => @netmask_regex,
+          %W[networking interfaces #{vlan(interface, index)} network] => @ip_regex
+        }
+      )
+    end
+    expected_bindings
+  end
+
+  agents.each do |agent|
+    interface = fact_on(agent, 'networking.primary')
+
+    step "Add two vlans" do
+      on(agent, "ip link add link #{interface} name #{vlan(interface, 1)} type vlan id 1")
+      on(agent, "ip addr add 11.0.0.1/24 dev #{vlan(interface, 1)}")
+      on(agent, "ip link add link #{interface} name #{vlan(interface, 2)} type vlan id 2")
+      on(agent, "ip addr add 11.0.0.2/24 dev #{vlan(interface, 2)}")
+    end
+
+    step "Check vlans are found" do
+      networking_facts = JSON.parse(on(agent, facter('networking --json')).stdout)
+
+      expected_bindings(interface, 2).each do |fact_tokens, regex|
+        assert_match(regex, networking_facts.dig(*fact_tokens).to_s)
+      end
+    end
+
+    teardown do
+      on(agent, "ip link delete #{vlan(interface, 1)}")
+      on(agent, "ip link delete #{vlan(interface, 2)}")
+    end
+  end
+end

lib/facter/facts/aix/memory/swap/available.rb

@@ -11,7 +11,7 @@ class Available
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:available_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

lib/facter/facts/aix/memory/swap/available_bytes.rb

@@ -13,7 +13,7 @@ def call_the_resolver
             fact_value = fact_value[:available_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

lib/facter/facts/aix/memory/swap/total.rb

@@ -11,7 +11,7 @@ class Total
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:total_bytes])
             end
             [Facter::ResolvedFact.new(FACT_NAME, fact_value), Facter::ResolvedFact.new(ALIASES, fact_value, :legacy)]
           end

lib/facter/facts/aix/memory/swap/total_bytes.rb

@@ -13,7 +13,7 @@ def call_the_resolver
             fact_value = fact_value[:total_bytes] if fact_value
 
             [Facter::ResolvedFact.new(FACT_NAME, fact_value),
-             Facter::ResolvedFact.new(ALIASES, Facter::FactsUtils::UnitConverter.bytes_to_mb(fact_value), :legacy)]
+             Facter::ResolvedFact.new(ALIASES, Facter::Util::Facts::UnitConverter.bytes_to_mb(fact_value), :legacy)]
           end
         end
       end

lib/facter/facts/aix/memory/swap/used.rb

@@ -10,7 +10,7 @@ class Used
           def call_the_resolver
             fact_value = Facter::Resolvers::Aix::Memory.resolve(:swap)
             if fact_value
-              fact_value = Facter::FactsUtils::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
+              fact_value = Facter::Util::Facts::UnitConverter.bytes_to_human_readable(fact_value[:used_bytes])
             end
             Facter::ResolvedFact.new(FACT_NAME, fact_value)
           end