Refactor hooks(#3)

* Remove comment out code from .pre-commit-hooks.yaml
* Refactor utils
* Update .pre-commit-hooks.yaml

Author: shenxianpeng

.gitignore

@@ -5,3 +5,4 @@ cpp_linter_hooks/__pycache__/
 tests/.coverage
 tests/__pycache__
 .coverage
+__pycache__

.pre-commit-hooks.yaml

@@ -1,34 +1,15 @@
----
-# This file tells https://pre-commit.com/ which hooks
-# are provided by this repo for use by other git repos.
-
 - id: clang-format
   name: clang-format
-  description: Automatically run `clang-format` against C/C++ source code
+  description: formatting C/C++ code with `clang-format`
   entry: clang-format-hook
   language: python
   files: \.(h\+\+|h|hh|hxx|hpp|c|cc|cpp|c\+\+|cxx)$
   types_or: [c, c++, c#, objective-c]
 
 - id: clang-tidy
   name: clang-tidy
-  description: Run `clang-tidy` against C/C++ code to find warnings/errors
+  description: diagnosing and fixing typical programming errors with `clang-tidy`
   entry: clang-tidy-hook
   language: python
   files: \.(h\+\+|h|hh|hxx|hpp|c|cc|cpp|c\+\+|cxx)$
   types_or: [c, c++, c#, objective-c]
-
-# - id: docker-clang-format
-#   name: clang-format
-#   description: Run `clang-format` against C/C++ source code in Docker container
-#   language: docker
-#   files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
-#   entry: clang-format -i
-#   args: ["-style=Google"]
-
-# - id: docker-clang-tidy
-#   name: clang-tidy
-#   description: Run `clang-tidy` against C/C++ code to find warnings/errors in Docker container
-#   language: docker
-#   types_or: [c, c++, c#, objective-c]
-#   entry: clang-tidy

cpp_linter_hooks/util.py

@@ -1,24 +1,31 @@
 import subprocess
 
 
-def check_installed(tool, version="") -> int:
+def check_installed(tool: str, version="") -> int:
     if version:
         check_version_cmd = [f'{tool}-{version} ', '--version']
+    else:
+        check_version_cmd = [tool, '--version']
+    try:
+        subprocess.run(check_version_cmd, stdout=subprocess.PIPE)
+        retval = 0
+    except FileNotFoundError:
+        retval = install_clang_tools(version)
+    return retval
+
+
+def install_clang_tools(version: str) -> int:
+    if version:
         # clang-tools exist because install_requires=['clang-tools'] in setup.py
         install_tool_cmd = ['clang-tools', '-i', version]
     else:
-        check_version_cmd = [tool, '--version']
         # install verison 13 by default if clang-tools not exist.
         install_tool_cmd = ['clang-tools', '-i', '13']
     try:
-        subprocess.run(check_version_cmd, stdout=subprocess.PIPE)
+        subprocess.run(install_tool_cmd, stdout=subprocess.PIPE)
         retval = 0
-    except FileNotFoundError:
-        try:
-            subprocess.run(install_tool_cmd, stdout=subprocess.PIPE)
-            retval = 0
-        except Exception:
-            retval = 1
+    except Exception:
+        retval = 1
     return retval
 
 
@@ -30,7 +37,7 @@ def get_expect_version(args) -> str:
                 # when --version 14
                 expect_version = args[args.index(arg) + 1]
             else:
-                # when --version=14, --version='14' or --version="14"
+                # when --version=14
                 expect_version = arg.replace(" ", "").replace("=", "").replace("--version", "")
             return expect_version
     return ""

tests/test_util.py

@@ -4,47 +4,49 @@
 
 from cpp_linter_hooks.util import check_installed
 from cpp_linter_hooks.util import get_expect_version
+from cpp_linter_hooks.util import install_clang_tools
 
 
-@pytest.mark.parametrize(
-    ('tool', 'expected_retval'), (
-        ('clang-format', 0),
-        ('clang-tidy', 0),
-    ),
-)
-@patch('cpp_linter_hooks.clang_format.subprocess.run')
+@pytest.mark.parametrize(('tool', 'expected_retval'), (('clang-format', 0), ('clang-tidy', 0),),)
+@patch('cpp_linter_hooks.util.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')
+@pytest.mark.parametrize(('tool', 'version', 'expected_retval'), (('clang-format', '14', 0), ('clang-tidy', '14', 0),),)
+@patch('cpp_linter_hooks.util.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'
+@pytest.mark.parametrize(('tool', 'version', 'expected_retval'), (('non-exist-cmd', '14', 0),),)
+@patch('cpp_linter_hooks.util.subprocess.run')
+def test_check_installed_with_except(mock_subprocess_run, tool, version, expected_retval):
+    mock_subprocess_run.return_value = expected_retval
+    ret = check_installed(tool, version=version)
+    assert ret == expected_retval
 
-    args = ['clang-format', '-i', '--style=Google', '--version = 13']
-    version = get_expect_version(args)
-    assert version == '13'
 
-    args = ['clang-format', '-i', '--style=Google']
+@pytest.mark.parametrize(('version', 'expected_retval'), (('100', 1),),)
+@patch('cpp_linter_hooks.util.subprocess.run')
+def test_install_clang_tools(mock_subprocess_run, version, expected_retval):
+    mock_subprocess_run.return_value = expected_retval
+    try:
+        ret = install_clang_tools(version)
+        assert ret == expected_retval
+    except Exception:
+        pass
+
+
+def test_get_expect_version():
+    args = ['clang-format', '--version 14']
     version = get_expect_version(args)
-    assert version == ""
+    assert version == '14'
 
-    args = ['clang-format', '-i', '--install=13']
+    args = ['clang-format', '--version=14']
     version = get_expect_version(args)
-    assert version == ""
+    assert version == '14'