(FACT-2872_2) Reimplement linux networking resolver

.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   Exclude:
     - acceptance/**/*
     - vendor/**/*
+    - lib/facter/resolvers/networking_linux_resolver.rb
 
 require:
   - rubocop-performance

.rubocop_todo.yml

@@ -1,12 +1,85 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 1000`
-# on 2020-09-22 15:44:45 +0300 using RuboCop version 0.81.0.
+# on 2020-12-10 18:21:07 +0200 using RuboCop version 0.81.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 76
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
+Layout/LeadingCommentSpace:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 127
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Lint/SafeNavigationChain:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 46
+
+# Offense count: 4
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 4
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 72
 # Configuration parameters: CustomTransform, IgnoreMethods, SpecSuffixOnly.
 RSpec/FilePath:
   Exclude:
@@ -28,9 +101,6 @@ 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/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'
@@ -52,9 +122,6 @@ RSpec/FilePath:
     - 'spec/facter/resolvers/solaris/solaris_release_resolver_spec.rb'
     - 'spec/facter/resolvers/suse_relese_resolver_spec.rb'
     - '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/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'
@@ -67,6 +134,7 @@ RSpec/FilePath:
     - 'spec/facter/resolvers/windows/system32_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/virtualization_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/win_os_description_resolver_spec.rb'
+    - 'spec/facter/util/windows/win32ole_spec.rb'
     - 'spec/framework/config/config_reader_spec.rb'
     - 'spec/framework/config/fact_groups_spec.rb'
     - 'spec/framework/core/fact/external/external_fact_manager_spec.rb'
@@ -106,7 +174,7 @@ RSpec/LeakyConstantDeclaration:
     - 'spec/facter/resolvers/macosx/mountpoints_resolver_spec.rb'
     - 'spec/facter/util/windows/network_utils_spec.rb'
 
-# Offense count: 93
+# Offense count: 92
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
@@ -172,7 +240,7 @@ RSpec/SubjectStub:
     - 'spec/custom_facts/util/fact_spec.rb'
     - 'spec/custom_facts/util/resolution_spec.rb'
 
-# Offense count: 123
+# Offense count: 122
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
@@ -201,15 +269,12 @@ RSpec/VerifiedDoubles:
     - 'spec/facter/facts/windows/virtualization/is_virtual_spec.rb'
     - 'spec/facter/facts/windows/virtualization/virtual_spec.rb'
     - 'spec/facter/query_parser_spec.rb'
-    - 'spec/facter/resolvers/aix/architecture_resolver_spec.rb'
     - 'spec/facter/resolvers/aix/ffi_helper_spec.rb'
     - 'spec/facter/resolvers/aix/hardware_resolver_spec.rb'
     - 'spec/facter/resolvers/bsd/ffi_helper_spec.rb'
     - '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/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'
@@ -220,9 +285,27 @@ RSpec/VerifiedDoubles:
     - 'spec/facter/resolvers/windows/system32_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/uptime_resolver_spec.rb'
     - 'spec/facter/resolvers/windows/win_os_description_resolver_spec.rb'
+    - 'spec/facter/util/windows/network_utils_spec.rb'
+    - 'spec/facter/util/windows/win32ole_spec.rb'
     - 'spec/framework/core/fact_loaders/external_fact_loader_spec.rb'
     - 'spec/framework/core/fact_manager_spec.rb'
     - 'spec/framework/core/session_cache_spec.rb'
     - 'spec/framework/formatters/hocon_fact_formatter_spec.rb'
     - 'spec/framework/formatters/json_fact_formatter_spec.rb'
     - 'spec/mocks/util.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords.
+# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW
+Style/CommentAnnotation:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/facter/resolvers/networking_linux_resolver.rb'

acceptance/lib/facter/acceptance/base_fact_utils.rb

@@ -483,6 +483,10 @@ def ubuntu_expected_facts(agent)
           os_arch                 = 'ppc64le'
           os_hardware             = 'ppc64le'
           processor_model_pattern = // # facter doesn't figure out the processor type on these machines
+        elsif agent['platform'] =~ /aarch64/
+          os_arch                 = 'aarch64'
+          os_hardware             = 'aarch64'
+          processor_model_pattern = // # facter doesn't figure out the processor type on these machines
         else
           os_arch     = 'i386'
           os_hardware = 'i686'

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