Skip to content

Commit

Permalink
[exp] make it work for any upstream repo (aptos-labs#10016)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rustielin
rustielin authored and Zekun Wang committed Oct 13, 2023
1 parent 5fb890c commit 33b1dab
Showing 1 changed file with 60 additions and 31 deletions.
91 changes: 60 additions & 31 deletions testsuite/exp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def get_gh_username(shell: Shell) -> str:
return ""


def wait_for_workflow(shell: Shell, branch: str, workflow_name: str) -> bool:
def wait_for_workflow(shell: Shell, branch: str, workflow_name: str, repo: str) -> bool:
"""Get the latest workflow run ID and wait for it to complete."""
# get the workflow run ID
gh_run_list_cmd = [
Expand All @@ -94,24 +94,22 @@ def wait_for_workflow(shell: Shell, branch: str, workflow_name: str) -> bool:
"--jq",
".[0].databaseId",
"--repo",
UPSTREAM_APTOS_CORE_REPO,
str,
]
gh_run_list_cmd_ret = shell.run(gh_run_list_cmd)
# get the URL
if not gh_run_list_cmd_ret.succeeded():
log.info("Failed to get workflow run ID")
return False
workflow_run_id = gh_run_list_cmd_ret.unwrap().decode().strip()
log.info(
f"Workflow URL: https://github.com/aptos-labs/aptos-core/actions/runs/{workflow_run_id}"
)
log.info(f"Workflow URL: https://github.com/{repo}/actions/runs/{workflow_run_id}")

workflow_success = False
iterations = WORKFLOW_WATCH_TIMEOUT_SECS // WORKFLOW_WATCH_INTERVAL_SECS
for i in range(iterations):
secs_remaining = (iterations - i) * WORKFLOW_WATCH_INTERVAL_SECS
log.info(
f"Checking workflow status: https://github.com/aptos-labs/aptos-core/actions/runs/{workflow_run_id} ({secs_remaining}s remaining)"
f"Checking workflow status: https://github.com/{repo}/actions/runs/{workflow_run_id} ({secs_remaining}s remaining)"
)
gh_run_view_cmd = [
"gh",
Expand All @@ -120,7 +118,7 @@ def wait_for_workflow(shell: Shell, branch: str, workflow_name: str) -> bool:
workflow_run_id,
"--log", # Exit with non-zero status if run fails
"--repo",
UPSTREAM_APTOS_CORE_REPO,
repo,
]
gh_run_view_cmd_ret = shell.run(gh_run_view_cmd)
if gh_run_view_cmd_ret.succeeded():
Expand All @@ -141,6 +139,7 @@ def workflow_dispatch_docker_build(
git_sha: str,
features: str,
profile: str,
repo: str,
dry_run: bool = False,
wait: bool = False,
) -> bool:
Expand All @@ -167,7 +166,7 @@ def workflow_dispatch_docker_build(
"--field",
f"BUILD_ADDL_TESTING_IMAGES={build_addl_testing_images}",
"--repo",
UPSTREAM_APTOS_CORE_REPO,
repo,
]
log.info(
"%s: $ %s",
Expand All @@ -179,7 +178,7 @@ def workflow_dispatch_docker_build(
return True
gh_workflow_run_cmd_ret = shell.run(gh_workflow_run_cmd, stream_output=True)
log.info(
f"All workflow runs: https://github.com/aptos-labs/aptos-core/actions/workflows/{DOCKER_RUST_BUILD_WORKFLOW_NAME}"
f"All workflow runs: https://github.com/{repo}/actions/workflows/{DOCKER_RUST_BUILD_WORKFLOW_NAME}"
)
# XXX: wait a while for GH API to update
time.sleep(10)
Expand All @@ -190,14 +189,15 @@ def workflow_dispatch_docker_build(
log.error("Failed to trigger docker build workflow")
return False
if wait:
return wait_for_workflow(shell, branch, DOCKER_RUST_BUILD_WORKFLOW_NAME)
return wait_for_workflow(shell, branch, DOCKER_RUST_BUILD_WORKFLOW_NAME, repo)
return True


def workflow_dispatch_forge(
shell: Shell,
branch: str,
git_sha: str,
repo: str,
duration: int = 480,
test_suite: str = FORGE_DEFAULT_TEST_SUITE,
dry_run: bool = False,
Expand All @@ -222,7 +222,7 @@ def workflow_dispatch_forge(
"--field",
f"FORGE_CLUSTER_NAME={FORGE_DEFAULT_CLUSTER_NAME}",
"--repo",
UPSTREAM_APTOS_CORE_REPO,
repo,
]
log.info(
"%s: $ %s",
Expand All @@ -234,7 +234,7 @@ def workflow_dispatch_forge(
return True
gh_workflow_run_cmd_ret = shell.run(gh_workflow_run_cmd, stream_output=True)
log.info(
f"All workflow runs: https://github.com/aptos-labs/aptos-core/actions/workflows/{FORGE_WORKFLOW_NAME}"
f"All workflow runs: https://github.com/{repo}/actions/workflows/{FORGE_WORKFLOW_NAME}"
)
# XXX: wait a while for GH API to update
time.sleep(10)
Expand All @@ -245,21 +245,21 @@ def workflow_dispatch_forge(
log.error("Failed to trigger Forge test workflow")
return False
if wait:
return wait_for_workflow(shell, branch, FORGE_WORKFLOW_NAME)
return wait_for_workflow(shell, branch, FORGE_WORKFLOW_NAME, repo)
return True


def ensure_git_status(git: Git, ignore_uncommitted_changes: bool) -> Tuple[str, str]:
def ensure_git_status(
git: Git,
current_git_branch: str,
new_exp_git_branch: str,
ignore_uncommitted_changes: bool,
) -> Tuple[str, str]:
"""Ensure that the git status is clean and return the git SHA and branch name of the experimental branch"""

aptos_core_repo = git.get_repo_from_remote("origin")
aptos_core_repo_url = f"https://github.com/{aptos_core_repo}.git"

current_git_branch = git.branch()
new_exp_git_branch = (
EXP_GIT_BRANCH_PREFIX + current_git_branch
) # the temporary branch to push to

# ensure that the current git workspace is clean
if not git.status():
log.info("ERROR: uncommitted changes in git workspace")
Expand Down Expand Up @@ -299,7 +299,7 @@ def main(log_metadata: bool) -> None:
init_logging(logger=log, print_metadata=log_metadata)


@main.command(help="Run a workflow on the aptos-core repo")
@main.command(help="Run a workflow on the upstream aptos-core git repo")
@click.option(
"--features",
multiple=True,
Expand All @@ -311,6 +311,11 @@ def main(log_metadata: bool) -> None:
default="release",
help="Cargo profile to build",
)
@click.option(
"--repo",
default=UPSTREAM_APTOS_CORE_REPO,
help="Repo to run the workflow on",
)
@click.option(
"--ignore-uncommitted-changes",
is_flag=True,
Expand Down Expand Up @@ -344,6 +349,7 @@ def main(log_metadata: bool) -> None:
def run(
features: List[str],
profile: str,
repo: str,
ignore_uncommitted_changes: bool,
wait: bool,
dry_run: bool,
Expand All @@ -360,21 +366,37 @@ def run(

# disclaimer if we're on a fork
get_repo_from_remote_ret = git.get_repo_from_remote("origin")
current_git_branch = git.branch()
new_exp_git_branch = (
EXP_GIT_BRANCH_PREFIX + current_git_branch
) # the temporary branch to push to
is_fork = False
if get_repo_from_remote_ret != UPSTREAM_APTOS_CORE_REPO:
log.info(
f"WARNING: You are running this script from a fork of {UPSTREAM_APTOS_CORE_REPO}."
if get_repo_from_remote_ret != repo and repo == UPSTREAM_APTOS_CORE_REPO:
print(f"WARNING: You are running this script from a fork of {repo}.")
print("WARNING: This script will push a new branch to your fork.")
print(
f"WARNING: It will run core code from your local changes, BUT will execute workflows from the main branch of the upstream {repo}."
)
log.info("WARNING: This script will push a new branch to your fork.")
log.info(
f"WARNING: It will run core code from your local changes, BUT will execute workflows from the main branch of the upstream {UPSTREAM_APTOS_CORE_REPO}."
)
log.info(
print(
"WARNING: If you wish to test workflow changes, please make a branch on the upstream, rather than a fork, and run exp from there."
)
is_fork = True

git_sha, new_exp_git_branch = ensure_git_status(git, ignore_uncommitted_changes)
if repo != UPSTREAM_APTOS_CORE_REPO:
print(
f"WARNING: You are running this script on a repo ({repo}) other than the upstream"
)
print(
f"WARNING: It will create a branch named {new_exp_git_branch} on repo {repo}"
)
# prompt user for confirmation
if not click.confirm("Are you sure you want to continue?"):
log.info("Exiting...")
sys.exit(0)

git_sha, new_exp_git_branch = ensure_git_status(
git, current_git_branch, new_exp_git_branch, ignore_uncommitted_changes
)
features = ",".join(features)
profile = profile

Expand All @@ -391,6 +413,7 @@ def run(
git_sha,
features,
profile,
repo,
dry_run=dry_run,
wait=wait,
)
Expand All @@ -408,6 +431,7 @@ def run(
shell,
new_exp_git_branch if not is_fork else "main",
git_sha,
repo,
duration=forge_runner_duration_secs,
test_suite=forge_test_suite,
dry_run=dry_run,
Expand All @@ -419,7 +443,12 @@ def run(


@main.command("list", help="List all authored workflows")
def list_exp():
@click.option(
"--repo",
default=UPSTREAM_APTOS_CORE_REPO,
help="Repo to run the workflow on",
)
def list_exp(repo: str):
shell = LocalShell()
username = get_gh_username(shell)
gh_workflow_list_cmd = [
Expand All @@ -433,7 +462,7 @@ def list_exp():
"--user",
username,
"--repo",
UPSTREAM_APTOS_CORE_REPO,
repo,
]
gh_workflow_list_cmd_ret = shell.run(gh_workflow_list_cmd)
list_out = json.dumps(
Expand Down

0 comments on commit 33b1dab

Please sign in to comment.