Skip to content

Jira Add Component module

Add a component to a JIRA issue.

Raises:

Type Description
Exception

Raised if there is a problem emitted by the API.

main(credential_file, issue, comp)

Add a component to a JIRA issue.

Parameters:

Name Type Description Default
credential_file str

The credential file containing username and password.

 required
issue str

The Jira issue identifier e.g.: JP-478.

 required
comp str

The Jira component.

 required

Raises:

Type Description
Exception

Raised if there is a problem emitted by the API.
Source code in jira_python_utils/jira_add_component.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@click.command()
@click.option('--credential_file', help='credential file containing username and password')
@click.option('--issue', help='The JIRA issue')
@click.option('--comp', help='The JIRA component')
def main(credential_file, issue, comp):
    """Add a component to a JIRA issue.

    Args:
        credential_file (str): The credential file containing username and password.
        issue (str): The Jira issue identifier e.g.: JP-478.
        comp (str): The Jira component.

    Raises:
        Exception: Raised if there is a problem emitted by the API.
    """

    rest_url_file = DEFAULT_URL_FILE
    check_infile_status(rest_url_file)

    if credential_file is None:
        credential_file = DEFAULT_CREDENTIAL_FILE
    check_infile_status(credential_file)

    error_ctr = 0

    if issue is None:
        error_console.print("--issue was not specified")
        error_ctr += 1

    if comp is None:
        error_console.print("--comp was not specified")
        error_ctr += 1

    if error_ctr > 0:
        error_console.print("Required parameter(s) not defined")
        click.echo(click.get_current_context().get_help())
        sys.exit(1)

    auth_jira = get_auth(credential_file, get_jira_url(rest_url_file))

    if auth_jira is None:
        error_console.print("Could not instantiate JIRA auth")
        sys.exit(1)

    console.print(f"Will attempt to add component '{comp}' to JIRA issue '{issue}'")

    try:

        i = auth_jira.issue(issue)
        if i is None:
            raise Exception(f"Could not retrieve issue object for issue '{issue}'")

        # comp = 'report automation'
        i.fields.components.append({'name': comp})
        i.update(fields={'components': i.fields.components})

    except Error as e:
        error_console.print(f"Encountered some exception while attempting to add component '{comp}' to JIRA issue '{issue}': {e}")
        sys.exit(1)
    else:
        console.print("Added component '{comp}' to JIRA issue '{issue}'")