Merge pull request #13640 from chrisroberts/arch-networking

Fix arch guest networking setup

Author: chrisroberts

Diff for: lib/vagrant/util.rb

@@ -21,6 +21,7 @@ module Util
     autoload :FileMutex,                 'vagrant/util/file_mutex'
     autoload :GuestHosts,                'vagrant/util/guest_hosts'
     autoload :GuestInspection,           'vagrant/util/guest_inspection'
+    autoload :GuestNetworks,             'vagrant/util/guest_networks'
     autoload :HashWithIndifferentAccess, 'vagrant/util/hash_with_indifferent_access'
     autoload :HCLogFormatter,            'vagrant/util/logging_formatter'
     autoload :HCLogOutputter,            'vagrant/util/logging_formatter'

Diff for: lib/vagrant/util/guest_inspection.rb

@@ -26,6 +26,14 @@ def systemd_networkd?(comm)
           comm.test("systemctl -q is-active systemd-networkd.service", sudo: true)
         end
 
+        # NetworkManager.service is in use
+        #
+        # @param [Vagrant::Plugin::V2::Communicator] comm Guest communicator
+        # @return [Boolean]
+        def systemd_network_manager?(comm)
+          comm.test("systemctl -q is-active NetworkManager.service", sudo: true)
+        end
+
         # Check if a unit file with the given name is defined. Name can
         # be a pattern or explicit name.
         #

Diff for: lib/vagrant/util/guest_networks.rb

@@ -0,0 +1,107 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module Vagrant
+  module Util
+    # Helper methods for configuring guest networks
+    module GuestNetworks
+      module Linux
+        NETWORK_MANAGER_DEVICE_DIRECTORY = "/etc/NetworkManager/system-connections".freeze
+
+        def configure_network_manager(machine, networks, **opts)
+          comm = machine.communicate
+          nm_directory = opts.fetch(:nm_directory, NETWORK_MANAGER_DEVICE_DIRECTORY)
+
+          interfaces = machine.guest.capability(:network_interfaces)
+          net_configs = machine.config.vm.networks.find_all { |type, _| type.to_s.end_with?("_network") }.map(&:last)
+
+          # Get IDs of currently configured devices
+          current_devs = Hash.new.tap do |cd|
+            comm.execute("nmcli -t c show") do |type, data|
+              if type == :stdout
+                _, id, _, dev = data.strip.split(":")
+                cd[dev] = id
+              end
+            end
+          end
+
+          networks.each.with_index do |network, i|
+            net_opts = (net_configs[i] || {}).merge(network)
+            net_opts[:type] = net_opts[:type].to_s
+            net_opts[:device] = interfaces[network[:interface]]
+
+            if !net_opts[:mac_address]
+              comm.execute("cat /sys/class/net/#{net_opts[:device]}/address") do |type, data|
+                net_opts[:mac_address] = data if type == :stdout
+              end
+            end
+
+            tmpl_opts = {
+              interface_name: net_opts[:device],
+              type: net_opts[:type],
+              mac_address: net_opts[:mac_address],
+              uuid: SecureRandom.uuid
+            }
+
+            if net_opts[:type] != "dhcp"
+              begin
+                addr = IPAddr.new("#{net_opts[:ip]}")
+                if addr.ipv4?
+                  tmpl_opts[:ipv4] = addr.to_string
+                  masked = addr.mask(net_opts[:netmask])
+
+                  tmpl_opts[:ipv4_mask] = masked.prefix
+                  tmpl_opts[:ipv4_gateway] = masked.succ.to_string
+                else
+                  tmpl_opts[:ipv6] = addr.to_string
+                  masked = addr.mask(net_opts[:netmask])
+
+                  tmpl_opts[:ipv6_mask] = masked.prefix
+                  tmpl_opts[:ipv6_gateway] = masked.succ.to_string
+                end
+              rescue IPAddr::Error => err
+                raise NetworkAddressInvalid,
+                      address: net_opts[:ip],
+                      mask: net_opts[:netmask],
+                      error: err.to_s
+              end
+            end
+
+            entry = TemplateRenderer.render("networking/network_manager/network_manager_device", options: tmpl_opts)
+            remote_path = "/tmp/vagrant-network-entry-#{net_opts[:device]}-#{Time.now.to_i}-#{i}"
+            final_path = "#{nm_directory}/#{net_opts[:device]}.nmconnection"
+
+            Tempfile.open("vagrant-nm-configure-networks") do |f|
+              f.binmode
+              f.write(entry)
+              f.fsync
+              f.close
+              comm.upload(f.path, remote_path)
+            end
+
+            # Remove the device if it already exists
+            if device_id = current_devs[net_opts[:device]]
+              [
+                "nmcli d disconnect '#{net_opts[:device]}'",
+                "nmcli c delete '#{device_id}'",
+              ].each do |cmd|
+                comm.sudo(cmd, error_check: false)
+              end
+            end
+
+            # Apply the config
+            [
+              "chown root:root '#{remote_path}'",
+              "chmod 0600 '#{remote_path}'",
+              "mv '#{remote_path}' '#{final_path}'",
+              "nmcli c load '#{final_path}'",
+              "nmcli d connect '#{net_opts[:device]}'"
+            ].each do |cmd|
+              comm.sudo(cmd)
+            end
+          end
+        end
+      end
+    end
+  end
+end

Diff for: plugins/guests/arch/cap/configure_networks.rb

@@ -13,9 +13,13 @@ module Cap
       class ConfigureNetworks
         include Vagrant::Util
         extend Vagrant::Util::GuestInspection::Linux
