feat: add ruff linter with ci check (#1182)

* feat: add ruff linter with ci check

Liniting the python files in tests directory would reduce whitespace etc
change and enforce basic coding standard for those. Kind of
opportunistic PR as there might be other opinions about how to deal with
this.

* fix: format with ruff

.github/workflows/ci.yml

@@ -36,6 +36,8 @@ jobs:
         env:
           # NOTE: use env to pass the output in order to avoid possible injection attacks
           FILES: "${{ steps.files.outputs.added_modified }}"
+      - name: Lint and format Python with Ruff
+        uses: astral-sh/ruff-action@v1
 
   typo:
     runs-on: ubuntu-latest

tests/conftest.py

@@ -4,26 +4,30 @@
 import pytest
 from helper import TempRepository
 
-def create_repo(dirname = None):
+
+def create_repo(dirname=None):
     repo = TempRepository(dirname)
-    tmp_file_a = repo.create_tmp_file()
-    tmp_file_b = repo.create_tmp_file()
+    repo.create_tmp_file()
+    repo.create_tmp_file()
     repo.switch_cwd_under_repo()
     return repo
 
+
 def init_repo_git_status(repo):
     git = repo.get_repo_git()
     git.add(".")
     git.config("--local", "user.name", "test")
     git.config("--local", "user.email", "[email protected]")
     git.commit("-m", "chore: initial commit")
 
+
 @pytest.fixture(scope="module")
 def temp_repo():
     repo = create_repo()
     init_repo_git_status(repo)
     return repo
 
+
 @pytest.fixture(scope="module")
 def named_temp_repo(request):
     dirname = request.param

tests/helper.py

@@ -1,6 +1,8 @@
-import os, subprocess, shutil, tempfile
+import os
+import subprocess
+import shutil
+import tempfile
 from git import Repo, GitCommandError
-from testpath import MockCommand, modified_env
 
 CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
 GIT_EXTRAS_BIN = os.path.abspath(os.path.join(CURRENT_DIR, "..", "bin"))
@@ -10,15 +12,16 @@
 GITLAB_ORIGIN = "https://gitlab.com/tj/git-extras.git"
 BITBUCKET_ORIGIN = "https://bitbucket.org/tj/git-extras.git"
 
+
 class TempRepository:
-    def __init__(self, repo_work_dir = None):
+    def __init__(self, repo_work_dir=None):
         self._system_tmpdir = tempfile.gettempdir()
-        if repo_work_dir == None:
+        if repo_work_dir is None:
             repo_work_dir = tempfile.mkdtemp()
         else:
             repo_work_dir = os.path.join(self._system_tmpdir, repo_work_dir)
         self._cwd = repo_work_dir
-        self._tempdirname = self._cwd[len(self._system_tmpdir) + 1:]
+        self._tempdirname = self._cwd[len(self._system_tmpdir) + 1 :]
         self._git_repo = Repo.init(repo_work_dir, b="default")
         self._files = []
         self.change_origin_to_github()
@@ -50,8 +53,8 @@ def create_tmp_dir(self):
         tmp_dir = tempfile.mkdtemp()
         return tmp_dir
 
-    def create_tmp_file(self, temp_dir = None):
-        if temp_dir == None:
+    def create_tmp_file(self, temp_dir=None):
+        if temp_dir is None:
             temp_dir = self._cwd
 
         tmp_file = tempfile.mkstemp(dir=temp_dir)
@@ -63,7 +66,7 @@ def remove_tmp_file(self, file_path):
         print(f"File {file_path} has been removed")
 
     def writefile(self, temp_file, data):
-        if data == None:
+        if data is None:
             return
 
         with open(temp_file, "w", encoding="utf-8") as f:
@@ -86,8 +89,9 @@ def invoke_installed_extras_command(self, name, *params):
         origin_extras_command = os.path.join(GIT_EXTRAS_BIN, command_name)
         temp_extras_command = os.path.join(self._cwd, command_name)
         helpers = [
-                os.path.join(GIT_EXTRAS_HELPER, "git-extra-utility"),
-                os.path.join(GIT_EXTRAS_HELPER, "is-git-repo")]
+            os.path.join(GIT_EXTRAS_HELPER, "git-extra-utility"),
+            os.path.join(GIT_EXTRAS_HELPER, "is-git-repo"),
+        ]
 
         if not os.path.exists(temp_extras_command):
             whole = []
@@ -106,7 +110,7 @@ def invoke_installed_extras_command(self, name, *params):
             os.chmod(temp_extras_command, 0o775)
 
         script = [temp_extras_command, *params]
-        print(f"Run the script \"{script}\"")
+        print(f'Run the script "{script}"')
         return subprocess.run(script, capture_output=True)
 
     def change_origin(self, origin_url):

tests/pyproject.toml

@@ -21,3 +21,66 @@ testpaths = ["."]
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.9
+target-version = "py39"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"

tests/test_git_abort.py

@@ -1,5 +1,6 @@
 from git import GitCommandError
 
+
 class TestGitAbort:
     def test_init(self, temp_repo):
         git = temp_repo.get_repo_git()

tests/test_git_archive_file.py

