Modified dependency on custom py-pure-client

Author: genegr

setup.cfg

@@ -51,9 +51,8 @@ install_requires =
     importlib-metadata; python_version<"3.8"
     sanic
     prometheus-client
-    py-pure-client
-
-
+    # temporary workaround for Pure Python SDK
+    py-pure-client @ git+https://github.com/genegr/py-pure-client.git
 
 [options.packages.find]
 where = src

src/pure_fa_openmetrics_exporter/pure_fa_exporter.py

@@ -4,7 +4,7 @@
 
 from sanic import Sanic
 from sanic.log import logger
-from sanic.response import text, html, raw
+from sanic.response import text, html, raw, empty
 from sanic.exceptions import SanicException
 from sanic.handlers import ErrorHandler
 from prometheus_client import generate_latest, CollectorRegistry
@@ -104,6 +104,10 @@ async def flasharray_handler(request, tag):
     registry = CollectorRegistry()
     collector = FlasharrayCollector
     endpoint = request.args.get('endpoint', None)
+    if not endpoint:
+        return empty(status=400)
+    if (len(request.args.keys()) > 1):
+        return empty(status=400)
     fa_client = FlasharrayClient(endpoint, request.token, app.ctx.disable_cert_warn)
     registry.register(collector(fa_client, request=tag))
     resp = generate_latest(registry)

tests/conftest.py

@@ -1,9 +1,11 @@
 import pytest
 from pypureclient import PureError
 from pure_fa_openmetrics_exporter.flasharray_client import client
+from pure_fa_openmetrics_exporter import pure_fa_exporter
+from sanic_testing.testing import SanicTestClient
 
