Compare commits

...

1 Commits

Author SHA1 Message Date
swapnil-signoz
346e6cee67 test(fileauditor): cover the audit file write path end to end 2026-11-16 18:30:11 +05:30
6 changed files with 284 additions and 0 deletions

View File

@@ -45,6 +45,7 @@ jobs:
- callbackauthn
- cloudintegrations
- dashboard
- fileauditor
- ingestionkeys
- inframonitoring
- llmpricingrules

51
tests/fixtures/fileauditor.py vendored Normal file
View File

@@ -0,0 +1,51 @@
import json
import time
import docker
from fixtures import types
AUDIT_FILE_PATH = "/tmp/audit.log"
def list_audit_events(signoz: types.SigNoz) -> list[dict]:
"""Each line of the audit file is one OTLP JSON batch of events; this flattens all batches into events."""
exit_code, output = docker.from_env().containers.get(signoz.self.id).exec_run(["cat", AUDIT_FILE_PATH])
assert exit_code == 0, output.decode()
events = []
for line in output.decode().splitlines():
for resource_logs in json.loads(line)["resourceLogs"]:
resource = _attributes(resource_logs["resource"]["attributes"])
for scope_logs in resource_logs["scopeLogs"]:
for log_record in scope_logs["logRecords"]:
events.append(
{
"event_name": log_record["eventName"],
"severity_text": log_record["severityText"],
"body": log_record["body"]["stringValue"],
"scope_name": scope_logs["scope"]["name"],
"resource": resource,
"attributes": _attributes(log_record["attributes"]),
}
)
return events
def wait_for_audit_event(signoz: types.SigNoz, event_name: str, resource_id: str, target_id: str | None = None, wait_seconds: int = 10) -> dict:
deadline = time.time() + wait_seconds
events = []
while time.time() < deadline:
events = list_audit_events(signoz)
matched = [event for event in events if event["event_name"] == event_name and event["resource"].get("signoz.resource.id") == resource_id and (target_id is None or event["attributes"].get("signoz.resource.target.id") == target_id)]
if len(matched) > 0:
return matched[0]
time.sleep(0.5)
raise AssertionError(f"No {event_name} audit event for resource {resource_id} (target {target_id}) within {wait_seconds}s, events: {events}")
def _attributes(otlp_attributes: list[dict]) -> dict:
# OTLP JSON encodes int64 values as decimal strings.
return {attribute["key"]: int(attribute["value"]["intValue"]) if "intValue" in attribute["value"] else attribute["value"]["stringValue"] for attribute in otlp_attributes}

View File

