Don't include features from skipped ports in CI runs.

azure-pipelines/e2e-assets/ci-skipped-features/baseline.txt

@@ -0,0 +1,5 @@
+skipped-depends:arm64-osx=skip
+skipped-depends:x64-linux=skip
+skipped-depends:x64-osx=skip
+skipped-depends:x64-windows=skip
+skipped-depends:x86-windows=skip

azure-pipelines/e2e-assets/ci-skipped-features/skipped-depends/portfile.cmake

@@ -0,0 +1 @@
+message(FATAL_ERROR "This port is skipped and should not be attempted.")

azure-pipelines/e2e-assets/ci-skipped-features/skipped-depends/vcpkg.json

@@ -0,0 +1,13 @@
+{
+  "name": "skipped-depends",
+  "version": "1.0.0",
+  "dependencies": [
+    {
+      "name": "skipped-features",
+      "default-features": false,
+      "features": [
+        "fail-if-included"
+      ]
+    }
+  ]
+}

azure-pipelines/e2e-assets/ci-skipped-features/skipped-features/portfile.cmake

@@ -0,0 +1,4 @@
+set(VCPKG_POLICY_EMPTY_PACKAGE enabled)
+if ("fail-if-included" IN_LIST FEATURES)
+    message(FATAL_ERROR "The feature 'fail-if-included' should not be included.")
+endif()

azure-pipelines/e2e-assets/ci-skipped-features/skipped-features/vcpkg.json

@@ -0,0 +1,9 @@
+{
+  "name": "skipped-features",
+  "version": "1.0.0",
+  "features": {
+    "fail-if-included": {
+      "description": "This feature should cause a failure if it is included in the build."
+    }
+  }
+}

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

@@ -5,61 +5,59 @@ $Output = Run-VcpkgAndCaptureOutput ci --dry-run --triplet=$Triplet --x-builtin-
 Throw-IfNotFailed
 $ErrorOutput = Run-VcpkgAndCaptureStdErr ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt"
 Throw-IfNotFailed
-if (-not ($Output.Contains("dep-on-feature-not-sup:${Triplet}:  cascade"))) {
-    throw 'dep-on-feature-not-sup must cascade because it depends on a features that is not supported'
-}
-if (-not ($Output.Contains("not-sup-host-b:${Triplet}:     skip"))) {
-    throw 'not-sup-host-b must be skipped because it is not supported'
-}
-if (-not ($Output.Contains("feature-not-sup:${Triplet}:        *"))) {
-    throw 'feature-not-sup must be built because the port that causes this port to skip should not be installed'
-}
-if (-not ($Output.Contains("feature-dep-missing:${Triplet}:        *"))) {
-    throw 'feature-dep-missing must be built because the broken feature is not selected.'
-}
+# dep-on-feature-not-sup must cascade because it depends on a features that is not supported
+Throw-IfNonContains -Actual $Output -Expected "dep-on-feature-not-sup:${Triplet}: cascade"
+# not-sup-host-b must be skipped because it is not supported
+Throw-IfNonContains -Actual $Output -Expected "not-sup-host-b:${Triplet}: unsupported"
+# feature-not-sup must be built because the port that causes this port to skip should not be installed
+Throw-IfNonContains -Actual $Output -Expected "feature-not-sup:${Triplet}:      *:"
+# feature-dep-missing must be built because the broken feature is not selected.
+Throw-IfNonContains -Actual $Output -Expected "feature-dep-missing:${Triplet}:      *:"
 if ($Output.Split("*").Length -ne 4) {
     throw 'base-port should not be installed for the host'
 }
-if (-not ($ErrorOutput.Contains("REGRESSION: not-sup-host-b:${Triplet} is marked as fail but not supported for ${Triplet}."))) {
-    throw "feature-not-sup's baseline fail entry should result in a regression because the port is not supported"
-}
-if (-not ($ErrorOutput.Contains("REGRESSION: dep-on-feature-not-sup:${Triplet} is marked as fail but one dependency is not supported for ${Triplet}."))) {
-    throw "feature-not-sup's baseline fail entry should result in a regression because the port is cascade for this triplet"
-}
+Throw-IfNonContains -Actual $Output -Expected @"
+SUMMARY FOR $Triplet
+  CASCADED_DUE_TO_MISSING_DEPENDENCIES: 1
+  EXCLUDED_BY_DRY_RUN: 3
+  UNSUPPORTED: 1
+"@
+# feature-not-sup's baseline fail entry should result in a regression because the port is not supported
+Throw-IfNonContains -Actual $ErrorOutput -Expected "REGRESSION: not-sup-host-b:${Triplet} is marked as fail but not supported for ${Triplet}."
+# feature-not-sup's baseline fail entry should result in a regression because the port is cascade for this triplet
+Throw-IfNonContains -Actual $ErrorOutput -Expected "REGRESSION: dep-on-feature-not-sup:${Triplet} is marked as fail but one dependency is not supported for ${Triplet}."
 
 # pass means pass
