|
| 1 | +"""Tests for json_dump_if_changed functionality.""" |
| 2 | + |
| 3 | +import codecs |
| 4 | +import json |
| 5 | +import os |
| 6 | +import tempfile |
| 7 | + |
| 8 | +import pytest |
| 9 | + |
| 10 | +from github_backup import github_backup |
| 11 | + |
| 12 | + |
| 13 | +class TestJsonDumpIfChanged: |
| 14 | + """Test suite for json_dump_if_changed function.""" |
| 15 | + |
| 16 | + def test_writes_new_file(self): |
| 17 | + """Should write file when it doesn't exist.""" |
| 18 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 19 | + output_file = os.path.join(tmpdir, "test.json") |
| 20 | + test_data = {"key": "value", "number": 42} |
| 21 | + |
| 22 | + result = github_backup.json_dump_if_changed(test_data, output_file) |
| 23 | + |
| 24 | + assert result is True |
| 25 | + assert os.path.exists(output_file) |
| 26 | + |
| 27 | + # Verify content matches expected format |
| 28 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 29 | + content = f.read() |
| 30 | + loaded = json.loads(content) |
| 31 | + assert loaded == test_data |
| 32 | + |
| 33 | + def test_skips_unchanged_file(self): |
| 34 | + """Should skip write when content is identical.""" |
| 35 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 36 | + output_file = os.path.join(tmpdir, "test.json") |
| 37 | + test_data = {"key": "value", "number": 42} |
| 38 | + |
| 39 | + # First write |
| 40 | + result1 = github_backup.json_dump_if_changed(test_data, output_file) |
| 41 | + assert result1 is True |
| 42 | + |
| 43 | + # Get the initial mtime |
| 44 | + mtime1 = os.path.getmtime(output_file) |
| 45 | + |
| 46 | + # Second write with same data |
| 47 | + result2 = github_backup.json_dump_if_changed(test_data, output_file) |
| 48 | + assert result2 is False |
| 49 | + |
| 50 | + # File should not have been modified |
| 51 | + mtime2 = os.path.getmtime(output_file) |
| 52 | + assert mtime1 == mtime2 |
| 53 | + |
| 54 | + def test_writes_when_content_changed(self): |
| 55 | + """Should write file when content has changed.""" |
| 56 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 57 | + output_file = os.path.join(tmpdir, "test.json") |
| 58 | + test_data1 = {"key": "value1"} |
| 59 | + test_data2 = {"key": "value2"} |
| 60 | + |
| 61 | + # First write |
| 62 | + result1 = github_backup.json_dump_if_changed(test_data1, output_file) |
| 63 | + assert result1 is True |
| 64 | + |
| 65 | + # Second write with different data |
| 66 | + result2 = github_backup.json_dump_if_changed(test_data2, output_file) |
| 67 | + assert result2 is True |
| 68 | + |
| 69 | + # Verify new content |
| 70 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 71 | + loaded = json.load(f) |
| 72 | + assert loaded == test_data2 |
| 73 | + |
| 74 | + def test_uses_consistent_formatting(self): |
| 75 | + """Should use same JSON formatting as json_dump.""" |
| 76 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 77 | + output_file = os.path.join(tmpdir, "test.json") |
| 78 | + test_data = {"z": "last", "a": "first", "m": "middle"} |
| 79 | + |
| 80 | + github_backup.json_dump_if_changed(test_data, output_file) |
| 81 | + |
| 82 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 83 | + content = f.read() |
| 84 | + |
| 85 | + # Check for consistent formatting: |
| 86 | + # - sorted keys |
| 87 | + # - 4-space indent |
| 88 | + # - comma-colon-space separator |
| 89 | + expected = json.dumps( |
| 90 | + test_data, |
| 91 | + ensure_ascii=False, |
| 92 | + sort_keys=True, |
| 93 | + indent=4, |
| 94 | + separators=(",", ": "), |
| 95 | + ) |
| 96 | + assert content == expected |
| 97 | + |
| 98 | + def test_atomic_write_always_used(self): |
| 99 | + """Should always use temp file and rename for atomic writes.""" |
| 100 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 101 | + output_file = os.path.join(tmpdir, "test.json") |
| 102 | + test_data = {"key": "value"} |
| 103 | + |
| 104 | + result = github_backup.json_dump_if_changed(test_data, output_file) |
| 105 | + |
| 106 | + assert result is True |
| 107 | + assert os.path.exists(output_file) |
| 108 | + |
| 109 | + # Temp file should not exist after atomic write |
| 110 | + temp_file = output_file + ".temp" |
| 111 | + assert not os.path.exists(temp_file) |
| 112 | + |
| 113 | + # Verify content |
| 114 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 115 | + loaded = json.load(f) |
| 116 | + assert loaded == test_data |
| 117 | + |
| 118 | + def test_handles_unicode_content(self): |
| 119 | + """Should correctly handle Unicode content.""" |
| 120 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 121 | + output_file = os.path.join(tmpdir, "test.json") |
| 122 | + test_data = { |
| 123 | + "emoji": "🚀", |
| 124 | + "chinese": "你好", |
| 125 | + "arabic": "مرحبا", |
| 126 | + "cyrillic": "Привет", |
| 127 | + } |
| 128 | + |
| 129 | + result = github_backup.json_dump_if_changed(test_data, output_file) |
| 130 | + assert result is True |
| 131 | + |
| 132 | + # Verify Unicode is preserved |
| 133 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 134 | + loaded = json.load(f) |
| 135 | + assert loaded == test_data |
| 136 | + |
| 137 | + # Second write should skip |
| 138 | + result2 = github_backup.json_dump_if_changed(test_data, output_file) |
| 139 | + assert result2 is False |
| 140 | + |
| 141 | + def test_handles_complex_nested_data(self): |
| 142 | + """Should handle complex nested data structures.""" |
| 143 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 144 | + output_file = os.path.join(tmpdir, "test.json") |
| 145 | + test_data = { |
| 146 | + "users": [ |
| 147 | + {"id": 1, "name": "Alice", "tags": ["admin", "user"]}, |
| 148 | + {"id": 2, "name": "Bob", "tags": ["user"]}, |
| 149 | + ], |
| 150 | + "metadata": {"version": "1.0", "nested": {"deep": {"value": 42}}}, |
| 151 | + } |
| 152 | + |
| 153 | + result = github_backup.json_dump_if_changed(test_data, output_file) |
| 154 | + assert result is True |
| 155 | + |
| 156 | + # Verify structure is preserved |
| 157 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 158 | + loaded = json.load(f) |
| 159 | + assert loaded == test_data |
| 160 | + |
| 161 | + def test_overwrites_on_unicode_decode_error(self): |
| 162 | + """Should overwrite if existing file has invalid UTF-8.""" |
| 163 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 164 | + output_file = os.path.join(tmpdir, "test.json") |
| 165 | + test_data = {"key": "value"} |
| 166 | + |
| 167 | + # Write invalid UTF-8 bytes |
| 168 | + with open(output_file, "wb") as f: |
| 169 | + f.write(b"\xff\xfe invalid utf-8") |
| 170 | + |
| 171 | + # Should catch UnicodeDecodeError and overwrite |
| 172 | + result = github_backup.json_dump_if_changed(test_data, output_file) |
| 173 | + assert result is True |
| 174 | + |
| 175 | + # Verify new content was written |
| 176 | + with codecs.open(output_file, "r", encoding="utf-8") as f: |
| 177 | + loaded = json.load(f) |
| 178 | + assert loaded == test_data |
| 179 | + |
| 180 | + def test_key_order_independence(self): |
| 181 | + """Should treat differently-ordered dicts as same if keys/values match.""" |
| 182 | + with tempfile.TemporaryDirectory() as tmpdir: |
| 183 | + output_file = os.path.join(tmpdir, "test.json") |
| 184 | + |
| 185 | + # Write first dict |
| 186 | + data1 = {"z": 1, "a": 2, "m": 3} |
| 187 | + github_backup.json_dump_if_changed(data1, output_file) |
| 188 | + |
| 189 | + # Try to write same data but different order |
| 190 | + data2 = {"a": 2, "m": 3, "z": 1} |
| 191 | + result = github_backup.json_dump_if_changed(data2, output_file) |
| 192 | + |
| 193 | + # Should skip because content is the same (keys are sorted) |
| 194 | + assert result is False |
| 195 | + |
| 196 | + |
| 197 | +if __name__ == "__main__": |
| 198 | + pytest.main([__file__, "-v"]) |
0 commit comments