Jira To Confluence Weekly Progress Report module

Retrieve the list of resolved issues for the specified assignee between the start date and end date and create a Confluence page with the list of issues.

`create_html_content(jira_issue_base_url, title, issues, config)`

Create the HTML table that will be inserted into the new Confluence page.

Parameters:

Name	Type	Description	Default
`jira_issue_base_url`	`str`	The JIRA issue base url.	required
`title`	`str`	The title of the Confluence page.	required
`issues`	`List[Any]`	The list of issues.	required
`config`	`Dict[str, Any]`	The configuration object.	required

Returns: str: The HTML table.

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def create_html_content(
    jira_issue_base_url: str,
    title: str,
    issues: List[Any],
    config: Dict[str, Any]) -> str:
    """Create the HTML table that will be inserted into the new Confluence
    page.

    Args:
        jira_issue_base_url (str): The JIRA issue base url.
        title (str): The title of the Confluence page.
        issues (List[Any]): The list of issues.
        config (Dict[str, Any]): The configuration object.
    Returns:
        str: The HTML table.
    """
    in_development_color = config['confluence']['status']['color_codes']['in_development']
    done_color = config['confluence']['status']['color_codes']['done']

    logging.info(f"Will add '{len(issues)}' issues to the HTML table for Confluence page with title '{title}'")

    content = []
    content.append(f"<html><body><h3>{title}</h3>")
    content.append("""<table>
        <thead>
            <tr>
                <th>Issue</th>
                <th>Summary</th>
                <th>Type</th>
                <th>Priority</th>
                <th>Status</th>
            </tr>
        </thead>
        <tbody>""")

    for issue in issues:
        status = issue.fields.status.name
        if status.lower() == 'in development' or status.lower() == 'done' or status.lower() == 'on hold':
            content.append(f"<tr><td><a href='{jira_issue_base_url}/{issue}' target='_blank'>{issue}</a></td>")
            content.append(f"<td>{issue.fields.summary}</td>")
            content.append(f"<td>{issue.fields.issuetype.name}</td>")
            content.append(f"<td>{issue.fields.priority.name}</td>")
            if status.lower() == 'done':
                content.append(f"<td style='font-weight: bold; color: {done_color}'>{status}</td></tr>")
            elif status.lower() == 'in development':
                content.append(f"<td style='font-weight: bold; color: {in_development_color}'>{status}</td></tr>")
            elif status.lower() == 'on hold':
                content.append(f"<td style='font-weight: bold; color: {in_development_color}'>{status}</td></tr>")
            else:
                content.append(f"<td>{status}</td></tr>")

    content.append("</tbody></table></body></html>")
    return "\n".join(content)

`get_in_development_issues(start_date, end_date, assignee, auth_jira)`

Get the list of issues that are in development for the specified assignee between the start date and end date.

Parameters:

Name	Type	Description	Default
`start_date`	`str`	The start date in the format 'YYYY-MM-DD'.	required
`end_date`	`str`	The end date in the format 'YYYY-MM-DD'.	required
`assignee`	`str`	The assignee.	required
`auth_jira`	`JIRA`	The authenticated JIRA object.	required

Returns: List[Any]: The list of issues that are in development.

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def get_in_development_issues(start_date: str, end_date: str, assignee: str, auth_jira: JIRA) -> List[Any]:
    """Get the list of issues that are in development for the specified assignee between the start date and end date.

    Args:
        start_date (str): The start date in the format 'YYYY-MM-DD'.
        end_date (str): The end date in the format 'YYYY-MM-DD'.
        assignee (str): The assignee.
        auth_jira (JIRA): The authenticated JIRA object.
    Returns:
        List[Any]: The list of issues that are in development.
    """
    query = f"""status = 'In Development' AND updated>= {start_date} AND updated <= {end_date}"""

    if assignee is not None:
        query = f"""{query} AND assignee in ({assignee})"""
        logging.info(f"Added assignee '{assignee}' to the query: {query}")

    return get_issues(query, auth_jira)

`get_issues(query, auth_jira)`

Get the list of issues for the specified query.

Parameters:

Name	Type	Description	Default
`query`	`str`	The JQL query.	required
`auth_jira`	`JIRA`	The authenticated JIRA object.	required

Returns:

Type	Description
`List[Any]`	List[Any]: The list of issues.

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def get_issues(query: str, auth_jira: JIRA) -> List[Any]:
    """Get the list of issues for the specified query.

    Args:
        query (str): The JQL query.
        auth_jira (JIRA): The authenticated JIRA object.

    Returns:
        List[Any]: The list of issues.
    """
    logging.info(f"Will attempt to retrieve issues with query '{query}'")

    try:
        issues = auth_jira.search_issues(query)

    except Exception as e:
        print_red(f"Encountered some exception while attempting to query with JQL '{query}' : '{e}'")
        sys.exit(1)
    else:
        print("Query was successful")
    return issues

