From 17fde4e228120041908d79ccd317bb30253359f1 Mon Sep 17 00:00:00 2001 From: John Date: Mon, 5 Jul 2021 14:56:48 +0100 Subject: [PATCH] Move source of truth logic from TIAF to job --- .../ConsoleFrontendConfig.in | 4 -- scripts/build/Jenkins/Jenkinsfile | 15 ++++- .../build/Platform/Windows/build_config.json | 7 +- scripts/build/TestImpactAnalysis/tiaf.py | 66 ++++++++++++------- .../build/TestImpactAnalysis/tiaf_driver.py | 6 +- 5 files changed, 61 insertions(+), 37 deletions(-) diff --git a/cmake/TestImpactFramework/ConsoleFrontendConfig.in b/cmake/TestImpactFramework/ConsoleFrontendConfig.in index ffd24ffb72..e4111fb9cd 100644 --- a/cmake/TestImpactFramework/ConsoleFrontendConfig.in +++ b/cmake/TestImpactFramework/ConsoleFrontendConfig.in @@ -4,10 +4,6 @@ "timestamp": "${timestamp}" }, "jenkins": { - "pipeline_of_truth" : [ - "nightly-incremental", - "nightly-clean" - ], "use_test_impact_analysis": ${use_tiaf} }, "repo": { diff --git a/scripts/build/Jenkins/Jenkinsfile b/scripts/build/Jenkins/Jenkinsfile index 8ac9353aea..3567267eab 100644 --- a/scripts/build/Jenkins/Jenkinsfile +++ b/scripts/build/Jenkins/Jenkinsfile @@ -13,8 +13,17 @@ EMPTY_JSON = readJSON text: '{}' ENGINE_REPOSITORY_NAME = 'o3de' -BUILD_SNAPSHOTS = ['development', 'stabilization/2106', ''] -DEFAULT_BUILD_SNAPSHOT = BUILD_SNAPSHOTS.get(0) +// Branches with build snapshots +BUILD_SNAPSHOTS = ['development', 'stabilization/2106'] + +// Build snapshots with empty snapshot (for use with 'SNAPSHOT' pipeline paramater) +BUILD_SNAPSHOTS_WITH_EMPTY = BUILD_SNAPSHOTS + '' + +// The default build snapshot to be selected in the 'SNAPSHOT' pipeline paramater +DEFAULT_BUILD_SNAPSHOT = BUILD_SNAPSHOTS_WITH_EMPTY.get(0) + +// Branches with build snapshots as comma separated value string +env.BUILD_SNAPSHOTS = BUILD_SNAPSHOTS.join(",") def pipelineProperties = [] @@ -476,7 +485,7 @@ try { } } else { // Non-PR builds - pipelineParameters.add(choice(defaultValue: DEFAULT_BUILD_SNAPSHOT, name: 'SNAPSHOT', choices: BUILD_SNAPSHOTS, description: 'Selects the build snapshot to use. A more diverted snapshot will cause longer build times, but will not cause build failures.')) + pipelineParameters.add(choice(defaultValue: DEFAULT_BUILD_SNAPSHOT, name: 'SNAPSHOT', choices: BUILD_SNAPSHOTS_WITH_EMPTY, description: 'Selects the build snapshot to use. A more diverted snapshot will cause longer build times, but will not cause build failures.')) snapshot = env.SNAPSHOT echo "Snapshot \"${snapshot}\" selected." } diff --git a/scripts/build/Platform/Windows/build_config.json b/scripts/build/Platform/Windows/build_config.json index 07e0e54bf5..b210d0bfb8 100644 --- a/scripts/build/Platform/Windows/build_config.json +++ b/scripts/build/Platform/Windows/build_config.json @@ -27,9 +27,7 @@ }, "profile_vs2019_pipe": { "TAGS": [ - "default", - "nightly-incremental", - "nightly-clean" + "default" ], "steps": [ "profile_vs2019", @@ -90,7 +88,8 @@ "OUTPUT_DIRECTORY": "build/windows_vs2019", "CONFIGURATION": "profile", "SCRIPT_PATH": "scripts/build/TestImpactAnalysis/tiaf_driver.py", - "SCRIPT_PARAMETERS": "--testFailurePolicy=continue --suite main --pipeline !PIPELINE_NAME! --destCommit !CHANGE_ID! --config \"!OUTPUT_DIRECTORY!/bin/TestImpactFramework/persistent/tiaf.profile.json\"" + "SCRIPT_PARAMETERS": + "--config=\"!OUTPUT_DIRECTORY!/bin/TestImpactFramework/persistent/tiaf.profile.json\" --suite=main --testFailurePolicy=continue --destBranch=!CHANGE_TARGET! --pipeline=!PIPELINE_NAME! --destCommit=!CHANGE_ID! --branchesOfTruth=!BUILD_SNAPSHOTS! --pipelinesOfTruth=default" } }, "debug_vs2019": { diff --git a/scripts/build/TestImpactAnalysis/tiaf.py b/scripts/build/TestImpactAnalysis/tiaf.py index 40158f8432..7d071138aa 100644 --- a/scripts/build/TestImpactAnalysis/tiaf.py +++ b/scripts/build/TestImpactAnalysis/tiaf.py @@ -20,33 +20,51 @@ def is_child_path(parent_path, child_path): return os.path.commonpath([os.path.abspath(parent_path)]) == os.path.commonpath([os.path.abspath(parent_path), os.path.abspath(child_path)]) class TestImpact: - def __init__(self, config_file, pipeline, dst_commit): - self.__pipeline = pipeline + def __init__(self, config_file, dst_commit, dst_branch, pipeline, branches_of_truth, pipelines_of_truth): + # Commit self.__dst_commit = dst_commit + print(f"Commit: '{self.__dst_commit}'.") self.__src_commit = None self.__has_src_commit = False + # Branch + self.__dst_branch = dst_branch + print(f"Destination branch: '{self.__dst_branch}'.") + self.__branches_of_truth = branches_of_truth + print(f"Branches of truth: '{self.__branches_of_truth}'.") + if self.__dst_branch in self.__branches_of_truth: + self.__is_branch_of_truth = True + else: + self.__is_branch_of_truth = False + print(f"Is branch of truth: '{self.__is_branch_of_truth}'.") + # Pipeline + self.__pipeline = pipeline + print(f"Pipeline: '{self.__pipeline}'.") + self.__pipelines_of_truth = pipelines_of_truth + print(f"Pipelines of truth: '{self.__pipelines_of_truth}'.") + if self.__pipeline in self.__pipelines_of_truth: + self.__is_pipeline_of_truth = True + else: + self.__is_pipeline_of_truth = False + print(f"Is pipeline of truth: '{self.__is_pipeline_of_truth}'.") + # Config self.__parse_config_file(config_file) - if self.__use_test_impact_analysis and not self.__is_pipeline_of_truth: - self.__generate_change_list() + # Sequence + if self.__use_test_impact_analysis: + if self.__is_pipeline_of_truth and self.__is_branch_of_truth: + self.__is_seeding = True + else: + self.__is_seeding = False + self.__generate_change_list() # Parse the configuration file and retrieve the data needed for launching the test impact analysis runtime def __parse_config_file(self, config_file): print(f"Attempting to parse configuration file '{config_file}'...") with open(config_file, "r") as config_data: config = json.load(config_data) - # Repository self.__repo_dir = config["repo"]["root"] - # Jenkins + self.__repo = Repo(self.__repo_dir) + # TIAF self.__use_test_impact_analysis = config["jenkins"]["use_test_impact_analysis"] - self.__pipeline_of_truth = config["jenkins"]["pipeline_of_truth"] - print(f"Pipeline of truth: '{self.__pipeline_of_truth}'.") - print(f"This pipeline: '{self.__pipeline}'.") - if self.__pipeline in self.__pipeline_of_truth: - self.__is_pipeline_of_truth = True - else: - self.__is_pipeline_of_truth = False - print(f"Is pipeline of truth: '{self.__is_pipeline_of_truth}'.") - # TIAF binary self.__tiaf_bin = config["repo"]["tiaf_bin"] if self.__use_test_impact_analysis and not os.path.isfile(self.__tiaf_bin): raise FileNotFoundError("Could not find tiaf binary") @@ -143,7 +161,7 @@ class TestImpact: # Runs the specified test sequence def run(self, suite, test_failure_policy, safe_mode, test_timeout, global_timeout): args = [] - pipeline_of_truth_test_failure_policy = "continue" + seed_sequence_test_failure_policy = "continue" # Suite args.append(f"--suite={suite}") print(f"Test suite is set to '{suite}'.") @@ -156,15 +174,15 @@ class TestImpact: print(f"Global sequence timeout is set to {test_timeout} seconds.") if self.__use_test_impact_analysis: print("Test impact analysis is enabled.") - # Pipeline of truth sequence - if self.__is_pipeline_of_truth: + # Seed sequences + if self.__is_seeding: # Sequence type args.append("--sequence=seed") print("Sequence type is set to 'seed'.") # Test failure policy - args.append(f"--fpolicy={pipeline_of_truth_test_failure_policy}") - print(f"Test failure policy is set to '{pipeline_of_truth_test_failure_policy}'.") - # Non pipeline of truth sequence + args.append(f"--fpolicy={seed_sequence_test_failure_policy}") + print(f"Test failure policy is set to '{seed_sequence_test_failure_policy}'.") + # Impact analysis sequences else: if self.__has_change_list: # Change list @@ -194,8 +212,8 @@ class TestImpact: # Pipeline of truth sequence if self.__is_pipeline_of_truth: # Test failure policy - args.append(f"--fpolicy={pipeline_of_truth_test_failure_policy}") - print(f"Test failure policy is set to '{pipeline_of_truth_test_failure_policy}'.") + args.append(f"--fpolicy={seed_sequence_test_failure_policy}") + print(f"Test failure policy is set to '{seed_sequence_test_failure_policy}'.") # Non pipeline of truth sequence else: # Test failure policy @@ -205,7 +223,7 @@ class TestImpact: print("Args: ", end='') print(*args) result = subprocess.run([self.__tiaf_bin] + args) - # If the sequence completed 9with or without failures) we will update the historical meta-data + # If the sequence completed (with or without failures) we will update the historical meta-data if result.returncode == 0 or result.returncode == 7: print("Test impact analysis runtime returned successfully.") if self.__is_pipeline_of_truth: diff --git a/scripts/build/TestImpactAnalysis/tiaf_driver.py b/scripts/build/TestImpactAnalysis/tiaf_driver.py index e346feaadd..3c8ec4b32a 100644 --- a/scripts/build/TestImpactAnalysis/tiaf_driver.py +++ b/scripts/build/TestImpactAnalysis/tiaf_driver.py @@ -35,14 +35,16 @@ def parse_args(): parser = argparse.ArgumentParser() parser.add_argument('--config', dest="config", type=file_path, help="Path to the test impact analysis framework configuration file", required=True) + parser.add_argument('--destBranch', dest="dst_branch", help="For PR builds, the destination branch to be merged to, otherwise empty") + parser.add_argument('--branchesOfTruth', dest="branches_of_truth", type=lambda arg: arg.split(','), help="Comma separated branches that seeding will occur on", required=True) parser.add_argument('--pipeline', dest="pipeline", help="Pipeline the test impact analysis framework is running on", required=True) + parser.add_argument('--pipelinesOfTruth', dest="pipelines_of_truth", type=lambda arg: arg.split(','), help="Comma separated pipeline that seeding will occur on", required=True) parser.add_argument('--destCommit', dest="dst_commit", help="Commit to run test impact analysis on (ignored when seeding)", required=True) parser.add_argument('--suite', dest="suite", help="Test suite to run", required=True) parser.add_argument('--testFailurePolicy', dest="test_failure_policy", type=test_failure_policy, help="Test failure policy for regular and test impact sequences (ignored when seeding)", required=True) parser.add_argument('--safeMode', dest="safe_mode", action='store_true', help="Run impact analysis tests in safe mode (ignored when seeding)") parser.add_argument('--testTimeout', dest="test_timeout", type=timout_type, help="Maximum run time (in seconds) of any test target before being terminated", required=False) parser.add_argument('--globalTimeout', dest="global_timeout", type=timout_type, help="Maximum run time of the sequence before being terminated", required=False) - parser.set_defaults(test_failure_policy="abort") parser.set_defaults(test_timeout=None) parser.set_defaults(global_timeout=None) args = parser.parse_args() @@ -52,7 +54,7 @@ def parse_args(): if __name__ == "__main__": try: args = parse_args() - tiaf = TestImpact(args.config, args.pipeline, args.dst_commit) + tiaf = TestImpact(args.config, args.dst_commit, args.dst_branch, args.pipeline, args.branches_of_truth, args.pipelines_of_truth) return_code = tiaf.run(args.suite, args.test_failure_policy, args.safe_mode, args.test_timeout, args.global_timeout) # Non-gating will be removed from this script and handled at the job level in SPEC-7413 #sys.exit(return_code)