-$Output = Run-VcpkgAndCaptureOutput ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt"
+Run-Vcpkg ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt"
 Throw-IfNotFailed
 $ErrorOutput = Run-VcpkgAndCaptureStdErr ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.pass.baseline.txt"
 Throw-IfNotFailed
-if (-not ($ErrorOutput.Contains("REGRESSION: not-sup-host-b:${Triplet} is marked as pass but not supported for ${Triplet}."))) {
-    throw "feature-not-sup's baseline pass entry should result in a regression because the port is not supported"
-}
-if (-not ($ErrorOutput.Contains("REGRESSION: dep-on-feature-not-sup:${Triplet} is marked as pass but one dependency is not supported for ${Triplet}."))) {
-    throw "feature-not-sup's baseline pass entry should result in a regression because the port is cascade for this triplet"
-}
+# feature-not-sup's baseline pass entry should result in a regression because the port is not supported
+Throw-IfNonContains -Actual $ErrorOutput -Expected "REGRESSION: not-sup-host-b:${Triplet} is marked as pass but not supported for ${Triplet}."
+# feature-not-sup's baseline pass entry should result in a regression because the port is cascade for this triplet
+Throw-IfNonContains -Actual $ErrorOutput -Expected "REGRESSION: dep-on-feature-not-sup:${Triplet} cascaded, but it is required to pass. ("
 
 # any invalid manifest must raise an error
-$Output = Run-VcpkgAndCaptureOutput ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/broken-manifests"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt"
+Remove-Problem-Matchers
+Run-Vcpkg ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/broken-manifests"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt"
+Restore-Problem-Matchers
 Throw-IfNotFailed
 
 # test malformed individual overlay port manifest
 Remove-Problem-Matchers
 $Output = Run-VcpkgAndCaptureOutput ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt" --overlay-ports="$PSScriptRoot/../e2e-ports/broken-manifests/malformed"
 Restore-Problem-Matchers
 Throw-IfNotFailed
-if (-not ($Output.Contains("vcpkg.json:3:17: error: Trailing comma"))) {
-    throw 'malformed port manifest must raise a parsing error'
-}
+# malformed port manifest must raise a parsing error
+Throw-IfNonContains -Actual $Output -Expected "vcpkg.json:3:17: error: Trailing comma"
 
 # test malformed overlay port manifests
 Remove-Problem-Matchers
 $Output = Run-VcpkgAndCaptureOutput ci --dry-run --triplet=$Triplet --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci"  --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci/ci.baseline.txt" --overlay-ports="$PSScriptRoot/../e2e-ports/broken-manifests"
 Restore-Problem-Matchers
 Throw-IfNotFailed
-if (-not ($Output.Contains("vcpkg.json:3:17: error: Trailing comma"))) {
-    throw 'malformed overlay port manifest must raise a parsing error'
-}
+# malformed overlay manifest must raise a parsing error
+Throw-IfNonContains -Actual $Output -Expected "vcpkg.json:3:17: error: Trailing comma"
 
 # test that file conflicts are detected
 Remove-Item -Recurse -Force $installRoot -ErrorAction SilentlyContinue
@@ -68,8 +66,8 @@ Remove-Problem-Matchers
 $emptyDir = "$TestingRoot/empty"
 New-Item -ItemType Directory -Path $emptyDir -Force | Out-Null
 $Output = Run-VcpkgAndCaptureOutput ci @commonArgs --x-builtin-ports-root="$emptyDir" --binarysource=clear --overlay-ports="$PSScriptRoot/../e2e-ports/duplicate-file-a" --overlay-ports="$PSScriptRoot/../e2e-ports/duplicate-file-b"
-Throw-IfNotFailed
 Restore-Problem-Matchers
