allow version to be a path

clang_tools/install.py

@@ -10,30 +10,31 @@
 import shutil
 import subprocess
 import sys
-from typing import Optional
-from . import release_tag
+from typing import Optional, cast
 
-from . import install_os, RESET_COLOR, suffix, YELLOW
-from .util import download_file, verify_sha512, get_sha_checksum
+from . import release_tag, install_os, RESET_COLOR, suffix, YELLOW
+from .util import (
+    download_file,
+    verify_sha512,
+    get_sha_checksum,
+    parse_version,
+    VERSION_TUPLE,
+)
 
 
 #: This pattern is designed to match only the major version number.
 RE_PARSE_VERSION = re.compile(rb"version\s([\d\.]+)", re.MULTILINE)
 
 
-def is_installed(tool_name: str, version: str) -> Optional[Path]:
+def is_installed(tool_name: str, version: VERSION_TUPLE) -> Optional[Path]:
     """Detect if the specified tool is installed.
 
     :param tool_name: The name of the specified tool.
     :param version: The specific version to expect.
 
     :returns: The path to the detected tool (if found), otherwise `None`.
     """
-    version_tuple = version.split(".")
-    ver_major = version_tuple[0]
-    if len(version_tuple) < 3:
-        # append minor and patch version numbers if not specified
-        version_tuple += ("0",) * (3 - len(version_tuple))
+    ver_major = version[0]
     exe_name = (
         f"{tool_name}" + (f"-{ver_major}" if install_os != "windows" else "") + suffix
     )
@@ -47,24 +48,28 @@ def is_installed(tool_name: str, version: str) -> Optional[Path]:
     except (FileNotFoundError, subprocess.CalledProcessError):
         return None  # tool is not installed
     ver_num = RE_PARSE_VERSION.search(result.stdout)
+    assert ver_num is not None, "Failed to parse version from tool output"
+    ver_match = cast(bytes, ver_num.groups(0)[0]).decode(encoding="utf-8")
     print(
         f"Found a installed version of {tool_name}:",
-        ver_num.groups(0)[0].decode(encoding="utf-8"),
+        ver_match,
         end=" ",
     )
-    path = shutil.which(exe_name)  # find the installed binary
-    if path is None:
+    exe_path = shutil.which(exe_name)  # find the installed binary
+    if exe_path is None:
         print()  # print end-of-line
         return None  # failed to locate the binary
-    path = Path(path).resolve()
+    path = Path(exe_path).resolve()
     print("at", str(path))
-    ver_num = ver_num.groups(0)[0].decode(encoding="utf-8").split(".")
-    if ver_num is None or ver_num[0] != ver_major:
+    ver_tuple = ver_match.split(".")
+    if ver_tuple is None or ver_tuple[0] != str(ver_major):
         return None  # version is unknown or not the desired major release
     return path
 
 
-def clang_tools_binary_url(tool: str, version: str, tag: str = release_tag) -> str:
+def clang_tools_binary_url(
+    tool: str, version: VERSION_TUPLE, tag: str = release_tag
+) -> str:
     """Assemble the URL to the binary.
 
     :param tool: The name of the tool to download.
@@ -77,12 +82,12 @@ def clang_tools_binary_url(tool: str, version: str, tag: str = release_tag) -> s
         "https://github.com/cpp-linter/clang-tools-static-binaries/releases/download/"
         + tag
     )
-    download_url = f"{base_url}/{tool}-{version}_{install_os}-amd64{suffix}"
+    download_url = f"{base_url}/{tool}-{version[0]}_{install_os}-amd64{suffix}"
     return download_url.replace(" ", "")
 
 
 def install_tool(
-    tool_name: str, version: str, directory: str, no_progress_bar: bool
+    tool_name: str, version: VERSION_TUPLE, directory: str, no_progress_bar: bool
 ) -> bool:
     """An abstract function that can install either clang-tidy or clang-format.
 