`get_jira_issue_base_url(config)`

Get the JIRA issue base url from the configuration file.

Parameters:

Name	Type	Description	Default
`config`	`Dict[str, Any]`	The configuration object.	required

Returns:

Name	Type	Description
`str`	`str`	The JIRA issue base url.

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def get_jira_issue_base_url(config: Dict[str, Any]) -> str:
    """Get the JIRA issue base url from the configuration file.

    Args:
        config (Dict[str, Any]): The configuration object.

    Returns:
        str: The JIRA issue base url.
    """
    jira_issue_base_url = config['jira']['issue_base_url']
    if jira_issue_base_url is None or jira_issue_base_url == '':
        print_red("Could not find the JIRA issue base url in the configuration file")
        sys.exit(1)

    if jira_issue_base_url.endswith('/'):
        jira_issue_base_url = jira_issue_base_url.rstrip('/')

    return jira_issue_base_url

`get_on_hold_issues(start_date, end_date, assignee, auth_jira)`

Get the list of issues that are on hold for the specified assignee between the start date and end date.

Parameters:

Name	Type	Description	Default
`start_date`	`str`	The start date in the format 'YYYY-MM-DD'.	required
`end_date`	`str`	The end date in the format 'YYYY-MM-DD'.	required
`assignee`	`str`	The assignee.	required
`auth_jira`	`JIRA`	The authenticated JIRA object.	required

Returns: List[Any]: The list of issues that are on hold.

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def get_on_hold_issues(start_date: str, end_date: str, assignee: str, auth_jira: JIRA) -> List[Any]:
    """Get the list of issues that are on hold for the specified assignee between the start date and end date.

    Args:
        start_date (str): The start date in the format 'YYYY-MM-DD'.
        end_date (str): The end date in the format 'YYYY-MM-DD'.
        assignee (str): The assignee.
        auth_jira (JIRA): The authenticated JIRA object.
    Returns:
        List[Any]: The list of issues that are on hold.
    """
    query = f"""status = 'On Hold' AND updated>= {start_date} AND updated <= {end_date}"""

    if assignee is not None:
        query = f"""{query} AND assignee in ({assignee})"""
        logging.info(f"Added assignee '{assignee}' to the query: {query}")

    return get_issues(query, auth_jira)

`get_resolved_issues(start_date, end_date, assignee, auth_jira)`

Get the list of resolved issues for the specified assignee between the start date and end date.

Parameters:

Name	Type	Description	Default
`start_date`	`str`	The start date in the format 'YYYY-MM-DD'	required
`end_date`	`str`	The end date in the format 'YYYY-MM-DD'	required
`assignee`	`str`	The assignee	required
`auth_jira`	`JIRA`	The authenticated JIRA object	required

Returns: List[Any]: The list of resolved issues

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def get_resolved_issues(start_date: str, end_date: str, assignee: str, auth_jira: JIRA) -> List[Any]:
    """Get the list of resolved issues for the specified assignee between the start date and end date.

    Args:
        start_date (str): The start date in the format 'YYYY-MM-DD'
        end_date (str): The end date in the format 'YYYY-MM-DD'
        assignee (str): The assignee
        auth_jira (JIRA): The authenticated JIRA object
    Returns:
        List[Any]: The list of resolved issues
    """
    query = f"""resolved >= {start_date} AND resolved <= {end_date}"""

    if assignee is not None:
        query = f"""{query} AND assignee in ({assignee})"""
        logging.info(f"Added assignee '{assignee}' to the query: {query}")

    return get_issues(query, auth_jira)

`get_weekly_ranges(config, config_file)`

Retrieve the weekly ranges from the configuration file.

Parameters:

Name	Type	Description	Default
`config`	`Dict[str, Any]`	The configuration object.	required
`config_file`	`str`	The configuration file.	required

Returns:

Type	Description
`List[Dict[str, str]]`	List[Dict[str, str]]: The list of weekly ranges.

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

def get_weekly_ranges(config: Dict[str, Any], config_file: str) -> List[Dict[str, str]]:
    """Retrieve the weekly ranges from the configuration file.

    Args:
        config (Dict[str, Any]): The configuration object.
        config_file (str): The configuration file.

    Returns:
        List[Dict[str, str]]: The list of weekly ranges.
    """

    if 'weekly' not in config['jira']:
        print_red(f"'weekly' section does not exist in configuration file '{config_file}'")
        sys.exit(1)

    return config['jira']['weekly']

