CD-2177: Improve Error Handling for Missing [DEFAULT] Section in Config File

[pvonleh]

Description:

This PR enhances error handling in the configuration file parsing process. If the [DEFAULT] section header is missing, the script will now log an explicit error message. This ensures users receive clear instructions on how to resolve the issue, improving debugging efficiency and configuration setup.

The expected configuration file format:

[DEFAULT]
API_TOKEN=AAAA_Provided_by_Virtru_AAA=
API_TOKEN_ID[email protected]

Additionally, the script now allows flexibility in the order of API_TOKEN and API_TOKEN_ID. Regardless of their order in the config file, the script will execute successfully without errors.

Changes Included:

• Implemented logging to detect and report missing [DEFAULT] section headers.
• Added clear error messages instructing users to add [DEFAULT] as the first line of the config file.
• Ensured multiple occurrences of the error are consistently logged.
• Improved handling of API_TOKEN and API_TOKEN_ID, allowing their order to be interchangeable without causing script failures.

Why This Change is Needed:

• Previously, a missing [DEFAULT] header could lead to unclear script failures.
• This update provides explicit error messages, making it easier for users to diagnose and fix configuration issues.
• Enhances script robustness by ensuring misconfigured files are flagged in logs.
• Improves usability by allowing flexibility in the order of API_TOKEN and API_TOKEN_ID.

Example Log Output:

2025-02-02 05:33:32,627 - ERROR - Add [DEFAULT] as the first line of the config file.
2025-02-02 05:34:02,151 - ERROR - Config file is missing a section header: [DEFAULT]
2025-02-02 05:34:02,151 - ERROR - Add [DEFAULT] as the first line of the config file.
2025-02-02 05:34:47,730 - ERROR - Config file is missing a section header: [DEFAULT]
2025-02-02 05:34:47,730 - ERROR - Add [DEFAULT] as the first line of the config file.

Testing Done:

• Tested with a config file missing [DEFAULT] to confirm proper error logging.
• Verified error messages appear in the log with timestamps for traceability.
• Confirmed that script execution is blocked when [DEFAULT] is missing.
• Tested different placements of API_TOKEN and API_TOKEN_ID to ensure the script runs successfully in all cases.

Reviewer Notes:

• Please verify the clarity and consistency of the error messages.
• Let me know if any improvements are needed for better user guidance.
• Feel free to suggest any additional edge cases that should be considered.