Fix overlay-ports behavior for manifest customers. (#1586)

In #1534 I introduced a bug which causes the builtin ports directory to "win" over declared command line --overlay-ports. This was not discovered in testing because the overlay-ports tests don't actually test with names that are also in the builtin ports directory.

Author: BillyONeal

azure-pipelines/e2e-projects/overlays-malformed-shadowing-builtin/builtin-malformed/a/portfile.cmake

@@ -0,0 +1,2 @@
+# This port is intentionally malformed and should not be loaded, because ../../a should be loaded instead
+set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

azure-pipelines/e2e-projects/overlays-malformed-shadowing-builtin/builtin-malformed/a/vcpkg.json

@@ -0,0 +1,5 @@
+{
+  "name": "a",
+  "version": "0",
+  "intentionally-malformed"
+}

azure-pipelines/e2e-projects/overlays-malformed-shadowing-builtin/config-overlays/a/portfile.cmake

@@ -0,0 +1 @@
+set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

azure-pipelines/e2e-projects/overlays-malformed-shadowing-builtin/config-overlays/a/vcpkg.json

@@ -0,0 +1,4 @@
+{
+  "name": "a",
+  "version": "0"
+}

azure-pipelines/e2e-projects/overlays-malformed-shadowing-builtin/vcpkg-configuration.json

@@ -0,0 +1,4 @@
+{
+  "$comment": "'config-overlays/a' in . should get loaded first, so we should never consider 'builtin-malformed/a'",
+  "overlay-ports": [ "config-overlays" ]
+}

azure-pipelines/e2e-projects/overlays-malformed-shadowing-builtin/vcpkg.json

@@ -0,0 +1,5 @@
+{
+	"dependencies": [
+		"a"
+	]
+}

azure-pipelines/end-to-end-tests-dir/overlays.ps1

@@ -6,6 +6,7 @@ $manifestInfoPath = Join-Path -Path $vcpkgDir -ChildPath "manifest-info.json"
 # Tests a simple project with overlay ports and triplets configured on a vcpkg-configuration.json file
 Copy-Item -Recurse -LiteralPath @(
     "$PSScriptRoot/../e2e-projects/overlays-malformed-shadowing",
+    "$PSScriptRoot/../e2e-projects/overlays-malformed-shadowing-builtin",
     "$PSScriptRoot/../e2e-projects/overlays-project-config-embedded",
     "$PSScriptRoot/../e2e-projects/overlays-project-with-config"
     ) $TestingRoot
@@ -40,9 +41,9 @@ try {
     --overlay-triplets=$manifestRoot/my-triplets `
     --x-install-root=$installRoot `
     --triplet fancy-config-embedded-triplet
-    Throw-IfFailed
+    Throw-IfFailed
 } finally {
-    popd
+    popd
 }
 
 # Config with bad paths
@@ -59,6 +60,11 @@ $manifestRoot = "$TestingRoot/overlays-malformed-shadowing"
 Run-Vcpkg install --x-manifest-root=$manifestRoot
 Throw-IfFailed
 
+# ... even if that subsequent port is the builtin root
+$manifestRoot = "$TestingRoot/overlays-malformed-shadowing-builtin"
+Run-Vcpkg install --x-manifest-root=$manifestRoot --x-builtin-ports-root "$manifestRoot/builtin-malformed"
+Throw-IfFailed
+
 # Test overlay_triplet paths remain relative to the manifest root after x-update-baseline
 $manifestRoot = "$TestingRoot/overlays-project-with-config"
 $configurationBefore = Get-Content "$manifestRoot/vcpkg-configuration.json" | ConvertFrom-Json

src/vcpkg/portfileprovider.cpp

@@ -257,14 +257,14 @@ namespace vcpkg
 
         OverlayPortIndex(const OverlayPortPaths& paths)
         {
-            if (auto builtin_overlay_port_dir = paths.builtin_overlay_port_dir.get())
+            for (auto&& overlay_port : paths.overlay_ports)
             {
-                m_entries.emplace_back(OverlayPortKind::Directory, *builtin_overlay_port_dir);
+                m_entries.emplace_back(OverlayPortKind::Unknown, overlay_port);
             }
 
-            for (auto&& overlay_port : paths.overlay_ports)
+            if (auto builtin_overlay_port_dir = paths.builtin_overlay_port_dir.get())
             {
-                m_entries.emplace_back(OverlayPortKind::Unknown, overlay_port);
+                m_entries.emplace_back(OverlayPortKind::Directory, *builtin_overlay_port_dir);
             }
         }