| # Copyright 2020 The Chromium Authors |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """Library for defining try builders. |
| |
| The `try_builder` function defined in this module enables defining a builder and |
| the tryjob verifier for it in the same location. It can also be accessed through |
| `try_.builder`. |
| |
| The `tryjob` function specifies the verifier details for a builder. It can also |
| be accessed through `try_.job`. |
| |
| The `defaults` struct provides module-level defaults for the arguments to |
| `try_builder`. The parameters that support module-level defaults have a |
| corresponding attribute on `defaults` that is a `lucicfg.var` that can be used |
| to set the default value. Can also be accessed through `try_.defaults`. |
| """ |
| |
| load("./args.star", "args") |
| load("./branches.star", "branches") |
| load("./builders.star", "builders", "os") |
| load("./orchestrator.star", "register_compilator", "register_orchestrator") |
| load("//project.star", "settings") |
| |
| def default_location_filters(builder_name = None): |
| """Get the default location filters for a builder. |
| |
| Args: |
| builder_name: The qualified-name of the builder to get the location |
| filters for. May be a bucket-qualified name (e.g. try/linux-rel) or a |
| project-qualified name (e.g. chromium/try/linux-rel). If specified, |
| the builder's config files at //infra/config/generated/builders/ are |
| added to the default include-filters returned. |
| |
| Returns: |
| A list of cq.location_filter objects to use for the builder. |
| """ |
| |
| def location_filter(*, path_regexp, exclude = False): |
| return cq.location_filter( |
| gerrit_host_regexp = ".*", |
| gerrit_project_regexp = ".*", |
| path_regexp = path_regexp, |
| exclude = exclude, |
| ) |
| |
| filters = [ |
| # Contains documentation that doesn't affect the outputs |
| location_filter(path_regexp = "docs/.+", exclude = True), |
| # Contains configuration files that aren't active until after committed |
| location_filter(path_regexp = "infra/config/.+", exclude = True), |
| ] |
| if builder_name: |
| pieces = builder_name.split("/") |
| if len(pieces) == 2: |
| bucket, builder = pieces |
| elif len(pieces) == 3: |
| _, bucket, builder = pieces |
| else: |
| fail("builder_name must be a qualified builder name, got {}".format(builder_name)) |
| filters.append( |
| # Contains builder-specific files that can be consumed by the builder |
| # pre-submit |
| location_filter(path_regexp = "infra/config/generated/builders/{}/{}/.+".format(bucket, builder)), |
| ) |
| |
| return filters |
| |
| def location_filters_without_defaults(tryjob_builder_proto): |
| default_filters = default_location_filters(tryjob_builder_proto.name) |
| return [f for f in tryjob_builder_proto.location_filters if cq.location_filter( |
| gerrit_host_regexp = f.gerrit_host_regexp, |
| gerrit_project_regexp = f.gerrit_project_regexp, |
| path_regexp = f.path_regexp, |
| exclude = f.exclude, |
| ) not in default_filters] |
| |
| # Intended to be used for the `caches` builder arg when no source checkout is |
| # required. |
| # |
| # Setting a cache with a "builder" path prevents buildbucket from automatically |
| # creating a regular builder cache with a 4 minute wait_for_warm_cache. |
| # `wait_for_warm_cache = None` ensures that swarming will not look for a bot |
| # with a builder cache. |
| SOURCELESS_BUILDER_CACHES = [ |
| swarming.cache( |
| name = "unused_builder_cache", |
| path = "builder", |
| wait_for_warm_cache = None, |
| ), |
| ] |
| |
| defaults = args.defaults( |
| extends = builders.defaults, |
| check_for_flakiness = True, |
| # TODO(crbug/1456545) - Once we've migrated to the ResultDB-based solution |
| # this should be deprecated in favor for the original check_for_flakiness |
| # argument. |
| check_for_flakiness_with_resultdb = True, |
| cq_group = None, |
| main_list_view = None, |
| subproject_list_view = None, |
| resultdb_bigquery_exports = [], |
| # Default overrides for more specific wrapper functions. The value is set to |
| # args.DEFAULT so that when they are passed to the corresponding standard |
| # argument, if the more-specific default has not been set it will fall back |
| # to the standard default. |
| compilator_cores = args.DEFAULT, |
| compilator_reclient_jobs = args.DEFAULT, |
| orchestrator_cores = args.DEFAULT, |
| ) |
| |
| def tryjob( |
| *, |
| disable_reuse = None, |
| experiment_percentage = None, |
| location_filters = None, |
| cancel_stale = None, |
| add_default_filters = True, |
| equivalent_builder = None, |
| equivalent_builder_percentage = None, |
| equivalent_builder_whitelist = None, |
| omit_from_luci_cv = False, |
| custom_cq_run_modes = None): |
| """Specifies the details of a tryjob verifier. |
| |
| See https://chromium.googlesource.com/infra/luci/luci-go/+/HEAD/lucicfg/doc/README.md#luci.cq_tryjob_verifier |
| for details on the most of the arguments. |
| |
| Args: |
| disable_reuse: See cq.tryjob_verifier. |
| experiment_percentage: See cq.tryjob_verifier. |
| location_filters: A list of cq.location_filter objects and/or strings. |
| This is the same as the location_filters value of cq.tryjob_verifier |
| except that strings can be provided, which will be converted to a |
| cq.location_filter with path_regexp set to the provided string. |
| cancel_stale: See cq.tryjob_verifier. |
| add_default_filters: A bool indicating whether to add default filters that |
| exclude certain directories that would have no impact when building |
| chromium with the patch applied (docs, config files that don't take |
| effect until landing, etc., see default_location_filters). |
| equivalent_builder: See cq.tryjob_verifier. |
| equivalent_builder_percentage: See cq.tryjob_verifier. |
| equivalent_builder_whitelist: See cq.tryjob_verifier. |
| omit_from_luci_cv: A bool indicating whether the tryjob will be |
| added to luci verifier. This is useful for the equivalent_builder which |
| can't be added twice. |
| custom_cq_run_modes: List of cq.run_mode names that will trigger this |
| tryjob. Uses cq.MODE_DRY_RUN, cq.MODE_FULL_RUN if not specified. |
| |
| Returns: |
| A struct that can be passed to the `tryjob` argument of `try_.builder` to |
| enable the builder for CQ. |
| """ |
| |
| def normalize_location_filter(f): |
| if type(f) == type(""): |
| return cq.location_filter(path_regexp = f) |
| return f |
| |
| if location_filters: |
| location_filters = [normalize_location_filter(f) for f in location_filters] |
| |
| return struct( |
| disable_reuse = disable_reuse, |
| experiment_percentage = experiment_percentage, |
| add_default_filters = add_default_filters, |
| location_filters = location_filters, |
| cancel_stale = cancel_stale, |
| custom_cq_run_modes = custom_cq_run_modes, |
| equivalent_builder = equivalent_builder, |
| equivalent_builder_percentage = equivalent_builder_percentage, |
| equivalent_builder_whitelist = equivalent_builder_whitelist, |
| omit_from_luci_cv = omit_from_luci_cv, |
| ) |
| |
| def try_builder( |
| *, |
| name, |
| branch_selector = branches.selector.MAIN, |
| check_for_flakiness = args.DEFAULT, |
| check_for_flakiness_with_resultdb = args.DEFAULT, |
| cq_group = args.DEFAULT, |
| list_view = args.DEFAULT, |
| main_list_view = args.DEFAULT, |
| subproject_list_view = args.DEFAULT, |
| tryjob = None, |
| experiments = None, |
| resultdb_bigquery_exports = args.DEFAULT, |
| **kwargs): |
| """Define a try builder. |
| |
| Arguments: |
| name - name of the builder, will show up in UIs and logs. Required. |
| branch_selector - A branch selector value controlling whether the |
| builder definition is executed. See branches.star for more |
| information. |
| check_for_flakiness - If True, it checks for new tests in a given try |
| build and reruns them multiple times to ensure that they are not |
| flaky. |
| # TODO(crbug/1456545) - Once we've migrated to the ResultDB-based solution |
| # this should be deprecated in favor for the original check_for_flakiness |
| # argument. |
| check_for_flakiness_with_resultdb - If True, it checks for new tests in a |
| given try build using resultdb as the data source, instead of the |
| previous mechanism which utilized a pregenerated test history. New tests |
| are rerun multiple times to ensure that they are not flaky. |
| cq_group - The CQ group to add the builder to. If tryjob is None, it will |
| be added as includable_only. |
| list_view - A string or list of strings identifying the ID(s) of the list |
| view to add an entry to. Supports a module-level default that defaults |
| to the group of the builder, if provided. |
| main_console_view - A string identifying the ID of the main list |
| view to add an entry to. Supports a module-level default that |
| defaults to None. |
| subproject_list_view - A string identifying the ID of the |
| subproject list view to add an entry to. Suppoers a module-level |
| default that defaults to None. |
| tryjob - A struct containing the details of the tryjob verifier for the |
| builder, obtained by calling the `tryjob` function. |
| experiments - a dict of experiment name to the percentage chance (0-100) |
| that it will apply to builds generated from this builder. |
| resultdb_bigquery_exports - a list of resultdb.export_test_results(...) |
| specifying additional parameters for exporting test results to BigQuery. |
| Will always upload to the following tables in addition to any tables |
| specified by the list's elements: |
| chrome-luci-data.chromium.try_test_results |
| chrome-luci-data.gpu_try_test_results |
| """ |
| if not branches.matches(branch_selector): |
| return None |
| |
| experiments = experiments or {} |
| |
| # TODO(crbug.com/1346781): Remove when the experiment is the default. |
| experiments.setdefault("chromium_swarming.expose_merge_script_failures", 100) |
| |
| # TODO(crbug.com/1466962): Remove when the experiment is the default. |
| experiments.setdefault("swarming.prpc.cli", 100) |
| |
| merged_resultdb_bigquery_exports = [ |
| resultdb.export_test_results( |
| bq_table = "chrome-luci-data.chromium.try_test_results", |
| ), |
| resultdb.export_test_results( |
| bq_table = "chrome-luci-data.chromium.gpu_try_test_results", |
| predicate = resultdb.test_result_predicate( |
| # Only match the telemetry_gpu_integration_test target and its |
| # Fuchsia and Android variants that have a suffix added to the |
| # end. Those are caught with [^/]*. |
| test_id_regexp = "ninja://chrome/test:telemetry_gpu_integration_test[^/]*/.+", |
| ), |
| ), |
| resultdb.export_test_results( |
| bq_table = "chrome-luci-data.chromium.blink_web_tests_try_test_results", |
| predicate = resultdb.test_result_predicate( |
| # Match the "blink_web_tests" target and all of its |
| # flag-specific versions, e.g. "vulkan_swiftshader_blink_web_tests". |
| test_id_regexp = "(ninja://[^/]*blink_web_tests/.+)|(ninja://[^/]*_wpt_tests/.+)", |
| ), |
| ), |
| ] |
| merged_resultdb_bigquery_exports.extend( |
| defaults.get_value( |
| "resultdb_bigquery_exports", |
| resultdb_bigquery_exports, |
| ), |
| ) |
| |
| list_view = defaults.get_value("list_view", list_view) |
| if list_view == args.COMPUTE: |
| list_view = defaults.get_value_from_kwargs("builder_group", kwargs) |
| if type(list_view) == type(""): |
| list_view = [list_view] |
| list_view = list(list_view or []) |
| main_list_view = defaults.get_value("main_list_view", main_list_view) |
| if main_list_view: |
| list_view.append(main_list_view) |
| subproject_list_view = defaults.get_value("subproject_list_view", subproject_list_view) |
| if subproject_list_view: |
| list_view.append(subproject_list_view) |
| |
| properties = kwargs.pop("properties", {}) |
| properties = dict(properties) |
| |
| # Populate "cq" property if builder is a required or path-based CQ builder. |
| # This is useful for bigquery analysis. |
| if "cq" in properties: |
| fail("Setting 'cq' property directly is not supported. It is " + |
| "generated automatically based on tryjob and location_filters.") |
| if tryjob != None: |
| cq_reason = "required" if not tryjob.location_filters else "path-based" |
| properties["cq"] = cq_reason |
| |
| # TODO(crbug/1456545) - Once we've migrated to the ResultDB-based solution |
| # check_for_flakiness_with_resultdb should be deprecated in favor for the |
| # original check_for_flakiness argument. |
| check_for_flakiness = defaults.get_value( |
| "check_for_flakiness", |
| check_for_flakiness, |
| ) |
| check_for_flakiness_with_resultdb = defaults.get_value( |
| "check_for_flakiness_with_resultdb", |
| check_for_flakiness_with_resultdb, |
| ) |
| |
| flakiness = {} |
| if defaults.get_value("check_for_flakiness", check_for_flakiness): |
| flakiness["check_for_flakiness"] = True |
| if defaults.get_value("check_for_flakiness_with_resultdb", check_for_flakiness_with_resultdb): |
| flakiness["check_for_flakiness_with_resultdb"] = True |
| if flakiness: |
| properties["$build/flakiness"] = flakiness |
| |
| # Define the builder first so that any validation of luci.builder arguments |
| # (e.g. bucket) occurs before we try to use it |
| ret = builders.builder( |
| name = name, |
| branch_selector = branch_selector, |
| list_view = list_view, |
| resultdb_bigquery_exports = merged_resultdb_bigquery_exports, |
| experiments = experiments, |
| resultdb_index_by_timestamp = True, |
| properties = properties, |
| **kwargs |
| ) |
| |
| bucket = defaults.get_value_from_kwargs("bucket", kwargs) |
| builder = "{}/{}".format(bucket, name) |
| cq_group = defaults.get_value("cq_group", cq_group) |
| if tryjob != None: |
| location_filters = tryjob.location_filters |
| if tryjob.add_default_filters: |
| location_filters = (location_filters or []) + default_location_filters(builder) |
| if not tryjob.omit_from_luci_cv: |
| luci.cq_tryjob_verifier( |
| builder = builder, |
| cq_group = cq_group, |
| disable_reuse = tryjob.disable_reuse, |
| experiment_percentage = tryjob.experiment_percentage, |
| location_filters = location_filters, |
| cancel_stale = tryjob.cancel_stale, |
| # These are the default if includable_only is False, but we list |
| # them here so we can add additional modes in a later generator. |
| mode_allowlist = tryjob.custom_cq_run_modes or [cq.MODE_DRY_RUN, cq.MODE_FULL_RUN], |
| equivalent_builder = tryjob.equivalent_builder, |
| equivalent_builder_percentage = tryjob.equivalent_builder_percentage, |
| equivalent_builder_whitelist = tryjob.equivalent_builder_whitelist, |
| ) |
| else: |
| # Allow CQ to trigger this builder if user opts in via CQ-Include-Trybots. |
| luci.cq_tryjob_verifier( |
| builder = builder, |
| cq_group = cq_group, |
| includable_only = True, |
| ) |
| |
| return ret |
| |
| def _orchestrator_builder( |
| *, |
| name, |
| compilator, |
| use_orchestrator_pool = False, |
| **kwargs): |
| """Define an orchestrator builder. |
| |
| An orchestrator builder is part of a pair of try builders. The orchestrator |
| triggers an associated compilator builder, which performs compilation and |
| isolation on behalf of the orchestrator. The orchestrator extracts from the |
| compilator the information necessary to trigger tests. This allows the |
| orchestrator to run on a small machine and improves compilation times |
| because the compilator will be compiling more often and can run on a larger |
| machine. |
| |
| The properties set for the orchestrator will be copied to the compilator, |
| with the exception of the $build/orchestrator property that is automatically |
| added to the orchestrator. |
| |
| |
| Args: |
| name: The name of the orchestrator. |
| compilator: A string identifying the associated compilator. Compilators |
| can be defined using try_.compilator_builder. |
| use_orchestrator_pool: Whether to use the bots in |
| luci.chromium.try.orchestrator pool. This kwarg should be taken out |
| once all CQ builders are migrated to be srcless (crbug/1287228) |
| **kwargs: Additional kwargs to be forwarded to try_.builder. |
| The following kwargs will have defaults applied if not set: |
| * builderless: True on branches, False on main |
| * cores: The orchestrator_cores module-level default. |
| * executable: "recipe:chromium/orchestrator" |
| * os: os.LINUX_DEFAULT |
| * service_account: "chromium-orchestrator@chops-service-accounts.iam.gserviceaccount.com" |
| * ssd: None |
| """ |
| builder_group = defaults.get_value_from_kwargs("builder_group", kwargs) |
| if not builder_group: |
| fail("builder_group must be specified") |
| |
| # TODO(crbug/1287228): Make this the default once all CQ builders are |
| # migrated to be srcless |
| if use_orchestrator_pool: |
| kwargs.setdefault("pool", "luci.chromium.try.orchestrator") |
| kwargs.setdefault("builderless", None) |
| |
| # Orchestrator builders that don't use a src checkout don't need a |
| # builder cache. |
| kwargs.setdefault("caches", SOURCELESS_BUILDER_CACHES) |
| else: |
| kwargs.setdefault("builderless", not settings.is_main) |
| |
| kwargs.setdefault("cores", defaults.orchestrator_cores.get()) |
| kwargs.setdefault("executable", "recipe:chromium/orchestrator") |
| |
| kwargs.setdefault("reclient_instance", None) |
| kwargs.setdefault("os", os.LINUX_DEFAULT) |
| kwargs.setdefault("service_account", "chromium-orchestrator@chops-service-accounts.iam.gserviceaccount.com") |
| kwargs.setdefault("ssd", None) |
| |
| ret = try_.builder(name = name, **kwargs) |
| if ret: |
| bucket = defaults.get_value_from_kwargs("bucket", kwargs) |
| |
| register_orchestrator(bucket, name, builder_group, compilator) |
| |
| return ret |
| |
| def _compilator_builder(*, name, **kwargs): |
| """Define a compilator builder. |
| |
| An orchestrator builder is part of a pair of try builders. The compilator is |
| triggered by an associated compilator builder, which performs compilation and |
| isolation on behalf of the orchestrator. The orchestrator extracts from the |
| compilator the information necessary to trigger tests. This allows the |
| orchestrator to run on a small machine and improves compilation times |
| because the compilator will be compiling more often and can run on a larger |
| machine. |
| |
| The properties set for the orchestrator will be copied to the compilator, |
| with the exception of the $build/orchestrator property that is automatically |
| added to the orchestrator. |
| |
| Args: |
| name: The name of the compilator. |
| **kwargs: Additional kwargs to be forwarded to try_.builder. |
| The following kwargs will have defaults applied if not set: |
| * builderless: True on branches, False on main |
| * cores: The compilator_cores module-level default. |
| * reclient_jobs: The compilator_reclient_jobs module-level default. |
| * executable: "recipe:chromium/compilator" |
| * ssd: True |
| """ |
| builder_group = defaults.get_value_from_kwargs("builder_group", kwargs) |
| if not builder_group: |
| fail("builder_group must be specified") |
| |
| kwargs.setdefault("builderless", not settings.is_main) |
| kwargs.setdefault("cores", defaults.compilator_cores.get()) |
| kwargs.setdefault("executable", "recipe:chromium/compilator") |
| kwargs.setdefault("reclient_jobs", defaults.compilator_reclient_jobs.get()) |
| kwargs.setdefault("ssd", True) |
| |
| ret = try_.builder(name = name, **kwargs) |
| if ret: |
| bucket = defaults.get_value_from_kwargs("bucket", kwargs) |
| |
| register_compilator(bucket, name) |
| |
| return ret |
| |
| def _gpu_optional_tests_builder(*, name, **kwargs): |
| kwargs.setdefault("builderless", False) |
| kwargs.setdefault("execution_timeout", 6 * time.hour) |
| kwargs.setdefault("service_account", try_.gpu.SERVICE_ACCOUNT) |
| return try_.builder(name = name, **kwargs) |
| |
| try_ = struct( |
| # Module-level defaults for try functions |
| defaults = defaults, |
| |
| # Functions for declaring try builders |
| builder = try_builder, |
| job = tryjob, |
| orchestrator_builder = _orchestrator_builder, |
| compilator_builder = _compilator_builder, |
| |
| # CONSTANTS |
| DEFAULT_EXECUTABLE = "recipe:chromium_trybot", |
| DEFAULT_EXECUTION_TIMEOUT = 4 * time.hour, |
| DEFAULT_POOL = "luci.chromium.try", |
| DEFAULT_SERVICE_ACCOUNT = "chromium-try-builder@chops-service-accounts.iam.gserviceaccount.com", |
| MEGA_CQ_DRY_RUN_NAME = "CQ_MODE_MEGA_DRY_RUN", |
| MEGA_CQ_FULL_RUN_NAME = "CQ_MODE_MEGA_FULL_RUN", |
| gpu = struct( |
| optional_tests_builder = _gpu_optional_tests_builder, |
| SERVICE_ACCOUNT = "chromium-try-gpu-builder@chops-service-accounts.iam.gserviceaccount.com", |
| ), |
| ) |
