RepoAuditor 0.2.42__tar.gz → 0.2.44__tar.gz

{repoauditor-0.2.42 → repoauditor-0.2.44}/DEVELOPMENT.md

@@ -4,18 +4,8 @@
 | --- | --- | --- |
 | 1. Fork the repository | -- | https://github.com/gt-sse-center/RepoAuditor/fork |
 | 2. Create a PAT for your forked repository | -- | See [PAT setup instructions](README.md#personal-access-token-pat) |
-| 3. Sync the `test-GitHubCommunityStandards` branch | see instructions below | In the web interface, select "New Branch", then choose `gt-sse-center/RepoAuditor` and `test-GitHubCommunityStandards` as source, and enter `test-GitHubCommunityStandards` as branch name. |
-| 4. Update your forked repository settings to match RepoAuditor's defaults | -- | 
-
-
-To sync the `test-GitHubCommunityStandards` branch using the command line:
-```bash
-git clone <REPOAUDITOR_FORK_URL>
-git remote add upstream https://github.com/gt-sse-center/RepoAuditor
-git fetch upstream
-git checkout -b test-GitHubCommunityStandards upstream/test-GitHubCommunityStandards
-git push origin test-GitHubCommunityStandards
-```
+| 3. Update your forked repository settings to match RepoAuditor's defaults | -- | 
+
 
 # Local Development
 

{repoauditor-0.2.42 → repoauditor-0.2.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.42
+Version: 0.2.44
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
 Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Requires-Dist: dbrownell-common>=0.14.10
+Requires-Dist: gitpython>=3.1.44
 Requires-Dist: pluggy>=1.5.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: typer-config[yaml]>=1.4.2
@@ -72,6 +73,11 @@ To get a list of command line options, you can run
 uv run repo_auditor --help
 ```
 
+`RepoAuditor` accepts both a set of flags as well as a configuratin YAML file. We have provided a sample configuration file called `default_config.yaml`, which can be used as:
+```shell
+uv run repo_auditor --config default_config.yaml
+```
+
 ### Personal Access Token (PAT)
 
 The most common use case for `RepoAuditor` would be to audit a GitHub repository.

{repoauditor-0.2.42 → repoauditor-0.2.44}/README.md

@@ -46,6 +46,11 @@ To get a list of command line options, you can run
 uv run repo_auditor --help
 ```
 
+`RepoAuditor` accepts both a set of flags as well as a configuratin YAML file. We have provided a sample configuration file called `default_config.yaml`, which can be used as:
+```shell
+uv run repo_auditor --config default_config.yaml
+```
+
 ### Personal Access Token (PAT)
 
 The most common use case for `RepoAuditor` would be to audit a GitHub repository.

repoauditor-0.2.44/default_config.yaml

@@ -0,0 +1,5 @@
+includes: ["GitHub", "GitHubCommunityStandards", "GitHubRulesets"]
+GitHub-url: "https://github.com/gt-sse-center/RepoAuditor"
+GitHubCommunityStandards-url: "https://github.com/gt-sse-center/RepoAuditor"
+GitHubRulesets-url: "https://github.com/gt-sse-center/RepoAuditor"
+# GitHub-pat: "PAT"

{repoauditor-0.2.42 → repoauditor-0.2.44}/pyproject.toml

@@ -8,6 +8,7 @@ authors = [
 requires-python = ">= 3.10"
 dependencies = [
     "dbrownell-common>=0.14.10",
+    "gitpython>=3.1.44",
     "pluggy>=1.5.0",
     "requests>=2.32.3",
     "typer>=0.15.3",

{repoauditor-0.2.42 → repoauditor-0.2.44}/src/RepoAuditor/__init__.py

@@ -2,4 +2,4 @@ APP_NAME = "RepoAuditor"
 
 # Note that the default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.42"
+__version__ = "0.2.44"

{repoauditor-0.2.42 → repoauditor-0.2.44}/tests/Plugins/GitHubCommunityStandards_EndToEndTest.py

@@ -6,21 +6,52 @@
 # -------------------------------------------------------------------------------
 """End-to-end tests for the GitHubCommunityStandards plugin."""
 
+import shutil
 from pathlib import Path
+from tempfile import TemporaryDirectory
+from unittest.mock import patch
 
 import pytest
 from dbrownell_Common.TestHelpers.StreamTestHelpers import (
     InitializeStreamCapabilities,
 )
+from git import Repo
 from typer.testing import CliRunner
 from utilities import CheckPATFileExists, GetGithubUrl, ScrubDurationGithuburlAndSpaces
 
 from RepoAuditor.EntryPoint import app
+from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import CommunityStandardsQuery
 
 # ----------------------------------------------------------------------
 pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 
 
+def GetDataFunctional(path_to_delete: str, is_directory=False):
+    """A functional which returns a modified GetData method which
+    deletes the specified path in the cloned repo.
+    """
+
+    def GetData(self, module_data):
+        # Clone the GitHub repository to a temp directory
+        github_url = module_data["url"]
+        branch = module_data.get("branch", "main")
+        temp_repo_dir = TemporaryDirectory()
+        Repo.clone_from(github_url, temp_repo_dir.name, branch=branch)
+
+        path = Path(temp_repo_dir.name) / path_to_delete
+
+        if is_directory:
+            shutil.rmtree(path)
+        else:
+            path.unlink()
+
+        # Record the path and the temp directory for later cleanup
+        module_data["repo_dir"] = temp_repo_dir
+        return module_data
+
+    return GetData
+
+
 # ----------------------------------------------------------------------
 class TestCommunityStandards:
     """End-to-end tests for community standards files in a GitHub repository."""
@@ -28,21 +59,24 @@ class TestCommunityStandards:
     # ----------------------------------------------------------------------
     def test_CodeOwners(self, pat_args, snapshot):
         """Test if a CODEOWNERS file exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-CodeOwners-exists"])
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHubCommunityStandards-CodeOwners-exists"],
+        )
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional(".github/CODEOWNERS"),
+    )
     def test_NoCodeOwners(self, pat_args, snapshot):
         """Test if a CODEOWNERS file does not exist in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args
-            + [
-                "--GitHubCommunityStandards-CodeOwners-exists",
-                "--GitHubCommunityStandards-branch",
-                "test-GitHubCommunityStandards",
-            ],
+            pat_args + ["--GitHubCommunityStandards-CodeOwners-exists"],
         )
 
         assert result.exit_code == -1, result.output
@@ -50,21 +84,24 @@ class TestCommunityStandards:
 
     def test_Contributing(self, pat_args, snapshot):
         """Test if a CONTRIBUTING.md file exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-Contributing-exists"])
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHubCommunityStandards-Contributing-exists"],
+        )
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional("CONTRIBUTING.md"),
+    )
     def test_NoContributing(self, pat_args, snapshot):
         """Test if a CONTRIBUTING file does not exist in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args
-            + [
-                "--GitHubCommunityStandards-Contributing-exists",
-                "--GitHubCommunityStandards-branch",
-                "test-GitHubCommunityStandards",
-            ],
+            pat_args + ["--GitHubCommunityStandards-Contributing-exists"],
         )
 
         assert result.exit_code == -1, result.output
@@ -77,38 +114,44 @@ class TestCommunityStandards:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional(".github/ISSUE_TEMPLATE", True),
+    )
     def test_NoIssueTemplate(self, pat_args, snapshot):
         """Test if no Issue template file exists in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args
-            + [
-                "--GitHubCommunityStandards-IssueTemplates-exists",
-                "--GitHubCommunityStandards-branch",
-                "test-GitHubCommunityStandards",
-            ],
+            pat_args + ["--GitHubCommunityStandards-IssueTemplates-exists"],
         )
 
         assert result.exit_code == -1, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
     def test_PullRequestTemplate(self, pat_args, snapshot):
-        """Test if a Pull Request template file (e.g. PULL_REQUEST_TEMPLATE.md) exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-PullRequestTemplate-exists"])
+        """
+        Test if a Pull Request template file (e.g. PULL_REQUEST_TEMPLATE.md)
+        exists in the repository.
+        """
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHubCommunityStandards-PullRequestTemplate-exists"],
+        )
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional(".github/pull_request_template.md"),
+    )
     def test_NoPullRequestTemplate(self, pat_args, snapshot):
         """Test if no Pull Request template file exists in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args
-            + [
-                "--GitHubCommunityStandards-PullRequestTemplate-exists",
-                "--GitHubCommunityStandards-branch",
-                "test-GitHubCommunityStandards",
-            ],
+            pat_args + ["--GitHubCommunityStandards-PullRequestTemplate-exists"],
         )
 
         assert result.exit_code == -1, result.output
@@ -116,21 +159,24 @@ class TestCommunityStandards:
 
     def test_SecurityPolicy(self, pat_args, snapshot):
         """Test if a Security policy file (e.g. SECURITY.md) exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-SecurityPolicy-exists"])
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHubCommunityStandards-SecurityPolicy-exists"],
+        )
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional("SECURITY.md"),
+    )
     def test_NoSecurityPolicy(self, pat_args, snapshot):
         """Test if no Security policy file exists in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args
-            + [
-                "--GitHubCommunityStandards-SecurityPolicy-exists",
-                "--GitHubCommunityStandards-branch",
-                "test-GitHubCommunityStandards",
-            ],
+            pat_args + ["--GitHubCommunityStandards-SecurityPolicy-exists"],
         )
 
         assert result.exit_code == -1, result.output

{repoauditor-0.2.42 → repoauditor-0.2.44}/uv.lock

@@ -517,6 +517,7 @@ name = "repoauditor"
 source = { editable = "." }
 dependencies = [
     { name = "dbrownell-common" },
+    { name = "gitpython" },
     { name = "pluggy" },
     { name = "requests" },
     { name = "typer" },
@@ -537,6 +538,7 @@ dev = [
 [package.metadata]
 requires-dist = [
     { name = "dbrownell-common", specifier = ">=0.14.10" },
+    { name = "gitpython", specifier = ">=3.1.44" },
     { name = "pluggy", specifier = ">=1.5.0" },
     { name = "requests", specifier = ">=2.32.3" },
     { name = "typer", specifier = ">=0.15.3" },