+        extend Vagrant::Util::GuestNetworks::Linux
 
         def self.configure_networks(machine, networks)
           comm = machine.communicate
+
+          return configure_network_manager(machine, networks) if systemd_network_manager?(comm)
+
           commands = []
           uses_systemd_networkd = systemd_networkd?(comm)
 

Diff for: plugins/guests/redhat/cap/configure_networks.rb

@@ -12,6 +12,7 @@ module Cap
       class ConfigureNetworks
         include Vagrant::Util
         extend Vagrant::Util::GuestInspection::Linux
+        extend Vagrant::Util::GuestNetworks::Linux
 
         def self.configure_networks(machine, networks)
           @logger = Log4r::Logger.new("vagrant::guest::redhat::configurenetworks")
@@ -23,98 +24,11 @@ def self.configure_networks(machine, networks)
           # The legacy configuration will handle rhel/centos pre-10
           # versions. The newer versions have a different path for
           # network configuration files.
-
-          return configure_networks_legacy(machine, networks) if network_scripts_dir.end_with?("network-scripts")
-
-          comm = machine.communicate
-
-          interfaces = machine.guest.capability(:network_interfaces)
-          net_configs = machine.config.vm.networks.find_all { |type, _| type.to_s.end_with?("_network") }.map(&:last)
-
-          # Get IDs of currently configured devices
-          current_devs = Hash.new.tap do |cd|
-            comm.execute("nmcli -t c show") do |type, data|
-              if type == :stdout
-                _, id, _, dev = data.strip.split(":")
-                cd[dev] = id
-              end
-            end
-          end
-
-          networks.each.with_index do |network, i|
-            net_opts = (net_configs[i] || {}).merge(network)
-            net_opts[:type] = net_opts[:type].to_s
-            net_opts[:device] = interfaces[network[:interface]]
-
-            if !net_opts[:mac_address]
-              comm.execute("cat /sys/class/net/#{net_opts[:device]}/address") do |type, data|
-                net_opts[:mac_address] = data if type == :stdout
-              end
-            end
-
-            tmpl_opts = {
-              interface_name: net_opts[:device],
-              type: net_opts[:type],
-              mac_address: net_opts[:mac_address],
-              uuid: SecureRandom.uuid
-            }
-
-            if net_opts[:type] != "dhcp"
-              begin
-                addr = IPAddr.new("#{net_opts[:ip]}")
-                if addr.ipv4?
-                  tmpl_opts[:ipv4] = addr.to_string
-                  masked = addr.mask(net_opts[:netmask])
-
-                  tmpl_opts[:ipv4_mask] = masked.prefix
-                  tmpl_opts[:ipv4_gateway] = masked.succ.to_string
-                else
-                  tmpl_opts[:ipv6] = addr.to_string
-                  masked = addr.mask(net_opts[:netmask])
-
-                  tmpl_opts[:ipv6_mask] = masked.prefix
-                  tmpl_opts[:ipv6_gateway] = masked.succ.to_string
-                end
-              rescue IPAddr::Error => err
-                raise NetworkAddressInvalid,
-                  address: net_opts[:ip],
-                  mask: net_opts[:netmask],
-                  error: err.to_s
-              end
-            end
-
-            entry = TemplateRenderer.render("guests/redhat/network_manager_device", options: tmpl_opts)
-            remote_path = "/tmp/vagrant-network-entry-#{net_opts[:device]}-#{Time.now.to_i}-#{i}"
-            final_path = "#{network_scripts_dir}/#{net_opts[:device]}.nmconnection"
-
-            Tempfile.open("vagrant-redhat-configure-networks") do |f|
-              f.binmode
-              f.write(entry)
-              f.fsync
-              f.close
-              comm.upload(f.path, remote_path)
-            end
-
-            # Remove the device if it already exists
-            if device_id = current_devs[net_opts[:device]]
-              [
-                "nmcli d disconnect '#{net_opts[:device]}'",
-                "nmcli c delete '#{device_id}'",
-              ].each do |cmd|
-                comm.sudo(cmd, error_check: false)
-              end
-            end
-
-            # Apply the config
-            [
-              "chown root:root '#{remote_path}'",
-              "chmod 0600 '#{remote_path}'",
-              "mv '#{remote_path}' '#{final_path}'",
-              "nmcli c load '#{final_path}'",
-              "nmcli d connect '#{net_opts[:device]}'"
-            ].each do |cmd|
-              comm.sudo(cmd)
-            end
+          if network_scripts_dir.end_with?("network-scripts")
+            configure_networks_legacy(machine, networks)
+          else
+            # Recent versions use Network Manager
+            configure_network_manager(machine, networks)
           end
         end
 

Diff for: templates/guests/redhat/network_manager_device.erb renamed to templates/networking/network_manager/network_manager_device.erb

@@ -29,6 +29,7 @@
       allow(guest).to receive(:capability).with(:network_interfaces)
         .and_return(["eth1", "eth2"])
       allow(cap).to receive(:systemd_networkd?).and_return(true)
+      allow(cap).to receive(:systemd_network_manager?).and_return(false)
     end
 
     let(:network_1) do
@@ -81,5 +82,17 @@
         expect(comm.received_commands[0]).to match(/netctl enable 'eth2'/)
       end
     end
+
+    context "network is controlled by NetworkManager via systemd" do
+      before do
+        expect(cap).to receive(:systemd_network_manager?).and_return(true)
+      end
+
+      it "should configure for network manager" do
+        expect(cap).to receive(:configure_network_manager).with(machine, [network_1])
+
+        cap.configure_networks(machine, [network_1])
+      end
+    end
   end
 end