Env Var Expansion and Cleanup #23
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`TemplateVariableInfo` provides a mechanism for custom make variable expansion. `string_flag()` contains a simple (pre-built) way to generate flags. This be used with `config_setting()` and can be set via commandline (without `--define`). `TemplateVariableInfo` support was added to `string_flag()` in bazelbuild/bazel-skylib#440. Many other Bazel target rules support make variable expansion on many attributes (e.g. `env`). This PR adds support for `TemplateVariableInfo` (e.g. via `string_flag()`) to bats bazel test rules on the `env` attribute. Changes: * Adding call to `ctx.expand_make_variables()` in `_bats_test_impl()`. * This is done in addition to (after) expansion for `$(location ...)`. * Updating `:hello_world_test` (which tests `env` attribute usage) to also test flag-driven envs. * Adding `@bazel_skylib` to workspace. * Only used to declare/reference `string_flag()` in `tests/BUILD.bazel`. * While this could have been simply covered by a custom rule (to return a `TemplateVariableInfo`) in a test-specific `.bzl` file, it seemed better to just use the common (external/pre-existing) rule. * Refenced via `git_repository()` as the necessary changes are not yet in a tag/release. * Only affects tests, and thus does not cause any extra transitive dependencies on libraries that use this project. * Misc other changes: * Updating bats-support and bats-assert rules to use `glob()`. * Supports newer versions, which separated out contents into multiple `.bash` files. * More flexible than naming exact file names. * Replacing attribute dict `update()` call with dict concat operator `|`. * Renaming some test cases in `hello_world.bats`. See https://bazel.build/rules/lib/providers/TemplateVariableInfo, https://bazel.build/docs/configurable-attributes, https://bazel.build/reference/be/general#config_setting, https://bazel.build/extending/config#defining-build-settings
filmil
requested changes
Oct 27, 2023
filmil
approved these changes
Oct 27, 2023
|
Thanks for the fast review and merge. Can you make a new release/tag with these changes? Thanks! Edit: I see that you already did. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TemplateVariableInfoprovides a mechanism for custom make variable expansion.string_flag()contains a simple (pre-built) way to generate flags. This be used withconfig_setting()and can be set via commandline (without--define).TemplateVariableInfosupport was added tostring_flag()in bazelbuild/bazel-skylib#440.Many other Bazel target rules support make variable expansion on many attributes (e.g.
env). This PR adds support forTemplateVariableInfo(e.g. viastring_flag()or other custom rule) to bats bazel test rules on theenvattribute.Changes:
ctx.expand_make_variables()in_bats_test_impl().$(location ...).:hello_world_test(which testsenvattribute usage) to also test flag-driven envs.@bazel_skylibto workspace.string_flag()intests/BUILD.bazel.TemplateVariableInfo) in a test-specific.bzlfile, it seemed better to just use the common (external/pre-existing) rule.git_repository()(instead ofhttp_archive()) as the necessary changes are not yet in a tag/release.glob()..bashfiles.update()call with dict concat operator|.hello_world.bats.See https://bazel.build/rules/lib/providers/TemplateVariableInfo, https://bazel.build/docs/configurable-attributes, https://bazel.build/reference/be/general#config_setting, https://bazel.build/extending/config#defining-build-settings