[git registry] Add "reference" key

azure-pipelines/e2e_ports/vcpkg-internal-e2e-test-port2/portfile.cmake

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

azure-pipelines/e2e_ports/vcpkg-internal-e2e-test-port2/vcpkg.json

@@ -0,0 +1,4 @@
+{
+	"name": "vcpkg-internal-e2e-test-port2",
+	"version-string": "1.0.0"
+}

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

@@ -64,17 +64,26 @@ try
         '-c', 'core.autocrlf=false'
     )
 
+    $gitMainBranch = 'main'
+    $gitSecondaryBranch = 'secondary'
+
     $CurrentTest = 'git init .'
     git @gitConfigOptions init .
     Throw-IfFailed
+
+    # Create git registry with vcpkg-internal-e2e-test-port in the main branch
+    $CurrentTest = 'git switch --orphan'
+    git @gitConfigOptions switch --orphan $gitMainBranch
+    Throw-IfFailed
+
     Copy-Item -Recurse -LiteralPath "$PSScriptRoot/../e2e_ports/vcpkg-internal-e2e-test-port" -Destination .
     New-Item -Path './vcpkg-internal-e2e-test-port/foobar' -Value 'this is just to get a distinct git tree'
 
     $CurrentTest = 'git add -A'
     git @gitConfigOptions add -A
     Throw-IfFailed
-    $CurrentTest = 'git commit'
-    git @gitConfigOptions commit -m 'initial commit'
+    $CurrentTest = 'git commit -m'
+    git @gitConfigOptions commit -m 'add vcpkg-internal-e2e-test-port'
     Throw-IfFailed
 
     $vcpkgInternalE2eTestPortGitTree = git rev-parse 'HEAD:vcpkg-internal-e2e-test-port'
@@ -103,12 +112,65 @@ try
     $CurrentTest = 'git add -A'
     git @gitConfigOptions add -A
     Throw-IfFailed
-    $CurrentTest = 'git commit'
+    $CurrentTest = 'git commit --amend --no-edit'
+    git @gitConfigOptions commit --amend --no-edit
+    Throw-IfFailed
+
+    $gitMainBaselineCommit = git rev-parse HEAD
+    $gitMainRefVersionsObject = git rev-parse HEAD:versions
+
+    # Create git registry with vcpkg-internal-e2e-test-port2 in the secondary branch
+
+    $CurrentTest = 'git switch --orphan'
+    git @gitConfigOptions switch --orphan $gitSecondaryBranch
+    Throw-IfFailed
+
+    Copy-Item -Recurse -LiteralPath "$PSScriptRoot/../e2e_ports/vcpkg-internal-e2e-test-port2" -Destination .
+    New-Item -Path './vcpkg-internal-e2e-test-port2/foobaz' -Value 'this is just to get a distinct git tree'
+
+    $CurrentTest = 'git add -A'
+    git @gitConfigOptions add -A
+    Throw-IfFailed
+    $CurrentTest = 'git commit -m'
+    git @gitConfigOptions commit -m 'add vcpkg-internal-e2e-test-port2'
+    Throw-IfFailed
+
+    $vcpkgInternalE2eTestPort2GitTree = git rev-parse 'HEAD:vcpkg-internal-e2e-test-port2'
+    $vcpkgInternalE2eTestPortVersionsJson = @{
+        "versions" = @(
+            @{
+                "version-string" = "1.0.0";
+                "git-tree" = $vcpkgInternalE2eTestPort2GitTree
+            }
+        )
+    }
+    $vcpkgBaseline = @{
+        "default" = @{
+            "vcpkg-internal-e2e-test-port2" = @{
+                "baseline" = "1.0.0"
+            }
+        }
+    }
+
+    New-Item -Path './versions' -ItemType Directory
+    New-Item -Path './versions/v-' -ItemType Directory
+
+    New-Item -Path './versions/baseline.json' -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgBaseline)
+    New-Item -Path './versions/v-/vcpkg-internal-e2e-test-port2.json' -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgInternalE2eTestPortVersionsJson)
+
+    $CurrentTest = 'git add -A'
+    git @gitConfigOptions add -A
+    Throw-IfFailed
+    $CurrentTest = 'git commit --amend --no-edit'
     git @gitConfigOptions commit --amend --no-edit
     Throw-IfFailed
 
