Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Promote from BLAIS5-4521 to main #157

Merged
merged 4 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions lib/filters/generic_not_found_filter.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import logging
from lib.log_processor import ProcessedLogEntry


def generic_not_found_filter(log_entry: ProcessedLogEntry) -> bool:

if not isinstance(log_entry.severity, str):
return False

if not isinstance(log_entry.message, str):
return False

if log_entry.severity != "ERROR":
return False

if (
'generic::not_found: Failed to fetch "latest' not in log_entry.message
and 'generic::not_found: Failed to fetch "version_' not in log_entry.message
):
return False

logging.info(f"Skipping generic not found alert")
return True
2 changes: 2 additions & 0 deletions lib/send_alerts.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
from lib.filters.execute_sql_filter import execute_sql_filter
from lib.filters.paramiko_filter import paramiko_filter
from lib.filters.bootstrapper_filter import bootstrapper_filter
from lib.filters.generic_not_found_filter import generic_not_found_filter


def log_entry_skipped(log_entry: ProcessedLogEntry):
Expand All @@ -50,6 +51,7 @@ def log_entry_skipped(log_entry: ProcessedLogEntry):
execute_sql_filter,
paramiko_filter,
bootstrapper_filter,
generic_not_found_filter,
]

for filter in filters:
Expand Down
154 changes: 154 additions & 0 deletions tests/lib/filters/test_generic_not_found_filter.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
import pytest
import datetime
import dataclasses

from lib.log_processor import ProcessedLogEntry
from lib.filters.generic_not_found_filter import generic_not_found_filter


@pytest.fixture()
def processed_log_entry_generic_not_found_error_latest() -> ProcessedLogEntry:
return ProcessedLogEntry(
message='alert: ERROR: [AuditLog] generic::not_found: Failed to fetch "latest"',
data=dict(description="dummy"),
severity="ERROR",
platform="cloud_run_revision",
application="slack-alerts",
log_name="/logs/cloudfunctions",
timestamp=datetime.datetime(2024, 5, 20, 10, 23, 56, 32425),
log_query={
"resource.type": "cloud_run_revision",
"resource.labels.instance_id": "00f46b928521d49fcdbf455e4592829a1631850562c1b37283d70572deaca72b851130f7fbca367bbb5a75b386efa9832f3d974f1a5a463b2fb9af0fb2a9c2fb4e57",
},
)


@pytest.fixture()
def processed_log_entry_generic_not_found_error_version() -> ProcessedLogEntry:
return ProcessedLogEntry(
message='alert: ERROR: [AuditLog] generic::not_found: Failed to fetch "version_255"',
data=dict(description="dummy"),
severity="ERROR",
platform="cloud_run_revision",
application="slack-alerts",
log_name="/logs/cloudfunctions",
timestamp=datetime.datetime(2024, 5, 20, 10, 23, 56, 32425),
log_query={
"resource.type": "cloud_run_revision",
"resource.labels.instance_id": "00f46b928521d49fcdbf455e4592829a1631850562c1b37283d70572df455e4592829a1631850562c1b3725a75b386efa9832f3d974f1a5a463b2fb9af0fb2a9b4e57",
},
)


def test_log_is_not_skipped_when_its_first_run_generic_not_found_error_latest(
processed_log_entry_generic_not_found_error_latest: ProcessedLogEntry,
):
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_latest
)
assert log_is_skipped is True


def test_log_is_not_skipped_when_its_first_run_generic_not_found_error_version(
processed_log_entry_generic_not_found_error_version: ProcessedLogEntry,
):
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_version
)
assert log_is_skipped is True


def test_log_is_skipped_when_its_from_cloud_run_revision_when_generic_not_found_error_latest(
processed_log_entry_generic_not_found_error_latest: ProcessedLogEntry,
):
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_latest
)
assert log_is_skipped is True


def test_log_is_skipped_when_its_from_cloud_run_revision_when_generic_not_found_error_version(
processed_log_entry_generic_not_found_error_version: ProcessedLogEntry,
):
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_version
)
assert log_is_skipped is True


