create-test-plan.py 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863
  1. #!/usr/bin/env python
  2. import argparse
  3. import dataclasses
  4. import fnmatch
  5. from enum import Enum
  6. import json
  7. import logging
  8. import os
  9. import re
  10. from typing import Optional
  11. logger = logging.getLogger(__name__)
  12. class AppleArch(Enum):
  13. Aarch64 = "aarch64"
  14. X86_64 = "x86_64"
  15. class MsvcArch(Enum):
  16. X86 = "x86"
  17. X64 = "x64"
  18. Arm32 = "arm"
  19. Arm64 = "arm64"
  20. class JobOs(Enum):
  21. WindowsLatest = "windows-latest"
  22. UbuntuLatest = "ubuntu-latest"
  23. MacosLatest = "macos-latest"
  24. Ubuntu22_04 = "ubuntu-22.04"
  25. Ubuntu24_04 = "ubuntu-24.04"
  26. Ubuntu24_04_arm = "ubuntu-24.04-arm"
  27. Macos13 = "macos-13"
  28. class SdlPlatform(Enum):
  29. Android = "android"
  30. Emscripten = "emscripten"
  31. Haiku = "haiku"
  32. LoongArch64 = "loongarch64"
  33. Msys2 = "msys2"
  34. Linux = "linux"
  35. MacOS = "macos"
  36. Ios = "ios"
  37. Tvos = "tvos"
  38. Msvc = "msvc"
  39. N3ds = "n3ds"
  40. PowerPC = "powerpc"
  41. PowerPC64 = "powerpc64"
  42. Ps2 = "ps2"
  43. Psp = "psp"
  44. Vita = "vita"
  45. Riscos = "riscos"
  46. FreeBSD = "freebsd"
  47. NetBSD = "netbsd"
  48. class Msys2Platform(Enum):
  49. Mingw32 = "mingw32"
  50. Mingw64 = "mingw64"
  51. Clang64 = "clang64"
  52. Ucrt64 = "ucrt64"
  53. class IntelCompiler(Enum):
  54. Icc = "icc"
  55. Icx = "icx"
  56. class VitaGLES(Enum):
  57. Pib = "pib"
  58. Pvr = "pvr"
  59. @dataclasses.dataclass(slots=True)
  60. class JobSpec:
  61. name: str
  62. os: JobOs
  63. platform: SdlPlatform
  64. artifact: Optional[str]
  65. container: Optional[str] = None
  66. no_cmake: bool = False
  67. xcode: bool = False
  68. android_mk: bool = False
  69. android_gradle: bool = False
  70. lean: bool = False
  71. android_arch: Optional[str] = None
  72. android_abi: Optional[str] = None
  73. android_platform: Optional[int] = None
  74. msys2_platform: Optional[Msys2Platform] = None
  75. intel: Optional[IntelCompiler] = None
  76. apple_framework: Optional[bool] = None
  77. apple_archs: Optional[set[AppleArch]] = None
  78. msvc_project: Optional[str] = None
  79. msvc_arch: Optional[MsvcArch] = None
  80. clang_cl: bool = False
  81. gdk: bool = False
  82. vita_gles: Optional[VitaGLES] = None
  83. JOB_SPECS = {
  84. "msys2-mingw32": JobSpec(name="Windows (msys2, mingw32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32", msys2_platform=Msys2Platform.Mingw32, ),
  85. "msys2-mingw64": JobSpec(name="Windows (msys2, mingw64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64", msys2_platform=Msys2Platform.Mingw64, ),
  86. "msys2-clang64": JobSpec(name="Windows (msys2, clang64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-clang", msys2_platform=Msys2Platform.Clang64, ),
  87. "msys2-ucrt64": JobSpec(name="Windows (msys2, ucrt64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-ucrt", msys2_platform=Msys2Platform.Ucrt64, ),
  88. "msvc-x64": JobSpec(name="Windows (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-x64", msvc_arch=MsvcArch.X64, msvc_project="VisualC/SDL.sln", ),
  89. "msvc-x86": JobSpec(name="Windows (MSVC, x86)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-x86", msvc_arch=MsvcArch.X86, msvc_project="VisualC/SDL.sln", ),
  90. "msvc-clang-x64": JobSpec(name="Windows (MSVC, clang-cl x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-clang-cl-x64", msvc_arch=MsvcArch.X64, clang_cl=True, ),
  91. "msvc-clang-x86": JobSpec(name="Windows (MSVC, clang-cl x86)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-clang-cl-x86", msvc_arch=MsvcArch.X86, clang_cl=True, ),
  92. "msvc-arm32": JobSpec(name="Windows (MSVC, ARM)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm32", msvc_arch=MsvcArch.Arm32, ),
  93. "msvc-arm64": JobSpec(name="Windows (MSVC, ARM64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm64", msvc_arch=MsvcArch.Arm64, ),
  94. "msvc-gdk-x64": JobSpec(name="GDK (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-GDK", msvc_arch=MsvcArch.X64, msvc_project="VisualC-GDK/SDL.sln", gdk=True, no_cmake=True, ),
  95. "ubuntu-22.04": JobSpec(name="Ubuntu 22.04", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu22.04", ),
  96. "ubuntu-24.04-arm64": JobSpec(name="Ubuntu 24.04 (ARM64)", os=JobOs.Ubuntu24_04_arm, platform=SdlPlatform.Linux, artifact="SDL-ubuntu24.04-arm64", ),
  97. "steamrt-sniper": JobSpec(name="Steam Linux Runtime (Sniper)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Linux, artifact="SDL-slrsniper", container="registry.gitlab.steamos.cloud/steamrt/sniper/sdk:beta", ),
  98. "ubuntu-intel-icx": JobSpec(name="Ubuntu 22.04 (Intel oneAPI)", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu22.04-oneapi", intel=IntelCompiler.Icx, ),
  99. "ubuntu-intel-icc": JobSpec(name="Ubuntu 22.04 (Intel Compiler)", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu22.04-icc", intel=IntelCompiler.Icc, ),
  100. "macos-framework-x64": JobSpec(name="MacOS (Framework) (x64)", os=JobOs.Macos13, platform=SdlPlatform.MacOS, artifact="SDL-macos-framework", apple_framework=True, apple_archs={AppleArch.Aarch64, AppleArch.X86_64, }, xcode=True, ),
  101. "macos-framework-arm64": JobSpec(name="MacOS (Framework) (arm64)", os=JobOs.MacosLatest, platform=SdlPlatform.MacOS, artifact=None, apple_framework=True, apple_archs={AppleArch.Aarch64, AppleArch.X86_64, }, ),
  102. "macos-gnu-arm64": JobSpec(name="MacOS (GNU prefix)", os=JobOs.MacosLatest, platform=SdlPlatform.MacOS, artifact="SDL-macos-arm64-gnu", apple_framework=False, apple_archs={AppleArch.Aarch64, }, ),
  103. "ios": JobSpec(name="iOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Ios, artifact="SDL-ios-arm64", xcode=True, ),
  104. "tvos": JobSpec(name="tvOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Tvos, artifact="SDL-tvos-arm64", xcode=True, ),
  105. "android-cmake": JobSpec(name="Android (CMake)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact="SDL-android-arm64", android_abi="arm64-v8a", android_arch="aarch64", android_platform=23, ),
  106. "android-cmake-lean": JobSpec(name="Android (CMake, lean)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact="SDL-lean-android-arm64", android_abi="arm64-v8a", android_arch="aarch64", android_platform=23, lean=True, ),
  107. "android-mk": JobSpec(name="Android (Android.mk)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_mk=True, ),
  108. "android-gradle": JobSpec(name="Android (Gradle)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_gradle=True, ),
  109. "emscripten": JobSpec(name="Emscripten", os=JobOs.UbuntuLatest, platform=SdlPlatform.Emscripten, artifact="SDL-emscripten", ),
  110. "haiku": JobSpec(name="Haiku", os=JobOs.UbuntuLatest, platform=SdlPlatform.Haiku, artifact="SDL-haiku-x64", container="ghcr.io/haiku/cross-compiler:x86_64-r1beta5", ),
  111. "loongarch64": JobSpec(name="LoongArch64", os=JobOs.UbuntuLatest, platform=SdlPlatform.LoongArch64, artifact="SDL-loongarch64", ),
  112. "n3ds": JobSpec(name="Nintendo 3DS", os=JobOs.UbuntuLatest, platform=SdlPlatform.N3ds, artifact="SDL-n3ds", container="devkitpro/devkitarm:latest", ),
  113. "ppc": JobSpec(name="PowerPC", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC, artifact="SDL-ppc", container="dockcross/linux-ppc:latest", ),
  114. "ppc64": JobSpec(name="PowerPC64", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC64, artifact="SDL-ppc64le", container="dockcross/linux-ppc64le:latest", ),
  115. "ps2": JobSpec(name="Sony PlayStation 2", os=JobOs.UbuntuLatest, platform=SdlPlatform.Ps2, artifact="SDL-ps2", container="ps2dev/ps2dev:latest", ),
  116. "psp": JobSpec(name="Sony PlayStation Portable", os=JobOs.UbuntuLatest, platform=SdlPlatform.Psp, artifact="SDL-psp", container="pspdev/pspdev:latest", ),
  117. "vita-pib": JobSpec(name="Sony PlayStation Vita (GLES w/ pib)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Vita, artifact="SDL-vita-pib", container="vitasdk/vitasdk:latest", vita_gles=VitaGLES.Pib, ),
  118. "vita-pvr": JobSpec(name="Sony PlayStation Vita (GLES w/ PVR_PSP2)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Vita, artifact="SDL-vita-pvr", container="vitasdk/vitasdk:latest", vita_gles=VitaGLES.Pvr, ),
  119. "riscos": JobSpec(name="RISC OS", os=JobOs.UbuntuLatest, platform=SdlPlatform.Riscos, artifact="SDL-riscos", container="riscosdotinfo/riscos-gccsdk-4.7:latest", ),
  120. "netbsd": JobSpec(name="NetBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.NetBSD, artifact="SDL-netbsd-x64", ),
  121. "freebsd": JobSpec(name="FreeBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.FreeBSD, artifact="SDL-freebsd-x64", ),
  122. }
  123. class StaticLibType(Enum):
  124. MSVC = "SDL3-static.lib"
  125. A = "libSDL3.a"
  126. class SharedLibType(Enum):
  127. WIN32 = "SDL3.dll"
  128. SO_0 = "libSDL3.so.0"
  129. SO = "libSDL3.so"
  130. DYLIB = "libSDL3.0.dylib"
  131. FRAMEWORK = "SDL3.framework/Versions/A/SDL3"
  132. @dataclasses.dataclass(slots=True)
  133. class JobDetails:
  134. name: str
  135. key: str
  136. os: str
  137. platform: str
  138. artifact: str
  139. no_cmake: bool
  140. ccache: bool = False
  141. build_tests: bool = True
  142. container: str = ""
  143. cmake_build_type: str = "RelWithDebInfo"
  144. shell: str = "sh"
  145. sudo: str = "sudo"
  146. cmake_config_emulator: str = ""
  147. apk_packages: list[str] = dataclasses.field(default_factory=list)
  148. apt_packages: list[str] = dataclasses.field(default_factory=list)
  149. brew_packages: list[str] = dataclasses.field(default_factory=list)
  150. cmake_toolchain_file: str = ""
  151. cmake_arguments: list[str] = dataclasses.field(default_factory=list)
  152. cmake_build_arguments: list[str] = dataclasses.field(default_factory=list)
  153. clang_tidy: bool = True
  154. cppflags: list[str] = dataclasses.field(default_factory=list)
  155. cc: str = ""
  156. cxx: str = ""
  157. cflags: list[str] = dataclasses.field(default_factory=list)
  158. cxxflags: list[str] = dataclasses.field(default_factory=list)
  159. ldflags: list[str] = dataclasses.field(default_factory=list)
  160. pollute_directories: list[str] = dataclasses.field(default_factory=list)
  161. use_cmake: bool = True
  162. shared: bool = True
  163. static: bool = True
  164. shared_lib: Optional[SharedLibType] = None
  165. static_lib: Optional[StaticLibType] = None
  166. run_tests: bool = True
  167. test_pkg_config: bool = True
  168. cc_from_cmake: bool = False
  169. source_cmd: str = ""
  170. pretest_cmd: str = ""
  171. java: bool = False
  172. android_apks: list[str] = dataclasses.field(default_factory=list)
  173. android_ndk: bool = False
  174. android_mk: bool = False
  175. android_gradle: bool = False
  176. minidump: bool = False
  177. intel: bool = False
  178. msys2_msystem: str = ""
  179. msys2_env: str = ""
  180. msys2_no_perl: bool = False
  181. werror: bool = True
  182. msvc_vcvars_arch: str = ""
  183. msvc_vcvars_sdk: str = ""
  184. msvc_project: str = ""
  185. msvc_project_flags: list[str] = dataclasses.field(default_factory=list)
  186. setup_ninja: bool = False
  187. setup_libusb_arch: str = ""
  188. xcode_sdk: str = ""
  189. cpactions: bool = False
  190. setup_gdk_folder: str = ""
  191. cpactions_os: str = ""
  192. cpactions_version: str = ""
  193. cpactions_arch: str = ""
  194. cpactions_setup_cmd: str = ""
  195. cpactions_install_cmd: str = ""
  196. setup_vita_gles_type: str = ""
  197. check_sources: bool = False
  198. setup_python: bool = False
  199. pypi_packages: list[str] = dataclasses.field(default_factory=list)
  200. def to_workflow(self, enable_artifacts: bool) -> dict[str, str|bool]:
  201. data = {
  202. "name": self.name,
  203. "key": self.key,
  204. "os": self.os,
  205. "ccache": self.ccache,
  206. "container": self.container if self.container else "",
  207. "platform": self.platform,
  208. "artifact": self.artifact,
  209. "enable-artifacts": enable_artifacts,
  210. "shell": self.shell,
  211. "msys2-msystem": self.msys2_msystem,
  212. "msys2-env": self.msys2_env,
  213. "msys2-no-perl": self.msys2_no_perl,
  214. "android-ndk": self.android_ndk,
  215. "java": self.java,
  216. "intel": self.intel,
  217. "apk-packages": my_shlex_join(self.apk_packages),
  218. "apt-packages": my_shlex_join(self.apt_packages),
  219. "test-pkg-config": self.test_pkg_config,
  220. "brew-packages": my_shlex_join(self.brew_packages),
  221. "pollute-directories": my_shlex_join(self.pollute_directories),
  222. "no-cmake": self.no_cmake,
  223. "build-tests": self.build_tests,
  224. "source-cmd": self.source_cmd,
  225. "pretest-cmd": self.pretest_cmd,
  226. "cmake-config-emulator": self.cmake_config_emulator,
  227. "cc": self.cc,
  228. "cxx": self.cxx,
  229. "cflags": my_shlex_join(self.cppflags + self.cflags),
  230. "cxxflags": my_shlex_join(self.cppflags + self.cxxflags),
  231. "ldflags": my_shlex_join(self.ldflags),
  232. "cmake-toolchain-file": self.cmake_toolchain_file,
  233. "clang-tidy": self.clang_tidy,
  234. "cmake-arguments": my_shlex_join(self.cmake_arguments),
  235. "cmake-build-arguments": my_shlex_join(self.cmake_build_arguments),
  236. "shared": self.shared,
  237. "static": self.static,
  238. "shared-lib": self.shared_lib.value if self.shared_lib else None,
  239. "static-lib": self.static_lib.value if self.static_lib else None,
  240. "cmake-build-type": self.cmake_build_type,
  241. "run-tests": self.run_tests,
  242. "android-apks": my_shlex_join(self.android_apks),
  243. "android-gradle": self.android_gradle,
  244. "android-mk": self.android_mk,
  245. "werror": self.werror,
  246. "sudo": self.sudo,
  247. "msvc-vcvars-arch": self.msvc_vcvars_arch,
  248. "msvc-vcvars-sdk": self.msvc_vcvars_sdk,
  249. "msvc-project": self.msvc_project,
  250. "msvc-project-flags": my_shlex_join(self.msvc_project_flags),
  251. "setup-ninja": self.setup_ninja,
  252. "setup-libusb-arch": self.setup_libusb_arch,
  253. "cc-from-cmake": self.cc_from_cmake,
  254. "xcode-sdk": self.xcode_sdk,
  255. "cpactions": self.cpactions,
  256. "cpactions-os": self.cpactions_os,
  257. "cpactions-version": self.cpactions_version,
  258. "cpactions-arch": self.cpactions_arch,
  259. "cpactions-setup-cmd": self.cpactions_setup_cmd,
  260. "cpactions-install-cmd": self.cpactions_install_cmd,
  261. "setup-vita-gles-type": self.setup_vita_gles_type,
  262. "setup-gdk-folder": self.setup_gdk_folder,
  263. "check-sources": self.check_sources,
  264. "setup-python": self.setup_python,
  265. "pypi-packages": my_shlex_join(self.pypi_packages),
  266. }
  267. return {k: v for k, v in data.items() if v != ""}
  268. def my_shlex_join(s):
  269. def escape(s):
  270. if s[:1] == "'" and s[-1:] == "'":
  271. return s
  272. if set(s).intersection(set("; \t")):
  273. return f'"{s}"'
  274. return s
  275. return " ".join(escape(s))
  276. def spec_to_job(spec: JobSpec, key: str, trackmem_symbol_names: bool) -> JobDetails:
  277. job = JobDetails(
  278. name=spec.name,
  279. key=key,
  280. os=spec.os.value,
  281. artifact=spec.artifact or "",
  282. container=spec.container or "",
  283. platform=spec.platform.value,
  284. sudo="sudo",
  285. no_cmake=spec.no_cmake,
  286. )
  287. if job.os.startswith("ubuntu"):
  288. job.apt_packages.extend([
  289. "ninja-build",
  290. "pkg-config",
  291. ])
  292. pretest_cmd = []
  293. if trackmem_symbol_names:
  294. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=1")
  295. else:
  296. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=0")
  297. win32 = spec.platform in (SdlPlatform.Msys2, SdlPlatform.Msvc)
  298. fpic = None
  299. build_parallel = True
  300. if spec.lean:
  301. job.cppflags.append("-DSDL_LEAN_AND_MEAN=1")
  302. if win32:
  303. job.cmake_arguments.append("-DSDLTEST_PROCDUMP=ON")
  304. job.minidump = True
  305. if spec.intel is not None:
  306. match spec.intel:
  307. case IntelCompiler.Icx:
  308. job.cc = "icx"
  309. job.cxx = "icpx"
  310. case IntelCompiler.Icc:
  311. job.cc = "icc"
  312. job.cxx = "icpc"
  313. # Disable deprecation warning
  314. job.cppflags.append("-diag-disable=10441")
  315. # Avoid 'Catastrophic error: cannot open precompiled header file'
  316. job.cmake_arguments.append("-DCMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON")
  317. job.clang_tidy = False
  318. case _:
  319. raise ValueError(f"Invalid intel={spec.intel}")
  320. job.source_cmd = f"source /opt/intel/oneapi/setvars.sh;"
  321. job.intel = True
  322. job.shell = "bash"
  323. job.cmake_arguments.extend((
  324. f"-DCMAKE_C_COMPILER={job.cc}",
  325. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  326. "-DCMAKE_SYSTEM_NAME=Linux",
  327. ))
  328. match spec.platform:
  329. case SdlPlatform.Msvc:
  330. job.setup_ninja = not spec.gdk
  331. job.clang_tidy = False # complains about \threadsafety: "unknown command tag name [clang-diagnostic-documentation-unknown-command]"
  332. job.msvc_project = spec.msvc_project if spec.msvc_project else ""
  333. job.msvc_project_flags.append("-p:TreatWarningsAsError=true")
  334. job.test_pkg_config = False
  335. job.shared_lib = SharedLibType.WIN32
  336. job.static_lib = StaticLibType.MSVC
  337. job.cmake_arguments.extend((
  338. "-DCMAKE_MSVC_DEBUG_INFORMATION_FORMAT=ProgramDatabase",
  339. "-DCMAKE_EXE_LINKER_FLAGS=-DEBUG",
  340. "-DCMAKE_SHARED_LINKER_FLAGS=-DEBUG",
  341. ))
  342. job.cmake_arguments.append("'-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded$<$<CONFIG:Debug>:Debug>'")
  343. if spec.clang_cl:
  344. job.cmake_arguments.extend((
  345. "-DCMAKE_C_COMPILER=clang-cl",
  346. "-DCMAKE_CXX_COMPILER=clang-cl",
  347. ))
  348. match spec.msvc_arch:
  349. case MsvcArch.X86:
  350. job.cflags.append("/clang:-m32")
  351. job.ldflags.append("/MACHINE:X86")
  352. case MsvcArch.X64:
  353. job.cflags.append("/clang:-m64")
  354. job.ldflags.append("/MACHINE:X64")
  355. case _:
  356. raise ValueError(f"Unsupported clang-cl architecture (arch={spec.msvc_arch})")
  357. if spec.msvc_project:
  358. match spec.msvc_arch:
  359. case MsvcArch.X86:
  360. msvc_platform = "Win32"
  361. case MsvcArch.X64:
  362. msvc_platform = "x64"
  363. case _:
  364. raise ValueError(f"Unsupported vcxproj architecture (arch={spec.msvc_arch})")
  365. if spec.gdk:
  366. msvc_platform = f"Gaming.Desktop.{msvc_platform}"
  367. job.msvc_project_flags.append(f"-p:Platform={msvc_platform}")
  368. match spec.msvc_arch:
  369. case MsvcArch.X86:
  370. job.msvc_vcvars_arch = "x64_x86"
  371. case MsvcArch.X64:
  372. job.msvc_vcvars_arch = "x64"
  373. case MsvcArch.Arm32:
  374. job.msvc_vcvars_arch = "x64_arm"
  375. job.msvc_vcvars_sdk = "10.0.22621.0" # 10.0.26100.0 dropped ARM32 um and ucrt libraries
  376. job.run_tests = False
  377. case MsvcArch.Arm64:
  378. job.msvc_vcvars_arch = "x64_arm64"
  379. job.run_tests = False
  380. if spec.gdk:
  381. job.setup_gdk_folder = "VisualC-GDK"
  382. else:
  383. match spec.msvc_arch:
  384. case MsvcArch.X86:
  385. job.setup_libusb_arch = "x86"
  386. case MsvcArch.X64:
  387. job.setup_libusb_arch = "x64"
  388. case SdlPlatform.Linux:
  389. if spec.name.startswith("Ubuntu"):
  390. assert spec.os.value.startswith("ubuntu-")
  391. job.apt_packages.extend((
  392. "ccache",
  393. "gnome-desktop-testing",
  394. "libasound2-dev",
  395. "libpulse-dev",
  396. "libaudio-dev",
  397. "libjack-dev",
  398. "libsndio-dev",
  399. "libusb-1.0-0-dev",
  400. "libx11-dev",
  401. "libxext-dev",
  402. "libxrandr-dev",
  403. "libxcursor-dev",
  404. "libxfixes-dev",
  405. "libxi-dev",
  406. "libxss-dev",
  407. "libwayland-dev",
  408. "libxkbcommon-dev",
  409. "libdrm-dev",
  410. "libgbm-dev",
  411. "libgl1-mesa-dev",
  412. "libgles2-mesa-dev",
  413. "libegl1-mesa-dev",
  414. "libdbus-1-dev",
  415. "libibus-1.0-dev",
  416. "libudev-dev",
  417. "fcitx-libs-dev",
  418. ))
  419. match = re.match(r"ubuntu-(?P<year>[0-9]+)\.(?P<month>[0-9]+).*", spec.os.value)
  420. ubuntu_year, ubuntu_month = [int(match["year"]), int(match["month"])]
  421. if ubuntu_year >= 22:
  422. job.apt_packages.extend(("libpipewire-0.3-dev", "libdecor-0-dev"))
  423. job.apt_packages.extend((
  424. "libunwind-dev", # For SDL_test memory tracking
  425. ))
  426. job.ccache = True
  427. if trackmem_symbol_names:
  428. # older libunwind is slow
  429. job.cmake_arguments.append("-DSDLTEST_TIMEOUT_MULTIPLIER=2")
  430. job.shared_lib = SharedLibType.SO_0
  431. job.static_lib = StaticLibType.A
  432. fpic = True
  433. case SdlPlatform.Ios | SdlPlatform.Tvos:
  434. job.brew_packages.extend([
  435. "ccache",
  436. "ninja",
  437. ])
  438. job.ccache = True
  439. job.clang_tidy = False
  440. job.run_tests = False
  441. job.test_pkg_config = False
  442. job.shared_lib = SharedLibType.DYLIB
  443. job.static_lib = StaticLibType.A
  444. match spec.platform:
  445. case SdlPlatform.Ios:
  446. if spec.xcode:
  447. job.xcode_sdk = 'iphoneos'
  448. job.cmake_arguments.extend([
  449. "-DCMAKE_SYSTEM_NAME=iOS",
  450. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  451. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  452. ])
  453. case SdlPlatform.Tvos:
  454. if spec.xcode:
  455. job.xcode_sdk = 'appletvos'
  456. job.cmake_arguments.extend([
  457. "-DCMAKE_SYSTEM_NAME=tvOS",
  458. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  459. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  460. ])
  461. case SdlPlatform.MacOS:
  462. if spec.apple_framework:
  463. job.static = False
  464. job.clang_tidy = False
  465. job.test_pkg_config = False
  466. job.cmake_arguments.extend((
  467. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  468. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  469. "-DSDL_FRAMEWORK=ON",
  470. ))
  471. job.shared_lib = SharedLibType.FRAMEWORK
  472. else:
  473. job.clang_tidy = True
  474. job.cmake_arguments.extend((
  475. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  476. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  477. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  478. ))
  479. job.shared_lib = SharedLibType.DYLIB
  480. job.static_lib = StaticLibType.A
  481. job.ccache = True
  482. job.apt_packages = []
  483. job.brew_packages.extend((
  484. "ccache",
  485. "ninja",
  486. ))
  487. if job.clang_tidy:
  488. job.brew_packages.append("llvm")
  489. if spec.xcode:
  490. job.xcode_sdk = "macosx"
  491. case SdlPlatform.Android:
  492. job.android_gradle = spec.android_gradle
  493. job.android_mk = spec.android_mk
  494. job.apt_packages.append("ccache")
  495. job.run_tests = False
  496. job.shared_lib = SharedLibType.SO
  497. job.static_lib = StaticLibType.A
  498. if spec.android_mk or not spec.no_cmake:
  499. job.android_ndk = True
  500. if spec.android_gradle or not spec.no_cmake:
  501. job.java = True
  502. if spec.android_mk or spec.android_gradle:
  503. job.apt_packages = []
  504. if not spec.no_cmake:
  505. job.ccache = True
  506. job.cmake_arguments.extend((
  507. f"-DANDROID_PLATFORM={spec.android_platform}",
  508. f"-DANDROID_ABI={spec.android_abi}",
  509. ))
  510. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  511. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  512. job.android_apks = [
  513. "testaudiorecording-apk",
  514. "testautomation-apk",
  515. "testcontroller-apk",
  516. "testmultiaudio-apk",
  517. "testsprite-apk",
  518. ]
  519. case SdlPlatform.Emscripten:
  520. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  521. job.shared = False
  522. job.ccache = True
  523. job.apt_packages.append("ccache")
  524. job.cmake_config_emulator = "emcmake"
  525. job.cmake_build_type = "Debug"
  526. job.test_pkg_config = False
  527. job.cmake_arguments.extend((
  528. "-DSDLTEST_BROWSER=chrome",
  529. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  530. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  531. ))
  532. job.cflags.extend((
  533. "-gsource-map",
  534. "-ffile-prefix-map=${PWD}=/SDL",
  535. ))
  536. job.ldflags.extend((
  537. "--source-map-base", "/",
  538. ))
  539. pretest_cmd.extend((
  540. "# Start local HTTP server",
  541. "cmake --build build --target serve-sdl-tests --verbose &",
  542. "chrome --version",
  543. "chromedriver --version",
  544. ))
  545. job.static_lib = StaticLibType.A
  546. job.setup_python = True
  547. job.pypi_packages.append("selenium")
  548. case SdlPlatform.Ps2:
  549. job.ccache = False # actions/ccache does not work in psp container (incompatible tar of busybox)
  550. build_parallel = False
  551. job.shared = False
  552. job.sudo = ""
  553. job.apt_packages = []
  554. job.apk_packages = ["ccache", "cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  555. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  556. job.clang_tidy = False
  557. job.run_tests = False
  558. job.shared = False
  559. job.cc = "mips64r5900el-ps2-elf-gcc"
  560. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  561. job.static_lib = StaticLibType.A
  562. case SdlPlatform.Psp:
  563. job.ccache = False # actions/ccache does not work in psp container (incompatible tar of busybox)
  564. build_parallel = False
  565. job.sudo = ""
  566. job.apt_packages = []
  567. job.apk_packages = ["ccache", "cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  568. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  569. job.clang_tidy = False
  570. job.run_tests = False
  571. job.shared = False
  572. job.cc = "psp-gcc"
  573. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  574. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  575. job.static_lib = StaticLibType.A
  576. case SdlPlatform.Vita:
  577. job.ccache = True
  578. job.sudo = ""
  579. job.apt_packages = []
  580. job.apk_packages = ["ccache", "cmake", "ninja", "pkgconf", "bash", "tar"]
  581. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  582. assert spec.vita_gles is not None
  583. job.setup_vita_gles_type = {
  584. VitaGLES.Pib: "pib",
  585. VitaGLES.Pvr: "pvr",
  586. }[spec.vita_gles]
  587. job.cmake_arguments.extend((
  588. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  589. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  590. "-DSDL_ARMNEON=ON",
  591. "-DSDL_ARMSIMD=ON",
  592. ))
  593. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  594. job.source_cmd = r"""sed -i -E "s#set\\( PKG_CONFIG_EXECUTABLE \"\\$\\{VITASDK}/bin/arm-vita-eabi-pkg-config\" \\)#set\\( PKG_CONFIG_EXECUTABLE \"${VITASDK}/bin/arm-vita-eabi-pkg-config\" CACHE PATH \"Path of pkg-config executable\" \\)#" ${VITASDK}/share/vita.toolchain.cmake"""
  595. job.clang_tidy = False
  596. job.run_tests = False
  597. job.shared = False
  598. job.cc = "arm-vita-eabi-gcc"
  599. job.static_lib = StaticLibType.A
  600. case SdlPlatform.Haiku:
  601. job.ccache = True
  602. fpic = False
  603. job.run_tests = False
  604. job.apt_packages.append("ccache")
  605. job.cc = "x86_64-unknown-haiku-gcc"
  606. job.cxx = "x86_64-unknown-haiku-g++"
  607. job.sudo = ""
  608. job.cmake_arguments.extend((
  609. f"-DCMAKE_C_COMPILER={job.cc}",
  610. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  611. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  612. ))
  613. job.shared_lib = SharedLibType.SO_0
  614. job.static_lib = StaticLibType.A
  615. case SdlPlatform.PowerPC64 | SdlPlatform.PowerPC:
  616. job.ccache = True
  617. # FIXME: Enable SDL_WERROR
  618. job.werror = False
  619. job.clang_tidy = False
  620. job.run_tests = False
  621. job.sudo = ""
  622. job.apt_packages = ["ccache"]
  623. job.shared_lib = SharedLibType.SO_0
  624. job.static_lib = StaticLibType.A
  625. job.cmake_arguments.extend((
  626. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  627. ))
  628. case SdlPlatform.LoongArch64:
  629. job.ccache = True
  630. fpic = True
  631. job.run_tests = False
  632. job.apt_packages.append("ccache")
  633. job.cc = "${LOONGARCH64_CC}"
  634. job.cxx = "${LOONGARCH64_CXX}"
  635. job.cmake_arguments.extend((
  636. f"-DCMAKE_C_COMPILER={job.cc}",
  637. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  638. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  639. "-DCMAKE_SYSTEM_NAME=Linux",
  640. ))
  641. job.shared_lib = SharedLibType.SO_0
  642. job.static_lib = StaticLibType.A
  643. case SdlPlatform.N3ds:
  644. job.ccache = True
  645. job.shared = False
  646. job.apt_packages = ["ccache", "ninja-build", "binutils"]
  647. job.clang_tidy = False
  648. job.run_tests = False
  649. job.cc_from_cmake = True
  650. job.cmake_toolchain_file = "${DEVKITPRO}/cmake/3DS.cmake"
  651. job.static_lib = StaticLibType.A
  652. case SdlPlatform.Msys2:
  653. job.ccache = True
  654. job.shell = "msys2 {0}"
  655. assert spec.msys2_platform
  656. job.msys2_msystem = spec.msys2_platform.value
  657. job.msys2_env = {
  658. "mingw32": "mingw-w64-i686",
  659. "mingw64": "mingw-w64-x86_64",
  660. "clang64": "mingw-w64-clang-x86_64",
  661. "ucrt64": "mingw-w64-ucrt-x86_64",
  662. }[spec.msys2_platform.value]
  663. job.msys2_no_perl = spec.msys2_platform in (Msys2Platform.Mingw32, )
  664. job.shared_lib = SharedLibType.WIN32
  665. job.static_lib = StaticLibType.A
  666. case SdlPlatform.Riscos:
  667. job.ccache = False # FIXME: enable when container gets upgrade
  668. # FIXME: Enable SDL_WERROR
  669. job.werror = False
  670. job.apt_packages = ["ccache", "cmake", "ninja-build"]
  671. job.test_pkg_config = False
  672. job.shared = False
  673. job.run_tests = False
  674. job.sudo = ""
  675. job.cmake_arguments.extend((
  676. "-DRISCOS:BOOL=ON",
  677. "-DCMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON",
  678. "-DSDL_GCC_ATOMICS:BOOL=OFF",
  679. ))
  680. job.cmake_toolchain_file = "/home/riscos/env/toolchain-riscos.cmake"
  681. job.static_lib = StaticLibType.A
  682. case SdlPlatform.FreeBSD | SdlPlatform.NetBSD:
  683. job.cpactions = True
  684. job.no_cmake = True
  685. job.run_tests = False
  686. job.apt_packages = []
  687. job.shared_lib = SharedLibType.SO_0
  688. job.static_lib = StaticLibType.A
  689. match spec.platform:
  690. case SdlPlatform.FreeBSD:
  691. job.cpactions_os = "freebsd"
  692. job.cpactions_version = "14.2"
  693. job.cpactions_arch = "x86-64"
  694. job.cpactions_setup_cmd = "sudo pkg update"
  695. job.cpactions_install_cmd = "sudo pkg install -y cmake ninja pkgconf libXcursor libXext libXinerama libXi libXfixes libXrandr libXScrnSaver libXxf86vm wayland wayland-protocols libxkbcommon mesa-libs libglvnd evdev-proto libinotify alsa-lib jackit pipewire pulseaudio sndio dbus zh-fcitx ibus libudev-devd"
  696. job.cmake_arguments.extend((
  697. "-DSDL_CHECK_REQUIRED_INCLUDES=/usr/local/include",
  698. "-DSDL_CHECK_REQUIRED_LINK_OPTIONS=-L/usr/local/lib",
  699. ))
  700. case SdlPlatform.NetBSD:
  701. job.cpactions_os = "netbsd"
  702. job.cpactions_version = "10.1"
  703. job.cpactions_arch = "x86-64"
  704. job.cpactions_setup_cmd = "export PATH=\"/usr/pkg/sbin:/usr/pkg/bin:/sbin:$PATH\"; export PKG_CONFIG_PATH=\"/usr/pkg/lib/pkgconfig\";export PKG_PATH=\"https://cdn.netBSD.org/pub/pkgsrc/packages/NetBSD/$(uname -p)/$(uname -r|cut -f \"1 2\" -d.)/All/\";echo \"PKG_PATH=$PKG_PATH\";echo \"uname -a -> \"$(uname -a)\"\";sudo -E sysctl -w security.pax.aslr.enabled=0;sudo -E sysctl -w security.pax.aslr.global=0;sudo -E pkgin clean;sudo -E pkgin update"
  705. job.cpactions_install_cmd = "sudo -E pkgin -y install cmake dbus pkgconf ninja-build pulseaudio libxkbcommon wayland wayland-protocols libinotify libusb1"
  706. case _:
  707. raise ValueError(f"Unsupported platform={spec.platform}")
  708. if "ubuntu" in spec.name.lower():
  709. job.check_sources = True
  710. job.setup_python = True
  711. if job.ccache:
  712. job.cmake_arguments.extend((
  713. "-DCMAKE_C_COMPILER_LAUNCHER=ccache",
  714. "-DCMAKE_CXX_COMPILER_LAUNCHER=ccache",
  715. ))
  716. if not build_parallel:
  717. job.cmake_build_arguments.append("-j1")
  718. if job.cflags or job.cppflags:
  719. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags + job.cppflags)}\"")
  720. if job.cxxflags or job.cppflags:
  721. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags + job.cppflags)}\"")
  722. if job.ldflags:
  723. job.cmake_arguments.append(f"-DCMAKE_SHARED_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  724. job.cmake_arguments.append(f"-DCMAKE_EXE_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  725. job.pretest_cmd = "\n".join(pretest_cmd)
  726. def tf(b):
  727. return "ON" if b else "OFF"
  728. if fpic is not None:
  729. job.cmake_arguments.append(f"-DCMAKE_POSITION_INDEPENDENT_CODE={tf(fpic)}")
  730. if job.no_cmake:
  731. job.cmake_arguments = []
  732. return job
  733. def spec_to_platform(spec: JobSpec, key: str, enable_artifacts: bool, trackmem_symbol_names: bool) -> dict[str, str|bool]:
  734. logger.info("spec=%r", spec)
  735. job = spec_to_job(spec, key=key, trackmem_symbol_names=trackmem_symbol_names)
  736. logger.info("job=%r", job)
  737. platform = job.to_workflow(enable_artifacts=enable_artifacts)
  738. logger.info("platform=%r", platform)
  739. return platform
  740. def main():
  741. parser = argparse.ArgumentParser(allow_abbrev=False)
  742. parser.add_argument("--github-variable-prefix", default="platforms")
  743. parser.add_argument("--github-ci", action="store_true")
  744. parser.add_argument("--verbose", action="store_true")
  745. parser.add_argument("--commit-message-file")
  746. parser.add_argument("--no-artifact", dest="enable_artifacts", action="store_false")
  747. parser.add_argument("--trackmem-symbol-names", dest="trackmem_symbol_names", action="store_true")
  748. args = parser.parse_args()
  749. logging.basicConfig(level=logging.INFO if args.verbose else logging.WARNING)
  750. remaining_keys = set(JOB_SPECS.keys())
  751. all_level_keys = (
  752. # Level 1
  753. (
  754. "haiku",
  755. ),
  756. )
  757. filters = []
  758. if args.commit_message_file:
  759. with open(args.commit_message_file, "r") as f:
  760. commit_message = f.read()
  761. for m in re.finditer(r"\[sdl-ci-filter (.*)]", commit_message, flags=re.M):
  762. filters.append(m.group(1).strip(" \t\n\r\t'\""))
  763. if re.search(r"\[sdl-ci-artifacts?]", commit_message, flags=re.M):
  764. args.enable_artifacts = True
  765. if re.search(r"\[sdl-ci-(full-)?trackmem(-symbol-names)?]", commit_message, flags=re.M):
  766. args.trackmem_symbol_names = True
  767. if not filters:
  768. filters.append("*")
  769. logger.info("filters: %r", filters)
  770. all_level_platforms = {}
  771. all_platforms = {key: spec_to_platform(spec, key=key, enable_artifacts=args.enable_artifacts, trackmem_symbol_names=args.trackmem_symbol_names) for key, spec in JOB_SPECS.items()}
  772. for level_i, level_keys in enumerate(all_level_keys, 1):
  773. level_key = f"level{level_i}"
  774. logger.info("Level %d: keys=%r", level_i, level_keys)
  775. assert all(k in remaining_keys for k in level_keys)
  776. level_platforms = tuple(all_platforms[key] for key in level_keys)
  777. remaining_keys.difference_update(level_keys)
  778. all_level_platforms[level_key] = level_platforms
  779. logger.info("=" * 80)
  780. logger.info("Keys before filter: %r", remaining_keys)
  781. filtered_remaining_keys = set()
  782. for filter in filters:
  783. filtered_remaining_keys.update(fnmatch.filter(remaining_keys, filter))
  784. logger.info("Keys after filter: %r", filtered_remaining_keys)
  785. remaining_keys = filtered_remaining_keys
  786. logger.info("Remaining: %r", remaining_keys)
  787. all_level_platforms["others"] = tuple(all_platforms[key] for key in remaining_keys)
  788. if args.github_ci:
  789. for level, platforms in all_level_platforms.items():
  790. platforms_json = json.dumps(platforms)
  791. txt = f"{args.github_variable_prefix}-{level}={platforms_json}"
  792. logger.info("%s", txt)
  793. if "GITHUB_OUTPUT" in os.environ:
  794. with open(os.environ["GITHUB_OUTPUT"], "a") as f:
  795. f.write(txt)
  796. f.write("\n")
  797. else:
  798. logger.warning("GITHUB_OUTPUT not defined")
  799. return 0
  800. if __name__ == "__main__":
  801. raise SystemExit(main())