@@ -0,0 +1,151 @@
import uuid
from collections.abc import Callable
from http import HTTPStatus
import requests
from fixtures import types
from fixtures.auth import USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD, find_user_by_email
from fixtures.fileauditor import wait_for_audit_event
from fixtures.savedview import SAVED_VIEW_BASE, create_saved_view
from fixtures.serviceaccount import SERVICE_ACCOUNT_BASE, create_service_account, create_service_account_with_key, delete_service_account, get_first_key_id
def test_create_saved_view_writes_create_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
admin = find_user_by_email(signoz, token, USER_ADMIN_EMAIL)
view_id = create_saved_view(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
event = wait_for_audit_event(signoz, "signoz.audit.create", view_id)
assert event["severity_text"] == "INFO"
assert event["scope_name"] == "signoz.audit"
assert event["resource"]["service.name"] == "signoz"
assert event["resource"]["signoz.resource.kind"] == "saved-view"
assert event["attributes"]["signoz.audit.verb"] == "create"
assert event["attributes"]["signoz.audit.outcome"] == "success"
assert event["attributes"]["signoz.principal.id"] == admin["id"]
assert event["attributes"]["signoz.principal.email"] == USER_ADMIN_EMAIL
assert event["attributes"]["signoz.organization.id"] == admin["orgId"]
assert event["attributes"]["http.request.method"] == "POST"
assert event["attributes"]["http.route"] == "/api/v2/saved_views"
assert event["attributes"]["http.response.status_code"] == HTTPStatus.CREATED
def test_update_service_account_writes_update_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
service_account_id = create_service_account(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
response = requests.put(
signoz.self.host_configs["8080"].get(f"{SERVICE_ACCOUNT_BASE}/{service_account_id}"),
json={"name": f"fileauditor-{uuid.uuid4().hex[:8]}"},
headers={"Authorization": f"Bearer {token}"},
timeout=5,
)
assert response.status_code == HTTPStatus.NO_CONTENT, response.text
event = wait_for_audit_event(signoz, "signoz.audit.update", service_account_id)
assert event["resource"]["signoz.resource.kind"] == "serviceaccount"
assert event["attributes"]["signoz.audit.verb"] == "update"
assert event["attributes"]["signoz.audit.outcome"] == "success"
assert event["attributes"]["http.route"] == "/api/v1/service_accounts/{id}"
assert event["attributes"]["http.response.status_code"] == HTTPStatus.NO_CONTENT
def test_delete_service_account_writes_delete_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
service_account_id = create_service_account(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
delete_service_account(signoz, token, service_account_id)
event = wait_for_audit_event(signoz, "signoz.audit.delete", service_account_id)
assert event["resource"]["signoz.resource.kind"] == "serviceaccount"
assert event["attributes"]["signoz.audit.verb"] == "delete"
assert event["attributes"]["signoz.audit.outcome"] == "success"
assert event["attributes"]["http.route"] == "/api/v1/service_accounts/{id}"
assert event["attributes"]["http.response.status_code"] == HTTPStatus.NO_CONTENT
def test_create_service_account_key_writes_attach_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
service_account_id = create_service_account(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
response = requests.post(
signoz.self.host_configs["8080"].get(f"{SERVICE_ACCOUNT_BASE}/{service_account_id}/keys"),
json={"name": "fileauditor", "expiresAt": 0},
headers={"Authorization": f"Bearer {token}"},
timeout=5,
)
assert response.status_code == HTTPStatus.CREATED, response.text
key_id = response.json()["data"]["id"]
event = wait_for_audit_event(signoz, "signoz.audit.attach", service_account_id, target_id=key_id)
assert event["resource"]["signoz.resource.kind"] == "serviceaccount"
assert event["attributes"]["signoz.resource.target.kind"] == "factor-api-key"
assert event["attributes"]["signoz.audit.verb"] == "attach"
assert event["attributes"]["signoz.audit.outcome"] == "success"
assert event["attributes"]["http.route"] == "/api/v1/service_accounts/{id}/keys"
assert event["attributes"]["http.response.status_code"] == HTTPStatus.CREATED
def test_revoke_service_account_key_writes_detach_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
service_account_id, _ = create_service_account_with_key(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
key_id = get_first_key_id(signoz, token, service_account_id)
response = requests.delete(
signoz.self.host_configs["8080"].get(f"{SERVICE_ACCOUNT_BASE}/{service_account_id}/keys/{key_id}"),
headers={"Authorization": f"Bearer {token}"},
timeout=5,
)
assert response.status_code == HTTPStatus.NO_CONTENT, response.text
event = wait_for_audit_event(signoz, "signoz.audit.detach", service_account_id, target_id=key_id)
assert event["resource"]["signoz.resource.kind"] == "serviceaccount"
assert event["attributes"]["signoz.resource.target.kind"] == "factor-api-key"
assert event["attributes"]["signoz.audit.verb"] == "detach"
assert event["attributes"]["signoz.audit.outcome"] == "success"
assert event["attributes"]["http.route"] == "/api/v1/service_accounts/{id}/keys/{fid}"
assert event["attributes"]["http.response.status_code"] == HTTPStatus.NO_CONTENT
def test_delete_missing_saved_view_writes_failure_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
missing_view_id = str(uuid.uuid4())
response = requests.delete(
signoz.self.host_configs["8080"].get(f"{SAVED_VIEW_BASE}/{missing_view_id}"),
headers={"Authorization": f"Bearer {token}"},
timeout=5,
)
assert response.status_code == HTTPStatus.NOT_FOUND, response.text
event = wait_for_audit_event(signoz, "signoz.audit.delete", missing_view_id)
assert event["severity_text"] == "ERROR"
assert event["attributes"]["signoz.audit.outcome"] == "failure"
assert event["attributes"]["exception.type"] == "not-found"
assert event["attributes"]["http.response.status_code"] == HTTPStatus.NOT_FOUND

View File

@@ -0,0 +1,49 @@
import uuid
from collections.abc import Callable
from sqlalchemy import sql
from fixtures import types
from fixtures.auth import USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD
from fixtures.fileauditor import list_audit_events, wait_for_audit_event
from fixtures.savedview import create_saved_view
def test_unlicensed_create_writes_no_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
with signoz.sqlstore.conn.begin() as conn:
licenses = conn.execute(sql.text("SELECT id, created_at, updated_at, key, data, last_validated_at, org_id FROM license")).mappings().all()
assert len(licenses) > 0
conn.execute(sql.text("DELETE FROM license"))
try:
unlicensed_view_id = create_saved_view(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
finally:
with signoz.sqlstore.conn.begin() as conn:
conn.execute(
sql.text("INSERT INTO license (id, created_at, updated_at, key, data, last_validated_at, org_id) VALUES (:id, :created_at, :updated_at, :key, :data, :last_validated_at, :org_id)"),
[dict(row) for row in licenses],
)
marker_view_id = create_saved_view(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
wait_for_audit_event(signoz, "signoz.audit.create", marker_view_id)
assert all(event["resource"].get("signoz.resource.id") != unlicensed_view_id for event in list_audit_events(signoz))
def test_login_writes_no_event(
signoz: types.SigNoz,
apply_license: types.Operation, # pylint: disable=unused-argument
get_token: Callable[[str, str], str],
) -> None:
token = get_token(USER_ADMIN_EMAIL, USER_ADMIN_PASSWORD)
marker_view_id = create_saved_view(signoz, token, f"fileauditor-{uuid.uuid4().hex[:8]}")
wait_for_audit_event(signoz, "signoz.audit.create", marker_view_id)
assert all(event["attributes"].get("http.route") != "/api/v2/sessions/email_password" for event in list_audit_events(signoz))

View File

@@ -0,0 +1,32 @@
import pytest
from testcontainers.core.container import Network
from fixtures import types
from fixtures.fileauditor import AUDIT_FILE_PATH
from fixtures.signoz import create_signoz
@pytest.fixture(name="signoz", scope="package")
def signoz_fileauditor(
network: Network,
zeus: types.TestContainerDocker,
gateway: types.TestContainerDocker,
sqlstore: types.TestContainerSQL,
clickhouse: types.TestContainerClickhouse,
request: pytest.FixtureRequest,
pytestconfig: pytest.Config,
) -> types.SigNoz:
return create_signoz(
network=network,
zeus=zeus,
gateway=gateway,
sqlstore=sqlstore,
clickhouse=clickhouse,
request=request,
pytestconfig=pytestconfig,
cache_key="signoz-fileauditor",
env_overrides={
"SIGNOZ_AUDITOR_PROVIDER": "file",
"SIGNOZ_AUDITOR_FILE_PATH": AUDIT_FILE_PATH,
},
)