create-test-plan.py 37 KB

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