Apply review comments

Author: Kobzol

src/ci/github-actions/ci.py

@@ -34,10 +34,11 @@ def add_job_properties(jobs: List[Dict], prefix: str) -> List[Job]:
  """
 modified_jobs= []
 forjobinjobs:
-job=dict(job)
-job["image"] =get_job_image(job)
-job["name"] =f"{prefix} - {job['name']}"
-modified_jobs.append(job)
+# Create a copy of the `job` dictionary to avoid modifying `jobs`
+new_job=dict(job)
+new_job["image"] =get_job_image(new_job)
+new_job["name"] =f"{prefix} - {new_job['name']}"
+modified_jobs.append(new_job)
 returnmodified_jobs
 
 
@@ -46,11 +47,15 @@ def add_base_env(jobs: List[Job], environment: Dict[str, str]) -> List[Job]:
  Prepends `environment` to the `env` attribute of each job.
  The `env` of each job has higher precedence than `environment`.
  """
+modified_jobs= []
 forjobinjobs:
 env=environment.copy()
 env.update(job.get("env", {}))
-job["env"] =env
-returnjobs
+
+new_job=dict(job)
+new_job["env"] =env
+modified_jobs.append(new_job)
+returnmodified_jobs
 
 
 @dataclasses.dataclass
@@ -123,7 +128,9 @@ def find_run_type(ctx: GitHubCtx) -> Optional[WorkflowRunType]:
 
 defcalculate_jobs(run_type: WorkflowRunType, job_data: Dict[str, Any]) ->List[Job]:
 ifisinstance(run_type, PRRunType):
-returnadd_base_env(add_job_properties(job_data["pr"], "PR"), job_data["envs"]["pr"])
+returnadd_base_env(
+add_job_properties(job_data["pr"], "PR"), job_data["envs"]["pr"]
+ )
 elifisinstance(run_type, TryRunType):
 jobs=job_data["try"]
 custom_jobs=run_type.custom_jobs
@@ -188,95 +195,123 @@ def format_run_type(run_type: WorkflowRunType) -> str:
 raiseAssertionError()
 
 
-defget_job_image(job) ->str:
+defget_job_image(job: Job) ->str:
 """
  By default, the Docker image of a job is based on its name.
  However, it can be overridden by its IMAGE environment variable.
  """
-returnjob.get("env", {}).get("IMAGE", job["name"])
+env=job.get("env", {})
+# Return the IMAGE environment variable if it exists, otherwise return the job name
+returnenv.get("IMAGE", job["name"])
 
 
-defrun_workflow_locally(job_data: Dict[str, Any], job_name: str, pr_jobs: bool):
-DOCKER_DIR=Path(__file__).absolute().parent.parent/"docker"
+defis_linux_job(job: Job) ->bool:
+return"ubuntu"injob["os"]
 
-jobs=job_data["pr"] ifpr_jobselsejob_data["auto"]
-jobs= [jobforjobinjobsifjob.get("name") ==job_name]
+
+deffind_linux_job(job_data: Dict[str, Any], job_name: str, pr_jobs: bool) ->Job:
+candidates=job_data["pr"] ifpr_jobselsejob_data["auto"]
+jobs= [jobforjobincandidatesifjob.get("name") ==job_name]
 iflen(jobs) ==0:
-raiseException(f"Job `{job_name}` not found in {'pr'ifpr_jobselse'auto'} jobs")
+available_jobs="\n".join(
+sorted(job["name"] forjobincandidatesifis_linux_job(job))
+ )
+raiseException(f"""Job `{job_name}` not found in {'pr'ifpr_jobselse'auto'} jobs.
+The following jobs are available:
+{available_jobs}""")
 assertlen(jobs) ==1
+
 job=jobs[0]
-if"ubuntu"notinjob["os"]:
+ifnotis_linux_job(job):
 raiseException("Only Linux jobs can be executed locally")
+returnjob
+
+
+defrun_workflow_locally(job_data: Dict[str, Any], job_name: str, pr_jobs: bool):
+DOCKER_DIR=Path(__file__).absolute().parent.parent/"docker"
+
+job=find_linux_job(job_data, job_name=job_name, pr_jobs=pr_jobs)
 
 custom_env= {}