`main(assignee, config_file, credential_file, logfile, outdir, query)`

Retrieve the list of resolved issues for the specified assignee between the start date and end date and create a Confluence page with the list of issues.

Parameters:

Name	Type	Description	Default
`assignee`	`str`	The assignee.	required
`config_file`	`Optional[str]`	The configuration file.	required
`credential_file`	`Optional[str]`	The credential file.	required
`logfile`	`Optional[str]`	The log file.	required
`outdir`	`Optional[str]`	The output directory.	required
`query`	`str`	The Jira jql query string.	required

Source code in jira_python_utils/jira_to_confluence_weekly_progress_report.py

@click.command()
@click.option('--assignee', help='The assignee')
@click.option('--config_file', type=click.Path(exists=True), help=f"The configuration file - default is '{DEFAULT_CONFIG_FILE}'")
@click.option('--credential_file', help='credential file containing username and password')
@click.option('--logfile', help="The log file")
@click.option('--outdir', help=f"The default is the current working directory - default is '{DEFAULT_OUTDIR}'")
@click.option('--query', help='The Jira jql query string')
def main(assignee: str, config_file: Optional[str], credential_file: Optional[str], logfile: Optional[str], outdir: Optional[str], query: str):
    """Retrieve the list of resolved issues for the specified assignee between the start date and end date and create a Confluence page with the list of issues.

    Args:
        assignee (str): The assignee.
        config_file (Optional[str]): The configuration file.
        credential_file (Optional[str]): The credential file.
        logfile (Optional[str]): The log file.
        outdir (Optional[str]): The output directory.
        query (str): The Jira jql query string.
    """

    rest_url_file = DEFAULT_URL_FILE
    check_infile_status(rest_url_file, "txt")

    url = get_rest_url(rest_url_file)

    if credential_file is None:
        credential_file = DEFAULT_CREDENTIAL_FILE

    check_infile_status(credential_file)

    error_ctr = 0

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

    if outdir is None:
        outdir = DEFAULT_OUTDIR
        print_yellow(f"--outdir was not specified and therefore was set to '{outdir}'")

    if not os.path.exists(outdir):
        pathlib.Path(outdir).mkdir(parents=True, exist_ok=True)
        print_yellow(f"Created output directory '{outdir}'")

    if logfile is None:
        logfile = os.path.join(
            outdir,
            os.path.splitext(os.path.basename(__file__))[0] + '.log'
        )
        print_yellow(f"--logfile was not specified and therefore was set to '{logfile}'")

    if config_file is None:
        config_file = DEFAULT_CONFIG_FILE
        print_yellow(f"--config_file was not specified and therefore was set to '{config_file}'")

    check_infile_status(config_file, "yaml")

    logging.basicConfig(
        filename=logfile,
        format=LOGGING_FORMAT,
        level=LOG_LEVEL
    )

    logging.info(f"Loading configuration from '{config_file}'")
    config = yaml.safe_load(pathlib.Path(config_file).read_text())

    if 'jira' not in config:
        print_red(f"'jira' section does not exist in configuration file '{config_file}'")
        sys.exit(1)

    week_ranges = get_weekly_ranges(config, config_file)

    logging.info(f"Found '{len(week_ranges)}' week ranges in the configuration file '{config_file}'")

    if assignee is None and 'assignee' in config['jira']:
        assignee = config['jira']['assignee']
        logging.info(f"Retrieved assignee '{assignee}' from the configuration file '{config_file}'")

    jira_issue_base_url = get_jira_issue_base_url(config)

    auth_jira, auth = get_auth_jira(credential_file, url)

    for week_range in week_ranges:

        start_date = week_range['start_date']
        end_date = week_range['end_date']
        print_yellow(f"{start_date=} {end_date=}")

        resolved_issues = get_resolved_issues(
            start_date,
            end_date,
            assignee,
            auth_jira
        )

        # in_development_issues = get_in_development_issues(
        #     start_date,
        #     end_date,
        #     assignee,
        #     auth_jira
        # )

        # on_hold_issues = get_on_hold_issues(
        #     start_date,
        #     end_date,
        #     assignee,
        #     auth_jira
        # )

        # issues = resolved_issues + in_development_issues + on_hold_issues
        # issues = on_hold_issues
        issues = resolved_issues

        confluence_page_name = f"Jay's Weekly Progress Report between '{start_date}' and '{end_date}'"

        html_content = create_html_content(
            jira_issue_base_url,
            confluence_page_name,
            issues,
            config,
        )

        manager = ConfluenceManager(
            outdir=outdir,
            config=config,
            config_file=config_file,
        )

        manager.create_page(
            auth=auth,
            title=confluence_page_name,
            html_content=html_content
        )