Files
prowler/ui/actions/finding-groups/finding-groups.adapter.test.ts
T
Alan Buscaglia 587187419f feat(ui): add findings triage (#11704)
Co-authored-by: alejandrobailo <alejandrobailo94@gmail.com>
2026-07-01 17:55:33 +02:00

386 lines
11 KiB
TypeScript

import { afterEach, describe, expect, it, vi } from "vitest";
import {
FINDING_TRIAGE_DISABLED_REASON,
FINDING_TRIAGE_STATUS,
} from "@/types/findings-triage";
import {
adaptFindingGroupResourcesResponse,
adaptFindingGroupsResponse,
} from "./finding-groups.adapter";
const expectNoRawTriageTransportKeys = (value: Record<string, unknown>) => {
expect(value).not.toHaveProperty("triage_status");
expect(value).not.toHaveProperty("triage_has_note");
expect(value).not.toHaveProperty("attributes");
expect(value).not.toHaveProperty("relationships");
};
afterEach(() => {
vi.unstubAllEnvs();
});
// ---------------------------------------------------------------------------
// Fix 1: adaptFindingGroupsResponse — unknown + type guard
// ---------------------------------------------------------------------------
describe("adaptFindingGroupsResponse — malformed input", () => {
it("should return [] when apiResponse is null", () => {
// Given
const input = null;
// When
const result = adaptFindingGroupsResponse(input);
// Then
expect(result).toEqual([]);
});
it("should return [] when data is not an array", () => {
// Given
const input = { data: "not-an-array" };
// When
const result = adaptFindingGroupsResponse(input);
// Then
expect(result).toEqual([]);
});
it("should return mapped rows for valid data", () => {
// Given
const input = {
data: [
{
id: "group-1",
type: "finding-groups",
attributes: {
check_id: "s3_bucket_public_access",
check_title: "S3 Bucket Public Access",
check_description: null,
severity: "critical",
status: "FAIL",
muted: true,
impacted_providers: ["aws"],
resources_total: 5,
resources_fail: 3,
pass_count: 2,
fail_count: 3,
manual_count: 1,
pass_muted_count: 0,
fail_muted_count: 3,
manual_muted_count: 0,
muted_count: 0,
new_count: 1,
changed_count: 0,
new_fail_count: 0,
new_fail_muted_count: 1,
new_pass_count: 0,
new_pass_muted_count: 0,
new_manual_count: 0,
new_manual_muted_count: 0,
changed_fail_count: 0,
changed_fail_muted_count: 0,
changed_pass_count: 0,
changed_pass_muted_count: 0,
changed_manual_count: 0,
changed_manual_muted_count: 0,
first_seen_at: null,
last_seen_at: "2024-01-01T00:00:00Z",
failing_since: null,
finding_id: "group-finding-id-1",
finding_uid: "group-finding-uid-1",
triage_status: "risk_accepted",
triage_has_note: true,
},
},
],
};
// When
const result = adaptFindingGroupsResponse(input);
// Then
expect(result).toHaveLength(1);
expect(result[0].checkId).toBe("s3_bucket_public_access");
expect(result[0].checkTitle).toBe("S3 Bucket Public Access");
expect(result[0].muted).toBe(true);
expect(result[0].manualCount).toBe(1);
expect(result[0].newFailMutedCount).toBe(1);
expect(result[0]).not.toHaveProperty("triage");
expectNoRawTriageTransportKeys(
result[0] as unknown as Record<string, unknown>,
);
});
});
// ---------------------------------------------------------------------------
// Fix 1: adaptFindingGroupResourcesResponse — unknown + type guard
// ---------------------------------------------------------------------------
describe("adaptFindingGroupResourcesResponse — malformed input", () => {
it("should return [] when apiResponse is null", () => {
// Given/When
const result = adaptFindingGroupResourcesResponse(null, "check-1");
// Then
expect(result).toEqual([]);
});
it("should return [] when data is not an array", () => {
// Given/When
const result = adaptFindingGroupResourcesResponse({ data: {} }, "check-1");
// Then
expect(result).toEqual([]);
});
it("should keep resource rows with valid attributes even when JSON:API type differs", () => {
// Given
const input = {
data: [
{
id: "resource-row-1",
type: "findings",
attributes: {
finding_id: "real-finding-uuid",
finding_uid: "prowler-finding-uid-1",
triage_status: "remediating",
triage_notes_count: 1,
resource: {
uid: "arn:aws:s3:::my-bucket",
name: "my-bucket",
service: "s3",
region: "us-east-1",
type: "Bucket",
resource_group: "default",
},
provider: {
type: "aws",
uid: "123456789",
alias: "production",
},
status: "FAIL",
severity: "high",
first_seen_at: null,
last_seen_at: "2024-01-01T00:00:00Z",
},
},
],
};
// When
const result = adaptFindingGroupResourcesResponse(input, "check-1");
// Then
expect(result).toHaveLength(1);
expect(result[0]).toEqual(
expect.objectContaining({
findingId: "real-finding-uuid",
resourceName: "my-bucket",
triage: expect.objectContaining({
status: FINDING_TRIAGE_STATUS.REMEDIATING,
hasVisibleNote: true,
}),
}),
);
});
it("should skip malformed resource entries inside a data array", () => {
// Given
const input = {
data: [
null,
"bad-entry",
{
id: "resource-row-1",
type: "finding-group-resources",
attributes: {
finding_id: "real-finding-uuid",
resource: {
uid: "arn:aws:s3:::my-bucket",
name: "my-bucket",
service: "s3",
region: "us-east-1",
type: "Bucket",
resource_group: "default",
},
provider: {
type: "aws",
uid: "123456789",
alias: "production",
},
status: "FAIL",
severity: "high",
first_seen_at: null,
last_seen_at: "2024-01-01T00:00:00Z",
},
},
],
};
// When
const result = adaptFindingGroupResourcesResponse(input, "check-1");
// Then
expect(result).toHaveLength(1);
expect(result[0]).toEqual(
expect.objectContaining({
findingId: "real-finding-uuid",
resourceName: "my-bucket",
}),
);
});
it("should attach adapter-produced triage DTOs to finding-level resource rows", () => {
// Given
vi.stubEnv("NEXT_PUBLIC_IS_CLOUD_ENV", "true");
const input = {
data: [
{
id: "resource-row-1",
type: "finding-group-resources",
attributes: {
finding_id: "real-finding-uuid",
finding_uid: "prowler-finding-uid-1",
triage_status: "under_review",
triage_has_note: true,
resource: {
uid: "arn:aws:s3:::my-bucket",
name: "my-bucket",
service: "s3",
region: "us-east-1",
type: "Bucket",
resource_group: "default",
},
provider: {
type: "aws",
uid: "123456789",
alias: "production",
},
status: "FAIL",
muted: false,
delta: "new",
severity: "critical",
first_seen_at: null,
last_seen_at: "2024-01-01T00:00:00Z",
},
},
],
};
// When
const [row] = adaptFindingGroupResourcesResponse(input, "s3_check");
// Then
expect(row.triage).toEqual(
expect.objectContaining({
findingId: "real-finding-uuid",
findingUid: "prowler-finding-uid-1",
status: FINDING_TRIAGE_STATUS.UNDER_REVIEW,
label: "Under Review",
hasVisibleNote: true,
canEdit: true,
}),
);
expectNoRawTriageTransportKeys(
row.triage as unknown as Record<string, unknown>,
);
});
it("should leave triage editing disabled until a real capability is provided", () => {
// Given
vi.stubEnv("NEXT_PUBLIC_IS_CLOUD_ENV", "false");
const input = {
data: [
{
id: "resource-row-1",
type: "finding-group-resources",
attributes: {
finding_id: "real-finding-uuid",
finding_uid: "prowler-finding-uid-1",
triage_status: "open",
triage_has_note: false,
resource: {
uid: "arn:aws:s3:::my-bucket",
name: "my-bucket",
service: "s3",
region: "us-east-1",
type: "Bucket",
resource_group: "default",
},
provider: {
type: "aws",
uid: "123456789",
alias: "production",
},
status: "FAIL",
muted: false,
delta: "new",
severity: "critical",
first_seen_at: null,
last_seen_at: "2024-01-01T00:00:00Z",
},
},
],
};
// When
const [row] = adaptFindingGroupResourcesResponse(input, "s3_check");
// Then
expect(row.triage).toEqual(
expect.objectContaining({
canEdit: false,
disabledReason: FINDING_TRIAGE_DISABLED_REASON.CLOUD_ONLY,
}),
);
});
it("should return mapped rows for valid data", () => {
// Given
const input = {
data: [
{
id: "resource-row-1",
type: "finding-group-resources",
attributes: {
finding_id: "real-finding-uuid",
resource: {
uid: "arn:aws:s3:::my-bucket",
name: "my-bucket",
service: "s3",
region: "us-east-1",
type: "Bucket",
resource_group: "default",
},
provider: {
type: "aws",
uid: "123456789",
alias: "production",
},
status: "FAIL",
muted: true,
delta: "new",
severity: "critical",
first_seen_at: null,
last_seen_at: "2024-01-01T00:00:00Z",
},
},
],
};
// When
const result = adaptFindingGroupResourcesResponse(input, "s3_check");
// Then
expect(result).toHaveLength(1);
expect(result[0].findingId).toBe("real-finding-uuid");
expect(result[0].checkId).toBe("s3_check");
expect(result[0].resourceName).toBe("my-bucket");
expect(result[0].delta).toBe("new");
expect(result[0].isMuted).toBe(true);
});
});