promtext-cli 0.1.2.dev84__tar.gz → 0.1.2.dev93__tar.gz

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/.copier-answers.yml

@@ -1,13 +1,14 @@
 # Changes here will be overwritten by Copier.
-_commit: 0.5.11
+_commit: 0.7.7
 _src_path: https://codeberg.org/margau/copier-python-uv.git
-code_dir: src
+code_dir: promtext_cli
 container: false
 forgejo_publish: true
 forgejo_url: https://codeberg.org/margau/promtext-cli
-ignore_pylint: true
-ignore_ruff: true
-ignore_ruff_format: true
+ignore_pylint: false
+ignore_pytest: false
+ignore_ruff: false
+ignore_ruff_format: false
 project_description: Prometheus Textfile Tooling
 project_name: promtext-cli
 pypi_publish: true

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/.forgejo/workflows/commitlint.yaml

@@ -11,7 +11,7 @@ jobs:
   commitlint-check:
     runs-on: docker
     container:
-      image: codeberg.org/margau/buildenv-commitlint:latest@sha256:243d5a0bed5be48a06167e2f4eaa132b7548f3e93605601575fb8e2612e5da82
+      image: codeberg.org/margau/buildenv-commitlint:latest@sha256:8253a5665a32be5a1ec56589e85e9c40634ca43a3d3ec261b08759e8e87efc60
 
     steps:
       - uses: https://code.forgejo.org/actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/.forgejo/workflows/lint.yaml

@@ -20,8 +20,8 @@ jobs:
       - name: Install the project
         run: uv sync --locked --all-extras --dev
       - name: check with ruff
-        run: uv run ruff check src || exit 0 
+        run: uv run ruff check promtext_cli tests 
       - name: format with ruff
-        run: uv run ruff format --check src || exit 0 
+        run: uv run ruff format --check promtext_cli tests 
       - name: check with pylint
-        run: uv run pylint src || exit 0 
+        run: uv run pylint promtext_cli tests  # TODO: Check if there is a need for special pytest-related pylint rules

promtext_cli-0.1.2.dev93/.forgejo/workflows/test.yaml

@@ -0,0 +1,25 @@
+name: pytest
+
+on:
+  push:
+    branches:
+      - main
+  # non-main branches are handled by pull_request
+  pull_request:
+
+jobs:
+  pytest:
+    runs-on: docker
+    container:
+      image: codeberg.org/margau/buildenv-uv:latest@sha256:aaaf8bd9bfbe276136de485eb397aad9dc569b0ae76473b12f16b0205fcf4be0
+
+    steps:
+      - uses: https://code.forgejo.org/actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        with:
+          fetch-depth: 0
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+      - name: run pytest
+        run: uv run coverage run -m pytest -v 
+      - name: show coverage
+        run: uv run coverage report -m

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
         stages: [commit-msg]
         args: []
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.12
+    rev: v0.15.13
     hooks:
       # Run the linter.
       - id: ruff-check

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: promtext-cli
-Version: 0.1.2.dev84
+Version: 0.1.2.dev93
 Summary: Prometheus Textfile Tooling
 Project-URL: Documentation, https://codeberg.org/margau/promtext-cli/src/branch/main#readme
 Project-URL: Issues, https://codeberg.org/margau/promtext-cli/issues

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/promtext_cli/main.py

@@ -1,5 +1,8 @@
 """promtext_cli is providing a CLI to cleanly update prometheus textfiles from scripts"""
 
+# pylint: disable=C0116,R0914,R0912,R0915
+# this rules will be fixed by a object-oriented refactoring
+
 import argparse
 from pathlib import Path
 import logging
@@ -8,37 +11,43 @@ import sys
 from prometheus_client.parser import text_string_to_metric_families
 from prometheus_client import CollectorRegistry, Gauge, write_to_textfile
 
+
 def promtext():
     # setup argpars
     # required file first
-    parser = argparse.ArgumentParser(description='Prometheus textfile helper')
+    parser = argparse.ArgumentParser(description="Prometheus textfile helper")
     parser.add_argument(
-        'filename', 
+        "filename",
         type=str,
-        help='Path to existing or new prometheus textfile, will be updated'
-        )
+        help="Path to existing or new prometheus textfile, will be updated",
+    )
 
     # metric name, required
