Add optional HTTP auth, tests.

conftest.py

@@ -116,6 +116,34 @@ def exporter_instance(exporter_cfg_defaults, find_free_port):
     yield exporter
 
 
+@pytest.fixture()
+def exporter_instance_auth(find_free_port, celery_config, log_level):
+    cfg = {
+        "host": "0.0.0.0",
+        "port": find_free_port(),
+        "broker_url": celery_config["broker_url"],
+        "broker_transport_option": ["visibility_timeout=7200"],
+        "broker_ssl_option": [],
+        "retry_interval": 5,
+        "log_level": log_level,
+        "accept_content": None,
+        "worker_timeout": 1,
+        "purge_offline_worker_metrics": 10,
+        "initial_queues": ["queue_from_command_line"],
+        "http_username": "angus",
+        "http_password": "secret",
+    }
+    exporter = Exporter(
+        worker_timeout_seconds=cfg["worker_timeout"],
+        purge_offline_worker_metrics_seconds=cfg["purge_offline_worker_metrics"],
+        initial_queues=cfg["initial_queues"],
+        http_username=cfg["http_username"],
+        http_password=cfg["http_password"],
+    )
+    setattr(exporter, "cfg", cfg)
+    yield exporter
+
+
 @pytest.fixture()
 def threaded_exporter(exporter_instance):
     thread = threading.Thread(
@@ -157,6 +185,17 @@ def threaded_exporter_static_labels(exporter_instance_static_labels):
     yield exporter_instance_static_labels
 
 
+@pytest.fixture()
+def threaded_exporter_auth(exporter_instance_auth):
+    thread = threading.Thread(
+        target=exporter_instance_auth.run,
+        args=(exporter_instance_auth.cfg,),
+        daemon=True,
+    )
+    thread.start()
+    yield exporter_instance_auth
+
+
 @pytest.fixture()
 def hostname():
     return socket.gethostname()

pyproject.toml

@@ -64,6 +64,7 @@ pytest-celery = "^0.0.0"
 pylint = "^3.3.1"
 certifi = "^2024.8.30"
 idna = "^3.7"
+flask-httpauth-stubs = "^0.1.6"
 
 [build-system]
 requires = ["poetry-core>=1.0.0a5"]

src/cli.py

@@ -127,6 +127,12 @@ def _eq_sign_separated_argument_to_dict(_ctx, _param, value):
     help="Prefix all metrics with a string. "
     "This option replaces the 'celery_*' part with a custom prefix. ",
 )
+@click.option(
+    "--http-username", default=None, help="Basic auth username for /metrics endpoint."
+)
+@click.option(
+    "--http-password", default=None, help="Basic auth password for /metrics endpoint."
+)
 @click.option(
     "--default-queue-name",
     default="celery",
@@ -157,6 +163,8 @@ def cli(  # pylint: disable=too-many-arguments,too-many-positional-arguments,too
     generic_hostname_task_sent_metric,
     queues,
     metric_prefix,
+    http_username,
+    http_password,
     default_queue_name,
     static_label,
 ):  # pylint: disable=unused-argument
@@ -169,6 +177,8 @@ def cli(  # pylint: disable=too-many-arguments,too-many-positional-arguments,too
         generic_hostname_task_sent_metric,
         queues,
         metric_prefix,
+        http_username,
+        http_password,
         default_queue_name,
         static_label,
     ).run(ctx.params)

src/exporter.py

@@ -29,6 +29,8 @@ def __init__(
         generic_hostname_task_sent_metric=False,
         initial_queues=None,
         metric_prefix="celery_",
+        http_username=None,
+        http_password=None,
         default_queue_name="celery",
         static_label=None,
     ):
@@ -146,6 +148,8 @@ def __init__(
             ["queue_name", *self.static_label_keys],
             registry=self.registry,
         )
+        self.http_username = http_username
+        self.http_password = http_password
 
     def scrape(self):
         if (
@@ -409,6 +413,8 @@ def run(self, click_params):
                 click_params["host"],
                 click_params["port"],
                 self.scrape,
+                self.http_username,
+                self.http_password,
             )
             while True:
                 try:

src/http_server.py

@@ -1,12 +1,14 @@
 from threading import Thread
 
 import kombu.exceptions
-from flask import Blueprint, Flask, current_app, request
+from flask import Blueprint, Flask, current_app, request, abort
+from flask_httpauth import HTTPBasicAuth
 from loguru import logger
 from prometheus_client.exposition import choose_encoder
 from waitress import serve
 
 blueprint = Blueprint("celery_exporter", __name__)
+auth = HTTPBasicAuth()
 
 
 @blueprint.route("/")
@@ -28,6 +30,7 @@ def index():
 
 
 @blueprint.route("/metrics")
+@auth.login_required(optional=False)
 def metrics():
     current_app.config["metrics_puller"]()
     encoder, content_type = choose_encoder(request.headers.get("accept"))
@@ -36,6 +39,7 @@ def metrics():
 
 
 @blueprint.route("/health")
+@auth.login_required(optional=False)
 def health():
     conn = current_app.config["celery_connection"]
     uri = conn.as_uri()
@@ -51,11 +55,29 @@ def health():
     return f"Connected to the broker {conn.as_uri()}"
 
 
-def start_http_server(registry, celery_connection, host, port, metrics_puller):
+# pylint: disable=too-many-positional-arguments,too-many-arguments
+def start_http_server(
+    registry,
+    celery_connection,
+    host,
+    port,
+    metrics_puller,
+    http_username=None,
+    http_password=None,
+):
     app = Flask(__name__)
     app.config["registry"] = registry
     app.config["celery_connection"] = celery_connection
     app.config["metrics_puller"] = metrics_puller
+
+    @auth.verify_password
+    def verify_password(username, password):
+        if not http_username or not http_password:
+            return "anonymous"
+        if http_username == username and http_password == password:
+            return "authenticated"
+        abort(401)
+
     app.register_blueprint(blueprint)
     Thread(
         target=serve,

src/test_http_server.py

@@ -14,6 +14,27 @@ def test_health(threaded_exporter):
     res.raise_for_status()
 
 
+@pytest.mark.celery()
+def test_health_auth_missing(threaded_exporter_auth):
+    time.sleep(1)
+    res = requests.get(
+        f"http://localhost:{threaded_exporter_auth.cfg['port']}/health", timeout=3
+    )
+    assert res.status_code == 401
+
+
+@pytest.mark.celery()
+def test_health_auth_present(threaded_exporter_auth):
+    time.sleep(1)
+    username = threaded_exporter_auth.cfg["http_username"]
+    password = threaded_exporter_auth.cfg["http_password"]
+    res = requests.get(
+        f"http://{username}:{password}@localhost:{threaded_exporter_auth.cfg['port']}/health",
+        timeout=3,
+    )
+    res.raise_for_status()
+
+
 def test_index(threaded_exporter):
     time.sleep(1)
     res = requests.get(f"http://localhost:{threaded_exporter.cfg['port']}", timeout=3)