create-test-plan.py 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  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.cxxflags.append("/clang:-m32")
  352. job.ldflags.append("/MACHINE:X86")
  353. case MsvcArch.X64:
  354. job.cflags.append("/clang:-m64")
  355. job.cxxflags.append("/clang:-m64")
  356. job.ldflags.append("/MACHINE:X64")
  357. case _:
  358. raise ValueError(f"Unsupported clang-cl architecture (arch={spec.msvc_arch})")
  359. if spec.msvc_project:
  360. match spec.msvc_arch:
  361. case MsvcArch.X86:
  362. msvc_platform = "Win32"
  363. case MsvcArch.X64:
  364. msvc_platform = "x64"
  365. case _:
  366. raise ValueError(f"Unsupported vcxproj architecture (arch={spec.msvc_arch})")
  367. if spec.gdk:
  368. msvc_platform = f"Gaming.Desktop.{msvc_platform}"
  369. job.msvc_project_flags.append(f"-p:Platform={msvc_platform}")
  370. match spec.msvc_arch:
  371. case MsvcArch.X86:
  372. job.msvc_vcvars_arch = "x64_x86"
  373. case MsvcArch.X64:
  374. job.msvc_vcvars_arch = "x64"
  375. case MsvcArch.Arm32:
  376. job.msvc_vcvars_arch = "x64_arm"
  377. job.msvc_vcvars_sdk = "10.0.22621.0" # 10.0.26100.0 dropped ARM32 um and ucrt libraries
  378. job.run_tests = False
  379. case MsvcArch.Arm64:
  380. job.msvc_vcvars_arch = "x64_arm64"
  381. job.run_tests = False
  382. if spec.gdk:
  383. job.setup_gdk_folder = "VisualC-GDK"
  384. else:
  385. match spec.msvc_arch:
  386. case MsvcArch.X86:
  387. job.setup_libusb_arch = "x86"
  388. case MsvcArch.X64:
  389. job.setup_libusb_arch = "x64"
  390. case SdlPlatform.Linux:
  391. if spec.name.startswith("Ubuntu"):
  392. assert spec.os.value.startswith("ubuntu-")
  393. job.apt_packages.extend((
  394. "ccache",
  395. "gnome-desktop-testing",
  396. "libasound2-dev",
  397. "libpulse-dev",
  398. "libaudio-dev",
  399. "libjack-dev",
  400. "libsndio-dev",
  401. "libusb-1.0-0-dev",
  402. "libx11-dev",
  403. "libxext-dev",
  404. "libxrandr-dev",
  405. "libxcursor-dev",
  406. "libxfixes-dev",
  407. "libxi-dev",
  408. "libxss-dev",
  409. "libwayland-dev",
  410. "libxkbcommon-dev",
  411. "libdrm-dev",
  412. "libgbm-dev",
  413. "libgl1-mesa-dev",
  414. "libgles2-mesa-dev",
  415. "libegl1-mesa-dev",
  416. "libdbus-1-dev",
  417. "libibus-1.0-dev",
  418. "libudev-dev",
  419. "fcitx-libs-dev",
  420. ))
  421. match = re.match(r"ubuntu-(?P<year>[0-9]+)\.(?P<month>[0-9]+).*", spec.os.value)
  422. ubuntu_year, ubuntu_month = [int(match["year"]), int(match["month"])]
  423. if ubuntu_year >= 22:
  424. job.apt_packages.extend(("libpipewire-0.3-dev", "libdecor-0-dev"))
  425. job.apt_packages.extend((
  426. "libunwind-dev", # For SDL_test memory tracking
  427. ))
  428. job.ccache = True
  429. if trackmem_symbol_names:
  430. # older libunwind is slow
  431. job.cmake_arguments.append("-DSDLTEST_TIMEOUT_MULTIPLIER=2")
  432. job.shared_lib = SharedLibType.SO_0
  433. job.static_lib = StaticLibType.A
  434. fpic = True
  435. case SdlPlatform.Ios | SdlPlatform.Tvos:
  436. job.brew_packages.extend([
  437. "ccache",
  438. "ninja",
  439. ])
  440. job.ccache = True
  441. job.clang_tidy = False
  442. job.run_tests = False
  443. job.test_pkg_config = False
  444. job.shared_lib = SharedLibType.DYLIB
  445. job.static_lib = StaticLibType.A
  446. match spec.platform:
  447. case SdlPlatform.Ios:
  448. if spec.xcode:
  449. job.xcode_sdk = 'iphoneos'
  450. job.cmake_arguments.extend([
  451. "-DCMAKE_SYSTEM_NAME=iOS",
  452. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  453. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  454. ])
  455. case SdlPlatform.Tvos:
  456. if spec.xcode:
  457. job.xcode_sdk = 'appletvos'
  458. job.cmake_arguments.extend([
  459. "-DCMAKE_SYSTEM_NAME=tvOS",
  460. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  461. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  462. ])
  463. case SdlPlatform.MacOS:
  464. if spec.apple_framework:
  465. job.static = False
  466. job.clang_tidy = False
  467. job.test_pkg_config = False
  468. job.cmake_arguments.extend((
  469. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  470. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  471. "-DSDL_FRAMEWORK=ON",
  472. ))
  473. job.shared_lib = SharedLibType.FRAMEWORK
  474. else:
  475. job.clang_tidy = True
  476. job.cmake_arguments.extend((
  477. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  478. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  479. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  480. ))
  481. job.shared_lib = SharedLibType.DYLIB
  482. job.static_lib = StaticLibType.A
  483. job.ccache = True
  484. job.apt_packages = []
  485. job.brew_packages.extend((
  486. "ccache",
  487. "ninja",
  488. ))
  489. if job.clang_tidy:
  490. job.brew_packages.append("llvm")
  491. if spec.xcode:
  492. job.xcode_sdk = "macosx"
  493. case SdlPlatform.Android:
  494. job.android_gradle = spec.android_gradle
  495. job.android_mk = spec.android_mk
  496. job.apt_packages.append("ccache")
  497. job.run_tests = False
  498. job.shared_lib = SharedLibType.SO
  499. job.static_lib = StaticLibType.A
  500. if spec.android_mk or not spec.no_cmake:
  501. job.android_ndk = True
  502. if spec.android_gradle or not spec.no_cmake:
  503. job.java = True
  504. if spec.android_mk or spec.android_gradle:
  505. job.apt_packages = []
  506. if not spec.no_cmake:
  507. job.ccache = True
  508. job.cmake_arguments.extend((
  509. f"-DANDROID_PLATFORM={spec.android_platform}",
  510. f"-DANDROID_ABI={spec.android_abi}",
  511. ))
  512. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  513. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  514. job.android_apks = [
  515. "testaudiorecording-apk",
  516. "testautomation-apk",
  517. "testcontroller-apk",
  518. "testmultiaudio-apk",
  519. "testsprite-apk",
  520. ]
  521. case SdlPlatform.Emscripten:
  522. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  523. job.shared = False
  524. job.ccache = True
  525. job.apt_packages.append("ccache")
  526. job.cmake_config_emulator = "emcmake"
  527. job.cmake_build_type = "Debug"
  528. job.test_pkg_config = False
  529. job.cmake_arguments.extend((
  530. "-DSDLTEST_BROWSER=chrome",
  531. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  532. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  533. ))
  534. job.cflags.extend((
  535. "-gsource-map",
  536. "-ffile-prefix-map=${PWD}=/SDL",
  537. ))
  538. job.ldflags.extend((
  539. "--source-map-base", "/",
  540. ))
  541. pretest_cmd.extend((
  542. "# Start local HTTP server",
  543. "cmake --build build --target serve-sdl-tests --verbose &",
  544. "chrome --version",
  545. "chromedriver --version",
  546. ))
  547. job.static_lib = StaticLibType.A
  548. job.setup_python = True
  549. job.pypi_packages.append("selenium")
  550. case SdlPlatform.Ps2:
  551. job.ccache = False # actions/ccache does not work in psp container (incompatible tar of busybox)
  552. build_parallel = False
  553. job.shared = False
  554. job.sudo = ""
  555. job.apt_packages = []
  556. job.apk_packages = ["ccache", "cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  557. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  558. job.clang_tidy = False
  559. job.run_tests = False
  560. job.shared = False
  561. job.cc = "mips64r5900el-ps2-elf-gcc"
  562. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  563. job.static_lib = StaticLibType.A
  564. case SdlPlatform.Psp:
  565. job.ccache = False # actions/ccache does not work in psp container (incompatible tar of busybox)
  566. build_parallel = False
  567. job.sudo = ""
  568. job.apt_packages = []
  569. job.apk_packages = ["ccache", "cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  570. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  571. job.clang_tidy = False
  572. job.run_tests = False
  573. job.shared = False
  574. job.cc = "psp-gcc"
  575. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  576. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  577. job.static_lib = StaticLibType.A
  578. case SdlPlatform.Vita:
  579. job.ccache = True
  580. job.sudo = ""
  581. job.apt_packages = []
  582. job.apk_packages = ["ccache", "cmake", "ninja", "pkgconf", "bash", "tar"]
  583. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  584. assert spec.vita_gles is not None
  585. job.setup_vita_gles_type = {
  586. VitaGLES.Pib: "pib",
  587. VitaGLES.Pvr: "pvr",
  588. }[spec.vita_gles]
  589. job.cmake_arguments.extend((
  590. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  591. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  592. "-DSDL_ARMNEON=ON",
  593. "-DSDL_ARMSIMD=ON",
  594. ))
  595. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  596. 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"""
  597. job.clang_tidy = False
  598. job.run_tests = False
  599. job.shared = False
  600. job.cc = "arm-vita-eabi-gcc"
  601. job.static_lib = StaticLibType.A
  602. case SdlPlatform.Haiku:
  603. job.ccache = True
  604. fpic = False
  605. job.run_tests = False
  606. job.apt_packages.append("ccache")
  607. job.cc = "x86_64-unknown-haiku-gcc"
  608. job.cxx = "x86_64-unknown-haiku-g++"
  609. job.sudo = ""
  610. job.cmake_arguments.extend((
  611. f"-DCMAKE_C_COMPILER={job.cc}",
  612. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  613. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  614. ))
  615. job.shared_lib = SharedLibType.SO_0
  616. job.static_lib = StaticLibType.A
  617. case SdlPlatform.PowerPC64 | SdlPlatform.PowerPC:
  618. job.ccache = True
  619. # FIXME: Enable SDL_WERROR
  620. job.werror = False
  621. job.clang_tidy = False
  622. job.run_tests = False
  623. job.sudo = ""
  624. job.apt_packages = ["ccache"]
  625. job.shared_lib = SharedLibType.SO_0
  626. job.static_lib = StaticLibType.A
  627. job.cmake_arguments.extend((
  628. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  629. ))
  630. case SdlPlatform.LoongArch64:
  631. job.ccache = True
  632. fpic = True
  633. job.run_tests = False
  634. job.apt_packages.append("ccache")
  635. job.cc = "${LOONGARCH64_CC}"
  636. job.cxx = "${LOONGARCH64_CXX}"
  637. job.cmake_arguments.extend((
  638. f"-DCMAKE_C_COMPILER={job.cc}",
  639. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  640. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  641. "-DCMAKE_SYSTEM_NAME=Linux",
  642. ))
  643. job.shared_lib = SharedLibType.SO_0
  644. job.static_lib = StaticLibType.A
  645. case SdlPlatform.N3ds:
  646. job.ccache = True
  647. job.shared = False
  648. job.apt_packages = ["ccache", "ninja-build", "binutils"]
  649. job.clang_tidy = False
  650. job.run_tests = False
  651. job.cc_from_cmake = True
  652. job.cmake_toolchain_file = "${DEVKITPRO}/cmake/3DS.cmake"
  653. job.static_lib = StaticLibType.A
  654. case SdlPlatform.Msys2:
  655. job.ccache = True
  656. job.shell = "msys2 {0}"
  657. assert spec.msys2_platform
  658. job.msys2_msystem = spec.msys2_platform.value
  659. job.msys2_env = {
  660. "mingw32": "mingw-w64-i686",
  661. "mingw64": "mingw-w64-x86_64",
  662. "clang64": "mingw-w64-clang-x86_64",
  663. "ucrt64": "mingw-w64-ucrt-x86_64",
  664. }[spec.msys2_platform.value]
  665. job.msys2_no_perl = spec.msys2_platform in (Msys2Platform.Mingw32, )
  666. job.shared_lib = SharedLibType.WIN32
  667. job.static_lib = StaticLibType.A
  668. case SdlPlatform.Riscos:
  669. job.ccache = False # FIXME: enable when container gets upgrade
  670. # FIXME: Enable SDL_WERROR
  671. job.werror = False
  672. job.apt_packages = ["ccache", "cmake", "ninja-build"]
  673. job.test_pkg_config = False
  674. job.shared = False
  675. job.run_tests = False
  676. job.sudo = ""
  677. job.cmake_arguments.extend((
  678. "-DRISCOS:BOOL=ON",
  679. "-DCMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON",
  680. "-DSDL_GCC_ATOMICS:BOOL=OFF",
  681. ))
  682. job.cmake_toolchain_file = "/home/riscos/env/toolchain-riscos.cmake"
  683. job.static_lib = StaticLibType.A
  684. case SdlPlatform.FreeBSD | SdlPlatform.NetBSD:
  685. job.cpactions = True
  686. job.no_cmake = True
  687. job.run_tests = False
  688. job.apt_packages = []
  689. job.shared_lib = SharedLibType.SO_0
  690. job.static_lib = StaticLibType.A
  691. match spec.platform:
  692. case SdlPlatform.FreeBSD:
  693. job.cpactions_os = "freebsd"
  694. job.cpactions_version = "14.2"
  695. job.cpactions_arch = "x86-64"
  696. job.cpactions_setup_cmd = "sudo pkg update"
  697. 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"
  698. job.cmake_arguments.extend((
  699. "-DSDL_CHECK_REQUIRED_INCLUDES=/usr/local/include",
  700. "-DSDL_CHECK_REQUIRED_LINK_OPTIONS=-L/usr/local/lib",
  701. ))
  702. case SdlPlatform.NetBSD:
  703. job.cpactions_os = "netbsd"
  704. job.cpactions_version = "10.1"
  705. job.cpactions_arch = "x86-64"
  706. 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"
  707. job.cpactions_install_cmd = "sudo -E pkgin -y install cmake dbus pkgconf ninja-build pulseaudio libxkbcommon wayland wayland-protocols libinotify libusb1"
  708. case _:
  709. raise ValueError(f"Unsupported platform={spec.platform}")
  710. if "ubuntu" in spec.name.lower():
  711. job.check_sources = True
  712. job.setup_python = True
  713. if job.ccache:
  714. job.cmake_arguments.extend((
  715. "-DCMAKE_C_COMPILER_LAUNCHER=ccache",
  716. "-DCMAKE_CXX_COMPILER_LAUNCHER=ccache",
  717. ))
  718. if not build_parallel:
  719. job.cmake_build_arguments.append("-j1")
  720. if job.cflags or job.cppflags:
  721. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags + job.cppflags)}\"")
  722. if job.cxxflags or job.cppflags:
  723. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags + job.cppflags)}\"")
  724. if job.ldflags:
  725. job.cmake_arguments.append(f"-DCMAKE_SHARED_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  726. job.cmake_arguments.append(f"-DCMAKE_EXE_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  727. job.pretest_cmd = "\n".join(pretest_cmd)
  728. def tf(b):
  729. return "ON" if b else "OFF"
  730. if fpic is not None:
  731. job.cmake_arguments.append(f"-DCMAKE_POSITION_INDEPENDENT_CODE={tf(fpic)}")
  732. if job.no_cmake:
  733. job.cmake_arguments = []
  734. return job
  735. def spec_to_platform(spec: JobSpec, key: str, enable_artifacts: bool, trackmem_symbol_names: bool) -> dict[str, str|bool]:
  736. logger.info("spec=%r", spec)
  737. job = spec_to_job(spec, key=key, trackmem_symbol_names=trackmem_symbol_names)
  738. logger.info("job=%r", job)
  739. platform = job.to_workflow(enable_artifacts=enable_artifacts)
  740. logger.info("platform=%r", platform)
  741. return platform
  742. def main():
  743. parser = argparse.ArgumentParser(allow_abbrev=False)
  744. parser.add_argument("--github-variable-prefix", default="platforms")
  745. parser.add_argument("--github-ci", action="store_true")
  746. parser.add_argument("--verbose", action="store_true")
  747. parser.add_argument("--commit-message-file")
  748. parser.add_argument("--no-artifact", dest="enable_artifacts", action="store_false")
  749. parser.add_argument("--trackmem-symbol-names", dest="trackmem_symbol_names", action="store_true")
  750. args = parser.parse_args()
  751. logging.basicConfig(level=logging.INFO if args.verbose else logging.WARNING)
  752. remaining_keys = set(JOB_SPECS.keys())
  753. all_level_keys = (
  754. # Level 1
  755. (
  756. "haiku",
  757. ),
  758. )
  759. filters = []
  760. if args.commit_message_file:
  761. with open(args.commit_message_file, "r") as f:
  762. commit_message = f.read()
  763. for m in re.finditer(r"\[sdl-ci-filter (.*)]", commit_message, flags=re.M):
  764. filters.append(m.group(1).strip(" \t\n\r\t'\""))
  765. if re.search(r"\[sdl-ci-artifacts?]", commit_message, flags=re.M):
  766. args.enable_artifacts = True
  767. if re.search(r"\[sdl-ci-(full-)?trackmem(-symbol-names)?]", commit_message, flags=re.M):
  768. args.trackmem_symbol_names = True
  769. if not filters:
  770. filters.append("*")
  771. logger.info("filters: %r", filters)
  772. all_level_platforms = {}
  773. 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()}
  774. for level_i, level_keys in enumerate(all_level_keys, 1):
  775. level_key = f"level{level_i}"
  776. logger.info("Level %d: keys=%r", level_i, level_keys)
  777. assert all(k in remaining_keys for k in level_keys)
  778. level_platforms = tuple(all_platforms[key] for key in level_keys)
  779. remaining_keys.difference_update(level_keys)
  780. all_level_platforms[level_key] = level_platforms
  781. logger.info("=" * 80)
  782. logger.info("Keys before filter: %r", remaining_keys)
  783. filtered_remaining_keys = set()
  784. for filter in filters:
  785. filtered_remaining_keys.update(fnmatch.filter(remaining_keys, filter))
  786. logger.info("Keys after filter: %r", filtered_remaining_keys)
  787. remaining_keys = filtered_remaining_keys
  788. logger.info("Remaining: %r", remaining_keys)
  789. all_level_platforms["others"] = tuple(all_platforms[key] for key in remaining_keys)
  790. if args.github_ci:
  791. for level, platforms in all_level_platforms.items():
  792. platforms_json = json.dumps(platforms)
  793. txt = f"{args.github_variable_prefix}-{level}={platforms_json}"
  794. logger.info("%s", txt)
  795. if "GITHUB_OUTPUT" in os.environ:
  796. with open(os.environ["GITHUB_OUTPUT"], "a") as f:
  797. f.write(txt)
  798. f.write("\n")
  799. else:
  800. logger.warning("GITHUB_OUTPUT not defined")
  801. return 0
  802. if __name__ == "__main__":
  803. raise SystemExit(main())