Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Version in DependencyOverride rather than reinventing it. #1238

Merged
merged 2 commits into from
Oct 23, 2023
Merged

Use Version in DependencyOverride rather than reinventing it. #1238

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4b7fa1
Use SchemedVersion in DependencyOverride rather than reinventing it.
BillyONeal Oct 18, 2023
db17508
Back off to Version given that the scheme is not significant to overr…
BillyONeal Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions include/vcpkg/sourceparagraph.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,7 @@ namespace vcpkg
struct DependencyOverride
{
std::string name;
std::string version;
int port_version = 0;
VersionScheme version_scheme = VersionScheme::String;
SchemedVersion version;

Json::Object extra_info;

Expand Down
1 change: 1 addition & 0 deletions include/vcpkg/versions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ namespace vcpkg
Version version;

friend bool operator==(const SchemedVersion& lhs, const SchemedVersion& rhs);
friend bool operator!=(const SchemedVersion& lhs, const SchemedVersion& rhs);
};

StringLiteral to_string_literal(VersionScheme scheme);
Expand Down
126 changes: 66 additions & 60 deletions src/vcpkg-test/dependencies.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1554,29 +1554,23 @@ TEST_CASE ("version install overrides", "[versionplan]")
bp.v["b"] = {"2", 0};
bp.v["c"] = {"2", 0};

DependencyOverride bdo{"b", SchemedVersion{VersionScheme::String, Version{"1", 0}}};
DependencyOverride cdo{"c", SchemedVersion{VersionScheme::String, Version{"1", 0}}};
SECTION ("string")
{
auto install_plan = create_versioned_install_plan(vp,
bp,
var_provider,
{Dependency{"c"}},
{DependencyOverride{"b", "1"}, DependencyOverride{"c", "1"}},
toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);
auto install_plan =
create_versioned_install_plan(vp, bp, var_provider, {Dependency{"c"}}, {bdo, cdo}, toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);

REQUIRE(install_plan.size() == 1);
check_name_and_version(install_plan.install_actions[0], "c", {"1", 0});
}

SECTION ("relaxed")
{
auto install_plan = create_versioned_install_plan(vp,
bp,
var_provider,
{Dependency{"b"}},
{DependencyOverride{"b", "1"}, DependencyOverride{"c", "1"}},
toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);
auto install_plan =
create_versioned_install_plan(vp, bp, var_provider, {Dependency{"b"}}, {bdo, cdo}, toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);

REQUIRE(install_plan.size() == 1);
check_name_and_version(install_plan.install_actions[0], "b", {"1", 0});
Expand All @@ -1600,13 +1594,10 @@ TEST_CASE ("version install transitive overrides", "[versionplan]")
bp.v["b"] = {"2", 0};
bp.v["c"] = {"2", 1};

DependencyOverride bdo{"b", SchemedVersion{VersionScheme::String, Version{"1", 0}}};
DependencyOverride cdo{"c", SchemedVersion{VersionScheme::String, Version{"1", 0}}};
WITH_EXPECTED(install_plan,
create_versioned_install_plan(vp,
bp,
var_provider,
{Dependency{"b"}},
{DependencyOverride{"b", "1"}, DependencyOverride{"c", "1"}},
toplevel_spec()));
create_versioned_install_plan(vp, bp, var_provider, {Dependency{"b"}}, {bdo, cdo}, toplevel_spec()));