+Throw-IfNotFailed
 
 # test effect of parent hashes
 Remove-Item -Recurse -Force $installRoot -ErrorAction SilentlyContinue
@@ -86,6 +84,60 @@ Remove-Item -Recurse -Force $installRoot -ErrorAction SilentlyContinue
 New-Item -ItemType Directory -Path $installRoot -Force | Out-Null
 $Output = Run-VcpkgAndCaptureOutput ci @commonArgs --x-builtin-ports-root="$PSScriptRoot/../e2e-ports/ci" --binarysource="clear;files,$ArchiveRoot" --parent-hashes="$TestingRoot/parent-hashes.json"
 Throw-IfFailed
-if ($Output.Contains("base-port:${Triplet}: SUCCEEDED:")) {
-    throw 'base-port must not be rebuilt again'
+# base-port must not be rebuilt again
+Throw-IfNonContains -Actual $Output -Expected "base-port:${Triplet}: parent: "
+Throw-IfNonContains -Actual $Output -Expected @"
+SUMMARY FOR $Triplet
+  CASCADED_DUE_TO_MISSING_DEPENDENCIES: 1
+  EXCLUDED_BY_PARENT: 3
+  UNSUPPORTED: 1
+"@
+
+# test that features included only by skipped ports are not included
+$xunitFile = Join-Path $TestingRoot 'xunit.xml'
+Refresh-TestRoot
+Remove-Problem-Matchers
+$Output = Run-VcpkgAndCaptureOutput ci @commonArgs --x-builtin-ports-root="$PSScriptRoot/../e2e-assets/ci-skipped-features" --binarysource=clear --ci-baseline="$PSScriptRoot/../e2e-assets/ci-skipped-features/baseline.txt" --x-xunit-all --x-xunit="$xunitFile"
+Restore-Problem-Matchers
+Throw-IfFailed
+if (-not ($Output -match 'skipped-features:[^:]+:      \*:' -and $Output -match 'Building skipped-features:[^@]+@1\.0\.0\.\.\.')) {
+    throw 'did not attempt to build skipped-features'
+}
+Throw-IfNonContains -Actual $Output -Expected @"
+SUMMARY FOR $Triplet
+  SUCCEEDED: 1
+  EXCLUDED: 1
+"@
+
+$xunitContent = Get-Content $xunitFile -Raw
+$expected = @"
+<\?xml version="1\.0" encoding="utf-8"\?><assemblies>
+  <assembly name="skipped-depends" run-date="\d\d\d\d-\d\d-\d\d" run-time="\d\d:\d\d:\d\d" time="0">
+    <collection name="$Triplet" time="0">
+      <test name="skipped-depends:$Triplet" method="skipped-depends:$Triplet" time="0" result="Skip">
+        <traits>
+          <trait name="owner" value="$Triplet"/>
+        </traits>
+        <reason><!\[CDATA\[EXCLUDED\]\]></reason>
+      </test>
+    </collection>
+  </assembly>
+  <assembly name="skipped-features" run-date="\d\d\d\d-\d\d-\d\d" run-time="\d\d:\d\d:\d\d" time="0">
+    <collection name="$Triplet" time="0">
+      <test name="skipped-features:$Triplet" method="skipped-features\[core\]:$Triplet" time="0" result="Pass">
+        <traits>
+          <trait name="abi_tag" value="[^"]+"/>
+          <trait name="features" value="core"/>
+          <trait name="owner" value="$Triplet"/>
+        </traits>
+      </test>
+    </collection>
+  </assembly>
+</assemblies>
+
+"@
+
+if (-not ($xunitContent -match $expected)) {
+    Write-Diff -Actual $xunitContent -Expected $expected
+    throw 'xUnit output did not match expected output'
 }

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

@@ -234,16 +234,25 @@ function Set-EmptyTestPort {
     git -C $PortsRoot status
 }
 
+function Write-Diff {
+    Param(
+        [string]$Actual,
+        [string]$Expected
+    )
+
+    Set-Content -Value $Expected -LiteralPath "$TestingRoot/expected.txt"
+    Set-Content -Value $Actual -LiteralPath "$TestingRoot/actual.txt"
+    git diff --no-index -- "$TestingRoot/expected.txt" "$TestingRoot/actual.txt"
+    Write-Stack
+}
+
 function Throw-IfNonEqual {
     Param(
         [string]$Actual,
         [string]$Expected
     )
     if ($Actual -ne $Expected) {
-        Set-Content -Value $Expected -LiteralPath "$TestingRoot/expected.txt"
-        Set-Content -Value $Actual -LiteralPath "$TestingRoot/actual.txt"
-        git diff --no-index -- "$TestingRoot/expected.txt" "$TestingRoot/actual.txt"
-        Write-Stack
+        Write-Diff -Actual $Actual -Expected $Expected
         throw "Expected '$Expected' but got '$Actual'"
     }
 }
