Skip to content

[volumecache 11/12] Add cache path normalization tests #381

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

Open
toloudis wants to merge 1 commit into from
Open

[volumecache 11/12] Add cache path normalization tests #381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
123 changes: 123 additions & 0 deletions test/test_cacheManager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,3 +545,126 @@ TEST_CASE("CacheManager invalidates entries when the source file mtime changes",

std::filesystem::remove(srcFile, ec);
}

TEST_CASE("CacheManager normalizes equivalent filepaths to the same key", "[cache][normalize]")
{
// These tests use synthetic paths that don't exist on disk; statForKey
// returns (0, 0) for them, so the cache key depends only on the
// (normalized) filepath string and the other LoadSpec fields.
const std::uint64_t oneImage = imageBytes(4, 4, 4, 1);

CacheManager cache;
cache.setConfig(ramOnlyConfig(oneImage * 4));

SECTION("'./' segment is normalized away")
{
LoadSpec stored;
stored.filepath = "/some/dir/foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "/some/dir/./foo.tif";
REQUIRE(cache.findImage(lookup) != nullptr);
}

SECTION("'..' segment is normalized away")
{
LoadSpec stored;
stored.filepath = "/some/dir/foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "/some/dir/subdir/../foo.tif";
REQUIRE(cache.findImage(lookup) != nullptr);
}

SECTION("Duplicate path separators are collapsed")
{
LoadSpec stored;
stored.filepath = "/some/dir/foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "/some//dir///foo.tif";
REQUIRE(cache.findImage(lookup) != nullptr);
}

SECTION("Bare names (no slashes) pass through unchanged")
{
LoadSpec stored;
stored.filepath = "in_memory_array_42";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "in_memory_array_42";
REQUIRE(cache.findImage(lookup) != nullptr);
}

SECTION("Remote URLs are passed through without normalization")
{
LoadSpec stored;
stored.filepath = "http://example.com/path/to/data.zarr";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "http://example.com/path/to/data.zarr";
REQUIRE(cache.findImage(lookup) != nullptr);
}
Comment on lines +603 to +612

@ShrimpCryptid ShrimpCryptid Oct 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this test that none of the other normalizations are applied? Double-slashes, ./,
.., etc.


SECTION("Distinct paths still produce distinct keys (no false hits)")
{
LoadSpec stored;
stored.filepath = "/some/dir/foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "/some/dir/bar.tif";
REQUIRE(cache.findImage(lookup) == nullptr);
}

#ifdef _WIN32
SECTION("UNC paths normalize across slash style and case on Windows")
{
LoadSpec stored;
stored.filepath = "\\\\Server\\Share\\Path\\Foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

// Same UNC path, lowercase, mixed slashes.
LoadSpec lookupSlash;
lookupSlash.filepath = "//server/share/path/foo.tif";
REQUIRE(cache.findImage(lookupSlash) != nullptr);

// Same UNC path, with a '..' segment in the relative tail.
LoadSpec lookupDotDot;
lookupDotDot.filepath = "\\\\server\\share\\path\\subdir\\..\\foo.tif";
REQUIRE(cache.findImage(lookupDotDot) != nullptr);

// Different UNC share — must NOT collide.
LoadSpec otherShare;
otherShare.filepath = "\\\\server\\othershare\\path\\foo.tif";
REQUIRE(cache.findImage(otherShare) == nullptr);
}

SECTION("Forward and back slashes are equivalent on Windows")
{
LoadSpec stored;
stored.filepath = "C:/some/dir/foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "C:\\some\\dir\\foo.tif";
REQUIRE(cache.findImage(lookup) != nullptr);
}

SECTION("Case differences are equivalent on Windows")
{
LoadSpec stored;
stored.filepath = "C:/Some/Dir/Foo.tif";
cache.storeImage(stored, makeImage(4, 4, 4, 1));

LoadSpec lookup;
lookup.filepath = "c:/some/dir/foo.tif";
REQUIRE(cache.findImage(lookup) != nullptr);
}
#endif
}
Loading