Summary

The goal is to merge the existing CI nightly run script with the ansible-network-triager tool and provide enhanced functionality via a single CLI interface. The tool will be capable of generating bug scrub reports and CI reports, both using a single configuration file (config.yaml) for all inputs and options. The tool will also handle logging, email notifications, and present information in a table format on the CLI.

CLI Commands:

• Bug Scrub Command:
  triager --bugs -c config.yaml --log --send-email

• CI Report Command:
  triager --ci -c config.yaml --log --send-email

Key Features:

• Single Configuration File: All information, such as repository details, email recipients, and credentials, will be stored in config.yaml.
• Logging: The tool will log all operations gracefully.
• Table Output: Bug and CI reports will be displayed in a structured table format in the CLI.
• Email Notifications: Common logic for sending emails will be shared across the bug and CI report options.

Definition of Done

1. Tool Integration:

• • The CI nightly run script is successfully integrated with the ansible-network-triager tool.

1. CLI Options:

• • Bug scrub reports can be generated with triager --bugs.
  • CI reports can be generated with triager --ci.
  • The tool can read inputs and configurations from a single config.yaml file.
  • Email sending is triggered using the --send-email option and is common for both bug and CI reports.

1. Logging:

• • The tool supports graceful logging using the --log flag.

1. CLI Table Output:

• • Bug and CI reports are presented in a clear table format within the CLI.

1. Email Sending:

• • The tool reads email credentials from the configuration file or prompts for input if not provided.
  • Emails are sent based on the command options provided.

1. Code Structure:

• • Shared logic for sending emails is reused across multiple options.
  • The tool is cleanly integrated and runs without issues on both local and containerized environments.

1. Testing:

• • The tool has been tested to verify that bug scrub and CI report functionalities work as expected.
  • Logging, email sending, and CLI table output are tested for both bug and CI report use cases.