feat: add configuration option for test executor arguments (#2636)
* Add test-execution-args option. * Add usage of test-execution-args. * Add CI configuration to use test-execution-args. * Document the test-execution-args setting. * Simplify code using or syntax instead of inline if. Co-authored-by: Malcolm Smith <smith@chaquo.com> * Clarified some Android-specific terminology, and added details about the default args to the test runner. * Switch to a dict-based test-execution configuration * Add tests for test-execution parsing. * Add all the files before pushing... * Add note about default Android version for testbed. * Improve description of test-execution setting. Co-authored-by: Joe Rickerby <joerick@mac.com> * Switch to using test-runtime. --------- Co-authored-by: Malcolm Smith <smith@chaquo.com> Co-authored-by: Joe Rickerby <joerick@mac.com>
This commit is contained in:
Russell Keith-Magee
co-authored by
Malcolm Smith
Joe Rickerby
Malcolm Smith
Joe Rickerby
parent
c53e541c2d
commit
4fe7630d9c
+31
-1
@@ -24,7 +24,7 @@ from .projectfiles import get_requires_python_str, resolve_dependency_groups
|
||||
from .selector import BuildSelector, EnableGroup, TestSelector, selector_matches
|
||||
from .typing import PLATFORMS, PlatformName
|
||||
from .util import resources
|
||||
from .util.helpers import format_safe, strtobool, unwrap
|
||||
from .util.helpers import format_safe, parse_key_value_string, strtobool, unwrap
|
||||
from .util.packaging import DependencyConstraints
|
||||
|
||||
MANYLINUX_ARCHS: Final[tuple[str, ...]] = (
|
||||
@@ -92,6 +92,20 @@ class GlobalOptions:
|
||||
allow_empty: bool
|
||||
|
||||
|
||||
@dataclasses.dataclass(frozen=True)
|
||||
class TestRuntimeConfig:
|
||||
args: Sequence[str] = ()
|
||||
|
||||
@classmethod
|
||||
def from_config_string(cls, config_string: str) -> Self:
|
||||
config_dict = parse_key_value_string(config_string, [], ["args"])
|
||||
args = config_dict.get("args") or []
|
||||
return cls(args=args)
|
||||
|
||||
def options_summary(self) -> str | dict[str, str]:
|
||||
return {"args": repr(self.args)}
|
||||
|
||||
|
||||
@dataclasses.dataclass(frozen=True, kw_only=True)
|
||||
class BuildOptions:
|
||||
globals: GlobalOptions
|
||||
@@ -110,6 +124,7 @@ class BuildOptions:
|
||||
test_extras: str
|
||||
test_groups: list[str]
|
||||
test_environment: ParsedEnvironment
|
||||
test_runtime: TestRuntimeConfig
|
||||
build_verbosity: int
|
||||
build_frontend: BuildFrontendConfig
|
||||
config_settings: str
|
||||
@@ -761,6 +776,20 @@ class Options:
|
||||
msg = f"Malformed environment option {test_environment_config!r}"
|
||||
raise errors.ConfigurationError(msg) from e
|
||||
|
||||
test_runtime_str = self.reader.get(
|
||||
"test-runtime",
|
||||
env_plat=False,
|
||||
option_format=ShlexTableFormat(sep="; ", pair_sep=":", allow_merge=False),
|
||||
)
|
||||
if not test_runtime_str:
|
||||
test_runtime = TestRuntimeConfig()
|
||||
else:
|
||||
try:
|
||||
test_runtime = TestRuntimeConfig.from_config_string(test_runtime_str)
|
||||
except ValueError as e:
|
||||
msg = f"Failed to parse test runtime config. {e}"
|
||||
raise errors.ConfigurationError(msg) from e
|
||||
|
||||
test_requires = self.reader.get(
|
||||
"test-requires", option_format=ListFormat(sep=" ")
|
||||
).split()
|
||||
@@ -868,6 +897,7 @@ class Options:
|
||||
test_command=test_command,
|
||||
test_sources=test_sources,
|
||||
test_environment=test_environment,
|
||||
test_runtime=test_runtime,
|
||||
test_requires=[*test_requires, *test_requirements_from_groups],
|
||||
test_extras=test_extras,
|
||||
test_groups=test_groups,
|
||||
|
||||
@@ -638,17 +638,27 @@ def test_wheel(state: BuildState, wheel: Path) -> None:
|
||||
)
|
||||
raise errors.FatalError(msg)
|
||||
|
||||
# By default, run on a testbed managed emulator running the newest supported
|
||||
# Android version. However, if the user specifies a --managed or --connected
|
||||
# test execution argument, that argument takes precedence.
|
||||
test_runtime_args = state.options.test_runtime.args
|
||||
|
||||
if any(arg.startswith(("--managed", "--connected")) for arg in test_runtime_args):
|
||||
emulator_args = []
|
||||
else:
|
||||
emulator_args = ["--managed", "maxVersion"]
|
||||
|
||||
# Run the test app.
|
||||
call(
|
||||
state.python_dir / "android.py",
|
||||
"test",
|
||||
"--managed",
|
||||
"maxVersion",
|
||||
"--site-packages",
|
||||
site_packages_dir,
|
||||
"--cwd",
|
||||
cwd_dir,
|
||||
*emulator_args,
|
||||
*(["-v"] if state.options.build_verbosity > 0 else []),
|
||||
*test_runtime_args,
|
||||
"--",
|
||||
*test_args,
|
||||
env=state.build_env,
|
||||
|
||||
@@ -2,6 +2,7 @@ from __future__ import annotations
|
||||
|
||||
import dataclasses
|
||||
import os
|
||||
import platform
|
||||
import shlex
|
||||
import shutil
|
||||
import subprocess
|
||||
@@ -653,11 +654,35 @@ def build(options: Options, tmp_path: Path) -> None:
|
||||
)
|
||||
raise errors.FatalError(msg)
|
||||
|
||||
test_runtime_args = build_options.test_runtime.args
|
||||
|
||||
# 2025-10: The GitHub Actions macos-15 runner has a known issue where
|
||||
# the default simulator won't start due to a disk performance issue;
|
||||
# see https://github.com/actions/runner-images/issues/12777 for details.
|
||||
# In the meantime, if it looks like we're running on a GitHub Actions
|
||||
# macos-15 runner, use a simulator that is known to work, unless the
|
||||
# user explicitly specifies a simulator.
|
||||
os_version, _, arch = platform.mac_ver()
|
||||
if (
|
||||
"GITHUB_ACTIONS" in os.environ
|
||||
and os_version.startswith("15.")
|
||||
and arch == "arm64"
|
||||
and not any(
|
||||
arg.startswith("--simulator") for arg in test_runtime_args
|
||||
)
|
||||
):
|
||||
test_runtime_args = [
|
||||
"--simulator",
|
||||
"iPhone 16e,OS=18.5",
|
||||
*test_runtime_args,
|
||||
]
|
||||
|
||||
call(
|
||||
"python",
|
||||
testbed_path,
|
||||
"run",
|
||||
*(["--verbose"] if build_options.build_verbosity > 0 else []),
|
||||
*test_runtime_args,
|
||||
"--",
|
||||
*final_command,
|
||||
env=test_env,
|
||||
|
||||
@@ -569,6 +569,39 @@
|
||||
],
|
||||
"title": "CIBW_TEST_ENVIRONMENT"
|
||||
},
|
||||
"test-runtime": {
|
||||
"description": "Additional configuration for the test runner",
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"pattern": "^$"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": false
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"pattern": "args:"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"args"
|
||||
],
|
||||
"properties": {
|
||||
"args": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"title": "CIBW_TEST_RUNTIME"
|
||||
},
|
||||
"overrides": {
|
||||
"type": "array",
|
||||
"description": "An overrides array",
|
||||
@@ -638,6 +671,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/$defs/inherit"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/$defs/inherit"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -748,6 +784,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -876,6 +915,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -936,6 +978,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1009,6 +1054,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1069,6 +1117,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1129,6 +1180,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1189,6 +1243,9 @@
|
||||
},
|
||||
"test-environment": {
|
||||
"$ref": "#/properties/test-environment"
|
||||
},
|
||||
"test-runtime": {
|
||||
"$ref": "#/properties/test-runtime"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,6 +25,7 @@ test-requires = []
|
||||
test-extras = []
|
||||
test-groups = []
|
||||
test-environment = {}
|
||||
test-runtime = {}
|
||||
|
||||
container-engine = "docker"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user