add unittest

Author: shenxianpeng

.github/workflows/add-tag.yml renamed to .github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: "Tag"
+name: "Test"
 
 on:
   push:
@@ -15,7 +15,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: retag latest commit for testing
+      - name: Add tag to latest commit for testing
         run: |
           git config user.name 'github-actions'
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'

.gitignore

@@ -1,3 +1,5 @@
 build
 dist
-cpp_linter_hooks.egg-info
+cpp_linter_hooks.egg-info
+tests/.coverage
+tests/__pycache__

.pre-commit-config.yaml

@@ -1,7 +1,13 @@
 repos:
+  # For development test
   - repo: https://github.com/shenxianpeng/cpp-linter-hooks
     rev: latest
     hooks:
       - id: clang-format
         verbose: true
         args: [--style=Google, --version=13]
+  - repo: https://github.com/pycqa/flake8
+    rev: '4.0.1'
+    hooks:
+      - id: flake8
+        args: [--max-line-length=120]

README.md

@@ -1,18 +1,33 @@
-# C/C++ linter hooks for pre-commit
+# cpp-linter-hooks
 
-Linter your C/C++ code with `clang-format` and `clang-tidy` for [pre-commit](https://pre-commit.com/).
+Using `clang-format` and `clang-tidy` hooks with [pre-commit](https://pre-commit.com/) to lint your C/C++ code.
 
-**Automaticlly install `clang-format` and `clang-tidy`** when they do not exist.
+✨Highlight✨: automatically install `clang-format` and `clang-tidy` when they do not exist.
 
 ## Usage
 
-For example
+Add this to your `.pre-commit-config.yaml`
 
 ```yaml
 repos:
   - repo: https://github.com/shenxianpeng/cpp-linter-hooks
+    rev: v0.1.0  # Use the ref you want to point at
     hooks:
       - id: clang-format
-        args: ["--style=Google", "--version=14"]
-      - id: clang-tidy
+        args: [--style=Google] 
+      # - id: clang-tidy ## Work in progress
+      #   args: [--config-file=file]
 ```
+
+## Support hooks
+
+### `clang-format`
+
+Prevent committing unformatted C/C++ code.
+
+* Set coding style: LLVM, GNU, Google, Chromium, Microsoft, Mozilla, WebKit with `args: [--style=LLVM]`
+* Load coding style configuration file `.clang-format` with `args: [--style=file]`
+
+### `clang-tidy`
+
+Prevent committing typical programming errors, like style violations, interface misuse, or bugs that can be deduced.

cpp_linter_hooks/clang_format.py

@@ -18,9 +18,9 @@ def run_clang_format(args) -> int:
         return 1
 
 
-def main() -> int:
+def main():
     run_clang_format(args)
 
 
 if __name__ == "__main__":
-    raise SystemExit(main())
+    main()

cpp_linter_hooks/util.py

@@ -1,22 +1,25 @@
 import subprocess
 
 
-def check_installed(tool, version='13'):
+def check_installed(tool, version='13') -> int:
     command = [f'{tool}-{version} ', '--version']
     try:
         subprocess.run(command, stdout=subprocess.PIPE)
+        retval = 0
     except FileNotFoundError:
         # clang-tools exist because install_requires=['clang-tools'] in setup.py
-        subprocess.run(['clang-tools', '-i', version], stdout=subprocess.PIPE)
+        retval = subprocess.run(['clang-tools', '-i', version], stdout=subprocess.PIPE).returncode
+    return retval
 
 
-def get_expect_version(args):
+def get_expect_version(args) -> str:
     for arg in args:
-        if arg.startswith("--version") :  # expect specific clang-tools version.
+        if arg.startswith("--version"):  # expect specific clang-tools version.
             # If --version is passed in as 2 arguments, the second is version
             if arg == "--version" and args.index(arg) != len(args) - 1:
                 expect_version = args[args.index(arg) + 1]
             # Expected split of --version=14 or --version 14
             else:
                 expect_version = arg.replace(" ", "").replace("=", "").replace("--version", "")
             return expect_version
+    return None

tests/test_clang_format.py

@@ -0,0 +1,31 @@
+import pytest
+from unittest.mock import patch
+from cpp_linter_hooks.clang_format import run_clang_format
+
+
+@pytest.mark.parametrize(
+    ('args', 'expected_retval'), (
+        (['clang-format', '-i', '--style=Google', 'tests/main.c'], 0),
+        (['clang-format', '-i', '--style=Google', '--version=13', 'tests/main.c'], 0),
+    ),
+)
+@patch('cpp_linter_hooks.clang_format.subprocess.run')
+def test_run_clang_format_valid(mock_subprocess_run, args, expected_retval):
+    mock_subprocess_run.return_value = expected_retval
+    ret = run_clang_format(args)
+    assert ret == expected_retval
+
+
+@pytest.mark.parametrize(
+    ('args', 'expected_retval'), (
+        (['clang-format', '-i', '--style=Google', 'abc/def.c'], 1),
+        (['clang-format', '-i', '--style=Google', '--version=13', 'abc/def.c'], 1),
+    ),
+)
+@patch('cpp_linter_hooks.clang_format.subprocess.run', side_effect=FileNotFoundError)
+def test_run_clang_format_invalid(mock_subprocess_run, args, expected_retval):
+    mock_subprocess_run.return_value = expected_retval
+    try:
+        ret = run_clang_format(args)
+    except FileNotFoundError:
+        assert ret == expected_retval

tests/test_util.py

@@ -0,0 +1,47 @@
+import pytest
+from unittest.mock import patch
+from cpp_linter_hooks.util import check_installed, get_expect_version
+
+
+@pytest.mark.parametrize(
+    ('tool', 'expected_retval'), (
+        ('clang-format', 0),
+        ('clang-tidy', 0),
+    ),
+)
+@patch('cpp_linter_hooks.clang_format.subprocess.run')
+def test_check_installed(mock_subprocess_run, tool, expected_retval):
+    mock_subprocess_run.return_value = expected_retval
+    ret = check_installed(tool)
+    assert ret == expected_retval
+
+
+@pytest.mark.parametrize(
+    ('tool', 'version', 'expected_retval'), (
+        ('clang-format', '14', 0),
+        ('clang-tidy', '14', 0),
+    ),
+)
+@patch('cpp_linter_hooks.clang_format.subprocess.run')
+def test_check_installed_with_version(mock_subprocess_run, tool, version, expected_retval):
+    mock_subprocess_run.return_value = expected_retval
+    ret = check_installed(tool, version=version)
+    assert ret == expected_retval
+
+
+def test_get_expect_version():
+    args = ['clang-format', '-i', '--style=Google', '--version=13']
+    version = get_expect_version(args)
+    assert version == '13'
+
+    args = ['clang-format', '-i', '--style=Google', '--version = 13']
+    version = get_expect_version(args)
+    assert version == '13'
+
+    args = ['clang-format', '-i', '--style=Google']
+    version = get_expect_version(args)
+    assert version is None
+
+    args = ['clang-format', '-i' '--install=13']
+    version = get_expect_version(args)
+    assert version is None