@@ -261,10 +270,7 @@ function Throw-IfNonEndsWith {
     }
 
     if ($actualSuffix -ne $Expected) {
-        Set-Content -Value $Expected -LiteralPath "$TestingRoot/expected.txt"
-        Set-Content -Value $Actual -LiteralPath "$TestingRoot/actual.txt"
-        git diff --no-index -- "$TestingRoot/expected.txt" "$TestingRoot/actual.txt"
-        Write-Stack
+        Write-Diff -Actual $Actual -Expected $Expected
         throw "Expected '$Expected' but got '$actualSuffix'"
     }
 }
@@ -275,10 +281,7 @@ function Throw-IfContains {
         [string]$Expected
     )
     if ($Actual.Contains($Expected)) {
-        Set-Content -Value $Expected -LiteralPath "$TestingRoot/expected.txt"
-        Set-Content -Value $Actual -LiteralPath "$TestingRoot/actual.txt"
-        git diff --no-index -- "$TestingRoot/expected.txt" "$TestingRoot/actual.txt"
-        Write-Stack
+        Write-Diff -Actual $Actual -Expected $Expected
         throw "Expected '$Expected' to not be in '$Actual'"
     }
 }
@@ -289,10 +292,7 @@ function Throw-IfNonContains {
         [string]$Expected
     )
     if (-not ($Actual.Contains($Expected))) {
-        Set-Content -Value $Expected -LiteralPath "$TestingRoot/expected.txt"
-        Set-Content -Value $Actual -LiteralPath "$TestingRoot/actual.txt"
-        git diff --no-index -- "$TestingRoot/expected.txt" "$TestingRoot/actual.txt"
-        Write-Stack
+        Write-Diff -Actual $Actual -Expected $Expected
         throw "Expected '$Expected' to be in '$Actual'"
     }
 }

include/vcpkg/base/checks.h

@@ -36,6 +36,7 @@ namespace vcpkg::Checks
     }
 
     // If expression is false, call exit_fail.
+    VCPKG_SAL_ANNOTATION(_Post_satisfies_(_Old_(expression)))
     void check_exit(const LineInfo& line_info, bool expression);
 
     // if expression is false, call exit_with_message.

include/vcpkg/base/json.h

@@ -1,6 +1,5 @@
 #pragma once
 
-#include <vcpkg/base/fwd/files.h>
 #include <vcpkg/base/fwd/json.h>
 
 #include <vcpkg/base/expected.h>
@@ -336,7 +335,6 @@ namespace vcpkg::Json
     };
 
     ExpectedL<ParsedJson> parse(StringView text, StringView origin);
-    ParsedJson parse_file(LineInfo li, const ReadOnlyFilesystem&, const Path&);
     ExpectedL<Json::Object> parse_object(StringView text, StringView origin);
 
     std::string stringify(const Value&);

include/vcpkg/base/message-data.inc.h

@@ -186,6 +186,11 @@ DECLARE_MESSAGE(ARegistryPathMustStartWithDollar,
                 "",
                 "A registry path must start with `$` to mean the registry root; for example, `$/foo/bar`.")
 DECLARE_MESSAGE(ARelaxedVersionString, (), "", "a relaxed version string")
