test(*): Add test for metrics

crowdsecurity · Jan 3, 2025 · 62727ce · 62727ce
1 parent fe617fb
commit 62727ce
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 2 deletions.
diff --git a/src/LapiRemediation.php b/src/LapiRemediation.php
@@ -245,6 +245,7 @@ public function pushUsageMetrics(
                 // We update the count of each origin/remediation, one by one
                 // because we want to handle the case where an origin/remediation/count has been updated
                 // between the time we get the count and the time we update it
+                // $delta is negative, so we decrement the count
                 $this->updateMetricsOriginsCount($origin, $remediation, $delta);
             }
         }
@@ -299,14 +300,14 @@ private function buildMetricsItems(array $originsCount): array
                 if ($count <= 0) {
                     continue;
                 }
-                // Count all processed metrics, even clean ones
+                // Count all processed metrics, even bypass ones
                 $processed += $count;
                 // Prepare data to update origins count item after processing
                 $originsToUpdate[$origin][$remediation] = -$count;
                 if (Constants::REMEDIATION_BYPASS === $remediation) {
                     continue;
                 }
-                // Create "dropped" metrics
+                // Create "dropped" metrics (all that is not a bypass)
                 $metricsItems[] = [
                     'name' => 'dropped',
                     'value' => $count,

diff --git a/tests/Unit/LapiRemediationTest.php b/tests/Unit/LapiRemediationTest.php
@@ -774,7 +774,43 @@ public function testPushUsageMetricsInLiveMode($cacheType)
 
         $result = $remediation->pushUsageMetrics('test-remediation-php-unit', 'v0.0.0', 'crowdsec-php-bouncer-unit-test');
         $this->assertArrayHasKey('remediation_components', $result, 'Should return a remediation_components key');
+        $items = $result['remediation_components'][0]['metrics'][0]['items'];
 
+        $this->assertEquals(
+            $items[0],
+            [
+                'name' => 'dropped',
+                'value' => 1,
+                'unit' => 'request',
+                'labels' => [
+                    'origin' => 'CAPI',
+                    'remediation' => 'ban',
+                ],
+            ],
+            'Should have CAPI/ban metrics'. json_encode($items[0])
+        );
+        $this->assertEquals(
+            $items[1],
+            [
+                'name' => 'dropped',
+                'value' => 1,
+                'unit' => 'request',
+                'labels' => [
+                    'origin' => 'lists:tor',
+                    'remediation' => 'captcha',
+                ],
+            ],
+            'Should have lists:tor/captcha metrics'. json_encode($items[1])
+        );
+        $this->assertEquals(
+            $items[2],
+            [
+                'name' => 'processed',
+                'value' => 3,
+                'unit' => 'request',
+            ],
+            'Should have processed metrics'. json_encode($items[2])
+        );
         $firstPushTime = time();
         $item = $this->cacheStorage->getItem(AbstractCache::CONFIG);
         $configItem = $item->get();