def test_log_message_is_not_a_string_when_generic_not_found_error_latest(
processed_log_entry_generic_not_found_error_latest: ProcessedLogEntry,
):
processed_log_entry_generic_not_found_error_latest = dataclasses.replace(
processed_log_entry_generic_not_found_error_latest, message=1234
)
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_latest
)

assert log_is_skipped is False


def test_log_message_is_not_a_string_when_generic_not_found_error_version(
processed_log_entry_generic_not_found_error_version: ProcessedLogEntry,
):
processed_log_entry_generic_not_found_error_version = dataclasses.replace(
processed_log_entry_generic_not_found_error_version, message=1234
)
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_version
)

assert log_is_skipped is False


def test_log_message_is_not_skipped_when_it_does_not_contain_generic_not_found_error_latest(
processed_log_entry_generic_not_found_error_latest: ProcessedLogEntry,
):
processed_log_entry_generic_not_found_error_latest = dataclasses.replace(
processed_log_entry_generic_not_found_error_latest, message="foo"
)
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_latest
)

assert log_is_skipped is False


def test_log_message_is_not_skipped_when_it_does_not_contain_generic_not_found_error_version(
processed_log_entry_generic_not_found_error_version: ProcessedLogEntry,
):
processed_log_entry_generic_not_found_error_version = dataclasses.replace(
processed_log_entry_generic_not_found_error_version, message="foo"
)
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_version
)

assert log_is_skipped is False


def test_log_message_is_not_skipped_when_it_contains_severity_info_latest(
processed_log_entry_generic_not_found_error_latest: ProcessedLogEntry,
):
processed_log_entry_generic_not_found_error_latest = dataclasses.replace(
processed_log_entry_generic_not_found_error_latest, severity="INFO"
)
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_latest
)

assert log_is_skipped is False


def test_log_message_is_not_skipped_when_it_contains_severity_info_version(
processed_log_entry_generic_not_found_error_version: ProcessedLogEntry,
):
processed_log_entry_generic_not_found_error_version = dataclasses.replace(
processed_log_entry_generic_not_found_error_version, severity="INFO"
)
log_is_skipped = generic_not_found_filter(
processed_log_entry_generic_not_found_error_version
)

assert log_is_skipped is False
162 changes: 162 additions & 0 deletions tests/test_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -1480,3 +1480,165 @@ def test_skip_bootstrapper_alerts(run_slack_alerter, number_of_http_calls, caplo
logging.INFO,
"Skipping bootstrapper alert",
) in caplog.record_tuples


def test_skip_generic_not_found_alerts_latest(
run_slack_alerter, number_of_http_calls, caplog
):
# arrange
example_log_entry = {
"protoPayload": {
"@type": "type.googleapis.com/google.cloud.audit.AuditLog",
"status": {
"code": 5,
"message": 'generic::not_found: Failed to fetch "latest"',
},
"authenticationInfo": {
"principalEmail": "628324858917@cloudbuild.gserviceaccount.com",
"serviceAccountDelegationInfo": [
{
"firstPartyPrincipal": {
"principalEmail": "cloud-build-argo-foreman@prod.google.com"
}
}
],
"principalSubject": "serviceAccount:628324858917@cloudbuild.gserviceaccount.com",
},
"requestMetadata": {
"callerIp": "34.89.11.189",
"callerSuppliedUserAgent": "go-containerregistry,gzip(gfe)",
"requestAttributes": {},
"destinationAttributes": {},
},
"serviceName": "artifactregistry.googleapis.com",
"methodName": "Docker-HeadManifest",
"authorizationInfo": [
{
"resource": "projects/ons-blaise-v2-prod/locations/europe-west2/repositories/gcf-artifacts",
"permission": "artifactregistry.repositories.downloadArtifacts",
"granted": True,
"resourceAttributes": {},
"permissionType": "DATA_READ",
}
],
"resourceName": "projects/ons-blaise-v2-prod/locations/europe-west2/repositories/gcf-artifacts/dockerImages/ons--blaise--v2--prod__europe--west2__nifi--receipt%2Fcache",
"request": {
"@type": "type.googleapis.com/google.logging.type.HttpRequest",
"requestUrl": "/v2/ons-blaise-v2-prod/gcf-artifacts/ons--blaise--v2--prod__europe--west2__nifi--receipt/cache/manifests/latest",
"requestMethod": "HEAD",
},
"resourceLocation": {
"currentLocations": ["europe-west2"],
"originalLocations": ["europe-west2"],
},
},
"insertId": "1h15w4udgp0q",
"resource": {
"type": "audited_resource",
"labels": {
"project_id": "ons-blaise-v2-prod",
"service": "artifactregistry.googleapis.com",
"method": "Docker-HeadManifest",
},
},
"timestamp": "2024-12-02T12:01:35.011476126Z",
"severity": "ERROR",
"logName": "projects/ons-blaise-v2-prod/logs/cloudaudit.googleapis.com%2Fdata_access",
"receiveTimestamp": "2024-12-02T12:01:35.148295977Z",
}