@@ -94,21 +99,21 @@ def install_tool(
     :returns: `True` if the binary had to be downloaded and installed.
         `False` if the binary was not downloaded but is installed in ``directory``.
     """
-    destination = Path(directory, f"{tool_name}-{version}{suffix}")
+    destination = Path(directory, f"{tool_name}-{version[0]}{suffix}")
     bin_url = clang_tools_binary_url(tool_name, version)
     if destination.exists():
-        print(f"{tool_name}-{version}", "already installed...")
+        print(f"{tool_name}-{version[0]}", "already installed...")
         print("   checking SHA512...", end=" ")
         if verify_sha512(get_sha_checksum(bin_url), destination.read_bytes()):
             print("valid")
             return False
         print("invalid")
         uninstall_tool(tool_name, version, directory)
-    print("Downloading", tool_name, f"(version {version})")
+    print("Downloading", tool_name, f"(version {version[0]})")
     bin_name = str(PurePath(bin_url).stem)
     if download_file(bin_url, bin_name, no_progress_bar) is None:
         raise OSError(f"Failed to download {bin_name} from {bin_url}")
-    move_and_chmod_bin(bin_name, f"{tool_name}-{version}{suffix}", directory)
+    move_and_chmod_bin(bin_name, f"{tool_name}-{version[0]}{suffix}", directory)
     if not verify_sha512(get_sha_checksum(bin_url), destination.read_bytes()):
         raise ValueError(
             f"File was corrupted during download from {bin_url}"
@@ -157,10 +162,10 @@ def move_and_chmod_bin(old_bin_name: str, new_bin_name: str, install_dir: str) -
 
 def create_sym_link(
     tool_name: str,
-    version: str,
+    version: VERSION_TUPLE,
     install_dir: str,
     overwrite: bool = False,
-    target: Path = None,
+    target: Optional[Path] = None,
 ) -> bool:
     """Create a symlink to the installed binary that
     doesn't have the version number appended.
@@ -181,7 +186,7 @@ def create_sym_link(
         link_root_path.mkdir(parents=True)
     link = link_root_path / (tool_name + suffix)
     if target is None:
-        target = link_root_path / f"{tool_name}-{version}{suffix}"
+        target = link_root_path / f"{tool_name}-{version[0]}{suffix}"
     if link.exists():
         if not link.is_symlink():
             print(
@@ -215,15 +220,15 @@ def create_sym_link(
         return False
 
 
-def uninstall_tool(tool_name: str, version: str, directory: str):
+def uninstall_tool(tool_name: str, version: VERSION_TUPLE, directory: str):
     """Remove a specified tool of a given version.
 
     :param tool_name: The name of the clang tool to uninstall.
     :param version: The version of the clang-tools to remove.
     :param directory: The directory from which to remove the
         installed clang-tools.
     """
-    tool_path = Path(directory, f"{tool_name}-{version}{suffix}")
+    tool_path = Path(directory, f"{tool_name}-{version[0]}{suffix}")
     if tool_path.exists():
         print("Removing", tool_path.name, "from", str(tool_path.parent))
         tool_path.unlink()
@@ -244,12 +249,17 @@ def uninstall_clang_tools(version: str, directory: str):
     """
     install_dir = install_dir_name(directory)
     print(f"Uninstalling version {version} from {str(install_dir)}")
+    version_tuple = parse_version(version)
     for tool in ("clang-format", "clang-tidy"):
-        uninstall_tool(tool, version, install_dir)
+        uninstall_tool(tool, version_tuple, install_dir)
 
 
 def install_clang_tools(
-    version: str, tools: str, directory: str, overwrite: bool, no_progress_bar: bool
+    version: VERSION_TUPLE,
+    tools: str,
+    directory: str,
+    overwrite: bool,
+    no_progress_bar: bool,
 ) -> None:
     """Wraps functions used to individually install tools.
 
@@ -261,7 +271,7 @@ def install_clang_tools(
     :param no_progress_bar: A flag used to disable the downloads' progress bar.
     """
     install_dir = install_dir_name(directory)
-    if install_dir.rstrip(os.sep) not in os.environ.get("PATH"):
+    if install_dir.rstrip(os.sep) not in os.environ.get("PATH", ""):
         print(
             f"{YELLOW}{install_dir}",
             f"directory is not in your environment variable PATH.{RESET_COLOR}",

clang_tools/main.py

@@ -4,10 +4,12 @@
 
 The module containing main entrypoint function.
 """
+
 import argparse
 
 from .install import install_clang_tools, uninstall_clang_tools
 from . import RESET_COLOR, YELLOW
+from .util import parse_version
 
 
 def get_parser() -> argparse.ArgumentParser:
@@ -66,13 +68,20 @@ def main():
     if args.uninstall:
         uninstall_clang_tools(args.uninstall, args.directory)
     elif args.install:
-        install_clang_tools(
-            args.install,
-            args.tool,
-            args.directory,
-            args.overwrite,
-            args.no_progress_bar,
-        )
+        version = parse_version(args.install)
+        if version != (0, 0, 0):
+            install_clang_tools(
+                version,
+                args.tool,
+                args.directory,
+                args.overwrite,
+                args.no_progress_bar,
+            )
+        else:
+            print(
+                f"{YELLOW}The version specified is not a semantic",
+                f"specification{RESET_COLOR}",
+            )
     else:
         print(
             f"{YELLOW}Nothing to do because `--install` and `--uninstall`",

clang_tools/util.py

@@ -8,10 +8,12 @@
 import hashlib
 from pathlib import Path
 import urllib.request
-from typing import Optional
+from typing import Optional, Tuple
 from urllib.error import HTTPError
 from http.client import HTTPResponse
 
+VERSION_TUPLE = Tuple[int, int, int]
+
 
 def check_install_os() -> str:
     """Identify this Operating System.
@@ -82,7 +84,6 @@ def get_sha_checksum(binary_url: str) -> str:
     with urllib.request.urlopen(
         binary_url.replace(".exe", "") + ".sha512sum"
     ) as response:
-        response: HTTPResponse
         return response.read(response.length).decode(encoding="utf-8")
 
 
@@ -99,3 +100,22 @@ def verify_sha512(checksum: str, exe: bytes) -> bool:
         # released checksum's include the corresponding filename (which we don't need)
         checksum = checksum.split(" ", 1)[0]
     return checksum == hashlib.sha512(exe).hexdigest()
+
+
+def parse_version(version: str) -> VERSION_TUPLE:
+    """Parse the given version string into a semantic specification.
+
+    :param version: The version specification as a string.
+
+    :returns: A tuple of ints that describes the major, minor, and patch versions.
+        If the version is a path, then the tuple is just 3 zeros.
+    """
+    version_tuple = version.split(".")
+    if len(version_tuple) < 3:
+        # append minor and patch version numbers if not specified
+        version_tuple += ["0"] * (3 - len(version_tuple))
+    try:
+        return tuple([int(x) for x in version_tuple])  # type: ignore[return-value]
+    except ValueError:
+        assert Path(version).exists(), "specified version is not a semantic or a path"
+        return (0, 0, 0)

tests/test_install.py

@@ -12,17 +12,18 @@
     is_installed,
     uninstall_clang_tools,
 )
+from clang_tools.util import VERSION_TUPLE
 
 
-@pytest.mark.parametrize("version", [str(v) for v in range(7, 17)] + ["12.0.1"])
+@pytest.mark.parametrize("version", [(v, 0, 0) for v in range(7, 17)] + [(12, 0, 1)])
 @pytest.mark.parametrize(
     "tool_name",
     ["clang-format", "clang-tidy", "clang-query", "clang-apply-replacements"],
 )
-def test_clang_tools_binary_url(tool_name: str, version: str):
+def test_clang_tools_binary_url(tool_name: str, version: VERSION_TUPLE):
     """Test `clang_tools_binary_url()`"""
     url = clang_tools_binary_url(tool_name, version)
-    assert f"{tool_name}-{version}_{install_os}-amd64" in url
+    assert f"{tool_name}-{version[0]}_{install_os}-amd64" in url
 
 
 @pytest.mark.parametrize("directory", ["", "."])
@@ -35,10 +36,10 @@ def test_dir_name(monkeypatch: pytest.MonkeyPatch, directory: str):
 
 def test_create_symlink(monkeypatch: pytest.MonkeyPatch, tmp_path: Path):
     """Test creation of symlink."""
-    tool_name, version = ("clang-tool", "1")
+    tool_name, version = ("clang-tool", (1, 0, 0))
     monkeypatch.chdir(str(tmp_path))
     # use a test tar file and rename it to "clang-tool-1" (+ OS suffix)
-    test_target = tmp_path / f"{tool_name}-{version}{suffix}"
+    test_target = tmp_path / f"{tool_name}-{version[0]}{suffix}"
     test_target.write_bytes(b"some binary data")
 
     # create the symlink
@@ -54,8 +55,10 @@ def test_create_symlink(monkeypatch: pytest.MonkeyPatch, tmp_path: Path):
     assert not create_sym_link(tool_name, version, str(tmp_path), True)
 
 
-@pytest.mark.parametrize("version", ["12"])
-def test_install_tools(monkeypatch: pytest.MonkeyPatch, tmp_path: Path, version: str):
+@pytest.mark.parametrize("version", [(12, 0, 0)])
+def test_install_tools(
+    monkeypatch: pytest.MonkeyPatch, tmp_path: Path, version: VERSION_TUPLE
+):
     """Test install tools to a temp directory."""
     monkeypatch.chdir(tmp_path)
     tool_name = "clang-format"
@@ -64,14 +67,14 @@ def test_install_tools(monkeypatch: pytest.MonkeyPatch, tmp_path: Path, version:
     # invoking again should return False
     assert not install_tool(tool_name, version, str(tmp_path), False)
     # uninstall the tool deliberately
-    uninstall_clang_tools(version, str(tmp_path))
+    uninstall_clang_tools(".".join([str(x) for x in version]), str(tmp_path))
     assert f"{tool_name}-{version}{suffix}" not in [
         fd.name for fd in tmp_path.iterdir()
     ]
 
 
-@pytest.mark.parametrize("version", ["0"])
-def test_is_installed(version: str):
+@pytest.mark.parametrize("version", [(0, 0, 0)])
+def test_is_installed(version: VERSION_TUPLE):
     """Test if installed version matches specified ``version``"""
     tool_path = is_installed("clang-format", version=version)
     assert tool_path is None
@@ -84,9 +87,9 @@ def test_path_warning(capsys: pytest.CaptureFixture):
     2. indicates a failure to download a tool
     """
     try:
-        install_clang_tools("x", "x", ".", False, False)
+        install_clang_tools((0, 0, 0), "x", ".", False, False)
     except OSError as exc:
-        if install_dir_name(".") not in os.environ.get("PATH"):  # pragma: no cover
+        if install_dir_name(".") not in os.environ.get("PATH", ""):  # pragma: no cover
             # this warning does not happen in an activated venv
             result = capsys.readouterr()
             assert "directory is not in your environment variable PATH" in result.out

tests/test_util.py

@@ -1,9 +1,15 @@
 """Tests related to the utility functions."""
+
 from pathlib import Path, PurePath
 import pytest
 from clang_tools import install_os
 from clang_tools.install import clang_tools_binary_url
-from clang_tools.util import check_install_os, download_file, get_sha_checksum
+from clang_tools.util import (
+    check_install_os,
+    download_file,
+    get_sha_checksum,
+    parse_version,
+)
 from clang_tools import release_tag
 
 
@@ -19,7 +25,7 @@ def test_check_install_os():
 def test_download_file(monkeypatch: pytest.MonkeyPatch, tmp_path: Path, tag: str):
     """Test that deliberately fails to download a file."""
     monkeypatch.chdir(str(tmp_path))
-    url = clang_tools_binary_url("clang-format", "12", tag=tag)
+    url = clang_tools_binary_url("clang-format", (12, 0, 0), tag=tag)
     file_name = download_file(url, "file.tar.gz", True)
     assert file_name is not None
 
@@ -31,5 +37,11 @@ def test_get_sha(monkeypatch: pytest.MonkeyPatch):
     expected = Path(f"clang-format-12_{install_os}-amd64.sha512sum").read_text(
         encoding="utf-8"
     )
-    url = clang_tools_binary_url("clang-format", "12", tag=release_tag)
+    url = clang_tools_binary_url("clang-format", (12, 0, 0), tag=release_tag)
     assert get_sha_checksum(url) == expected
+
+
+def test_version_path():
+    """Tests version parsing when given specification is a path."""
+    version = str(Path(__file__).parent)
+    assert parse_version(version) == (0, 0, 0)