REQUIRE(install_plan.size() == 2);
check_name_and_version(install_plan.install_actions[0], "c", {"1", 0});
Expand Down Expand Up @@ -2144,36 +2135,37 @@ TEST_CASE ("version overlay ports", "[versionplan]")
}
SECTION ("constraint+override")
{
auto install_plan =
create_versioned_install_plan(vp,
bp,
oprovider,
var_provider,
{
Dependency{"a", {}, {}, {VersionConstraintKind::Minimum, "1", 1}},
},
{
DependencyOverride{"a", "2", 0},
},
toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);
auto install_plan = create_versioned_install_plan(
vp,
bp,
oprovider,
var_provider,
{
Dependency{"a", {}, {}, {VersionConstraintKind::Minimum, "1", 1}},
},
{
DependencyOverride{"a", SchemedVersion{VersionScheme::String, Version{"2", 0}}},
},
toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);

REQUIRE(install_plan.size() == 1);
check_name_and_version(install_plan.install_actions[0], "a", {"overlay", 0});
}
SECTION ("override")
{
auto install_plan = create_versioned_install_plan(vp,
bp,
oprovider,
var_provider,
{
Dependency{"a"},
},
{
DependencyOverride{"a", "2", 0},
},
toplevel_spec())
auto install_plan = create_versioned_install_plan(
vp,
bp,
oprovider,
var_provider,
{
Dependency{"a"},
},
{
DependencyOverride{"a", SchemedVersion{VersionScheme::String, Version{"2", 0}}},
},
toplevel_spec())
.value_or_exit(VCPKG_LINE_INFO);

REQUIRE(install_plan.size() == 1);
Expand Down Expand Up @@ -2204,12 +2196,24 @@ TEST_CASE ("respect supports expression", "[versionplan]")
// override from non supported to supported version
MockOverlayProvider oprovider;
install_plan = create_versioned_install_plan(
vp, bp, oprovider, var_provider, {Dependency{"a"}}, {DependencyOverride{"a", "1", 1}}, toplevel_spec());
vp,
bp,
oprovider,
var_provider,
{Dependency{"a"}},
{DependencyOverride{"a", SchemedVersion{VersionScheme::String, Version{"1", 1}}}},
toplevel_spec());
CHECK(install_plan.has_value());
// override from supported to non supported version
bp.v["a"] = {"1", 1};
install_plan = create_versioned_install_plan(
vp, bp, oprovider, var_provider, {Dependency{"a"}}, {DependencyOverride{"a", "1", 0}}, toplevel_spec());
vp,
bp,
oprovider,
var_provider,
{Dependency{"a"}},
{DependencyOverride{"a", SchemedVersion{VersionScheme::String, Version{"1", 0}}}},
toplevel_spec());
CHECK_FALSE(install_plan.has_value());
}
}
Expand Down Expand Up @@ -2241,23 +2245,25 @@ TEST_CASE ("respect supports expressions of features", "[versionplan]")
{
// override from non supported to supported version
MockOverlayProvider oprovider;
install_plan = create_versioned_install_plan(vp,
bp,
oprovider,
var_provider,
{Dependency{"a", {{"x"}}}},
{DependencyOverride{"a", "1", 1}},
toplevel_spec());
install_plan = create_versioned_install_plan(
vp,
bp,
oprovider,
var_provider,
{Dependency{"a", {{"x"}}}},
{DependencyOverride{"a", SchemedVersion{VersionScheme::String, Version{"1", 1}}}},
toplevel_spec());
CHECK(install_plan.has_value());
// override from supported to non supported version
bp.v["a"] = {"1", 1};
install_plan = create_versioned_install_plan(vp,
bp,
oprovider,
var_provider,
{Dependency{"a", {{"x"}}}},
{DependencyOverride{"a", "1", 0}},
toplevel_spec());
install_plan = create_versioned_install_plan(
vp,
bp,
oprovider,
var_provider,
{Dependency{"a", {{"x"}}}},
{DependencyOverride{"a", SchemedVersion{VersionScheme::String, Version{"1", 0}}}},
toplevel_spec());
CHECK_FALSE(install_plan.has_value());
}
}
Expand Down
28 changes: 14 additions & 14 deletions src/vcpkg-test/manifests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,8 @@ TEST_CASE ("manifest overrides embedded port version", "[manifests]")
]
})json");
REQUIRE(parsed.has_value());
CHECK((*parsed.get())->core_paragraph->overrides.at(0).port_version == 1);
CHECK((*parsed.get())->core_paragraph->overrides.at(0).version ==
SchemedVersion{VersionScheme::String, Version{"abcd", 1}});

parsed = test_parse_port_manifest(R"json({
"name": "zlib",
Expand All @@ -403,7 +404,8 @@ TEST_CASE ("manifest overrides embedded port version", "[manifests]")
]
})json");
REQUIRE(parsed.has_value());
CHECK((*parsed.get())->core_paragraph->overrides.at(0).port_version == 1);
CHECK((*parsed.get())->core_paragraph->overrides.at(0).version ==
SchemedVersion{VersionScheme::Date, Version{"2018-01-01", 1}});

