RepoAuditor 0.2.27__tar.gz → 0.2.29__tar.gz

{repoauditor-0.2.27 → repoauditor-0.2.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.27
+Version: 0.2.29
 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

{repoauditor-0.2.27 → repoauditor-0.2.29}/pyproject.toml

@@ -39,7 +39,7 @@ repo_auditor = "RepoAuditor:EntryPoint.app"
 [project.entry-points.RepoAuditor]
 GitHubPlugin = "RepoAuditor.Plugins.GitHubPlugin"
 GitHubCustomizationPlugin = "RepoAuditor.Plugins.GitHubCustomizationPlugin"
-GitHubRulesetPlugin="RepoAuditor.Plugins.GitHubRuleset"
+GitHubRulesetPlugin="RepoAuditor.Plugins.GitHubRulesetsPlugin"
 
 [build-system]
 requires = ["hatchling"]

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Module.py

@@ -182,6 +182,9 @@ class Module(ABC):
                 if evaluate_info.result == EvaluateResult.Warning:
                     return_code = 1
 
+            # Cleanup any resources created during the query
+            query.Cleanup(query_data)
+
             return (
                 return_code,
                 [

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/CustomizationQuery.py

@@ -7,6 +7,8 @@
 """Contains the CustomizationQuery object."""
 
 from typing import Any, Optional
+from tempfile import TemporaryDirectory
+from git import Repo
 
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 
@@ -40,12 +42,22 @@ class CustomizationQuery(Query):
         self,
         module_data: dict[str, Any],
     ) -> Optional[dict[str, Any]]:
-        """Get the data from an API session."""
-        response = module_data["session"].get("")
+        """Get the repo data."""
 
-        response.raise_for_status()
-        response = response.json()
+        # 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)
 
-        module_data["standard"] = response
+        # Record the path and the temp directory for later cleanup
+        module_data["repo_dir"] = temp_repo_dir
 
         return module_data
+
+    @override
+    def Cleanup(self, module_data: dict[str, Any]) -> None:
+        """Clean up the cloned repository."""
+        repo_dir = module_data["repo_dir"]
+        repo_dir.cleanup()
+        del module_data

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Impl/ExistsRequirementImpl.py

@@ -6,6 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the ExistsRequirementImpl object."""
 
+from pathlib import Path
 from typing import Any
 from collections.abc import Sequence
 
@@ -69,28 +70,23 @@ class ExistsRequirementImpl(Requirement):
     ) -> Requirement.EvaluateImplResult:
         if requirement_args[self.dynamic_arg_name]:
             for location in self.possible_locations:
-                # Query for file location
-                response = query_data["session"].get(f"contents/{location}")
+                # Get full file path in temporary repo directory and check if it exists
+                # This checks both upper case and lower case variants
+                full_file_path = Path(query_data["repo_dir"].name) / Path(location)
 
-                # If location is found, response will have status code 200
-                if response.status_code == 200:
-                    response_json = response.json()
-                    # If response is a list, we have a directory
-                    if isinstance(response_json, list):
-                        for file in response_json:
-                            # Check if there are any template files (.md or .yml)
-                            if ".md" in file["path"] or ".yml" in file["path"]:
-                                return Requirement.EvaluateImplResult(
-                                    EvaluateResult.Success,
-                                    f"File {self.github_file} found in directory {location}",
-                                )
-
-                    # If response is a dict, we have a single file
-                    elif isinstance(response_json, dict):
+                if full_file_path.exists():
+                    # If full_file_path is a directory, check if it isn't empty
+                    if full_file_path.is_dir() and any(full_file_path.iterdir()):
                         return Requirement.EvaluateImplResult(
-                            EvaluateResult.Success, f"File {self.github_file} found at {location}"
+                            EvaluateResult.Success,
+                            f"File found in {self.github_file} directory of the repository",
                         )
 
+                    return Requirement.EvaluateImplResult(
+                        EvaluateResult.Success,
+                        f"{self.github_file} found in repository",
+                    )
+
             return Requirement.EvaluateImplResult(
                 EvaluateResult.Error,
                 f"No {self.github_file} file found.",

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Module.py

@@ -6,9 +6,6 @@
 # -------------------------------------------------------------------------------
 """Contains the GitHubCustomizationModule object."""
 
-from typing import Any
-from dbrownell_Common.Types import override
-
 from RepoAuditor.Module import ExecutionStyle
 from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
 from RepoAuditor.Plugins.GitHubCustomization.CustomizationQuery import CustomizationQuery
@@ -27,8 +24,3 @@ class GitHubCustomizationModule(GitHubBaseModule):
             ],
             requires_explicit_include=True,
         )
-
-    @override
-    def Cleanup(self, dynamic_args: dict[str, Any]) -> None:
-        """Clean up any resources created during execution."""
-        # No resources to clean up in the minimal implementation

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/CodeOwners.py

@@ -20,14 +20,9 @@ class CodeOwners(ExistsRequirementImpl):
             "exists",
             "CODEOWNERS",
             [
-                # Upper case variants
                 ".github/CODEOWNERS",
                 "docs/CODEOWNERS",
                 "CODEOWNERS",
-                # Lower case variants
-                ".github/codeowners",
-                "docs/codeowners",
-                "codeowners",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/Contributing.py

@@ -20,14 +20,9 @@ class Contributing(ExistsRequirementImpl):
             "exists",
             "CONTRIBUTING",
             [
-                # Upper case variants
                 ".github/CONTRIBUTING.md",
                 "docs/CONTRIBUTING.md",
                 "CONTRIBUTING.md",
-                # Lower case variants
-                ".github/contributing.md",
-                "docs/contributing.md",
-                "contributing.md",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/IssueTemplates.py

@@ -21,12 +21,8 @@ class IssueTemplates(ExistsRequirementImpl):
                 ".github/ISSUE_TEMPLATE.md",
                 "docs/ISSUE_TEMPLATE.md",
                 "ISSUE_TEMPLATE.md",
-                "docs/issue_template.md",
-                ".github/issue_template.md",
-                "issue_template.md",
                 # Directories
                 ".github/ISSUE_TEMPLATE",
-                ".github/issue_template",
             ],
             "Add issue templates to your repository in the .github/ISSUE_TEMPLATE directory.",
             "Issue templates help contributors create high-quality issues by providing a structured format.",

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/PullRequestTemplates.py

@@ -18,17 +18,11 @@ class PullRequestTemplate(ExistsRequirementImpl):
             "exists",
             "PULL_REQUESTS_TEMPLATE",
             [
-                # Upper case variants
                 ".github/PULL_REQUEST_TEMPLATE.md",
                 "docs/PULL_REQUEST_TEMPLATE.md",
                 "PULL_REQUEST_TEMPLATE.md",
-                # Lower case variants
-                ".github/pull_request_template.md",
-                "docs/pull_request_template.md",
-                "pull_request_template.md",
                 # Directory with multiple templates
                 ".github/PULL_REQUEST_TEMPLATE",
-                ".github/pull_request_template",
             ],
             "Create a pull request template file in one of these locations: .github/PULL_REQUEST_TEMPLATE.md, .github/pull_request_template.md, docs/PULL_REQUEST_TEMPLATE.md, or PULL_REQUEST_TEMPLATE.md",
             "Pull request templates help standardize code contributions and expedite the review process by ensuring consistent PR format.",

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/SecurityPolicy.py

@@ -20,14 +20,9 @@ class SecurityPolicy(ExistsRequirementImpl):
             "exists",
             "SECURITY",
             [
-                # Upper case variants
                 ".github/SECURITY.md",
                 "docs/SECURITY.md",
                 "SECURITY.md",
-                # Lower case variants
-                ".github/security.md",
-                "docs/security.md",
-                "security.md",
             ],
             textwrap.dedent(
                 """\

repoauditor-0.2.29/src/RepoAuditor/Plugins/GitHubRulesets/Impl/EnableRulesetRequirementImpl.py

@@ -0,0 +1,83 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the EnableRequirementImpl object."""
+
+from typing import Any, Optional
+from collections.abc import Callable
+
+from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+
+from RepoAuditor.Requirement import EvaluateResult, Requirement
+from RepoAuditor.Plugins.GitHub.Impl.EnableRequirementImpl import EnableRequirementImpl
+
+
+# ----------------------------------------------------------------------
+class EnableRulesetRequirementImpl(EnableRequirementImpl):
+    """Object that implements ruleset settings that can be enabled/disabled."""
+
+    # ----------------------------------------------------------------------
+    def __init__(
+        self,
+        name: str,
+        default_value: bool,  # noqa: FBT001
+        dynamic_arg_name: str,
+        github_ruleset_type: str,
+        github_ruleset_value: str,
+        get_configuration_value_func: Callable[[dict[str, Any]], Optional[bool]],
+        resolution: str,
+        rationale: str,
+        subject: Optional[str] = None,
+        *,
+        requires_explicit_include: bool = False,
+        unset_set_terminology: tuple[str, str] = ("unchecked", "checked"),
+        missing_value_is_warning: bool = True,
+    ) -> None:
+        super().__init__(
+            name=name,
+            default_value=default_value,
+            dynamic_arg_name=dynamic_arg_name,
+            github_settings_value=github_ruleset_value,
+            get_configuration_value_func=get_configuration_value_func,
+            resolution=resolution,
+            rationale=rationale,
+            subject=subject,
+            requires_explicit_include=requires_explicit_include,
+            unset_set_terminology=unset_set_terminology,
+            missing_value_is_warning=missing_value_is_warning,
+        )
+
+        self.github_ruleset_type = github_ruleset_type
+
+    # ----------------------------------------------------------------------
+    @override
+    def _EvaluateImpl(
+        self,
+        query_data: dict[str, Any],
+        requirement_args: dict[str, Any],
+    ) -> Requirement.EvaluateImplResult:
+        if requirement_args[self.dynamic_arg_name]:
+            # Get the rules for the specified branch
+            rules = query_data.get("rules", [])
+
+            for rule in rules:
+                if self.get_configuration_value_func(rule):
+                    # Get the ruleset associated with the rule
+                    ruleset = rule["ruleset"]
+                    return self.EvaluateImplResult(
+                        EvaluateResult.Success,
+                        f"Ruleset '{ruleset['name']}' enforces {self.github_ruleset_type}",
+                    )
+
+            return self.EvaluateImplResult(
+                EvaluateResult.Error,
+                f"No active branch ruleset requiring {self.github_ruleset_type} found",
+                provide_resolution=True,
+                provide_rationale=True,
+            )
+
+        # Requirement flag not set so DoesNotApply
+        return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)

repoauditor-0.2.29/src/RepoAuditor/Plugins/GitHubRulesets/Module.py

@@ -0,0 +1,26 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the GitHubRulesetModule object."""
+
+from RepoAuditor.Module import ExecutionStyle
+from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
+from RepoAuditor.Plugins.GitHubRulesets.RulesetQuery import RulesetQuery
+
+
+class GitHubRulesetsModule(GitHubBaseModule):
+    """Module that validates GitHub repository rulesets."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "GitHubRulesets",
+            "Validates GitHub repository rulesets.",
+            ExecutionStyle.Parallel,
+            [
+                RulesetQuery(),
+            ],
+            requires_explicit_include=True,
+        )

repoauditor-0.2.29/src/RepoAuditor/Plugins/GitHubRulesets/Requirements/RequirePullRequests.py

@@ -0,0 +1,25 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the RequirePullRequests object."""
+
+from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+
+
+class RequirePullRequests(EnableRulesetRequirementImpl):
+    """Require pull requests before merging to default branch."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            name="RequirePullRequests",
+            default_value=False,
+            dynamic_arg_name="true",
+            github_ruleset_type="Pull Requests",
+            github_ruleset_value="pull_request",
+            get_configuration_value_func=lambda rule: rule.get("type", "") == "pull_request",
+            resolution="Enable pull request requirements in repository rulesets",
+            rationale="Pull request reviews help maintain code quality and collaboration",
+        )

repoauditor-0.2.29/src/RepoAuditor/Plugins/GitHubRulesets/Requirements/RequireSignedCommits.py

@@ -0,0 +1,25 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the RequireSignedCommits object."""
+
+from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+
+
+class RequireSignedCommits(EnableRulesetRequirementImpl):
+    """Require signed commits."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            name="RequireSignedCommits",
+            default_value=False,
+            dynamic_arg_name="true",
+            github_ruleset_type="Signed Commits",
+            github_ruleset_value="required_signatures",
+            get_configuration_value_func=lambda rule: rule.get("type", "") == "required_signatures",
+            resolution="Enable commit signing requirement in repository rulesets",
+            rationale="Signed commits ensure commit authenticity",
+        )

repoauditor-0.2.29/src/RepoAuditor/Plugins/GitHubRulesets/Requirements/RequireStatusChecks.py

@@ -0,0 +1,25 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the RequireStatusChecks object."""
+
+from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+
+
+class RequireStatusChecks(EnableRulesetRequirementImpl):
+    """Require status checks to pass before merging."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            name="RequireStatusChecks",
+            default_value=False,
+            dynamic_arg_name="true",
+            github_ruleset_type="Status Checks",
+            github_ruleset_value="required_status_checks",
+            get_configuration_value_func=lambda rule: rule.get("type", "") == "required_status_checks",
+            resolution="Configure required status checks in repository rulesets",
+            rationale="Status checks ensure code quality and compatibility",
+        )

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Plugins/GitHubRulesets/RulesetQuery.py

@@ -45,9 +45,30 @@ class RulesetQuery(Query):
             data, or None if an error occurs.
 
         """
-        # Fetch ruleset data from the GitHub API
-        ruleset_data = module_data["session"].get("rulesets")
+        branch = module_data.get("branch")
+        if branch is None:
+            # Get the default branch name
+            response = module_data["session"].get("")
+
+            response.raise_for_status()
+            response = response.json()
+
+            branch = response["default_branch"]
+
+        # Fetch ruleset data for a specific branch.
+        # This only returns active rules on the branch
+        rules_response = module_data["session"].get(f"rules/branches/{branch}")
+
+        rules_response.raise_for_status()
 
         # Add ruleset data to module_data
-        module_data["ruleset_data"] = ruleset_data
+        module_data["rules"] = rules_response.json()
+
+        # Also get the associated ruleset for each rule
+        for rule in module_data["rules"]:
+            ruleset_respone = module_data["session"].get(f"rulesets/{rule['ruleset_id']}")
+            ruleset_respone.raise_for_status()
+            ruleset = ruleset_respone.json()
+            rule["ruleset"] = ruleset
+
         return module_data

repoauditor-0.2.27/src/RepoAuditor/Plugins/GitHubRuleset.py → repoauditor-0.2.29/src/RepoAuditor/Plugins/GitHubRulesetsPlugin.py

@@ -11,10 +11,10 @@ import pluggy
 from RepoAuditor import APP_NAME
 from RepoAuditor.Module import Module
 
-from RepoAuditor.Plugins.GitHubRulesets.Module import GitHubRulesetModule
+from RepoAuditor.Plugins.GitHubRulesets.Module import GitHubRulesetsModule
 
 
 @pluggy.HookimplMarker(APP_NAME)
 def GetModule() -> Module:
     """Return GitHubRulesetModule Module."""
-    return GitHubRulesetModule()
+    return GitHubRulesetsModule()

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/Query.py

@@ -129,6 +129,14 @@ class Query(ABC):
             max_num_threads=max_num_threads,
         )
 
+    # ----------------------------------------------------------------------
+    def Cleanup(
+        self,
+        module_data: dict[str, Any],
+    ) -> None:
+        """Clean up any resources created during execution."""
+        del module_data
+
 
 # ----------------------------------------------------------------------
 class StatusInfo:

{repoauditor-0.2.27 → repoauditor-0.2.29}/src/RepoAuditor/__init__.py

@@ -3,4 +3,4 @@ APP_NAME = "RepoAuditor"
 # Note that this value will be overwritten by calls to `python ../../Build.py update_version` based
 # on changes observed in the git repository. The default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.27"
+__version__ = "0.2.29"

{repoauditor-0.2.27 → repoauditor-0.2.29}/tests/Plugins/GitHubCustomization_EndToEndTest.py

@@ -36,11 +36,18 @@ class TestCustomization:
 
     def test_NoCodeOwners(self, pat_args, snapshot):
         """Test if a CODEOWNERS file does not exist in the repository."""
-        # TODO: How to test if CodeOwners file doesn't exist without updating repo?
-        result = CliRunner().invoke(app, pat_args)
-
-        assert result.exit_code == 0, result.output
-        # assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-CodeOwners-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
     def test_Contributing(self, pat_args, snapshot):
         """Test if a CONTRIBUTING.md file exists in the repository."""
@@ -49,6 +56,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoContributing(self, pat_args, snapshot):
+        """Test if a CONTRIBUTING file does not exist in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-Contributing-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
     def test_IssueTemplate(self, pat_args, snapshot):
         """Test if an Issue template file (e.g. ISSUE_TEMPLATE.md) exists in the repository."""
         result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-IssueTemplates-exists"])
@@ -56,6 +78,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoIssueTemplate(self, pat_args, snapshot):
+        """Test if no Issue template file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-IssueTemplates-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        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 + ["--GitHubCustomization-PullRequestTemplate-exists"])
@@ -63,6 +100,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoPullRequestTemplate(self, pat_args, snapshot):
+        """Test if no Pull Request template file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-PullRequestTemplate-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
     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 + ["--GitHubCustomization-SecurityPolicy-exists"])
@@ -70,6 +122,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoSecurityPolicy(self, pat_args, snapshot):
+        """Test if no Security policy file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-SecurityPolicy-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
 
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------