create-test-plan.py 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834
  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. Ubuntu20_04 = "ubuntu-20.04"
  25. Ubuntu22_04 = "ubuntu-22.04"
  26. Ubuntu24_04 = "ubuntu-24.04"
  27. Ubuntu24_04_arm = "ubuntu-24.04-arm"
  28. Macos13 = "macos-13"
  29. class SdlPlatform(Enum):
  30. Android = "android"
  31. Emscripten = "emscripten"
  32. Haiku = "haiku"
  33. LoongArch64 = "loongarch64"
  34. Msys2 = "msys2"
  35. Linux = "linux"
  36. MacOS = "macos"
  37. Ios = "ios"
  38. Tvos = "tvos"
  39. Msvc = "msvc"
  40. N3ds = "n3ds"
  41. PowerPC = "powerpc"
  42. PowerPC64 = "powerpc64"
  43. Ps2 = "ps2"
  44. Psp = "psp"
  45. Vita = "vita"
  46. Riscos = "riscos"
  47. FreeBSD = "freebsd"
  48. NetBSD = "netbsd"
  49. class Msys2Platform(Enum):
  50. Mingw32 = "mingw32"
  51. Mingw64 = "mingw64"
  52. Clang32 = "clang32"
  53. Clang64 = "clang64"
  54. Ucrt64 = "ucrt64"
  55. class IntelCompiler(Enum):
  56. Icc = "icc"
  57. Icx = "icx"
  58. class VitaGLES(Enum):
  59. Pib = "pib"
  60. Pvr = "pvr"
  61. @dataclasses.dataclass(slots=True)
  62. class JobSpec:
  63. name: str
  64. os: JobOs
  65. platform: SdlPlatform
  66. artifact: Optional[str]
  67. container: Optional[str] = None
  68. no_cmake: bool = False
  69. xcode: bool = False
  70. android_mk: bool = False
  71. android_gradle: bool = False
  72. lean: bool = False
  73. android_arch: Optional[str] = None
  74. android_abi: Optional[str] = None
  75. android_platform: Optional[int] = None
  76. msys2_platform: Optional[Msys2Platform] = None
  77. intel: Optional[IntelCompiler] = None
  78. apple_framework: Optional[bool] = None
  79. apple_archs: Optional[set[AppleArch]] = None
  80. msvc_project: Optional[str] = None
  81. msvc_arch: Optional[MsvcArch] = None
  82. clang_cl: bool = False
  83. gdk: bool = False
  84. vita_gles: Optional[VitaGLES] = None
  85. JOB_SPECS = {
  86. "msys2-mingw32": JobSpec(name="Windows (msys2, mingw32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32", msys2_platform=Msys2Platform.Mingw32, ),
  87. "msys2-mingw64": JobSpec(name="Windows (msys2, mingw64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64", msys2_platform=Msys2Platform.Mingw64, ),
  88. "msys2-clang32": JobSpec(name="Windows (msys2, clang32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32-clang", msys2_platform=Msys2Platform.Clang32, ),
  89. "msys2-clang64": JobSpec(name="Windows (msys2, clang64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-clang", msys2_platform=Msys2Platform.Clang64, ),
  90. "msys2-ucrt64": JobSpec(name="Windows (msys2, ucrt64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-ucrt", msys2_platform=Msys2Platform.Ucrt64, ),
  91. "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", ),
  92. "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", ),
  93. "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, ),
  94. "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, ),
  95. "msvc-arm32": JobSpec(name="Windows (MSVC, ARM)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm32", msvc_arch=MsvcArch.Arm32, ),
  96. "msvc-arm64": JobSpec(name="Windows (MSVC, ARM64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm64", msvc_arch=MsvcArch.Arm64, ),
  97. "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, ),
  98. "ubuntu-20.04": JobSpec(name="Ubuntu 20.04", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04", ),
  99. "ubuntu-22.04": JobSpec(name="Ubuntu 22.04", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu22.04", ),
  100. "ubuntu-24.04-arm64": JobSpec(name="Ubuntu 24.04 (ARM64)", os=JobOs.Ubuntu24_04_arm, platform=SdlPlatform.Linux, artifact="SDL-ubuntu24.04-arm64", ),
  101. "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", ),
  102. "ubuntu-intel-icx": JobSpec(name="Ubuntu 20.04 (Intel oneAPI)", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-oneapi", intel=IntelCompiler.Icx, ),
  103. "ubuntu-intel-icc": JobSpec(name="Ubuntu 20.04 (Intel Compiler)", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-icc", intel=IntelCompiler.Icc, ),
  104. "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, ),
  105. "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, }, ),
  106. "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, }, ),
  107. "ios": JobSpec(name="iOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Ios, artifact="SDL-ios-arm64", xcode=True, ),
  108. "tvos": JobSpec(name="tvOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Tvos, artifact="SDL-tvos-arm64", xcode=True, ),
  109. "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, ),
  110. "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, ),
  111. "android-mk": JobSpec(name="Android (Android.mk)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_mk=True, ),
  112. "android-gradle": JobSpec(name="Android (Gradle)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_gradle=True, ),
  113. "emscripten": JobSpec(name="Emscripten", os=JobOs.UbuntuLatest, platform=SdlPlatform.Emscripten, artifact="SDL-emscripten", ),
  114. "haiku": JobSpec(name="Haiku", os=JobOs.UbuntuLatest, platform=SdlPlatform.Haiku, artifact="SDL-haiku-x64", container="ghcr.io/haiku/cross-compiler:x86_64-r1beta5", ),
  115. "loongarch64": JobSpec(name="LoongArch64", os=JobOs.UbuntuLatest, platform=SdlPlatform.LoongArch64, artifact="SDL-loongarch64", ),
  116. "n3ds": JobSpec(name="Nintendo 3DS", os=JobOs.UbuntuLatest, platform=SdlPlatform.N3ds, artifact="SDL-n3ds", container="devkitpro/devkitarm:latest", ),
  117. "ppc": JobSpec(name="PowerPC", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC, artifact="SDL-ppc", container="dockcross/linux-ppc:latest", ),
  118. "ppc64": JobSpec(name="PowerPC64", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC64, artifact="SDL-ppc64le", container="dockcross/linux-ppc64le:latest", ),
  119. "ps2": JobSpec(name="Sony PlayStation 2", os=JobOs.UbuntuLatest, platform=SdlPlatform.Ps2, artifact="SDL-ps2", container="ps2dev/ps2dev:latest", ),
  120. "psp": JobSpec(name="Sony PlayStation Portable", os=JobOs.UbuntuLatest, platform=SdlPlatform.Psp, artifact="SDL-psp", container="pspdev/pspdev:latest", ),
  121. "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, ),
  122. "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, ),
  123. "riscos": JobSpec(name="RISC OS", os=JobOs.UbuntuLatest, platform=SdlPlatform.Riscos, artifact="SDL-riscos", container="riscosdotinfo/riscos-gccsdk-4.7:latest", ),
  124. "netbsd": JobSpec(name="NetBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.NetBSD, artifact="SDL-netbsd-x64", ),
  125. "freebsd": JobSpec(name="FreeBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.FreeBSD, artifact="SDL-freebsd-x64", ),
  126. }
  127. class StaticLibType(Enum):
  128. MSVC = "SDL3-static.lib"
  129. A = "libSDL3.a"
  130. class SharedLibType(Enum):
  131. WIN32 = "SDL3.dll"
  132. SO_0 = "libSDL3.so.0"
  133. SO = "libSDL3.so"
  134. DYLIB = "libSDL3.0.dylib"
  135. FRAMEWORK = "SDL3.framework/Versions/A/SDL3"
  136. @dataclasses.dataclass(slots=True)
  137. class JobDetails:
  138. name: str
  139. key: str
  140. os: str
  141. platform: str
  142. artifact: str
  143. no_cmake: bool
  144. build_tests: bool = True
  145. container: str = ""
  146. cmake_build_type: str = "RelWithDebInfo"
  147. shell: str = "sh"
  148. sudo: str = "sudo"
  149. cmake_config_emulator: str = ""
  150. apk_packages: list[str] = dataclasses.field(default_factory=list)
  151. apt_packages: list[str] = dataclasses.field(default_factory=list)
  152. brew_packages: list[str] = dataclasses.field(default_factory=list)
  153. cmake_toolchain_file: str = ""
  154. cmake_arguments: list[str] = dataclasses.field(default_factory=list)
  155. cmake_build_arguments: list[str] = dataclasses.field(default_factory=list)
  156. clang_tidy: bool = True
  157. cppflags: list[str] = dataclasses.field(default_factory=list)
  158. cc: str = ""
  159. cxx: str = ""
  160. cflags: list[str] = dataclasses.field(default_factory=list)
  161. cxxflags: list[str] = dataclasses.field(default_factory=list)
  162. ldflags: list[str] = dataclasses.field(default_factory=list)
  163. pollute_directories: list[str] = dataclasses.field(default_factory=list)
  164. use_cmake: bool = True
  165. shared: bool = True
  166. static: bool = True
  167. shared_lib: Optional[SharedLibType] = None
  168. static_lib: Optional[StaticLibType] = None
  169. run_tests: bool = True
  170. test_pkg_config: bool = True
  171. cc_from_cmake: bool = False
  172. source_cmd: str = ""
  173. pretest_cmd: str = ""
  174. java: bool = False
  175. android_apks: list[str] = dataclasses.field(default_factory=list)
  176. android_ndk: bool = False
  177. android_mk: bool = False
  178. android_gradle: bool = False
  179. minidump: bool = False
  180. intel: bool = False
  181. msys2_msystem: str = ""
  182. msys2_env: str = ""
  183. msys2_no_perl: bool = False
  184. werror: bool = True
  185. msvc_vcvars_arch: str = ""
  186. msvc_vcvars_sdk: str = ""
  187. msvc_project: str = ""
  188. msvc_project_flags: list[str] = dataclasses.field(default_factory=list)
  189. setup_ninja: bool = False
  190. setup_libusb_arch: str = ""
  191. xcode_sdk: str = ""
  192. cpactions: bool = False
  193. setup_gdk_folder: str = ""
  194. cpactions_os: str = ""
  195. cpactions_version: str = ""
  196. cpactions_arch: str = ""
  197. cpactions_setup_cmd: str = ""
  198. cpactions_install_cmd: str = ""
  199. setup_vita_gles_type: str = ""
  200. check_sources: bool = False
  201. setup_python: bool = False
  202. pypi_packages: list[str] = dataclasses.field(default_factory=list)
  203. def to_workflow(self, enable_artifacts: bool) -> dict[str, str|bool]:
  204. data = {
  205. "name": self.name,
  206. "key": self.key,
  207. "os": self.os,
  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. "gnome-desktop-testing",
  392. "libasound2-dev",
  393. "libpulse-dev",
  394. "libaudio-dev",
  395. "libjack-dev",
  396. "libsndio-dev",
  397. "libusb-1.0-0-dev",
  398. "libx11-dev",
  399. "libxext-dev",
  400. "libxrandr-dev",
  401. "libxcursor-dev",
  402. "libxfixes-dev",
  403. "libxi-dev",
  404. "libxss-dev",
  405. "libwayland-dev",
  406. "libxkbcommon-dev",
  407. "libdrm-dev",
  408. "libgbm-dev",
  409. "libgl1-mesa-dev",
  410. "libgles2-mesa-dev",
  411. "libegl1-mesa-dev",
  412. "libdbus-1-dev",
  413. "libibus-1.0-dev",
  414. "libudev-dev",
  415. "fcitx-libs-dev",
  416. ))
  417. match = re.match(r"ubuntu-(?P<year>[0-9]+)\.(?P<month>[0-9]+).*", spec.os.value)
  418. ubuntu_year, ubuntu_month = [int(match["year"]), int(match["month"])]
  419. if ubuntu_year >= 22:
  420. job.apt_packages.extend(("libpipewire-0.3-dev", "libdecor-0-dev"))
  421. job.apt_packages.extend((
  422. "libunwind-dev", # For SDL_test memory tracking
  423. ))
  424. if trackmem_symbol_names:
  425. # older libunwind is slow
  426. job.cmake_arguments.append("-DSDLTEST_TIMEOUT_MULTIPLIER=2")
  427. job.shared_lib = SharedLibType.SO_0
  428. job.static_lib = StaticLibType.A
  429. fpic = True
  430. case SdlPlatform.Ios | SdlPlatform.Tvos:
  431. job.brew_packages.extend([
  432. "ninja",
  433. ])
  434. job.clang_tidy = False
  435. job.run_tests = False
  436. job.test_pkg_config = False
  437. job.shared_lib = SharedLibType.DYLIB
  438. job.static_lib = StaticLibType.A
  439. match spec.platform:
  440. case SdlPlatform.Ios:
  441. if spec.xcode:
  442. job.xcode_sdk = 'iphoneos'
  443. job.cmake_arguments.extend([
  444. "-DCMAKE_SYSTEM_NAME=iOS",
  445. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  446. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  447. ])
  448. case SdlPlatform.Tvos:
  449. if spec.xcode:
  450. job.xcode_sdk = 'appletvos'
  451. job.cmake_arguments.extend([
  452. "-DCMAKE_SYSTEM_NAME=tvOS",
  453. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  454. "-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0",
  455. ])
  456. case SdlPlatform.MacOS:
  457. if spec.apple_framework:
  458. job.static = False
  459. job.clang_tidy = False
  460. job.test_pkg_config = False
  461. job.cmake_arguments.extend((
  462. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  463. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  464. "-DSDL_FRAMEWORK=ON",
  465. ))
  466. job.shared_lib = SharedLibType.FRAMEWORK
  467. else:
  468. job.clang_tidy = True
  469. job.cmake_arguments.extend((
  470. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  471. "-DCMAKE_OSX_DEPLOYMENT_TARGET=10.13",
  472. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  473. ))
  474. job.shared_lib = SharedLibType.DYLIB
  475. job.static_lib = StaticLibType.A
  476. job.apt_packages = []
  477. job.brew_packages.append("ninja")
  478. if job.clang_tidy:
  479. job.brew_packages.append("llvm")
  480. if spec.xcode:
  481. job.xcode_sdk = "macosx"
  482. case SdlPlatform.Android:
  483. job.android_gradle = spec.android_gradle
  484. job.android_mk = spec.android_mk
  485. job.run_tests = False
  486. job.shared_lib = SharedLibType.SO
  487. job.static_lib = StaticLibType.A
  488. if spec.android_mk or not spec.no_cmake:
  489. job.android_ndk = True
  490. if spec.android_gradle or not spec.no_cmake:
  491. job.java = True
  492. if spec.android_mk or spec.android_gradle:
  493. job.apt_packages = []
  494. if not spec.no_cmake:
  495. job.cmake_arguments.extend((
  496. f"-DANDROID_PLATFORM={spec.android_platform}",
  497. f"-DANDROID_ABI={spec.android_abi}",
  498. ))
  499. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  500. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  501. job.android_apks = [
  502. "testaudiorecording-apk",
  503. "testautomation-apk",
  504. "testcontroller-apk",
  505. "testmultiaudio-apk",
  506. "testsprite-apk",
  507. ]
  508. case SdlPlatform.Emscripten:
  509. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  510. job.shared = False
  511. job.cmake_config_emulator = "emcmake"
  512. job.cmake_build_type = "Debug"
  513. job.test_pkg_config = False
  514. job.cmake_arguments.extend((
  515. "-DSDLTEST_BROWSER=chrome",
  516. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  517. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  518. ))
  519. job.cflags.extend((
  520. "-gsource-map",
  521. "-ffile-prefix-map=${PWD}=/SDL",
  522. ))
  523. job.ldflags.extend((
  524. "--source-map-base", "/",
  525. ))
  526. pretest_cmd.extend((
  527. "# Start local HTTP server",
  528. "cmake --build build --target serve-sdl-tests --verbose &",
  529. "chrome --version",
  530. "chromedriver --version",
  531. ))
  532. job.static_lib = StaticLibType.A
  533. job.setup_python = True
  534. job.pypi_packages.append("selenium")
  535. case SdlPlatform.Ps2:
  536. build_parallel = False
  537. job.shared = False
  538. job.sudo = ""
  539. job.apt_packages = []
  540. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  541. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  542. job.clang_tidy = False
  543. job.run_tests = False
  544. job.shared = False
  545. job.cc = "mips64r5900el-ps2-elf-gcc"
  546. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  547. job.static_lib = StaticLibType.A
  548. case SdlPlatform.Psp:
  549. build_parallel = False
  550. job.sudo = ""
  551. job.apt_packages = []
  552. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  553. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  554. job.clang_tidy = False
  555. job.run_tests = False
  556. job.shared = False
  557. job.cc = "psp-gcc"
  558. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  559. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  560. job.static_lib = StaticLibType.A
  561. case SdlPlatform.Vita:
  562. job.sudo = ""
  563. job.apt_packages = []
  564. job.apk_packages = ["cmake", "ninja", "pkgconf", "bash", "tar"]
  565. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  566. assert spec.vita_gles is not None
  567. job.setup_vita_gles_type = {
  568. VitaGLES.Pib: "pib",
  569. VitaGLES.Pvr: "pvr",
  570. }[spec.vita_gles]
  571. job.cmake_arguments.extend((
  572. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  573. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  574. "-DSDL_ARMNEON=ON",
  575. "-DSDL_ARMSIMD=ON",
  576. ))
  577. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  578. 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"""
  579. job.clang_tidy = False
  580. job.run_tests = False
  581. job.shared = False
  582. job.cc = "arm-vita-eabi-gcc"
  583. job.static_lib = StaticLibType.A
  584. case SdlPlatform.Haiku:
  585. fpic = False
  586. job.run_tests = False
  587. job.cc = "x86_64-unknown-haiku-gcc"
  588. job.cxx = "x86_64-unknown-haiku-g++"
  589. job.sudo = ""
  590. job.cmake_arguments.extend((
  591. f"-DCMAKE_C_COMPILER={job.cc}",
  592. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  593. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  594. ))
  595. job.shared_lib = SharedLibType.SO_0
  596. job.static_lib = StaticLibType.A
  597. case SdlPlatform.PowerPC64 | SdlPlatform.PowerPC:
  598. # FIXME: Enable SDL_WERROR
  599. job.werror = False
  600. job.clang_tidy = False
  601. job.run_tests = False
  602. job.sudo = ""
  603. job.apt_packages = []
  604. job.shared_lib = SharedLibType.SO_0
  605. job.static_lib = StaticLibType.A
  606. job.cmake_arguments.extend((
  607. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  608. ))
  609. case SdlPlatform.LoongArch64:
  610. job.run_tests = False
  611. job.cc = "${LOONGARCH64_CC}"
  612. job.cxx = "${LOONGARCH64_CXX}"
  613. job.cmake_arguments.extend((
  614. f"-DCMAKE_C_COMPILER={job.cc}",
  615. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  616. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  617. "-DCMAKE_SYSTEM_NAME=Linux",
  618. ))
  619. job.shared_lib = SharedLibType.SO_0
  620. job.static_lib = StaticLibType.A
  621. case SdlPlatform.N3ds:
  622. job.shared = False
  623. job.apt_packages = ["ninja-build", "binutils"]
  624. job.clang_tidy = False
  625. job.run_tests = False
  626. job.cc_from_cmake = True
  627. job.cmake_toolchain_file = "${DEVKITPRO}/cmake/3DS.cmake"
  628. job.static_lib = StaticLibType.A
  629. case SdlPlatform.Msys2:
  630. job.shell = "msys2 {0}"
  631. assert spec.msys2_platform
  632. job.msys2_msystem = spec.msys2_platform.value
  633. job.msys2_env = {
  634. "mingw32": "mingw-w64-i686",
  635. "mingw64": "mingw-w64-x86_64",
  636. "clang32": "mingw-w64-clang-i686",
  637. "clang64": "mingw-w64-clang-x86_64",
  638. "ucrt64": "mingw-w64-ucrt-x86_64",
  639. }[spec.msys2_platform.value]
  640. job.msys2_no_perl = spec.msys2_platform in (Msys2Platform.Mingw32, Msys2Platform.Clang32)
  641. job.shared_lib = SharedLibType.WIN32
  642. job.static_lib = StaticLibType.A
  643. case SdlPlatform.Riscos:
  644. # FIXME: Enable SDL_WERROR
  645. job.werror = False
  646. job.apt_packages = ["cmake", "ninja-build"]
  647. job.test_pkg_config = False
  648. job.shared = False
  649. job.run_tests = False
  650. job.sudo = ""
  651. job.cmake_arguments.extend((
  652. "-DRISCOS:BOOL=ON",
  653. "-DCMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON",
  654. "-DSDL_GCC_ATOMICS:BOOL=OFF",
  655. ))
  656. job.cmake_toolchain_file = "/home/riscos/env/toolchain-riscos.cmake"
  657. job.static_lib = StaticLibType.A
  658. case SdlPlatform.FreeBSD | SdlPlatform.NetBSD:
  659. job.cpactions = True
  660. job.no_cmake = True
  661. job.run_tests = False
  662. job.apt_packages = []
  663. job.shared_lib = SharedLibType.SO_0
  664. job.static_lib = StaticLibType.A
  665. match spec.platform:
  666. case SdlPlatform.FreeBSD:
  667. job.cpactions_os = "freebsd"
  668. job.cpactions_version = "14.2"
  669. job.cpactions_arch = "x86-64"
  670. job.cpactions_setup_cmd = "sudo pkg update"
  671. 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"
  672. job.cmake_arguments.extend((
  673. "-DSDL_CHECK_REQUIRED_INCLUDES=/usr/local/include",
  674. "-DSDL_CHECK_REQUIRED_LINK_OPTIONS=-L/usr/local/lib",
  675. ))
  676. case SdlPlatform.NetBSD:
  677. job.cpactions_os = "netbsd"
  678. job.cpactions_version = "10.1"
  679. job.cpactions_arch = "x86-64"
  680. 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"
  681. job.cpactions_install_cmd = "sudo -E pkgin -y install cmake dbus pkgconf ninja-build pulseaudio libxkbcommon wayland wayland-protocols libinotify libusb1"
  682. case _:
  683. raise ValueError(f"Unsupported platform={spec.platform}")
  684. if "ubuntu" in spec.name.lower():
  685. job.check_sources = True
  686. job.setup_python = True
  687. if not build_parallel:
  688. job.cmake_build_arguments.append("-j1")
  689. if job.cflags:
  690. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags)}\"")
  691. if job.cxxflags:
  692. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags)}\"")
  693. if job.ldflags:
  694. job.cmake_arguments.append(f"-DCMAKE_SHARED_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  695. job.cmake_arguments.append(f"-DCMAKE_EXE_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  696. job.pretest_cmd = "\n".join(pretest_cmd)
  697. def tf(b):
  698. return "ON" if b else "OFF"
  699. if fpic is not None:
  700. job.cmake_arguments.append(f"-DCMAKE_POSITION_INDEPENDENT_CODE={tf(fpic)}")
  701. if job.no_cmake:
  702. job.cmake_arguments = []
  703. return job
  704. def spec_to_platform(spec: JobSpec, key: str, enable_artifacts: bool, trackmem_symbol_names: bool) -> dict[str, str|bool]:
  705. logger.info("spec=%r", spec)
  706. job = spec_to_job(spec, key=key, trackmem_symbol_names=trackmem_symbol_names)
  707. logger.info("job=%r", job)
  708. platform = job.to_workflow(enable_artifacts=enable_artifacts)
  709. logger.info("platform=%r", platform)
  710. return platform
  711. def main():
  712. parser = argparse.ArgumentParser(allow_abbrev=False)
  713. parser.add_argument("--github-variable-prefix", default="platforms")
  714. parser.add_argument("--github-ci", action="store_true")
  715. parser.add_argument("--verbose", action="store_true")
  716. parser.add_argument("--commit-message-file")
  717. parser.add_argument("--no-artifact", dest="enable_artifacts", action="store_false")
  718. parser.add_argument("--trackmem-symbol-names", dest="trackmem_symbol_names", action="store_true")
  719. args = parser.parse_args()
  720. logging.basicConfig(level=logging.INFO if args.verbose else logging.WARNING)
  721. remaining_keys = set(JOB_SPECS.keys())
  722. all_level_keys = (
  723. # Level 1
  724. (
  725. "haiku",
  726. ),
  727. )
  728. filters = []
  729. if args.commit_message_file:
  730. with open(args.commit_message_file, "r") as f:
  731. commit_message = f.read()
  732. for m in re.finditer(r"\[sdl-ci-filter (.*)]", commit_message, flags=re.M):
  733. filters.append(m.group(1).strip(" \t\n\r\t'\""))
  734. if re.search(r"\[sdl-ci-artifacts?]", commit_message, flags=re.M):
  735. args.enable_artifacts = True
  736. if re.search(r"\[sdl-ci-(full-)?trackmem(-symbol-names)?]", commit_message, flags=re.M):
  737. args.trackmem_symbol_names = True
  738. if not filters:
  739. filters.append("*")
  740. logger.info("filters: %r", filters)
  741. all_level_platforms = {}
  742. 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()}
  743. for level_i, level_keys in enumerate(all_level_keys, 1):
  744. level_key = f"level{level_i}"
  745. logger.info("Level %d: keys=%r", level_i, level_keys)
  746. assert all(k in remaining_keys for k in level_keys)
  747. level_platforms = tuple(all_platforms[key] for key in level_keys)
  748. remaining_keys.difference_update(level_keys)
  749. all_level_platforms[level_key] = level_platforms
  750. logger.info("=" * 80)
  751. logger.info("Keys before filter: %r", remaining_keys)
  752. filtered_remaining_keys = set()
  753. for filter in filters:
  754. filtered_remaining_keys.update(fnmatch.filter(remaining_keys, filter))
  755. logger.info("Keys after filter: %r", filtered_remaining_keys)
  756. remaining_keys = filtered_remaining_keys
  757. logger.info("Remaining: %r", remaining_keys)
  758. all_level_platforms["others"] = tuple(all_platforms[key] for key in remaining_keys)
  759. if args.github_ci:
  760. for level, platforms in all_level_platforms.items():
  761. platforms_json = json.dumps(platforms)
  762. txt = f"{args.github_variable_prefix}-{level}={platforms_json}"
  763. logger.info("%s", txt)
  764. if "GITHUB_OUTPUT" in os.environ:
  765. with open(os.environ["GITHUB_OUTPUT"], "a") as f:
  766. f.write(txt)
  767. f.write("\n")
  768. else:
  769. logger.warning("GITHUB_OUTPUT not defined")
  770. return 0
  771. if __name__ == "__main__":
  772. raise SystemExit(main())