forked from lix-project/lix
85f0cdc370
Motivation
`PathSet` is not correct because string contexts have other forms
(`Built` and `DrvDeep`) that are not rendered as plain store paths.
Instead of wrongly using `PathSet`, or "stringly typed" using
`StringSet`, use `std::std<StringContextElem>`.
-----
In support of this change, `NixStringContext` is now defined as
`std::std<StringContextElem>` not `std:vector<StringContextElem>`. The
old definition was just used by a `getContext` method which was only
used by the eval cache. It can be deleted altogether since the types are
now unified and the preexisting `copyContext` function already suffices.
Summarizing the previous paragraph:
Old:
- `value/context.hh`: `NixStringContext = std::vector<StringContextElem>`
- `value.hh`: `NixStringContext Value::getContext(...)`
- `value.hh`: `copyContext(...)`
New:
- `value/context.hh`: `NixStringContext = std::set<StringContextElem>`
- `value.hh`: `copyContext(...)`
----
The string representation of string context elements no longer contains
the store dir. The diff of `src/libexpr/tests/value/context.cc` should
make clear what the new representation is, so we recommend reviewing
that file first. This was done for two reasons:
Less API churn:
`Value::mkString` and friends did not take a `Store` before. But if
`NixStringContextElem::{parse, to_string}` *do* take a store (as they
did before), then we cannot have the `Value` functions use them (in
order to work with the fully-structured `NixStringContext`) without
adding that argument.
That would have been a lot of churn of threading the store, and this
diff is already large enough, so the easier and less invasive thing to
do was simply make the element `parse` and `to_string` functions not
take the `Store` reference, and the easiest way to do that was to simply
drop the store dir.
Space usage:
Dropping the `/nix/store/` (or similar) from the internal representation
will safe space in the heap of the Nix programming being interpreted. If
the heap contains many strings with non-trivial contexts, the saving
could add up to something significant.
----
The eval cache version is bumped.
The eval cache serialization uses `NixStringContextElem::{parse,
to_string}`, and since those functions are changed per the above, that
means the on-disk representation is also changed.
This is simply done by changing the name of the used for the eval cache
from `eval-cache-v4` to eval-cache-v5`.
----
To avoid some duplication `EvalCache::mkPathString` is added to abstract
over the simple case of turning a store path to a string with just that
string in the context.
Context
This PR picks up where #7543 left off. That one introduced the fully
structured `NixStringContextElem` data type, but kept `PathSet context`
as an awkward middle ground between internal `char[][]` interpreter heap
string contexts and `NixStringContext` fully parsed string contexts.
The infelicity of `PathSet context` was specifically called out during
Nix team group review, but it was agreeing that fixing it could be left
as future work. This is that future work.
A possible follow-up step would be to get rid of the `char[][]`
evaluator heap representation, too, but it is not yet clear how to do
that. To use `NixStringContextElem` there we would need to get the STL
containers to GC pointers in the GC build, and I am not sure how to do
that.
----
PR #7543 effectively is writing the inverse of a `mkPathString`,
`mkOutputString`, and one more such function for the `DrvDeep` case. I
would like that PR to have property tests ensuring it is actually the
inverse as expected.
This PR sets things up nicely so that reworking that PR to be in that
more elegant and better tested way is possible.
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
121 lines
3.3 KiB
C++
121 lines
3.3 KiB
C++
#include <nlohmann/json.hpp>
|
|
#include <gtest/gtest.h>
|
|
#include <rapidcheck/gtest.h>
|
|
|
|
#include "tests/path.hh"
|
|
#include "tests/libexpr.hh"
|
|
#include "tests/value/context.hh"
|
|
|
|
namespace nix {
|
|
|
|
TEST(NixStringContextElemTest, empty_invalid) {
|
|
EXPECT_THROW(
|
|
NixStringContextElem::parse(""),
|
|
BadNixStringContextElem);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, single_bang_invalid) {
|
|
EXPECT_THROW(
|
|
NixStringContextElem::parse("!"),
|
|
BadNixStringContextElem);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, double_bang_invalid) {
|
|
EXPECT_THROW(
|
|
NixStringContextElem::parse("!!/"),
|
|
BadStorePath);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, eq_slash_invalid) {
|
|
EXPECT_THROW(
|
|
NixStringContextElem::parse("=/"),
|
|
BadStorePath);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, slash_invalid) {
|
|
EXPECT_THROW(
|
|
NixStringContextElem::parse("/"),
|
|
BadStorePath);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, opaque) {
|
|
std::string_view opaque = "g1w7hy3qg1w7hy3qg1w7hy3qg1w7hy3q-x";
|
|
auto elem = NixStringContextElem::parse(opaque);
|
|
auto * p = std::get_if<NixStringContextElem::Opaque>(&elem);
|
|
ASSERT_TRUE(p);
|
|
ASSERT_EQ(p->path, StorePath { opaque });
|
|
ASSERT_EQ(elem.to_string(), opaque);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, drvDeep) {
|
|
std::string_view drvDeep = "=g1w7hy3qg1w7hy3qg1w7hy3qg1w7hy3q-x.drv";
|
|
auto elem = NixStringContextElem::parse(drvDeep);
|
|
auto * p = std::get_if<NixStringContextElem::DrvDeep>(&elem);
|
|
ASSERT_TRUE(p);
|
|
ASSERT_EQ(p->drvPath, StorePath { drvDeep.substr(1) });
|
|
ASSERT_EQ(elem.to_string(), drvDeep);
|
|
}
|
|
|
|
TEST(NixStringContextElemTest, built) {
|
|
std::string_view built = "!foo!g1w7hy3qg1w7hy3qg1w7hy3qg1w7hy3q-x.drv";
|
|
auto elem = NixStringContextElem::parse(built);
|
|
auto * p = std::get_if<NixStringContextElem::Built>(&elem);
|
|
ASSERT_TRUE(p);
|
|
ASSERT_EQ(p->output, "foo");
|
|
ASSERT_EQ(p->drvPath, StorePath { built.substr(5) });
|
|
ASSERT_EQ(elem.to_string(), built);
|
|
}
|
|
|
|
}
|
|
|
|
namespace rc {
|
|
using namespace nix;
|
|
|
|
Gen<NixStringContextElem::Opaque> Arbitrary<NixStringContextElem::Opaque>::arbitrary()
|
|
{
|
|
return gen::just(NixStringContextElem::Opaque {
|
|
.path = *gen::arbitrary<StorePath>(),
|
|
});
|
|
}
|
|
|
|
Gen<NixStringContextElem::DrvDeep> Arbitrary<NixStringContextElem::DrvDeep>::arbitrary()
|
|
{
|
|
return gen::just(NixStringContextElem::DrvDeep {
|
|
.drvPath = *gen::arbitrary<StorePath>(),
|
|
});
|
|
}
|
|
|
|
Gen<NixStringContextElem::Built> Arbitrary<NixStringContextElem::Built>::arbitrary()
|
|
{
|
|
return gen::just(NixStringContextElem::Built {
|
|
.drvPath = *gen::arbitrary<StorePath>(),
|
|
.output = (*gen::arbitrary<StorePathName>()).name,
|
|
});
|
|
}
|
|
|
|
Gen<NixStringContextElem> Arbitrary<NixStringContextElem>::arbitrary()
|
|
{
|
|
switch (*gen::inRange<uint8_t>(0, 2)) {
|
|
case 0:
|
|
return gen::just<NixStringContextElem>(*gen::arbitrary<NixStringContextElem::Opaque>());
|
|
case 1:
|
|
return gen::just<NixStringContextElem>(*gen::arbitrary<NixStringContextElem::DrvDeep>());
|
|
default:
|
|
return gen::just<NixStringContextElem>(*gen::arbitrary<NixStringContextElem::Built>());
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
namespace nix {
|
|
|
|
RC_GTEST_PROP(
|
|
NixStringContextElemTest,
|
|
prop_round_rip,
|
|
(const NixStringContextElem & o))
|
|
{
|
|
RC_ASSERT(o == NixStringContextElem::parse(o.to_string()));
|
|
}
|
|
|
|
}
|