def build_show(build_id,
open_browser=False,
team_instance=None,
project=None,
detect=None):
"""Get the details of a build.
:param build_id: ID of the build.
:type build_id: int
:param open_browser: Open the build results page in your web browser.
:type open_browser: bool
:param team_instance: VSTS account or TFS collection URL. Example: https://myaccount.visualstudio.com
:type team_instance: str
:param project: Name or ID of the team project.
:type project: str
:param detect: Automatically detect instance and project. Default is "on".
:type detect: str
:rtype: :class:`<Build> <build.v4_0.models.Build>`
"""
try:
team_instance, project = resolve_instance_and_project(
detect=detect, team_instance=team_instance, project=project)
client = get_build_client(team_instance)
build = client.get_build(build_id=build_id, project=project)
if open_browser:
_open_build(build, team_instance)
return build
except Exception as ex:
handle_command_exception(ex)
def build_queue(definition_id=None,
definition_name=None,
branch=None,
variables=None,
open_browser=False,
team_instance=None,
project=None,
detect=None,
source_branch=None):
"""Request (queue) a build.
:param definition_id: ID of the definition to queue. Required if --name is not supplied.
:type definition_id: int
:param definition_name: Name of the definition to queue. Ignored if --id is supplied.
:type definition_name: str
:param branch: Branch to build. Required if there is not a default branch set up on the definition. Example: "dev".
:type branch: str
:param variables: Space separated "name=value" pairs for the variables you would like to set.
:type variables: [str]
:param open_browser: Open the build results page in your web browser.
:type open_browser: bool
:param team_instance: VSTS account or TFS collection URL. Example: https://myaccount.visualstudio.com
:type team_instance: str
:param project: Name or ID of the team project.
:type project: str
:param detect: Automatically detect instance and project. Default is "on".
:type detect: str
:param source_branch: Obsolete. Use --branch instead.
:type source_branch: str
:rtype: :class:`<Build> <build.v4_0.models.Build>`
"""
if branch is None:
branch = source_branch
team_instance, project = resolve_instance_and_project(
detect=detect, team_instance=team_instance, project=project)
if definition_id is None and definition_name is None:
raise ValueError(
'Either the --definition-id argument or the --definition-name argument '
+ 'must be supplied for this command.')
client = get_build_client(team_instance)
if definition_id is None:
definition_id = get_definition_id_from_name(definition_name, client,
project)
definition_reference = DefinitionReference(id=definition_id)
build = Build(definition=definition_reference)
build.source_branch = resolve_git_ref_heads(branch)
if variables is not None and variables:
build.parameters = {}
for variable in variables:
separator_pos = variable.find('=')
if separator_pos >= 0:
build.parameters[
variable[:separator_pos]] = variable[separator_pos + 1:]
else:
raise ValueError(
'The --variables argument should consist of space separated "name=value" pairs.'
)
queued_build = client.queue_build(build=build, project=project)
if open_browser:
_open_build(queued_build, team_instance)
return queued_build
def build_list(definition_ids=None,
branch=None,
team_instance=None,
project=None,
detect=None,
top=None,
result=None,
status=None,
reason=None,
tags=None,
requested_for=None):
"""List build results.
:param definition_ids: IDs (space separated) of definitions to list builds for.
:type definition_ids: list of int
:param branch: Filter by builds for this branch.
:type branch: str
:param team_instance: VSTS account or TFS collection URL. Example: https://myaccount.visualstudio.com
:type team_instance: str
:param project: Name or ID of the team project.
:type project: str
:param detect: Automatically detect instance and project. Default is "on".
:type detect: str
:param top: Maximum number of builds to list.
:type top: int
:param result: Limit to builds with this result.
:type result: str
:param status: Limit to builds with this status.
:type status: str
:param reason: Limit to builds with this reason.
:type reason: str
:param tags: Limit to builds with each of the specified tags. Space separated.
:type tags: list of str
:param requested_for: Limit to builds requested for this user or group.
:type requested_for: str
:rtype: :class:`<Build> <build.v4_0.models.Build>`
"""
try:
team_instance, project = resolve_instance_and_project(
detect=detect, team_instance=team_instance, project=project)
client = get_build_client(team_instance)
if definition_ids is not None and definition_ids:
definition_ids = list(set(definition_ids)) # make distinct
if tags is not None and tags:
tags = list(set(tags)) # make distinct
builds = client.get_builds(definitions=definition_ids,
project=project,
branch_name=resolve_git_ref_heads(branch),
top=top,
result_filter=result,
status_filter=status,
reason_filter=reason,
tag_filters=tags,
requested_for=resolve_identity_as_id(
requested_for, team_instance))
return builds
except Exception as ex:
handle_command_exception(ex)
def build_definition_list(name=None,
top=None,
team_instance=None,
project=None,
repository=None,
repository_type=None,
detect=None):
"""List build definitions.
:param name: Limit results to definitions with this name or starting with this name. Examples: "FabCI" or "Fab*"
:type name: bool
:param top: Maximum number of definitions to list.
:type top: int
:param team_instance: VSTS account or TFS collection URL. Example: https://myaccount.visualstudio.com
:type team_instance: str
:param project: Name or ID of the team project.
:type project: str
:param repository: Limit results to definitions associated with this repository.
:type repository: str
:param repository_type: Limit results to definitions associated with this repository type. It is mandatory to pass 'repository' argument along with this argument.
:type repository_type: str
:param detect: Automatically detect values for instance and project. Default is "on".
:type detect: str
:rtype: [BuildDefinitionReference]
"""
team_instance, project, repository = resolve_instance_project_and_repo(
detect=detect,
team_instance=team_instance,
project=project,
repo=repository)
client = get_build_client(team_instance)
query_order = 'DefinitionNameAscending'
if repository is not None:
if repository_type is None:
repository_type = 'TfsGit'
if repository_type.lower() == 'tfsgit':
resolved_repository = _resolve_repository_as_id(
repository, team_instance, project)
else:
resolved_repository = repository
if resolved_repository is None:
raise ValueError(
"Could not find a repository with name '{}' in project '{}'.".
format(repository, project))
else:
resolved_repository = None
definition_references = client.get_definitions(
project=project,
name=name,
repository_id=resolved_repository,
repository_type=repository_type,
top=top,
query_order=query_order)
return definition_references
def build_queue(definition_id=None,
definition_name=None,
source_branch=None,
open_browser=False,
team_instance=None,
project=None,
detect=None):
"""Request (queue) a build.
:param definition_id: ID of the definition to queue. Required if --name is not supplied.
:type definition_id: int
:param definition_name: Name of the definition to queue. Ignored if --id is supplied.
:type definition_name: str
:param source_branch: Branch to build. Example: "dev".
:type source_branch: str
:param open_browser: Open the build results page in your web browser.
:type open_browser: bool
:param team_instance: VSTS account or TFS collection URL. Example: https://myaccount.visualstudio.com
:type team_instance: str
:param project: Name or ID of the team project.
:type project: str
:param detect: Automatically detect instance and project. Default is "on".
:type detect: str
:rtype: :class:`<Build> <build.v4_0.models.Build>`
"""
try:
team_instance, project = resolve_instance_and_project(
detect=detect, team_instance=team_instance, project=project)
if definition_id is None and definition_name is None:
raise ValueError(
'Either the --definition-id argument or the --definition-name argument '
+ 'must be supplied for this command.')
client = get_build_client(team_instance)
if definition_id is None:
definition_id = get_definition_id_from_name(
definition_name, client, project)
definition_reference = DefinitionReference(id=definition_id)
build = Build(definition=definition_reference)
if source_branch is not None:
build.source_branch = resolve_git_ref_heads(source_branch)
queued_build = client.queue_build(build=build, project=project)
if open_browser:
_open_build(queued_build, team_instance)
return queued_build
except Exception as ex:
handle_command_exception(ex)
def build_definition_show(definition_id=None,
name=None,
open_browser=False,
team_instance=None,
project=None,
detect=None):
"""Get the details of a build definition.
:param definition_id: ID of the definition.
:type definition_id: int
:param name: Name of the definition. Ignored if --id is supplied.
:type name: str
:param open_browser: Open the definition summary page in your web browser.
:type open_browser: bool
:param team_instance: VSTS account or TFS collection URL. Example: https://myaccount.visualstudio.com
:type team_instance: str
:param project: Name or ID of the team project.
:type project: str
:param detect: Automatically detect values for instance and project. Default is "on".
:type detect: str
:rtype: BuildDefinitionReference
"""
try:
team_instance, project = resolve_instance_and_project(
detect=detect, team_instance=team_instance, project=project)
client = get_build_client(team_instance)
if definition_id is None:
if name is not None:
definition_id = get_definition_id_from_name(
name, client, project)
else:
raise ValueError(
"Either the --id argument or the --name argument must be supplied for this command."
)
build_definition = client.get_definition(definition_id=definition_id,
project=project)
if open_browser:
_open_definition(build_definition, team_instance)
return build_definition
except Exception as ex:
handle_command_exception(ex)
