integration_test_utils.md

integration_test_utils API

integration_test_utils.bazel_binary_label

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.bazel_binary_label(version)

Returns a label for the specified Bazel version as provided by https://github.com/bazelbuild/bazel-integration-testing.

PARAMETERS

Name	Description	Default Value
version	A string value representing the semantic version of Bazel to use for the integration test.	none

RETURNS

A string representing a label for a version of Bazel.

integration_test_utils.bazel_binary_repo_name

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.bazel_binary_repo_name(version)

Generates a Bazel binary repository name for the specified version.

PARAMETERS

Name	Description	Default Value
version	A string that represents a Bazel version or a label.	none

RETURNS

A string that is suitable for use as a repository name.

integration_test_utils.bazel_integration_test_name

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.bazel_integration_test_name(name, version)

Generates a test name from the provided base name and the Bazel version.

PARAMETERS

Name	Description	Default Value
name	The base name as a string.	none
version	The Bazel semantic version as a string.	none

RETURNS

A string that is suitable as an integration test name.

integration_test_utils.bazel_integration_test_names

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.bazel_integration_test_names(name, versions)

Generates a list of integration test names based upon the provided base name and versions.

PARAMETERS

Name	Description	Default Value
name	The base name as a string.	none
versions	A list of semantic version string values.	[]

RETURNS

A list of integration test names as string values.

integration_test_utils.glob_workspace_files

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.glob_workspace_files(workspace_path)

Recursively globs the Bazel workspace files at the specified path.

PARAMETERS

Name	Description	Default Value
workspace_path	A string representing the path to glob.	none

RETURNS

A list of the files under the specified path ignoring certain Bazel artifacts (e.g. bazel-*).

integration_test_utils.is_version_file

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.is_version_file(version)

Determines if the version string is a reference to a version file.

PARAMETERS

Name	Description	Default Value
version	A string that represents a Bazel version or a label.	none

RETURNS

A bool the specifies whether the string is a file reference.

integration_test_utils.semantic_version_to_name

load("@rules_bazel_integration_test//bazel_integration_test:defs.bzl", "integration_test_utils")

integration_test_utils.semantic_version_to_name(version)

Converts a semantic version string (e.g. X.Y.Z) to a suitable name string (e.g. X_Y_Z).

PARAMETERS

Name	Description	Default Value
version	A semantic version string.	none

RETURNS

A string that is suitable for use in a label or filename.