1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86

// Copyright (C) 2025 Shota FUJI
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: GPL-3.0-only

const std = @import("std");

const config = @import("config");

pub const SnapshotError = error{
    ProcessNotExited,
};

const test_name_prefix = "test.";

pub fn expectMatchSnapshot(
    location: std.builtin.SourceLocation,
    run: *const std.process.Child.RunResult,
) !void {
    var arena = std.heap.ArenaAllocator.init(std.testing.allocator);
    defer arena.deinit();

    const allocator = arena.allocator();

    switch (run.term) {
        .Exited => {},
        else => {
            std.debug.print("Program did not exit: {s}\n", .{@tagName(run.term)});
            return SnapshotError.ProcessNotExited;
        },
    }

    const filename = if (std.mem.startsWith(u8, location.fn_name, test_name_prefix))
        location.fn_name[test_name_prefix.len..]
    else
        location.fn_name;

    var src_dir = try std.fs.openDirAbsolute(config.test_src_root, .{ .no_follow = true });
    defer src_dir.close();

    const current = src_dir.readFileAlloc(allocator, filename, std.math.maxInt(usize)) catch |err| {
        if (config.update_snapshot) {
            std.debug.print("Writing snapshot to {s}\n", .{filename});
            try src_dir.writeFile(.{
                .data = run.stdout,
                .sub_path = filename,
            });
            return;
        }

        std.debug.print(
            "Unable to open snapshot file {s}. Create using -Dupdate-snapshot option\n",
            .{filename},
        );
        return err;
    };

    const current_normalized = try std.mem.replaceOwned(u8, allocator, current, "\r\n", "\n");
    allocator.free(current);

    const actual_normalized = try std.mem.replaceOwned(u8, allocator, run.stdout, "\r\n", "\n");

    if (!std.mem.eql(u8, current_normalized, actual_normalized) and config.update_snapshot) {
        std.debug.print("Writing snapshot to {s}\n", .{filename});
        try src_dir.writeFile(.{
            .data = actual_normalized,
            .sub_path = filename,
        });
        return;
    }

    // Let std.testing print diffs
    try std.testing.expectEqualStrings(current_normalized, actual_normalized);
}