workspace_assert_member_revision()
def workspace_assert_member_revision(url, rev)Checks if the workspace satifies a requirement
Args
url-strThe url of the workspace memberrev-strgit/sha256 hash
workspace_assert_member_semver()
def workspace_assert_member_semver(url, semver)Fails if the workspace does not satifies a requirement
Args
url-strThe url of the workspace membersemver-strThe semver requiement assuming the member has a version
workspace_check_member_revision()
def workspace_check_member_revision(url, rev)Checks if the workspace satifies a requirement
Args
url-strThe url of the workspace memberrev-strgit/sha256 hash
Returns
bool True if the workspace member is found at the specified rev, False otherwise
workspace_check_member_semver()
def workspace_check_member_semver(url, semver)Checks if the workspace satifies a requirement
Args
url-strThe url of the workspace membersemver-strThe semver requiement assuming the member has a version
Returns
bool True if the workspace member is found satisfying semver, False otherwise
workspace_get_absolute_path()
def workspace_get_absolute_path()Get the absolute path to the workspace
Returns
str The absolute path to the workspace
workspace_get_build_archive_info()
def workspace_get_build_archive_info(name, archive)Gets the archive info the specified rule and archive
Args
name-strrule name to get info forarchive-strarchive object containing details of how to create the archive
Returns
dict The archive info
workspace_get_cpu_count()
def workspace_get_cpu_count()Get the number of CPUs available
Use info_get_cpu_count(). This will be removed in a future release.
Returns
int The number of CPUs available
workspace_get_env_var()
def workspace_get_env_var(name)Get the value of an environment variable
Args
name-strThe name of the environment variable
Returns
str The value of the environment variable
workspace_get_path_to_checkout()
def workspace_get_path_to_checkout()Get the path in the workspace where the current module is located
Returns
str The path to the checked out repo or archive
workspace_get_path_to_log_file()
def workspace_get_path_to_log_file(name)Gets the path to the log file for a given target.
The log file location changes on every run. Calling this will
effectively call workspace_set_always_evaluate(True) because
the log path location changes with every run.
Args
name-strThe name of the rule
Returns
str The relative workspace path to the log file
workspace_get_path_to_member_with_rev()
def workspace_get_path_to_member_with_rev(url, rev)Gets the path to a workspace member with the specified revision.
If the the specified requirement is not found, the program will exit with an error.
Args
url-strThe url of the workspace memberrev-strthe git or sha256 hash
Returns
str The path to the workspace member.
workspace_get_path_to_member_with_semver()
def workspace_get_path_to_member_with_semver(url, semver)Get the path to a workspace member.
If the the specified requirement is not found, the program will exit with an error. Not all workspace members have versions. The version is set manually during checkout or pulled from the git rev (tag).
Args
url-strThe url of the workspace membersemver-strThe semver requiement assuming the member has a version
Returns
bool The path to the workspace member.
workspace_is_env_var_set()
def workspace_is_env_var_set(name)Check if an environment variable is set
Args
name-strThe name of the environment variable
Returns
bool True if the environment variable is set, False otherwise
workspace_is_reproducible()
def workspace_is_reproducible()Check if the workspace is reproducible
If any repos are on a branch rather than a commit, this will return False.
Use a lock file (see --create-lock-file) to ensure reproducibility.
Returns
bool True if the workspace is reproducible, False otherwise
workspace_set_always_evaluate()
def workspace_set_always_evaluate(value)Set the always evaluate flag for the workspace.
This will prevent spaces from skipping the evaluation phase when running rules in the workspace.
Args
value-