create-test-plan.py 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818
  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. Macos12 = "macos-12"
  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. uwp: bool = False
  82. gdk: bool = False
  83. vita_gles: Optional[VitaGLES] = None
  84. JOB_SPECS = {
  85. "msys2-mingw32": JobSpec(name="Windows (msys2, mingw32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32", msys2_platform=Msys2Platform.Mingw32, ),
  86. "msys2-mingw64": JobSpec(name="Windows (msys2, mingw64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64", msys2_platform=Msys2Platform.Mingw64, ),
  87. "msys2-clang32": JobSpec(name="Windows (msys2, clang32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32-clang", msys2_platform=Msys2Platform.Clang32, ),
  88. "msys2-clang64": JobSpec(name="Windows (msys2, clang64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-clang", msys2_platform=Msys2Platform.Clang64, ),
  89. "msys2-ucrt64": JobSpec(name="Windows (msys2, ucrt64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-ucrt", msys2_platform=Msys2Platform.Ucrt64, ),
  90. "msvc-x64": JobSpec(name="Windows (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-x64", msvc_arch=MsvcArch.X64, msvc_project="VisualC/SDL.sln", ),
  91. "msvc-x86": JobSpec(name="Windows (MSVC, x86)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-x86", msvc_arch=MsvcArch.X86, msvc_project="VisualC/SDL.sln", ),
  92. "msvc-clang-x64": JobSpec(name="Windows (MSVC, clang-cl x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-clang-cl-x64", msvc_arch=MsvcArch.X64, clang_cl=True, ),
  93. "msvc-clang-x86": JobSpec(name="Windows (MSVC, clang-cl x86)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-clang-cl-x86", msvc_arch=MsvcArch.X86, clang_cl=True, ),
  94. "msvc-arm32": JobSpec(name="Windows (MSVC, ARM)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm32", msvc_arch=MsvcArch.Arm32, ),
  95. "msvc-arm64": JobSpec(name="Windows (MSVC, ARM64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm64", msvc_arch=MsvcArch.Arm64, ),
  96. "msvc-uwp-x64": JobSpec(name="UWP (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-UWP", msvc_arch=MsvcArch.X64, msvc_project="VisualC-WinRT/SDL-UWP.sln", uwp=True, ),
  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-intel-icx": JobSpec(name="Ubuntu 20.04 (Intel oneAPI)", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-oneapi", intel=IntelCompiler.Icx, ),
  101. "ubuntu-intel-icc": JobSpec(name="Ubuntu 20.04 (Intel Compiler)", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-icc", intel=IntelCompiler.Icc, ),
  102. "macos-framework-x64": JobSpec(name="MacOS (Framework) (x64)", os=JobOs.Macos12, platform=SdlPlatform.MacOS, artifact="SDL-macos-framework", apple_framework=True, apple_archs={AppleArch.Aarch64, AppleArch.X86_64, }, xcode=True, ),
  103. "macos-framework-arm64": JobSpec(name="MacOS (Framework) (arm64)", os=JobOs.MacosLatest, platform=SdlPlatform.MacOS, artifact=None, apple_framework=True, apple_archs={AppleArch.Aarch64, AppleArch.X86_64, }, ),
  104. "macos-gnu-arm64": JobSpec(name="MacOS (GNU prefix)", os=JobOs.MacosLatest, platform=SdlPlatform.MacOS, artifact="SDL-macos-arm64-gnu", apple_framework=False, apple_archs={AppleArch.Aarch64, }, ),
  105. "ios": JobSpec(name="iOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Ios, artifact="SDL-ios-arm64", xcode=True, ),
  106. "tvos": JobSpec(name="tvOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Tvos, artifact="SDL-tvos-arm64", xcode=True, ),
  107. "android-cmake": JobSpec(name="Android (CMake)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact="SDL-android-arm64", android_abi="arm64-v8a", android_arch="aarch64", android_platform=23, ),
  108. "android-cmake-lean": JobSpec(name="Android (CMake, lean)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact="SDL-lean-android-arm64", android_abi="arm64-v8a", android_arch="aarch64", android_platform=23, lean=True, ),
  109. "android-mk": JobSpec(name="Android (Android.mk)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_mk=True, ),
  110. "android-gradle": JobSpec(name="Android (Gradle)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_gradle=True, ),
  111. "emscripten": JobSpec(name="Emscripten", os=JobOs.UbuntuLatest, platform=SdlPlatform.Emscripten, artifact="SDL-emscripten", ),
  112. "haiku": JobSpec(name="Haiku", os=JobOs.UbuntuLatest, platform=SdlPlatform.Haiku, artifact="SDL-haiku-x64", container="haiku/cross-compiler:x86_64-r1beta4", ),
  113. "loongarch64": JobSpec(name="LoongArch64", os=JobOs.UbuntuLatest, platform=SdlPlatform.LoongArch64, artifact="SDL-loongarch64", ),
  114. "n3ds": JobSpec(name="Nintendo 3DS", os=JobOs.UbuntuLatest, platform=SdlPlatform.N3ds, artifact="SDL-n3ds", container="devkitpro/devkitarm:latest", ),
  115. "ppc64": JobSpec(name="PowerPC64", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC64, artifact="SDL-ppc64le", container="dockcross/linux-ppc64le:latest", ),
  116. "ps2": JobSpec(name="Sony PlayStation 2", os=JobOs.UbuntuLatest, platform=SdlPlatform.Ps2, artifact="SDL-ps2", container="ps2dev/ps2dev:latest", ),
  117. "psp": JobSpec(name="Sony PlayStation Portable", os=JobOs.UbuntuLatest, platform=SdlPlatform.Psp, artifact="SDL-psp", container="pspdev/pspdev:latest", ),
  118. "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, ),
  119. "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, ),
  120. "riscos": JobSpec(name="RISC OS", os=JobOs.UbuntuLatest, platform=SdlPlatform.Riscos, artifact="SDL-riscos", container="riscosdotinfo/riscos-gccsdk-4.7:latest", ),
  121. "netbsd": JobSpec(name="NetBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.NetBSD, artifact="SDL-netbsd-x64", ),
  122. "freebsd": JobSpec(name="FreeBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.FreeBSD, artifact="SDL-freebsd-x64", ),
  123. }
  124. class StaticLibType(Enum):
  125. MSVC = "SDL3-static.lib"
  126. A = "libSDL3.a"
  127. class SharedLibType(Enum):
  128. WIN32 = "SDL3.dll"
  129. SO_0 = "libSDL3.so.0"
  130. SO = "libSDL3.so"
  131. DYLIB = "libSDL3.0.dylib"
  132. FRAMEWORK = "SDL3.framework/Versions/A/SDL3"
  133. @dataclasses.dataclass(slots=True)
  134. class JobDetails:
  135. name: str
  136. key: str
  137. os: str
  138. platform: str
  139. artifact: str
  140. no_cmake: bool
  141. build_tests: bool = True
  142. container: str = ""
  143. cmake_build_type: str = "RelWithDebInfo"
  144. shell: str = "sh"
  145. sudo: str = "sudo"
  146. cmake_config_emulator: str = ""
  147. apk_packages: list[str] = dataclasses.field(default_factory=list)
  148. apt_packages: list[str] = dataclasses.field(default_factory=list)
  149. brew_packages: list[str] = dataclasses.field(default_factory=list)
  150. cmake_toolchain_file: str = ""
  151. cmake_arguments: list[str] = dataclasses.field(default_factory=list)
  152. cmake_build_arguments: list[str] = dataclasses.field(default_factory=list)
  153. clang_tidy: bool = True
  154. cppflags: list[str] = dataclasses.field(default_factory=list)
  155. cc: str = ""
  156. cxx: str = ""
  157. cflags: list[str] = dataclasses.field(default_factory=list)
  158. cxxflags: list[str] = dataclasses.field(default_factory=list)
  159. ldflags: list[str] = dataclasses.field(default_factory=list)
  160. pollute_directories: list[str] = dataclasses.field(default_factory=list)
  161. use_cmake: bool = True
  162. shared: bool = True
  163. static: bool = True
  164. shared_lib: Optional[SharedLibType] = None
  165. static_lib: Optional[StaticLibType] = None
  166. run_tests: bool = True
  167. test_pkg_config: bool = True
  168. cc_from_cmake: bool = False
  169. source_cmd: str = ""
  170. pretest_cmd: str = ""
  171. java: bool = False
  172. android_apks: list[str] = dataclasses.field(default_factory=list)
  173. android_ndk: bool = False
  174. android_mk: bool = False
  175. android_gradle: bool = False
  176. minidump: bool = False
  177. intel: bool = False
  178. msys2_msystem: str = ""
  179. msys2_env: str = ""
  180. msys2_no_perl: bool = False
  181. werror: bool = True
  182. msvc_vcvars: str = ""
  183. msvc_project: str = ""
  184. msvc_project_flags: list[str] = dataclasses.field(default_factory=list)
  185. setup_ninja: bool = False
  186. setup_libusb_arch: str = ""
  187. xcode_sdk: str = ""
  188. cpactions: bool = False
  189. setup_gdk_folder: str = ""
  190. cpactions_os: str = ""
  191. cpactions_version: str = ""
  192. cpactions_arch: str = ""
  193. cpactions_setup_cmd: str = ""
  194. cpactions_install_cmd: str = ""
  195. setup_vita_gles_type: str = ""
  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. }
  258. return {k: v for k, v in data.items() if v != ""}
  259. def my_shlex_join(s):
  260. def escape(s):
  261. if s[:1] == "'" and s[-1:] == "'":
  262. return s
  263. if set(s).intersection(set("; \t")):
  264. return f'"{s}"'
  265. return s
  266. return " ".join(escape(s))
  267. def spec_to_job(spec: JobSpec, key: str, trackmem_symbol_names: bool) -> JobDetails:
  268. job = JobDetails(
  269. name=spec.name,
  270. key=key,
  271. os=spec.os.value,
  272. artifact=spec.artifact or "",
  273. container=spec.container or "",
  274. platform=spec.platform.value,
  275. sudo="sudo",
  276. no_cmake=spec.no_cmake,
  277. )
  278. if job.os.startswith("ubuntu"):
  279. job.apt_packages.extend([
  280. "ninja-build",
  281. "pkg-config",
  282. ])
  283. pretest_cmd = []
  284. if trackmem_symbol_names:
  285. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=1")
  286. else:
  287. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=0")
  288. win32 = spec.platform in (SdlPlatform.Msys2, SdlPlatform.Msvc)
  289. fpic = None
  290. build_parallel = True
  291. if spec.lean:
  292. job.cppflags.append("-DSDL_LEAN_AND_MEAN=1")
  293. if win32:
  294. job.cmake_arguments.append("-DSDLTEST_PROCDUMP=ON")
  295. job.minidump = True
  296. if spec.intel is not None:
  297. match spec.intel:
  298. case IntelCompiler.Icx:
  299. job.cc = "icx"
  300. job.cxx = "icpx"
  301. case IntelCompiler.Icc:
  302. job.cc = "icc"
  303. job.cxx = "icpc"
  304. job.cppflags.append("-diag-disable=10441")
  305. job.clang_tidy = False
  306. case _:
  307. raise ValueError(f"Invalid intel={spec.intel}")
  308. job.source_cmd = f"source /opt/intel/oneapi/setvars.sh;"
  309. job.intel = True
  310. job.shell = "bash"
  311. job.cmake_arguments.extend((
  312. f"-DCMAKE_C_COMPILER={job.cc}",
  313. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  314. "-DCMAKE_SYSTEM_NAME=Linux",
  315. ))
  316. match spec.platform:
  317. case SdlPlatform.Msvc:
  318. job.setup_ninja = not spec.gdk
  319. job.clang_tidy = False # complains about \threadsafety: "unknown command tag name [clang-diagnostic-documentation-unknown-command]"
  320. job.msvc_project = spec.msvc_project if spec.msvc_project else ""
  321. job.msvc_project_flags.append("-p:TreatWarningsAsError=true")
  322. job.test_pkg_config = False
  323. job.shared_lib = SharedLibType.WIN32
  324. job.static_lib = StaticLibType.MSVC
  325. job.cmake_arguments.extend((
  326. "-DCMAKE_MSVC_DEBUG_INFORMATION_FORMAT=ProgramDatabase",
  327. "-DCMAKE_EXE_LINKER_FLAGS=-DEBUG",
  328. "-DCMAKE_SHARED_LINKER_FLAGS=-DEBUG",
  329. ))
  330. if spec.uwp:
  331. job.cmake_arguments.append("'-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded$<$<CONFIG:Debug>:Debug>DLL'")
  332. else:
  333. job.cmake_arguments.append("'-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded$<$<CONFIG:Debug>:Debug>'")
  334. if spec.clang_cl:
  335. job.cmake_arguments.extend((
  336. "-DCMAKE_C_COMPILER=clang-cl",
  337. "-DCMAKE_CXX_COMPILER=clang-cl",
  338. ))
  339. match spec.msvc_arch:
  340. case MsvcArch.X86:
  341. job.cflags.append("/clang:-m32")
  342. job.ldflags.append("/MACHINE:X86")
  343. case MsvcArch.X64:
  344. job.cflags.append("/clang:-m64")
  345. job.ldflags.append("/MACHINE:X64")
  346. case _:
  347. raise ValueError(f"Unsupported clang-cl architecture (arch={spec.msvc_arch})")
  348. if spec.msvc_project:
  349. match spec.msvc_arch:
  350. case MsvcArch.X86:
  351. msvc_platform = "Win32"
  352. case MsvcArch.X64:
  353. msvc_platform = "x64"
  354. case _:
  355. raise ValueError(f"Unsupported vcxproj architecture (arch={spec.msvc_arch})")
  356. if spec.gdk:
  357. msvc_platform = f"Gaming.Desktop.{msvc_platform}"
  358. job.msvc_project_flags.append(f"-p:Platform={msvc_platform}")
  359. match spec.msvc_arch:
  360. case MsvcArch.X86:
  361. job.msvc_vcvars = "x64_x86"
  362. case MsvcArch.X64:
  363. job.msvc_vcvars = "x64"
  364. case MsvcArch.Arm32:
  365. job.msvc_vcvars = "x64_arm"
  366. job.run_tests = False
  367. case MsvcArch.Arm64:
  368. job.msvc_vcvars = "x64_arm64"
  369. job.run_tests = False
  370. if spec.uwp:
  371. job.build_tests = False
  372. job.cmake_arguments.extend((
  373. "-DCMAKE_SYSTEM_NAME=WindowsStore",
  374. "-DCMAKE_SYSTEM_VERSION=10.0",
  375. ))
  376. job.msvc_project_flags.append("-p:WindowsTargetPlatformVersion=10.0.17763.0")
  377. elif spec.gdk:
  378. job.setup_gdk_folder = "VisualC-GDK"
  379. else:
  380. match spec.msvc_arch:
  381. case MsvcArch.X86:
  382. job.setup_libusb_arch = "x86"
  383. case MsvcArch.X64:
  384. job.setup_libusb_arch = "x64"
  385. case SdlPlatform.Linux:
  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. if trackmem_symbol_names:
  414. # older libunwind is slow
  415. job.cmake_arguments.append("-DSDLTEST_TIMEOUT_MULTIPLIER=2")
  416. job.apt_packages.extend((
  417. "libunwind-dev", # For SDL_test memory tracking
  418. ))
  419. job.shared_lib = SharedLibType.SO_0
  420. job.static_lib = StaticLibType.A
  421. fpic = True
  422. assert spec.os.value.startswith("ubuntu-")
  423. ubuntu_year, ubuntu_month = [int(v) for v in spec.os.value.removeprefix("ubuntu-").split(".", 1)]
  424. if ubuntu_year >= 22:
  425. job.apt_packages.extend(("libpipewire-0.3-dev", "libdecor-0-dev"))
  426. case SdlPlatform.Ios | SdlPlatform.Tvos:
  427. job.brew_packages.extend([
  428. "ninja",
  429. "pkg-config",
  430. ])
  431. job.clang_tidy = False
  432. job.run_tests = False
  433. job.test_pkg_config = False
  434. job.shared_lib = SharedLibType.DYLIB
  435. job.static_lib = StaticLibType.A
  436. match spec.platform:
  437. case SdlPlatform.Ios:
  438. if spec.xcode:
  439. job.xcode_sdk = 'iphoneos'
  440. job.cmake_arguments.extend([
  441. "-DCMAKE_SYSTEM_NAME=iOS",
  442. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  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. ])
  451. case SdlPlatform.MacOS:
  452. if spec.apple_framework:
  453. job.static = False
  454. job.clang_tidy = False
  455. job.test_pkg_config = False
  456. job.cmake_arguments.extend((
  457. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  458. "-DSDL_FRAMEWORK=ON",
  459. ))
  460. job.shared_lib = SharedLibType.FRAMEWORK
  461. else:
  462. job.clang_tidy = True
  463. job.cmake_arguments.extend((
  464. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  465. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  466. ))
  467. job.shared_lib = SharedLibType.DYLIB
  468. job.static_lib = StaticLibType.A
  469. job.apt_packages = []
  470. job.brew_packages.append("ninja")
  471. if job.test_pkg_config:
  472. job.brew_packages.append("pkg-config")
  473. if job.clang_tidy:
  474. job.brew_packages.append("llvm")
  475. if spec.xcode:
  476. job.xcode_sdk = "macosx"
  477. case SdlPlatform.Android:
  478. job.android_gradle = spec.android_gradle
  479. job.android_mk = spec.android_mk
  480. job.run_tests = False
  481. job.shared_lib = SharedLibType.SO
  482. job.static_lib = StaticLibType.A
  483. if spec.android_mk or not spec.no_cmake:
  484. job.android_ndk = True
  485. if spec.android_gradle or not spec.no_cmake:
  486. job.java = True
  487. if spec.android_mk or spec.android_gradle:
  488. job.apt_packages = []
  489. if not spec.no_cmake:
  490. job.cmake_arguments.extend((
  491. f"-DANDROID_PLATFORM={spec.android_platform}",
  492. f"-DANDROID_ABI={spec.android_abi}",
  493. ))
  494. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  495. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  496. job.android_apks = [
  497. "testaudiorecording-apk",
  498. "testautomation-apk",
  499. "testcontroller-apk",
  500. "testmultiaudio-apk",
  501. "testsprite-apk",
  502. ]
  503. case SdlPlatform.Emscripten:
  504. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  505. job.shared = False
  506. job.cmake_config_emulator = "emcmake"
  507. job.cmake_build_type = "Debug"
  508. job.test_pkg_config = False
  509. job.apt_packages.append("python3-selenium")
  510. job.cmake_arguments.extend((
  511. "-DSDLTEST_BROWSER=chrome",
  512. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  513. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  514. ))
  515. job.cflags.extend((
  516. "-gsource-map",
  517. "-ffile-prefix-map=${PWD}=/SDL",
  518. ))
  519. job.ldflags.extend((
  520. "--source-map-base", "/",
  521. ))
  522. pretest_cmd.extend((
  523. "# Start local HTTP server",
  524. "cmake --build build --target serve-sdl-tests --verbose &",
  525. "chrome --version",
  526. "chromedriver --version",
  527. ))
  528. job.static_lib = StaticLibType.A
  529. case SdlPlatform.Ps2:
  530. build_parallel = False
  531. job.shared = False
  532. job.sudo = ""
  533. job.apt_packages = []
  534. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  535. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  536. job.clang_tidy = False
  537. job.run_tests = False
  538. job.shared = False
  539. job.cc = "mips64r5900el-ps2-elf-gcc"
  540. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  541. job.static_lib = StaticLibType.A
  542. case SdlPlatform.Psp:
  543. build_parallel = False
  544. job.sudo = ""
  545. job.apt_packages = []
  546. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  547. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  548. job.clang_tidy = False
  549. job.run_tests = False
  550. job.shared = False
  551. job.cc = "psp-gcc"
  552. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  553. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  554. job.static_lib = StaticLibType.A
  555. case SdlPlatform.Vita:
  556. job.sudo = ""
  557. job.apt_packages = []
  558. job.apk_packages = ["cmake", "ninja", "pkgconf", "bash", "tar"]
  559. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  560. assert spec.vita_gles is not None
  561. job.setup_vita_gles_type = {
  562. VitaGLES.Pib: "pib",
  563. VitaGLES.Pvr: "pvr",
  564. }[spec.vita_gles]
  565. job.cmake_arguments.extend((
  566. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  567. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  568. "-DSDL_ARMNEON=ON",
  569. "-DSDL_ARMSIMD=ON",
  570. ))
  571. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  572. 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"""
  573. job.clang_tidy = False
  574. job.run_tests = False
  575. job.shared = False
  576. job.cc = "arm-vita-eabi-gcc"
  577. job.static_lib = StaticLibType.A
  578. case SdlPlatform.Haiku:
  579. fpic = False
  580. job.run_tests = False
  581. job.cc = "x86_64-unknown-haiku-gcc"
  582. job.cxx = "x86_64-unknown-haiku-g++"
  583. job.sudo = ""
  584. job.cmake_arguments.extend((
  585. f"-DCMAKE_C_COMPILER={job.cc}",
  586. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  587. "-DCMAKE_SYSTEM_NAME=Haiku",
  588. ))
  589. job.shared_lib = SharedLibType.SO_0
  590. job.static_lib = StaticLibType.A
  591. case SdlPlatform.PowerPC64:
  592. # FIXME: Enable SDL_WERROR
  593. job.werror = False
  594. job.clang_tidy = False
  595. job.run_tests = False
  596. job.sudo = ""
  597. job.apt_packages = []
  598. job.shared_lib = SharedLibType.SO_0
  599. job.static_lib = StaticLibType.A
  600. case SdlPlatform.LoongArch64:
  601. job.run_tests = False
  602. job.cc = "${LOONGARCH64_CC}"
  603. job.cxx = "${LOONGARCH64_CXX}"
  604. job.cmake_arguments.extend((
  605. f"-DCMAKE_C_COMPILER={job.cc}",
  606. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  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 not build_parallel:
  675. job.cmake_build_arguments.append("-j1")
  676. if job.cflags:
  677. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags)}\"")
  678. if job.cxxflags:
  679. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags)}\"")
  680. if job.ldflags:
  681. job.cmake_arguments.append(f"-DCMAKE_SHARED_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  682. job.cmake_arguments.append(f"-DCMAKE_EXE_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  683. job.pretest_cmd = "\n".join(pretest_cmd)
  684. def tf(b):
  685. return "ON" if b else "OFF"
  686. if fpic is not None:
  687. job.cmake_arguments.append(f"-DCMAKE_POSITION_INDEPENDENT_CODE={tf(fpic)}")
  688. if job.no_cmake:
  689. job.cmake_arguments = []
  690. return job
  691. def spec_to_platform(spec: JobSpec, key: str, enable_artifacts: bool, trackmem_symbol_names: bool) -> dict[str, str|bool]:
  692. logger.info("spec=%r", spec)
  693. job = spec_to_job(spec, key=key, trackmem_symbol_names=trackmem_symbol_names)
  694. logger.info("job=%r", job)
  695. platform = job.to_workflow(enable_artifacts=enable_artifacts)
  696. logger.info("platform=%r", platform)
  697. return platform
  698. def main():
  699. parser = argparse.ArgumentParser(allow_abbrev=False)
  700. parser.add_argument("--github-variable-prefix", default="platforms")
  701. parser.add_argument("--github-ci", action="store_true")
  702. parser.add_argument("--verbose", action="store_true")
  703. parser.add_argument("--commit-message-file")
  704. parser.add_argument("--no-artifact", dest="enable_artifacts", action="store_false")
  705. parser.add_argument("--trackmem-symbol-names", dest="trackmem_symbol_names", action="store_true")
  706. args = parser.parse_args()
  707. logging.basicConfig(level=logging.INFO if args.verbose else logging.WARNING)
  708. remaining_keys = set(JOB_SPECS.keys())
  709. all_level_keys = (
  710. # Level 1
  711. (
  712. "haiku",
  713. ),
  714. )
  715. filters = []
  716. if args.commit_message_file:
  717. with open(args.commit_message_file, "r") as f:
  718. commit_message = f.read()
  719. for m in re.finditer(r"\[sdl-ci-filter (.*)]", commit_message, flags=re.M):
  720. filters.append(m.group(1).strip(" \t\n\r\t'\""))
  721. if re.search(r"\[sdl-ci-artifacts?]", commit_message, flags=re.M):
  722. args.enable_artifacts = True
  723. if re.search(r"\[sdl-ci-(full-)?trackmem(-symbol-names)?]", commit_message, flags=re.M):
  724. args.trackmem_symbol_names = True
  725. if not filters:
  726. filters.append("*")
  727. logger.info("filters: %r", filters)
  728. all_level_platforms = {}
  729. 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()}
  730. for level_i, level_keys in enumerate(all_level_keys, 1):
  731. level_key = f"level{level_i}"
  732. logger.info("Level %d: keys=%r", level_i, level_keys)
  733. assert all(k in remaining_keys for k in level_keys)
  734. level_platforms = tuple(all_platforms[key] for key in level_keys)
  735. remaining_keys.difference_update(level_keys)
  736. all_level_platforms[level_key] = level_platforms
  737. logger.info("=" * 80)
  738. logger.info("Keys before filter: %r", remaining_keys)
  739. filtered_remaining_keys = set()
  740. for filter in filters:
  741. filtered_remaining_keys.update(fnmatch.filter(remaining_keys, filter))
  742. logger.info("Keys after filter: %r", filtered_remaining_keys)
  743. remaining_keys = filtered_remaining_keys
  744. logger.info("Remaining: %r", remaining_keys)
  745. all_level_platforms["others"] = tuple(all_platforms[key] for key in remaining_keys)
  746. if args.github_ci:
  747. for level, platforms in all_level_platforms.items():
  748. platforms_json = json.dumps(platforms)
  749. txt = f"{args.github_variable_prefix}-{level}={platforms_json}"
  750. logger.info("%s", txt)
  751. if "GITHUB_OUTPUT" in os.environ:
  752. with open(os.environ["GITHUB_OUTPUT"], "a") as f:
  753. f.write(txt)
  754. f.write("\n")
  755. else:
  756. logger.warning("GITHUB_OUTPUT not defined")
  757. return 0
  758. if __name__ == "__main__":
  759. raise SystemExit(main())