Skip to content

chore: standardize log messages#362

Merged
JenGoldstrich merged 1 commit intomainfrom
chore/standardize-log-messages
Aug 15, 2025
Merged

chore: standardize log messages#362
JenGoldstrich merged 1 commit intomainfrom
chore/standardize-log-messages

Conversation

@tenthirtyam
Copy link
Copy Markdown
Collaborator

Description

Standardizes and improves the clarity of log messages throughout the VMware builder codebase by updating the phrasing of log outputs and consistently adding log level prefixes (such as [INFO] and [WARN]). This helps make log output more uniform and easier to interpret, which is beneficial for both debugging and monitoring. Additionally, several test assertions have been updated to use clearer error messages.

  • Added [INFO] and [WARN] prefixes to log messages in driver.go, driver_esxi.go, driver_workstation_windows.go, step_configure_vnc.go, step_output_dir.go, and step_remote_upload.go, ensuring consistent log levels and improved readability. [1] [2] [3] [4] [5] [6]
  • Updated log message phrasing for error handling to use "Failed to..." instead of "Error..." or "Unable to...", making the messages more direct and standardized. [1] [2] [3] [4] [5] [6] [7]
  • Changed error messages in test assertions from "Unable to..." to "Failed to..." for improved clarity and consistency in driver_parser_test.go and hw_config_test.go. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]
  • Improved log messages to better describe actions and outcomes, such as device and MAC address discoveries, and cloning/uploading operations. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

These changes collectively make the codebase's logging and error reporting more consistent and easier to understand for future maintenance and debugging.

Rollback Plan

Revert commit.

Changes to Security Controls

None.

Updated log messages across components to consistently use [INFO] and [WARN] prefixes and improved error descriptions for clarity. This change enhances log readability and makes error handling more uniform throughout the codebase.

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
@tenthirtyam tenthirtyam added this to the v2.0.0 milestone Aug 15, 2025
@tenthirtyam tenthirtyam self-assigned this Aug 15, 2025
@tenthirtyam tenthirtyam added the chore Chore label Aug 15, 2025
@tenthirtyam tenthirtyam requested a review from a team as a code owner August 15, 2025 20:55
@tenthirtyam tenthirtyam requested a review from kp2099 August 15, 2025 20:55
@JenGoldstrich JenGoldstrich merged commit 4088d03 into main Aug 15, 2025
14 checks passed
@JenGoldstrich JenGoldstrich deleted the chore/standardize-log-messages branch August 15, 2025 21:52
@github-actions
Copy link
Copy Markdown

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

chore Chore

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants