Give custom name to image snapshot file

[obendidi]

Hello I have some tests where I need to generate multiple snapshot images in the same test.

Is it possible to provide the target snapshot name file to snapshot when asserting the images are equal ?

My use case:

from syrupy.extensions.image import PNGImageSnapshotExtension
import base64
import pytest


@pytest.fixture
def snapshot(snapshot):
    return snapshot.use_extension(PNGImageSnapshotExtension)

def test_some_func(snasphot):
   base64_img1, base64_img2 = func()

    assert base64.base64decode(base64_img1) == snapshot
    assert base64.base64decode(base64_img2) == snapshot

It works as intended, but IMO the syntax is weird and magical, (we are basically testing 2 different things against the same object).

what I'm looking for / propose is to be able to set a custom filename for the snapshot if we want:

    assert base64.base64decode(base64_img1) == snapshot(filename="photo_image.png")
    assert base64.base64decode(base64_img2) == snapshot(filename="signature_image.png")

Thanks!

[noahnu]

Not possible at the moment, and there are some assumptions about filename for the PNG extension, however perhaps we can add some "name" field.

[obendidi]

If i understood correctly the lib currently uses the test function name as name for the png + the number of calls to snapshot as a suffix, to have something like this:

__snapshots__/<test_file_name>/<test_function_name>.<num_call_if_>_0>.png

can we perhaps add prefix_name that overides, the num_call that is added automatically ?

would be happy to contribute in any case ^^

[noahnu]

That logic happens here: https://github.com/tophat/syrupy/blob/e008935c052106d157196ca77415f4773a14f64a/src/syrupy/extensions/base.py#L79. You should be able to adjust it for a custom extension or for the PNG / single file extension. There might be assumptions around it in terms of discovering unused snapshots. Feel free to explore it, contributions welcome. This bit gets a bit tricky though.

[danfrankj]

+1 for this feature. We have string string assertions that need to land in separate named files. As soon as that lands, we'll happily migrate off of snapshottest

[noahnu]

@danfrankj would the behaviour of overriding num_call as @Bendidi suggested be sufficient? I don't think we could easily support full control of the name (outside of a custom extension) due to challenges with snapshot discovery.

[tophat-opensource-bot]

🎉 This issue has been resolved in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[noahnu]

@iamogbz Looks like this github comment was posted by the dry run for the next branch ^.