Joe Rickerby
3a524160c3
* Fix a few bugs in run_example_ci_config tooling Github-deploy.yml had a fix to make it work out-of-the-box. * Add flaky marker on test_ssl (due to external internet access during the test, it does occasionally fail)
202 lines
6.9 KiB
Python
Executable File
202 lines
6.9 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
|
|
import os
|
|
import re
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
import textwrap
|
|
import time
|
|
import typing
|
|
from pathlib import Path
|
|
from urllib.parse import quote
|
|
|
|
import click
|
|
|
|
DIR = Path(__file__).parent.parent.resolve()
|
|
|
|
|
|
def shell(cmd: str, *, check: bool, **kwargs: object) -> subprocess.CompletedProcess[str]:
|
|
return subprocess.run([cmd], shell=True, check=check, **kwargs) # type: ignore[call-overload, no-any-return]
|
|
|
|
|
|
def git_repo_has_changes() -> bool:
|
|
unstaged_changes = shell("git diff-index --quiet HEAD --", check=False).returncode != 0
|
|
staged_changes = shell("git diff-index --quiet --cached HEAD --", check=False).returncode != 0
|
|
return unstaged_changes or staged_changes
|
|
|
|
|
|
def generate_basic_project(path: Path) -> None:
|
|
sys.path.insert(0, "")
|
|
from test.test_projects.c import new_c_project # noqa: PLC0415
|
|
|
|
project = new_c_project()
|
|
project.generate(path)
|
|
|
|
|
|
class CIService(typing.NamedTuple):
|
|
name: str
|
|
dst_config_path: str
|
|
badge_md: str
|
|
config_file_transform: typing.Callable[[str], str] = lambda x: x # identity by default
|
|
|
|
|
|
def github_config_file_transform(content: str) -> str:
|
|
# one of the the github configs only builds on main, so we need to remove that restriction
|
|
# so our example build will run on the test branch.
|
|
#
|
|
# replace:
|
|
# """
|
|
# push:
|
|
# branches:
|
|
# - main
|
|
# """
|
|
# with:
|
|
# """
|
|
# push:
|
|
# """"
|
|
content = re.sub(
|
|
r"push:\n\s+branches:\n\s+- main",
|
|
"push:",
|
|
content,
|
|
)
|
|
return content
|
|
|
|
|
|
services = [
|
|
CIService(
|
|
name="azure-pipelines",
|
|
dst_config_path="azure-pipelines.yml",
|
|
badge_md="[](https://dev.azure.com/joerick0429/cibuildwheel/_build/latest?definitionId=2&branchName={branch})",
|
|
),
|
|
CIService(
|
|
name="circleci",
|
|
dst_config_path=".circleci/config.yml",
|
|
badge_md="[](https://circleci.com/gh/pypa/cibuildwheel/tree/{branch})",
|
|
),
|
|
CIService(
|
|
name="github",
|
|
dst_config_path=".github/workflows/example.yml",
|
|
badge_md="[](https://github.com/pypa/cibuildwheel/actions?query=branch%3A{branch})",
|
|
config_file_transform=github_config_file_transform,
|
|
),
|
|
CIService(
|
|
name="travis-ci",
|
|
dst_config_path=".travis.yml",
|
|
badge_md="[](https://app.travis-ci.com/pypa/cibuildwheel)",
|
|
),
|
|
CIService(
|
|
name="gitlab",
|
|
dst_config_path=".gitlab-ci.yml",
|
|
badge_md="[](https://gitlab.com/joerick/cibuildwheel/-/commits/{branch})",
|
|
),
|
|
CIService(
|
|
name="cirrus-ci",
|
|
dst_config_path=".cirrus.yml",
|
|
badge_md="[](https://cirrus-ci.com/github/pypa/cibuildwheel/{branch})",
|
|
),
|
|
]
|
|
|
|
|
|
def ci_service_for_config_file(config_file: Path) -> CIService:
|
|
filename = config_file.name
|
|
try:
|
|
return next(s for s in services if filename.startswith(s.name))
|
|
except StopIteration:
|
|
msg = f"unknown ci service for config file {config_file}"
|
|
raise ValueError(msg) from None
|
|
|
|
|
|
@click.command()
|
|
@click.argument("config_files", nargs=-1, type=click.Path())
|
|
def run_example_ci_configs(config_files=None):
|
|
"""
|
|
Test the example configs. If no files are specified, will test
|
|
examples/*-minimal.yml
|
|
"""
|
|
|
|
if len(config_files) == 0:
|
|
config_files = Path("examples").glob("*-minimal.yml")
|
|
else:
|
|
config_files = [Path(f) for f in config_files]
|
|
|
|
# check each CI service has at most 1 config file
|
|
configs_by_service = set()
|
|
for config_file in config_files:
|
|
service = ci_service_for_config_file(config_file)
|
|
if service.name in configs_by_service:
|
|
msg = "You cannot specify more than one config per CI service"
|
|
raise Exception(msg)
|
|
configs_by_service.add(service.name)
|
|
|
|
if git_repo_has_changes():
|
|
print("Your git repo has uncommitted changes. Commit or stash before continuing.")
|
|
sys.exit(1)
|
|
|
|
previous_branch = shell(
|
|
"git rev-parse --abbrev-ref HEAD", check=True, capture_output=True, encoding="utf8"
|
|
).stdout.strip()
|
|
|
|
timestamp = time.strftime("%Y-%m-%dT%H-%M-%S", time.gmtime())
|
|
branch_name = f"example-config-test---{previous_branch}-{timestamp}"
|
|
|
|
try:
|
|
shell(f"git checkout --orphan {branch_name}", check=True)
|
|
|
|
example_project = Path("example_root")
|
|
generate_basic_project(example_project)
|
|
|
|
for config_file in config_files:
|
|
service = ci_service_for_config_file(config_file)
|
|
dst_config_file = example_project / service.dst_config_path
|
|
|
|
dst_config_file.parent.mkdir(parents=True, exist_ok=True)
|
|
|
|
contents = config_file.read_text(encoding="utf8")
|
|
contents = service.config_file_transform(contents)
|
|
dst_config_file.write_text(contents, encoding="utf8")
|
|
|
|
subprocess.run(["git", "add", example_project], check=True)
|
|
message = textwrap.dedent(
|
|
f"""\
|
|
Test example CI configs
|
|
|
|
Testing files: {[str(f) for f in config_files]}
|
|
Generated from branch: {previous_branch}
|
|
Time: {timestamp}
|
|
"""
|
|
)
|
|
subprocess.run(["git", "commit", "--no-verify", "--message", message], check=True)
|
|
shell(f"git subtree --prefix={example_project} push origin {branch_name}", check=True)
|
|
|
|
print("---")
|
|
print()
|
|
print("> **Examples test run**")
|
|
print("> ")
|
|
print(f"> Branch: [{branch_name}](https://github.com/pypa/cibuildwheel/tree/{branch_name})")
|
|
print("> ")
|
|
print("> | Service | Config | Status |")
|
|
print("> |---|---|---|")
|
|
for config_file in config_files:
|
|
service = ci_service_for_config_file(config_file)
|
|
badge = service.badge_md.format(
|
|
branch=branch_name, branch_escaped=quote(branch_name, safe="")
|
|
)
|
|
print(f"> | {service.name} | `{config_file}` | {badge} |")
|
|
print("> ")
|
|
print("> Generated by `bin/run_example_ci_config.py`")
|
|
print()
|
|
print("---")
|
|
finally:
|
|
# remove any local changes
|
|
shutil.rmtree(example_project, ignore_errors=True)
|
|
shell("git checkout -- .", check=True)
|
|
shell(f"git checkout {previous_branch}", check=True)
|
|
shell(f"git branch -D --force {branch_name}", check=True)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
os.chdir(DIR)
|
|
run_example_ci_configs(standalone_mode=True)
|