[llvm] [CI] Add unittesting for metrics collection script (PR #150360)

[Aiden Grossman via llvm-commits]

https://github.com/boomanaiden154 updated https://github.com/llvm/llvm-project/pull/150360

>From d2e5e9b3da39446403af027537fe415f977303a1 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <aidengrossman at google.com>
Date: Thu, 24 Jul 2025 02:06:52 +0000
Subject: [PATCH 1/2] =?UTF-8?q?[=F0=9D=98=80=F0=9D=97=BD=F0=9D=97=BF]=20in?=
 =?UTF-8?q?itial=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Created using spr 1.3.6
---
 .ci/metrics/metrics_test.py | 66 +++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 .ci/metrics/metrics_test.py

diff --git a/.ci/metrics/metrics_test.py b/.ci/metrics/metrics_test.py
new file mode 100644
index 0000000000000..50462f3526f51
--- /dev/null
+++ b/.ci/metrics/metrics_test.py
@@ -0,0 +1,66 @@
+# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+"""Tests for metrics.py"""
+
+from dataclasses import dataclass
+import requests
+import unittest
+import unittest.mock
+
+import metrics
+
+
+class TestMetrics(unittest.TestCase):
+    def test_upload_gauge_metric(self):
+        test_metrics = [metrics.GaugeMetric("gauge_test", 5, 1000)]
+        return_value = requests.Response()
+        return_value.status_code = 204
+        with unittest.mock.patch(
+            "requests.post", return_value=return_value
+        ) as post_mock:
+            metrics.upload_metrics(test_metrics, "test_userid", "test_api_key")
+            self.assertSequenceEqual(post_mock.call_args.args, [metrics.GRAFANA_URL])
+            self.assertEqual(
+                post_mock.call_args.kwargs["data"], "gauge_test value=5 1000"
+            )
+            self.assertEqual(
+                post_mock.call_args.kwargs["auth"], ("test_userid", "test_api_key")
+            )
+
+    def test_upload_job_metric(self):
+        test_metrics = [
+            metrics.JobMetrics("test_job", 5, 10, 1, 1000, 7, "test_workflow")
+        ]
+        return_value = requests.Response()
+        return_value.status_code = 204
+        with unittest.mock.patch(
+            "requests.post", return_value=return_value
+        ) as post_mock:
+            metrics.upload_metrics(test_metrics, "test_userid", "test_aoi_key")
+            self.assertEqual(
+                post_mock.call_args.kwargs["data"],
+                "test_job queue_time=5,run_time=10,status=1 1000",
+            )
+
+    def test_upload_unknown_metric(self):
+        @dataclass
+        class FakeMetric:
+            fake_data: str
+
+        test_metrics = [FakeMetric("test")]
+
+        with self.assertRaises(ValueError):
+            metrics.upload_metrics(test_metrics, "test_userid", "test_api_key")
+
+    def test_bad_response_code(self):
+        test_metrics = [metrics.GaugeMetric("gauge_test", 5, 1000)]
+        return_value = requests.Response()
+        return_value.status_code = 403
+        # Just assert that we continue running here and do not raise anything.
+        with unittest.mock.patch("requests.post", return_value=return_value) as _:
+            metrics.upload_metrics(test_metrics, "test_userid", "test_api_key")
+
+
+if __name__ == "__main__":
+    unittest.main()

>From f752783ce70e56ba43926c1f45fa040760cc1e5a Mon Sep 17 00:00:00 2001
From: Aiden Grossman <aidengrossman at google.com>
Date: Thu, 24 Jul 2025 18:23:10 +0000
Subject: [PATCH 2/2] feedback

Created using spr 1.3.6
---
 .ci/metrics/metrics_test.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/.ci/metrics/metrics_test.py b/.ci/metrics/metrics_test.py
index 50462f3526f51..259e55f817939 100644
--- a/.ci/metrics/metrics_test.py
+++ b/.ci/metrics/metrics_test.py
@@ -13,6 +13,11 @@
 
 class TestMetrics(unittest.TestCase):
     def test_upload_gauge_metric(self):
+        """Test that we can upload a gauge metric correctly.
+
+        Also verify that we pass around parameters like API keys and user IDs
+        correctly to the HTTP POST request.
+        """
         test_metrics = [metrics.GaugeMetric("gauge_test", 5, 1000)]
         return_value = requests.Response()
         return_value.status_code = 204
@@ -29,6 +34,7 @@ def test_upload_gauge_metric(self):
             )
 
     def test_upload_job_metric(self):
+        """Test that we can upload a job metric correctly."""
         test_metrics = [
             metrics.JobMetrics("test_job", 5, 10, 1, 1000, 7, "test_workflow")
         ]
@@ -44,6 +50,8 @@ def test_upload_job_metric(self):
             )
 
     def test_upload_unknown_metric(self):
+        """Test we report an error if we encounter an unknown metric type."""
+
         @dataclass
         class FakeMetric:
             fake_data: str
@@ -54,6 +62,7 @@ class FakeMetric:
             metrics.upload_metrics(test_metrics, "test_userid", "test_api_key")
 
     def test_bad_response_code(self):
+        """Test that we gracefully handle HTTP response errors."""
         test_metrics = [metrics.GaugeMetric("gauge_test", 5, 1000)]
         return_value = requests.Response()
         return_value.status_code = 403