+DECLARE_MESSAGE(
+    RequestedPortsNotInCIPlan,
+    (),
+    "",
+    "one or more ports requested to be installed were not present in the action plan. (Probably a vcpkg bug)")
 DECLARE_MESSAGE(ArtifactsBootstrapFailed, (), "", "vcpkg-artifacts is not installed and could not be bootstrapped.")
 DECLARE_MESSAGE(ArtifactsOptionIncompatibility, (msg::option), "", "--{option} has no effect on find artifact.")
 DECLARE_MESSAGE(ArtifactsOptionJson,
@@ -379,6 +384,11 @@ DECLARE_MESSAGE(BuildResultBuildFailed,
                 (),
                 "Printed after the name of an installed entity to indicate that it failed to build.",
                 "BUILD_FAILED")
+DECLARE_MESSAGE(BuildResultCached,
+                (),
+                "Printed after the name of an installed entity to indicate that it was not installed because it "
+                "already existed in a binary cache.",
+                "CACHED")
 DECLARE_MESSAGE(
     BuildResultCacheMissing,
     (),
@@ -400,6 +410,15 @@ DECLARE_MESSAGE(BuildResultExcluded,
                 "Printed after the name of an installed entity to indicate that the user explicitly "
                 "requested it not be installed.",
                 "EXCLUDED")
+DECLARE_MESSAGE(BuildResultExcludedByDryRun,
+                (),
+                "Printed after the name of an entity that would be installed, but is not due to --dry-run.",
+                "EXCLUDED_BY_DRY_RUN")
+DECLARE_MESSAGE(BuildResultExcludedByParent,
+                (),
+                "Printed after the name of an installed entity to indicate that it isn't tested due to an ABI hash in "
+                "--parent-hashes.",
+                "EXCLUDED_BY_PARENT")
 DECLARE_MESSAGE(
     BuildResultFileConflicts,
     (),
@@ -427,6 +446,11 @@ DECLARE_MESSAGE(BuildResultSummaryLine,
                 (msg::build_result, msg::count),
                 "Displayed to show a count of results of a build_result in a summary.",
                 "{build_result}: {count}")
+DECLARE_MESSAGE(
+    BuildResultUnsupported,
+    (),
+    "Printed after the name of an installed entity to indicate that it was not included due to a \"supports\" clause.",
+    "UNSUPPORTED")
 DECLARE_MESSAGE(BuildTreesRootDir, (), "", "Buildtrees directory (experimental)")
 DECLARE_MESSAGE(BuildTroubleshootingMessage1,
                 (),
@@ -467,10 +491,6 @@ DECLARE_MESSAGE(CiBaselineDisallowedCascade,
                 (msg::spec, msg::path),
                 "",
                 "REGRESSION: {spec} cascaded, but it is required to pass. ({path}).")
-DECLARE_MESSAGE(CiBaselineIndependentRegression,
-                (msg::spec, msg::build_result),
-                "",
-                "REGRESSION: Independent {spec} failed with {build_result}.")
 DECLARE_MESSAGE(CiBaselineRegression,
                 (msg::spec, msg::build_result, msg::path),
                 "",
@@ -495,10 +515,6 @@ DECLARE_MESSAGE(CiBaselineUnexpectedPass,
                 (msg::spec, msg::path),
                 "",
                 "PASSING, REMOVE FROM FAIL LIST: {spec} ({path}).")
-DECLARE_MESSAGE(CiBaselineUnexpectedPassCascade,
-                (msg::spec, msg::triplet),
-                "",
-                "REGRESSION: {spec} is marked as pass but one dependency is not supported for {triplet}.")
 DECLARE_MESSAGE(CiBaselineUnexpectedPassUnsupported,
                 (msg::spec, msg::triplet),
                 "",

include/vcpkg/base/messages.h

@@ -75,7 +75,8 @@ namespace vcpkg
     {
         LocalizedString() = default;
         operator StringView() const noexcept;
-        const std::string& data() const noexcept;
+        const std::string& data() const& noexcept;
+        std::string&& data() && noexcept;
         const std::string& to_string() const noexcept;
         std::string extract_data();
 

include/vcpkg/ci-baseline.h

@@ -42,15 +42,8 @@ namespace vcpkg
     {
         std::vector<TripletExclusions> triplets;
 
-        void insert(Triplet triplet);
         void insert(Triplet triplet, SortedVector<std::string>&& exclusions);
-    };
-
-    struct ExclusionPredicate
-    {
-        const ExclusionsMap* data;
-
-        bool operator()(const PackageSpec& spec) const;
+        bool is_excluded(const PackageSpec& spec) const;
     };
 
     std::vector<CiBaselineLine> parse_ci_baseline(StringView text, StringView origin, ParseMessages& messages);
@@ -69,6 +62,5 @@ namespace vcpkg
                                      BuildResult result,
                                      const CiBaselineData& cidata,
                                      const std::string* cifile,
-                                     bool allow_unexpected_passing,
-                                     bool is_independent);
+                                     bool allow_unexpected_passing);
 }