-    $gitBaselineCommit = git rev-parse HEAD
-    $gitRefVersionsObject = git rev-parse HEAD:versions
+    $gitSecondaryBaselineCommit = git rev-parse HEAD
+    $gitSecondaryRefVersionsObject = git rev-parse HEAD:versions
+
+    $CurrentTest = 'git switch'
+    git @gitConfigOptions switch $gitMainBranch
+    Throw-IfFailed
 }
 finally
 {
@@ -117,18 +179,6 @@ finally
 
 # actually test the registries
 Write-Trace "actually test the registries"
-$vcpkgJson = @{
-    "name" = "manifest-test";
-    "version-string" = "1.0.0";
-    "dependencies" = @(
-        "vcpkg-internal-e2e-test-port"
-    );
-    # Use versioning features without a builtin-baseline
-    "overrides" = @(@{
-        "name" = "unused";
-        "version" = "0";
-    })
-}
 
 # test the filesystem registry
 Write-Trace "test the filesystem registry"
@@ -140,9 +190,18 @@ $manifestDir = (Get-Item $manifestDir).FullName
 Push-Location $manifestDir
 try
 {
-    New-Item -Path 'vcpkg.json' -ItemType File `
-        -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgJson)
-
+    $vcpkgJson = @{
+        "name" = "manifest-test";
+        "version-string" = "1.0.0";
+        "dependencies" = @(
+            "vcpkg-internal-e2e-test-port"
+        );
+        # Use versioning features without a builtin-baseline
+        "overrides" = @(@{
+            "name" = "unused";
+            "version" = "0";
+        })
+    }
     $vcpkgConfigurationJson = @{
         "default-registry" = $null;
         "registries" = @(
@@ -153,6 +212,8 @@ try
             }
         )
     }
+    New-Item -Path 'vcpkg.json' -ItemType File `
+        -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgJson)
     New-Item -Path 'vcpkg-configuration.json' -ItemType File `
         -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgConfigurationJson)
 
@@ -174,34 +235,64 @@ $manifestDir = (Get-Item $manifestDir).FullName
 Push-Location $manifestDir
 try
 {
-    New-Item -Path 'vcpkg.json' -ItemType File `
-        -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgJson)
+    $vcpkgJson = @{
+        "name" = "manifest-test";
+        "version-string" = "1.0.0";
+        "dependencies" = @(
+            "vcpkg-internal-e2e-test-port",
+            "vcpkg-internal-e2e-test-port2"
+        );
+        # Use versioning features without a builtin-baseline
+        "overrides" = @(@{
+            "name" = "unused";
+            "version" = "0";
+        })
+    }
 
     $vcpkgConfigurationJson = @{
         "default-registry" = $null;
         "registries" = @(
             @{
                 "kind" = "git";
                 "repository" = $gitRegistryUpstream;
-                "baseline" = $gitBaselineCommit;
-                "packages" = @( "vcpkg-internal-e2e-test-port" )
+                "baseline" = $gitMainBaselineCommit;
+                 "packages" = @( "vcpkg-internal-e2e-test-port" )
+            },
+            @{
+                "kind" = "git";
+                "repository" = $gitRegistryUpstream;
+                "reference" = $gitSecondaryBranch;
+                "baseline" = $gitSecondaryBaselineCommit;
+                 "packages" = @( "vcpkg-internal-e2e-test-port2" )
             }
         )
     }
+
+    New-Item -Path 'vcpkg.json' -ItemType File `
+        -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgJson)
+
     New-Item -Path 'vcpkg-configuration.json' -ItemType File `
         -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgConfigurationJson)
 
     Run-Vcpkg install @builtinRegistryArgs '--feature-flags=registries,manifests' --dry-run
     Throw-IfFailed
     Require-FileExists $env:X_VCPKG_REGISTRIES_CACHE/git-trees/$vcpkgInternalE2eTestPortGitTree
+    Require-FileExists $env:X_VCPKG_REGISTRIES_CACHE/git-trees/$vcpkgInternalE2eTestPort2GitTree
     # This is both the selected baseline as well as the current HEAD
-    Require-FileExists $env:X_VCPKG_REGISTRIES_CACHE/git-trees/$gitRefVersionsObject
+    Require-FileExists $env:X_VCPKG_REGISTRIES_CACHE/git-trees/$gitMainRefVersionsObject
+    Require-FileExists $env:X_VCPKG_REGISTRIES_CACHE/git-trees/$gitSecondaryRefVersionsObject
     # Dry run does not create a lockfile
     Require-FileNotExists $installRoot/vcpkg/vcpkg-lock.json
 
     Run-Vcpkg install @builtinRegistryArgs '--feature-flags=registries,manifests'
     Throw-IfFailed
