basic tests and workflow test

Author: gistart

.github/workflows/tests.yml

@@ -0,0 +1,50 @@
+name: test-all
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: run all tests
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9, 'pypy3']
+    services:
+      victoria:
+        image: victoriametrics/victoria-metrics:v1.59.0
+        #options: >-
+        #  --entrypoint "/victoria-metrics-prod", "--envflag.enable"]
+        env:
+          httpListenAddr: 8429
+          influxListenAddr: 8491
+          graphiteListenAddr: 8492
+        ports:
+        - 8428:8428
+        - 8491:8491
+        - 8492:8492
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+    - name: python${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: pip-requirements
+      run: pip install --upgrade -e .[test]
+    - name: run-test
+      run: pytest -svvv --continue-on-collection-errors --cov=./prometheus_push_client --cov-report=xml:coverage.xml
+      env:
+        VM_HOST: localhost
+        VM_API_PORT: 8428
+        VM_INFLUX_PORT: 8491
+        VM_GRAPHITE_PORT: 8492
+    - name: upload-cov
+      uses: codecov/codecov-action@v1
+      with:
+        files: coverage.xml
+        verbose: true

README.md

@@ -0,0 +1,9 @@
+# prometheus-push-client
+
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gistart/prometheus-push-client/test-all)
+
+## Default labelvalues
+
+! host AND victoria account id
+
+! side-effect: does not register labelled metrics at creation time, so you report only metrics that you used!

prometheus_push_client/metrics.py

@@ -9,7 +9,6 @@ def __init__(self, name, documentation="", default_labelvalues=None, **kwargs):
         kwargs["registry"] = kwargs.get("registry", PUSH_REGISTRY)
         self._default_labelvalues = default_labelvalues or {}
         super().__init__(name, documentation, **kwargs)
-
         # TODO: hooks for sync mode
 
     def labels(self, *labelvalues, **labelkwargs):

setup.py

@@ -38,7 +38,7 @@
         "test": [
             "pytest",
             "pytest-asyncio",
-            "aiohttp",
+            "pytest-cov",
             "requests",
         ],
     }

test/conftest.py

@@ -0,0 +1,3 @@
+import sys
+import os
+sys.path.append(os.path.join(os.path.dirname(__file__)))

test/test_offline/__init__.py

@@ -0,0 +1,49 @@
+import pytest
+import prometheus_push_client as ppc
+
+from testutils import make_metric_fixture, collect_metrics
+
+NS = "test_offline"
+SUB = "defaults"
+
+
+_cnt1 = ppc.Counter(
+    name="c1",
+    namespace=NS,
+    subsystem=SUB,
+    labelnames=["host", "l1", "l2"],
+    default_labelvalues={
+        "host": "localhost",
+        "l1": 0,
+    }
+)
+
+@pytest.fixture
+def counter1(request):
+    return make_metric_fixture(request, _cnt1)
+
+
+@pytest.fixture
+def test_defaults_expected():
+    return \
+"""
+test_offline_defaults_c1_total{host="localhost",l1="0",l2="2"} 2.0
+test_offline_defaults_c1_total{host="localhost",l1="1",l2="2"} 2.0
+test_offline_defaults_c1_total{host="H",l1="1",l2="2"} 2.0
+""".strip()
+
+
+def test_default_labelvalues_usage(counter1, test_defaults_expected):
+    # pairs of equivalent actions:
+
+    counter1.labels(l2=2).inc()
+    counter1.labels(2).inc()
+
+    counter1.labels(l1=1, l2=2).inc()
+    counter1.labels(1, 2).inc()
+
+    counter1.labels(host="H", l1=1, l2=2).inc()
+    counter1.labels("H", 1, 2).inc()
+
+    res = collect_metrics(counter1._name)
+    assert res == test_defaults_expected

test/test_offline/test_defaults.py

@@ -0,0 +1,63 @@
+import pytest
+
+import prometheus_push_client as ppc
+
+from testutils import make_metric_fixture, collect_metrics
+
+
+NS = "test_offline"
+SUB = "influx"
+
+
+@pytest.fixture
+def sum1(request):
+    return make_metric_fixture(
+        request,
+        ppc.Summary(name="s1", namespace=NS, subsystem=SUB)
+    )
+
+
+@pytest.fixture
+def counter1(request):
+    return make_metric_fixture(
+        request,
+        ppc.Counter(name="c1", namespace=NS, subsystem=SUB)
+    )
+
+
+@pytest.fixture
+def histogram1(request):
+    return make_metric_fixture(
+        request,
+        ppc.Histogram(name="h1", namespace=NS, subsystem=SUB, buckets=[1,2,float("inf")])
+    )
+
+
+
+def test_influx_formatter(sum1, counter1, histogram1):
+    pass
+
+
+@pytest.fixture
+def invalid_gauge(request):
+    return make_metric_fixture(request, ppc.Gauge("justgauge"))
+
+
+@pytest.fixture
+def valid_gauge(request):
+    return make_metric_fixture(request, ppc.Gauge("just_gauge"))
+
+
+def test_influx_metric_name_invalid(invalid_gauge):
+    with pytest.raises(ValueError):
+        fmt = ppc.InfluxFormat()
+
+
+def test_influx_metric_name_valid(valid_gauge):
+    fmt = ppc.InfluxFormat()
+
+    valid_gauge.inc(10)
+    valid_gauge.inc(-5)
+
+    data = fmt.generate_latest().decode()
+    assert data == "just gauge=5.0"

test/test_offline/test_influx.py

@@ -0,0 +1,18 @@
+import os
+import pytest
+
+
+@pytest.fixture
+def cfg():
+
+    class Cfg:
+        vm_host = os.getenv("VM_HOST", "localhost")
+        vm_api_port = os.getenv("VM_API_PORT", "8428")
+        vm_influx_port = os.getenv("VM_INFLUX_PORT", "8491")
+        vm_graphite_port = os.getenv("VM_GRAPHITE_PORT", "8492")
+
+        vm_ping_url = f"http://{vm_host}:{vm_api_port}/health"
+        vm_write_url = f"http://{vm_host}:{vm_api_port}/write"
+        vm_export_url = f"http://{vm_host}:{vm_api_port}/api/v1/export"
+
+    return Cfg()