✨ Add the stats command

Jamim · Jamim · commit 840e7be87aad · 2024-05-13T03:09:17.000+03:00
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 ## 🧑🏽‍🔬 Usage
 
-To enable [ccache][ccache] for `glibc`, run:
+To enable [ccache][ccache] for `sys-libs/glibc`, run:
 ```shell
 gcm enable glibc
 ```
@@ -18,6 +18,11 @@ To disable it, run:
 gcm disable glibc
 ```
 
+To explore all available commands, run:
+```shell
+gcm --help
+```
+
 [ci-badge]: https://img.shields.io/github/actions/workflow/status/Jamim/gentoo-cache-manager/ci.yml.svg
 [ci]: https://github.com/Jamim/gentoo-cache-manager/actions/workflows/ci.yml
 [cov-badge]: https://codecov.io/github/Jamim/gentoo-cache-manager/graph/badge.svg
diff --git a/src/gcm/commands/__init__.py b/src/gcm/commands/__init__.py
@@ -1,4 +1,5 @@
 from .disable import Disable
 from .enable import Enable
+from .stats import Stats
 
-COMMANDS = [Enable(), Disable()]
+COMMANDS = [Enable(), Disable(), Stats()]
diff --git a/src/gcm/commands/stats.py b/src/gcm/commands/stats.py
@@ -0,0 +1,82 @@
+import io
+import re
+import subprocess
+
+import click
+
+from .base import (
+    CCACHE_DIR,
+    PACKAGE_NAME,
+    Command,
+)
+
+COLORS = {
+    'Cacheable calls': ('yellow', 'magenta'),
+    'Hits': ('green', 'yellow'),
+    'Direct': ('bright_green', 'green'),
+    'Preprocessed': ('bright_green', 'green'),
+    'Misses': ('blue', 'yellow'),
+    'Uncacheable calls': ('red', 'magenta'),
+    'Local storage': ('white', ''),
+    'Cache size (GiB)': ('cyan', 'magenta'),
+    'Cache size (GB)': ('cyan', 'magenta'),
+    'Cleanups': ('bright_black', ''),
+}
+STAT_REGEX = re.compile(r'(?P<indent> *)(?P<title>.*):(?P<data>.*)?\n')
+DATA_REGEX = re.compile(
+    r'(?P<spacing> +)(?P<value>[\d.]+) / '
+    r'(?P<total> *[\d.]+) \((?P<percent>.*)\)'
+)
+STAT_TEMPLATE = '  {indent}{title}:{data}\n'
+DATA_TEMPLATE = '{spacing}{value} / {total} ({percent})'
+
+
+def colorize_data(data: str, stat_color: str, total_color: str) -> str:
+    match = DATA_REGEX.match(data)
+    if not match:
+        return click.style(data, stat_color)
+
+    values = match.groupdict()
+
+    def colorize(key: str, color: str) -> None:
+        values[key] = click.style(values[key], color)
+
+    colorize('value', stat_color)
+    colorize('total', total_color)
+    colorize('percent', stat_color)
+
+    return DATA_TEMPLATE.format(**values)
+
+
+def show_stats(package: str) -> None:
+    stdout: io.TextIOWrapper = subprocess.Popen(
+        ['ccache', '-s'],
+        env={'CCACHE_DIR': CCACHE_DIR / package},
+        stdout=subprocess.PIPE,
+        text=True,
+    ).stdout  # type: ignore[assignment]
+    stats = stdout.readlines()
+    for line in stats:
+        match = STAT_REGEX.match(line)
+        if match:
+            indent, title, data = match.groups()
+            colors = COLORS.get(title)
+            if colors:
+                stat_color, total_color = colors
+                title = click.style(title, stat_color)
+                if data:
+                    data = colorize_data(data, stat_color, total_color)
+            line = STAT_TEMPLATE.format(indent=indent, title=title, data=data)
+        else:
+            line = f'  {line}'
+        click.echo(line, nl=False)
+
+
+class Stats(Command):
+    """Show ccache stats for a package."""
+
+    INVOKE_MESSAGE = f'Showing ccache stats for {PACKAGE_NAME}'
+
+    @staticmethod
+    def callback(package: str) -> None:  # type: ignore[override]
+        show_stats(package)
diff --git a/tests/commands/test_stats.py b/tests/commands/test_stats.py
@@ -0,0 +1,87 @@
+from unittest.mock import patch
+
+import pytest
+from click.testing import CliRunner
+
+from gcm.commands.stats import Stats
+
+MODERN_STATS = """Cacheable calls:   101 / 235 (42.98%)
+  Hits:              8 / 101 ( 7.92%)
+    Direct:          6 /   8 (75.00%)
+    Preprocessed:    2 /   8 (25.00%)
+  Misses:           93 / 101 (92.08%)
+Uncacheable calls: 134 / 235 (57.02%)
+Local storage:
+  Cache size (GiB): 0.1 / 2.0 ( 0.00%)
+  Cleanups:         16
+  Hits:              8 / 101 ( 7.92%)
+  Misses:           93 / 101 (92.08%)"""
+
+LEGACY_STATS = """Summary:
+  Hits:               8 /  101 (7.92 %)
+    Direct:           6 /  135 (4.44 %)
+    Preprocessed:     2 /  119 (1.68 %)
+  Misses:            93
+    Direct:         129
+    Preprocessed:   117
+  Uncacheable:      134
+Primary storage:
+  Hits:              37 /  260 (14.23 %)
+  Misses:           223
+  Cache size (GB): 0.10 / 2.00 (0.00 %)
+  Cleanups:          16
+
+Use the -v/--verbose option for more details."""
+
+MODERN_OUTPUT = """Showing ccache stats for \x1b[32m\x1b[1mapp-misc/foo\x1b[0m
+  \x1b[33mCacheable calls\x1b[0m:   \x1b[33m101\x1b[0m / \x1b[35m235\x1b[0m (\x1b[33m42.98%\x1b[0m)
+    \x1b[32mHits\x1b[0m:              \x1b[32m8\x1b[0m / \x1b[33m101\x1b[0m (\x1b[32m 7.92%\x1b[0m)
+      \x1b[92mDirect\x1b[0m:          \x1b[92m6\x1b[0m / \x1b[32m  8\x1b[0m (\x1b[92m75.00%\x1b[0m)
+      \x1b[92mPreprocessed\x1b[0m:    \x1b[92m2\x1b[0m / \x1b[32m  8\x1b[0m (\x1b[92m25.00%\x1b[0m)
+    \x1b[34mMisses\x1b[0m:           \x1b[34m93\x1b[0m / \x1b[33m101\x1b[0m (\x1b[34m92.08%\x1b[0m)
+  \x1b[31mUncacheable calls\x1b[0m: \x1b[31m134\x1b[0m / \x1b[35m235\x1b[0m (\x1b[31m57.02%\x1b[0m)
+  \x1b[37mLocal storage\x1b[0m:
+    \x1b[36mCache size (GiB)\x1b[0m: \x1b[36m0.1\x1b[0m / \x1b[35m2.0\x1b[0m (\x1b[36m 0.00%\x1b[0m)
+    \x1b[90mCleanups\x1b[0m:\x1b[90m         16\x1b[0m
+    \x1b[32mHits\x1b[0m:              \x1b[32m8\x1b[0m / \x1b[33m101\x1b[0m (\x1b[32m 7.92%\x1b[0m)
+    \x1b[34mMisses\x1b[0m:           \x1b[34m93\x1b[0m / \x1b[33m101\x1b[0m (\x1b[34m92.08%\x1b[0m)
+\x1b[32mDone :-)\x1b[0m
+"""  # noqa: E501
+
+LEGACY_OUTPUT = """Showing ccache stats for \x1b[32m\x1b[1mapp-misc/foo\x1b[0m
+  Summary:
+    \x1b[32mHits\x1b[0m:               \x1b[32m8\x1b[0m / \x1b[33m 101\x1b[0m (\x1b[32m7.92 %\x1b[0m)
+      \x1b[92mDirect\x1b[0m:           \x1b[92m6\x1b[0m / \x1b[32m 135\x1b[0m (\x1b[92m4.44 %\x1b[0m)
+      \x1b[92mPreprocessed\x1b[0m:     \x1b[92m2\x1b[0m / \x1b[32m 119\x1b[0m (\x1b[92m1.68 %\x1b[0m)
+    \x1b[34mMisses\x1b[0m:\x1b[34m            93\x1b[0m
+      \x1b[92mDirect\x1b[0m:\x1b[92m         129\x1b[0m
+      \x1b[92mPreprocessed\x1b[0m:\x1b[92m   117\x1b[0m
+    Uncacheable:      134
+  Primary storage:
+    \x1b[32mHits\x1b[0m:              \x1b[32m37\x1b[0m / \x1b[33m 260\x1b[0m (\x1b[32m14.23 %\x1b[0m)
+    \x1b[34mMisses\x1b[0m:\x1b[34m           223\x1b[0m
+    \x1b[36mCache size (GB)\x1b[0m: \x1b[36m0.10\x1b[0m / \x1b[35m2.00\x1b[0m (\x1b[36m0.00 %\x1b[0m)
+    \x1b[90mCleanups\x1b[0m:\x1b[90m          16\x1b[0m
+  
+  Use the -v/--verbose option for more details.
+\x1b[32mDone :-)\x1b[0m
+"""  # noqa: E501
+
+
+@pytest.mark.parametrize(
+    'stats,output',
+    (
+        (MODERN_STATS, MODERN_OUTPUT),
+        (LEGACY_STATS, LEGACY_OUTPUT),
+    ),
+)
+@patch('subprocess.Popen')
+def test_stats(popen, stats, output):
+    popen.return_value.stdout.readlines.return_value = [
+        f'{line}\n' for line in stats.split('\n')
+    ]
+
+    result = CliRunner().invoke(Stats(), ['foo'], color=True)
+
+    assert result.exit_code == 0
+    assert result.output == output
