1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
// Copyright (c) 2026 Progmasoft.
// SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-1.1
#include <Progmasoft/Catch3.hpp>
#include <atomic>
#include <chrono>
#include <filesystem>
#include <fstream>
#include <string>
#include <system_error>
namespace {
class TemporarySnapshotDirectory final {
public:
TemporarySnapshotDirectory() {
static std::atomic<unsigned long long> nextId{ 0 };
const auto timestamp =
std::chrono::steady_clock::now().time_since_epoch().count();
Path = std::filesystem::temp_directory_path() /
( "progmasoft-catch3-snapshot-" +
std::to_string( timestamp ) + "-" +
std::to_string(
nextId.fetch_add( 1, std::memory_order_relaxed ) ) );
std::filesystem::create_directories( Path );
}
~TemporarySnapshotDirectory() {
std::error_code ignored;
std::filesystem::remove_all( Path, ignored );
}
std::filesystem::path Path;
};
} // namespace
TEST_CASE( "Snapshot comparison does not write during ordinary runs",
"[progmasoft][snapshot]" ) {
using Progmasoft::Catch3::CompareSnapshot;
using Progmasoft::Catch3::SnapshotOptions;
using Progmasoft::Catch3::SnapshotStatus;
const TemporarySnapshotDirectory directory;
const auto result =
CompareSnapshot( "greeting",
"hello\nworld\n",
SnapshotOptions{ .Directory = directory.Path } );
CHECK( result.Status == SnapshotStatus::kMismatched );
CHECK_FALSE( result.Succeeded() );
CHECK( result.DifferenceLine == 1 );
CHECK( result.DifferenceColumn == 1 );
CHECK_FALSE( std::filesystem::exists( result.File ) );
}
TEST_CASE( "Snapshots normalize line endings and report precise differences",
"[progmasoft][snapshot]" ) {
using Progmasoft::Catch3::CompareSnapshot;
using Progmasoft::Catch3::SnapshotOptions;
using Progmasoft::Catch3::SnapshotStatus;
using Progmasoft::Catch3::SnapshotUpdateMode;
const TemporarySnapshotDirectory directory;
const SnapshotOptions createOptions{
.Directory = directory.Path,
.UpdateMode = SnapshotUpdateMode::kCreateMissing,
};
const auto created =
CompareSnapshot( "multiline", "one\ntwo\n", createOptions );
REQUIRE( created.Status == SnapshotStatus::kCreated );
CHECK( created.Succeeded() );
const auto normalized =
CompareSnapshot( "multiline", "one\r\ntwo\r\n", createOptions );
CHECK( normalized.Status == SnapshotStatus::kMatched );
CHECK( normalized.Expected == "one\ntwo\n" );
const auto mismatch =
CompareSnapshot( "multiline",
"one\ntoo\n",
SnapshotOptions{ .Directory = directory.Path } );
CHECK( mismatch.Status == SnapshotStatus::kMismatched );
CHECK( mismatch.DifferenceLine == 2 );
CHECK( mismatch.DifferenceColumn == 2 );
CHECK( mismatch.Message.find( "line 2, column 2" ) != std::string::npos );
}
TEST_CASE( "Snapshot creation and replacement require explicit update modes",
"[progmasoft][snapshot]" ) {
using Progmasoft::Catch3::CompareSnapshot;
using Progmasoft::Catch3::SnapshotOptions;
using Progmasoft::Catch3::SnapshotStatus;
using Progmasoft::Catch3::SnapshotUpdateMode;
const TemporarySnapshotDirectory directory;
const SnapshotOptions createMissing{
.Directory = directory.Path,
.UpdateMode = SnapshotUpdateMode::kCreateMissing,
};
REQUIRE( CompareSnapshot( "answer", "first", createMissing ).Succeeded() );
const auto protectedMismatch =
CompareSnapshot( "answer", "second", createMissing );
CHECK( protectedMismatch.Status == SnapshotStatus::kMismatched );
CHECK( protectedMismatch.Expected == "first" );
const SnapshotOptions updateEverything{
.Directory = directory.Path,
.UpdateMode = SnapshotUpdateMode::kAlways,
};
const auto updated =
CompareSnapshot( "answer", "second", updateEverything );
REQUIRE( updated.Status == SnapshotStatus::kUpdated );
CHECK( updated.Expected == "first" );
CHECK( updated.Actual == "second" );
CHECK( CompareSnapshot( "answer", "second", createMissing ).Succeeded() );
}
TEST_CASE( "Snapshot names and I/O failures are returned as structured errors",
"[progmasoft][snapshot]" ) {
using Progmasoft::Catch3::CompareSnapshot;
using Progmasoft::Catch3::SnapshotOptions;
using Progmasoft::Catch3::SnapshotStatus;
using Progmasoft::Catch3::SnapshotUpdateMode;
const TemporarySnapshotDirectory directory;
const SnapshotOptions options{ .Directory = directory.Path };
CHECK( CompareSnapshot( "../outside", "text", options ).Status ==
SnapshotStatus::kInvalidName );
CHECK( CompareSnapshot( "nested/name", "text", options ).Status ==
SnapshotStatus::kInvalidName );
CHECK( CompareSnapshot( "", "text", options ).Status ==
SnapshotStatus::kInvalidName );
CHECK( CompareSnapshot( "valid", "text", SnapshotOptions{} ).Status ==
SnapshotStatus::kInvalidOptions );
const auto blockingFile = directory.Path / "not-a-directory";
{
std::ofstream output( blockingFile, std::ios::binary );
REQUIRE( output.good() );
output << "file";
}
const auto ioFailure = CompareSnapshot(
"snapshot",
"text",
SnapshotOptions{ .Directory = blockingFile,
.UpdateMode = SnapshotUpdateMode::kCreateMissing } );
CHECK( ioFailure.Status == SnapshotStatus::kIoError );
CHECK_FALSE( ioFailure.Message.empty() );
}
TEST_CASE( "Snapshot assertion macro reports successful explicit updates",
"[progmasoft][snapshot]" ) {
const TemporarySnapshotDirectory directory;
CATCH3_CHECK_SNAPSHOT(
"macro",
"stable value",
( Progmasoft::Catch3::SnapshotOptions{
.Directory = directory.Path,
.UpdateMode =
Progmasoft::Catch3::SnapshotUpdateMode::kCreateMissing,
} ) );
}
|