create-test-plan.py 35 KB

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