parsed = test_parse_port_manifest(R"json({
"name": "zlib",
Expand All @@ -416,7 +418,8 @@ TEST_CASE ("manifest overrides embedded port version", "[manifests]")
]
})json");
REQUIRE(parsed.has_value());
CHECK((*parsed.get())->core_paragraph->overrides.at(0).port_version == 1);
CHECK((*parsed.get())->core_paragraph->overrides.at(0).version ==
SchemedVersion{VersionScheme::Relaxed, Version{"1.2", 1}});

parsed = test_parse_port_manifest(R"json({
"name": "zlib",
Expand All @@ -429,7 +432,8 @@ TEST_CASE ("manifest overrides embedded port version", "[manifests]")
]
})json");
REQUIRE(parsed.has_value());
CHECK((*parsed.get())->core_paragraph->overrides.at(0).port_version == 1);
CHECK((*parsed.get())->core_paragraph->overrides.at(0).version ==
SchemedVersion{VersionScheme::Semver, Version{"1.2.0", 1}});
}

TEST_CASE ("manifest constraints", "[manifests]")
Expand Down Expand Up @@ -565,9 +569,7 @@ TEST_CASE ("manifest builtin-baseline", "[manifests]")
REQUIRE(pgh.core_paragraph->dependencies[0].constraint.port_version == 1);
REQUIRE(pgh.core_paragraph->dependencies[0].constraint.type == VersionConstraintKind::Minimum);
REQUIRE(pgh.core_paragraph->overrides.size() == 1);
REQUIRE(pgh.core_paragraph->overrides[0].version_scheme == VersionScheme::String);
REQUIRE(pgh.core_paragraph->overrides[0].version == "abcd");
REQUIRE(pgh.core_paragraph->overrides[0].port_version == 0);
REQUIRE(pgh.core_paragraph->overrides[0].version == SchemedVersion{VersionScheme::String, Version{"abcd", 0}});
REQUIRE(pgh.core_paragraph->builtin_baseline.value_or("does not have a value") ==
"089fa4de7dca22c67dcab631f618d5cd0697c8d4");
REQUIRE(!pgh.check_against_feature_flags({}, feature_flags_without_versioning));
Expand Down Expand Up @@ -602,9 +604,7 @@ TEST_CASE ("manifest builtin-baseline", "[manifests]")
REQUIRE(pgh.core_paragraph->dependencies[0].constraint.port_version == 1);
REQUIRE(pgh.core_paragraph->dependencies[0].constraint.type == VersionConstraintKind::Minimum);
REQUIRE(pgh.core_paragraph->overrides.size() == 1);
REQUIRE(pgh.core_paragraph->overrides[0].version_scheme == VersionScheme::String);
REQUIRE(pgh.core_paragraph->overrides[0].version == "abcd");
REQUIRE(pgh.core_paragraph->overrides[0].port_version == 0);
REQUIRE(pgh.core_paragraph->overrides[0].version == SchemedVersion{VersionScheme::String, Version{"abcd", 0}});
REQUIRE(!pgh.core_paragraph->builtin_baseline.has_value());
REQUIRE(!pgh.check_against_feature_flags({}, feature_flags_without_versioning));
REQUIRE(!pgh.check_against_feature_flags({}, feature_flags_with_versioning));
Expand Down Expand Up @@ -679,8 +679,8 @@ TEST_CASE ("manifest overrides", "[manifests]")
auto& pgh = **m_pgh.get();
REQUIRE(Json::stringify(serialize_manifest(pgh), Json::JsonStyle::with_spaces(4)) == std::get<0>(v));
REQUIRE(pgh.core_paragraph->overrides.size() == 1);
REQUIRE(pgh.core_paragraph->overrides[0].version_scheme == std::get<1>(v));
REQUIRE(pgh.core_paragraph->overrides[0].version == std::get<2>(v));
REQUIRE(pgh.core_paragraph->overrides[0].version ==
SchemedVersion{std::get<1>(v), Version{std::get<2>(v).to_string(), 0}});
REQUIRE(!pgh.check_against_feature_flags({}, feature_flags_without_versioning));
REQUIRE(pgh.check_against_feature_flags({}, feature_flags_with_versioning));
}
Expand Down Expand Up @@ -733,9 +733,9 @@ TEST_CASE ("manifest overrides", "[manifests]")
REQUIRE(Json::stringify(serialize_manifest(pgh), Json::JsonStyle::with_spaces(4)) == raw);
REQUIRE(pgh.core_paragraph->overrides.size() == 2);
REQUIRE(pgh.core_paragraph->overrides[0].name == "abc");
REQUIRE(pgh.core_paragraph->overrides[0].port_version == 5);
REQUIRE(pgh.core_paragraph->overrides[0].version == SchemedVersion{VersionScheme::String, Version{"hello", 5}});
REQUIRE(pgh.core_paragraph->overrides[1].name == "abcd");
REQUIRE(pgh.core_paragraph->overrides[1].port_version == 7);
REQUIRE(pgh.core_paragraph->overrides[1].version == SchemedVersion{VersionScheme::String, Version{"hello", 7}});

