Logs validation on root level

[Cerebrovinny]

what

Added logs validation on root level to block all the incorrect log level usages
e.g atmos version --check --logs-level=asdasd

why

Latest release validation only validates usage in env level
e.g ATMOS_LOGS_LEVEL=Trsace atmos terraform plan asd --stack dev --logs-level=Tra

Evidence:

references

Summary by CodeRabbit

• New Features

  • Added logging configuration flags
    • logs-level with default "Info"
    • logs-file with default "/dev/stdout"

• Tests

  • Enhanced logger test suite with new test functions
    • Added tests for log level enablement
    • Added tests for logging methods
    • Added tests for CLI configuration logging

• Bug Fixes

  • Improved error handling for logging configuration validation

• Chores

  • Simplified error exit code handling in utility function

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces enhanced logging configuration handling in the command-line interface. The changes focus on improving log management by adding new flags for log level and log file, implementing more robust configuration validation, and expanding the test suite for the logger package. The modifications aim to provide more granular control over logging behavior and improve error reporting during configuration initialization.

Changes

File	Change Summary
cmd/root.go	Added logs-level and logs-file flags; enhanced PersistentPreRun with logging configuration validation and error handling
pkg/logger/logger_test.go	Added comprehensive test functions for log level parsing, logger methods, and CLI configuration initialization
pkg/utils/log_utils.go	Simplified LogErrorAndExit function by directly passing exit code to os.Exit()

Possibly related PRs

• Validate Atmos Log Levels #930: Changes involving log level validation, which aligns with the new logging configuration handling

Suggested Labels

major

Suggested Reviewers

• aknysh

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

cmd/root.go (1)

46-51: Consider consolidating configuration structures.

The code creates two separate structures (errorConfig and configAndStacksInfo) with identical logging information. This could lead to maintenance issues if the logging configuration evolves.

Consider consolidating into a single structure or extracting the logging configuration into a shared type:

+type LoggingConfig struct {
+    Level string
+    File  string
+}

-errorConfig := schema.AtmosConfiguration{
-    Logs: schema.Logs{
-        Level: logsLevel,
-        File:  logsFile,
-    },
-}

-configAndStacksInfo := schema.ConfigAndStacksInfo{
-    LogsLevel: logsLevel,
-    LogsFile:  logsFile,
-}

+loggingConfig := LoggingConfig{
+    Level: logsLevel,
+    File:  logsFile,
+}

+errorConfig := schema.AtmosConfiguration{
+    Logs: schema.Logs(loggingConfig),
+}

+configAndStacksInfo := schema.ConfigAndStacksInfo(loggingConfig)

Also applies to: 53-56

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83bd190 and 4871c09.

📒 Files selected for processing (3)

• cmd/root.go (1 hunks)
• pkg/logger/logger_test.go (2 hunks)
• pkg/utils/log_utils.go (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• pkg/utils/log_utils.go

🧰 Additional context used

🪛 golangci-lint (1.62.2)

pkg/logger/logger_test.go

250-250: Error return value of io.Copy is not checked

(errcheck)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Summary

🔇 Additional comments (5)

cmd/root.go (2)

43-44: LGTM! Proper flag retrieval.

The code correctly retrieves the log level and log file flags, which were previously defined in the init function.

---

58-64: LGTM! Robust configuration validation.

The code properly validates the configuration and handles errors, with a special case for the NotFound error which is expected in some scenarios.

pkg/logger/logger_test.go (3)

68-93: LGTM! Comprehensive test cases for log level parsing.

The test cases cover a wide range of scenarios including empty strings, valid levels, and various invalid formats. The table-driven test approach is well-structured and maintainable.

---

179-215: LGTM! Well-structured level enablement tests.

The test cases thoroughly verify the hierarchical nature of log levels and their enablement rules.

---

273-339: LGTM! Comprehensive CLI config tests.

The test cases effectively verify the logger initialization from CLI configuration, including default values and error handling.

[github-actions]

These changes were released in v1.150.0.