Add git tool

[CTY-git]

PR Checklist

• The commit message follows our guidelines: Code of conduct
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Does this PR introduce a breaking change?
• Include PR in release notes?

PR Type

• Bugfix
• Feature
• Refactoring
• Build /CI
• Documentation
• Others

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Other information

[patched-admin]

File Changed: patchwork/common/tools/git_tool.py

Rule 1: Do not ignore potential bugs in the code

Details: The code doesn't handle subprocess execution failures properly. The subprocess.run() call could raise CalledProcessError if the git command fails, but there's no try-catch block to handle these exceptions. This could lead to unhandled runtime errors.

Affected Code Snippet:

def execute(self, args: list[str]) -> str:
    env = os.environ.copy()
    p = subprocess.run(
        ["git", *args],
        env=env,
        cwd=self.path,
        text=True,
        stdout=subprocess.PIPE,
        stderr=subprocess.STDOUT,
    )
    return p.stdout

Start Line: 39
End Line: 49

---

Rule 2: Do not overlook possible security vulnerabilities

Details: The code accepts arbitrary command-line arguments that are passed directly to the git command without any validation or sanitization. This could lead to command injection if malicious input is provided. The code should implement input validation and sanitization for the args parameter.

Affected Code Snippet:

def execute(self, args: list[str]) -> str:
    env = os.environ.copy()
    p = subprocess.run(
        ["git", *args],
        env=env,
        cwd=self.path,
        text=True,
        stdout=subprocess.PIPE,
        stderr=subprocess.STDOUT,
    )
    return p.stdout

Start Line: 39
End Line: 49

File Changed: patchwork/common/tools/github_tool.py

Rule 1: Do not ignore potential bugs in the code

Details: The addition of abc_register=False could potentially introduce bugs by preventing proper abstract base class registration. This parameter affects Python's ABC (Abstract Base Class) mechanism, which could lead to issues with class inheritance and method overriding if not handled correctly.

Affected Code Snippet:

class GitHubTool(Tool, tool_name="github_tool",  abc_register=False):

Start Line: 9
End Line: 9

---

Rule 3: Do not deviate from original coding standards

Details: The modification introduces an extra space after the comma in tool_name="github_tool", abc_register=False. This violates common Python style guidelines (PEP 8) which specifies that there should be one space after a comma, not multiple spaces.

Affected Code Snippet:

class GitHubTool(Tool, tool_name="github_tool",  abc_register=False):

Start Line: 9
End Line: 9

---

Summary

The code change presents:

1. A potential bug risk by disabling ABC registration
2. No security concerns
3. A minor coding standard violation with extra spacing

Recommendation:

• Review the necessity of abc_register=False and document the reason if it's required
• Fix the spacing issue to comply with PEP 8
• Consider adding a comment explaining why ABC registration is disabled if this is intentional

File Changed: patchwork/steps/GitHubAgent/GitHubAgent.py

Rule 1: Do not ignore potential bugs in the code

Details: The code introduces a new dependency (GitTool) and modifies the tool_set dictionary without proper validation or error handling. There should be validation to ensure the GitTool is properly initialized and the base_path exists.

Affected Code Snippet:

tool_set=dict(
    github_tool=GitHubTool(base_path, inputs["github_api_key"]),
    git_tool=GitTool(base_path),
),

Start Line: 38
End Line: 41

---

Rule 2: Do not overlook possible security vulnerabilities

Details: The code exposes a potential security vulnerability by providing unrestricted access to git commands through GitTool without any input validation or command sanitization. The system_prompt also informs about this access without any security boundaries mentioned.

Affected Code Snippet:

tool_set=dict(
    github_tool=GitHubTool(base_path, inputs["github_api_key"]),
    git_tool=GitTool(base_path),
),
system_prompt="""\
You are a senior software developer helping the program manager to obtain some data from GitHub.
You can access github through the `gh` CLI app through the `github_tool`, and `git` through the `git_tool`.
Your `gh` app has already been authenticated.
"""

Start Line: 38
End Line: 46