-custom_env["DEPLOY"] ="1"
+# Replicate src/ci/scripts/setup-environment.sh
+# Adds custom environment variables to the job
+ifjob_name.startswith("dist-"):
+ifjob_name.endswith("-alt"):
+custom_env["DEPLOY_ALT"] ="1"
+else:
+custom_env["DEPLOY"] ="1"
 custom_env.update({k: str(v) for (k, v) injob.get("env", {}).items()})
 
-args= [
-str(DOCKER_DIR/"run.sh"),
-get_job_image(job)
- ]
+args= [str(DOCKER_DIR/"run.sh"), get_job_image(job)]
 env_formatted= [f"{k}={v}"for (k, v) insorted(custom_env.items())]
 print(f"Executing `{' '.join(env_formatted)}{' '.join(args)}`")
 
 env=os.environ.copy()
 env.update(custom_env)
 
-process=subprocess.Popen(args, env=env)
-try:
-process.wait()
-exceptKeyboardInterrupt:
-process.kill()
+subprocess.run(args, env=env)
 
 
-if__name__=="__main__":
-logging.basicConfig(level=logging.INFO)
+defcalculate_job_matrix(job_data: Dict[str, Any]):
+github_ctx=get_github_ctx()
 
-withopen(JOBS_YAML_PATH) asf:
-data=yaml.safe_load(f)
+run_type=find_run_type(github_ctx)
+logging.info(f"Job type: {run_type}")
 
+withopen(CI_DIR/"channel") asf:
+channel=f.read().strip()
+
+jobs= []
+ifrun_typeisnotNone:
+jobs=calculate_jobs(run_type, job_data)
+jobs=skip_jobs(jobs, channel)
+
+ifnotjobs:
+raiseException("Scheduled job list is empty, this is an error")
+
+run_type=format_run_type(run_type)
+
+logging.info(f"Output:\n{yaml.dump(dict(jobs=jobs, run_type=run_type), indent=4)}")
+print(f"jobs={json.dumps(jobs)}")
+print(f"run_type={run_type}")
+
+
+defcreate_cli_parser():
 parser=argparse.ArgumentParser(
-prog="ci.py",
-description="Generate or run CI workflows"
+prog="ci.py", description="Generate or run CI workflows"
+ )
+subparsers=parser.add_subparsers(
+help="Command to execute", dest="command", required=True
+ )
+subparsers.add_parser(
+"calculate-job-matrix",
+help="Generate a matrix of jobs that should be executed in CI",
+ )
+run_parser=subparsers.add_parser(
+"run-local", help="Run a CI jobs locally (on Linux)"
  )
-generate_matrix=argparse.ArgumentParser()
-subparsers=parser.add_subparsers(help="Command to execute", dest="command", required=True)
-subparsers.add_parser("calculate-job-matrix")
-run_parser=subparsers.add_parser("run-local")
 run_parser.add_argument(
 "job_name",
 help="CI job that should be executed. By default, a merge (auto) "
-"job with the given name will be executed"
+"job with the given name will be executed",
  )
 run_parser.add_argument(
-"--pr",
-action="store_true",
-help="Run a PR job instead of an auto job"
+"--pr", action="store_true", help="Run a PR job instead of an auto job"
  )
-args=parser.parse_args()
-
-ifargs.command=="calculate-job-matrix":
-github_ctx=get_github_ctx()
+returnparser
 
-run_type=find_run_type(github_ctx)
-logging.info(f"Job type: {run_type}")
 
-withopen(CI_DIR/"channel") asf:
-channel=f.read().strip()
-
-jobs= []
-ifrun_typeisnotNone:
-jobs=calculate_jobs(run_type, data)
-jobs=skip_jobs(jobs, channel)
+if__name__=="__main__":
+logging.basicConfig(level=logging.INFO)
 
-ifnotjobs:
-raiseException("Scheduled job list is empty, this is an error")
+withopen(JOBS_YAML_PATH) asf:
+data=yaml.safe_load(f)
 
-run_type=format_run_type(run_type)
+parser=create_cli_parser()
+args=parser.parse_args()
 
-logging.info(f"Output:\n{yaml.dump(dict(jobs=jobs, run_type=run_type), indent=4)}")
-print(f"jobs={json.dumps(jobs)}")
-print(f"run_type={run_type}")
+ifargs.command=="calculate-job-matrix":
+calculate_job_matrix(data)
 elifargs.command=="run-local":
 run_workflow_locally(data, args.job_name, args.pr)
 else: