Refactor and resolve #4 and #5 (#6)

* Refactor installation

* Support to test specific branch

* Update test workflow

* Install exe to sys.executable

* Fix flake8 error

* Test more versions of clang-tools

* Fixed #4

* Bump version to 0.2.1

* Update python-test.yml

* fix: UnicodeDecodeError: 'charmap' codec can't decode byte 0x8f in position 1809

Author: shenxianpeng

.github/workflows/python-test.yml

@@ -13,6 +13,11 @@ on:
     paths:
       - '**.py'
   workflow_dispatch:
+    # inputs:
+    #   branch_name:
+    #     description: 'Test against to branch'
+    #     required: true
+    #     default: 'main'
 
 permissions:
   contents: read
@@ -45,8 +50,7 @@ jobs:
   install:
     strategy:
       matrix:
-        # version: [ 3.9, 4, 5, 6, 7, 8, 9, 10, 11, 12, 12.0.1, 13, 14 ]
-        version: [ 10, 11 ]
+        version: [ 3.9, 4, 5, 6, 7, 8, 9, 10, 11, 12, 12.0.1, 13, 14 ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
       fail-fast: false
     runs-on: ${{ matrix.os }}
@@ -55,18 +59,16 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: "3.8"
-    - name: Install on Windows
-      if: matrix.os == 'windows-latest'
+    - name: Install clang-tools of pull_request event
+      if: github.event_name == 'pull_request'
+      run: pip install git+https://github.com/shenxianpeng/clang-tools-pip.git@${{ github.head_ref }}
+    - name: Install clang-tools of push event
+      if: github.event_name == 'push'
+      run: pip install git+https://github.com/shenxianpeng/clang-tools-pip.git@${{ github.ref }}
+    - name: Installation testing
       run: |
-        pip install git+https://github.com/shenxianpeng/clang-tools-pip.git@main
-        clang-tools --install ${{ matrix.version }} --directory .
-    - name: Install on Linux
-      if: matrix.os == 'ubuntu-latest'
-      run: |
-        sudo pip install git+https://github.com/shenxianpeng/clang-tools-pip.git@main
-        sudo clang-tools --install ${{ matrix.version }}
-    - name: Install on MacOS
-      if: matrix.os == 'macos-latest'
-      run: |
-        pip install git+https://github.com/shenxianpeng/clang-tools-pip.git@main
-        clang-tools --install ${{ matrix.version }} --directory .
+        clang-tools --install ${{ matrix.version }}
+        which clang-format-${{ matrix.version }}
+        clang-format-${{ matrix.version }} --version
+        which clang-tidy-${{ matrix.version }}
+        clang-tidy-${{ matrix.version }} --version

README.md

@@ -9,13 +9,13 @@ Install clang-tools binaries (clang-format, clang-tidy) with pip.
 Install `clang-tools` command with pip
 
 ```bash
-$ sudo pip install clang-tools
+$ pip install clang-tools
 ```
 
 ## Usage
 
 ```bash
-$ sudo clang-tools --help
+$ clang-tools --help
 usage: clang-tools [-h] [-i INSTALL] [-d DIRECTORY]
 
 optional arguments:
@@ -28,9 +28,9 @@ optional arguments:
 Use `clang-tools` command to install version 13 binaries.
 
 ```bash
-$ sudo clang-tools --install 13
+$ clang-tools --install 13
 # Or install to a specified directory
-$ sudo clang-tools --install 13 --directory .
+$ clang-tools --install 13 --directory .
 
 $ clang-format-13 --version
 clang-format version 13.0.0
@@ -42,3 +42,10 @@ LLVM (http://llvm.org/):
   Default target: x86_64-unknown-linux-gnu
   Host CPU: skylake
 ```
+
+## Supported versions
+
+|    verions   | 14 | 13 | 12.0.1 | 12 | 11 | 10 | 9 | 8 | 7 | 6 | 5 | 4 | 3.9 |
+|:------------:|:--:|:--:|:------:|:--:|:--:|:--:|:-:|:-:|:-:|:-:|:-:|:-:|:---:|
+| clang-format |  ✔️ |  ✔️ | ✔️ |  ✔️ |  ✔️ |  ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
+|  clang-tidy  |  ❌ |  ✔️ | ✔️ |  ✔️ |  ✔️ |  ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |

clang_tools/install.py

@@ -2,6 +2,7 @@
 import subprocess
 import shutil
 import os
+import sys
 from posixpath import basename
 from clang_tools.util import check_install_os
 from clang_tools.util import download_file
@@ -64,17 +65,19 @@ def install_clang_tidy(version, directory) -> None:
 def move_and_chmod_binary(old_file_name, new_file_name, directory) -> None:
     """Move download clang-tools binary and move to bin dir with right permission."""
     if directory:
-        clang_tools_dir = directory
+        install_dir = directory
     else:
         install_os = check_install_os()
-        if install_os in ['linux', 'macosx']:
-            clang_tools_dir = "/usr/bin"
-        elif install_os == "windows":
-            clang_tools_dir = "C:/bin"
-        else:
-            raise Exception(f"Not support {install_os}")
-    shutil.move(old_file_name, f"{clang_tools_dir}/{new_file_name}")
-    os.chmod(os.path.join(clang_tools_dir, new_file_name), 0o777)
+        if install_os not in ['linux', 'macosx', 'windows']:
+            raise SystemExit(f"Not support {install_os}")
+        install_dir = os.path.dirname(sys.executable)
+    try:
+        if not os.path.isdir(install_dir):
+            os.makedirs(install_dir)
+        shutil.move(old_file_name, f"{install_dir}/{new_file_name}")
+        os.chmod(os.path.join(install_dir, new_file_name), 0o755)
+    except PermissionError:
+        raise SystemExit("You don't have permission. Try to run with the appropriate permissions.")
 
 
 def install_clang_tools(version, directory) -> None:

clang_tools/util.py

@@ -1,5 +1,6 @@
 import string
 import subprocess
+from urllib.error import HTTPError
 import urllib.request
 import platform
 
@@ -12,7 +13,10 @@ def check_install_os() -> string:
 
 
 def download_file(url, file_name) -> None:
-    urllib.request.urlretrieve(url, file_name)
+    try:
+        urllib.request.urlretrieve(url, file_name)
+    except HTTPError:
+        raise SystemExit(f"Not found {file_name}, exit!")
 
 
 def unpack_file(file_name) -> int:
@@ -22,17 +26,6 @@ def unpack_file(file_name) -> int:
 
 
 def cmake_and_build():
-    command = [
-        "cmake",
-        "-S" "llvm-project-12.0.1.src/llvm",
-        "-B", "llvm-project-12.0.1.src/build",
-        "-DBUILD_SHARED_LIBS=OFF",
-        "-DLLVM_ENABLE_PROJECTS=\"clang;clang-tools-extra\"",
-        "-DLLVM_BUILD_STATIC=ON",
-        "-DCMAKE_CXX_FLAGS=\"-s -flto\"",
-        "-DCMAKE_BUILD_TYPE=MinSizeRel",
-        "-DCMAKE_CXX_COMPILER=g++-10",
-        "-DCMAKE_C_COMPILER=gcc-10",
-        ]
+    command = []
     result = subprocess.run(command, stdout=subprocess.PIPE)
     print(result.stdout.decode("utf-8"))

setup.py

@@ -1,11 +1,11 @@
 from setuptools import setup, find_packages
 
-with open("README.md", "r") as file:
+with open("README.md", "r", encoding='utf-8') as file:
     long_description = file.read()
 
 setup(
     name="clang_tools",
-    version="0.2.0",
+    version="0.2.1",
     description="Install clang-tools (clang-format, clang-tidy) with pip",
     long_description=long_description,
     long_description_content_type="text/markdown",