Add license reporting and "vcpkg license-report" command.

azure-pipelines/e2e-ports/vcpkg-license-bsd-on-mit/portfile.cmake

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

azure-pipelines/e2e-ports/vcpkg-license-bsd-on-mit/vcpkg.json

@@ -0,0 +1,8 @@
+{
+  "name": "vcpkg-license-bsd-on-mit",
+  "version": "0",
+  "license": "BSD-3-Clause",
+  "dependencies": [
+    "vcpkg-license-mit"
+  ]
+}

azure-pipelines/e2e-ports/vcpkg-license-bsd/portfile.cmake

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

azure-pipelines/e2e-ports/vcpkg-license-bsd/vcpkg.json

@@ -0,0 +1,5 @@
+{
+  "name": "vcpkg-license-bsd",
+  "version": "0",
+  "license": "BSD-3-Clause"
+}

azure-pipelines/e2e-ports/vcpkg-license-mit/portfile.cmake

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

azure-pipelines/e2e-ports/vcpkg-license-mit/vcpkg.json

@@ -0,0 +1,5 @@
+{
+  "name": "vcpkg-license-mit",
+  "version": "0",
+  "license": "MIT"
+}

azure-pipelines/e2e-ports/vcpkg-license-null/portfile.cmake

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

azure-pipelines/e2e-ports/vcpkg-license-null/vcpkg.json

@@ -0,0 +1,5 @@
+{
+  "name": "vcpkg-license-null",
+  "version": "0",
+  "license": null
+}

azure-pipelines/end-to-end-tests-dir/build-test-ports.ps1

@@ -58,9 +58,10 @@ The following packages are already installed:
 
 $output = Run-VcpkgAndCaptureOutput @commonArgs --overlay-ports="$PSScriptRoot/../e2e-ports" install vcpkg-internal-e2e-test-port3 --head
 Throw-IfFailed
-if ($output -notmatch 'vcpkg-internal-e2e-test-port3:[^ ]+ is already installed -- not building from HEAD') {
-    throw 'Wrong already installed message for --head'
-}
+Throw-IfNonContains -Actual $output -Expected @"
+The following packages are already installed, but were requested at --head version. Their installed contents will not be changed. To get updated versions, remove these packages first:
+    vcpkg-internal-e2e-test-port3:
+"@
 
 Refresh-TestRoot
 $output = Run-VcpkgAndCaptureOutput @commonArgs --x-builtin-ports-root="$PSScriptRoot/../e2e-ports" install vcpkg-bad-spdx-license

azure-pipelines/end-to-end-tests-dir/license-report.ps1

@@ -0,0 +1,90 @@
+. $PSScriptRoot/../end-to-end-tests-prelude.ps1
+
+[string]$output = Run-VcpkgAndCaptureOutput @commonArgs license-report "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports"
+Throw-IfFailed
+Throw-IfNonEqual -Actual $output -Expected @"
+There are no installed packages, and thus no licenses of installed packages. Did you mean to install something first?
+
+"@
+
+$output = Run-VcpkgAndCaptureOutput @commonArgs install "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports" vcpkg-license-bsd vcpkg-license-mit
+Throw-IfFailed
+Throw-IfNonContains -Actual $output -Expected @"
+Packages installed in this vcpkg installation declare the following licenses:
+BSD-3-Clause
+MIT
+"@
+
+$output = Run-VcpkgAndCaptureOutput @commonArgs license-report "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports"
+Throw-IfFailed
+Throw-IfNonEqual -Actual $output -Expected @"
+Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
+Installed packages declare the following licenses:
+BSD-3-Clause
+MIT
+
+"@
+
+# Note that the MIT license already is not displayed
+$output = Run-VcpkgAndCaptureOutput @commonArgs install "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports" vcpkg-license-bsd-on-mit
+Throw-IfFailed
+Throw-IfNonContains -Actual $output -Expected @"
+Packages installed in this vcpkg installation declare the following licenses:
+BSD-3-Clause
+"@
+
+$output = Run-VcpkgAndCaptureOutput @commonArgs license-report "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports"
+Throw-IfFailed
+Throw-IfNonEqual -Actual $output -Expected @"
+Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
+Installed packages declare the following licenses:
+BSD-3-Clause
+MIT
+
+"@
+
+# Empty port == no license field set at all
+$output = Run-VcpkgAndCaptureOutput @commonArgs install "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports" vcpkg-empty-port
+Throw-IfFailed
+Throw-IfNonContains -Actual $output -Expected @"
+Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
+Some packages did not declare an SPDX license. Check the ``copyright`` file for each package for more information about their licensing.
+"@
+
+$output = Run-VcpkgAndCaptureOutput @commonArgs license-report "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports"
+Throw-IfFailed
+Throw-IfNonEqual -Actual $output -Expected @"
+Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
+Some packages did not declare an SPDX license. Check the ``copyright`` file for each package for more information about their licensing.
+Installed packages declare the following licenses:
+BSD-3-Clause
+MIT
+
+"@
+
+Run-Vcpkg @commonArgs remove "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports" vcpkg-license-bsd
+Throw-IfFailed
+
+# bsd-on-mit is still here so no change
+$output = Run-VcpkgAndCaptureOutput @commonArgs license-report "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports"
+Throw-IfFailed
+Throw-IfNonEqual -Actual $output -Expected @"
+Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
+Some packages did not declare an SPDX license. Check the ``copyright`` file for each package for more information about their licensing.
+Installed packages declare the following licenses:
+BSD-3-Clause
+MIT
+
+"@
+
+Run-Vcpkg @commonArgs remove "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports" vcpkg-license-bsd-on-mit vcpkg-license-mit
+Throw-IfFailed
+
+# Only unknown left
+$output = Run-VcpkgAndCaptureOutput @commonArgs license-report "--x-builtin-ports-root=$PSScriptRoot/../e2e-ports"
+Throw-IfFailed
+Throw-IfNonEqual -Actual $output -Expected @"
+Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
+Some packages did not declare an SPDX license. Check the ``copyright`` file for each package for more information about their licensing.
+
+"@

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

