create-test-plan.py 39 KB

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