neser 1.2.0

NESER - Nintendo Emulation Systems Engine (Rust). Desktop and WebAssembly frontends.
Documentation 
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294


"""
TestRomXml: Unit tests for the RomXml streaming XML parser.

This module provides a suite of tests for the RomXml class, verifying correct parsing
of NES ROM XML files, including handling of all relevant cartridge metadata fields.
"""
import os
import tempfile
import unittest
try:
    from .romxml import RomXml
    from .rom_database import RomDbKey
except ImportError:  # pragma: no cover - allow running as a script
    from romxml import RomXml
    from rom_database import RomDbKey

class TestRomXml(unittest.TestCase):
    """
    Unit tests for the RomXml streaming XML parser.
    """
    def _write_xml(self, xml_text: str) -> str:
        """
        Write the given XML string to a temporary file.

        Args:
            xml_text: The XML content to write.

        Returns:
            str: Path to the temporary XML file.
        """
        fd, path = tempfile.mkstemp(suffix=".xml")
        with os.fdopen(fd, "w", encoding="utf-8") as handle:
            handle.write(xml_text)
        return path
    def test_next_record_parses_fields_and_uppercases_crc(self) -> None:
        """
        Test that RomXml parses fields and uppercases CRC values.
        """
        xml_text = """
        <database>
            <game>
            <rom crc32="a1b2c3d4" />
            <pcb mirroring="horizontal" />
            <console region="PAL" />
            </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            record = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(
            record,
            {
                RomDbKey.CRC.value: "A1B2C3D4",
                RomDbKey.NAMETABLE_LAYOUT.value: "horizontal",
                RomDbKey.HARDWARE.value: "1",
                RomDbKey.PRG_ROM_SIZE.value: "0",
                RomDbKey.PRG_RAM_SIZE.value: "0",
                RomDbKey.PRG_NVRAM_SIZE.value: "0",
                RomDbKey.CHR_ROM_SIZE.value: "0",
                RomDbKey.CHR_RAM_SIZE.value: "0",
                RomDbKey.CHR_NVRAM_SIZE.value: "0"
            }
        )

    def test_next_record_handles_missing_fields(self) -> None:
        """
        Test that RomXml handles missing fields gracefully.
        """
        xml_text = """
        <database>
          <game>
            <rom />
            <pcb />
            <console />
          </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            record = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(record, {
            RomDbKey.PRG_ROM_SIZE.value: "0",
            RomDbKey.PRG_RAM_SIZE.value: "0",
            RomDbKey.PRG_NVRAM_SIZE.value: "0",
            RomDbKey.CHR_ROM_SIZE.value: "0",
            RomDbKey.CHR_RAM_SIZE.value: "0",
            RomDbKey.CHR_NVRAM_SIZE.value: "0"
        })

    def test_next_record_multiple_games(self) -> None:
        """
        Test that RomXml parses multiple <game> elements in sequence.
        """
        xml_text = """
        <database>
          <game>
            <rom crc32="00000001" />
          </game>
          <game>
            <rom crc32="00000002" />
            <pcb mirroring="vertical" />
          </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            first = parser.next_record()
            second = parser.next_record()
            third = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(first, {
            RomDbKey.CRC.value: "00000001",
            RomDbKey.PRG_ROM_SIZE.value: "0",
            RomDbKey.PRG_RAM_SIZE.value: "0",
            RomDbKey.PRG_NVRAM_SIZE.value: "0",
            RomDbKey.CHR_ROM_SIZE.value: "0",
            RomDbKey.CHR_RAM_SIZE.value: "0",
            RomDbKey.CHR_NVRAM_SIZE.value: "0"
        })
        self.assertEqual(second, {
            RomDbKey.CRC.value: "00000002", 
            RomDbKey.NAMETABLE_LAYOUT.value: "vertical",
            RomDbKey.PRG_ROM_SIZE.value: "0",
            RomDbKey.PRG_RAM_SIZE.value: "0",
            RomDbKey.PRG_NVRAM_SIZE.value: "0",
            RomDbKey.CHR_ROM_SIZE.value: "0",
            RomDbKey.CHR_RAM_SIZE.value: "0",
            RomDbKey.CHR_NVRAM_SIZE.value: "0"
        })
        self.assertIsNone(third)

    def test_next_record_ignores_non_game_elements(self) -> None:
        """
        Test that RomXml ignores non-<game> elements in the XML.
        """
        xml_text = """
        <database>
          <header version="1" />
          <game>
            <rom crc32="deadbeef" />
          </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            record = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(record, {
            RomDbKey.CRC.value: "DEADBEEF",
            RomDbKey.PRG_ROM_SIZE.value: "0",
            RomDbKey.PRG_RAM_SIZE.value: "0",
            RomDbKey.PRG_NVRAM_SIZE.value: "0",
            RomDbKey.CHR_ROM_SIZE.value: "0",
            RomDbKey.CHR_RAM_SIZE.value: "0",
            RomDbKey.CHR_NVRAM_SIZE.value: "0"
        })

    def test_next_record_missing_crc_is_omitted(self) -> None:
        """
        Test that RomXml omits records missing CRC values.
        """
        xml_text = """
        <database>
          <game>
            <rom size="16" />
          </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            record = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(record, {
            RomDbKey.PRG_ROM_SIZE.value: "0",
            RomDbKey.PRG_RAM_SIZE.value: "0",
            RomDbKey.PRG_NVRAM_SIZE.value: "0",
            RomDbKey.CHR_ROM_SIZE.value: "0",
            RomDbKey.CHR_RAM_SIZE.value: "0",
            RomDbKey.CHR_NVRAM_SIZE.value: "0"            
        })

    def test_next_record_parses_extended_rom_info(self) -> None:
        """
        Test that RomXml parses all extended cartridge metadata fields from XML.
        """
        xml_text = """
        <database>
          <game>
            <!--  Licensed Japan 10-Yard Fight (rev0).nes  -->
            <prgrom size="16384" crc32="D3D248C9" sha1="64185EDC4FD64B5F5E565B90B0DDC241592D899C" sum16="0339"/>
            <chrrom size="8192" crc32="9C124A53" sha1="BEDDF6A65A1A72410CFB1208E8B6B6E0CF5B2E74" sum16="16E5"/>
            <rom size="24576" crc32="836C4FA7" sha1="55DC03A493150258E10166CF38ED76DFADE605D6"/>
            <chrnvram size="8192"/>
            <chrram size="8192"/>
            <prgnvram size="8192"/>
            <prgram size="8192"/>
            <pcb mapper="0" submapper="0" mirroring="H" battery="0"/>
            <console type="0" region="0"/>
            <expansion type="1"/>
            <vs hardware="0" ppu="5"/>
          </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            record = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(
            record,
            {
                RomDbKey.CRC.value: "836C4FA7",
                RomDbKey.PRG_ROM_SIZE.value: "16384",
                RomDbKey.PRG_ROM_CRC.value: "D3D248C9",
                RomDbKey.PRG_NVRAM_SIZE.value: "8192",
                RomDbKey.PRG_RAM_SIZE.value: "8192",
                RomDbKey.CHR_ROM_SIZE.value: "8192",
                RomDbKey.CHR_ROM_CRC.value: "9C124A53",
                RomDbKey.CHR_NVRAM_SIZE.value: "8192",
                RomDbKey.CHR_RAM_SIZE.value: "8192",
                RomDbKey.MAPPER.value: "0",
                RomDbKey.SUBMAPPER.value: "0",
                RomDbKey.NAMETABLE_LAYOUT.value: "H",
                RomDbKey.BATTERY.value: "0",
                RomDbKey.HARDWARE.value: "2",
                RomDbKey.EXPANSION_TYPE.value: "1",
                RomDbKey.VS_HARDWARE_TYPE.value: "0",
                RomDbKey.VS_PPU_TYPE.value: "5",
                RomDbKey.CONSOLE_CLASS.value: "Licensed Japan 10-Yard Fight (rev0).nes"
            },
        )

    def test_next_record_parses_extended_rom_info_missing_optional(self) -> None:
        """
        Test that RomXml handles missing optional fields in extended XML.
        """
        xml_text = """
        <database>
          <game>
            <rom crc32="1234abcd" />
            <pcb mapper="2" />
          </game>
        </database>
        """
        path = self._write_xml(xml_text)
        try:
            parser = RomXml(path)
            record = parser.next_record()
        finally:
            os.unlink(path)

        self.assertEqual(record, {
            RomDbKey.CRC.value: "1234ABCD",
            RomDbKey.MAPPER.value: "2",
            RomDbKey.PRG_ROM_SIZE.value: "0",
            RomDbKey.PRG_RAM_SIZE.value: "0",
            RomDbKey.PRG_NVRAM_SIZE.value: "0",
            RomDbKey.CHR_ROM_SIZE.value: "0",
            RomDbKey.CHR_RAM_SIZE.value: "0",
            RomDbKey.CHR_NVRAM_SIZE.value: "0"
        })

    def test_normalize_label(self) -> None:
        """
        Test the _normalize_label static method for label normalization.
        """
        self.assertEqual(RomXml._normalize_label(None), "")
        self.assertEqual(RomXml._normalize_label("  A  B  "), "A B")
        self.assertEqual(RomXml._normalize_label("Label:"), "Label")


if __name__ == "__main__":
    unittest.main()