@@ -89,7 +89,7 @@ Throw-IfNotFailed
 if ($output -notmatch @"
 warning: In octopus, 1.0 is completely new version, so the "port-version" field should be removed. Remove "port-version", commit that change, and try again. To skip this check, rerun with --skip-version-format-check .
 "@) {
-    throw "Expected detecting present port-version when a new version is added as bad"
+    throw "Expected detecting present port-version when a new version is added as bad"
 }
 
 Run-Vcpkg @portsRedirectArgsOK x-add-version octopus --skip-version-format-check
@@ -105,7 +105,7 @@ Throw-IfNotFailed
 if ($output -notmatch @"
 warning: In octopus, 2.0 is completely new version, so the "port-version" field should be removed. Remove "port-version", commit that change, and try again. To skip this check, rerun with --skip-version-format-check .
 "@) {
-    throw "Expected detecting present port-version when a new version is added as bad"
+    throw "Expected detecting present port-version when a new version is added as bad"
 }
 
 Run-Vcpkg @portsRedirectArgsOK x-add-version octopus --skip-version-format-check
@@ -121,7 +121,7 @@ Throw-IfNotFailed
 if ($output -notmatch @"
 warning: In octopus, the current "port-version" for 2.0 is 1, so the next added "port-version" should be 2, but the port declares "port-version" 3. Change "port-version" to 2, commit that change, and try again. To skip this check, rerun with --skip-version-format-check .
 "@) {
-    throw "Expected detecting present port-version when a new version is added as bad"
+    throw "Expected detecting present port-version when a new version is added as bad"
 }
 
 Run-Vcpkg @portsRedirectArgsOK x-add-version octopus --skip-version-format-check

include/vcpkg/base/contractual-constants.h

@@ -344,6 +344,8 @@ namespace vcpkg
     inline constexpr StringLiteral FilePortfileDotCMake = "portfile.cmake";
     inline constexpr StringLiteral FileShare = "share";
     inline constexpr StringLiteral FileStatus = "status";
+    inline constexpr StringLiteral FileStatusNew = "status-new";
+    inline constexpr StringLiteral FileStatusOld = "status-old";
     inline constexpr StringLiteral FileTools = "tools";
     inline constexpr StringLiteral FileUpdates = "updates";
     inline constexpr StringLiteral FileUsage = "usage";

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

@@ -137,12 +137,7 @@ DECLARE_MESSAGE(AllFormatArgsUnbalancedBraces,
                 (msg::value),
                 "example of {value} is 'foo bar {'",
                 "unbalanced brace in format string \"{value}\"")
-DECLARE_MESSAGE(AllPackagesAreUpdated, (), "", "All installed packages are up-to-date.")
-DECLARE_MESSAGE(AlreadyInstalled, (msg::spec), "", "{spec} is already installed")
-DECLARE_MESSAGE(AlreadyInstalledNotHead,
-                (msg::spec),
-                "'HEAD' means the most recent version of source code",
-                "{spec} is already installed -- not building from HEAD")
+DECLARE_MESSAGE(AllPackagesAreUpdated, (), "", "No action taken because all installed packages are up-to-date.")
 DECLARE_MESSAGE(AManifest, (), "", "a manifest")
 DECLARE_MESSAGE(AMaximumOfOneAssetReadUrlCanBeSpecified, (), "", "a maximum of one asset read url can be specified.")
 DECLARE_MESSAGE(AMaximumOfOneAssetWriteUrlCanBeSpecified, (), "", "a maximum of one asset write url can be specified.")