-@pytest.fixture()
-def fa_client(scope="session"):
+@pytest.fixture(scope="session")
+def fa_client():
     try:
         c = client.FlasharrayClient(
                              target = '10.225.112.90',
@@ -12,3 +14,18 @@ def fa_client(scope="session"):
     except PureError as pe:
         pytest.fail("Could not connect to flasharray {0}".format(pe))
     yield c
+
+@pytest.fixture()
+def api_token():
+    return 'b5cb29e7-a93c-b40a-b02f-da2b90c8c65e' 
+
+@pytest.fixture()
+def endpoint():
+    return '10.225.112.90' 
+
+@pytest.fixture(scope="session")
+def app_client():
+    app = pure_fa_exporter.app
+    app.ctx.disable_cert_warn = True
+    client = SanicTestClient(app)
+    return client

tests/functional/test_01_home.py

@@ -1,5 +1,7 @@
 import pytest
+from httpx import Headers
 
-def test_home(client):
-    rv = client.get("/")
-    assert b'/metrics' in rv.data
+def test_home(app_client, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/', headers = h)
+    assert res.status_code == 200

tests/functional/test_02_array.py

@@ -1,6 +1,7 @@
 import pytest
-from flask import request
+from httpx import Headers
 
-def test_array(client):
-    rv = client.get('/metrics/array')
-    assert b'purefa_info{array_name=' in rv.data
+def test_array(app_client, endpoint, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/metrics/array?endpoint=' + endpoint, headers = h)
+    assert 'purefa_info{array_name=' in res.text

tests/functional/test_03_volumes.py

@@ -1,19 +1,17 @@
 import pytest
+from httpx import Headers
 
-def test_volumes(client):
-    rv = client.get("/metrics/volumes")
-    for e in ['purefa_volume_space_datareduction_ratio',
+def test_volumes(app_client, endpoint, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/metrics/volumes?endpoint=' + endpoint, headers = h)
+    for e in ['purefa_volume_space_data_reduction_ratio',
               'purefa_volume_space_size_bytes',
-              'purefa_volume_space_bytes',
-              'shared',
+              'purefa_volume_space_used_bytes',
               'snapshots',
               'snapshots_effective',
-              'system',
-              'thin_provisioning',
               'total_effective',
               'total_physical',
               'total_provisioned',
-              'total_reduction',
               'unique',
               'virtual',
               'purefa_volume_performance_latency_usec',
@@ -28,7 +26,6 @@ def test_volumes(client):
               'san_usec_per_write_op',
               'service_usec_per_mirrored_write_op',
               'service_usec_per_read_op',
-              'service_usec_per_read_op_cache_reduction',
               'service_usec_per_write_op',
               'usec_per_mirrored_write_op',
               'usec_per_read_op',
@@ -43,4 +40,4 @@ def test_volumes(client):
               'bytes_per_write',
               'bytes_per_op',
               'bytes_per_mirrored_write']:
-        assert b"e" in rv.data
+        assert e in res.text

tests/functional/test_04_hosts.py

@@ -1,19 +1,17 @@
 import pytest
+from httpx import Headers
 
+def test_hosts(app_client, endpoint, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/metrics/hosts?endpoint=' + endpoint, headers = h)
 
-def test_hosts(client):
-    rv = client.get("/metrics/hosts")
-    for e in ['purefa_host_space_datareduction_ratio',
+    for e in ['purefa_host_space_data_reduction_ratio',
               'purefa_host_space_size_bytes',
-              'purefa_host_space_bytes'
-              'shared',
+              'purefa_host_space_used_bytes',
               'snapshots',
-              'system',
-              'thin_provisioning',
               'total_physical',
               'total_provisioned',
-              'total_reduction',
-              'unique'
+              'unique',
               'purefa_host_performance_latency_usec',
               'purefa_host_performance_bandwidth_bytes',
               'purefa_host_performance_iops',
@@ -25,7 +23,6 @@ def test_hosts(client):
               'san_usec_per_mirrored_write_op',
               'service_usec_per_mirrored_write_op',
               'service_usec_per_read_op',
-              'service_usec_per_read_op_cache_reduction',
               'service_usec_per_write_op',
               'usec_per_read_op',
               'usec_per_write_op',
@@ -36,4 +33,4 @@ def test_hosts(client):
               'read_bytes_per_sec',
               'write_bytes_per_sec',
               'mirrored_write_bytes_per_sec']:
-        assert b"e" in rv.data
+        assert e in res.text

tests/functional/test_05_pods.py

@@ -1,19 +1,18 @@
 import pytest
+from httpx import Headers
 
+def test_pods(app_client, endpoint, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/metrics/pods?endpoint=' + endpoint, headers = h)
 
-def test_pods(client):
-    rv = client.get("/metrics/pods")
-    for e in ['purefa_pod_space_datareduction_ratio',
+    for e in ['purefa_pod_space_data_reduction_ratio',
               'purefa_pod_space_size_bytes',
-              'purefa_pod_space_bytes',
+              'purefa_pod_space_used_bytes',
               'replication',
               'shared',
               'snapshots',
-              'system',
-              'thin_provisioning',
               'total_physical',
               'total_provisioned',
-              'total_reduction',
               'unique',
               'purefa_pod_performance_latency_usec',
               'purefa_pod_performance_bandwidth_bytes',
@@ -27,7 +26,6 @@ def test_pods(client):
               'san_usec_per_write_op',
               'service_usec_per_mirrored_write_op',
               'service_usec_per_read_op',
-              'service_usec_per_read_op_cache_reduction',
               'service_usec_per_write_op',
               'usec_per_mirrored_write_op',
               'usec_per_read_op',
@@ -36,5 +34,5 @@ def test_pods(client):
               'read_bytes_per_sec',
               'write_bytes_per_sec',
               'mirrored_write_bytes_per_sec']:
-        assert b"e" in rv.data
+        assert e in res.text
 

tests/functional/test_06_directories.py

@@ -1,27 +1,23 @@
 import pytest
+from httpx import Headers
 
-
-def test_directories(client):
-    rv = client.get("/metrics/directories")
-    for e in ['purefa_directory_space_datareduction_ratio',
+def test_directories(app_client, endpoint, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/metrics/directories?endpoint=' + endpoint, headers = h)
+    for e in ['purefa_directory_space_data_reduction_ratio',
               'purefa_directory_space_size_bytes',
-              'purefa_directory_space_bytes',
+              'purefa_directory_space_used_bytes',
               'name',
               'filesystem',
               'path',
               'space',
-              'shared',
               'snapshots',
-              'system',
-              'thin_provisioning',
               'total_physical',
-              'total_provisioned',
-              'total_reduction',
               'unique',
               'purefa_directory_performance_latency_usec',
               'purefa_directory_performance_bandwidth_bytes',
               'purefa_directory_performance_iops',
-              'purefa_directory_performance_avg_block_bytes'
+              'purefa_directory_performance_avg_block_bytes',
               'usec_per_read_op',
               'usec_per_write_op',
               'usec_per_other_op',
@@ -33,5 +29,5 @@ def test_directories(client):
               'bytes_per_op',
               'bytes_per_read',
               'bytes_per_write']:
-        assert b"e" in rv.data
+        assert e in res.text
 

tests/functional/test_07_errors.py

@@ -1,9 +1,10 @@
 import pytest
+from httpx import Headers
 
-
-def test_not_existing_endpoint(client):
-    rv = client.get("/not-existing")
-    assert rv.status_code == 404
+def test_not_existing_endpoint(app_client, api_token):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get('/not-existing', headers = h)
+    assert res.status_code == 404
 
 @pytest.mark.parametrize("test_input,expected",
                          [('/metrics/array/', 404),
@@ -16,31 +17,33 @@ def test_not_existing_endpoint(client):
                           ('/metrics/directories/not-a-dir', 404),
                           ('/metrics/pods/', 404),
                           ('/metrics/pods/not-a-pod', 404)])
-def test_wrong_endpoint(client, test_input, expected):
-    rv = client.get(test_input)
-    assert rv.status_code == expected
+def test_wrong_endpoint(app_client, api_token, test_input, expected):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.get(test_input, headers = h)
+    assert res.status_code == expected
 
 @pytest.mark.parametrize("test_input,expected",
                          [('/', 405),
                           ('/metrics/array', 405),
-                          ('/metrics/array/', 404),
+                          ('/metrics/array/', 405),
                           ('/metrics/array/not-an-array', 404),
                           ('/metrics/volumes', 405),
-                          ('/metrics/volumes/', 404),
+                          ('/metrics/volumes/', 405),
                           ('/metrics/volumes/not-a-volume', 404),
                           ('/metrics/hosts', 405),
-                          ('/metrics/hosts/', 404),
+                          ('/metrics/hosts/', 405),
                           ('/metrics/hosts/not-a-host', 404),
                           ('/metrics/directories', 405),
-                          ('/metrics/directories/', 404),
+                          ('/metrics/directories/', 405),
                           ('/metrics/directories/not-a-dir', 404),
                           ('/metrics/pods', 405),
-                          ('/metrics/pods/', 404),
+                          ('/metrics/pods/', 405),
                           ('/metrics/pods/not-a-pod', 404)])
-def test_post_put_del(client, test_input, expected):
-    rv = client.post(test_input)
-    assert rv.status_code == expected
-    rv = client.put(test_input)
-    assert rv.status_code == expected
-    rv = client.delete(test_input)
-    assert rv.status_code == expected
+def test_post_put_del(app_client, api_token, test_input, expected):
+    h = Headers({'Authorization': "Bearer " + api_token})
+    _, res = app_client.post(test_input, headers = h)
+    assert res.status_code == expected
+    _, res = app_client.put(test_input)
+    assert res.status_code == expected
+    _, res = app_client.delete(test_input)
+    assert res.status_code == expected