-    parser.add_argument(
-        'metric', 
-        type=str,
-        help='metric name (new or updated)')
+    parser.add_argument("metric", type=str, help="metric name (new or updated)")
 
     # metric value as int/float, required
-    parser.add_argument('value', type=float, help='metric value')
+    parser.add_argument("value", type=float, help="metric value")
 
     # metric documentation as optional argument
     parser.add_argument(
-        '--docs', type=str, 
-        help='metric documentation', default="metric appended by promtext-cli")
+        "--docs",
+        type=str,
+        help="metric documentation",
+        default="metric appended by promtext-cli",
+    )
 
     # labels, key-value, minimum 0, repeatable
-    parser.add_argument("--label", metavar="KEY=VALUE", help='label key=value pairs', action='append')
+    parser.add_argument(
+        "--label", metavar="KEY=VALUE", help="label key=value pairs", action="append"
+    )
 
     # log level from argparse
     parser.add_argument(
-        '-v', '--verbose',
-        action="store_const", dest="loglevel", const=logging.INFO,
+        "-v",
+        "--verbose",
+        action="store_const",
+        dest="loglevel",
+        const=logging.INFO,
     )
     args = parser.parse_args()
     logging.basicConfig(level=args.loglevel)
@@ -52,7 +61,7 @@ def promtext():
 
     # check if args.filename exists with pathlib
     if textfile.is_file():
-        for f in text_string_to_metric_families(textfile.read_text()):
+        for f in text_string_to_metric_families(textfile.read_text(encoding="utf-8")):
             # per metric: iterate over samples, create metric in registry
             m = False
             samples = []
@@ -63,8 +72,13 @@ def promtext():
                 labelnames = list(samples[0].labels.keys())
                 # metric-type specific init
                 if f.type == "gauge":
-                    m = Gauge(f.name, f.documentation,
-                        unit=f.unit, labelnames=labelnames, registry=registry)
+                    m = Gauge(
+                        f.name,
+                        f.documentation,
+                        unit=f.unit,
+                        labelnames=labelnames,
+                        registry=registry,
+                    )
                 else:
                     # we don't support other types yet, continue in these cases
                     logger.warning("unsupported metric type %s, dropping", f.type)
@@ -76,8 +90,11 @@ def promtext():
                     else:
                         m.set(s.value)
                 metrics[f.name] = m
-                logger.info("copy gauge metric %s with labels %s from old file",
-                    f.name, ', '.join(labelnames))
+                logger.info(
+                    "copy gauge metric %s with labels %s from old file",
+                    f.name,
+                    ", ".join(labelnames),
+                )
             else:
                 logger.warning("got empty metric %s from old file, dropping", f.name)
 
@@ -99,18 +116,24 @@ def promtext():
         labelvalues = labels.values()
     else:
         m = metrics[args.metric]
-        
+
+        # There is no way to access existing labelnames directly
+        # pylint: disable=W0212
         old_labelnames = list(m._labelnames)
         for la in old_labelnames:
             logger.info("processing label %s", la)
-            if la in labels: # labelvalues are needed in order!
+            if la in labels:  # labelvalues are needed in order!
                 labelvalues.append(labels[la])
             else:
                 logger.error("previously known label '%s' missing, cannot update!", la)
                 sys.exit(1)
         if len(old_labelnames) != len(labels.keys()):
-            logger.error("labelnames for metric %s not the same, cannot update! Old: %s, New: %s",
-                args.metric, old_labelnames, list(labels.keys()))
+            logger.error(
+                "labelnames for metric %s not the same, cannot update! Old: %s, New: %s",
+                args.metric,
+                old_labelnames,
+                list(labels.keys()),
+            )
             sys.exit(1)
         logger.info("updating metric %s", args.metric)
 
@@ -124,5 +147,6 @@ def promtext():
     write_to_textfile(args.filename, registry)
     logger.info("wrote to %s", args.filename)
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     promtext()

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/pyproject.toml

@@ -30,13 +30,19 @@ Source = "https://codeberg.org/margau/promtext-cli.git"
 [project.scripts]
 promtext = "promtext_cli.main:promtext"
 
+[dependency-groups]
+dev = [
+  "ruff>=0.15.13",
+  "pylint>=4.0.5",
+  "pytest>=9.0.3",
+  "coverage>=7.14.0",
+  "cli-test-helpers>=4.2.0",
+]
 
