pedrovgs/KotlinSnapshot

Option to Fail if Snapshot is Missing

Open

#70 opened on Oct 5, 2021

View on GitHubContributor guide
 (5 comments) (1 reaction) (0 assignees)Kotlin (13 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (167 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Removed the template because this is a feature request rather than a bug report.

It would be useful to have an option to fail an assertion, rather than generate a snapshot, if a snapshot is missing. This is especially useful for CI. It's also possible I'm missing something here but in local dev with the latest version of KotlinSnapshot, just deleting a snapshot will recreate it on the next test, which could create false negatives (no failure? false positive success?).

Jest's default behavior is not to create snapshots without --updateSnapshots which I think is safe, but even just a flag would be useful.

Please point me in the right direction if I'm missing something, which is totally possible, but it looks like the answer is currently no: https://github.com/pedrovgs/KotlinSnapshot/blob/69fba61ca93080866a7ee90713595e1ead0bf1ba/core/src/main/kotlin/com/karumi/kotlinsnapshot/core/Camera.kt#L28-L31

Contributor guide

Research direction
Examine the Camera.kt file to see how snapshots are created, then add a configuration flag to throw an error instead of creating a snapshot when one is missing.
Tech stack
kotlin
Domain
testing
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75