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. Clang32 = "clang32"
  52. Clang64 = "clang64"
  53. Ucrt64 = "ucrt64"
  54. class IntelCompiler(Enum):
  55. Icc = "icc"
  56. Icx = "icx"
  57. class VitaGLES(Enum):
  58. Pib = "pib"
  59. Pvr = "pvr"
  60. @dataclasses.dataclass(slots=True)
  61. class JobSpec:
  62. name: str
  63. os: JobOs
  64. platform: SdlPlatform
  65. artifact: Optional[str]
  66. container: Optional[str] = None
  67. no_cmake: bool = False
  68. xcode: bool = False
  69. android_mk: bool = False
  70. android_gradle: bool = False
  71. lean: bool = False
  72. android_arch: Optional[str] = None
  73. android_abi: Optional[str] = None
  74. android_platform: Optional[int] = None
  75. msys2_platform: Optional[Msys2Platform] = None
  76. intel: Optional[IntelCompiler] = None
  77. apple_framework: Optional[bool] = None
  78. apple_archs: Optional[set[AppleArch]] = None
  79. msvc_project: Optional[str] = None
  80. msvc_arch: Optional[MsvcArch] = None
  81. clang_cl: bool = False
  82. gdk: bool = False
  83. vita_gles: Optional[VitaGLES] = None
  84. JOB_SPECS = {
  85. "msys2-mingw32": JobSpec(name="Windows (msys2, mingw32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32", msys2_platform=Msys2Platform.Mingw32, ),
  86. "msys2-mingw64": JobSpec(name="Windows (msys2, mingw64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64", msys2_platform=Msys2Platform.Mingw64, ),
  87. "msys2-clang32": JobSpec(name="Windows (msys2, clang32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32-clang", msys2_platform=Msys2Platform.Clang32, ),
  88. "msys2-clang64": JobSpec(name="Windows (msys2, clang64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-clang", msys2_platform=Msys2Platform.Clang64, ),
  89. "msys2-ucrt64": JobSpec(name="Windows (msys2, ucrt64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-ucrt", msys2_platform=Msys2Platform.Ucrt64, ),
  90. "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", ),
  91. "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", ),
  92. "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, ),
  93. "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, ),
  94. "msvc-arm32": JobSpec(name="Windows (MSVC, ARM)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm32", msvc_arch=MsvcArch.Arm32, ),
  95. "msvc-arm64": JobSpec(name="Windows (MSVC, ARM64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm64", msvc_arch=MsvcArch.Arm64, ),
  96. "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, ),
  97. "ubuntu-22.04": JobSpec(name="Ubuntu 22.04", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu22.04", ),
  98. "ubuntu-24.04-arm64": JobSpec(name="Ubuntu 24.04 (ARM64)", os=JobOs.Ubuntu24_04_arm, platform=SdlPlatform.Linux, artifact="SDL-ubuntu24.04-arm64", ),
  99. "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", ),
  100. "ubuntu-intel-icx": JobSpec(name="Ubuntu 20.04 (Intel oneAPI)", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-oneapi", intel=IntelCompiler.Icx, ),
  101. "ubuntu-intel-icc": JobSpec(name="Ubuntu 20.04 (Intel Compiler)", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-icc", intel=IntelCompiler.Icc, ),
  102. "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, ),
  103. "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, }, ),
  104. "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, }, ),
  105. "ios": JobSpec(name="iOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Ios, artifact="SDL-ios-arm64", xcode=True, ),
  106. "tvos": JobSpec(name="tvOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Tvos, artifact="SDL-tvos-arm64", xcode=True, ),
  107. "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, ),
  108. "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, ),
  109. "android-mk": JobSpec(name="Android (Android.mk)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_mk=True, ),
  110. "android-gradle": JobSpec(name="Android (Gradle)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_gradle=True, ),
  111. "emscripten": JobSpec(name="Emscripten", os=JobOs.UbuntuLatest, platform=SdlPlatform.Emscripten, artifact="SDL-emscripten", ),
  112. "haiku": JobSpec(name="Haiku", os=JobOs.UbuntuLatest, platform=SdlPlatform.Haiku, artifact="SDL-haiku-x64", container="ghcr.io/haiku/cross-compiler:x86_64-r1beta5", ),
  113. "loongarch64": JobSpec(name="LoongArch64", os=JobOs.UbuntuLatest, platform=SdlPlatform.LoongArch64, artifact="SDL-loongarch64", ),
  114. "n3ds": JobSpec(name="Nintendo 3DS", os=JobOs.UbuntuLatest, platform=SdlPlatform.N3ds, artifact="SDL-n3ds", container="devkitpro/devkitarm:latest", ),
  115. "ppc": JobSpec(name="PowerPC", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC, artifact="SDL-ppc", container="dockcross/linux-ppc:latest", ),
  116. "ppc64": JobSpec(name="PowerPC64", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC64, artifact="SDL-ppc64le", container="dockcross/linux-ppc64le:latest", ),
  117. "ps2": JobSpec(name="Sony PlayStation 2", os=JobOs.UbuntuLatest, platform=SdlPlatform.Ps2, artifact="SDL-ps2", container="ps2dev/ps2dev:latest", ),
  118. "psp": JobSpec(name="Sony PlayStation Portable", os=JobOs.UbuntuLatest, platform=SdlPlatform.Psp, artifact="SDL-psp", container="pspdev/pspdev:latest", ),
  119. "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, ),
  120. "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, ),
  121. "riscos": JobSpec(name="RISC OS", os=JobOs.UbuntuLatest, platform=SdlPlatform.Riscos, artifact="SDL-riscos", container="riscosdotinfo/riscos-gccsdk-4.7:latest", ),
  122. "netbsd": JobSpec(name="NetBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.NetBSD, artifact="SDL-netbsd-x64", ),
  123. "freebsd": JobSpec(name="FreeBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.FreeBSD, artifact="SDL-freebsd-x64", ),
  124. }
  125. class StaticLibType(Enum):
  126. MSVC = "SDL3-static.lib"
  127. A = "libSDL3.a"
  128. class SharedLibType(Enum):
  129. WIN32 = "SDL3.dll"
  130. SO_0 = "libSDL3.so.0"
  131. SO = "libSDL3.so"
  132. DYLIB = "libSDL3.0.dylib"
  133. FRAMEWORK = "SDL3.framework/Versions/A/SDL3"
  134. @dataclasses.dataclass(slots=True)
  135. class JobDetails:
  136. name: str
  137. key: str
  138. os: str
  139. platform: str
  140. artifact: str
  141. no_cmake: bool
  142. ccache: bool = False
  143. build_tests: bool = True
  144. container: str = ""
  145. cmake_build_type: str = "RelWithDebInfo"
  146. shell: str = "sh"
  147. sudo: str = "sudo"
  148. cmake_config_emulator: str = ""
  149. apk_packages: list[str] = dataclasses.field(default_factory=list)
  150. apt_packages: list[str] = dataclasses.field(default_factory=list)
  151. brew_packages: list[str] = dataclasses.field(default_factory=list)
  152. cmake_toolchain_file: str = ""
  153. cmake_arguments: list[str] = dataclasses.field(default_factory=list)
  154. cmake_build_arguments: list[str] = dataclasses.field(default_factory=list)
  155. clang_tidy: bool = True
  156. cppflags: list[str] = dataclasses.field(default_factory=list)
  157. cc: str = ""
  158. cxx: str = ""
  159. cflags: list[str] = dataclasses.field(default_factory=list)
  160. cxxflags: list[str] = dataclasses.field(default_factory=list)
  161. ldflags: list[str] = dataclasses.field(default_factory=list)
  162. pollute_directories: list[str] = dataclasses.field(default_factory=list)
  163. use_cmake: bool = True
  164. shared: bool = True
  165. static: bool = True
  166. shared_lib: Optional[SharedLibType] = None
  167. static_lib: Optional[StaticLibType] = None
  168. run_tests: bool = True
  169. test_pkg_config: bool = True
  170. cc_from_cmake: bool = False
  171. source_cmd: str = ""
  172. pretest_cmd: str = ""
  173. java: bool = False
  174. android_apks: list[str] = dataclasses.field(default_factory=list)
  175. android_ndk: bool = False
  176. android_mk: bool = False
  177. android_gradle: bool = False
  178. minidump: bool = False
  179. intel: bool = False
  180. msys2_msystem: str = ""
  181. msys2_env: str = ""
  182. msys2_no_perl: bool = False
  183. werror: bool = True
  184. msvc_vcvars_arch: str = ""
  185. msvc_vcvars_sdk: str = ""
  186. msvc_project: str = ""
  187. msvc_project_flags: list[str] = dataclasses.field(default_factory=list)
  188. setup_ninja: bool = False
  189. setup_libusb_arch: str = ""
  190. xcode_sdk: str = ""
  191. cpactions: bool = False
  192. setup_gdk_folder: str = ""
  193. cpactions_os: str = ""
  194. cpactions_version: str = ""
  195. cpactions_arch: str = ""
  196. cpactions_setup_cmd: str = ""
  197. cpactions_install_cmd: str = ""
  198. setup_vita_gles_type: str = ""
  199. check_sources: bool = False
  200. setup_python: bool = False
  201. pypi_packages: list[str] = dataclasses.field(default_factory=list)
  202. def to_workflow(self, enable_artifacts: bool) -> dict[str, str|bool]:
  203. data = {
  204. "name": self.name,
  205. "key": self.key,
  206. "os": self.os,
  207. "ccache": self.ccache,
  208. "container": self.container if self.container else "",
  209. "platform": self.platform,
  210. "artifact": self.artifact,
  211. "enable-artifacts": enable_artifacts,
  212. "shell": self.shell,
  213. "msys2-msystem": self.msys2_msystem,
  214. "msys2-env": self.msys2_env,
  215. "msys2-no-perl": self.msys2_no_perl,
  216. "android-ndk": self.android_ndk,
  217. "java": self.java,
  218. "intel": self.intel,
  219. "apk-packages": my_shlex_join(self.apk_packages),
  220. "apt-packages": my_shlex_join(self.apt_packages),
  221. "test-pkg-config": self.test_pkg_config,
  222. "brew-packages": my_shlex_join(self.brew_packages),
  223. "pollute-directories": my_shlex_join(self.pollute_directories),
  224. "no-cmake": self.no_cmake,
  225. "build-tests": self.build_tests,
  226. "source-cmd": self.source_cmd,
  227. "pretest-cmd": self.pretest_cmd,
  228. "cmake-config-emulator": self.cmake_config_emulator,
  229. "cc": self.cc,
  230. "cxx": self.cxx,
  231. "cflags": my_shlex_join(self.cppflags + self.cflags),
  232. "cxxflags": my_shlex_join(self.cppflags + self.cxxflags),
  233. "ldflags": my_shlex_join(self.ldflags),
  234. "cmake-toolchain-file": self.cmake_toolchain_file,
  235. "clang-tidy": self.clang_tidy,
  236. "cmake-arguments": my_shlex_join(self.cmake_arguments),
  237. "cmake-build-arguments": my_shlex_join(self.cmake_build_arguments),
  238. "shared": self.shared,
  239. "static": self.static,
  240. "shared-lib": self.shared_lib.value if self.shared_lib else None,
  241. "static-lib": self.static_lib.value if self.static_lib else None,
  242. "cmake-build-type": self.cmake_build_type,
  243. "run-tests": self.run_tests,
  244. "android-apks": my_shlex_join(self.android_apks),
  245. "android-gradle": self.android_gradle,
  246. "android-mk": self.android_mk,
  247. "werror": self.werror,
  248. "sudo": self.sudo,
  249. "msvc-vcvars-arch": self.msvc_vcvars_arch,
  250. "msvc-vcvars-sdk": self.msvc_vcvars_sdk,
  251. "msvc-project": self.msvc_project,
  252. "msvc-project-flags": my_shlex_join(self.msvc_project_flags),
  253. "setup-ninja": self.setup_ninja,
  254. "setup-libusb-arch": self.setup_libusb_arch,
  255. "cc-from-cmake": self.cc_from_cmake,
  256. "xcode-sdk": self.xcode_sdk,
  257. "cpactions": self.cpactions,
  258. "cpactions-os": self.cpactions_os,
  259. "cpactions-version": self.cpactions_version,
  260. "cpactions-arch": self.cpactions_arch,
  261. "cpactions-setup-cmd": self.cpactions_setup_cmd,
  262. "cpactions-install-cmd": self.cpactions_install_cmd,
  263. "setup-vita-gles-type": self.setup_vita_gles_type,
  264. "setup-gdk-folder": self.setup_gdk_folder,
  265. "check-sources": self.check_sources,
  266. "setup-python": self.setup_python,
  267. "pypi-packages": my_shlex_join(self.pypi_packages),
  268. }
  269. return {k: v for k, v in data.items() if v != ""}
  270. def my_shlex_join(s):
  271. def escape(s):
  272. if s[:1] == "'" and s[-1:] == "'":
  273. return s
  274. if set(s).intersection(set("; \t")):
  275. return f'"{s}"'
  276. return s
  277. return " ".join(escape(s))
  278. def spec_to_job(spec: JobSpec, key: str, trackmem_symbol_names: bool) -> JobDetails:
  279. job = JobDetails(
  280. name=spec.name,
  281. key=key,
  282. os=spec.os.value,
  283. artifact=spec.artifact or "",
  284. container=spec.container or "",
  285. platform=spec.platform.value,
  286. sudo="sudo",
  287. no_cmake=spec.no_cmake,
  288. )
  289. if job.os.startswith("ubuntu"):
  290. job.apt_packages.extend([
  291. "ninja-build",
  292. "pkg-config",
  293. ])
  294. pretest_cmd = []
  295. if trackmem_symbol_names:
  296. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=1")
  297. else:
  298. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=0")
  299. win32 = spec.platform in (SdlPlatform.Msys2, SdlPlatform.Msvc)
  300. fpic = None
  301. build_parallel = True
  302. if spec.lean:
  303. job.cppflags.append("-DSDL_LEAN_AND_MEAN=1")
  304. if win32:
  305. job.cmake_arguments.append("-DSDLTEST_PROCDUMP=ON")
  306. job.minidump = True
  307. if spec.intel is not None:
  308. match spec.intel:
  309. case IntelCompiler.Icx:
  310. job.cc = "icx"
  311. job.cxx = "icpx"
  312. case IntelCompiler.Icc:
  313. job.cc = "icc"
  314. job.cxx = "icpc"
  315. job.cppflags.append("-diag-disable=10441")
  316. job.clang_tidy = False
  317. case _:
  318. raise ValueError(f"Invalid intel={spec.intel}")
  319. job.source_cmd = f"source /opt/intel/oneapi/setvars.sh;"
  320. job.intel = True
  321. job.shell = "bash"
  322. job.cmake_arguments.extend((
  323. f"-DCMAKE_C_COMPILER={job.cc}",
  324. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  325. "-DCMAKE_SYSTEM_NAME=Linux",
  326. ))
  327. match spec.platform:
  328. case SdlPlatform.Msvc:
  329. job.setup_ninja = not spec.gdk
  330. job.clang_tidy = False # complains about \threadsafety: "unknown command tag name [clang-diagnostic-documentation-unknown-command]"
  331. job.msvc_project = spec.msvc_project if spec.msvc_project else ""
  332. job.msvc_project_flags.append("-p:TreatWarningsAsError=true")
  333. job.test_pkg_config = False
  334. job.shared_lib = SharedLibType.WIN32
  335. job.static_lib = StaticLibType.MSVC
  336. job.cmake_arguments.extend((
  337. "-DCMAKE_MSVC_DEBUG_INFORMATION_FORMAT=ProgramDatabase",
  338. "-DCMAKE_EXE_LINKER_FLAGS=-DEBUG",
  339. "-DCMAKE_SHARED_LINKER_FLAGS=-DEBUG",
  340. ))
  341. job.cmake_arguments.append("'-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded$<$<CONFIG:Debug>:Debug>'")
  342. if spec.clang_cl:
  343. job.cmake_arguments.extend((
  344. "-DCMAKE_C_COMPILER=clang-cl",
  345. "-DCMAKE_CXX_COMPILER=clang-cl",
  346. ))
  347. match spec.msvc_arch:
  348. case MsvcArch.X86:
  349. job.cflags.append("/clang:-m32")
  350. job.ldflags.append("/MACHINE:X86")
  351. case MsvcArch.X64:
  352. job.cflags.append("/clang:-m64")
  353. job.ldflags.append("/MACHINE:X64")
  354. case _:
  355. raise ValueError(f"Unsupported clang-cl architecture (arch={spec.msvc_arch})")
  356. if spec.msvc_project:
  357. match spec.msvc_arch:
  358. case MsvcArch.X86:
  359. msvc_platform = "Win32"
  360. case MsvcArch.X64:
  361. msvc_platform = "x64"
  362. case _:
  363. raise ValueError(f"Unsupported vcxproj architecture (arch={spec.msvc_arch})")
  364. if spec.gdk:
  365. msvc_platform = f"Gaming.Desktop.{msvc_platform}"
  366. job.msvc_project_flags.append(f"-p:Platform={msvc_platform}")
  367. match spec.msvc_arch:
  368. case MsvcArch.X86:
  369. job.msvc_vcvars_arch = "x64_x86"
  370. case MsvcArch.X64:
  371. job.msvc_vcvars_arch = "x64"
  372. case MsvcArch.Arm32:
  373. job.msvc_vcvars_arch = "x64_arm"
  374. job.msvc_vcvars_sdk = "10.0.22621.0" # 10.0.26100.0 dropped ARM32 um and ucrt libraries
  375. job.run_tests = False
  376. case MsvcArch.Arm64:
  377. job.msvc_vcvars_arch = "x64_arm64"
  378. job.run_tests = False
  379. if spec.gdk:
  380. job.setup_gdk_folder = "VisualC-GDK"
  381. else:
  382. match spec.msvc_arch:
  383. case MsvcArch.X86:
  384. job.setup_libusb_arch = "x86"
  385. case MsvcArch.X64:
  386. job.setup_libusb_arch = "x64"
  387. case SdlPlatform.Linux:
  388. if spec.name.startswith("Ubuntu"):
  389. assert spec.os.value.startswith("ubuntu-")
  390. job.apt_packages.extend((
  391. "ccache",
  392. "gnome-desktop-testing",
  393. "libasound2-dev",
  394. "libpulse-dev",
  395. "libaudio-dev",
  396. "libjack-dev",
  397. "libsndio-dev",
  398. "libusb-1.0-0-dev",
  399. "libx11-dev",
  400. "libxext-dev",
  401. "libxrandr-dev",
  402. "libxcursor-dev",
  403. "libxfixes-dev",
  404. "libxi-dev",
  405. "libxss-dev",
  406. "libwayland-dev",
  407. "libxkbcommon-dev",
  408. "libdrm-dev",
  409. "libgbm-dev",
  410. "libgl1-mesa-dev",
  411. "libgles2-mesa-dev",
  412. "libegl1-mesa-dev",
  413. "libdbus-1-dev",
  414. "libibus-1.0-dev",
  415. "libudev-dev",
  416. "fcitx-libs-dev",
  417. ))
  418. match = re.match(r"ubuntu-(?P<year>[0-9]+)\.(?P<month>[0-9]+).*", spec.os.value)
  419. ubuntu_year, ubuntu_month = [int(match["year"]), int(match["month"])]
  420. if ubuntu_year >= 22:
  421. job.apt_packages.extend(("libpipewire-0.3-dev", "libdecor-0-dev"))
  422. job.apt_packages.extend((
  423. "libunwind-dev", # For SDL_test memory tracking
  424. ))
  425. job.ccache = True
  426. if trackmem_symbol_names:
  427. # older libunwind is slow
  428. job.cmake_arguments.append("-DSDLTEST_TIMEOUT_MULTIPLIER=2")
  429. job.shared_lib = SharedLibType.SO_0
  430. job.static_lib = StaticLibType.A
  431. fpic = True
  432. case SdlPlatform.Ios | SdlPlatform.Tvos:
  433. job.brew_packages.extend([
  434. "ccache",
  435. "ninja",
  436. ])
  437. job.ccache = True
  438. job.clang_tidy = False
  439. job.run_tests = False
  440. job.test_pkg_config = False
  441. job.shared_lib = SharedLibType.DYLIB
  442. job.static_lib = StaticLibType.A
  443. match spec.platform:
  444. case SdlPlatform.Ios:
  445. if spec.xcode:
  446. job.xcode_sdk = 'iphoneos'
  447. job.cmake_arguments.extend([
  448. "-DCMAKE_SYSTEM_NAME=iOS",
  449. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  450. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  451. ])
  452. case SdlPlatform.Tvos:
  453. if spec.xcode:
  454. job.xcode_sdk = 'appletvos'
  455. job.cmake_arguments.extend([
  456. "-DCMAKE_SYSTEM_NAME=tvOS",
  457. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  458. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  459. ])
  460. case SdlPlatform.MacOS:
  461. if spec.apple_framework:
  462. job.static = False
  463. job.clang_tidy = False
  464. job.test_pkg_config = False
  465. job.cmake_arguments.extend((
  466. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  467. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  468. "-DSDL_FRAMEWORK=ON",
  469. ))
  470. job.shared_lib = SharedLibType.FRAMEWORK
  471. else:
  472. job.clang_tidy = True
  473. job.cmake_arguments.extend((
  474. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  475. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  476. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  477. ))
  478. job.shared_lib = SharedLibType.DYLIB
  479. job.static_lib = StaticLibType.A
  480. job.ccache = True
  481. job.apt_packages = []
  482. job.brew_packages.extend((
  483. "ccache",
  484. "ninja",
  485. ))
  486. if job.clang_tidy:
  487. job.brew_packages.append("llvm")
  488. if spec.xcode:
  489. job.xcode_sdk = "macosx"
  490. case SdlPlatform.Android:
  491. job.android_gradle = spec.android_gradle
  492. job.android_mk = spec.android_mk
  493. job.apt_packages.append("ccache")
  494. job.run_tests = False
  495. job.shared_lib = SharedLibType.SO
  496. job.static_lib = StaticLibType.A
  497. if spec.android_mk or not spec.no_cmake:
  498. job.android_ndk = True
  499. if spec.android_gradle or not spec.no_cmake:
  500. job.java = True
  501. if spec.android_mk or spec.android_gradle:
  502. job.apt_packages = []
  503. if not spec.no_cmake:
  504. job.ccache = True
  505. job.cmake_arguments.extend((
  506. f"-DANDROID_PLATFORM={spec.android_platform}",
  507. f"-DANDROID_ABI={spec.android_abi}",
  508. ))
  509. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  510. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  511. job.android_apks = [
  512. "testaudiorecording-apk",
  513. "testautomation-apk",
  514. "testcontroller-apk",
  515. "testmultiaudio-apk",
  516. "testsprite-apk",
  517. ]
  518. case SdlPlatform.Emscripten:
  519. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  520. job.shared = False
  521. job.ccache = True
  522. job.apt_packages.append("ccache")
  523. job.cmake_config_emulator = "emcmake"
  524. job.cmake_build_type = "Debug"
  525. job.test_pkg_config = False
  526. job.cmake_arguments.extend((
  527. "-DSDLTEST_BROWSER=chrome",
  528. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  529. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  530. ))
  531. job.cflags.extend((
  532. "-gsource-map",
  533. "-ffile-prefix-map=${PWD}=/SDL",
  534. ))
  535. job.ldflags.extend((
  536. "--source-map-base", "/",
  537. ))
  538. pretest_cmd.extend((
  539. "# Start local HTTP server",
  540. "cmake --build build --target serve-sdl-tests --verbose &",
  541. "chrome --version",
  542. "chromedriver --version",
  543. ))
  544. job.static_lib = StaticLibType.A
  545. job.setup_python = True
  546. job.pypi_packages.append("selenium")
  547. case SdlPlatform.Ps2:
  548. job.ccache = False # actions/ccache does not work in psp container (incompatible tar of busybox)
  549. build_parallel = False
  550. job.shared = False
  551. job.sudo = ""
  552. job.apt_packages = []
  553. job.apk_packages = ["ccache", "cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  554. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  555. job.clang_tidy = False
  556. job.run_tests = False
  557. job.shared = False
  558. job.cc = "mips64r5900el-ps2-elf-gcc"
  559. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  560. job.static_lib = StaticLibType.A
  561. case SdlPlatform.Psp:
  562. job.ccache = False # actions/ccache does not work in psp container (incompatible tar of busybox)
  563. build_parallel = False
  564. job.sudo = ""
  565. job.apt_packages = []
  566. job.apk_packages = ["ccache", "cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  567. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  568. job.clang_tidy = False
  569. job.run_tests = False
  570. job.shared = False
  571. job.cc = "psp-gcc"
  572. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  573. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  574. job.static_lib = StaticLibType.A
  575. case SdlPlatform.Vita:
  576. job.ccache = True
  577. job.sudo = ""
  578. job.apt_packages = []
  579. job.apk_packages = ["ccache", "cmake", "ninja", "pkgconf", "bash", "tar"]
  580. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  581. assert spec.vita_gles is not None
  582. job.setup_vita_gles_type = {
  583. VitaGLES.Pib: "pib",
  584. VitaGLES.Pvr: "pvr",
  585. }[spec.vita_gles]
  586. job.cmake_arguments.extend((
  587. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  588. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  589. "-DSDL_ARMNEON=ON",
  590. "-DSDL_ARMSIMD=ON",
  591. ))
  592. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  593. 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"""
  594. job.clang_tidy = False
  595. job.run_tests = False
  596. job.shared = False
  597. job.cc = "arm-vita-eabi-gcc"
  598. job.static_lib = StaticLibType.A
  599. case SdlPlatform.Haiku:
  600. job.ccache = True
  601. fpic = False
  602. job.run_tests = False
  603. job.apt_packages.append("ccache")
  604. job.cc = "x86_64-unknown-haiku-gcc"
  605. job.cxx = "x86_64-unknown-haiku-g++"
  606. job.sudo = ""
  607. job.cmake_arguments.extend((
  608. f"-DCMAKE_C_COMPILER={job.cc}",
  609. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  610. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  611. ))
  612. job.shared_lib = SharedLibType.SO_0
  613. job.static_lib = StaticLibType.A
  614. case SdlPlatform.PowerPC64 | SdlPlatform.PowerPC:
  615. job.ccache = True
  616. # FIXME: Enable SDL_WERROR
  617. job.werror = False
  618. job.clang_tidy = False
  619. job.run_tests = False
  620. job.sudo = ""
  621. job.apt_packages = ["ccache"]
  622. job.shared_lib = SharedLibType.SO_0
  623. job.static_lib = StaticLibType.A
  624. job.cmake_arguments.extend((
  625. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  626. ))
  627. case SdlPlatform.LoongArch64:
  628. job.ccache = True
  629. fpic = True
  630. job.run_tests = False
  631. job.apt_packages.append("ccache")
  632. job.cc = "${LOONGARCH64_CC}"
  633. job.cxx = "${LOONGARCH64_CXX}"
  634. job.cmake_arguments.extend((
  635. f"-DCMAKE_C_COMPILER={job.cc}",
  636. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  637. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  638. "-DCMAKE_SYSTEM_NAME=Linux",
  639. ))
  640. job.shared_lib = SharedLibType.SO_0
  641. job.static_lib = StaticLibType.A
  642. case SdlPlatform.N3ds:
  643. job.ccache = True
  644. job.shared = False
  645. job.apt_packages = ["ccache", "ninja-build", "binutils"]
  646. job.clang_tidy = False
  647. job.run_tests = False
  648. job.cc_from_cmake = True
  649. job.cmake_toolchain_file = "${DEVKITPRO}/cmake/3DS.cmake"
  650. job.static_lib = StaticLibType.A
  651. case SdlPlatform.Msys2:
  652. job.ccache = True
  653. job.shell = "msys2 {0}"
  654. assert spec.msys2_platform
  655. job.msys2_msystem = spec.msys2_platform.value
  656. job.msys2_env = {
  657. "mingw32": "mingw-w64-i686",
  658. "mingw64": "mingw-w64-x86_64",
  659. "clang32": "mingw-w64-clang-i686",
  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, Msys2Platform.Clang32)
  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:
  719. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags)}\"")
  720. if job.cxxflags:
  721. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags)}\"")
  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())