Add comprehensive unit tests for Akamai metrics functionality #941

AbdullahKaratas · 2025-06-11T14:33:03Z

Testing Instructions

Quick Test

# Copy test files from local-test-environment branch (if needed)
git checkout local-test-environment -- docker-compose.yml config/ init-db.sql init-test-data.sh test.sh clean-setup.sh

# Run complete test suite
./test.sh

local-test-environment

Expected Results

The test verifies:

✅ Database setup with real Akamai datacenter IDs
✅ andromeda-server startup and RPC communication
✅ andromeda-akamai-reports metrics collection
✅ Prometheus metrics export on :9091/metrics

Sample Metrics Output

andromeda_akamai_requests_5m{datacenter_id="...",domain="...",project_id="..."} 6706
andromeda_akamai_status_5m{datacenter_id="...",domain="...",project_id="..."} 1

See test.sh for detailed step-by-step testing process

…lnerability, implement domain ownership validation, add project scope enforcement, change API parameter from property-name to domain-id

- Add unit tests for AkamaiMetricsController covering cache operations, initialization, data mapping, and error handling - Add unit tests for RPCHandlerAkamai covering sync operations, time calculations, datacenter aggregation, and edge cases - Tests verify business logic including percentage calculations, IP extraction, and data transformation - All tests are self-contained with no external dependencies and pass consistently

…ison Addresses staticcheck QF1003 warning by replacing if-else chain with more idiomatic switch statement for string comparison.

- Remove prometheus.NewMetricWithTimestamp() to avoid data gaps - Export only most recent values as current metrics - Add andromeda_akamai_last_update_timestamp metric for data freshness - Add comprehensive unit tests for historical data handling This fixes the issue where Prometheus would skip data points and create gaps due to historical timestamps in the exporter.

This fixes the controller test failures where CommonController.agent was nil during test execution, causing nil pointer dereferences. The agent is only used in production, so skipping sync in tests is safe.

ronchi-oss

I don't remember anymore if the patch to collector.go is how Andy wanted to fix the Prometheus "warnings". Otherwise, the unit testing in place is not adding value as it mostly is not testing real code (they tests the test code itself). I advise against fixing these tests; it'll be easier to take them out of the PR and make sure the patch to collector.go works and is what we need.

internal/controller/akamai_metrics_test.go

internal/driver/akamai/rpc_handler_test.go

internal/driver/akamai/metrics/collector.go

internal/driver/akamai/metrics/collector_test.go

- Remove fake unit tests that were testing test code instead of real code - Keep functional RPC handler test that tests actual behavior - Timestamp fix in collector.go remains (main implementation)

- Use configured domain_type from akamai.yaml instead of auto-detection only - Handle permission errors gracefully when domain already exists - Enables successful RPC agent startup and communication These fixes resolve the core RPC communication problems that were blocking metrics collection. The agent now starts successfully and can respond to RPC calls from the API server.

Add safety check in collector.go to handle cases where Akamai API returns dataRows with no datacenters, preventing index out of bounds panic on dataRow.Datacenters[0]. Logs warning and continues processing.

…-metrics

Resolved conflicts by: - Removing HTTP metrics API that was deleted upstream (akamai_metrics.go, swagger endpoints) - Keeping working RPC handler functionality for andromeda-akamai-reports - Adding new upstream RPC functions alongside existing handlers - Updating dependencies to latest versions - Preserving functional unit tests and Prometheus metrics collection The andromeda-akamai-reports service remains fully functional.

- Add missing akamai agent import - Fix CidrBlocksController struct initialization with proper field names - Ensure compatibility with upstream changes while maintaining functionality

REUSE.toml

internal/controller/cidr_blocks.go

internal/controller/controller.go

internal/driver/akamai/agent.go

internal/driver/akamai/rpc_handler.go