event = create_event(example_log_entry)

# act
with caplog.at_level(logging.INFO):
response = run_slack_alerter(event)

# assert
assert response == "Alert skipped"
assert number_of_http_calls() == 0
assert (
"root",
logging.INFO,
"Skipping generic not found alert",
) in caplog.record_tuples


def test_skip_generic_not_found_alerts_version(
run_slack_alerter, number_of_http_calls, caplog
):
# arrange
example_log_entry = {
"protoPayload": {
"@type": "type.googleapis.com/google.cloud.audit.AuditLog",
"status": {
"code": 5,
"message": 'generic::not_found: Failed to fetch "version_1"',
},
"authenticationInfo": {
"principalEmail": "628324858917@cloudbuild.gserviceaccount.com",
"serviceAccountDelegationInfo": [
{
"firstPartyPrincipal": {
"principalEmail": "cloud-build-argo-foreman@prod.google.com"
}
}
],
"principalSubject": "serviceAccount:628324858917@cloudbuild.gserviceaccount.com",
},
"requestMetadata": {
"callerIp": "34.89.11.189",
"callerSuppliedUserAgent": "go-containerregistry/v0.19.1,gzip(gfe)",
"requestAttributes": {},
"destinationAttributes": {},
},
"serviceName": "artifactregistry.googleapis.com",
"methodName": "Docker-HeadManifest",
"authorizationInfo": [
{
"resource": "projects/ons-blaise-v2-prod/locations/europe-west2/repositories/gcf-artifacts",
"permission": "artifactregistry.repositories.downloadArtifacts",
"granted": True,
"resourceAttributes": {},
"permissionType": "DATA_READ",
}
],
"resourceName": "projects/ons-blaise-v2-prod/locations/europe-west2/repositories/gcf-artifacts/dockerImages/ons--blaise--v2--prod__europe--west2__nifi--receipt",
"request": {
"requestMethod": "HEAD",
"@type": "type.googleapis.com/google.logging.type.HttpRequest",
"requestUrl": "/v2/ons-blaise-v2-prod/gcf-artifacts/ons--blaise--v2--prod__europe--west2__nifi--receipt/manifests/version_1",
},
"resourceLocation": {
"currentLocations": ["europe-west2"],
"originalLocations": ["europe-west2"],
},
},
"insertId": "1snjiu3dbkh4",
"resource": {
"type": "audited_resource",
"labels": {
"method": "Docker-HeadManifest",
"service": "artifactregistry.googleapis.com",
"project_id": "ons-blaise-v2-prod",
},
},
"timestamp": "2024-12-02T12:01:36.494768789Z",
"severity": "ERROR",
"logName": "projects/ons-blaise-v2-prod/logs/cloudaudit.googleapis.com%2Fdata_access",
"receiveTimestamp": "2024-12-02T12:01:36.786461532Z",
}

event = create_event(example_log_entry)

# act
with caplog.at_level(logging.INFO):
response = run_slack_alerter(event)

# assert
assert response == "Alert skipped"
assert number_of_http_calls() == 0
assert (
"root",
logging.INFO,
"Skipping generic not found alert",
) in caplog.record_tuples