create-test-plan.py 38 KB

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