create-test-plan.py 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819
  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. ])
  436. case SdlPlatform.Tvos:
  437. if spec.xcode:
  438. job.xcode_sdk = 'appletvos'
  439. job.cmake_arguments.extend([
  440. "-DCMAKE_SYSTEM_NAME=tvOS",
  441. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  442. ])
  443. case SdlPlatform.MacOS:
  444. if spec.apple_framework:
  445. job.static = False
  446. job.clang_tidy = False
  447. job.test_pkg_config = False
  448. job.cmake_arguments.extend((
  449. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  450. "-DSDL_FRAMEWORK=ON",
  451. ))
  452. job.shared_lib = SharedLibType.FRAMEWORK
  453. else:
  454. job.clang_tidy = True
  455. job.cmake_arguments.extend((
  456. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  457. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  458. ))
  459. job.shared_lib = SharedLibType.DYLIB
  460. job.static_lib = StaticLibType.A
  461. job.apt_packages = []
  462. job.brew_packages.append("ninja")
  463. if job.test_pkg_config:
  464. job.brew_packages.append("pkg-config")
  465. if job.clang_tidy:
  466. job.brew_packages.append("llvm")
  467. if spec.xcode:
  468. job.xcode_sdk = "macosx"
  469. case SdlPlatform.Android:
  470. job.android_gradle = spec.android_gradle
  471. job.android_mk = spec.android_mk
  472. job.run_tests = False
  473. job.shared_lib = SharedLibType.SO
  474. job.static_lib = StaticLibType.A
  475. if spec.android_mk or not spec.no_cmake:
  476. job.android_ndk = True
  477. if spec.android_gradle or not spec.no_cmake:
  478. job.java = True
  479. if spec.android_mk or spec.android_gradle:
  480. job.apt_packages = []
  481. if not spec.no_cmake:
  482. job.cmake_arguments.extend((
  483. f"-DANDROID_PLATFORM={spec.android_platform}",
  484. f"-DANDROID_ABI={spec.android_abi}",
  485. ))
  486. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  487. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  488. job.android_apks = [
  489. "testaudiorecording-apk",
  490. "testautomation-apk",
  491. "testcontroller-apk",
  492. "testmultiaudio-apk",
  493. "testsprite-apk",
  494. ]
  495. case SdlPlatform.Emscripten:
  496. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  497. job.shared = False
  498. job.cmake_config_emulator = "emcmake"
  499. job.cmake_build_type = "Debug"
  500. job.test_pkg_config = False
  501. job.apt_packages.append("python3-selenium")
  502. job.cmake_arguments.extend((
  503. "-DSDLTEST_BROWSER=chrome",
  504. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  505. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  506. ))
  507. job.cflags.extend((
  508. "-gsource-map",
  509. "-ffile-prefix-map=${PWD}=/SDL",
  510. ))
  511. job.ldflags.extend((
  512. "--source-map-base", "/",
  513. ))
  514. pretest_cmd.extend((
  515. "# Start local HTTP server",
  516. "cmake --build build --target serve-sdl-tests --verbose &",
  517. "chrome --version",
  518. "chromedriver --version",
  519. ))
  520. job.static_lib = StaticLibType.A
  521. case SdlPlatform.Ps2:
  522. build_parallel = False
  523. job.shared = False
  524. job.sudo = ""
  525. job.apt_packages = []
  526. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  527. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  528. job.clang_tidy = False
  529. job.run_tests = False
  530. job.shared = False
  531. job.cc = "mips64r5900el-ps2-elf-gcc"
  532. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  533. job.static_lib = StaticLibType.A
  534. case SdlPlatform.Psp:
  535. build_parallel = False
  536. job.sudo = ""
  537. job.apt_packages = []
  538. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  539. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  540. job.clang_tidy = False
  541. job.run_tests = False
  542. job.shared = False
  543. job.cc = "psp-gcc"
  544. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  545. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  546. job.static_lib = StaticLibType.A
  547. case SdlPlatform.Vita:
  548. job.sudo = ""
  549. job.apt_packages = []
  550. job.apk_packages = ["cmake", "ninja", "pkgconf", "bash", "tar"]
  551. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  552. assert spec.vita_gles is not None
  553. job.setup_vita_gles_type = {
  554. VitaGLES.Pib: "pib",
  555. VitaGLES.Pvr: "pvr",
  556. }[spec.vita_gles]
  557. job.cmake_arguments.extend((
  558. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  559. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  560. "-DSDL_ARMNEON=ON",
  561. "-DSDL_ARMSIMD=ON",
  562. ))
  563. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  564. 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"""
  565. job.clang_tidy = False
  566. job.run_tests = False
  567. job.shared = False
  568. job.cc = "arm-vita-eabi-gcc"
  569. job.static_lib = StaticLibType.A
  570. case SdlPlatform.Haiku:
  571. fpic = False
  572. job.run_tests = False
  573. job.cc = "x86_64-unknown-haiku-gcc"
  574. job.cxx = "x86_64-unknown-haiku-g++"
  575. job.sudo = ""
  576. job.cmake_arguments.extend((
  577. f"-DCMAKE_C_COMPILER={job.cc}",
  578. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  579. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  580. ))
  581. job.shared_lib = SharedLibType.SO_0
  582. job.static_lib = StaticLibType.A
  583. case SdlPlatform.PowerPC64:
  584. # FIXME: Enable SDL_WERROR
  585. job.werror = False
  586. job.clang_tidy = False
  587. job.run_tests = False
  588. job.sudo = ""
  589. job.apt_packages = []
  590. job.shared_lib = SharedLibType.SO_0
  591. job.static_lib = StaticLibType.A
  592. job.cmake_arguments.extend((
  593. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  594. ))
  595. case SdlPlatform.LoongArch64:
  596. job.run_tests = False
  597. job.cc = "${LOONGARCH64_CC}"
  598. job.cxx = "${LOONGARCH64_CXX}"
  599. job.cmake_arguments.extend((
  600. f"-DCMAKE_C_COMPILER={job.cc}",
  601. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  602. "-DSDL_UNIX_CONSOLE_BUILD=ON",
  603. "-DCMAKE_SYSTEM_NAME=Linux",
  604. ))
  605. job.shared_lib = SharedLibType.SO_0
  606. job.static_lib = StaticLibType.A
  607. case SdlPlatform.N3ds:
  608. job.shared = False
  609. job.apt_packages = ["ninja-build", "binutils"]
  610. job.clang_tidy = False
  611. job.run_tests = False
  612. job.cc_from_cmake = True
  613. job.cmake_toolchain_file = "${DEVKITPRO}/cmake/3DS.cmake"
  614. job.static_lib = StaticLibType.A
  615. case SdlPlatform.Msys2:
  616. job.shell = "msys2 {0}"
  617. assert spec.msys2_platform
  618. job.msys2_msystem = spec.msys2_platform.value
  619. job.msys2_env = {
  620. "mingw32": "mingw-w64-i686",
  621. "mingw64": "mingw-w64-x86_64",
  622. "clang32": "mingw-w64-clang-i686",
  623. "clang64": "mingw-w64-clang-x86_64",
  624. "ucrt64": "mingw-w64-ucrt-x86_64",
  625. }[spec.msys2_platform.value]
  626. job.msys2_no_perl = spec.msys2_platform in (Msys2Platform.Mingw32, Msys2Platform.Clang32)
  627. job.shared_lib = SharedLibType.WIN32
  628. job.static_lib = StaticLibType.A
  629. case SdlPlatform.Riscos:
  630. # FIXME: Enable SDL_WERROR
  631. job.werror = False
  632. job.apt_packages = ["cmake", "ninja-build"]
  633. job.test_pkg_config = False
  634. job.shared = False
  635. job.run_tests = False
  636. job.sudo = ""
  637. job.cmake_arguments.extend((
  638. "-DRISCOS:BOOL=ON",
  639. "-DCMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON",
  640. "-DSDL_GCC_ATOMICS:BOOL=OFF",
  641. ))
  642. job.cmake_toolchain_file = "/home/riscos/env/toolchain-riscos.cmake"
  643. job.static_lib = StaticLibType.A
  644. case SdlPlatform.FreeBSD | SdlPlatform.NetBSD:
  645. job.cpactions = True
  646. job.no_cmake = True
  647. job.run_tests = False
  648. job.apt_packages = []
  649. job.shared_lib = SharedLibType.SO_0
  650. job.static_lib = StaticLibType.A
  651. match spec.platform:
  652. case SdlPlatform.FreeBSD:
  653. job.cpactions_os = "freebsd"
  654. job.cpactions_version = "13.3"
  655. job.cpactions_arch = "x86-64"
  656. job.cpactions_setup_cmd = "sudo pkg update"
  657. 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"
  658. job.cmake_arguments.extend((
  659. "-DSDL_CHECK_REQUIRED_INCLUDES=/usr/local/include",
  660. "-DSDL_CHECK_REQUIRED_LINK_OPTIONS=-L/usr/local/lib",
  661. ))
  662. case SdlPlatform.NetBSD:
  663. job.cpactions_os = "netbsd"
  664. job.cpactions_version = "10.0"
  665. job.cpactions_arch = "x86-64"
  666. 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"
  667. job.cpactions_install_cmd = "sudo -E pkgin -y install cmake dbus pkgconf ninja-build pulseaudio libxkbcommon wayland wayland-protocols libinotify libusb1"
  668. case _:
  669. raise ValueError(f"Unsupported platform={spec.platform}")
  670. if "ubuntu" in spec.name.lower():
  671. job.check_sources = True
  672. if not build_parallel:
  673. job.cmake_build_arguments.append("-j1")
  674. if job.cflags:
  675. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags)}\"")
  676. if job.cxxflags:
  677. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags)}\"")
  678. if job.ldflags:
  679. job.cmake_arguments.append(f"-DCMAKE_SHARED_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  680. job.cmake_arguments.append(f"-DCMAKE_EXE_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  681. job.pretest_cmd = "\n".join(pretest_cmd)
  682. def tf(b):
  683. return "ON" if b else "OFF"
  684. if fpic is not None:
  685. job.cmake_arguments.append(f"-DCMAKE_POSITION_INDEPENDENT_CODE={tf(fpic)}")
  686. if job.no_cmake:
  687. job.cmake_arguments = []
  688. return job
  689. def spec_to_platform(spec: JobSpec, key: str, enable_artifacts: bool, trackmem_symbol_names: bool) -> dict[str, str|bool]:
  690. logger.info("spec=%r", spec)
  691. job = spec_to_job(spec, key=key, trackmem_symbol_names=trackmem_symbol_names)
  692. logger.info("job=%r", job)
  693. platform = job.to_workflow(enable_artifacts=enable_artifacts)
  694. logger.info("platform=%r", platform)
  695. return platform
  696. def main():
  697. parser = argparse.ArgumentParser(allow_abbrev=False)
  698. parser.add_argument("--github-variable-prefix", default="platforms")
  699. parser.add_argument("--github-ci", action="store_true")
  700. parser.add_argument("--verbose", action="store_true")
  701. parser.add_argument("--commit-message-file")
  702. parser.add_argument("--no-artifact", dest="enable_artifacts", action="store_false")
  703. parser.add_argument("--trackmem-symbol-names", dest="trackmem_symbol_names", action="store_true")
  704. args = parser.parse_args()
  705. logging.basicConfig(level=logging.INFO if args.verbose else logging.WARNING)
  706. remaining_keys = set(JOB_SPECS.keys())
  707. all_level_keys = (
  708. # Level 1
  709. (
  710. "haiku",
  711. ),
  712. )
  713. filters = []
  714. if args.commit_message_file:
  715. with open(args.commit_message_file, "r") as f:
  716. commit_message = f.read()
  717. for m in re.finditer(r"\[sdl-ci-filter (.*)]", commit_message, flags=re.M):
  718. filters.append(m.group(1).strip(" \t\n\r\t'\""))
  719. if re.search(r"\[sdl-ci-artifacts?]", commit_message, flags=re.M):
  720. args.enable_artifacts = True
  721. if re.search(r"\[sdl-ci-(full-)?trackmem(-symbol-names)?]", commit_message, flags=re.M):
  722. args.trackmem_symbol_names = True
  723. if not filters:
  724. filters.append("*")
  725. logger.info("filters: %r", filters)
  726. all_level_platforms = {}
  727. 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()}
  728. for level_i, level_keys in enumerate(all_level_keys, 1):
  729. level_key = f"level{level_i}"
  730. logger.info("Level %d: keys=%r", level_i, level_keys)
  731. assert all(k in remaining_keys for k in level_keys)
  732. level_platforms = tuple(all_platforms[key] for key in level_keys)
  733. remaining_keys.difference_update(level_keys)
  734. all_level_platforms[level_key] = level_platforms
  735. logger.info("=" * 80)
  736. logger.info("Keys before filter: %r", remaining_keys)
  737. filtered_remaining_keys = set()
  738. for filter in filters:
  739. filtered_remaining_keys.update(fnmatch.filter(remaining_keys, filter))
  740. logger.info("Keys after filter: %r", filtered_remaining_keys)
  741. remaining_keys = filtered_remaining_keys
  742. logger.info("Remaining: %r", remaining_keys)
  743. all_level_platforms["others"] = tuple(all_platforms[key] for key in remaining_keys)
  744. if args.github_ci:
  745. for level, platforms in all_level_platforms.items():
  746. platforms_json = json.dumps(platforms)
  747. txt = f"{args.github_variable_prefix}-{level}={platforms_json}"
  748. logger.info("%s", txt)
  749. if "GITHUB_OUTPUT" in os.environ:
  750. with open(os.environ["GITHUB_OUTPUT"], "a") as f:
  751. f.write(txt)
  752. f.write("\n")
  753. else:
  754. logger.warning("GITHUB_OUTPUT not defined")
  755. return 0
  756. if __name__ == "__main__":
  757. raise SystemExit(main())