1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-08 19:46:02 +01:00

Remove now-redundant methods for JSON on Derivation

This commit is contained in:
John Ericson 2025-10-16 16:08:59 -04:00
parent 1c02dd5b9c
commit a2c6f38e1f
6 changed files with 67 additions and 101 deletions

View file

@ -14,7 +14,7 @@
namespace nix { namespace nix {
using nlohmann::json; using namespace nlohmann;
class DerivationAdvancedAttrsTest : public CharacterizationTest, public LibStoreTest class DerivationAdvancedAttrsTest : public CharacterizationTest, public LibStoreTest
{ {
@ -59,7 +59,7 @@ TYPED_TEST_SUITE(DerivationAdvancedAttrsBothTest, BothFixtures);
/* Use DRV file instead of C++ literal as source of truth. */ \ /* Use DRV file instead of C++ literal as source of truth. */ \
auto aterm = readFile(this->goldenMaster(NAME ".drv")); \ auto aterm = readFile(this->goldenMaster(NAME ".drv")); \
auto expected = parseDerivation(*this->store, std::move(aterm), NAME, this->mockXpSettings); \ auto expected = parseDerivation(*this->store, std::move(aterm), NAME, this->mockXpSettings); \
Derivation got = Derivation::fromJSON(encoded, this->mockXpSettings); \ Derivation got = adl_serializer<Derivation>::from_json(encoded, this->mockXpSettings); \
EXPECT_EQ(got, expected); \ EXPECT_EQ(got, expected); \
}); \ }); \
} \ } \
@ -71,7 +71,7 @@ TYPED_TEST_SUITE(DerivationAdvancedAttrsBothTest, BothFixtures);
[&]() -> json { \ [&]() -> json { \
/* Use DRV file instead of C++ literal as source of truth. */ \ /* Use DRV file instead of C++ literal as source of truth. */ \
auto aterm = readFile(this->goldenMaster(NAME ".drv")); \ auto aterm = readFile(this->goldenMaster(NAME ".drv")); \
return parseDerivation(*this->store, std::move(aterm), NAME, this->mockXpSettings).toJSON(); \ return parseDerivation(*this->store, std::move(aterm), NAME, this->mockXpSettings); \
}, \ }, \
[](const auto & file) { return json::parse(readFile(file)); }, \ [](const auto & file) { return json::parse(readFile(file)); }, \
[](const auto & file, const auto & got) { return writeFile(file, got.dump(2) + "\n"); }); \ [](const auto & file, const auto & got) { return writeFile(file, got.dump(2) + "\n"); }); \
@ -81,10 +81,10 @@ TYPED_TEST_SUITE(DerivationAdvancedAttrsBothTest, BothFixtures);
{ \ { \
this->readTest(NAME ".drv", [&](auto encoded) { \ this->readTest(NAME ".drv", [&](auto encoded) { \
/* Use JSON file instead of C++ literal as source of truth. */ \ /* Use JSON file instead of C++ literal as source of truth. */ \
auto json = json::parse(readFile(this->goldenMaster(NAME ".json"))); \ auto j = json::parse(readFile(this->goldenMaster(NAME ".json"))); \
auto expected = Derivation::fromJSON(json, this->mockXpSettings); \ auto expected = adl_serializer<Derivation>::from_json(j, this->mockXpSettings); \
auto got = parseDerivation(*this->store, std::move(encoded), NAME, this->mockXpSettings); \ auto got = parseDerivation(*this->store, std::move(encoded), NAME, this->mockXpSettings); \
EXPECT_EQ(got.toJSON(), expected.toJSON()); \ EXPECT_EQ(static_cast<json>(got), static_cast<json>(expected)); \
EXPECT_EQ(got, expected); \ EXPECT_EQ(got, expected); \
}); \ }); \
} \ } \

View file

@ -201,7 +201,8 @@ INSTANTIATE_TEST_SUITE_P(
const auto & drv = GetParam(); \ const auto & drv = GetParam(); \
readTest(drv.name + ".drv", [&](auto encoded) { \ readTest(drv.name + ".drv", [&](auto encoded) { \
auto got = parseDerivation(*store, std::move(encoded), drv.name, mockXpSettings); \ auto got = parseDerivation(*store, std::move(encoded), drv.name, mockXpSettings); \
ASSERT_EQ(got.toJSON(), drv.toJSON()); \ using nlohmann::json; \
ASSERT_EQ(static_cast<json>(got), static_cast<json>(drv)); \
ASSERT_EQ(got, drv); \ ASSERT_EQ(got, drv); \
}); \ }); \
} \ } \

