fix: ignore test_a_suffix snapshots when running test_a

[huonw]

Description

This fixes #596 by making the filename vs. snapshot location matching stricter: instead of allowing a filename of test_file to match if it's a substring of the location (e.g. FOOtest_fileBAR would match), it now only matches if either of these are true:

• the filename exactly matches, ignoring the extension (e.g. test_file.ambr matches, while test_file_whatever.ambr does not)
• the parent directory exactly matches (e.g. .../test_file/foo.bar matches, but .../test_file.foo/bar does not, nor .../test_file/subdirectory/foo.bar)

I've added tests for this, as well as expanding the existing ones for #529 to include checking test names that have matching suffices (especially relevant for tests/integration/test_snapshot_similar_names_file_extension.py, with the single file snapshots). All three sets of changed tests fail without the change to location.py.

Related Issues

• Closes Unused snapshots when running on filename (test_a.py) that's the prefix of another (test_abc.py) #596

Checklist

• This PR has sufficient documentation.
• This PR has sufficient test coverage.
• This PR title satisfies semantic convention.

Additional Comments

Thanks for Syrupy!

[noahnu]

I assume this is to handle the SingleFileExtension (image + json). Right now it's not strict enough since the parents will traverse all the way up to the root of the file system.

My proposed logic:

Suggested change

	return self.filename == loc.stem or any(
	self.filename == parent.name for parent in loc.parents
	)
	return self.filename == loc.stem or self.filename == loc.parent.name

This does break the ability for an extension to have additional depth in their snapshot directories, but I think that's an okay compromise (my plans for syrupy in v3 are to restrict the API a bit to make internal refactoring easier -- we were a bit overzealous with how "extensible" we made everything).

[huonw]

Sounds good to me 👍 I've made that update and validated it in the tests.

[tophat-opensource-bot]

🎉 This PR is included in version 2.3.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[huonw]

Woohoo, thank you!