From 805d7baf42644109d0fb1f43f8908f9c88c75b04 Mon Sep 17 00:00:00 2001 From: Greg Magolan Date: Thu, 16 Feb 2023 21:54:40 -0800 Subject: [PATCH] feat: add write_aspect_bazelrc_presets macro --- .aspect/bazelrc/BUILD.bazel | 28 ++++++- .aspect/bazelrc/README.md | 56 +++++++++++++- .aspect/bazelrc/automatic_updates.md | 18 +++++ .aspect/bazelrc/intro.md | 5 ++ .aspect/bazelrc/usage.md | 31 ++++++++ .bazelrc | 15 +--- docs/BUILD.bazel | 5 ++ docs/bazelrc_presets.md | 32 ++++++++ e2e/bzlmod/.bazelignore | 1 + e2e/copy_to_directory/.bazelignore | 1 + e2e/workspace/.bazelignore | 1 + lib/BUILD.bazel | 6 ++ lib/bazelrc_presets.bzl | 59 +++++++++++++++ lib/tests/bazelrc_presets/BUILD.bazel | 16 ++++ lib/tests/bazelrc_presets/bazel5.bazelrc | 5 ++ lib/tests/bazelrc_presets/ci.bazelrc | 75 +++++++++++++++++++ lib/tests/bazelrc_presets/convenience.bazelrc | 29 +++++++ lib/tests/bazelrc_presets/correctness.bazelrc | 68 +++++++++++++++++ lib/tests/bazelrc_presets/debug.bazelrc | 19 +++++ lib/tests/bazelrc_presets/javascript.bazelrc | 28 +++++++ lib/tests/bazelrc_presets/performance.bazelrc | 54 +++++++++++++ 21 files changed, 538 insertions(+), 14 deletions(-) create mode 100644 .aspect/bazelrc/automatic_updates.md create mode 100644 .aspect/bazelrc/intro.md create mode 100644 .aspect/bazelrc/usage.md create mode 100644 docs/bazelrc_presets.md create mode 100644 e2e/bzlmod/.bazelignore create mode 100644 e2e/copy_to_directory/.bazelignore create mode 100644 e2e/workspace/.bazelignore create mode 100644 lib/bazelrc_presets.bzl create mode 100644 lib/tests/bazelrc_presets/BUILD.bazel create mode 100644 lib/tests/bazelrc_presets/bazel5.bazelrc create mode 100644 lib/tests/bazelrc_presets/ci.bazelrc create mode 100644 lib/tests/bazelrc_presets/convenience.bazelrc create mode 100644 lib/tests/bazelrc_presets/correctness.bazelrc create mode 100644 lib/tests/bazelrc_presets/debug.bazelrc create mode 100644 lib/tests/bazelrc_presets/javascript.bazelrc create mode 100644 lib/tests/bazelrc_presets/performance.bazelrc diff --git a/.aspect/bazelrc/BUILD.bazel b/.aspect/bazelrc/BUILD.bazel index 3da118662..0506ead85 100644 --- a/.aspect/bazelrc/BUILD.bazel +++ b/.aspect/bazelrc/BUILD.bazel @@ -1 +1,27 @@ -exports_files(glob(["*.bazelrc"])) +load("@aspect_bazel_lib//lib:write_source_files.bzl", "write_source_file") + +exports_files(glob([ + "*.bazelrc", + "*.md", +])) + +# `usage.md` & `intro.md` are also used for [docsite](https://docs.aspect.build/guides/bazelrc) +# content which is why they are separated into individual md files +genrule( + name = "gen_readme_md", + srcs = glob(["*.md"]), + outs = ["_README.md"], + cmd = """ + cat .aspect/bazelrc/intro.md > $@ + echo '' >> $@ + cat .aspect/bazelrc/usage.md >> $@ + echo '' >> $@ + cat .aspect/bazelrc/automatic_updates.md >> $@ + """, +) + +write_source_file( + name = "update_readme_md", + in_file = "_README.md", + out_file = "README.md", +) diff --git a/.aspect/bazelrc/README.md b/.aspect/bazelrc/README.md index fbe353624..61ed3c04b 100644 --- a/.aspect/bazelrc/README.md +++ b/.aspect/bazelrc/README.md @@ -1,4 +1,56 @@ -# Aspect Recommended Bazel Options +# Aspect bazelrc presets + +The `.bazelrc` files found here are the source-of-truth for our recommended Bazel presets. -The Bazel options found here are the source-of-truth for our recommended set of settings. They are mirrored on our docsite at https://docs.aspect.build/guides/bazelrc. + +## Using Aspect bazelrc presets in your project + +The `.bazelrc` file can get large, fast. +Some settings don't apply everywhere - some options are appropriate only on CI, +and some vary depending on the version of Bazel you use or languages used. + +Bazel rc files can contain `import` statements, which allow you to organize the content better. + +To use these presets in your project, simply vendor the `*.bazelrc` files from +https://github.com/aspect-build/bazel-lib/tree/main/.aspect/bazelrc into the +`.aspect/bazelrc` folder in your repository and `import` them in your `.bazelrc` file. + +For example, + +```python title=".bazelrc" +# Import Aspect bazelrc presets +import %workspace%/.aspect/bazelrc/bazel6.bazelrc +import %workspace%/.aspect/bazelrc/convenience.bazelrc +import %workspace%/.aspect/bazelrc/correctness.bazelrc +import %workspace%/.aspect/bazelrc/debug.bazelrc +import %workspace%/.aspect/bazelrc/javascript.bazelrc +import %workspace%/.aspect/bazelrc/performance.bazelrc + +### YOUR PROJECT SPECIFIC OPTIONS GO HERE ### + +# Load any settings & overrides specific to the current user from `.aspect/bazelrc/user.bazelrc`. +# This file should appear in `.gitignore` so that settings are not shared with team members. This +# should be last statement in this config so the user configuration is able to overwrite flags from +# this file. See https://bazel.build/configure/best-practices#bazelrc-file. +try-import %workspace%/.aspect/bazelrc/user.bazelrc +``` + +## Automatic updates + +A convenient way to automatically keep your vendored copy up-to-date is to use the `write_aspect_bazelrc_presets` rule in `.aspect/bazelrc/BUILD.bazel`: + +```python title=".aspect/bazelrc/BUILD.bazel" +"Aspect bazelrc presets; see https://docs.aspect.build/guides/bazelrc" + +load("@aspect_bazel_lib//lib:bazelrc_presets.bzl", "write_aspect_bazelrc_presets") + +write_aspect_bazelrc_presets(name = "update_aspect_bazelrc_presets") +``` + +When `@aspect_bazel_lib` is upgraded in your `WORKSPACE.bazel` or your `MODULE.bazel` file, a `diff_test` +stamped out by `write_aspect_bazelrc_presets` will fail if your vendored copy is out-of-date and print the Bazel command +to run to update it. For example, `bazel run //.aspect/bazelrc:update_aspect_bazelrc_presets`. + +See the [bazelrc](https://github.com/aspect-build/bazel-examples/blob/main/bazelrc/.aspect/bazelrc/BUILD.bazel) example +in our [bazel-examples](https://github.com/aspect-build/bazel-examples) repository for a working example. diff --git a/.aspect/bazelrc/automatic_updates.md b/.aspect/bazelrc/automatic_updates.md new file mode 100644 index 000000000..d13545943 --- /dev/null +++ b/.aspect/bazelrc/automatic_updates.md @@ -0,0 +1,18 @@ +## Automatic updates + +A convenient way to automatically keep your vendored copy up-to-date is to use the `write_aspect_bazelrc_presets` rule in `.aspect/bazelrc/BUILD.bazel`: + +```python title=".aspect/bazelrc/BUILD.bazel" +"Aspect bazelrc presets; see https://docs.aspect.build/guides/bazelrc" + +load("@aspect_bazel_lib//lib:bazelrc_presets.bzl", "write_aspect_bazelrc_presets") + +write_aspect_bazelrc_presets(name = "update_aspect_bazelrc_presets") +``` + +When `@aspect_bazel_lib` is upgraded in your `WORKSPACE.bazel` or your `MODULE.bazel` file, a `diff_test` +stamped out by `write_aspect_bazelrc_presets` will fail if your vendored copy is out-of-date and print the Bazel command +to run to update it. For example, `bazel run //.aspect/bazelrc:update_aspect_bazelrc_presets`. + +See the [bazelrc](https://github.com/aspect-build/bazel-examples/blob/main/bazelrc/.aspect/bazelrc/BUILD.bazel) example +in our [bazel-examples](https://github.com/aspect-build/bazel-examples) repository for a working example. diff --git a/.aspect/bazelrc/intro.md b/.aspect/bazelrc/intro.md new file mode 100644 index 000000000..553115fc2 --- /dev/null +++ b/.aspect/bazelrc/intro.md @@ -0,0 +1,5 @@ +# Aspect bazelrc presets + +The `.bazelrc` files found here are the source-of-truth for our recommended Bazel presets. + +They are mirrored on our docsite at https://docs.aspect.build/guides/bazelrc. diff --git a/.aspect/bazelrc/usage.md b/.aspect/bazelrc/usage.md new file mode 100644 index 000000000..2060e9634 --- /dev/null +++ b/.aspect/bazelrc/usage.md @@ -0,0 +1,31 @@ +## Using Aspect bazelrc presets in your project + +The `.bazelrc` file can get large, fast. +Some settings don't apply everywhere - some options are appropriate only on CI, +and some vary depending on the version of Bazel you use or languages used. + +Bazel rc files can contain `import` statements, which allow you to organize the content better. + +To use these presets in your project, simply vendor the `*.bazelrc` files from +https://github.com/aspect-build/bazel-lib/tree/main/.aspect/bazelrc into the +`.aspect/bazelrc` folder in your repository and `import` them in your `.bazelrc` file. + +For example, + +```python title=".bazelrc" +# Import Aspect bazelrc presets +import %workspace%/.aspect/bazelrc/bazel6.bazelrc +import %workspace%/.aspect/bazelrc/convenience.bazelrc +import %workspace%/.aspect/bazelrc/correctness.bazelrc +import %workspace%/.aspect/bazelrc/debug.bazelrc +import %workspace%/.aspect/bazelrc/javascript.bazelrc +import %workspace%/.aspect/bazelrc/performance.bazelrc + +### YOUR PROJECT SPECIFIC OPTIONS GO HERE ### + +# Load any settings & overrides specific to the current user from `.aspect/bazelrc/user.bazelrc`. +# This file should appear in `.gitignore` so that settings are not shared with team members. This +# should be last statement in this config so the user configuration is able to overwrite flags from +# this file. See https://bazel.build/configure/best-practices#bazelrc-file. +try-import %workspace%/.aspect/bazelrc/user.bazelrc +``` diff --git a/.bazelrc b/.bazelrc index b822f530a..4827c891a 100644 --- a/.bazelrc +++ b/.bazelrc @@ -1,25 +1,18 @@ # Bazel settings that apply to this repository. # Settings that apply only to CI are in .aspect/bazelrc/ci.bazelrc -# Import Aspect recommended Bazel convenience settings for all projects +# Import Aspect bazelrc presets import %workspace%/.aspect/bazelrc/convenience.bazelrc - -# Import Aspect recommended Bazel correctness settings for all projects import %workspace%/.aspect/bazelrc/correctness.bazelrc - -# Import Aspect recommended Bazel performance settings for all projects import %workspace%/.aspect/bazelrc/performance.bazelrc - -# Import Aspect recommended Bazel debug settings for all projects import %workspace%/.aspect/bazelrc/debug.bazelrc - -# Import Aspect recommended Bazel javascript settings for all projects import %workspace%/.aspect/bazelrc/javascript.bazelrc -# Import Aspect recommended Bazel 6 settings for all projects; -# using a try-import here since this repository is also tested against Bazel 5 on CI +# Use a try-import for Bazel 6 settings since this repository is also tested against Bazel 5 on CI try-import %workspace%/.aspect/bazelrc/bazel6.bazelrc +### PROJECT SPECIFIC OPTIONS ### + # For testing our --stamp behavior. # Normally users would use a --workspace_status_command with a script that calls `git describe`. build --embed_label=v1.2.3 diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel index 2ce1af4b3..a943ed56a 100644 --- a/docs/BUILD.bazel +++ b/docs/BUILD.bazel @@ -128,4 +128,9 @@ stardoc_with_diff_test( bzl_library_target = "//lib:repositories", ) +stardoc_with_diff_test( + name = "bazelrc_presets", + bzl_library_target = "//lib:bazelrc_presets", +) + update_docs() diff --git a/docs/bazelrc_presets.md b/docs/bazelrc_presets.md new file mode 100644 index 000000000..b2d149159 --- /dev/null +++ b/docs/bazelrc_presets.md @@ -0,0 +1,32 @@ + + +Aspect bazelrc presets; see https://docs.aspect.build/guides/bazelrc + + + +## write_aspect_bazelrc_presets + +
+write_aspect_bazelrc_presets(name, presets)
+
+ +Keeps your vendored copy of Aspect recommended `.bazelrc` presets up-to-date. + +This macro uses a [write_source_files](https://docs.aspect.build/rules/aspect_bazel_lib/docs/write_source_files) +rule under the hood to keep your presets up-to-date. + +By default all presets are vendored but this list can be customized using +the 'presets' attribute. + +See https://docs.aspect.build/guides/bazelrc for more info. + + +**PARAMETERS** + + +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| name | a unique name for this target | none | +| presets | a list of preset names to keep up-to-date

For example,

 write_aspect_bazelrc_presets(   name = "update_aspect_bazelrc_presets",   presets = [     "bazel6",     "ci",     "convenience",     "correctness",     "debug",     "javascript",     "performance",   ], )
| ["bazel5", "bazel6", "ci", "convenience", "correctness", "debug", "javascript", "performance"] | + + diff --git a/e2e/bzlmod/.bazelignore b/e2e/bzlmod/.bazelignore new file mode 100644 index 000000000..9877b311d --- /dev/null +++ b/e2e/bzlmod/.bazelignore @@ -0,0 +1 @@ +e2e/bzlmod/.aspect/bazelrc diff --git a/e2e/copy_to_directory/.bazelignore b/e2e/copy_to_directory/.bazelignore new file mode 100644 index 000000000..9877b311d --- /dev/null +++ b/e2e/copy_to_directory/.bazelignore @@ -0,0 +1 @@ +e2e/bzlmod/.aspect/bazelrc diff --git a/e2e/workspace/.bazelignore b/e2e/workspace/.bazelignore new file mode 100644 index 000000000..9877b311d --- /dev/null +++ b/e2e/workspace/.bazelignore @@ -0,0 +1 @@ +e2e/bzlmod/.aspect/bazelrc diff --git a/lib/BUILD.bazel b/lib/BUILD.bazel index 7c57a0a6a..9553a4f94 100644 --- a/lib/BUILD.bazel +++ b/lib/BUILD.bazel @@ -230,3 +230,9 @@ bzl_library( srcs = ["base64.bzl"], deps = ["//lib/private/docs:base64"], ) + +bzl_library( + name = "bazelrc_presets", + srcs = ["bazelrc_presets.bzl"], + deps = [":write_source_files"], +) diff --git a/lib/bazelrc_presets.bzl b/lib/bazelrc_presets.bzl new file mode 100644 index 000000000..46c9d7918 --- /dev/null +++ b/lib/bazelrc_presets.bzl @@ -0,0 +1,59 @@ +"Aspect bazelrc presets; see https://docs.aspect.build/guides/bazelrc" + +load("@aspect_bazel_lib//lib:write_source_files.bzl", "write_source_files") + +ALL_PRESETS = [ + "bazel5", + "bazel6", + "ci", + "convenience", + "correctness", + "debug", + "javascript", + "performance", +] + +def write_aspect_bazelrc_presets( + name, + presets = ALL_PRESETS): + """Keeps your vendored copy of Aspect recommended `.bazelrc` presets up-to-date. + + This macro uses a [write_source_files](https://docs.aspect.build/rules/aspect_bazel_lib/docs/write_source_files) + rule under the hood to keep your presets up-to-date. + + By default all presets are vendored but this list can be customized using + the 'presets' attribute. + + See https://docs.aspect.build/guides/bazelrc for more info. + + Args: + name: a unique name for this target + + presets: a list of preset names to keep up-to-date + + For example, + + ``` + write_aspect_bazelrc_presets( + name = "update_aspect_bazelrc_presets", + presets = [ + "bazel6", + "ci", + "convenience", + "correctness", + "debug", + "javascript", + "performance", + ], + ) + ``` + """ + + files = {} + for p in presets: + files["{}.bazelrc".format(p)] = "@aspect_bazel_lib//.aspect/bazelrc:{}.bazelrc".format(p) + + write_source_files( + name = name, + files = files, + ) diff --git a/lib/tests/bazelrc_presets/BUILD.bazel b/lib/tests/bazelrc_presets/BUILD.bazel new file mode 100644 index 000000000..019a4f61e --- /dev/null +++ b/lib/tests/bazelrc_presets/BUILD.bazel @@ -0,0 +1,16 @@ +"Aspect bazelrc presets; see https://docs.aspect.build/guides/bazelrc" + +load("@aspect_bazel_lib//lib:bazelrc_presets.bzl", "write_aspect_bazelrc_presets") + +write_aspect_bazelrc_presets( + name = "update_aspect_bazelrc_presets", + presets = [ + "bazel5", + "ci", + "convenience", + "correctness", + "debug", + "javascript", + "performance", + ], +) diff --git a/lib/tests/bazelrc_presets/bazel5.bazelrc b/lib/tests/bazelrc_presets/bazel5.bazelrc new file mode 100644 index 000000000..c9d77444d --- /dev/null +++ b/lib/tests/bazelrc_presets/bazel5.bazelrc @@ -0,0 +1,5 @@ +# Performance improvement for WORKSPACE evaluation +# of slow rulesets, for example rules_k8s has been +# observed to take 10 seconds without this flag. +# See https://github.com/bazelbuild/bazel/issues/13907 +common --incompatible_existing_rules_immutable_view diff --git a/lib/tests/bazelrc_presets/ci.bazelrc b/lib/tests/bazelrc_presets/ci.bazelrc new file mode 100644 index 000000000..749c15847 --- /dev/null +++ b/lib/tests/bazelrc_presets/ci.bazelrc @@ -0,0 +1,75 @@ +# We recommend enforcing a policy that keeps your CI from being slowed down +# by individual test targets that should be optimized +# or split up into multiple test targets with sharding or manually. +# Set this flag to exclude targets that have their timeout set to eternal (>15m) from running on CI. +# Docs: https://bazel.build/docs/user-manual#test-timeout-filters +build --test_timeout_filters=-eternal + +# Set this flag to enable re-tries of failed tests on CI. +# When any test target fails, try one or more times. This applies regardless of whether the "flaky" +# tag appears on the target definition. +# This is a tradeoff: legitimately failing tests will take longer to report, +# but we can paper over flaky tests that pass most of the time. +# The alternative is to mark every flaky test with the `flaky = True` attribute, but this requires +# the buildcop to make frequent code edits. +# Not recommended for local builds so that the flakiness is observed during development and thus +# is more likely to get fixed. +# Note that when passing after the first attempt, Bazel will give a special "FLAKY" status. +# Docs: https://bazel.build/docs/user-manual#flaky-test-attempts +build --flaky_test_attempts=2 + +# Announce all announces command options read from the bazelrc file(s) when starting up at the +# beginning of each Bazel invocation. This is very useful on CI to be able to inspect what Bazel rc +# settings are being applied on each run. +# Docs: https://bazel.build/docs/user-manual#announce-rc +build --announce_rc + +# Add a timestamp to each message generated by Bazel specifying the time at which the message was +# displayed. +# Docs: https://bazel.build/docs/user-manual#show-timestamps +build --show_timestamps + +# Only show progress every 60 seconds on CI. +# Docs: https://bazel.build/reference/command-line-reference#flag--progress_report_interval +build --progress_report_interval=60 + +# Only show progress every 60 seconds on CI. +# https://bazel.build/reference/command-line-reference#flag--show_progress_rate_limit +build --show_progress_rate_limit=60 + +# Don't use cursor controls in its screen output. +# Docs: https://bazel.build/docs/user-manual#curses +build --curses=no + +# Use colors to highlight its output on the screen. Set to `no` if your CI does not display colors. +# Docs: https://bazel.build/docs/user-manual#color +build --color=yes + +# The terminal width in columns. Configure this to override the default value based on what your CI system renders. +# Docs: https://github.com/bazelbuild/bazel/blob/1af61b21df99edc2fc66939cdf14449c2661f873/src/main/java/com/google/devtools/build/lib/runtime/UiOptions.java#L151 +build --terminal_columns=80 + +###################################### +# Generic remote cache configuration # +###################################### + +# Only download remote outputs of top level targets to the local machine. +# Docs: https://bazel.build/reference/command-line-reference#flag--remote_download_toplevel +build --remote_download_toplevel + +# The maximum amount of time to wait for remote execution and cache calls. +# https://bazel.build/reference/command-line-reference#flag--remote_timeout +build --remote_timeout=3600 + +# Upload locally executed action results to the remote cache. +# Docs: https://bazel.build/reference/command-line-reference#flag--remote_upload_local_results +build --remote_upload_local_results + +# Fall back to standalone local execution strategy if remote execution fails. If the grpc remote +# cache connection fails, it will fail the build, add this so it falls back to the local cache. +# Docs: https://bazel.build/reference/command-line-reference#flag--remote_local_fallback +build --remote_local_fallback + +# Fixes builds hanging on CI that get the TCP connection closed without sending RST packets. +# Docs: https://bazel.build/reference/command-line-reference#flag--grpc_keepalive_time +build --grpc_keepalive_time=30s diff --git a/lib/tests/bazelrc_presets/convenience.bazelrc b/lib/tests/bazelrc_presets/convenience.bazelrc new file mode 100644 index 000000000..3122d3273 --- /dev/null +++ b/lib/tests/bazelrc_presets/convenience.bazelrc @@ -0,0 +1,29 @@ +# Attempt to build & test every target whose prerequisites were successfully built. +# Docs: https://bazel.build/docs/user-manual#keep-going +build --keep_going +test --keep_going + +# Output test errors to stderr so users don't have to `cat` or open test failure log files when test +# fail. This makes the log noiser in exchange for reducing the time-to-feedback on test failures for +# users. +# Docs: https://bazel.build/docs/user-manual#test-output +test --test_output=errors + +# Show the output files created by builds that requested more than one target. This helps users +# locate the build outputs in more cases +# Docs: https://bazel.build/docs/user-manual#show-result +build --show_result=20 + +# Bazel picks up host-OS-specific config lines from bazelrc files. For example, if the host OS is +# Linux and you run bazel build, Bazel picks up lines starting with build:linux. Supported OS +# identifiers are `linux`, `macos`, `windows`, `freebsd`, and `openbsd`. Enabling this flag is +# equivalent to using `--config=linux` on Linux, `--config=windows` on Windows, etc. +# Docs: https://bazel.build/reference/command-line-reference#flag--enable_platform_specific_config +common --enable_platform_specific_config + +# Output a heap dump if an OOM is thrown during a Bazel invocation +# (including OOMs due to `--experimental_oom_more_eagerly_threshold`). +# The dump will be written to `/.heapdump.hprof`. +# You may need to configure CI to capture this artifact and upload for later use. +# Docs: https://bazel.build/reference/command-line-reference#flag--heap_dump_on_oom +build --heap_dump_on_oom diff --git a/lib/tests/bazelrc_presets/correctness.bazelrc b/lib/tests/bazelrc_presets/correctness.bazelrc new file mode 100644 index 000000000..84b51c258 --- /dev/null +++ b/lib/tests/bazelrc_presets/correctness.bazelrc @@ -0,0 +1,68 @@ +# Do not upload locally executed action results to the remote cache. +# This should be the default for local builds so local builds cannot poison the remote cache. +# It should be flipped to `--remote_upload_local_results` on CI +# by using `--bazelrc=.aspect/bazelrc/ci.bazelrc`. +# Docs: https://bazel.build/reference/command-line-reference#flag--remote_upload_local_results +build --noremote_upload_local_results + +# Don't allow network access for build actions in the sandbox. +# Ensures that you don't accidentally make non-hermetic actions/tests which depend on remote +# services. +# Developers should tag targets with `tags=["requires-network"]` to opt-out of the enforcement. +# Docs: https://bazel.build/reference/command-line-reference#flag--sandbox_default_allow_network +build --sandbox_default_allow_network=false +test --sandbox_default_allow_network=false + +# Warn if a test's timeout is significantly longer than the test's actual execution time. +# Bazel's default for test_timeout is medium (5 min), but most tests should instead be short (1 min). +# While a test's timeout should be set such that it is not flaky, a test that has a highly +# over-generous timeout can hide real problems that crop up unexpectedly. +# For instance, a test that normally executes in a minute or two should not have a timeout of +# ETERNAL or LONG as these are much, much too generous. +# Docs: https://bazel.build/docs/user-manual#test-verbose-timeout-warnings +test --test_verbose_timeout_warnings + +# Allow the Bazel server to check directory sources for changes. Ensures that the Bazel server +# notices when a directory changes, if you have a directory listed in the srcs of some target. +# Recommended when using +# [copy_directory](https://github.com/aspect-build/bazel-lib/blob/main/docs/copy_directory.md) and +# [rules_js](https://github.com/aspect-build/rules_js) since npm package are source directories +# inputs to copy_directory actions. +# Docs: https://bazel.build/reference/command-line-reference#flag--host_jvm_args +startup --host_jvm_args=-DBAZEL_TRACK_SOURCE_DIRECTORIES=1 + +# Allow exclusive tests to run in the sandbox. Fixes a bug where Bazel doesn't enable sandboxing for +# tests with `tags=["exclusive"]`. +# Docs: https://bazel.build/reference/command-line-reference#flag--incompatible_exclusive_test_sandboxed +test --incompatible_exclusive_test_sandboxed + +# Use a static value for `PATH` and does not inherit `LD_LIBRARY_PATH`. Doesn't let environment +# variables like `PATH` sneak into the build, which can cause massive cache misses when they change. +# Use `--action_env=ENV_VARIABLE` if you want to inherit specific environment variables from the +# client, but note that doing so can prevent cross-user caching if a shared cache is used. +# Docs: https://bazel.build/reference/command-line-reference#flag--incompatible_strict_action_env +build --incompatible_strict_action_env + +# Propagate tags from a target declaration to the actions' execution requirements. +# Ensures that tags applied in your BUILD file, like `tags=["no-remote"]` +# get propagated to actions created by the rule. +# Without this option, you rely on rules authors to manually check the tags you passed +# and apply relevant ones to the actions they create. +# See https://github.com/bazelbuild/bazel/issues/8830 for details. +# Docs: https://bazel.build/reference/command-line-reference#flag--experimental_allow_tags_propagation +build --experimental_allow_tags_propagation +fetch --experimental_allow_tags_propagation +query --experimental_allow_tags_propagation + +# Checking the ctime of input files of an action before uploading it to a remote cache. Prevents +# concurrent local file modification from poisoning the build cache. +# Docs: https://bazel.build/reference/command-line-reference#flag--experimental_guard_against_concurrent_changes +build --experimental_guard_against_concurrent_changes + +# Do not automatically create `__init__.py` files in the runfiles of Python targets. Fixes the wrong +# default that comes from Google's internal monorepo by using `__init__.py` to delimit a Python +# package. Precisely, when a `py_binary` or `py_test` target has `legacy_create_init` set to `auto (the +# default), it is treated as false if and only if this flag is set. See +# https://github.com/bazelbuild/bazel/issues/10076. +# Docs: https://bazel.build/reference/command-line-reference#flag--incompatible_default_to_explicit_init_py +build --incompatible_default_to_explicit_init_py diff --git a/lib/tests/bazelrc_presets/debug.bazelrc b/lib/tests/bazelrc_presets/debug.bazelrc new file mode 100644 index 000000000..bfb0bdd4a --- /dev/null +++ b/lib/tests/bazelrc_presets/debug.bazelrc @@ -0,0 +1,19 @@ +############################################################ +# Use `bazel test --config=debug` to enable these settings # +############################################################ + +# Stream stdout/stderr output from each test in real-time. +# Docs: https://bazel.build/docs/user-manual#test-output +test:debug --test_output=streamed + +# Run one test at a time. +# Docs: https://bazel.build/reference/command-line-reference#flag--test_strategy +test:debug --test_strategy=exclusive + +# Prevent long running tests from timing out. +# Docs: https://bazel.build/docs/user-manual#test-timeout +test:debug --test_timeout=9999 + +# Always run tests even if they have cached results. +# Docs: https://bazel.build/docs/user-manual#cache-test-results +test:debug --nocache_test_results diff --git a/lib/tests/bazelrc_presets/javascript.bazelrc b/lib/tests/bazelrc_presets/javascript.bazelrc new file mode 100644 index 000000000..dc768641e --- /dev/null +++ b/lib/tests/bazelrc_presets/javascript.bazelrc @@ -0,0 +1,28 @@ +# Aspect recommended Bazel flags when using Aspect's JavaScript rules: https://github.com/aspect-build/rules_js +# Docs for Node.js flags: https://nodejs.org/en/docs/guides/debugging-getting-started/#command-line-options + +# Support for debugging Node.js tests. Use bazel run with `--config=debug` to turn on the NodeJS +# inspector agent. The node process will break before user code starts and wait for the debugger to +# connect. Pass the --inspect-brk option to all tests which enables the node inspector agent. See +# https://nodejs.org/de/docs/guides/debugging-getting-started/#command-line-options for more +# details. +# Docs: https://nodejs.org/en/docs/guides/debugging-getting-started/#command-line-options +run:debug -- --node_options=--inspect-brk + +# Enable runfiles on all platforms. Runfiles are on by default on Linux and MacOS but off on +# Windows. +# +# In general, rules_js and derivate rule sets assume that runfiles are enabled and do not support no +# runfiles case because it does not scale to teach all Node.js tools to use the runfiles manifest. +# +# If you are developing on Windows, you must either run bazel with administrator privileges or +# enable developer mode. If you do not you may hit this error on Windows: +# +# Bazel needs to create symlinks to build the runfiles tree. +# Creating symlinks on Windows requires one of the following: +# 1. Bazel is run with administrator privileges. +# 2. The system version is Windows 10 Creators Update (1703) or later +# and developer mode is enabled. +# +# Docs: https://bazel.build/reference/command-line-reference#flag--enable_runfiles +build --enable_runfiles diff --git a/lib/tests/bazelrc_presets/performance.bazelrc b/lib/tests/bazelrc_presets/performance.bazelrc new file mode 100644 index 000000000..bc11a3f43 --- /dev/null +++ b/lib/tests/bazelrc_presets/performance.bazelrc @@ -0,0 +1,54 @@ +# Merkle tree calculations will be memoized to improve the remote cache hit checking speed. The +# memory foot print of the cache is controlled by `--experimental_remote_merkle_tree_cache_size`. +# Docs: https://bazel.build/reference/command-line-reference#flag--experimental_remote_merkle_tree_cache +build --experimental_remote_merkle_tree_cache +query --experimental_remote_merkle_tree_cache + +# The number of Merkle trees to memoize to improve the remote cache hit checking speed. Even though +# the cache is automatically pruned according to Java's handling of soft references, out-of-memory +# errors can occur if set too high. If set to 0 the cache size is unlimited. Optimal value varies +# depending on project's size. +# Docs: https://bazel.build/reference/command-line-reference#flag--experimental_remote_merkle_tree_cache_size +build --experimental_remote_merkle_tree_cache_size=1000 +query --experimental_remote_merkle_tree_cache_size=1000 + +# Speed up all builds by not checking if output files have been modified. Lets you make changes to +# the output tree without triggering a build for local debugging. For example, you can modify +# [rules_js](https://github.com/aspect-build/rules_js) 3rd party npm packages in the output tree +# when local debugging. +# Docs: https://github.com/bazelbuild/bazel/blob/1af61b21df99edc2fc66939cdf14449c2661f873/src/main/java/com/google/devtools/build/lib/pkgcache/PackageOptions.java#L185 +build --noexperimental_check_output_files +fetch --noexperimental_check_output_files +query --noexperimental_check_output_files + +# Don't apply `--noremote_upload_local_results` and `--noremote_accept_cached` to the disk cache. +# If you have both `--noremote_upload_local_results` and `--disk_cache`, then this fixes a bug where +# Bazel doesn't write to the local disk cache as it treats as a remote cache. +# Docs: https://bazel.build/reference/command-line-reference#flag--incompatible_remote_results_ignore_disk +build --incompatible_remote_results_ignore_disk + +# Directories used by sandboxed non-worker execution may be reused to avoid unnecessary setup costs. +# Save time on Sandbox creation and deletion when many of the same kind of action run during the +# build. +# No longer experimental in Bazel 6: https://github.com/bazelbuild/bazel/commit/c1a95501a5611878e5cc43a3cc531f2b9e47835b +# Docs: https://bazel.build/reference/command-line-reference#flag--reuse_sandbox_directories +build --experimental_reuse_sandbox_directories + +# Do not build runfiles symlink forests for external repositories under +# `.runfiles/wsname/external/repo` (in addition to `.runfiles/repo`). This reduces runfiles & +# sandbox creation times & prevents accidentally depending on this feature which may flip to off by +# default in the future. Note, some rules may fail under this flag, please file issues with the rule +# author. +# Docs: https://bazel.build/reference/command-line-reference#flag--legacy_external_runfiles +build --nolegacy_external_runfiles +run --nolegacy_external_runfiles +test --nolegacy_external_runfiles + +# Some actions are always IO-intensive but require little compute. It's wasteful to put the output +# in the remote cache, it just saturates the network and fills the cache storage causing earlier +# evictions. It's also not worth sending them for remote execution. +# For actions like PackageTar it's usually faster to just re-run the work locally every time. +# You'll have to look at an execution log to figure out what other action mnemonics you care about. +# In some cases you may need to patch rulesets to add a mnemonic to actions that don't have one. +# https://bazel.build/reference/command-line-reference#flag--modify_execution_info +build --modify_execution_info=PackageTar=+no-remote