Merge branch 'lav_prometheus' into 'main'

 Lav prometheus

See merge request !41

.gitlab-ci.yml

@@ -41,9 +41,11 @@ run-test-job:
     - source "$CI_PROJECT_DIR/plugins/venv/bin/activate"
     - pip install -r "$CI_PROJECT_DIR/plugins/netbox-rps-plugin/tests/requirements.e2e.txt"
     - pip install -r "$CI_PROJECT_DIR/plugins/netbox-cert-plugin/tests/requirements.e2e.txt"
+    - pip install -r "$CI_PROJECT_DIR/tests/requirements.e2e.txt"
   script:
     - env HOST="$HOST" PORT="$PORT" API_KEY="$API_KEY" python3 -m unittest discover -b "$CI_PROJECT_DIR/plugins/netbox-rps-plugin/tests/"
     - env HOST="$HOST" PORT="$PORT" API_KEY="$API_KEY" python3 -m unittest discover -b "$CI_PROJECT_DIR/plugins/netbox-cert-plugin/tests/"
+    - env HOST="$HOST" PORT="$PORT" API_KEY="$API_KEY" python3 -m unittest discover -b "$CI_PROJECT_DIR/tests/e2e/"
   after_script:
     - env ANSIBLE_HOST_KEY_CHECKING=false ANSIBLE_PRIVATE_KEY_FILE="$ANSIBLE_PRIVATE_KEY_FILE" ansible-playbook -i "$TESTING_HOSTS" -u debian ansible/halt_test.yml
     - deactivate

ansible/deploy_on_test.yml

@@ -33,6 +33,12 @@
         state: present
         pull: true
 
-    - name: Pause for 10 seconds
-      ansible.builtin.pause:
-        seconds: 60
+    - name: Wait until the metrics are available
+      ansible.builtin.uri:
+        url: "http://{{ lookup('ansible.builtin.env', 'HOST') }}:8080/metrics"
+        status_code: 200
+      register: curl_output
+      until: curl_output.status  == 200
+      retries: 60
+      delay: 5
+      delegate_to: localhost

env/netbox.env

@@ -17,7 +17,7 @@ EMAIL_USE_TLS=false
 GRAPHQL_ENABLED=true
 HOUSEKEEPING_INTERVAL=86400
 MEDIA_ROOT=/opt/netbox/netbox/media
-METRICS_ENABLED=false
+METRICS_ENABLED=true
 REDIS_CACHE_DATABASE=1
 REDIS_CACHE_HOST=redis-cache
 REDIS_CACHE_INSECURE_SKIP_TLS_VERIFY=false

tests/README.md

+# Testing the plugin
+
+## End to end
+
+Prepare a python environment to execute the E2E tests suite
+
+```shell
+python3 -m venv venv
+source venv/bin/activate
+pip install -r tests/requirements.e2e.txt
+python -m unittest discover tests/e2e
+```

tests/e2e/netbox/test_metrics.py

+"""Test case for Netbox Metrics"""
+
+import unittest
+import os
+import requests
+
+
+HOST = os.getenv("HOST", default="localhost")
+PORT = os.getenv("PORT", default="8080")
+
+
+class TestNetboxMetrics(unittest.TestCase):
+    """Test case for Netbox Metrics"""
+
+    def test_that_netbox_metrics_is_activated(self) -> None:
+        """Test that Netbox Metrics is activated"""
+
+        response = requests.get(
+            url=f"http://{HOST}:{PORT}/metrics",
+            timeout=5,
+        )
+
+        self.assertEqual(response.status_code, 200)
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/requirements.e2e.txt

+requests==2.30.0