From d1653533a6f6f70d1d95001abf3f80665ba135e7 Mon Sep 17 00:00:00 2001 From: Griffin Smith Date: Sun, 9 Aug 2020 00:27:55 -0400 Subject: test(tvix): Cover scanForReferences in a test Aded a few test cases covering the scanForReferences function, which had been accidentally broken in 976a36c (which is now partially-reverted). As part of this, since the test needed to generate hashes for store paths, the logic in MakeStorePath to compress a sha256 hash down to 20 bytes and convert it to base32 has been extracted to a member function on the Hash class. Fixes: #34 Change-Id: Ie2d914688a80f42d0234d351a7cc0714fd15709e Reviewed-on: https://cl.tvl.fyi/c/depot/+/1698 Tested-by: BuildkiteCI Reviewed-by: kanepyork --- third_party/nix/src/libstore/store-api.cc | 5 +- third_party/nix/src/libutil/hash.cc | 4 ++ third_party/nix/src/libutil/hash.hh | 6 +++ third_party/nix/src/nix/hash.cc | 4 +- third_party/nix/src/tests/CMakeLists.txt | 10 ++++ third_party/nix/src/tests/references_test.cc | 74 ++++++++++++++++++++++++++++ 6 files changed, 98 insertions(+), 5 deletions(-) create mode 100644 third_party/nix/src/tests/references_test.cc (limited to 'third_party/nix') diff --git a/third_party/nix/src/libstore/store-api.cc b/third_party/nix/src/libstore/store-api.cc index a6863cc04b52..ae403b0be65f 100644 --- a/third_party/nix/src/libstore/store-api.cc +++ b/third_party/nix/src/libstore/store-api.cc @@ -323,9 +323,8 @@ Path Store::makeStorePath(const std::string& type, const Hash& hash, checkStoreName(name); - return storeDir + "/" + - compressHash(hashString(htSHA256, s), 20).to_string(Base32, false) + - "-" + name; + return absl::StrCat(storeDir, "/", hashString(htSHA256, s).ToStorePathHash(), + "-", name); } Path Store::makeOutputPath(const std::string& id, const Hash& hash, diff --git a/third_party/nix/src/libutil/hash.cc b/third_party/nix/src/libutil/hash.cc index 426096e73af8..9d14ad9dfe14 100644 --- a/third_party/nix/src/libutil/hash.cc +++ b/third_party/nix/src/libutil/hash.cc @@ -158,6 +158,10 @@ bool Hash::IsValidBase32(absl::string_view s) { return true; } +std::string Hash::ToStorePathHash() const { + return compressHash(*this, kStorePathHashSize).to_string(Base32, false); +} + static std::string printHash32(const Hash& hash) { assert(hash.hashSize); size_t len = hash.base32Len(); diff --git a/third_party/nix/src/libutil/hash.hh b/third_party/nix/src/libutil/hash.hh index 4d52702aee75..6fbeec5b47fb 100644 --- a/third_party/nix/src/libutil/hash.hh +++ b/third_party/nix/src/libutil/hash.hh @@ -8,6 +8,9 @@ namespace nix { +// Size of the hashes rendered in store paths, in bytes +constexpr unsigned int kStorePathHashSize = 20; + MakeError(BadHash, Error); // TODO(grfn): Replace this with the hash type enum from the daemon proto so we @@ -90,6 +93,9 @@ struct Hash { /* Returns whether the passed string contains entirely valid base32 characters. */ static bool IsValidBase32(absl::string_view s); + + // Convert this Hash to the format expected in store paths + [[nodiscard]] std::string ToStorePathHash() const; }; /* Print a hash in base-16 if it's MD5, or base-32 otherwise. */ diff --git a/third_party/nix/src/nix/hash.cc b/third_party/nix/src/nix/hash.cc index 24529c67ce8c..08ada7ccfb3a 100644 --- a/third_party/nix/src/nix/hash.cc +++ b/third_party/nix/src/nix/hash.cc @@ -36,8 +36,8 @@ struct CmdHash final : Command { void run() override { for (const auto& path : paths) { Hash h = mode == mFile ? hashFile(ht, path) : hashPath(ht, path).first; - if (truncate && h.hashSize > 20) { - h = compressHash(h, 20); + if (truncate && h.hashSize > nix::kStorePathHashSize) { + h = compressHash(h, nix::kStorePathHashSize); } std::cout << format("%1%\n") % h.to_string(base, base == SRI); } diff --git a/third_party/nix/src/tests/CMakeLists.txt b/third_party/nix/src/tests/CMakeLists.txt index 929acc5ea671..cda8f5da8483 100644 --- a/third_party/nix/src/tests/CMakeLists.txt +++ b/third_party/nix/src/tests/CMakeLists.txt @@ -30,6 +30,16 @@ target_link_libraries(hash_test gtest_discover_tests(hash_test) +add_executable(references_test references_test.cc) +target_link_libraries(references_test + nixstore + rapidcheck + rapidcheck_gtest + GTest::gtest_main +) + +gtest_discover_tests(references_test) + add_executable(store_test store_tests.cc) target_link_libraries(store_test nixstore diff --git a/third_party/nix/src/tests/references_test.cc b/third_party/nix/src/tests/references_test.cc new file mode 100644 index 000000000000..8dcb3ed37a8b --- /dev/null +++ b/third_party/nix/src/tests/references_test.cc @@ -0,0 +1,74 @@ +#include "libstore/references.hh" + +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "libutil/hash.hh" + +class ReferencesTest : public ::testing::Test {}; + +namespace nix { + +TEST(ReferencesTest, ScanForOneReferenceNotFound) { + char path[] = "store_XXXXXXX"; + auto f = mkstemp(path); + + auto hash = hashString(htSHA256, "foo"); + auto ref = absl::StrFormat("/nix/store/%s-foo", hash.ToStorePathHash()); + + HashResult hr; + auto result = scanForReferences(path, {ref}, hr); + + ASSERT_EQ(result.find(ref), result.end()); + + EXPECT_EQ(close(f), 0); +} + +TEST(ReferencesTest, ScanForOneReferenceFound) { + char path[] = "store_XXXXXXX"; + auto f = mkstemp(path); + + auto hash = hashString(htSHA256, "foo"); + auto ref = absl::StrFormat("/nix/store/%s-foo", hash.ToStorePathHash()); + + EXPECT_GT(write(f, ref.c_str(), sizeof(char) * ref.size()), 0); + + HashResult hr; + auto result = scanForReferences(path, {ref}, hr); + + ASSERT_NE(result.find(ref), result.end()); + + ASSERT_EQ(close(f), 0); +} + +RC_GTEST_PROP(ReferencesTest, ScanForReferences, + (std::unordered_set strs)) { + char path[] = "store_XXXXXXX"; + auto f = mkstemp(path); + + PathSet refs; + for (const auto& s : strs) { + auto hash = hashString(htSHA256, s); + auto ref = absl::StrFormat("/nix/store/%s-foo", hash.ToStorePathHash()); + refs.insert(ref); + RC_ASSERT(write(f, ref.c_str(), sizeof(char) * ref.size()) > 0); + } + + HashResult hr; + auto result = scanForReferences(path, refs, hr); + + for (const auto& ref : refs) { + RC_ASSERT(result.find(ref) != result.end()); + } + + RC_ASSERT(close(f) == 0); +} + +} // namespace nix -- cgit 1.4.1