REQUIRE(!pgh.check_against_feature_flags({}, feature_flags_without_versioning));
REQUIRE(pgh.check_against_feature_flags({}, feature_flags_with_versioning));
Expand Down
2 changes: 1 addition & 1 deletion src/vcpkg/dependencies.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2007,7 +2007,7 @@ namespace vcpkg
provider, bprovider, oprovider, var_provider, options.host_triplet, options.packages_dir);
for (auto&& o : overrides)
{
vpg.add_override(o.name, {o.version, o.port_version});
vpg.add_override(o.name, o.version.version);
}

vpg.solve_with_roots(deps, toplevel);
Expand Down
17 changes: 5 additions & 12 deletions src/vcpkg/sourceparagraph.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@ namespace vcpkg

bool operator==(const DependencyOverride& lhs, const DependencyOverride& rhs)
{
if (lhs.version_scheme != rhs.version_scheme) return false;
if (lhs.port_version != rhs.port_version) return false;
if (lhs.name != rhs.name) return false;
if (lhs.version != rhs.version) return false;
return lhs.extra_info == rhs.extra_info;
Expand Down Expand Up @@ -762,16 +760,10 @@ namespace vcpkg
Json::Reader& r,
const Json::Object& obj,
std::string& name,
std::string& version,
VersionScheme& version_scheme,
int& port_version)
SchemedVersion& version)
{
r.required_object_field(type_name, obj, NAME, name, Json::PackageNameDeserializer::instance);

auto schemed_version = visit_required_schemed_deserializer(type_name, r, obj, true);
version = schemed_version.version.text();
version_scheme = schemed_version.scheme;
port_version = schemed_version.version.port_version();
version = visit_required_schemed_deserializer(type_name, r, obj, true);
}

virtual Optional<DependencyOverride> visit_object(Json::Reader& r, const Json::Object& obj) const override
Expand All @@ -786,7 +778,7 @@ namespace vcpkg
}
}

visit_impl(type_name(), r, obj, dep.name, dep.version, dep.version_scheme, dep.port_version);
visit_impl(type_name(), r, obj, dep.name, dep.version);

return dep;
}
Expand Down Expand Up @@ -1823,7 +1815,8 @@ namespace vcpkg

dep_obj.insert(DependencyOverrideDeserializer::NAME, Json::Value::string(dep.name));

serialize_schemed_version(dep_obj, dep.version_scheme, dep.version, dep.port_version);
serialize_schemed_version(
dep_obj, dep.version.scheme, dep.version.version.text(), dep.version.version.port_version());
};

auto serialize_license =
Expand Down
2 changes: 2 additions & 0 deletions src/vcpkg/versions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,8 @@ namespace vcpkg
return lhs.scheme == rhs.scheme && lhs.version == rhs.version;
}

bool operator!=(const SchemedVersion& lhs, const SchemedVersion& rhs) { return !(lhs == rhs); }

StringLiteral to_string_literal(VersionScheme scheme)
{
static constexpr StringLiteral MISSING = "missing";
Expand Down