Add new baseline-diff command #1980
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| #pragma once | ||
|
|
||
| #include <vcpkg/fwd/triplet.h> | ||
| #include <vcpkg/fwd/vcpkgcmdarguments.h> | ||
| #include <vcpkg/fwd/vcpkgpaths.h> | ||
|
|
||
| namespace vcpkg | ||
|
autoantwort marked this conversation as resolved.
|
||
| { | ||
|
autoantwort marked this conversation as resolved.
|
||
| extern const CommandMetadata CommandBaselineDiffMetadata; | ||
| void command_baseline_diff_and_exit(const VcpkgCmdArguments& args, | ||
| const VcpkgPaths& paths, | ||
| vcpkg::Triplet default_triplet, | ||
| vcpkg::Triplet host_triplet); | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,183 @@ | ||||||||
| #include <vcpkg/base/fwd/message_sinks.h> | ||||||||
|
|
||||||||
| #include <vcpkg/base/contractual-constants.h> | ||||||||
| #include <vcpkg/base/files.h> | ||||||||
| #include <vcpkg/base/messages.h> | ||||||||
| #include <vcpkg/base/parse.h> | ||||||||
| #include <vcpkg/base/path.h> | ||||||||
| #include <vcpkg/base/strings.h> | ||||||||
| #include <vcpkg/base/util.h> | ||||||||
|
|
||||||||
| #include <vcpkg/binarycaching.h> | ||||||||
| #include <vcpkg/cmakevars.h> | ||||||||
| #include <vcpkg/commands.baseline-diff.h> | ||||||||
| #include <vcpkg/commands.install.h> | ||||||||
| #include <vcpkg/configuration.h> | ||||||||
| #include <vcpkg/dependencies.h> | ||||||||
| #include <vcpkg/installeddatabase.h> | ||||||||
| #include <vcpkg/installedpaths.h> | ||||||||
| #include <vcpkg/paragraphs.h> | ||||||||
| #include <vcpkg/portfileprovider.h> | ||||||||
| #include <vcpkg/vcpkgcmdarguments.h> | ||||||||
| #include <vcpkg/vcpkgpaths.h> | ||||||||
|
|
||||||||
| #include <map> | ||||||||
| #include <memory> | ||||||||
| #include <string> | ||||||||
| #include <vector> | ||||||||
|
|
||||||||
| using namespace vcpkg; | ||||||||
|
|
||||||||
| namespace | ||||||||
| { | ||||||||
| constexpr CommandSwitch switches[] = { | ||||||||
| {SwitchXNoDefaultFeatures, msgHelpTxtOptManifestNoDefault}, | ||||||||
| }; | ||||||||
|
|
||||||||
| static constexpr CommandMultiSetting multisettings[] = { | ||||||||
| {SwitchXFeature, msgHelpTxtOptManifestFeature}, | ||||||||
| }; | ||||||||
|
|
||||||||
| bool print_lines(LocalizedString&& header, std::vector<std::string>&& lines) | ||||||||
| { | ||||||||
| if (!lines.empty()) | ||||||||
| { | ||||||||
| Util::sort_unique_erase(lines); | ||||||||
| msg::println(header.append_raw(':')); | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
| for (const auto& line : lines) | ||||||||
| { | ||||||||
| msg::write_unlocalized_text(Color::none, line); | ||||||||
| msg::write_unlocalized_text(Color::none, "\n"); | ||||||||
| } | ||||||||
| msg::write_unlocalized_text(Color::none, "\n"); | ||||||||
| return true; | ||||||||
| } | ||||||||
| return false; | ||||||||
| } | ||||||||
|
|
||||||||
| void check_for_valid_sha(StringView sha) | ||||||||
|
There was a problem hiding this comment. Can this use check_commit_exists (from git.h) instead? There was a problem hiding this comment. I see we can't do that in the general case because this kinda just blindly overwrites the baseline with a SHA and we don't necessarily have a git repo present for that. However that makes this kinda broken because filesystem registries' baselines are not SHAs. We should only be checking that the input is a SHA when we know that registry has that constraint.
Contributor
Author
There was a problem hiding this comment. The code is registry.h/cpp could really benefit from some comments. What is a |
||||||||
| { | ||||||||
| if (sha.size() < 7 || !Util::all_of(sha, ParserBase::is_hex_digit_lower)) | ||||||||
| { | ||||||||
| Checks::msg_exit_with_error(VCPKG_LINE_INFO, msgInvalidCommitId, msg::commit_sha = sha); | ||||||||
| } | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
| } | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
|
|
||||||||
| } // unnamed namespace | ||||||||
|
|
||||||||
| namespace vcpkg | ||||||||
| { | ||||||||
| constexpr CommandMetadata CommandBaselineDiffMetadata{ | ||||||||
| "x-baseline-diff", | ||||||||
| msgCmdBaselineDiffSynopsis, | ||||||||
| {"vcpkg x-baseline-diff <old_commit_sha> <newer_commit_sha>", | ||||||||
| "vcpkg x-baseline-diff $(git rev-parse 2026.02.27) $(git rev-parse 2026.03.18)"}, | ||||||||
|
There was a problem hiding this comment. Per
Suggested change
Contributor
Author
There was a problem hiding this comment. I must say that i am always very confused if such examples gets translated. Also only old and new would be translated here (The people that uses git also understand git without translations...).
Member
There was a problem hiding this comment. In general if there was "English" in the example we made it be translated, and if there was not we did not. So for instance, vcpkg-tool/src/vcpkg/commands.remove.cpp Line 174 in 4a0ae3e So I believe in this case the one that says There was a problem hiding this comment. I think we should just accept the tags here rather than needing the user to say rev-parse? (I fixed a similar bug in #1935 ) |
||||||||
| Undocumented, | ||||||||
|
There was a problem hiding this comment. I think we need a docs page for this.
Contributor
Author
There was a problem hiding this comment. |
||||||||
| AutocompletePriority::Public, | ||||||||
| 2, | ||||||||
| 2, | ||||||||
| {switches, {}, multisettings}, | ||||||||
| nullptr, | ||||||||
| }; | ||||||||
|
autoantwort marked this conversation as resolved.
|
||||||||
|
|
||||||||
| void command_baseline_diff_and_exit(const VcpkgCmdArguments& args, | ||||||||
| const VcpkgPaths& paths, | ||||||||
| Triplet default_triplet, | ||||||||
| Triplet host_triplet) | ||||||||
|
autoantwort marked this conversation as resolved.
|
||||||||
| { | ||||||||
| const auto* manifest = paths.get_manifest(); | ||||||||
| if (manifest == nullptr) | ||||||||
|
There was a problem hiding this comment. I'm not sure I agree with this design: Because the user is explicitly passing in multiple baseline SHAs, it seems to really be more of a classic mode command as other registries aren't accounted for. It seems like what you actually wanted is effectively this same diff but before/after what If this stays manifest only, it seems like one of the SHAs should be the one already in the manifest?
Contributor
Author
There was a problem hiding this comment.
Yes. I wanted to know what x-update-baseline does mean to me in terms of port versions, or what it would mean.
Contributor
Author
There was a problem hiding this comment.
At least if there is no second one. You are right, this would be more developer friendly. |
||||||||
| { | ||||||||
| Checks::msg_exit_with_message(VCPKG_LINE_INFO, msgMissingManifestFile); | ||||||||
| } | ||||||||
| auto options = args.parse_arguments(CommandBaselineDiffMetadata); | ||||||||
| check_for_valid_sha(options.command_arguments.at(0)); | ||||||||
| check_for_valid_sha(options.command_arguments.at(1)); | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
|
|
||||||||
| auto& fs = paths.get_filesystem(); | ||||||||
| InstalledDatabaseLock installed_lock{fs, paths.installed(), args.wait_for_lock, args.ignore_lock_failures}; | ||||||||
| auto var_provider_storage = CMakeVars::make_triplet_cmake_var_provider(paths, installed_lock); | ||||||||
| auto& var_provider = *var_provider_storage; | ||||||||
|
|
||||||||
| auto configuration = paths.get_configuration(); | ||||||||
| bool is_default_builtin = configuration.instantiate_registry_set(paths)->is_default_builtin_registry(); | ||||||||
| auto manifest_scf = parse_manifest_scf_or_exit(*manifest, paths, is_default_builtin); | ||||||||
|
|
||||||||
| const auto& manifest_core = *manifest_scf->core_paragraph; | ||||||||
| PackageSpec toplevel{manifest_core.name, default_triplet}; | ||||||||
| auto features = get_manifest_features(options, manifest_core, var_provider, toplevel, host_triplet); | ||||||||
|
|
||||||||
| auto dependencies = get_manifest_dependencies(*manifest_scf, features); | ||||||||
|
|
||||||||
| ActionPlan plan[2]; | ||||||||
| for (int i = 0; i < 2; ++i) | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
| { | ||||||||
| if (auto default_reg = configuration.config.default_reg.get()) | ||||||||
| { | ||||||||
| default_reg->baseline = options.command_arguments.at(i); | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
| } | ||||||||
| else | ||||||||
| { | ||||||||
| RegistryConfig synthesized_registry; | ||||||||
| synthesized_registry.kind = JsonIdBuiltin.to_string(); | ||||||||
| synthesized_registry.baseline = options.command_arguments.at(i); | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
| configuration.config.default_reg.emplace(synthesized_registry); | ||||||||
| } | ||||||||
|
|
||||||||
| auto registry_set = configuration.instantiate_registry_set(paths); | ||||||||
| auto verprovider = make_versioned_portfile_provider(*registry_set); | ||||||||
| auto baseprovider = make_baseline_provider(*registry_set); | ||||||||
|
|
||||||||
| auto extended_overlay_port_directories = paths.overlay_ports; | ||||||||
|
|
||||||||
| auto oprovider = make_manifest_provider(fs, | ||||||||
| extended_overlay_port_directories, | ||||||||
| manifest->path, | ||||||||
| std::make_unique<SourceControlFile>(manifest_scf->clone())); | ||||||||
| PackagesDirAssigner packages_dir_assigner{paths.packages()}; | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
autoantwort marked this conversation as resolved.
|
||||||||
| const CreateInstallPlanOptions create_options{ | ||||||||
| nullptr, host_triplet, UnsupportedPortAction::Warn, UseHeadVersion::No, Editable::No}; | ||||||||
| plan[i] = create_versioned_install_plan(*verprovider, | ||||||||
| *baseprovider, | ||||||||
| *oprovider, | ||||||||
| var_provider, | ||||||||
| dependencies, | ||||||||
| manifest_core.overrides, | ||||||||
| toplevel, | ||||||||
| packages_dir_assigner, | ||||||||
| create_options) | ||||||||
| .value_or_exit(VCPKG_LINE_INFO); | ||||||||
|
BillyONeal marked this conversation as resolved.
|
||||||||
| } | ||||||||
|
|
||||||||
| std::map<PackageSpec, std::string> versions; | ||||||||
| for (const auto& action : plan[0].install_actions) | ||||||||
| { | ||||||||
| versions[action.spec] = action.version.to_string(); | ||||||||
| } | ||||||||
| std::vector<std::string> user_requested; | ||||||||
| std::vector<std::string> transitive; | ||||||||
| for (const auto& action : plan[1].install_actions) | ||||||||
| { | ||||||||
| auto oldIter = versions.find(action.spec); | ||||||||
| auto newVersion = action.version.to_string(); | ||||||||
| auto& vec = action.request_type == RequestType::USER_REQUESTED ? user_requested : transitive; | ||||||||
| if (oldIter == versions.end()) | ||||||||
| { | ||||||||
| vec.push_back(fmt::format("{}: new: {}", action.spec.name(), newVersion)); | ||||||||
| } | ||||||||
| else if (oldIter->second != newVersion) | ||||||||
| { | ||||||||
| vec.push_back(fmt::format("{}: {} -> {}", action.spec.name(), oldIter->second, newVersion)); | ||||||||
|
BillyONeal marked this conversation as resolved.
autoantwort marked this conversation as resolved.
|
||||||||
| } | ||||||||
| } | ||||||||
|
BillyONeal marked this conversation as resolved.
autoantwort marked this conversation as resolved.
|
||||||||
| bool any_changes = false; | ||||||||
|
autoantwort marked this conversation as resolved.
|
||||||||
| any_changes |= print_lines(msg::format(msgDirectDependencies), std::move(user_requested)); | ||||||||
| any_changes |= print_lines(msg::format(msgTransitiveDependencies), std::move(transitive)); | ||||||||
|
autoantwort marked this conversation as resolved.
Outdated
|
||||||||
| if (!any_changes) | ||||||||
| { | ||||||||
| msg::println(msgBaselineDiffNoChange); | ||||||||
| } | ||||||||
|
|
||||||||
| Checks::exit_success(VCPKG_LINE_INFO); | ||||||||
| } | ||||||||
| } // namespace vcpkg | ||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if
installableconveys the meaning but I'd prefer a terse description.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe installed? Because the packages listed in the vcpkg.json are normally installed.