@@ -735,6 +730,7 @@ DECLARE_MESSAGE(CmdInstallExample1,
                 "This is a command line, only the <> parts should be localized",
                 "vcpkg install <port name> <port name>...")
 DECLARE_MESSAGE(CmdIntegrateSynopsis, (), "", "Integrates vcpkg with machines, projects, or shells")
+DECLARE_MESSAGE(CmdLicenseReportSynopsis, (), "", "Displays the declared licenses of all ports in the installed tree")
 DECLARE_MESSAGE(CmdListExample2,
                 (),
                 "This is a command line, only the <filter> part should be localized",
@@ -1168,10 +1164,10 @@ DECLARE_MESSAGE(ExpectedCharacterHere,
 DECLARE_MESSAGE(ExpectedDefaultFeaturesList, (), "", "expected ',' or end of text in default features list")
 DECLARE_MESSAGE(ExpectedDependenciesList, (), "", "expected ',' or end of text in dependencies list")
 DECLARE_MESSAGE(ExpectedDigitsAfterDecimal, (), "", "Expected digits after the decimal point")
+DECLARE_MESSAGE(ExpectedExplicitTriplet, (), "", "expected an explicit triplet")
 DECLARE_MESSAGE(ExpectedFailOrSkip, (), "", "expected 'fail', 'skip', or 'pass' here")
 DECLARE_MESSAGE(ExpectedFeatureListTerminal, (), "", "expected ',' or ']' in feature list")
 DECLARE_MESSAGE(ExpectedFeatureName, (), "", "expected feature name (must be lowercase, digits, '-')")
-DECLARE_MESSAGE(ExpectedExplicitTriplet, (), "", "expected an explicit triplet")
 DECLARE_MESSAGE(ExpectedInstallStateField,
                 (),
                 "The values in ''s are locale-invariant",
@@ -1734,6 +1730,11 @@ DECLARE_MESSAGE(InstallCopiedFile,
                 "{path_source} -> {path_destination} done")
 DECLARE_MESSAGE(InstalledBy, (msg::path), "", "Installed by {path}")
 DECLARE_MESSAGE(InstalledPackages, (), "", "The following packages are already installed:")
+DECLARE_MESSAGE(InstalledPackagesHead,
+                (),
+                "",
+                "The following packages are already installed, but were requested at --head version. Their installed "
+                "contents will not be changed. To get updated versions, remove these packages first:")
 DECLARE_MESSAGE(InstalledRequestedPackages, (), "", "All requested packages are currently installed.")
 DECLARE_MESSAGE(InstallFailed, (msg::path, msg::error_msg), "", "failed: {path}: {error_msg}")
 DECLARE_MESSAGE(InstallingMavenFileFailure,
@@ -2147,6 +2148,11 @@ DECLARE_MESSAGE(NoInstalledPackages,
                 (),
                 "The name 'search' is the name of a command that is not localized.",
                 "No packages are installed. Did you mean `search`?")
+DECLARE_MESSAGE(NoInstalledPackagesLicenseReport,
+                (),
+                "",
+                "There are no installed packages, and thus no licenses of installed packages. Did you mean to install "
+                "something first?")
 DECLARE_MESSAGE(NonExactlyArgs,
                 (msg::command_name, msg::expected, msg::actual),
                 "{expected} and {actual} are integers",
@@ -2214,6 +2220,21 @@ DECLARE_MESSAGE(OverwritingFile, (msg::path), "", "File {path} was already prese
 DECLARE_MESSAGE(PackageAbi, (msg::spec, msg::package_abi), "", "{spec} package ABI: {package_abi}")
 DECLARE_MESSAGE(PackageAlreadyRemoved, (msg::spec), "", "unable to remove {spec}: already removed")
 DECLARE_MESSAGE(PackageDiscoveryHeader, (), "", "Package Discovery")
+DECLARE_MESSAGE(PackageLicenseSpdx, (), "", "Installed packages declare the following licenses:")
+DECLARE_MESSAGE(PackageLicenseSpdxThisInstall,
+                (),
+                "",
+                "Packages installed in this vcpkg installation declare the following licenses:")
+DECLARE_MESSAGE(PackageLicenseUnknown,
+                (),
+                "",
+                "Some packages did not declare an SPDX license. Check the `copyright` file for each package for more "
+                "information about their licensing.")
+DECLARE_MESSAGE(PackageLicenseWarning,
+                (),
+                "",
+                "Installed contents are licensed to you by owners. Microsoft is not responsible for, nor does it grant "
+                "any licenses to, third-party packages.")
 DECLARE_MESSAGE(PackageManipulationHeader, (), "", "Package Manipulation")
 DECLARE_MESSAGE(PackageInfoHelp, (), "", "Display detailed information on packages")
 DECLARE_MESSAGE(PackageFailedtWhileExtracting,
@@ -2719,6 +2740,10 @@ DECLARE_MESSAGE(ToRemovePackages,
                 "",
                 "To only remove outdated packages, run\n{command_name} remove --outdated")
 DECLARE_MESSAGE(TotalInstallTime, (msg::elapsed), "", "Total install time: {elapsed}")
+DECLARE_MESSAGE(TotalInstallTimeSuccess,
+                (msg::elapsed),
+                "",
+                "All requested installations completed successfully in: {elapsed}")
 DECLARE_MESSAGE(ToUpdatePackages,
                 (msg::command_name),
                 "",

include/vcpkg/commands.install.h

@@ -37,14 +37,23 @@ namespace vcpkg
         PackageSpec m_spec;
     };
 
+    struct LicenseReport
+    {
+        bool any_unknown_licenses = false;
+        std::set<std::string> named_licenses;
+        void print_license_report(const msg::MessageT<>& named_license_heading) const;
+    };
+
     struct InstallSummary
     {
         std::vector<SpecSummary> results;
+        ElapsedTime timing;
+        LicenseReport license_report;
+        bool failed = false;
 
-        LocalizedString format() const;
+        LocalizedString format_results() const;
         void print_failed() const;
-        std::string xunit_results() const;
-        bool failed() const;
+        void print_complete_message() const;
     };
 
     struct InstallDir

include/vcpkg/commands.license-report.h

@@ -0,0 +1,10 @@
+#pragma once
+
+#include <vcpkg/fwd/vcpkgcmdarguments.h>
+#include <vcpkg/fwd/vcpkgpaths.h>
+
+namespace vcpkg
+{
+    extern const CommandMetadata CommandLicenseReportMetadata;
+    void command_license_report_and_exit(const VcpkgCmdArguments& args, const VcpkgPaths& paths);
+}

include/vcpkg/dependencies.h

@@ -209,7 +209,10 @@ namespace vcpkg
     struct FormattedPlan
     {
         bool has_removals = false;
-        LocalizedString text;
+        LocalizedString warning_text;
+        LocalizedString normal_text;
+
+        LocalizedString all_text() const;
     };
 
     FormattedPlan format_plan(const ActionPlan& action_plan, const Path& builtin_ports_dir);

include/vcpkg/spdx.h

@@ -6,6 +6,7 @@
 
 #include <vcpkg/fwd/dependencies.h>
 
+#include <vcpkg/base/optional.h>
 #include <vcpkg/base/span.h>
 
 #include <string>
@@ -29,5 +30,7 @@ namespace vcpkg
                                  std::string document_namespace,
                                  std::vector<Json::Object>&& resource_docs);
 
+    Optional<std::string> read_spdx_license(StringView text, StringView origin);
+
     Json::Object run_resource_heuristics(StringView contents, StringView portRawVersion);
 }

include/vcpkg/vcpkglib.h

@@ -13,7 +13,8 @@
 
 namespace vcpkg
 {
-    StatusParagraphs database_load_check(const Filesystem& fs, const InstalledPaths& installed);
+    StatusParagraphs database_load(const ReadOnlyFilesystem& fs, const InstalledPaths& installed);
+    StatusParagraphs database_load_collapse(const Filesystem& fs, const InstalledPaths& installed);
 
     void write_update(const Filesystem& fs, const InstalledPaths& installed, const StatusParagraph& p);
 
@@ -24,9 +25,12 @@ namespace vcpkg
     };
 
     std::vector<InstalledPackageView> get_installed_ports(const StatusParagraphs& status_db);
-    std::vector<StatusParagraphAndAssociatedFiles> get_installed_files(const Filesystem& fs,
+    std::vector<StatusParagraphAndAssociatedFiles> get_installed_files(const ReadOnlyFilesystem& fs,
                                                                        const InstalledPaths& installed,
                                                                        const StatusParagraphs& status_db);
+    std::vector<StatusParagraphAndAssociatedFiles> get_installed_files_and_upgrade(const Filesystem& fs,
+                                                                                   const InstalledPaths& installed,
+                                                                                   const StatusParagraphs& status_db);
 
     std::string shorten_text(StringView desc, const size_t length);
 } // namespace vcpkg