Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dup4/snapshot-cpp
Similar to Jest Snapshot, but implemented in C++.
https://github.com/dup4/snapshot-cpp
cpp snapshot unittest
Last synced: 15 days ago
JSON representation
Similar to Jest Snapshot, but implemented in C++.
- Host: GitHub
- URL: https://github.com/dup4/snapshot-cpp
- Owner: Dup4
- License: mit
- Created: 2022-04-11T11:36:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-24T03:25:04.000Z (about 1 year ago)
- Last Synced: 2024-05-02T05:50:18.158Z (6 months ago)
- Topics: cpp, snapshot, unittest
- Language: C++
- Homepage:
- Size: 223 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# snapshot-cpp
[![Clang Format][clang-format-badge]][clang-format-action]
[![Test][test-badge]][test-action]
[![codecov][codecov-badge]][codecov]
[![GitHub release][release-badge]][release-page]
Similar to [Jest Snapshot][jest-snapshot], but implemented in C++.
## Feature
* `SNAPSHOT(content)`
* `SNAPSHOT_INLINE(content)`
* `SNAPSHOT_DIFF(before_content, after_content)` required `git` binary.
* Support Linux and macOS.
## Integration
### CMake
```cmake
FetchContent_Declare(
snapshot
QUIET
GIT_REPOSITORY https://github.com/Dup4/snapshot-cpp.git
GIT_TAG v{x.y.z} # Where `x.y.z` is the release version you want to use.
)
```
### Bazel
```bazel
git_repository(
name = "snapshot",
remote = "https://github.com/Dup4/snapshot-cpp.git",
tag = "v{x.y.z}", # Where `x.y.z` is the release version you want to use.
)
```
## Usage
```cpp
const std::string tmp = "snapshot-cpp";
const std::string tmp_diff = tmp + "-diff";
EXPECT_EQ(tmp, SNAPSHOT_INLINE(tmp));
// EXPECT_EQ(tmp, std::string("snapshot-cpp"));
SNAPSHOT(tmp);
// // /home/Dup4/snapshot-cpp/test/snapshot_test.cc.TestBody.58.0
// std::string("snapshot-cpp")
SNAPSHOT_DIFF(tmp, tmp_diff);
// // /home/Dup4/snapshot-cpp/test/snapshot_test.cc.TestBody.59.0
// // before
// std::string("snapshot-cpp")
// // after
// std::string("snapshot-cpp-diff")
// // diff
// diff --git a/tmp/snapshot_test.cc.TestBody.59.0.snap.before b/tmp/snapshot_test.cc.TestBody.59.0.snap.after
// index aeb786e..3982900 100644
// --- a/tmp/snapshot_test.cc.TestBody.59.0.snap.before
// +++ b/tmp/snapshot_test.cc.TestBody.59.0.snap.after
// @@ -1 +1 @@
// -std::string("snapshot-cpp")
// \ No newline at end of file
// +std::string("snapshot-cpp-diff")
// \ No newline at end of file
```
## License
[MIT](./LICENSE) License © 2022 - PRESENT [Dup4][dup4]
[clang-format-badge]: https://github.com/Dup4/snapshot-cpp/workflows/Clang%20Format/badge.svg
[clang-format-action]: https://github.com/Dup4/snapshot-cpp/actions/workflows/clang_format.yml
[test-badge]: https://github.com/Dup4/snapshot-cpp/workflows/Test/badge.svg
[test-action]: https://github.com/Dup4/snapshot-cpp/actions/workflows/test.yml
[codecov-badge]: https://codecov.io/gh/Dup4/snapshot-cpp/branch/main/graph/badge.svg
[codecov]: https://codecov.io/gh/Dup4/snapshot-cpp
[release-badge]: https://img.shields.io/github/release/Dup4/snapshot-cpp.svg
[release-page]: https://GitHub.com/Dup4/snapshot-cpp/releases/
[jest-snapshot]: https://jestjs.io/docs/snapshot-testing
[dup4]: https://github.com/Dup4