-# Dev Dependencies
 [tool.uv]
-dev-dependencies = [
-  "ruff",
-  "pylint",
-]
 cache-keys = [{ file = "pyproject.toml" }, { git = { commit = true, tags = true } }]
 
+[tool.coverage.run]
+source = ["src", "tests"]
+
 # TODO: Dev/CI scripts for lint & co.

{promtext_cli-0.1.2.dev84 → promtext_cli-0.1.2.dev93}/renovate.json

@@ -8,6 +8,7 @@
       "matchFileNames": [
         ".forgejo/workflows/commitlint.yaml",
         ".forgejo/workflows/lint.yaml",
+        ".forgejo/workflows/test.yaml",
         ".forgejo/workflows/publish.yaml",
         ".forgejo/workflows/container.yaml",
         "Containerfile"
@@ -18,6 +19,7 @@
       "matchFileNames": [
         ".forgejo/workflows/commitlint.yaml",
         ".forgejo/workflows/lint.yaml",
+        ".forgejo/workflows/test.yaml",
         ".forgejo/workflows/publish.yaml",
         ".forgejo/workflows/container.yaml",
         "Containerfile"

promtext_cli-0.1.2.dev93/tests/test_blackbox.py

@@ -0,0 +1,48 @@
+# pylint: disable=R0801
+"""This script does blackbox-like testing of the promtext cli tool"""
+
+import shutil
+from cli_test_helpers import shell
+
+
+def test_entrypoint():
+    """
+    Is entrypoint script installed? (pyproject.toml)
+    """
+    assert shutil.which("promtext")
+
+
+def test_help():
+    """
+    Does the help command work?
+    """
+    result = shell("promtext --help")
+    assert result.exit_code == 0
+    assert "usage:" in result.stdout
+
+
+def test_empty():
+    """
+    Does the command fails with no arguments?
+    """
+    result = shell("promtext")
+    assert result.exit_code == 2
+    assert "usage:" in result.stderr
+
+
+def test_new_file(tmp_path):
+    """
+    Does the command create a new file with metrics content?
+    """
+    promfile = tmp_path / "new_file.prom"
+    result = shell(f"promtext {promfile} test_metric 0")
+    assert result.exit_code == 0
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP test_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE test_metric gauge"
+        "\n"
+        "test_metric 0.0"
+        "\n"
+    )

promtext_cli-0.1.2.dev93/tests/test_functional.py

@@ -0,0 +1,342 @@
+# pylint: disable=R0801,W0511
+"""This script does functional testing by calling the methods directly"""
+
+from cli_test_helpers import ArgvContext
+import pytest
+
+import promtext_cli.main
+
+
+def test_new_file(tmp_path):
+    """
+    Does the command create a new file with metrics content?
+    """
+    promfile = tmp_path / "new_file.prom"
+    with ArgvContext("promtext", str(promfile), "test_metric", "0"):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP test_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE test_metric gauge"
+        "\n"
+        "test_metric 0.0"
+        "\n"
+    )
+
+
+def test_labels(tmp_path):
+    """
+    Does the command create a new file with metrics content?
+    """
+    promfile = tmp_path / "label_file.prom"
+    with ArgvContext(
+        "promtext", "--label", "testlabel=testvalue", str(promfile), "test_metric", 0
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP test_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE test_metric gauge"
+        "\n"
+        'test_metric{testlabel="testvalue"} 0.0'
+        "\n"
+    )
+
+
+def test_existing_metric_append_metric(tmp_path):
+    """
+    Does the command append a new metric to an existing file
+    with metrics content and preserve existing metrics?
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="testvalue"} 0.0'
+        "\n"
+    )
+    with ArgvContext(
+        "promtext", "--label", "testlabel=testvalue", str(promfile), "new_metric", 0
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="testvalue"} 0.0'
+        "\n"
+        "# HELP new_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE new_metric gauge"
+        "\n"
+        'new_metric{testlabel="testvalue"} 0.0'
+        "\n"
+    )
+
+
+def test_existing_metric_append_labelvalue(tmp_path):
+    """
+    Does the command append a new metric to an existing file
+    with metrics content and preserve existing metrics?
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="existing"} 0.0'
+        "\n"
+    )
+    with ArgvContext(
+        "promtext", "--label", "testlabel=new", str(promfile), "existing_metric", 0
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="existing"} 0.0'
+        "\n"
+        'existing_metric{testlabel="new"} 0.0'
+        "\n"
+    )
+
+
+def test_existing_metric_multilabel(tmp_path):
+    """
+    Does the command append a new metric to an existing file
+    with metrics content and preserve existing metrics?
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{first="existing", second="existing"} 0.0'
+        "\n"
+    )
+    with ArgvContext(
+        "promtext",
+        "--label",
+        "first=new",
+        "--label",
+        "second=new",
+        str(promfile),
+        "existing_metric",
+        "42",
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{first="existing",second="existing"} 0.0'
+        "\n"
+        'existing_metric{first="new",second="new"} 42.0'
+        "\n"
+    )
+
+
+def test_existing_metric_overwrite(tmp_path):
+    """
+    Does the command overwrite a metric/labelset
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="existing"} 0.0'
+        "\n"
+    )
+    with ArgvContext(
+        "promtext",
+        "--label",
+        "testlabel=existing",
+        str(promfile),
+        "existing_metric",
+        "42",
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="existing"} 42.0'
+        "\n"
+    )
+
+
+def test_existing_metric_plain(tmp_path):
+    """
+    Does the command overwrite a metric without a label?
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        "existing_metric 0.0"
+        "\n"
+    )
+    with ArgvContext("promtext", str(promfile), "existing_metric", "42"):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        "existing_metric 42.0"
+        "\n"
+    )
+
+
+def test_existing_metric_labeldrop(tmp_path, capsys):
+    """
+    missing labels are not possible, promtext should fail
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="existing"} 0.0'
+        "\n"
+    )
+
+    with (
+        ArgvContext("promtext", str(promfile), "existing_metric", "42"),
+        pytest.raises(SystemExit) as pytest_wrapped_e,
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{testlabel="existing"} 0.0'
+        "\n"
+    )  # the content is not changed
+    # check that promtext exits correctly
+    assert pytest_wrapped_e.type is SystemExit
+    assert pytest_wrapped_e.value.code == 1
+    captured = capsys.readouterr()
+    assert (
+        "ERROR:promtext_cli.main:previously known label 'testlabel' missing, cannot update!"
+        in captured.err
+    )
+
+
+def test_existing_metric_labelchange(tmp_path, capsys):
+    """
+    changing labels are not possible, promtext should fail
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{existinglabel="existing"} 0.0'
+        "\n"
+    )
+
+    with (
+        ArgvContext(
+            "promtext",
+            "--label",
+            "newlabel=new",
+            str(promfile),
+            "existing_metric",
+            "42",
+        ),
+        pytest.raises(SystemExit) as pytest_wrapped_e,
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{existinglabel="existing"} 0.0'
+        "\n"
+    )  # the content is not changed
+    # check that promtext exits correctly
+    assert pytest_wrapped_e.type is SystemExit
+    assert pytest_wrapped_e.value.code == 1
+    captured = capsys.readouterr()
+    assert (
+        "ERROR:promtext_cli.main:previously known label 'existinglabel' missing, cannot update!"
+        in captured.err
+    )
+
+
+def test_existing_metric_labeladd(tmp_path, capsys):
+    """
+    adding new labels are not possible, promtext should fail
+    """
+    promfile = tmp_path / "existing_file.prom"
+    promfile.write_text(
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{existinglabel="existing"} 0.0'
+        "\n"
+    )
+
+    with (
+        ArgvContext(
+            "promtext",
+            "--label",
+            "existinglabel=existing",
+            "--label",
+            "newlabel=new",
+            str(promfile),
+            "existing_metric",
+            "42",
+        ),
+        pytest.raises(SystemExit) as pytest_wrapped_e,
+    ):
+        promtext_cli.main.promtext()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP existing_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE existing_metric gauge"
+        "\n"
+        'existing_metric{existinglabel="existing"} 0.0'
+        "\n"
+    )  # the content is not changed
+    # check that promtext exits correctly
+    assert pytest_wrapped_e.type is SystemExit
+    assert pytest_wrapped_e.value.code == 1
+    captured = capsys.readouterr()
+    assert (
+        "ERROR:promtext_cli.main:labelnames for metric existing_metric not the same, cannot update"
+        in captured.err
+    )
+
+
+# TODO: Test docs in promtext
+# TODO: Test non-gauge-values