create-test-plan.py 36 KB

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