View file

@ -1261,9 +1261,15 @@ void Derivation::checkInvariants(Store & store, const StorePath & drvPath) const
const Hash impureOutputHash = hashString(HashAlgorithm::SHA256, "impure"); const Hash impureOutputHash = hashString(HashAlgorithm::SHA256, "impure");
nlohmann::json DerivationOutput::toJSON() const } // namespace nix
namespace nlohmann {
using namespace nix;
void adl_serializer<DerivationOutput>::to_json(json & res, const DerivationOutput & o)
{ {
nlohmann::json res = nlohmann::json::object(); res = nlohmann::json::object();
std::visit( std::visit(
overloaded{ overloaded{
[&](const DerivationOutput::InputAddressed & doi) { res["path"] = doi.path; }, [&](const DerivationOutput::InputAddressed & doi) { res["path"] = doi.path; },
@ -1289,12 +1295,11 @@ nlohmann::json DerivationOutput::toJSON() const
res["impure"] = true; res["impure"] = true;
}, },
}, },
raw); o.raw);
return res;
} }
DerivationOutput DerivationOutput
DerivationOutput::fromJSON(const nlohmann::json & _json, const ExperimentalFeatureSettings & xpSettings) adl_serializer<DerivationOutput>::from_json(const json & _json, const ExperimentalFeatureSettings & xpSettings)
{ {
std::set<std::string_view> keys; std::set<std::string_view> keys;
auto & json = getObject(_json); auto & json = getObject(_json);
@ -1362,18 +1367,18 @@ DerivationOutput::fromJSON(const nlohmann::json & _json, const ExperimentalFeatu
} }
} }
nlohmann::json Derivation::toJSON() const void adl_serializer<Derivation>::to_json(json & res, const Derivation & d)
{ {
nlohmann::json res = nlohmann::json::object(); res = nlohmann::json::object();
res["name"] = name; res["name"] = d.name;
res["version"] = 3; res["version"] = 3;
{ {
nlohmann::json & outputsObj = res["outputs"]; nlohmann::json & outputsObj = res["outputs"];
outputsObj = nlohmann::json::object(); outputsObj = nlohmann::json::object();
for (auto & [outputName, output] : outputs) { for (auto & [outputName, output] : d.outputs) {
outputsObj[outputName] = output; outputsObj[outputName] = output;
} }
} }
@ -1381,7 +1386,7 @@ nlohmann::json Derivation::toJSON() const
{ {
auto & inputsList = res["inputSrcs"]; auto & inputsList = res["inputSrcs"];
inputsList = nlohmann::json ::array(); inputsList = nlohmann::json ::array();
for (auto & input : inputSrcs) for (auto & input : d.inputSrcs)
inputsList.emplace_back(input); inputsList.emplace_back(input);
} }
@ -1401,24 +1406,22 @@ nlohmann::json Derivation::toJSON() const
{ {
auto & inputDrvsObj = res["inputDrvs"]; auto & inputDrvsObj = res["inputDrvs"];
inputDrvsObj = nlohmann::json::object(); inputDrvsObj = nlohmann::json::object();
for (auto & [inputDrv, inputNode] : inputDrvs.map) { for (auto & [inputDrv, inputNode] : d.inputDrvs.map) {
inputDrvsObj[inputDrv.to_string()] = doInput(inputNode); inputDrvsObj[inputDrv.to_string()] = doInput(inputNode);
} }
} }
} }
res["system"] = platform; res["system"] = d.platform;
res["builder"] = builder; res["builder"] = d.builder;
res["args"] = args; res["args"] = d.args;
res["env"] = env; res["env"] = d.env;
if (structuredAttrs) if (d.structuredAttrs)
res["structuredAttrs"] = structuredAttrs->structuredAttrs; res["structuredAttrs"] = d.structuredAttrs->structuredAttrs;
return res;
} }
Derivation Derivation::fromJSON(const nlohmann::json & _json, const ExperimentalFeatureSettings & xpSettings) Derivation adl_serializer<Derivation>::from_json(const json & _json, const ExperimentalFeatureSettings & xpSettings)
{ {
using nlohmann::detail::value_t; using nlohmann::detail::value_t;
@ -1434,7 +1437,7 @@ Derivation Derivation::fromJSON(const nlohmann::json & _json, const Experimental
try { try {
auto outputs = getObject(valueAt(json, "outputs")); auto outputs = getObject(valueAt(json, "outputs"));
for (auto & [outputName, output] : outputs) { for (auto & [outputName, output] : outputs) {
res.outputs.insert_or_assign(outputName, DerivationOutput::fromJSON(output, xpSettings)); res.outputs.insert_or_assign(outputName, adl_serializer<DerivationOutput>::from_json(output, xpSettings));
} }
} catch (Error & e) { } catch (Error & e) {
e.addTrace({}, "while reading key 'outputs'"); e.addTrace({}, "while reading key 'outputs'");
@ -1490,31 +1493,4 @@ Derivation Derivation::fromJSON(const nlohmann::json & _json, const Experimental
return res; return res;
} }
} // namespace nix
namespace nlohmann {
using namespace nix;
DerivationOutput
adl_serializer<DerivationOutput>::from_json(const json & json, const ExperimentalFeatureSettings & xpSettings)
{
return DerivationOutput::fromJSON(json, xpSettings);
}
void adl_serializer<DerivationOutput>::to_json(json & json, const DerivationOutput & c)
{
json = c.toJSON();
}
Derivation adl_serializer<Derivation>::from_json(const json & json, const ExperimentalFeatureSettings & xpSettings)
{
return Derivation::fromJSON(json, xpSettings);
}
void adl_serializer<Derivation>::to_json(json & json, const Derivation & c)
{
json = c.toJSON();
}
} // namespace nlohmann } // namespace nlohmann

View file

@ -134,13 +134,6 @@ struct DerivationOutput
*/ */
std::optional<StorePath> std::optional<StorePath>
path(const StoreDirConfig & store, std::string_view drvName, OutputNameView outputName) const; path(const StoreDirConfig & store, std::string_view drvName, OutputNameView outputName) const;
nlohmann::json toJSON() const;
/**
* @param xpSettings Stop-gap to avoid globals during unit tests.
*/
static DerivationOutput
fromJSON(const nlohmann::json & json, const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
}; };
typedef std::map<std::string, DerivationOutput> DerivationOutputs; typedef std::map<std::string, DerivationOutput> DerivationOutputs;
@ -390,10 +383,6 @@ struct Derivation : BasicDerivation
{ {
} }
nlohmann::json toJSON() const;
static Derivation
fromJSON(const nlohmann::json & json, const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings);
bool operator==(const Derivation &) const = default; bool operator==(const Derivation &) const = default;
// TODO libc++ 16 (used by darwin) missing `std::map::operator <=>`, can't do yet. // TODO libc++ 16 (used by darwin) missing `std::map::operator <=>`, can't do yet.
// auto operator <=> (const Derivation &) const = default; // auto operator <=> (const Derivation &) const = default;

View file

@ -33,7 +33,7 @@ struct CmdAddDerivation : MixDryRun, StoreCommand
{ {
auto json = nlohmann::json::parse(drainFD(STDIN_FILENO)); auto json = nlohmann::json::parse(drainFD(STDIN_FILENO));
auto drv = Derivation::fromJSON(json); auto drv = static_cast<Derivation>(json);
auto drvPath = writeDerivation(*store, drv, NoRepair, /* read only */ dryRun); auto drvPath = writeDerivation(*store, drv, NoRepair, /* read only */ dryRun);

View file

@ -58,7 +58,7 @@ struct CmdShowDerivation : InstallablesCommand, MixPrintJSON
if (!drvPath.isDerivation()) if (!drvPath.isDerivation())
continue; continue;
jsonRoot[drvPath.to_string()] = store->readDerivation(drvPath).toJSON(); jsonRoot[drvPath.to_string()] = store->readDerivation(drvPath);
} }
printJSON(jsonRoot); printJSON(jsonRoot);
} }