@@ -1,4 +1,6 @@
-import os, pytest
+import os
+import pytest
+
 
 class TestGitArchiveFile:
     def test_init(self, temp_repo):
@@ -16,14 +18,17 @@ def test_archive_file_on_tags_branch(self, temp_repo):
         filename = "{0}.{1}.zip".format(temp_repo.get_repo_dirname(), git.describe())
         assert filename in os.listdir()
 
-    def test_archive_file_on_any_not_tags_branch_without_default_branch(self, temp_repo):
+    def test_archive_file_on_any_not_tags_branch_without_default_branch(
+        self, temp_repo
+    ):
         git = temp_repo.get_repo_git()
         git.checkout("-b", "not-tags-branch")
         temp_repo.invoke_installed_extras_command("archive-file")
         filename = "{0}.{1}.{2}.zip".format(
-                temp_repo.get_repo_dirname(),
-                git.describe("--always", "--long"),
-                "not-tags-branch")
+            temp_repo.get_repo_dirname(),
+            git.describe("--always", "--long"),
+            "not-tags-branch",
+        )
         assert filename in os.listdir()
 
     def test_archive_file_on_any_not_tags_branch_with_default_branch(self, temp_repo):
@@ -32,28 +37,28 @@ def test_archive_file_on_any_not_tags_branch_with_default_branch(self, temp_repo
         git.config("git-extras.default-branch", "default")
         temp_repo.invoke_installed_extras_command("archive-file")
         filename = "{0}.{1}.zip".format(
-                temp_repo.get_repo_dirname(),
-                git.describe("--always", "--long"))
+            temp_repo.get_repo_dirname(), git.describe("--always", "--long")
+        )
         assert filename in os.listdir()
 
     def test_archive_file_on_branch_name_has_slash(self, temp_repo):
         git = temp_repo.get_repo_git()
         git.checkout("-b", "feature/slash")
         temp_repo.invoke_installed_extras_command("archive-file")
         filename = "{0}.{1}.{2}.zip".format(
-                temp_repo.get_repo_dirname(),
-                git.describe("--always", "--long"),
-                "feature-slash")
+            temp_repo.get_repo_dirname(),
+            git.describe("--always", "--long"),
+            "feature-slash",
+        )
         assert filename in os.listdir()
 
     @pytest.mark.parametrize("named_temp_repo", ["backslash\\dir"], indirect=True)
     def test_archive_file_on_dirname_has_backslash(self, named_temp_repo):
         named_temp_repo.invoke_installed_extras_command("archive-file")
         git = named_temp_repo.get_repo_git()
         filename = "{0}.{1}.{2}.zip".format(
-                "backslash-dir",
-                git.describe("--always", "--long"),
-                "default")
+            "backslash-dir", git.describe("--always", "--long"), "default"
+        )
         assert filename in os.listdir()
 
     def test_archive_file_on_tag_name_has_slash(self, temp_repo):
@@ -65,6 +70,6 @@ def test_archive_file_on_tag_name_has_slash(self, temp_repo):
         temp_repo.invoke_installed_extras_command("archive-file")
         description_include_version = git.describe("--always", "--long")
         filename = "{0}.{1}.zip".format(
-                temp_repo.get_repo_dirname(),
-                description_include_version.replace("/", "-"))
+            temp_repo.get_repo_dirname(), description_include_version.replace("/", "-")
+        )
         assert filename in os.listdir()

tests/test_git_authors.py

@@ -1,9 +1,10 @@
-import os, subprocess
-
-expected_authors_list = "test <[email protected]>\ntestagain <[email protected]>\n"
+expected_authors_list = (
+    "test <[email protected]>\ntestagain <[email protected]>\n"
+)
 expected_authors_list_without_email = "test\ntestagain\n"
 authors_file = "AUTHORS"
 
+
 class TestGitAuthors:
     def test_init(self, temp_repo):
         git = temp_repo.get_repo_git()
@@ -18,16 +19,16 @@ def test_init(self, temp_repo):
         git.commit("-m", "test: add data B")
 
     def test_output_authors_has_email_without_any_parameter(self, temp_repo):
-        git = temp_repo.get_repo_git()
-        rs = temp_repo.invoke_extras_command("authors")
+        temp_repo.get_repo_git()
+        temp_repo.invoke_extras_command("authors")
         with open(authors_file) as f:
             content = f.read()
             print(content)
             print(expected_authors_list)
             assert content == expected_authors_list
 
     def test_list_authors_has_email_defaultly(self, temp_repo):
-        git = temp_repo.get_repo_git()
+        temp_repo.get_repo_git()
         actual = temp_repo.invoke_extras_command("authors", "--list")
         actual = actual.stdout.decode()
         assert actual == expected_authors_list
@@ -36,7 +37,7 @@ def test_list_authors_has_email_defaultly(self, temp_repo):
         assert actual == expected_authors_list
 
     def test_list_authors_has_not_email(self, temp_repo):
-        git = temp_repo.get_repo_git()
+        temp_repo.get_repo_git()
         actual = temp_repo.invoke_extras_command("authors", "--list", "--no-email")
         actual = actual.stdout.decode()
         assert actual == expected_authors_list_without_email