The restapi/** pattern was listed twice in the annotations path array. This removes the duplicate entry on line 21, keeping only the one on line 16.

The CidrBlocksController is initialized inline in controller.go, making this constructor function redundant.

The package name is already 'akamai', so the alias is unnecessary.

The package name is 'akamai', not 'agent', so the alias is unnecessary.

…lers - Removed global akamaiAgent variable as it was unnecessary - Removed standalone Sync and GetCidrs functions - Removed manual srv.Handle registrations for sync and get_cidrs - The RPC server now uses the methods from RPCHandlerAkamai directly through the registered RPC service interfaces

- Removed GetDNSMetricsAkamai from rpc_agent_akamai.proto - Removed implementation from rpc_handler.go - Regenerated protobuf files to reflect the changes - This RPC method was not being used anywhere in the codebase

- Removed unused imports from agent.go (net/http) - Removed unused imports from rpc_handler.go (encoding/json, fmt, net/url, strings, time) - These imports were only used by the removed GetDNSMetricsAkamai function

These files were not meant to be pushed to the repository: - clean-setup.sh - config/akamai.yaml - config/andromeda.yaml - docker-compose.yml - init-db.sql - init-test-data.sh - test.sh

AbdullahKaratas · 2025-07-20T22:06:55Z

I did the manual test, these are some real example outputs when we call the /metrics endpoint:

Akamai request count (5-minute window)

andromeda_akamai_requests_5m{datacenter_id="a10d9971-4a8a-11f0-a028-26af4eb7f05b",domain="perf-canary.ccee.sapcloud.io",project_id="test-project-00
2",target_ip="130.214.48.13"} 11629

Akamai status (0, 1)

andromeda_akamai_status_5m{datacenter_id="c6176476-1509-11f0-bc67-3eda432567b3",domain="eu01.hana.ondemand.com",project_id="test-project-003",targe
t_ip="130.214.199.139"} 1

Last update timestamp

andromeda_akamai_last_update_timestamp{datacenter_id="26817744-4b6e-11f0-a028-26af4eb7f05b",domain="zz02-test.hanavlab.ondemand.com",project_id="te
st-project-001",target_ip="130.214.252.210"} 1.7529363e+09

internal/driver/akamai/domain.go

internal/driver/akamai/metrics/collector.go

- Fix EnsureDomain permission error handling to return error instead of assuming domain exists - Refactor metrics collector loops to eliminate conditional checks and improve readability

ronchi-oss · 2025-08-01T11:08:18Z

I'll give an approval stamp now, though there are go.mod and go.sum conflicts that need fixing.

abdullah-karatas and others added 11 commits May 26, 2025 13:07

fix: Security fixes for Akamai DNS metrics API - Fix URL injection vu…

7c3f450

…lnerability, implement domain ownership validation, add project scope enforcement, change API parameter from property-name to domain-id

security: fix domain authorization bypass in Akamai DNS metrics API

ce8bd4f

WIP

7b24fb5

move everything to generated RPC framework

aa9268e

Fix REUSE and go mod tidy

5ecae81

Added missing parameter

a7ba1d5

fix: use switch statement instead of if-else for datacenter ID compar…

d840ef1

…ison Addresses staticcheck QF1003 warning by replacing if-else chain with more idiomatic switch statement for string comparison.

fix: remove unused extractMetricName function to satisfy linter

866f917

fix: add nil check for agent in PendingSync to prevent test panics

52a4935

This fixes the controller test failures where CommonController.agent was nil during test execution, causing nil pointer dereferences. The agent is only used in production, so skipping sync in tests is safe.

ronchi-oss requested changes Jul 10, 2025

View reviewed changes

abdullah-karatas added 3 commits July 14, 2025 00:49

refactor: remove non-functional unit tests per team feedback

a62fe12

- Remove fake unit tests that were testing test code instead of real code - Keep functional RPC handler test that tests actual behavior - Timestamp fix in collector.go remains (main implementation)

fix: prevent panic when Akamai dataRow has empty datacenters array

ea94163

Add safety check in collector.go to handle cases where Akamai API returns dataRows with no datacenters, preventing index out of bounds panic on dataRow.Datacenters[0]. Logs warning and continues processing.

AbdullahKaratas changed the base branch from review-akamai-metrics-security-fixes to main July 16, 2025 22:54

AbdullahKaratas requested review from a team and notandy as code owners July 16, 2025 22:54

abdullah-karatas added 3 commits July 17, 2025 00:56

Merge remote-tracking branch 'origin/main' into add-unit-tests-akamai…

ec51ca6

…-metrics

fix: correct CidrBlocksController initialization after merge

2315d6b

- Add missing akamai agent import - Fix CidrBlocksController struct initialization with proper field names - Ensure compatibility with upstream changes while maintaining functionality

notandy requested changes Jul 17, 2025

View reviewed changes

abdullah-karatas added 8 commits July 18, 2025 14:00

fix: remove duplicate restapi/** entry in REUSE.toml

f92a9b3

The restapi/** pattern was listed twice in the annotations path array. This removes the duplicate entry on line 21, keeping only the one on line 16.

refactor: remove unused NewCidrBlocksController function

e1b8dcc

The CidrBlocksController is initialized inline in controller.go, making this constructor function redundant.

style: remove redundant akamai import alias

bbb2121

The package name is already 'akamai', so the alias is unnecessary.

style: remove redundant akamaiAgent import alias

c0351c4

The package name is 'akamai', not 'agent', so the alias is unnecessary.

refactor: remove unused GetDNSMetricsAkamai RPC method

028c5a5

- Removed GetDNSMetricsAkamai from rpc_agent_akamai.proto - Removed implementation from rpc_handler.go - Regenerated protobuf files to reflect the changes - This RPC method was not being used anywhere in the codebase

fix: remove unused imports after GetDNSMetricsAkamai removal

f72ecfc

- Removed unused imports from agent.go (net/http) - Removed unused imports from rpc_handler.go (encoding/json, fmt, net/url, strings, time) - These imports were only used by the removed GetDNSMetricsAkamai function

chore: remove accidentally committed test files

48edb0e

These files were not meant to be pushed to the repository: - clean-setup.sh - config/akamai.yaml - config/andromeda.yaml - docker-compose.yml - init-db.sql - init-test-data.sh - test.sh

ronchi-oss requested changes Jul 29, 2025

View reviewed changes

internal/driver/akamai/domain.go Outdated Show resolved Hide resolved

internal/driver/akamai/metrics/collector.go Outdated Show resolved Hide resolved

fix: address code review feedback in akamai driver

8b2ccb3

- Fix EnsureDomain permission error handling to return error instead of assuming domain exists - Refactor metrics collector loops to eliminate conditional checks and improve readability

ronchi-oss previously approved these changes Aug 1, 2025

View reviewed changes

Merge branch 'main' into add-unit-tests-akamai-metrics

2eff6ac

AbdullahKaratas dismissed ronchi-oss’s stale review via 2eff6ac August 6, 2025 12:54

ronchi-oss approved these changes Aug 6, 2025

View reviewed changes

AbdullahKaratas requested a review from notandy August 26, 2025 15:36

Add comprehensive unit tests for Akamai metrics functionality #941

Are you sure you want to change the base?

Add comprehensive unit tests for Akamai metrics functionality #941

Uh oh!

Conversation

AbdullahKaratas commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing Instructions

Quick Test

Uh oh!

ronchi-oss left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AbdullahKaratas commented Jul 20, 2025

Akamai request count (5-minute window)

Akamai status (0, 1)

Last update timestamp

Uh oh!

Uh oh!

Uh oh!

ronchi-oss commented Aug 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AbdullahKaratas commented Jun 11, 2025 •

edited

Loading