create-test-plan.py 34 KB

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