[BV-267] Make sure .gitconfig is always present

[Franr]

What?

Make sure there is always a .gitconfig file present in the home directory.

Why?

So git can work properly inside the container.

References

closes #267

[coderabbitai]

Walkthrough

The pull request involves modifications to the project's configuration and file handling related to Git configuration. Changes span across multiple files including a GitHub Actions workflow, Dockerfile, and Python files in the leverage package. The primary focus is on ensuring the proper creation and handling of the .gitconfig file during container initialization and workflow execution.

Changes

File	Change Summary
.github/workflows/tests-integration.yaml	Removed .gitconfig file creation command, keeping only mkdir ~/.ssh
Dockerfile	Removed RUN touch /root/.gitconfig line
leverage/container.py	Added line to ensure .gitconfig file exists before container mount, updated file path handling
leverage/path.py	Added new host_git_config_file property method to return Git config file path
tests/bats/leverage.bats	Updated test command from run leverage -l to run leverage run -l in two test cases

Assessment against linked issues

Objective	Addressed	Explanation
Support multi-layer Terraform commands	❓	Changes do not directly implement the multi-layer command feature

Possibly related PRs

• Enhancement | Move tasks load and list to run command #290: The changes in the leverage/leverage.py and leverage/modules/run.py files involve modifications to command-line options and functionality related to the leverage command, which may interact with the Git configuration changes made in the main PR, particularly in how tasks are loaded and listed.

Suggested labels

minor

Suggested reviewers

• exequielrafaela

Poem

🐰 A config file's tale, so slight and neat,
Touched and moved with rabbit-like feat
No more touching, just a gentle mkdir
Git's secrets now whisper, no longer blurred
A workflow dance, clean and bright! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89c0162 and b3c3c4d.

📒 Files selected for processing (1)

• tests/bats/leverage.bats (2 hunks)

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

• GitHub Check: integration_tests_cli_refarch (3.9.15, 1.3.5-0.2.0)

🔇 Additional comments (2)

tests/bats/leverage.bats (2)

38-38: Verify the CLI interface change.

The command structure has changed from leverage -l to leverage run -l. This appears to be a breaking change in the CLI interface that might affect existing scripts and documentation.

Let's verify if this change is documented and consistent across the codebase:

Also applies to: 52-52

✅ Verification successful

CLI interface change appears intentional and consistent

The change from leverage -l to leverage run -l is part of a consistent command structure where all task-related operations use the run subcommand. This pattern is uniformly applied across the test files, with different subcommands for different types of operations (e.g., run for tasks, terraform for Terraform operations).

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining usage of the old command format
rg -l '\bleverage -l\b' --type md --type txt

# Search for documentation files that might need updating
fd -e md -e txt -e rst | xargs rg '\bleverage -l\b'

# Check if there's a changelog entry for this breaking change
fd -g 'CHANGELOG*' | xargs cat

Length of output: 133

---

Script:

#!/bin/bash
# Find main CLI implementation files
fd -e js -e ts | grep -i "cli\|command\|bin"

# Search for command parsing logic
ast-grep --pattern 'program
  .command($_)
  .option($_)'

# Look for other test files using leverage commands
fd -e bats | xargs grep "run leverage"

Length of output: 636

---

Line range hint 1-15: Verify test environment setup for .gitconfig.

Since the PR's objective is to ensure .gitconfig is always present, we should verify if the test environment setup needs to be updated to handle this requirement.

Let's check if any test setup or utility functions need to be modified:

---

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 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.

[coveralls]

Pull Request Test Coverage Report for Build 12735913668

Details

• 4 of 4 (100.0%) changed or added relevant lines in 2 files are covered.
• 59 unchanged lines in 2 files lost coverage.
• Overall coverage increased (+0.07%) to 60.173%

---

Files with Coverage Reduction	New Missed Lines	%
path.py	14	73.65%
container.py	45	61.8%

Totals
Change from base Build 12588018753:	0.07%
Covered Lines:	2454
Relevant Lines:	3936

---

💛 - Coveralls

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

leverage/container.py (1)

485-485: Consider mounting Git config as read-only.

The Git config is mounted with read-write permissions by default. Consider adding read_only=True to the mount options for better security, unless write access is specifically required.

-            Mount(source=self.paths.host_git_config_file.as_posix(), target="/etc/gitconfig", type="bind"),
+            Mount(source=self.paths.host_git_config_file.as_posix(), target="/etc/gitconfig", type="bind", read_only=True),

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 76ca5ae and 89c0162.

📒 Files selected for processing (4)

• .github/workflows/tests-integration.yaml (1 hunks)
• Dockerfile (0 hunks)
• leverage/container.py (2 hunks)
• leverage/path.py (1 hunks)

💤 Files with no reviewable changes (1)

• Dockerfile

🔇 Additional comments (3)

leverage/path.py (1)

200-203: LGTM! Clean implementation of the Git config path property.

The property method provides a clean way to access the Git config file path, consistent with Python's pathlib usage throughout the class.

leverage/container.py (1)

458-460: LGTM! Ensures Git config file exists.

The implementation correctly ensures the .gitconfig file exists before attempting to mount it.

.github/workflows/tests-integration.yaml (1)

64-64: LGTM! Removed redundant Git config creation.

Correctly removed the .gitconfig creation as it's now properly managed by the container setup. This also fixes the incorrect placement of the file in the .ssh directory.

[Franr]

fix the breaking changes introduced in #290