-    Require-FileEquals $installRoot/vcpkg/vcpkg-lock.json "{`n  $(ConvertTo-Json $gitRegistryUpstream): `"$gitBaselineCommit`"`n}`n"
+
+    $expectedVcpkgLockJson = "{$(ConvertTo-Json $gitRegistryUpstream):{
+        `"HEAD`" : `"$gitMainBaselineCommit`",
+        `"$gitSecondaryBranch`" : `"$gitSecondaryBaselineCommit`"
+    }}"
+
+    Require-JsonFileEquals $installRoot/vcpkg/vcpkg-lock.json $expectedVcpkgLockJson
 
     # Using the lock file means we can reinstall without pulling from the upstream registry
     $vcpkgConfigurationJson = @{
@@ -210,18 +301,34 @@ try
             @{
                 "kind" = "git";
                 "repository" = "/"; # An invalid repository
-                "baseline" = $gitBaselineCommit;
-                "packages" = @( "vcpkg-internal-e2e-test-port" )
+                "baseline" = $gitMainBaselineCommit;
+                 "packages" = @( "vcpkg-internal-e2e-test-port" )
+            },
+            @{
+                "kind" = "git";
+                "repository" = "/"; # An invalid repository
+                "reference" = $gitSecondaryBranch;
+                "baseline" = $gitSecondaryBaselineCommit;
+                 "packages" = @( "vcpkg-internal-e2e-test-port2" )
             }
         )
     }
 
+    Set-Content -Path 'vcpkg-configuration.json' `
+        -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgConfigurationJson)
+
     Remove-Item -Recurse -Force $installRoot -ErrorAction SilentlyContinue
     Require-FileNotExists $installRoot
     New-Item -Path $installRoot/vcpkg -ItemType Directory
     # We pre-seed the install root with a lockfile for the invalid repository, so it isn't actually fetched from
-    New-Item -Path $installRoot/vcpkg/vcpkg-lock.json -ItemType File `
-        -Value "{`n  `"/`": `"$gitBaselineCommit`"`n}`n"
+    $vcpkgLockJson = @{
+        "/" = @{
+            "HEAD" = $gitMainBaselineCommit; 
+            $gitSecondaryBranch = $gitSecondaryBaselineCommit  
+        } 
+    }
+   New-Item -Path $installRoot/vcpkg/vcpkg-lock.json -ItemType File `
+        -Value (ConvertTo-Json -Depth 5 -InputObject $vcpkgLockJson)
     Run-Vcpkg install @builtinRegistryArgs '--feature-flags=registries,manifests'
     Throw-IfFailed
 }

azure-pipelines/end-to-end-tests-prelude.ps1

@@ -42,16 +42,21 @@ function Require-FileExists {
     }
 }
 
-function Require-FileEquals {
+function Require-JsonFileEquals {
     [CmdletBinding()]
     Param(
         [string]$File,
-        [string]$Content
+        [string]$Json
     )
     Require-FileExists $File
-    if ((Get-Content $File -Raw) -ne $Content) {
+    $ExpectedJson = $Json | ConvertFrom-Json | ConvertTo-Json -Compress
+    $ActualJson = Get-Content $File | ConvertFrom-Json | ConvertTo-Json -Compress
+
+    if ($ActualJson -ne $ExpectedJson) {
         Write-Stack
-        throw "'$Script:CurrentTest' file '$File' did not have the correct contents"
+        throw "'$Script:CurrentTest' file '$File' did not have the correct contents`n
+                Expected: $ExpectedJson`n
+                Actual:   $ActualJson"
     }
 }
 

include/vcpkg/registries.h

@@ -24,24 +24,28 @@ namespace vcpkg
     {
         struct EntryData
         {
-            std::string value;
+            std::string reference;
+            std::string commit_id;
             bool stale;
         };
+
+        using LockDataType = std::multimap<std::string, EntryData, std::less<>>;
         struct Entry
         {
             LockFile* lockfile;
-            std::map<std::string, EntryData, std::less<>>::iterator data;
+            LockDataType::iterator data;
 
-            const std::string& value() const { return data->second.value; }
+            const std::string& reference() const { return data->second.reference; }
+            const std::string& commit_id() const { return data->second.commit_id; }
             bool stale() const { return data->second.stale; }
             const std::string& uri() const { return data->first; }
 
             void ensure_up_to_date(const VcpkgPaths& paths) const;
         };
 
-        Entry get_or_fetch(const VcpkgPaths& paths, StringView key);
+        Entry get_or_fetch(const VcpkgPaths& paths, StringView repo, StringView reference);
 
-        std::map<std::string, EntryData, std::less<>> lockdata;
+        LockDataType lockdata;
         bool modified = false;
     };
 

src/vcpkg-test/registries.cpp

@@ -182,6 +182,23 @@ TEST_CASE ("registry_parsing", "[registries]")
         CHECK(!r.errors().empty());
     }
 
+    test_json = parse_json(R"json(
+{
+    "kind": "git",
+    "repository": "abc",
+    "baseline": "123",
+    "reference": "abc/def"
+}
+    )json");
+    {
+        Json::Reader r;
+        auto registry_impl = r.visit(test_json, *registry_impl_des);
+        REQUIRE(registry_impl);
+        CHECK(*registry_impl.get());
+        INFO(Strings::join("\n", r.errors()));
+        CHECK(r.errors().empty());
+    }
+
     test_json = parse_json(R"json(
 {
     "kind": "git",