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

"""Unit tests for release package assembly."""

import stat
import tarfile
import tempfile
import unittest
import zipfile
from pathlib import Path

from scripts.package_release import (
    ReleasePackageConfig,
    _read_shader_preset_paths,
    collect_shader_dependencies,
    create_release_archive,
    main,
)


def write_text(path: Path, text: str) -> None:
    """Write UTF-8 text, creating parent directories first."""

    path.parent.mkdir(parents=True, exist_ok=True)
    path.write_text(text, encoding="utf-8")


def write_bytes(path: Path, data: bytes = b"test") -> None:
    """Write bytes, creating parent directories first."""

    path.parent.mkdir(parents=True, exist_ok=True)
    path.write_bytes(data)


def path_exists_with_exact_case(repo_root: Path, relative_path: Path) -> bool:
    """Return whether each path segment matches the directory entry casing exactly."""

    current = repo_root
    for part in relative_path.parts:
        if not current.is_dir():
            return False
        entries = {entry.name for entry in current.iterdir()}
        if part not in entries:
            return False
        current = current / part
    return current.exists()


class PackageReleaseTests(unittest.TestCase):
    """Behavior tests for release archive creation."""

    def test_repository_shader_dependencies_are_collectable(self) -> None:
        """Release packaging can collect every shader preset configured by the repository."""

        repo_root = Path(__file__).resolve().parents[1]

        dependencies = collect_shader_dependencies(repo_root)

        self.assertIn(Path("shaders/stock.slangp"), dependencies)

    def test_repository_shader_preset_paths_match_exact_vendor_casing(self) -> None:
        """Configured shader preset paths match vendored filenames on case-sensitive runners."""

        repo_root = Path(__file__).resolve().parents[1]
        preset_paths = _read_shader_preset_paths(repo_root / "src/platform/shaders.rs")

        mismatches = [
            path
            for path in preset_paths
            if not path_exists_with_exact_case(repo_root, path)
        ]

        self.assertEqual(mismatches, [])

    def test_collect_shader_dependencies_resolves_configured_preset_graph(self) -> None:
        """Configured shader presets include referenced presets, passes, includes, and LUTs."""

        with tempfile.TemporaryDirectory() as temp_dir_str:
            repo_root = Path(temp_dir_str)
            write_text(
                repo_root / "src/platform/shaders.rs",
                """
pub const SHADER_PRESETS: &[(&str, &str)] = &[
    (
        "crt",
        "vendor/slang-shaders/crt/preset.slangp",
    ),
];
""",
            )
            write_text(
                repo_root / "vendor/slang-shaders/crt/preset.slangp",
                '#reference "../common/base.slangp"\n'
                "shader0 = pass.slang\n"
                'textures = "lut.png"\n',
            )
            write_text(
                repo_root / "vendor/slang-shaders/crt/pass.slang",
                '#include "shared.inc"\n',
            )
            write_text(
                repo_root / "vendor/slang-shaders/crt/shared.inc", "#define TEST 1\n"
            )
            write_bytes(repo_root / "vendor/slang-shaders/crt/lut.png")
            write_text(
                repo_root / "vendor/slang-shaders/common/base.slangp",
                "shader0 = base.slang\n",
            )
            write_text(
                repo_root / "vendor/slang-shaders/common/base.slang", "void main() {}\n"
            )

            dependencies = collect_shader_dependencies(repo_root)

            self.assertEqual(
                dependencies,
                {
                    Path("vendor/slang-shaders/crt/preset.slangp"),
                    Path("vendor/slang-shaders/crt/pass.slang"),
                    Path("vendor/slang-shaders/crt/shared.inc"),
                    Path("vendor/slang-shaders/crt/lut.png"),
                    Path("vendor/slang-shaders/common/base.slangp"),
                    Path("vendor/slang-shaders/common/base.slang"),
                },
            )

    def test_create_tar_gz_archive_uses_release_layout_and_excludes_scripts(
        self,
    ) -> None:
        """Tar packages contain runtime resources under neser/ and omit dev scripts."""

        with tempfile.TemporaryDirectory() as temp_dir_str:
            repo_root = Path(temp_dir_str)
            output_dir = repo_root / "dist"
            binary_path = repo_root / "target/release/neser"
            write_bytes(binary_path, b"#!/bin/sh\n")
            binary_path.chmod(0o755)
            write_bytes(repo_root / "assets/fonts/NunitoSans-Regular.ttf")
            write_text(repo_root / "gamecontrollerdb.txt", "controller mappings\n")
            write_text(repo_root / "neser.conf.example", "# config\n")
            write_text(repo_root / "README.md", "# neser\n")
            write_text(repo_root / "README-NES.md", "# nes\n")
            write_text(repo_root / "README-GB.md", "# gb\n")
            write_text(repo_root / "README-GBA.md", "# gba\n")
            write_text(repo_root / "LICENSE", "license\n")
            write_text(repo_root / "shaders/stock.slangp", "shader0 = stock.slang\n")
            write_text(repo_root / "shaders/stock.slang", "void main() {}\n")
            write_text(
                repo_root / "src/platform/shaders.rs",
                'pub const SHADER_PRESETS: &[(&str, &str)] = &[("none", '
                '"shaders/stock.slangp")];',
            )
            write_text(repo_root / "scripts/dev-only.py", "print('dev only')\n")

            archive_path = create_release_archive(
                ReleasePackageConfig(
                    repo_root=repo_root,
                    binary_path=binary_path,
                    output_dir=output_dir,
                    target="x86_64-unknown-linux-gnu",
                    archive_format="tar.gz",
                )
            )

            self.assertEqual(archive_path.name, "neser-x86_64-unknown-linux-gnu.tar.gz")
            with tarfile.open(archive_path, "r:gz") as archive:
                names = set(archive.getnames())

                self.assertIn("neser/neser", names)
                self.assertIn("neser/assets/fonts/NunitoSans-Regular.ttf", names)
                self.assertIn("neser/gamecontrollerdb.txt", names)
                self.assertIn("neser/neser.conf.example", names)
                self.assertIn("neser/README.md", names)
                self.assertIn("neser/README-NES.md", names)
                self.assertIn("neser/README-GB.md", names)
                self.assertIn("neser/README-GBA.md", names)
                self.assertIn("neser/LICENSE", names)
                self.assertIn("neser/shaders/stock.slangp", names)
                self.assertIn("neser/shaders/stock.slang", names)
                self.assertFalse(
                    any(name.startswith("neser/scripts/") for name in names)
                )

                binary_info = archive.getmember("neser/neser")
                self.assertTrue(binary_info.mode & stat.S_IXUSR)

    def test_create_zip_archive_uses_windows_release_layout(self) -> None:
        """Zip packages contain Windows binary and runtime resources under neser/."""

        with tempfile.TemporaryDirectory() as temp_dir_str:
            repo_root = Path(temp_dir_str)
            output_dir = repo_root / "dist"
            binary_path = repo_root / "target/release/neser.exe"
            write_bytes(binary_path, b"MZ")
            write_bytes(repo_root / "assets/fonts/NunitoSans-Regular.ttf")
            write_text(repo_root / "gamecontrollerdb.txt", "controller mappings\n")
            write_text(repo_root / "neser.conf.example", "# config\n")
            write_text(repo_root / "README.md", "# neser\n")
            write_text(repo_root / "README-NES.md", "# nes\n")
            write_text(repo_root / "README-GB.md", "# gb\n")
            write_text(repo_root / "README-GBA.md", "# gba\n")
            write_text(repo_root / "LICENSE", "license\n")
            write_text(repo_root / "shaders/stock.slangp", "shader0 = stock.slang\n")
            write_text(repo_root / "shaders/stock.slang", "void main() {}\n")
            write_text(
                repo_root / "src/platform/shaders.rs",
                'pub const SHADER_PRESETS: &[(&str, &str)] = &[("none", '
                '"shaders/stock.slangp")];',
            )
            write_text(repo_root / "scripts/dev-only.py", "print('dev only')\n")

            archive_path = create_release_archive(
                ReleasePackageConfig(
                    repo_root=repo_root,
                    binary_path=binary_path,
                    output_dir=output_dir,
                    target="x86_64-pc-windows-msvc",
                    archive_format="zip",
                    binary_name="neser.exe",
                )
            )

            self.assertEqual(archive_path.name, "neser-x86_64-pc-windows-msvc.zip")
            with zipfile.ZipFile(archive_path) as archive:
                names = set(archive.namelist())

            self.assertIn("neser/neser.exe", names)
            self.assertIn("neser/gamecontrollerdb.txt", names)
            self.assertIn("neser/README-NES.md", names)
            self.assertIn("neser/README-GB.md", names)
            self.assertIn("neser/README-GBA.md", names)
            self.assertIn("neser/shaders/stock.slangp", names)
            self.assertFalse(any(name.startswith("neser/scripts/") for name in names))

    def test_main_creates_archive_from_cli_arguments(self) -> None:
        """CLI arguments create the requested release archive."""

        with tempfile.TemporaryDirectory() as temp_dir_str:
            repo_root = Path(temp_dir_str)
            output_dir = repo_root / "dist"
            binary_path = repo_root / "target/release/neser"
            write_bytes(binary_path, b"#!/bin/sh\n")
            binary_path.chmod(0o755)
            write_bytes(repo_root / "assets/fonts/NunitoSans-Regular.ttf")
            write_text(repo_root / "gamecontrollerdb.txt", "controller mappings\n")
            write_text(repo_root / "neser.conf.example", "# config\n")
            write_text(repo_root / "README.md", "# neser\n")
            write_text(repo_root / "README-NES.md", "# nes\n")
            write_text(repo_root / "README-GB.md", "# gb\n")
            write_text(repo_root / "README-GBA.md", "# gba\n")
            write_text(repo_root / "LICENSE", "license\n")
            write_text(repo_root / "shaders/stock.slangp", "shader0 = stock.slang\n")
            write_text(repo_root / "shaders/stock.slang", "void main() {}\n")
            write_text(
                repo_root / "src/platform/shaders.rs",
                'pub const SHADER_PRESETS: &[(&str, &str)] = &[("none", '
                '"shaders/stock.slangp")];',
            )

            exit_code = main(
                [
                    "--repo-root",
                    str(repo_root),
                    "--binary",
                    str(binary_path),
                    "--output-dir",
                    str(output_dir),
                    "--target",
                    "x86_64-unknown-linux-gnu",
                    "--format",
                    "tar.gz",
                ]
            )

            self.assertEqual(exit_code, 0)
            self.assertTrue(
                (output_dir / "neser-x86_64-unknown-linux-gnu.tar.gz").exists()
            )


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