From a8970281ced199a43ca9b0a4d5b0b97aff02a2e2 Mon Sep 17 00:00:00 2001
From: Chris Roberts <code@chrisroberts.org>
Date: Mon, 10 Oct 2016 10:22:07 -0700
Subject: [PATCH] guests/linux: Properly sort interface name types

Add failing networking interface list sorting test with example
provided by #7883. Update sorting logic to properly handle different
types and differing array lengths.

Fixes #7883
---
 .../guests/linux/cap/network_interfaces.rb    | 20 ++++++++++++++++++-
 .../linux/cap/network_interfaces_test.rb      | 10 ++++++++--
 2 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/plugins/guests/linux/cap/network_interfaces.rb b/plugins/guests/linux/cap/network_interfaces.rb
index c66de24c4..9a7db83d1 100644
--- a/plugins/guests/linux/cap/network_interfaces.rb
+++ b/plugins/guests/linux/cap/network_interfaces.rb
@@ -23,6 +23,9 @@ module VagrantPlugins
           @@logger.debug("Unsorted list: #{ifaces.inspect}")
           # Break out integers from strings and sort the arrays to provide
           # a natural sort for the interface names
+          # NOTE: Devices named with a hex value suffix will _not_ be sorted
+          #  as expected. This is generally seen with veth* devices, and proper ordering
+          #  is currently not required
           ifaces = ifaces.map do |iface|
             iface.scan(/(.+?)(\d+)/).flatten.map do |iface_part|
               if iface_part.to_i.to_s == iface_part
@@ -31,7 +34,22 @@ module VagrantPlugins
                 iface_part
               end
             end
-          end.sort.map(&:join)
+          end
+          ifaces = ifaces.sort do |lhs, rhs|
+            result = 0
+            slice_length = [rhs.size, lhs.size].min
+            slice_length.times do |idx|
+              if(lhs[idx].is_a?(rhs[idx].class))
+                result = lhs[idx] <=> rhs[idx]
+              elsif(lhs[idx].is_a?(String))
+                result = 1
+              else
+                result = -1
+              end
+              break if result != 0
+            end
+            result
+          end.map(&:join)
           @@logger.debug("Sorted list: #{ifaces.inspect}")
           # Extract ethernet devices and place at start of list
           resorted_ifaces = []
diff --git a/test/unit/plugins/guests/linux/cap/network_interfaces_test.rb b/test/unit/plugins/guests/linux/cap/network_interfaces_test.rb
index 5c6a36546..5142beaa2 100644
--- a/test/unit/plugins/guests/linux/cap/network_interfaces_test.rb
+++ b/test/unit/plugins/guests/linux/cap/network_interfaces_test.rb
@@ -64,9 +64,15 @@ describe "VagrantPlugins::GuestLinux::Cap::NetworkInterfaces" do
     end
 
     it "does not include ethernet devices aliases within prefix device listing" do
-      expect(comm).to receive(:sudo).and_yield(:stdout, "eth1\neth2\ndocker0\nbridge0\neth0\neth0:0")
+      expect(comm).to receive(:sudo).and_yield(:stdout, "eth1\neth2\ndocker0\nbridge0\neth0\ndocker1\neth0:0")
       result = cap.network_interfaces(machine)
-      expect(result).to eq(["eth0", "eth1", "eth2", "bridge0", "docker0", "eth0:0"])
+      expect(result).to eq(["eth0", "eth1", "eth2", "bridge0", "docker0", "docker1", "eth0:0"])
+    end
+
+    it "properly sorts non-consistent device name formats" do
+      expect(comm).to receive(:sudo).and_yield(:stdout, "eth0\neth1\ndocker0\nveth437f7f9\nveth06b3e44\nveth8bb7081")
+      result = cap.network_interfaces(machine)
+      expect(result).to eq(["eth0", "eth1", "docker0", "veth8bb7081", "veth437f7f9", "veth06b3e44"])
     end
   end
 end