Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/env load #178

Closed

Conversation

Paras-Wednesday
Copy link
Collaborator

@Paras-Wednesday Paras-Wednesday commented Sep 26, 2024

Ticket Link


Related Links


Description


  • It fixes the loading of the Db credentials from the secret manager for local env

Steps to Reproduce / Test


  • go test -gcflags=all=-l go-template/internal/config -run TestLoadEnv

Request


Response


Summary by CodeRabbit

  • New Features

    • Improved error handling for loading environment variables with more descriptive messages.
    • Added functionality to extract database credentials from a secret manager for non-local environments.
  • Bug Fixes

    • Enhanced tests to cover various scenarios for loading environment variables and handling database credentials.
  • Tests

    • Introduced new test cases for different environment settings and error conditions related to database credential management.

Copy link

coderabbitai bot commented Sep 26, 2024

Walkthrough

The changes involve enhancements to the LoadEnv function in internal/config/env.go, introducing a new helper function for extracting database credentials from a secret. A constant for local environment representation is defined, improving code clarity. Error handling is also refined. In internal/config/env_test.go, new test cases are added, and existing ones are modified to better cover various scenarios related to environment variable injection and database credential management.

Changes

Files Change Summary
internal/config/env.go Modified LoadEnv, added extractDBCredsFromSecret, defined localEnvFile, improved error handling for environment loading.
internal/config/env_test.go Added new test cases and modified existing ones to enhance coverage for environment variable injection and database credentials handling.

Poem

In the burrow where code does hop,
Changes made, we’ll never stop!
Secrets extracted, errors refined,
A clearer path for all to find.
Hooray for tests that catch the flaws,
A leap of joy, we pause and pause! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c3ab96b and a79e666.

📒 Files selected for processing (2)
  • internal/config/env.go (3 hunks)
  • internal/config/env_test.go (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • internal/config/env.go
  • internal/config/env_test.go

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
🪧 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 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 to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

🧹 Outside diff range and nitpick comments (2)
internal/config/env.go (1)

124-128: Avoid setting environment variables within functions

Setting environment variables inside a function can lead to side effects that are hard to trace and debug. It might be better to return the extracted credentials and let the caller decide how to use them.

Consider refactoring the code to return the credentials as a struct:

func extractDBCredsFromSecret() (*copilotSecrets, error) {
    // ... existing code ...

    return secrets, nil
}

Then, in the calling function, set the necessary environment variables or pass the credentials where needed.

internal/config/env_test.go (1)

Line range hint 399-452: Ensure expectedKeyValues are correctly asserted in loadDbCredsInjectedInLocalEnv

In the function loadDbCredsInjectedInLocalEnv, verify that all expected environment variables are correctly set and asserted in expectedKeyValues. This ensures that the test fully validates the loading of database credentials in the local environment.

Review the expectedKeyValues to ensure completeness.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2d0538b and c3ab96b.

📒 Files selected for processing (2)
  • internal/config/env.go (3 hunks)
  • internal/config/env_test.go (6 hunks)
🔇 Additional comments (1)
internal/config/env.go (1)

61-63: Use of constant localEnvFile enhances maintainability

Defining localEnvFile as a constant improves code readability and maintainability by avoiding hardcoded strings and making it easier to update the environment identifier in the future.

internal/config/env.go Outdated Show resolved Hide resolved
internal/config/env.go Show resolved Hide resolved
internal/config/env.go Outdated Show resolved Hide resolved
internal/config/env.go Outdated Show resolved Hide resolved
internal/config/env_test.go Show resolved Hide resolved
internal/config/env_test.go Show resolved Hide resolved
internal/config/env_test.go Outdated Show resolved Hide resolved
@Paras-Wednesday
Copy link
Collaborator Author

Closing this PR, as new PR against this will be opened, instead from forked repo, new PR will be from a branch of the orignal repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant