bazel-lib/docs/wrap_binary.md

Wraps binary rules to make them more compatible with Bazel.

Currently supports only Bash as the wrapper language, not cmd.exe.

Future additions might include:

• wrap a binary such that it sees a tty on stdin
• manipulate arguments or environment variables
• redirect stdout/stderr, e.g. to silence buildspam on success
• intercept exit code, e.g. to make an "expect_fail"
• change user, e.g. to deal with containerized build running as root, but tool requires non-root
• intercept signals, e.g. to make a tool behave as a Bazel persistent worker

chdir_binary

chdir_binary(name, binary, chdir, kwargs)

Wrap a *_binary to be executed under a given working directory.

Note: under bazel run, this is similar to the --run_under "cd $PWD &&" trick, but is hidden from the user so they don't need to know about that flag.

PARAMETERS

Name	Description	Default Value
name	Name of the rule.	none
binary	Label of an executable target to wrap.	none
chdir	Argument for the cd command. By default, supports using the binary under bazel run by running program in the root of the Bazel workspace, in the source tree.	"$BUILD_WORKSPACE_DIRECTORY"
kwargs	Additional named arguments for the resulting sh_binary rule.	none

tty_binary

tty_binary(name, binary, runfiles_manifest_key, kwargs)

Wrap a binary such that it sees a tty attached to its stdin

PARAMETERS

Name	Description	Default Value
name	Name of the rule	none
binary	Label of an executable target to wrap	none
runfiles_manifest_key	WORKAROUND: a lookup into the runfiles manifest for the binary	none
kwargs	Additional named arguments for the resulting sh_binary rule.	none