Skip to content

Add a sample report matrix for developers #108

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.

Sign up for GitHub

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

Merged
bencehezso merged 1 commit into from
Oct 25, 2026
Merged

Add a sample report matrix for developers #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,17 @@ web_modules/
# Generated reports
reports/

# Rendered sample reports (python -m tests.samples)
/samples/

# Local configs (only the example templates are tracked)
config/*
!config/*_example.json

# Terraform state and downloaded datasets
*.tfstate
!tests/fixtures/smoke/aws.tfstate
!tests/fixtures/samples/tfstate/*.tfstate
datasets/

# TypeScript cache
Expand Down
97 changes: 97 additions & 0 deletions tests/fixtures/samples/aws_no_egress.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"name": "Sample – Internal Billing Platform",
"purpose": "The same estate without egress: no egress document, no egress sentence.",
"provider": "aws",
"exit_strategy": 3,
"scope": {
"accountId": "123456789012",
"region": "eu-central-1"
},
"resources": [
{
"type": "AWS.ec2.describe_instances.Reservations",
"region": "eu-central-1",
"count": 14
},
{
"type": "AWS.ec2.describe_instances.Reservations",
"region": "eu-west-1",
"count": 6
},
{
"type": "AWS.s3.list_buckets.Buckets",
"region": "eu-central-1",
"count": 9
},
{
"type": "AWS.s3.list_buckets.Buckets",
"region": "eu-west-1",
"count": 3
},
{
"type": "AWS.ec2.describe_volumes.Volumes",
"region": "eu-central-1",
"count": 22
},
{
"type": "AWS.ec2.describe_volumes.Volumes",
"region": "eu-west-1",
"count": 8
},
{
"type": "AWS.rds.describe_db_instances.DBInstances",
"region": "eu-central-1",
"count": 3
},
{
"type": "AWS.rds.describe_db_instances.DBInstances",
"region": "eu-west-1",
"count": 1
},
{
"type": "AWS.dynamodb.list_tables.TableNames",
"region": "eu-central-1",
"count": 5
},
{
"type": "AWS.lambda.list_functions.Functions",
"region": "eu-central-1",
"count": 18
},
{
"type": "AWS.lambda.list_functions.Functions",
"region": "eu-west-1",
"count": 6
},
{
"type": "AWS.eks.list_clusters.clusters",
"region": "eu-central-1",
"count": 2
},
{
"type": "AWS.sqs.list_queues.QueueUrls",
"region": "eu-central-1",
"count": 7
},
{
"type": "AWS.sns.list_topics.Topics",
"region": "eu-central-1",
"count": 4
}
],
"costs": {
"currency": "USD",
"months": {
"2026-06": 8420.35,
"2026-07": 8791.1,
"2026-08": 9054.8,
"2026-09": 8632.45,
"2026-10": 9310.2,
"2026-11": 4120.75
}
},
"egress": null,
"upload": null,
"clock": "2026-11-12T09:30:00Z",
"run_id": "01939b8e-7c2a-7d41-9a51-3c8f0a6e0002"
}
157 changes: 157 additions & 0 deletions tests/fixtures/samples/aws_typical.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
{
"name": "Sample – Customer Self-Service Portal",
"purpose": "Several risk severities, USD costs with a provisional month, egress with archive tiers.",
"provider": "aws",
"exit_strategy": 3,
"scope": {
"accountId": "123456789012",
"region": "eu-central-1"
},
"resources": [
{
"type": "AWS.ec2.describe_instances.Reservations",
"region": "eu-central-1",
"count": 14
},
{
"type": "AWS.ec2.describe_instances.Reservations",
"region": "eu-west-1",
"count": 6
},
{
"type": "AWS.s3.list_buckets.Buckets",
"region": "eu-central-1",
"count": 9
},
{
"type": "AWS.s3.list_buckets.Buckets",
"region": "eu-west-1",
"count": 3
},
{
"type": "AWS.ec2.describe_volumes.Volumes",
"region": "eu-central-1",
"count": 22
},
{
"type": "AWS.ec2.describe_volumes.Volumes",
"region": "eu-west-1",
"count": 8
},
{
"type": "AWS.rds.describe_db_instances.DBInstances",
"region": "eu-central-1",
"count": 3
},
{
"type": "AWS.rds.describe_db_instances.DBInstances",
"region": "eu-west-1",
"count": 1
},
{
"type": "AWS.dynamodb.list_tables.TableNames",
"region": "eu-central-1",
"count": 5
},
{
"type": "AWS.lambda.list_functions.Functions",
"region": "eu-central-1",
"count": 18
},
{
"type": "AWS.lambda.list_functions.Functions",
"region": "eu-west-1",
"count": 6
},
{
"type": "AWS.eks.list_clusters.clusters",
"region": "eu-central-1",
"count": 2
},
{
"type": "AWS.sqs.list_queues.QueueUrls",
"region": "eu-central-1",
"count": 7
},
{
"type": "AWS.sns.list_topics.Topics",
"region": "eu-central-1",
"count": 4
}
],
"costs": {
"currency": "USD",
"months": {
"2026-06": 8420.35,
"2026-07": 8791.1,
"2026-08": 9054.8,
"2026-09": 8632.45,
"2026-10": 9310.2,
"2026-11": 4120.75
}
},
"egress": {
"archive_tiers": [
"Archive",
"Glacier",
"Deep Archive"
],
"resources": [
{
"type": "AWS.s3.list_buckets.Buckets",
"name": "sample-portal-assets",
"size_gib": 1800,
"tiers": {
"Standard": 1200,
"Standard-IA": 300,
"Glacier": 300
}
},
{
"type": "AWS.s3.list_buckets.Buckets",
"name": "sample-portal-archive",
"size_gib": 5200,
"tiers": {
"Standard": 400,
"Glacier": 3800,
"Deep Archive": 1000
}
},
{
"type": "AWS.ec2.describe_volumes.Volumes",
"name": "vol-0a1b2c3d4e5f60789",
"size_gib": 500,
"flags": [
"allocated (upper bound)"
]
},
{
"type": "AWS.ec2.describe_volumes.Volumes",
"name": "vol-0123456789abcdef0",
"size_gib": 250,
"flags": [
"allocated (upper bound)"
]
},
{
"type": "AWS.rds.describe_db_instances.DBInstances",
"name": "sample-portal-db",
"size_gib": 320,
"flags": [
"allocated (upper bound)"
],
"notes": [
"allocated: 320.0 GiB"
]
},
{
"type": "AWS.dynamodb.list_tables.TableNames",
"name": "sample-sessions",
"size_gib": 12
}
]
},
"upload": null,
"clock": "2026-11-12T09:30:00Z",
"run_id": "01939b8e-7c2a-7d41-9a51-3c8f0a6e0001"
}
Loading
Loading