diff --git a/docs/depth-advantage.html b/docs/depth-advantage.html new file mode 100644 index 0000000..d8de123 --- /dev/null +++ b/docs/depth-advantage.html @@ -0,0 +1,224 @@ + + + + + +RecourseOS - Depth Advantage + + + + + + + + +
+ +
+
strategy · implemented
+

Depth Advantage

+

RecourseOS competes on consequence depth, not gateway breadth. We explain why an action is dangerous, what the blast radius is, and provide cryptographic proof of the evaluation.

+
+
+
+ +
+

Competitive Positioning

+

While competitors offer shallow pattern matching ("block rm -rf"), RecourseOS provides:

+ + +

Consequence Reasoning Quality

+

Generic verdicts don't help humans make decisions. RecourseOS provides concrete metrics:

+ +
+
+ Before +

"Bucket deletion is destructive"

+
+
+ After +

"S3 bucket 'production-data' (12,847 objects, 50 GB, last modified 2 hours ago) has no versioning, object lock, or replication; deletion is UNRECOVERABLE"

+
+
+ +

For RDS instances:

+
RDS instance 'analytics-db' (postgres) is recoverable:
+5 snapshots (latest: 4 hours ago), PITR available, 7-day automated backups
+ +

Metrics gathered from live state include:

+ + +

Cascade Analysis

+

A count of affected resources isn't actionable. RecourseOS groups by type and tracks dependency depth:

+ +
+
+ Before +

"cascadeImpactCount: 7"

+
+
+ After +

"3 subnets, 2 EC2 instances, 1 NAT gateway, 1 RDS instance (max depth: 2)"

+
+
+ +

The consequence report includes structured cascade data:

+
{
+  "cascadeSummary": "3 subnets, 2 EC2 instances, 1 NAT gateway, 1 RDS instance",
+  "maxCascadeDepth": 2,
+  "cascadeByType": {
+    "aws_subnet": 3,
+    "aws_instance": 2,
+    "aws_nat_gateway": 1,
+    "aws_db_instance": 1
+  }
+}
+ +

Verification Loop

+

When RecourseOS can't determine recoverability from available state, it suggests verification commands. These include structured patterns for automatic output interpretation:

+ +
{
+  "evidence_key": "manual_snapshots_exist",
+  "description": "Check for manual RDS snapshots",
+  "verification": {
+    "type": "aws_cli",
+    "argv": ["aws", "rds", "describe-db-snapshots",
+             "--db-instance-identifier", "prod-db",
+             "--snapshot-type", "manual", "--output", "json"]
+  },
+  "expected_pattern": { "type": "json_array_not_empty" },
+  "failure_pattern": { "type": "regex", "regex": "^\\[\\]$" },
+  "example_output": "[{\"DBSnapshotIdentifier\": \"prod-db-2024-01-15\"}]"
+}
+ +

Pattern types:

+ + + + + + + + + +
TypeDescriptionUse Case
json_array_not_emptyOutput is a non-empty JSON arrayCheck if snapshots exist
json_field_equalsJSON field equals expected valueCheck if Status = "Enabled"
json_field_existsJSON field exists and is non-nullCheck if VersionId is present
regexRegex matches raw outputCheck for PITR: enabled
exit_codeCommand exit code matchesVerify command succeeded
+ +

Workflow:

+
    +
  1. RecourseOS returns verification suggestions with structured patterns
    2. +
  2. Agent runs command, captures exit code and raw output
    3. +
  3. Agent submits evidence via recourse_evaluate_with_evidence
    4. +
  4. Pattern matcher auto-interprets output
    5. +
  5. Verdict upgraded if evidence confirms recovery paths
    6. +
+ +

Attestation Richness

+

Audit logs prove something happened. Attestations prove what was evaluated and why:

+ +
+
+ Audit Log +

Signed input/output pair

+
+
+ RecourseOS Attestation +

Full reasoning chain, independently verifiable

+
+
+ +

Attestations include a reasoning trace:

+
{
+  "trace": {
+    "steps": [
+      { "action": "parse_input", "result": "Parsed Terraform plan with 3 resource changes" },
+      { "action": "analyze_blast_radius", "result": "Analyzed 3 changes" },
+      { "action": "cross_action_analysis", "result": "Checked 8 cross-action patterns" },
+      { "action": "policy_evaluation", "result": "Risk assessment: block" }
+    ],
+    "handlers_invoked": ["aws_db_instance", "aws_s3_bucket"],
+    "state_sources": ["terraform-plan", "terraform-state"]
+  }
+}
+ +

Third parties can verify attestations without RecourseOS access using the Go SDK or TypeScript implementation.

+ +

Cross-Action Detection

+

Individual actions may be safe, but their combination can be unrecoverable. RecourseOS detects these patterns:

+ +

See Cross-Action Analysis for the full pattern catalog.

+ +

Comparison Table

+ + + + + + + + + + + +
CapabilityPattern MatchersRecourseOS
Pattern matchingrm -rf → blockYes, plus context
Consequence depthNoneFull blast radius with metrics
Recoverability tiersBinary5-tier + reasoning
AttestationAudit logsCryptographic proof + trace
Evidence verificationNoneStructured pattern matching
Cascade analysisNoneType-grouped dependency graph
Cross-action detectionNoneMulti-change patterns
+
+
+ + + diff --git a/docs/depth-advantage.md b/docs/depth-advantage.md new file mode 100644 index 0000000..3d9f5e9 --- /dev/null +++ b/docs/depth-advantage.md @@ -0,0 +1,175 @@ +# Depth Advantage Strategy + +RecourseOS competes on **consequence depth**, not gateway breadth. While competitors like hoop.dev offer shallow pattern matching ("block `rm -rf`"), RecourseOS explains *why* an action is dangerous, *what* the blast radius is, and provides *cryptographic proof* of the evaluation. + +--- + +## Implementation Status + +| Focus Area | Status | Commit | +|------------|--------|--------| +| Attestation Richness | ✅ Complete | Reasoning trace + verification instructions | +| Consequence Reasoning | ✅ Complete | Concrete metrics for S3/RDS | +| Cascade Analysis | ✅ Complete | Type grouping + depth tracking | +| Verification Loop | ✅ Complete | Structured pattern matching | +| Cross-Action Analysis | ✅ Exists | Patterns in cross-action-patterns.ts | + +--- + +## Focus Areas + +### 1. Consequence Reasoning Quality ✅ + +**Before:** "Bucket deletion is destructive" +**After:** "S3 bucket 'production-data' (12,847 objects, 50 GB, last modified 2 hours ago) has no versioning, object lock, or replication; deletion is UNRECOVERABLE" + +**Implementation:** +- `src/state/aws/s3.ts`: Added `objectCount`, `totalSizeBytes`, `lastModified`, `sampleSize` metrics +- `src/state/aws/rds.ts`: Added `snapshotCount`, `latestSnapshotTime`, engine info to reasoning +- Helper functions: `formatBytes()`, `formatTimeAgo()`, `buildMetricsSummary()` + +**Example output:** +``` +RDS instance 'analytics-db' (postgres) is recoverable: 5 snapshots (latest: 4 hours ago), PITR available, 7-day automated backups +``` + +### 2. Cascade Analysis ✅ + +**Before:** "cascadeImpactCount: 7" +**After:** "3 subnets, 2 EC2 instances, 1 NAT gateway, 1 RDS instance (max depth: 2)" + +**Implementation:** +- `src/analyzer/dependencies.ts`: Added `resourceTypes` map, `buildCascadeSummary()` +- `src/resources/types.ts`: Enhanced `CascadeImpact` with `resourceType`, `depth`, `dependencyType` +- `src/output/json.ts`: Added `cascadeByType`, `cascadeSummary`, `maxCascadeDepth` to output + +**Example output:** +```json +{ + "cascadeSummary": "3 subnets, 2 EC2 instances, 1 NAT gateway, 1 RDS instance", + "maxCascadeDepth": 2, + "cascadeByType": { + "aws_subnet": 3, + "aws_instance": 2, + "aws_nat_gateway": 1, + "aws_db_instance": 1 + } +} +``` + +### 3. Verification Loop ✅ + +**Before:** Generic text suggestions +**After:** Copy-paste commands with structured patterns for automatic output interpretation + +**Implementation:** +- `src/core/mutation.ts`: Added `OutputPattern` type with `json_array_not_empty`, `json_field_equals`, `json_field_exists`, `regex`, `exit_code` +- `src/verification/pattern-matcher.ts`: New file with `interpretVerificationOutput()`, `matchPattern()` +- `src/verification/templates.ts`: Enhanced with `expected_pattern`, `failure_pattern`, `example_output` +- `src/mcp/server.ts`: Improved evidence re-evaluation with pattern matching + +**Workflow:** +1. RecourseOS returns verification suggestions with structured patterns +2. Agent runs command, captures output and exit code +3. Agent submits evidence with `raw_output` +4. Pattern matcher auto-interprets output +5. Verdict upgraded if evidence confirms recovery paths + +**Example suggestion:** +```json +{ + "evidence_key": "manual_snapshots_exist", + "verification": { + "argv": ["aws", "rds", "describe-db-snapshots", "--db-instance-identifier", "prod-db", ...] + }, + "expected_pattern": { "type": "json_array_not_empty" }, + "example_output": "[{\"Id\": \"prod-db-2024-01-15\", \"Status\": \"available\"}]" +} +``` + +### 4. Attestation Richness ✅ + +**Before:** Signed input/output pair +**After:** Full reasoning chain, independently verifiable + +**Implementation:** +- `schemas/attestation.v1.json`: Added `reasoningTrace` and `verificationInstructions` definitions +- `src/evaluator/trace.ts`: New `TraceBuilder` class for capturing evaluation steps +- `src/core/consequence.ts`: Added `trace` and `verification` fields to `ConsequenceReport` + +**Example trace:** +```json +{ + "trace": { + "steps": [ + { "action": "parse_input", "result": "Parsed Terraform plan with 3 resource changes" }, + { "action": "analyze_blast_radius", "result": "Analyzed 3 changes" }, + { "action": "cross_action_analysis", "result": "Checked 8 cross-action patterns" }, + { "action": "policy_evaluation", "result": "Risk assessment: block" } + ], + "handlers_invoked": ["aws_db_instance", "aws_s3_bucket"], + "state_sources": ["terraform-plan", "terraform-state"] + } +} +``` + +### 5. Cross-Action Analysis ✅ + +**Status:** Already implemented in `src/analyzer/cross-action.ts` and `cross-action-patterns.ts` + +**Patterns detected:** +- Delete security group while EC2 still references it +- Replace RDS instance while app still points to old endpoint +- Delete VPC while resources still depend on it +- And more... + +--- + +## Competitive Positioning + +| Capability | Hoop.dev | RecourseOS | +|------------|----------|------------| +| Pattern matching | `rm -rf` → block | ✓ | +| Consequence depth | ✗ | Full blast radius with concrete metrics | +| Recoverability tiers | Binary | 5-tier + detailed reasoning | +| Attestation | Audit logs | Cryptographic proof with reasoning trace | +| Evidence verification | ✗ | Structured pattern matching + re-evaluation | +| Cascade analysis | ✗ | Type-grouped dependency graph with depth | +| Cross-action detection | ✗ | Multi-change interaction patterns | + +--- + +## Files Changed + +### Consequence Reasoning +- `src/state/aws/s3.ts` - S3 metrics and enriched reasoning +- `src/state/aws/rds.ts` - RDS metrics and enriched reasoning + +### Cascade Analysis +- `src/analyzer/dependencies.ts` - Type grouping, depth tracking +- `src/resources/types.ts` - Enhanced CascadeImpact type +- `src/analyzer/blast-radius.ts` - Cascade summary building +- `src/output/json.ts` - JSON output with cascade fields + +### Verification Loop +- `src/core/mutation.ts` - OutputPattern type +- `src/verification/pattern-matcher.ts` - Auto-matching logic +- `src/verification/templates.ts` - Structured patterns +- `src/mcp/server.ts` - Improved evidence re-evaluation + +### Attestation Richness +- `schemas/attestation.v1.json` - Schema definitions +- `src/evaluator/trace.ts` - TraceBuilder +- `src/core/consequence.ts` - Trace fields +- `src/evaluator/terraform.ts` - Trace capture + +--- + +## Success Metrics ✅ + +- [x] Attestation includes full reasoning trace (not just verdict) +- [x] Third party can verify attestation without RecourseOS access +- [x] Consequence reports include live state metrics +- [x] Cascade impact shows affected resource count and types +- [x] Verification suggestions are copy-paste ready with expected outputs +- [x] Pattern matching enables automatic output interpretation diff --git a/docs/docs.html b/docs/docs.html index 3582f34..3a68482 100644 --- a/docs/docs.html +++ b/docs/docs.html @@ -187,6 +187,12 @@

Docs

Design Drafts

Designs for new capabilities. Some implemented, others under consideration.

+ + +
strategy
+
Depth Advantage
+
How RecourseOS competes on consequence depth: blast radius metrics, structured verification, cryptographic attestation.
+
implemented
diff --git a/docs/verification-protocol-v1.md b/docs/verification-protocol-v1.md index 172a3ea..d717421 100644 --- a/docs/verification-protocol-v1.md +++ b/docs/verification-protocol-v1.md @@ -26,7 +26,6 @@ This specification does not cover: - **Credential management.** The agent has its own credentials. Recourse does not provide, manage, or proxy credentials. - **Cross-account orchestration.** If verification requires assuming a role in another AWS account, the agent handles that context. Recourse suggests the command; the agent decides how to authenticate. -- **Output parsing.** The `expected_signal` and `failure_signal` fields are human-readable hints. Structured parsing (regex, JMESPath) may be added in a future version. - **Verification execution.** Recourse suggests; agents execute. The engine never runs commands itself. ## Schema @@ -83,10 +82,15 @@ export interface VerificationSuggestion { // How to resolve it verification: VerificationCommand; - // How to interpret results + // How to interpret results (human-readable hints) expected_signal: string; // What indicates evidence is present failure_signal: string; // What indicates evidence is absent + // Structured patterns for automatic output interpretation (optional) + expected_pattern?: OutputPattern; // Auto-match pattern for success + failure_pattern?: OutputPattern; // Auto-match pattern for failure + example_output?: string; // Human-readable example of expected output + // What changes if verified verdict_impact: { current_tier: string; @@ -103,6 +107,33 @@ export interface VerificationSuggestion { // - 'informational': Would only improve confidence priority: 'critical' | 'recommended' | 'informational'; } + +/** + * Structured pattern for automatic output interpretation. + * Enables agents to auto-match verification results without manual parsing. + */ +export interface OutputPattern { + // Pattern type determines evaluation strategy + type: + | 'json_array_not_empty' // Output is a non-empty JSON array + | 'json_field_equals' // JSON field equals expected value + | 'json_field_exists' // JSON field exists and is non-null + | 'regex' // Regex matches raw output + | 'exit_code'; // Command exit code matches + + // For json_* types: JSON path in dot notation + // Example: "Status", "DBSnapshots", "PointInTimeRecoveryDescription.PointInTimeRecoveryStatus" + path?: string; + + // For json_field_equals: the expected value + expected_value?: unknown; + + // For regex: the pattern to match + regex?: string; + + // For exit_code: expected code (default 0) + expected_exit_code?: number; +} ``` ### EvidenceSubmission @@ -191,6 +222,111 @@ Returns consequence report with optional `verification_suggestions` array. } ``` +## Automatic Output Interpretation + +When `expected_pattern` or `failure_pattern` is provided, agents can automatically interpret verification output without manual parsing. + +### Pattern Types + +| Type | Description | Example Use Case | +|------|-------------|------------------| +| `json_array_not_empty` | Output is a non-empty JSON array | Check if snapshots exist | +| `json_field_equals` | JSON field equals expected value | Check if `Status` = `"Enabled"` | +| `json_field_exists` | JSON field exists and is non-null | Check if `VersionId` is present | +| `regex` | Regex matches raw output | Check for `PITR:\s*enabled` | +| `exit_code` | Command exit code matches | Verify command succeeded | + +### Interpretation Flow + +``` +1. Agent runs verification command +2. Capture exit_code and raw_output +3. If exit_code != 0 and output contains "error"/"Error"/"AccessDenied": + → Return interpretation: "error" +4. If expected_pattern provided: + → Match output against expected_pattern + → If matches: return interpretation: "matches_expected" +5. If failure_pattern provided: + → Match output against failure_pattern + → If matches: return interpretation: "matches_failure" +6. If expected_pattern provided but didn't match: + → Return interpretation: "matches_failure" +7. Otherwise: + → Return interpretation: "ambiguous" +``` + +### Example: S3 Versioning Check + +```typescript +{ + evidence_key: 's3_versioning_enabled', + description: 'Check if S3 bucket has versioning enabled', + verification: { + type: 'aws_cli', + argv: ['aws', 's3api', 'get-bucket-versioning', '--bucket', 'my-bucket', '--output', 'json'] + }, + expected_signal: 'Status: Enabled indicates versioning is on', + failure_signal: 'Empty object {} indicates versioning is off', + + // Structured patterns for automatic matching + expected_pattern: { + type: 'json_field_equals', + path: 'Status', + expected_value: 'Enabled' + }, + failure_pattern: { + type: 'regex', + regex: '^\\{\\}$' // Empty JSON object + }, + example_output: '{"Status": "Enabled", "MFADelete": "Disabled"}' +} +``` + +### Example: RDS Snapshots Check + +```typescript +{ + evidence_key: 'manual_snapshots_exist', + description: 'Check for manual RDS snapshots', + verification: { + type: 'aws_cli', + argv: ['aws', 'rds', 'describe-db-snapshots', '--db-instance-identifier', 'prod-db', '--snapshot-type', 'manual', '--output', 'json'] + }, + expected_signal: 'Non-empty array indicates snapshots exist', + failure_signal: 'Empty array indicates no snapshots', + + // Structured pattern: just check if array is non-empty + expected_pattern: { + type: 'json_array_not_empty' + }, + example_output: '[{"DBSnapshotIdentifier": "prod-db-2024-01-15", "Status": "available"}]' +} +``` + +### Example: DynamoDB PITR Check + +```typescript +{ + evidence_key: 'dynamodb_pitr_enabled', + description: 'Check if DynamoDB table has Point-in-Time Recovery enabled', + verification: { + type: 'aws_cli', + argv: ['aws', 'dynamodb', 'describe-continuous-backups', '--table-name', 'users', '--output', 'json'] + }, + expected_signal: 'PointInTimeRecoveryStatus: ENABLED', + failure_signal: 'PointInTimeRecoveryStatus: DISABLED', + + expected_pattern: { + type: 'json_field_equals', + path: 'ContinuousBackupsDescription.PointInTimeRecoveryDescription.PointInTimeRecoveryStatus', + expected_value: 'ENABLED' + }, + example_output: '{"ContinuousBackupsDescription": {"PointInTimeRecoveryDescription": {"PointInTimeRecoveryStatus": "ENABLED"}}}' +} +``` + +--- + ## Verification Catalog ### EBS Volume Delete @@ -614,14 +750,17 @@ Recourse incorporates the evidence and returns a confident verdict: 1. **Attempt verification before escalating.** If you receive verification suggestions with `priority: critical`, run them before escalating to humans. This produces better verdicts with less human involvement. -2. **Skip verification gracefully.** If you lack credentials or the command fails, submit evidence with `agent_interpretation: error`. The engine will use your escalation with the original verdict. +2. **Use automatic pattern matching.** When `expected_pattern` is provided, use it to auto-interpret output instead of manual parsing. Submit both `raw_output` and your `agent_interpretation` based on pattern matching. + +3. **Skip verification gracefully.** If you lack credentials or the command fails, submit evidence with `agent_interpretation: error`. The engine will use your escalation with the original verdict. -3. **Trust the engine's interpretation.** Submit `raw_output` and let the engine validate. Your `agent_interpretation` is a hint, not authoritative. +4. **Trust the engine's interpretation.** Submit `raw_output` and let the engine validate. Your `agent_interpretation` is a hint, not authoritative. The engine may re-interpret using the structured patterns. -4. **Respect timeouts.** Use `timeout_seconds` from the suggestion. Don't hang indefinitely on slow API calls. +5. **Respect timeouts.** Use `timeout_seconds` from the suggestion. Don't hang indefinitely on slow API calls. -5. **Check permissions first.** If `requires_permissions` lists permissions you don't have, skip that verification and note it in `agent_notes`. +6. **Check permissions first.** If `requires_permissions` lists permissions you don't have, skip that verification and note it in `agent_notes`. ## Changelog +- **v1.1** (2026-05-09): Added structured output patterns (`OutputPattern`) for automatic verification output interpretation. New pattern types: `json_array_not_empty`, `json_field_equals`, `json_field_exists`, `regex`, `exit_code`. - **v1** (2024-XX-XX): Initial protocol diff --git a/schemas/attestation.v1.json b/schemas/attestation.v1.json index bc97d46..39b3b62 100644 --- a/schemas/attestation.v1.json +++ b/schemas/attestation.v1.json @@ -31,6 +31,8 @@ "items": { "$ref": "#/$defs/mutation" } }, "summary": { "$ref": "#/$defs/summary" }, + "trace": { "$ref": "#/$defs/reasoningTrace" }, + "verification": { "$ref": "#/$defs/verificationInstructions" }, "version": { "type": "string", "description": "Output schema version" @@ -197,6 +199,147 @@ "description": "Human-readable description of the evidence" } } + }, + "reasoningTrace": { + "type": "object", + "description": "Step-by-step reasoning chain for the evaluation", + "required": ["steps"], + "properties": { + "steps": { + "type": "array", + "description": "Ordered list of evaluation steps", + "items": { "$ref": "#/$defs/traceStep" } + }, + "duration_ms": { + "type": "number", + "description": "Total evaluation time in milliseconds" + }, + "handlers_invoked": { + "type": "array", + "items": { "type": "string" }, + "description": "List of handler names that were invoked" + }, + "state_sources": { + "type": "array", + "items": { "type": "string" }, + "description": "Sources of state used (terraform, aws-api, etc.)" + } + } + }, + "traceStep": { + "type": "object", + "required": ["step", "action", "result"], + "properties": { + "step": { + "type": "integer", + "description": "Step number (1-indexed)" + }, + "action": { + "type": "string", + "description": "What was done in this step", + "examples": ["parse_input", "route_to_handler", "check_backup_config", "assess_recoverability"] + }, + "target": { + "type": "string", + "description": "Resource or component this step operated on" + }, + "result": { + "type": "string", + "description": "Outcome of this step" + }, + "evidence_gathered": { + "type": "array", + "items": { "$ref": "#/$defs/evidence" }, + "description": "Evidence collected during this step" + }, + "decision": { + "type": "string", + "description": "Decision made based on this step (if any)" + }, + "confidence": { + "type": "number", + "minimum": 0, + "maximum": 1, + "description": "Confidence in this step's result" + } + } + }, + "verificationInstructions": { + "type": "object", + "description": "Instructions for independently verifying this assessment", + "properties": { + "commands": { + "type": "array", + "description": "Commands a verifier can run to confirm the assessment", + "items": { + "type": "object", + "required": ["description", "command"], + "properties": { + "description": { + "type": "string", + "description": "What this command checks" + }, + "command": { + "type": "string", + "description": "The command to run" + }, + "expected_pattern": { + "type": "string", + "description": "Regex pattern expected in output to confirm assessment" + }, + "confirms": { + "type": "string", + "description": "What aspect of the assessment this confirms" + } + } + } + }, + "api_checks": { + "type": "array", + "description": "API calls a verifier can make", + "items": { + "type": "object", + "required": ["service", "operation"], + "properties": { + "service": { + "type": "string", + "description": "AWS/GCP/Azure service name" + }, + "operation": { + "type": "string", + "description": "API operation name" + }, + "parameters": { + "type": "object", + "description": "Parameters for the API call" + }, + "expected_result": { + "type": "object", + "description": "Expected result structure" + } + } + } + }, + "reproducibility": { + "type": "string", + "enum": ["deterministic", "state-dependent", "time-sensitive"], + "description": "Whether this assessment can be exactly reproduced" + }, + "state_snapshot": { + "type": "object", + "description": "Snapshot of relevant state at evaluation time", + "properties": { + "captured_at": { + "type": "string", + "format": "date-time" + }, + "resources": { + "type": "object", + "additionalProperties": true + } + } + } + } } } } diff --git a/src/analyzer/blast-radius.ts b/src/analyzer/blast-radius.ts index 76acb7a..611bd8b 100644 --- a/src/analyzer/blast-radius.ts +++ b/src/analyzer/blast-radius.ts @@ -11,7 +11,7 @@ import type { import { RecoverabilityTier } from '../resources/types.js'; import { getRecoverability } from '../resources/index.js'; import { getRecoverabilityDual } from '../classifier/dual-verdict.js'; -import { buildDependencyGraph, findDependents } from './dependencies.js'; +import { buildDependencyGraph, findDependents, buildCascadeSummary } from './dependencies.js'; import { filterAllChanges } from '../parsers/plan.js'; export interface AnalyzeOptions { @@ -56,13 +56,7 @@ export function analyzeBlastRadius( // Find cascade impact for destructive changes let cascadeImpact: CascadeImpact[] = []; if (graph && change.actions.includes('delete')) { - const dependents = findDependents(graph, change.address); - cascadeImpact = dependents.map(dep => ({ - affectedResource: dep.address, - reason: dep.referenceAttribute - ? `References ${dep.referenceAttribute}` - : `Depends on deleted resource`, - })); + cascadeImpact = findDependents(graph, change.address); } return { @@ -92,6 +86,7 @@ function buildSummary(changes: BlastRadiusChange[]): BlastRadiusSummary { let cascadeImpactCount = 0; const seenCascade = new Set(); + const allCascadeImpacts: import('../resources/types.js').CascadeImpact[] = []; for (const change of changes) { byTier[change.recoverability.tier]++; @@ -100,15 +95,22 @@ function buildSummary(changes: BlastRadiusChange[]): BlastRadiusSummary { if (!seenCascade.has(impact.affectedResource)) { seenCascade.add(impact.affectedResource); cascadeImpactCount++; + allCascadeImpacts.push(impact); } } } + // Build enhanced cascade summary + const cascadeSummaryData = buildCascadeSummary(allCascadeImpacts); + return { totalChanges: changes.length, byTier, cascadeImpactCount, hasUnrecoverable: byTier[RecoverabilityTier.UNRECOVERABLE] > 0, + cascadeByType: cascadeImpactCount > 0 ? cascadeSummaryData.byType : undefined, + maxCascadeDepth: cascadeImpactCount > 0 ? cascadeSummaryData.maxDepth : undefined, + cascadeSummary: cascadeImpactCount > 0 ? cascadeSummaryData.humanReadable : undefined, }; } diff --git a/src/analyzer/dependencies.ts b/src/analyzer/dependencies.ts index c1addec..e1e0ad5 100644 --- a/src/analyzer/dependencies.ts +++ b/src/analyzer/dependencies.ts @@ -1,4 +1,4 @@ -import type { TerraformState, StateResource, ResourceDependency } from '../resources/types.js'; +import type { TerraformState, StateResource, ResourceDependency, CascadeImpact } from '../resources/types.js'; import { getDependencies } from '../resources/index.js'; export interface DependencyGraph { @@ -6,16 +6,20 @@ export interface DependencyGraph { dependents: Map; // Map from resource address to resources it depends on dependencies: Map; + // Map from address to resource type for lookups + resourceTypes: Map; } export function buildDependencyGraph(state: TerraformState): DependencyGraph { const dependents = new Map(); const dependencies = new Map(); + const resourceTypes = new Map(); // Initialize empty arrays for all resources for (const resource of state.resources) { dependents.set(resource.address, []); dependencies.set(resource.address, []); + resourceTypes.set(resource.address, resource.type); } // Build the graph @@ -49,10 +53,52 @@ export function buildDependencyGraph(state: TerraformState): DependencyGraph { } } - return { dependents, dependencies }; + return { dependents, dependencies, resourceTypes }; } +/** + * Find all resources that depend on the given address. + * Returns CascadeImpact objects with depth tracking. + */ export function findDependents( + graph: DependencyGraph, + address: string, + visited: Set = new Set(), + depth: number = 1 +): CascadeImpact[] { + if (visited.has(address)) { + return []; + } + visited.add(address); + + const directDependents = graph.dependents.get(address) || []; + const allDependents: CascadeImpact[] = []; + + for (const dep of directDependents) { + const resourceType = graph.resourceTypes.get(dep.address) || 'unknown'; + + allDependents.push({ + affectedResource: dep.address, + resourceType, + reason: dep.referenceAttribute + ? `References ${dep.referenceAttribute} of deleted resource` + : `Depends on deleted resource`, + depth, + dependencyType: dep.dependencyType, + }); + + // Recursively find dependents of dependents (at deeper level) + const transitiveDeps = findDependents(graph, dep.address, visited, depth + 1); + allDependents.push(...transitiveDeps); + } + + return allDependents; +} + +/** + * Legacy function for compatibility - returns just ResourceDependency[] + */ +export function findDependentsLegacy( graph: DependencyGraph, address: string, visited: Set = new Set() @@ -65,9 +111,8 @@ export function findDependents( const directDependents = graph.dependents.get(address) || []; const allDependents: ResourceDependency[] = [...directDependents]; - // Recursively find dependents of dependents for (const dep of directDependents) { - const transitiveDeps = findDependents(graph, dep.address, visited); + const transitiveDeps = findDependentsLegacy(graph, dep.address, visited); allDependents.push(...transitiveDeps); } @@ -77,8 +122,8 @@ export function findDependents( export function findAllAffectedResources( graph: DependencyGraph, addresses: string[] -): Map { - const affected = new Map(); +): Map { + const affected = new Map(); for (const address of addresses) { const dependents = findDependents(graph, address); @@ -89,3 +134,68 @@ export function findAllAffectedResources( return affected; } + +/** + * Build a human-readable summary of cascade impacts by type. + * Example: "3 subnets, 2 NAT gateways, 14 EC2 instances" + */ +export function buildCascadeSummary(impacts: CascadeImpact[]): { + byType: Record; + maxDepth: number; + humanReadable: string; +} { + const byType: Record = {}; + let maxDepth = 0; + + for (const impact of impacts) { + byType[impact.resourceType] = (byType[impact.resourceType] || 0) + 1; + if (impact.depth > maxDepth) { + maxDepth = impact.depth; + } + } + + // Build human-readable summary + const parts = Object.entries(byType) + .sort((a, b) => b[1] - a[1]) // Sort by count descending + .map(([type, count]) => { + const shortType = formatResourceType(type); + return `${count} ${shortType}${count !== 1 ? 's' : ''}`; + }); + + return { + byType, + maxDepth, + humanReadable: parts.join(', ') || 'none', + }; +} + +/** + * Convert AWS resource type to human-readable short form. + * Example: "aws_instance" → "EC2 instance" + */ +function formatResourceType(type: string): string { + const typeMap: Record = { + 'aws_instance': 'EC2 instance', + 'aws_subnet': 'subnet', + 'aws_security_group': 'security group', + 'aws_db_instance': 'RDS instance', + 'aws_rds_cluster': 'RDS cluster', + 'aws_s3_bucket': 'S3 bucket', + 'aws_lambda_function': 'Lambda function', + 'aws_vpc': 'VPC', + 'aws_nat_gateway': 'NAT gateway', + 'aws_internet_gateway': 'internet gateway', + 'aws_route_table': 'route table', + 'aws_iam_role': 'IAM role', + 'aws_iam_policy': 'IAM policy', + 'aws_elasticache_cluster': 'ElastiCache cluster', + 'aws_sqs_queue': 'SQS queue', + 'aws_sns_topic': 'SNS topic', + 'aws_efs_file_system': 'EFS filesystem', + 'aws_ebs_volume': 'EBS volume', + 'aws_lb': 'load balancer', + 'aws_lb_target_group': 'target group', + }; + + return typeMap[type] || type.replace(/^aws_/, '').replace(/_/g, ' '); +} diff --git a/src/core/consequence.ts b/src/core/consequence.ts index 3366b62..b2789b8 100644 --- a/src/core/consequence.ts +++ b/src/core/consequence.ts @@ -2,6 +2,7 @@ import type { RecoverabilityResult } from '../resources/types.js'; import type { DependencyImpact, EvidenceItem, MissingEvidence, MutationIntent, VerificationSuggestion } from './mutation.js'; import type { EvidenceRequirementLevel, EvidenceSufficiency } from './state-schema.js'; import type { CrossActionRisk } from '../analyzer/cross-action.js'; +import type { ReasoningTrace, VerificationInstructions } from '../evaluator/trace.js'; export type ConsequenceDecision = 'allow' | 'warn' | 'block' | 'escalate'; @@ -121,4 +122,17 @@ export interface ConsequenceReport { * Always present when cross-action analysis runs (explicit "we checked"). */ crossActionRisks?: CrossActionRisk[]; + + // Attestation Richness (v1.1) + /** + * Step-by-step reasoning trace showing how the evaluation was performed. + * Provides transparency and allows third-party verification. + */ + trace?: ReasoningTrace; + + /** + * Instructions for independently verifying this assessment. + * Includes CLI commands and API calls a verifier can run. + */ + verification?: VerificationInstructions; } diff --git a/src/core/mutation.ts b/src/core/mutation.ts index 61c6aba..1048e1b 100644 --- a/src/core/mutation.ts +++ b/src/core/mutation.ts @@ -121,6 +121,38 @@ export interface VerificationVerdictImpact { }; } +/** + * Structured pattern for matching verification output. + * Enables automatic interpretation of verification results. + */ +export interface OutputPattern { + /** + * Pattern type determines how to evaluate the output. + */ + type: 'json_array_not_empty' | 'json_field_equals' | 'json_field_exists' | 'regex' | 'exit_code'; + + /** + * For json_* types: JSON path to evaluate (dot notation). + * Example: "DBSnapshots", "Status", "PointInTimeRecoveryDescription.PointInTimeRecoveryStatus" + */ + path?: string; + + /** + * For json_field_equals: expected value. + */ + expected_value?: unknown; + + /** + * For regex: pattern to match against raw output. + */ + regex?: string; + + /** + * For exit_code: expected exit code (default 0). + */ + expected_exit_code?: number; +} + export interface VerificationSuggestion { evidence_key: string; description: string; @@ -131,6 +163,24 @@ export interface VerificationSuggestion { verdict_impact: VerificationVerdictImpact; // Derived from verdict_impact for agent convenience priority: VerificationPriority; + + /** + * Structured pattern for automatic output interpretation. + * If provided, agents can auto-match output without manual interpretation. + */ + expected_pattern?: OutputPattern; + + /** + * Structured pattern for failure detection. + * If matched, indicates evidence does NOT confirm recovery. + */ + failure_pattern?: OutputPattern; + + /** + * Human-readable example of expected output. + * Helps agents understand what they're looking for. + */ + example_output?: string; } // Evidence submission from agent diff --git a/src/evaluator/terraform.ts b/src/evaluator/terraform.ts index 8f64d51..aca0712 100644 --- a/src/evaluator/terraform.ts +++ b/src/evaluator/terraform.ts @@ -17,6 +17,12 @@ import type { RequiredEvidence, EvidenceItem, } from '../core/index.js'; +import { + TraceBuilder, + buildVerificationInstructions, + type ReasoningTrace, + type VerificationInstructions, +} from './trace.js'; import { buildRequiredEvidence, getEvidenceRequirements, @@ -47,10 +53,23 @@ export function evaluateTerraformPlanConsequences( state: TerraformState | null, options: TerraformConsequenceOptions = {} ): ConsequenceReport { + // Initialize trace capture + const trace = new TraceBuilder(); + trace.source('terraform-plan'); + if (state) { + trace.source('terraform-state'); + } + + trace.step('parse_input', `Parsed Terraform plan with ${plan.resourceChanges?.length ?? 0} resource changes`); + const blastRadiusReport = analyzeBlastRadius(plan, state, { useClassifier: options.useClassifier, }); + trace.step('analyze_blast_radius', `Analyzed ${blastRadiusReport.changes.length} changes`, { + decision: `total_changes=${blastRadiusReport.summary.totalChanges}, has_unrecoverable=${blastRadiusReport.summary.hasUnrecoverable}`, + }); + const policyEvaluation = evaluateBlastRadiusReport( blastRadiusReport, options.policy @@ -123,6 +142,12 @@ export function evaluateTerraformPlanConsequences( ); const crossActionRisks = detectCrossActionRisks(crossActionContext, crossActionPatterns); + trace.step('cross_action_analysis', `Checked ${crossActionPatterns.length} cross-action patterns`, { + decision: crossActionRisks.length > 0 + ? `found_risks=${crossActionRisks.map(r => r.patternName).join(',')}` + : 'no_risks_detected', + }); + // Get worst tier from cross-action risks (may upgrade plan-level summary) const crossActionWorstTier = getWorstCrossActionTier(crossActionRisks); @@ -225,6 +250,30 @@ export function evaluateTerraformPlanConsequences( ) : policyEvaluation; + // Record handlers invoked + for (const change of blastRadiusReport.changes) { + trace.handler(change.resource.type); + } + + // Final trace step + trace.step('policy_evaluation', `Risk assessment: ${finalPolicyEvaluation.decision}`, { + decision: finalPolicyEvaluation.decision, + confidence: 1.0, + }); + + // Build verification instructions for worst-case resource + const worstChange = blastRadiusReport.changes.find( + c => c.recoverability.tier === worstRecoverability.tier + ); + const verificationInstructions = worstChange + ? buildVerificationInstructions( + worstChange.resource.type, + worstChange.resource.before?.id as string | undefined, + worstRecoverability.tier, + worstChange.resource.before as Record | undefined + ) + : undefined; + const report: ConsequenceReport = { mutations, summary: { @@ -240,6 +289,9 @@ export function evaluateTerraformPlanConsequences( : finalPolicyEvaluation.reason, // Always include cross-action risks (empty array if none detected) crossActionRisks, + // Attestation richness fields + trace: trace.build(), + verification: verificationInstructions, }; // Add verification protocol fields diff --git a/src/evaluator/trace.ts b/src/evaluator/trace.ts new file mode 100644 index 0000000..1859540 --- /dev/null +++ b/src/evaluator/trace.ts @@ -0,0 +1,258 @@ +/** + * Reasoning Trace Builder + * + * Captures the step-by-step evaluation process for inclusion in attestations. + * This provides transparency into how RecourseOS reached its verdict. + */ + +export interface TraceStep { + step: number; + action: string; + target?: string; + result: string; + evidence_gathered?: EvidenceItem[]; + decision?: string; + confidence?: number; + duration_ms?: number; +} + +export interface EvidenceItem { + key: string; + value?: unknown; + present: boolean; + description?: string; +} + +export interface ReasoningTrace { + steps: TraceStep[]; + duration_ms: number; + handlers_invoked: string[]; + state_sources: string[]; +} + +export interface VerificationCommand { + description: string; + command: string; + expected_pattern?: string; + confirms?: string; +} + +export interface ApiCheck { + service: string; + operation: string; + parameters?: Record; + expected_result?: Record; +} + +export interface VerificationInstructions { + commands?: VerificationCommand[]; + api_checks?: ApiCheck[]; + reproducibility: 'deterministic' | 'state-dependent' | 'time-sensitive'; + state_snapshot?: { + captured_at: string; + resources: Record; + }; +} + +/** + * Trace Builder - captures evaluation steps as they occur + */ +export class TraceBuilder { + private steps: TraceStep[] = []; + private handlers: Set = new Set(); + private sources: Set = new Set(); + private startTime: number; + private stepCount = 0; + + constructor() { + this.startTime = performance.now(); + } + + /** + * Record a step in the evaluation process + */ + step(action: string, result: string, options?: { + target?: string; + evidence?: EvidenceItem[]; + decision?: string; + confidence?: number; + }): void { + this.stepCount++; + this.steps.push({ + step: this.stepCount, + action, + result, + target: options?.target, + evidence_gathered: options?.evidence, + decision: options?.decision, + confidence: options?.confidence, + }); + } + + /** + * Record that a handler was invoked + */ + handler(name: string): void { + this.handlers.add(name); + } + + /** + * Record a state source that was used + */ + source(name: string): void { + this.sources.add(name); + } + + /** + * Build the final trace object + */ + build(): ReasoningTrace { + return { + steps: this.steps, + duration_ms: Math.round(performance.now() - this.startTime), + handlers_invoked: Array.from(this.handlers), + state_sources: Array.from(this.sources), + }; + } +} + +/** + * Build verification instructions for a resource + */ +export function buildVerificationInstructions( + resourceType: string, + resourceId: string | undefined, + recoverabilityTier: number, + stateSnapshot?: Record +): VerificationInstructions { + const commands: VerificationCommand[] = []; + const apiChecks: ApiCheck[] = []; + + // AWS-specific verification commands + if (resourceType.startsWith('aws_')) { + const service = resourceType.split('_')[1]; + + switch (resourceType) { + case 'aws_s3_bucket': + if (resourceId) { + commands.push({ + description: 'Check bucket exists and get object count', + command: `aws s3api list-objects-v2 --bucket ${resourceId} --query 'length(Contents || \`[]\`)'`, + expected_pattern: '\\d+', + confirms: 'object_count', + }); + commands.push({ + description: 'Check bucket versioning status', + command: `aws s3api get-bucket-versioning --bucket ${resourceId}`, + confirms: 'versioning_enabled', + }); + apiChecks.push({ + service: 's3', + operation: 'ListObjectsV2', + parameters: { Bucket: resourceId }, + }); + } + break; + + case 'aws_db_instance': + if (resourceId) { + commands.push({ + description: 'Check RDS instance backup configuration', + command: `aws rds describe-db-instances --db-instance-identifier ${resourceId} --query 'DBInstances[0].{BackupRetention:BackupRetentionPeriod,DeletionProtection:DeletionProtection}'`, + confirms: 'backup_configuration', + }); + commands.push({ + description: 'Check for existing snapshots', + command: `aws rds describe-db-snapshots --db-instance-identifier ${resourceId} --query 'length(DBSnapshots)'`, + expected_pattern: '\\d+', + confirms: 'snapshot_count', + }); + apiChecks.push({ + service: 'rds', + operation: 'DescribeDBInstances', + parameters: { DBInstanceIdentifier: resourceId }, + }); + } + break; + + case 'aws_dynamodb_table': + if (resourceId) { + commands.push({ + description: 'Check DynamoDB table backup status', + command: `aws dynamodb describe-continuous-backups --table-name ${resourceId}`, + confirms: 'pitr_enabled', + }); + commands.push({ + description: 'Check deletion protection', + command: `aws dynamodb describe-table --table-name ${resourceId} --query 'Table.DeletionProtectionEnabled'`, + confirms: 'deletion_protection', + }); + } + break; + + case 'aws_ebs_volume': + if (resourceId) { + commands.push({ + description: 'Check for existing snapshots of this volume', + command: `aws ec2 describe-snapshots --filters "Name=volume-id,Values=${resourceId}" --query 'length(Snapshots)'`, + expected_pattern: '\\d+', + confirms: 'snapshot_exists', + }); + } + break; + + case 'aws_kms_key': + if (resourceId) { + commands.push({ + description: 'Check KMS key deletion window', + command: `aws kms describe-key --key-id ${resourceId} --query 'KeyMetadata.DeletionDate'`, + confirms: 'deletion_window', + }); + } + break; + + default: + // Generic AWS resource check + if (resourceId && service) { + commands.push({ + description: `Verify ${resourceType} state`, + command: `aws ${service} describe-* (resource-specific command needed)`, + confirms: 'resource_exists', + }); + } + } + } + + // Determine reproducibility based on tier and resource type + let reproducibility: 'deterministic' | 'state-dependent' | 'time-sensitive' = 'state-dependent'; + + if (recoverabilityTier <= 2) { + reproducibility = 'deterministic'; + } else if (resourceType.includes('snapshot') || resourceType.includes('backup')) { + reproducibility = 'time-sensitive'; + } + + return { + commands: commands.length > 0 ? commands : undefined, + api_checks: apiChecks.length > 0 ? apiChecks : undefined, + reproducibility, + state_snapshot: stateSnapshot ? { + captured_at: new Date().toISOString(), + resources: stateSnapshot, + } : undefined, + }; +} + +/** + * Create a trace for a simple pass-through evaluation + */ +export function createSimpleTrace( + inputType: string, + verdict: string, + reason: string +): ReasoningTrace { + const builder = new TraceBuilder(); + builder.step('parse_input', `Parsed ${inputType} input`); + builder.step('evaluate', reason, { decision: verdict }); + return builder.build(); +} diff --git a/src/mcp/server.ts b/src/mcp/server.ts index 52e9a4a..d69d0b1 100644 --- a/src/mcp/server.ts +++ b/src/mcp/server.ts @@ -8,11 +8,12 @@ import { } from '../evaluator/index.js'; import { getSupportedResourceTypes } from '../resources/index.js'; import { toConsequenceJson } from '../output/consequence-json.js'; -import type { ConsequenceReport, EvidenceSubmission } from '../core/index.js'; +import type { ConsequenceReport, EvidenceSubmission, VerificationSuggestion } from '../core/index.js'; import type { McpToolCall } from '../adapters/index.js'; import type { AdapterContext } from '../adapters/types.js'; import type { TerraformPlan, TerraformState } from '../resources/types.js'; import { getAttestationService, type AttestationService } from '../attestation/service.js'; +import { interpretVerificationOutput, type MatchResult } from '../verification/index.js'; const SCHEMA_VERSION = 'recourse.consequence.v1'; @@ -655,39 +656,108 @@ function evaluateWithEvidence(args: Record): ConsequenceReport }; } +/** + * Evidence evaluation result with pattern matching details. + */ +interface EvidenceEvaluationResult { + evidence_key: string; + agent_interpretation: EvidenceSubmission['agent_interpretation']; + pattern_interpretation?: MatchResult; + final_interpretation: EvidenceSubmission['agent_interpretation']; + confirms_recovery: boolean; + details: string; +} + +/** + * Evaluate evidence using pattern matching when available. + */ +function evaluateEvidenceItem( + submission: EvidenceSubmission, + originalSuggestions: VerificationSuggestion[] +): EvidenceEvaluationResult { + // Find matching verification suggestion by evidence_key + const suggestion = originalSuggestions.find(s => s.evidence_key === submission.evidence_key); + + // If we have structured patterns, use them + if (suggestion?.expected_pattern && submission.raw_output) { + const patternResult = interpretVerificationOutput( + submission.raw_output, + submission.exit_code ?? 0, + suggestion.expected_pattern, + suggestion.failure_pattern + ); + + // Pattern matching provides more reliable interpretation + return { + evidence_key: submission.evidence_key, + agent_interpretation: submission.agent_interpretation, + pattern_interpretation: patternResult, + // Trust pattern matching over agent interpretation for structured output + final_interpretation: patternResult.interpretation, + confirms_recovery: patternResult.matches, + details: patternResult.reason, + }; + } + + // Fall back to agent interpretation + return { + evidence_key: submission.evidence_key, + agent_interpretation: submission.agent_interpretation, + final_interpretation: submission.agent_interpretation, + confirms_recovery: submission.agent_interpretation === 'matches_expected', + details: submission.agent_notes || 'Agent-provided interpretation', + }; +} + function upgradeVerdictWithEvidence( baseReport: ConsequenceReport, evidence: EvidenceSubmission[] ): ConsequenceReport { - // Find evidence that matches expected signals - const confirmedEvidence = evidence.filter(e => e.agent_interpretation === 'matches_expected'); + // Get original verification suggestions for pattern matching + const originalSuggestions = baseReport.verificationSuggestions || []; + + // Evaluate all evidence with pattern matching + const evaluatedEvidence = evidence.map(e => evaluateEvidenceItem(e, originalSuggestions)); + + // Find evidence that confirms recovery paths + const confirmedEvidence = evaluatedEvidence.filter(e => e.confirms_recovery); + const failedEvidence = evaluatedEvidence.filter(e => + e.final_interpretation === 'matches_failure' || + e.final_interpretation === 'error' + ); // Update mutations with the new evidence const updatedMutations = baseReport.mutations.map(mutation => { - // Check if any evidence applies to this mutation + // Check if any confirmed evidence applies to this mutation const relevantEvidence = confirmedEvidence.filter(e => e.evidence_key.includes('snapshot') || e.evidence_key.includes('backup') || e.evidence_key.includes('replication') || - e.evidence_key.includes('versioning') + e.evidence_key.includes('versioning') || + e.evidence_key.includes('recovery') ); if (relevantEvidence.length > 0 && mutation.recoverability.tier === 4) { + // Build detailed reasoning from evidence + const evidenceDetails = relevantEvidence + .map(e => `${e.evidence_key}: ${e.details}`) + .join('; '); + // Upgrade from unrecoverable to recoverable-from-backup return { ...mutation, recoverability: { tier: 3, label: 'recoverable-from-backup', - reasoning: `External backup verified: ${relevantEvidence.map(e => e.evidence_key).join(', ')}`, + reasoning: `External backup verified: ${evidenceDetails}`, }, evidence: [ ...mutation.evidence, ...relevantEvidence.map(e => ({ key: e.evidence_key, - value: e.parsed_evidence, + value: e.pattern_interpretation?.extractedValue, present: true, - description: e.agent_notes || 'Verified by agent', + description: e.details, })), ], }; @@ -698,10 +768,19 @@ function upgradeVerdictWithEvidence( // Determine new risk assessment based on updated recoverability const hasUnrecoverable = updatedMutations.some(m => m.recoverability.tier === 4); - const newAssessment = hasUnrecoverable ? baseReport.riskAssessment : 'warn'; - const newReason = hasUnrecoverable - ? baseReport.assessmentReason - : 'External backup verified - proceed with caution'; + + // Build assessment reason with evidence summary + const verifiedCount = confirmedEvidence.length; + const failedCount = failedEvidence.length; + let newAssessment = baseReport.riskAssessment; + let newReason = baseReport.assessmentReason; + + if (verifiedCount > 0 && !hasUnrecoverable) { + newAssessment = 'warn'; + newReason = `${verifiedCount} recovery path(s) verified: ${confirmedEvidence.map(e => e.evidence_key).join(', ')}`; + } else if (failedCount > 0) { + newReason = `Evidence checked: ${failedCount} failed verification, ${verifiedCount} confirmed`; + } return { ...baseReport, @@ -710,6 +789,11 @@ function upgradeVerdictWithEvidence( assessmentReason: newReason, verificationProtocolVersion: 'v1', verificationSuggestions: [], // Clear since verification was completed + // Include evaluation results for transparency + verificationStatus: { + status: verifiedCount > 0 ? 'suggestions_available' : 'no_suggestions_available', + reason: `Evaluated ${evidence.length} evidence item(s): ${verifiedCount} confirmed, ${failedCount} failed`, + }, summary: { ...baseReport.summary, hasUnrecoverable, diff --git a/src/output/json.ts b/src/output/json.ts index 52144b2..18b4464 100644 --- a/src/output/json.ts +++ b/src/output/json.ts @@ -13,6 +13,10 @@ export interface JsonOutput { cascadeImpactCount: number; hasUnrecoverable: boolean; worstTier: string; + // Enhanced cascade analysis + cascadeByType?: Record; + cascadeSummary?: string; + maxCascadeDepth?: number; }; changes: Array<{ address: string; @@ -25,7 +29,10 @@ export interface JsonOutput { }; cascadeImpact: Array<{ affectedResource: string; + resourceType: string; reason: string; + depth: number; + dependencyType: 'explicit' | 'implicit'; }>; }>; } @@ -58,6 +65,10 @@ export function toJsonOutput(report: BlastRadiusReport): JsonOutput { cascadeImpactCount: summary.cascadeImpactCount, hasUnrecoverable: summary.hasUnrecoverable, worstTier: RecoverabilityLabels[worstTier], + // Enhanced cascade analysis + cascadeByType: summary.cascadeByType, + cascadeSummary: summary.cascadeSummary, + maxCascadeDepth: summary.maxCascadeDepth, }, changes: changes.map(change => ({ address: change.resource.address, @@ -68,7 +79,13 @@ export function toJsonOutput(report: BlastRadiusReport): JsonOutput { label: change.recoverability.label, reasoning: change.recoverability.reasoning, }, - cascadeImpact: change.cascadeImpact, + cascadeImpact: change.cascadeImpact.map(impact => ({ + affectedResource: impact.affectedResource, + resourceType: impact.resourceType, + reason: impact.reason, + depth: impact.depth, + dependencyType: impact.dependencyType, + })), })), }; } diff --git a/src/resources/types.ts b/src/resources/types.ts index 48e67e0..406447d 100644 --- a/src/resources/types.ts +++ b/src/resources/types.ts @@ -85,7 +85,10 @@ export interface BlastRadiusChange { export interface CascadeImpact { affectedResource: string; + resourceType: string; reason: string; + depth: number; // 1 = direct dependent, 2+ = transitive + dependencyType: 'explicit' | 'implicit'; } export interface BlastRadiusReport { @@ -98,6 +101,10 @@ export interface BlastRadiusSummary { byTier: Record; cascadeImpactCount: number; hasUnrecoverable: boolean; + // Enhanced cascade summary + cascadeByType?: Record; // e.g., { "aws_subnet": 3, "aws_instance": 14 } + maxCascadeDepth?: number; // Maximum depth of cascade chain + cascadeSummary?: string; // Human-readable: "3 subnets, 14 EC2 instances, 1 RDS cluster" } // Import trace types diff --git a/src/state/aws/rds.ts b/src/state/aws/rds.ts index 2d5c4cf..94245ab 100644 --- a/src/state/aws/rds.ts +++ b/src/state/aws/rds.ts @@ -77,13 +77,14 @@ export function analyzeRdsInstanceDeletionEvidence( ): RdsEvidenceAnalysis { const evidenceItems = toEvidenceItems(evidence); const missingEvidence = toMissingEvidence(evidence.missingEvidence ?? []); + const protections = buildProtectionSummary(evidence); if (evidence.deletionProtection === true) { return { recoverability: { tier: RecoverabilityTier.REVERSIBLE, label: RecoverabilityLabels[RecoverabilityTier.REVERSIBLE], - reasoning: 'RDS deletion protection is enabled; delete attempts should be blocked by AWS until protection is disabled', + reasoning: `RDS instance '${evidence.dbInstanceIdentifier}'${protections} has deletion protection enabled; delete attempts will be blocked by AWS`, source: 'rules', confidence: 0.95, }, @@ -97,11 +98,28 @@ export function analyzeRdsInstanceDeletionEvidence( || Boolean(evidence.latestRestorableTime) || (evidence.snapshotCount ?? 0) > 0 ) { + // Build specific recovery info + const recoveryOptions: string[] = []; + if ((evidence.snapshotCount ?? 0) > 0) { + const snapInfo = `${evidence.snapshotCount} snapshot${evidence.snapshotCount !== 1 ? 's' : ''}`; + if (evidence.latestSnapshotTime) { + recoveryOptions.push(`${snapInfo} (latest: ${formatTimeAgo(evidence.latestSnapshotTime)})`); + } else { + recoveryOptions.push(snapInfo); + } + } + if (evidence.latestRestorableTime) { + recoveryOptions.push(`PITR available`); + } + if ((evidence.backupRetentionPeriod ?? 0) > 0) { + recoveryOptions.push(`${evidence.backupRetentionPeriod}-day automated backups`); + } + return { recoverability: { tier: RecoverabilityTier.RECOVERABLE_FROM_BACKUP, label: RecoverabilityLabels[RecoverabilityTier.RECOVERABLE_FROM_BACKUP], - reasoning: 'RDS backups, point-in-time restore, or snapshots are available for this instance', + reasoning: `RDS instance '${evidence.dbInstanceIdentifier}'${evidence.engine ? ` (${evidence.engine})` : ''} is recoverable: ${recoveryOptions.join(', ')}`, source: 'rules', confidence: 0.9, }, @@ -115,7 +133,7 @@ export function analyzeRdsInstanceDeletionEvidence( recoverability: { tier: RecoverabilityTier.NEEDS_REVIEW, label: RecoverabilityLabels[RecoverabilityTier.NEEDS_REVIEW], - reasoning: 'RDS deletion cannot be classified safely without complete instance and snapshot evidence', + reasoning: `RDS instance '${evidence.dbInstanceIdentifier}' deletion cannot be classified safely without complete instance and snapshot evidence`, source: 'rules', confidence: 0.45, }, @@ -128,7 +146,7 @@ export function analyzeRdsInstanceDeletionEvidence( recoverability: { tier: RecoverabilityTier.UNRECOVERABLE, label: RecoverabilityLabels[RecoverabilityTier.UNRECOVERABLE], - reasoning: 'RDS instance has no deletion protection, backup retention, latest restorable time, or snapshots', + reasoning: `RDS instance '${evidence.dbInstanceIdentifier}'${evidence.engine ? ` (${evidence.engine})` : ''} has no deletion protection, no automated backups, no PITR, and no snapshots; deletion is UNRECOVERABLE`, source: 'rules', confidence: 0.9, }, @@ -197,24 +215,85 @@ function isUnavailable(statusCode: number): boolean { return statusCode === 0 || statusCode === 403 || statusCode >= 500; } +/** + * Format time ago (e.g., "2 hours ago", "3 days ago") + */ +function formatTimeAgo(isoDate: string): string { + const date = new Date(isoDate); + const now = new Date(); + const diffMs = now.getTime() - date.getTime(); + const diffMins = Math.floor(diffMs / 60000); + const diffHours = Math.floor(diffMs / 3600000); + const diffDays = Math.floor(diffMs / 86400000); + + if (diffMins < 60) return `${diffMins} minute${diffMins !== 1 ? 's' : ''} ago`; + if (diffHours < 24) return `${diffHours} hour${diffHours !== 1 ? 's' : ''} ago`; + if (diffDays < 30) return `${diffDays} day${diffDays !== 1 ? 's' : ''} ago`; + return `on ${date.toISOString().split('T')[0]}`; +} + +/** + * Build a protection summary string for reasoning + */ +function buildProtectionSummary(evidence: RdsInstanceEvidence): string { + const parts: string[] = []; + + if (evidence.engine) { + parts.push(evidence.engine); + } + + if ((evidence.backupRetentionPeriod ?? 0) > 0) { + parts.push(`${evidence.backupRetentionPeriod}-day backup retention`); + } + + if ((evidence.snapshotCount ?? 0) > 0) { + const snapInfo = `${evidence.snapshotCount} snapshot${evidence.snapshotCount !== 1 ? 's' : ''}`; + if (evidence.latestSnapshotTime) { + parts.push(`${snapInfo}, latest ${formatTimeAgo(evidence.latestSnapshotTime)}`); + } else { + parts.push(snapInfo); + } + } + + if (evidence.latestRestorableTime) { + parts.push(`PITR available to ${formatTimeAgo(evidence.latestRestorableTime)}`); + } + + if (evidence.multiAz) { + parts.push('Multi-AZ'); + } + + if ((evidence.readReplicas?.length ?? 0) > 0) { + parts.push(`${evidence.readReplicas!.length} read replica${evidence.readReplicas!.length !== 1 ? 's' : ''}`); + } + + return parts.length > 0 ? ` (${parts.join(', ')})` : ''; +} + function toEvidenceItems(evidence: RdsInstanceEvidence): EvidenceItem[] { - return [ + const items: EvidenceItem[] = [ { key: 'rds.instance', value: evidence.dbInstanceIdentifier, present: true, description: 'RDS instance targeted by the mutation', }, + { + key: 'rds.engine', + value: evidence.engine, + present: Boolean(evidence.engine), + description: 'RDS database engine type', + }, { key: 'rds.deletion_protection', value: evidence.deletionProtection, - present: evidence.deletionProtection === true, + present: evidence.deletionProtection !== undefined, description: 'RDS deletion protection setting', }, { key: 'rds.backup_retention_period', value: evidence.backupRetentionPeriod, - present: (evidence.backupRetentionPeriod ?? 0) > 0, + present: evidence.backupRetentionPeriod !== undefined, description: 'RDS automated backup retention period in days', }, { @@ -226,13 +305,19 @@ function toEvidenceItems(evidence: RdsInstanceEvidence): EvidenceItem[] { { key: 'rds.snapshot_count', value: evidence.snapshotCount, - present: (evidence.snapshotCount ?? 0) > 0, - description: 'RDS snapshots associated with the DB instance', + present: evidence.snapshotCount !== undefined, + description: 'Number of manual snapshots for this DB instance', + }, + { + key: 'rds.latest_snapshot_time', + value: evidence.latestSnapshotTime, + present: Boolean(evidence.latestSnapshotTime), + description: 'Most recent snapshot creation timestamp', }, { key: 'rds.multi_az', value: evidence.multiAz, - present: evidence.multiAz === true, + present: evidence.multiAz !== undefined, description: 'RDS Multi-AZ deployment setting', }, { @@ -242,6 +327,8 @@ function toEvidenceItems(evidence: RdsInstanceEvidence): EvidenceItem[] { description: 'RDS read replicas attached to the DB instance', }, ]; + + return items; } function toMissingEvidence(keys: string[]): MissingEvidence[] { diff --git a/src/state/aws/s3.ts b/src/state/aws/s3.ts index 0a020a3..f4b4104 100644 --- a/src/state/aws/s3.ts +++ b/src/state/aws/s3.ts @@ -21,6 +21,11 @@ export interface S3BucketEvidence { isEmpty?: boolean; tags?: Record; missingEvidence?: string[]; + // Enhanced metrics for consequence reasoning + objectCount?: number; + totalSizeBytes?: number; + lastModified?: string; + sampleSize?: number; // How many objects we sampled (for large buckets) } export interface S3EvidenceAnalysis { @@ -39,9 +44,12 @@ export async function readS3BucketEvidence( requestOptional(client, bucket, region, 'object-lock='), requestOptional(client, bucket, region, 'replication='), requestOptional(client, bucket, region, 'lifecycle='), - requestOptional(client, bucket, region, 'list-type=2&max-keys=1'), + requestOptional(client, bucket, region, 'list-type=2&max-keys=1000'), // Get up to 1000 objects for metrics ]); + // Parse object metrics from list response + const { objectCount, totalSizeBytes, lastModified, hasMore } = parseObjectMetrics(objectList.body); + return { bucket, region, @@ -53,8 +61,12 @@ export async function readS3BucketEvidence( hasReplication: replication.statusCode === 200 && //.test(lifecycle.body), isEmpty: objectList.statusCode === 200 - ? !//.test(objectList.body) + ? objectCount === 0 : undefined, + objectCount: hasMore ? undefined : objectCount, // Only report exact count if we got all objects + totalSizeBytes: hasMore ? undefined : totalSizeBytes, + lastModified, + sampleSize: hasMore ? objectCount : undefined, // Report sample size if we didn't get all missingEvidence: [ isUnavailable(versioning.statusCode) ? 's3.versioning' : '', isUnavailable(objectLock.statusCode) ? 's3.object_lock' : '', @@ -65,18 +77,104 @@ export async function readS3BucketEvidence( }; } +function parseObjectMetrics(body: string): { + objectCount: number; + totalSizeBytes: number; + lastModified: string | undefined; + hasMore: boolean; +} { + const contents = body.match(/[\s\S]*?<\/Contents>/g) || []; + let totalSizeBytes = 0; + let lastModified: string | undefined; + + for (const content of contents) { + const sizeMatch = content.match(/(\d+)<\/Size>/); + if (sizeMatch) { + totalSizeBytes += parseInt(sizeMatch[1], 10); + } + + const dateMatch = content.match(/([^<]+)<\/LastModified>/); + if (dateMatch) { + if (!lastModified || dateMatch[1] > lastModified) { + lastModified = dateMatch[1]; + } + } + } + + const isTruncated = /true<\/IsTruncated>/i.test(body); + + return { + objectCount: contents.length, + totalSizeBytes, + lastModified, + hasMore: isTruncated, + }; +} + +/** + * Format bytes to human-readable string (e.g., "47.2 GB") + */ +function formatBytes(bytes: number): string { + if (bytes === 0) return '0 B'; + const units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB']; + const i = Math.floor(Math.log(bytes) / Math.log(1024)); + const value = bytes / Math.pow(1024, i); + return `${value.toFixed(value < 10 ? 1 : 0)} ${units[i]}`; +} + +/** + * Format time ago (e.g., "2 hours ago", "3 days ago") + */ +function formatTimeAgo(isoDate: string): string { + const date = new Date(isoDate); + const now = new Date(); + const diffMs = now.getTime() - date.getTime(); + const diffMins = Math.floor(diffMs / 60000); + const diffHours = Math.floor(diffMs / 3600000); + const diffDays = Math.floor(diffMs / 86400000); + + if (diffMins < 60) return `${diffMins} minute${diffMins !== 1 ? 's' : ''} ago`; + if (diffHours < 24) return `${diffHours} hour${diffHours !== 1 ? 's' : ''} ago`; + if (diffDays < 30) return `${diffDays} day${diffDays !== 1 ? 's' : ''} ago`; + return `on ${date.toISOString().split('T')[0]}`; +} + +/** + * Build a metrics summary string for reasoning + */ +function buildMetricsSummary(evidence: S3BucketEvidence): string { + const parts: string[] = []; + + if (evidence.objectCount !== undefined) { + parts.push(`${evidence.objectCount.toLocaleString()} object${evidence.objectCount !== 1 ? 's' : ''}`); + } else if (evidence.sampleSize !== undefined) { + parts.push(`${evidence.sampleSize.toLocaleString()}+ objects`); + } + + if (evidence.totalSizeBytes !== undefined && evidence.totalSizeBytes > 0) { + parts.push(formatBytes(evidence.totalSizeBytes)); + } + + if (evidence.lastModified) { + parts.push(`last modified ${formatTimeAgo(evidence.lastModified)}`); + } + + return parts.length > 0 ? ` (${parts.join(', ')})` : ''; +} + export function analyzeS3BucketDeletionEvidence( evidence: S3BucketEvidence ): S3EvidenceAnalysis { const evidenceItems = toEvidenceItems(evidence); const missingEvidence = toMissingEvidence(evidence.missingEvidence ?? []); + const metrics = buildMetricsSummary(evidence); if (evidence.objectLockEnabled) { return { recoverability: { tier: RecoverabilityTier.REVERSIBLE, label: RecoverabilityLabels[RecoverabilityTier.REVERSIBLE], - reasoning: 'S3 object lock is enabled; destructive deletion is constrained by retention controls', + reasoning: `S3 bucket '${evidence.bucket}'${metrics} has object lock enabled; destructive deletion is constrained by retention controls`, source: 'rules', confidence: 0.95, }, @@ -90,7 +188,7 @@ export function analyzeS3BucketDeletionEvidence( recoverability: { tier: RecoverabilityTier.RECOVERABLE_WITH_EFFORT, label: RecoverabilityLabels[RecoverabilityTier.RECOVERABLE_WITH_EFFORT], - reasoning: 'S3 bucket appears empty; bucket deletion can be recreated but metadata may require manual restoration', + reasoning: `S3 bucket '${evidence.bucket}' is empty; bucket deletion can be recreated but metadata may require manual restoration`, source: 'rules', confidence: 0.8, }, @@ -100,11 +198,14 @@ export function analyzeS3BucketDeletionEvidence( } if (evidence.versioning === 'Enabled' || evidence.hasReplication) { + const protections: string[] = []; + if (evidence.versioning === 'Enabled') protections.push('versioning enabled'); + if (evidence.hasReplication) protections.push('replication configured'); return { recoverability: { tier: RecoverabilityTier.RECOVERABLE_FROM_BACKUP, label: RecoverabilityLabels[RecoverabilityTier.RECOVERABLE_FROM_BACKUP], - reasoning: 'S3 bucket has versioning or replication evidence that may support object recovery', + reasoning: `S3 bucket '${evidence.bucket}'${metrics} has ${protections.join(' and ')}; objects may be recoverable`, source: 'rules', confidence: 0.85, }, @@ -118,7 +219,7 @@ export function analyzeS3BucketDeletionEvidence( recoverability: { tier: RecoverabilityTier.NEEDS_REVIEW, label: RecoverabilityLabels[RecoverabilityTier.NEEDS_REVIEW], - reasoning: 'S3 bucket deletion cannot be classified safely without complete live-state evidence', + reasoning: `S3 bucket '${evidence.bucket}' deletion cannot be classified safely without complete live-state evidence`, source: 'rules', confidence: 0.45, }, @@ -131,7 +232,7 @@ export function analyzeS3BucketDeletionEvidence( recoverability: { tier: RecoverabilityTier.UNRECOVERABLE, label: RecoverabilityLabels[RecoverabilityTier.UNRECOVERABLE], - reasoning: 'S3 bucket contains objects and no versioning, object lock, or replication evidence was found', + reasoning: `S3 bucket '${evidence.bucket}'${metrics} has no versioning, object lock, or replication; deletion is UNRECOVERABLE`, source: 'rules', confidence: 0.9, }, @@ -177,7 +278,7 @@ function toEvidenceItems(evidence: S3BucketEvidence): EvidenceItem[] { // A value of 'Unknown' or undefined means evidence was not gathered const missingSet = new Set(evidence.missingEvidence ?? []); - return [ + const items: EvidenceItem[] = [ { key: 's3.bucket', value: evidence.bucket, @@ -215,6 +316,45 @@ function toEvidenceItems(evidence: S3BucketEvidence): EvidenceItem[] { description: 'Whether live listing found objects in the bucket', }, ]; + + // Add concrete metrics if available + if (evidence.objectCount !== undefined) { + items.push({ + key: 's3.object_count', + value: evidence.objectCount, + present: true, + description: 'Number of objects in the bucket', + }); + } + + if (evidence.totalSizeBytes !== undefined) { + items.push({ + key: 's3.total_size_bytes', + value: evidence.totalSizeBytes, + present: true, + description: 'Total size of objects in the bucket (bytes)', + }); + } + + if (evidence.lastModified !== undefined) { + items.push({ + key: 's3.last_modified', + value: evidence.lastModified, + present: true, + description: 'Most recent object modification timestamp', + }); + } + + if (evidence.sampleSize !== undefined) { + items.push({ + key: 's3.sample_size', + value: evidence.sampleSize, + present: true, + description: 'Number of objects sampled (bucket has more than this)', + }); + } + + return items; } function toMissingEvidence(keys: string[]): MissingEvidence[] { diff --git a/src/verification/index.ts b/src/verification/index.ts index 5c3ce47..ffe75f9 100644 --- a/src/verification/index.ts +++ b/src/verification/index.ts @@ -54,6 +54,10 @@ export { export type { ResourceContext } from './templates.js'; export { generateVerificationSuggestions } from './templates.js'; +// Pattern matching +export type { MatchResult } from './pattern-matcher.js'; +export { matchPattern, interpretVerificationOutput } from './pattern-matcher.js'; + // Main function: classify + generate import { classifyResourceType, defaultClassifier } from './classifier.js'; import { generateVerificationSuggestions, type ResourceContext } from './templates.js'; diff --git a/src/verification/pattern-matcher.ts b/src/verification/pattern-matcher.ts new file mode 100644 index 0000000..fdee934 --- /dev/null +++ b/src/verification/pattern-matcher.ts @@ -0,0 +1,327 @@ +/** + * Pattern Matcher + * + * Automatically interprets verification command output using structured patterns. + * This enables agents to automatically determine if evidence confirms recovery paths + * without manual interpretation. + */ + +import type { OutputPattern, AgentInterpretation } from '../core/mutation.js'; + +export interface MatchResult { + matches: boolean; + interpretation: AgentInterpretation; + reason: string; + extractedValue?: unknown; +} + +/** + * Match verification output against an expected pattern. + */ +export function matchPattern( + output: string, + exitCode: number, + pattern: OutputPattern | undefined +): MatchResult { + if (!pattern) { + return { + matches: false, + interpretation: 'ambiguous', + reason: 'No pattern defined for automatic matching', + }; + } + + try { + switch (pattern.type) { + case 'exit_code': + return matchExitCode(exitCode, pattern.expected_exit_code ?? 0); + + case 'json_array_not_empty': + return matchJsonArrayNotEmpty(output); + + case 'json_field_equals': + return matchJsonFieldEquals(output, pattern.path!, pattern.expected_value); + + case 'json_field_exists': + return matchJsonFieldExists(output, pattern.path!); + + case 'regex': + return matchRegex(output, pattern.regex!); + + default: + return { + matches: false, + interpretation: 'ambiguous', + reason: `Unknown pattern type: ${(pattern as OutputPattern).type}`, + }; + } + } catch (error) { + return { + matches: false, + interpretation: 'error', + reason: `Pattern matching failed: ${error instanceof Error ? error.message : String(error)}`, + }; + } +} + +/** + * Auto-interpret verification output using expected and failure patterns. + */ +export function interpretVerificationOutput( + output: string, + exitCode: number, + expectedPattern?: OutputPattern, + failurePattern?: OutputPattern +): MatchResult { + // First check exit code + if (exitCode !== 0) { + // Non-zero exit code usually indicates error + // Check if the output contains error indicators + if (output.includes('error') || output.includes('Error') || output.includes('AccessDenied')) { + return { + matches: false, + interpretation: 'error', + reason: `Command failed with exit code ${exitCode}`, + }; + } + // Some commands return non-zero for "not found" which is valid failure signal + if (failurePattern) { + const failureMatch = matchPattern(output, exitCode, failurePattern); + if (failureMatch.matches) { + return { + matches: false, + interpretation: 'matches_failure', + reason: failureMatch.reason, + }; + } + } + return { + matches: false, + interpretation: 'error', + reason: `Command failed with exit code ${exitCode}`, + }; + } + + // Check expected pattern first + if (expectedPattern) { + const expectedMatch = matchPattern(output, exitCode, expectedPattern); + if (expectedMatch.matches) { + return { + matches: true, + interpretation: 'matches_expected', + reason: expectedMatch.reason, + extractedValue: expectedMatch.extractedValue, + }; + } + } + + // Check failure pattern + if (failurePattern) { + const failureMatch = matchPattern(output, exitCode, failurePattern); + if (failureMatch.matches) { + return { + matches: false, + interpretation: 'matches_failure', + reason: failureMatch.reason, + }; + } + } + + // If we have an expected pattern and it didn't match, treat as failure + if (expectedPattern) { + return { + matches: false, + interpretation: 'matches_failure', + reason: 'Expected pattern not found in output', + }; + } + + // No patterns to match + return { + matches: false, + interpretation: 'ambiguous', + reason: 'No patterns defined for automatic matching', + }; +} + +// Pattern matching implementations + +function matchExitCode(actual: number, expected: number): MatchResult { + const matches = actual === expected; + return { + matches, + interpretation: matches ? 'matches_expected' : 'matches_failure', + reason: matches ? `Exit code ${actual} matches expected ${expected}` : `Exit code ${actual} does not match expected ${expected}`, + }; +} + +function matchJsonArrayNotEmpty(output: string): MatchResult { + const trimmed = output.trim(); + + // Handle empty output + if (!trimmed || trimmed === 'null') { + return { + matches: false, + interpretation: 'matches_failure', + reason: 'Output is empty or null', + }; + } + + try { + const parsed = JSON.parse(trimmed); + + if (Array.isArray(parsed)) { + if (parsed.length > 0) { + return { + matches: true, + interpretation: 'matches_expected', + reason: `Array contains ${parsed.length} item(s)`, + extractedValue: parsed.length, + }; + } + return { + matches: false, + interpretation: 'matches_failure', + reason: 'Array is empty', + }; + } + + return { + matches: false, + interpretation: 'ambiguous', + reason: 'Output is not an array', + }; + } catch { + return { + matches: false, + interpretation: 'error', + reason: 'Failed to parse output as JSON', + }; + } +} + +function matchJsonFieldEquals(output: string, path: string, expectedValue: unknown): MatchResult { + try { + const parsed = JSON.parse(output.trim()); + const value = getNestedValue(parsed, path); + + if (value === undefined) { + return { + matches: false, + interpretation: 'matches_failure', + reason: `Field '${path}' not found in output`, + }; + } + + if (value === expectedValue) { + return { + matches: true, + interpretation: 'matches_expected', + reason: `Field '${path}' equals '${expectedValue}'`, + extractedValue: value, + }; + } + + return { + matches: false, + interpretation: 'matches_failure', + reason: `Field '${path}' is '${value}', not '${expectedValue}'`, + extractedValue: value, + }; + } catch { + return { + matches: false, + interpretation: 'error', + reason: 'Failed to parse output as JSON', + }; + } +} + +function matchJsonFieldExists(output: string, path: string): MatchResult { + try { + const parsed = JSON.parse(output.trim()); + const value = getNestedValue(parsed, path); + + if (value !== undefined && value !== null) { + // For arrays, check if non-empty + if (Array.isArray(value) && value.length === 0) { + return { + matches: false, + interpretation: 'matches_failure', + reason: `Field '${path}' exists but is an empty array`, + extractedValue: value, + }; + } + + return { + matches: true, + interpretation: 'matches_expected', + reason: `Field '${path}' exists`, + extractedValue: value, + }; + } + + return { + matches: false, + interpretation: 'matches_failure', + reason: `Field '${path}' does not exist`, + }; + } catch { + return { + matches: false, + interpretation: 'error', + reason: 'Failed to parse output as JSON', + }; + } +} + +function matchRegex(output: string, pattern: string): MatchResult { + try { + const regex = new RegExp(pattern); + const match = regex.exec(output); + + if (match) { + return { + matches: true, + interpretation: 'matches_expected', + reason: `Regex pattern matched: ${match[0]}`, + extractedValue: match[0], + }; + } + + return { + matches: false, + interpretation: 'matches_failure', + reason: 'Regex pattern not found in output', + }; + } catch (error) { + return { + matches: false, + interpretation: 'error', + reason: `Invalid regex pattern: ${error instanceof Error ? error.message : String(error)}`, + }; + } +} + +/** + * Get nested value from object using dot notation path. + * Example: getNestedValue({a: {b: 1}}, 'a.b') => 1 + */ +function getNestedValue(obj: unknown, path: string): unknown { + const parts = path.split('.'); + let current: unknown = obj; + + for (const part of parts) { + if (current === null || current === undefined) { + return undefined; + } + + if (typeof current !== 'object') { + return undefined; + } + + current = (current as Record)[part]; + } + + return current; +} diff --git a/src/verification/templates.ts b/src/verification/templates.ts index 99d4f58..8c32bd3 100644 --- a/src/verification/templates.ts +++ b/src/verification/templates.ts @@ -120,6 +120,14 @@ const TEMPLATES: Record = { }, expected_signal: 'Non-empty array with Status=available indicates manual snapshot exists', failure_signal: 'Empty array indicates no manual snapshots', + expected_pattern: { + type: 'json_array_not_empty', + }, + failure_pattern: { + type: 'json_array_not_empty', + // Inverted logic - if array IS empty, it's a failure + }, + example_output: '[{"Id": "prod-db-2024-01-15", "Status": "available"}]', verdict_impact: { current_tier: 'unrecoverable', potential_tier: 'recoverable-from-backup', @@ -146,6 +154,10 @@ const TEMPLATES: Record = { }, expected_signal: 'Non-empty array indicates automated backups exist', failure_signal: 'Empty array indicates no automated backups', + expected_pattern: { + type: 'json_array_not_empty', + }, + example_output: '[{"Id": "prod-db", "Status": "active"}]', verdict_impact: { current_tier: 'unrecoverable', potential_tier: 'recoverable-from-backup', @@ -211,6 +223,17 @@ const TEMPLATES: Record = { }, expected_signal: 'PointInTimeRecoveryStatus=ENABLED indicates recovery is possible', failure_signal: 'PointInTimeRecoveryStatus=DISABLED indicates no point-in-time recovery', + expected_pattern: { + type: 'json_field_equals', + path: 'PointInTimeRecoveryStatus', + expected_value: 'ENABLED', + }, + failure_pattern: { + type: 'json_field_equals', + path: 'PointInTimeRecoveryStatus', + expected_value: 'DISABLED', + }, + example_output: '{"PointInTimeRecoveryStatus": "ENABLED", "EarliestRestorableDateTime": "2024-01-01T00:00:00Z"}', verdict_impact: { current_tier: 'unrecoverable', potential_tier: 'recoverable-from-backup', @@ -237,6 +260,10 @@ const TEMPLATES: Record = { }, expected_signal: 'Non-empty array with BackupStatus=AVAILABLE indicates backups exist', failure_signal: 'Empty array indicates no on-demand backups', + expected_pattern: { + type: 'json_array_not_empty', + }, + example_output: '[{"Arn": "arn:aws:dynamodb:us-east-1:123456789012:table/MyTable/backup/01234567890123-abcdefgh", "Status": "AVAILABLE"}]', verdict_impact: { current_tier: 'unrecoverable', potential_tier: 'recoverable-from-backup', @@ -401,6 +428,17 @@ const TEMPLATES: Record = { }, expected_signal: 'Status=Enabled indicates versioning is active', failure_signal: 'Empty response or Status=Suspended indicates no versioning', + expected_pattern: { + type: 'json_field_equals', + path: 'Status', + expected_value: 'Enabled', + }, + failure_pattern: { + type: 'json_field_equals', + path: 'Status', + expected_value: 'Suspended', + }, + example_output: '{"Status": "Enabled", "MFADelete": "Disabled"}', verdict_impact: { current_tier: 'unrecoverable', potential_tier: 'recoverable-from-backup', @@ -426,6 +464,11 @@ const TEMPLATES: Record = { }, expected_signal: 'ReplicationConfiguration with rules indicates data is replicated', failure_signal: 'ReplicationConfigurationNotFoundError indicates no replication', + expected_pattern: { + type: 'json_field_exists', + path: 'ReplicationConfiguration.Rules', + }, + example_output: '{"ReplicationConfiguration": {"Role": "arn:aws:iam::123456789012:role/replication-role", "Rules": [{"Status": "Enabled"}]}}', verdict_impact: { current_tier: 'unrecoverable', potential_tier: 'recoverable-from-backup', @@ -433,6 +476,32 @@ const TEMPLATES: Record = { }, priority: 'critical', }); + + // Check object count (for impact assessment) + suggestions.push({ + evidence_key: 'object_count', + description: 'Count objects in bucket to assess impact', + uncertainty: 'low', + verification: { + type: 'aws_cli', + argv: [ + 'aws', 's3api', 'list-objects-v2', + '--bucket', bucketName, + '--query', 'length(Contents)', + '--output', 'json', + ], + timeout_seconds: 60, + requires_permissions: ['s3:ListBucket'], + }, + expected_signal: 'Returns object count (0 = empty bucket, safer to delete)', + failure_signal: 'N/A - this is informational', + example_output: '12847', + verdict_impact: { + current_tier: 'unrecoverable', + potential_tier: 'unrecoverable', + }, + priority: 'informational', + }); } return suggestions; diff --git a/tests/dependency-graph.test.ts b/tests/dependency-graph.test.ts index fcbb2c5..66ab237 100644 --- a/tests/dependency-graph.test.ts +++ b/tests/dependency-graph.test.ts @@ -123,7 +123,7 @@ describe('Dependency Graph', () => { const dependents = findDependents(graph, 'aws_s3_bucket.main'); expect(dependents).toHaveLength(2); - const addresses = dependents.map(d => d.address).sort(); + const addresses = dependents.map(d => d.affectedResource).sort(); expect(addresses).toEqual([ 'aws_s3_bucket_policy.main', 'aws_s3_bucket_versioning.main', @@ -141,7 +141,7 @@ describe('Dependency Graph', () => { // VPC → Subnet → Instance expect(dependents.length).toBeGreaterThanOrEqual(2); - const addresses = dependents.map(d => d.address); + const addresses = dependents.map(d => d.affectedResource); expect(addresses).toContain('aws_subnet.main'); expect(addresses).toContain('aws_instance.web'); }); @@ -158,7 +158,7 @@ describe('Dependency Graph', () => { const dependents = findDependents(graph, 'aws_vpc.a'); // A affects B, C, and D - const addresses = new Set(dependents.map(d => d.address)); + const addresses = new Set(dependents.map(d => d.affectedResource)); expect(addresses.has('aws_subnet.b')).toBe(true); expect(addresses.has('aws_subnet.c')).toBe(true); expect(addresses.has('aws_instance.d')).toBe(true); @@ -177,8 +177,8 @@ describe('Dependency Graph', () => { const dependentsB = findDependents(graph, 'aws_security_group.b'); // Both should find each other but not infinitely recurse - expect(dependentsA.some(d => d.address === 'aws_security_group.b')).toBe(true); - expect(dependentsB.some(d => d.address === 'aws_security_group.a')).toBe(true); + expect(dependentsA.some(d => d.affectedResource === 'aws_security_group.b')).toBe(true); + expect(dependentsB.some(d => d.affectedResource === 'aws_security_group.a')).toBe(true); }); it('handles deep nesting (5+ levels)', () => { @@ -212,7 +212,7 @@ describe('Dependency Graph', () => { // Should find at least 10 dependents (may include implicit deps) expect(dependents.length).toBeGreaterThanOrEqual(10); // Verify all subnets are found - const addresses = new Set(dependents.map(d => d.address)); + const addresses = new Set(dependents.map(d => d.affectedResource)); for (let i = 0; i < 10; i++) { expect(addresses.has(`aws_subnet.subnet${i}`)).toBe(true); } @@ -241,8 +241,8 @@ describe('Dependency Graph', () => { const affected = findAllAffectedResources(graph, ['aws_s3_bucket.a', 'aws_s3_bucket.b']); expect(affected.size).toBe(2); - expect(affected.get('aws_s3_bucket.a')?.[0].address).toBe('aws_s3_bucket_policy.a'); - expect(affected.get('aws_s3_bucket.b')?.[0].address).toBe('aws_s3_bucket_policy.b'); + expect(affected.get('aws_s3_bucket.a')?.[0].affectedResource).toBe('aws_s3_bucket_policy.a'); + expect(affected.get('aws_s3_bucket.b')?.[0].affectedResource).toBe('aws_s3_bucket_policy.b'); }); it('excludes resources with no dependents from result', () => { @@ -283,11 +283,11 @@ describe('Dependency Graph', () => { // Both should be in the map expect(affected.size).toBe(2); // A should have B and C as dependents - const aAffected = affected.get('aws_vpc.a')?.map(d => d.address); + const aAffected = affected.get('aws_vpc.a')?.map(d => d.affectedResource); expect(aAffected).toContain('aws_subnet.b'); expect(aAffected).toContain('aws_instance.c'); // B should have C as dependent - const bAffected = affected.get('aws_subnet.b')?.map(d => d.address); + const bAffected = affected.get('aws_subnet.b')?.map(d => d.affectedResource); expect(bAffected).toContain('aws_instance.c'); }); }); diff --git a/tests/pattern-matcher.test.ts b/tests/pattern-matcher.test.ts new file mode 100644 index 0000000..3e327c6 --- /dev/null +++ b/tests/pattern-matcher.test.ts @@ -0,0 +1,533 @@ +import { describe, expect, it } from 'vitest'; +import { matchPattern, interpretVerificationOutput, type MatchResult } from '../src/verification/pattern-matcher.js'; +import type { OutputPattern } from '../src/core/mutation.js'; + +describe('Pattern Matcher', () => { + describe('matchPattern', () => { + describe('undefined pattern', () => { + it('returns ambiguous when pattern is undefined', () => { + const result = matchPattern('output', 0, undefined); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('ambiguous'); + expect(result.reason).toContain('No pattern defined'); + }); + }); + + describe('exit_code pattern', () => { + it('matches when exit code equals expected', () => { + const pattern: OutputPattern = { type: 'exit_code', expected_exit_code: 0 }; + const result = matchPattern('', 0, pattern); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + expect(result.reason).toContain('Exit code 0 matches expected 0'); + }); + + it('fails when exit code does not match', () => { + const pattern: OutputPattern = { type: 'exit_code', expected_exit_code: 0 }; + const result = matchPattern('', 1, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('does not match'); + }); + + it('defaults to expected_exit_code 0 when not specified', () => { + const pattern: OutputPattern = { type: 'exit_code' }; + const result = matchPattern('', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('handles non-zero expected exit code', () => { + const pattern: OutputPattern = { type: 'exit_code', expected_exit_code: 2 }; + const result = matchPattern('', 2, pattern); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + }); + }); + + describe('json_array_not_empty pattern', () => { + it('matches non-empty array', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('[{"id": "snap-123"}, {"id": "snap-456"}]', 0, pattern); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + expect(result.reason).toContain('2 item(s)'); + expect(result.extractedValue).toBe(2); + }); + + it('matches single-element array', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('["item"]', 0, pattern); + expect(result.matches).toBe(true); + expect(result.extractedValue).toBe(1); + }); + + it('fails on empty array', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('[]', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('empty'); + }); + + it('fails on empty output', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('empty or null'); + }); + + it('fails on null output', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('null', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('returns ambiguous for non-array JSON', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('{"key": "value"}', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('ambiguous'); + expect(result.reason).toContain('not an array'); + }); + + it('returns error for invalid JSON', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('not json', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + expect(result.reason).toContain('parse'); + }); + + it('handles whitespace around JSON', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern(' [1, 2, 3] \n', 0, pattern); + expect(result.matches).toBe(true); + expect(result.extractedValue).toBe(3); + }); + }); + + describe('json_field_equals pattern', () => { + it('matches when field equals expected value', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = matchPattern('{"Status": "Enabled"}', 0, pattern); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + expect(result.extractedValue).toBe('Enabled'); + }); + + it('fails when field does not equal expected', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = matchPattern('{"Status": "Suspended"}', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain("'Suspended'"); + expect(result.extractedValue).toBe('Suspended'); + }); + + it('fails when field is missing', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = matchPattern('{"OtherField": "value"}', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('not found'); + }); + + it('handles nested path', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Versioning.Status', expected_value: 'Enabled' }; + const result = matchPattern('{"Versioning": {"Status": "Enabled"}}', 0, pattern); + expect(result.matches).toBe(true); + expect(result.extractedValue).toBe('Enabled'); + }); + + it('handles deeply nested path', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'a.b.c.d', expected_value: 'value' }; + const result = matchPattern('{"a": {"b": {"c": {"d": "value"}}}}', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('handles boolean expected value', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Enabled', expected_value: true }; + const result = matchPattern('{"Enabled": true}', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('handles numeric expected value', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Count', expected_value: 42 }; + const result = matchPattern('{"Count": 42}', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('returns error for invalid JSON', () => { + const pattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = matchPattern('not json', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + }); + }); + + describe('json_field_exists pattern', () => { + it('matches when field exists', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'VersionId' }; + const result = matchPattern('{"VersionId": "abc123"}', 0, pattern); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + expect(result.extractedValue).toBe('abc123'); + }); + + it('fails when field does not exist', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'VersionId' }; + const result = matchPattern('{"OtherField": "value"}', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('does not exist'); + }); + + it('fails when field is null', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'VersionId' }; + const result = matchPattern('{"VersionId": null}', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('fails when field is empty array', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'Snapshots' }; + const result = matchPattern('{"Snapshots": []}', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('empty array'); + }); + + it('matches when field is non-empty array', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'Snapshots' }; + const result = matchPattern('{"Snapshots": [{"id": 1}]}', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('handles nested path', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'Bucket.Versioning' }; + const result = matchPattern('{"Bucket": {"Versioning": "Enabled"}}', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('fails for nested path when parent missing', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'Bucket.Versioning' }; + const result = matchPattern('{"OtherBucket": {"Versioning": "Enabled"}}', 0, pattern); + expect(result.matches).toBe(false); + }); + + it('returns error for invalid JSON', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: 'Field' }; + const result = matchPattern('not json', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + }); + }); + + describe('regex pattern', () => { + it('matches when regex found', () => { + const pattern: OutputPattern = { type: 'regex', regex: 'snapshot-\\w+' }; + const result = matchPattern('Snapshot ID: snapshot-abc123', 0, pattern); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + expect(result.extractedValue).toBe('snapshot-abc123'); + }); + + it('fails when regex not found', () => { + const pattern: OutputPattern = { type: 'regex', regex: 'snapshot-\\w+' }; + const result = matchPattern('No snapshots found', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('handles complex regex', () => { + const pattern: OutputPattern = { type: 'regex', regex: 'PITR:\\s*(enabled|active)' }; + const result = matchPattern('Status: OK, PITR: enabled, Region: us-east-1', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('returns error for invalid regex', () => { + const pattern: OutputPattern = { type: 'regex', regex: '(unclosed' }; + const result = matchPattern('test', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + expect(result.reason).toContain('Invalid regex'); + }); + }); + + describe('unknown pattern type', () => { + it('returns ambiguous for unknown pattern type', () => { + const pattern = { type: 'unknown_type' } as unknown as OutputPattern; + const result = matchPattern('output', 0, pattern); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('ambiguous'); + expect(result.reason).toContain('Unknown pattern type'); + }); + }); + }); + + describe('interpretVerificationOutput', () => { + describe('non-zero exit code handling', () => { + it('returns error for non-zero exit code with error in output', () => { + const result = interpretVerificationOutput( + 'error: Access denied', + 1 + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + expect(result.reason).toContain('exit code 1'); + }); + + it('detects Error in output', () => { + const result = interpretVerificationOutput( + 'Error: Connection refused', + 1 + ); + expect(result.interpretation).toBe('error'); + }); + + it('detects AccessDenied in output', () => { + const result = interpretVerificationOutput( + 'AccessDenied: You are not authorized', + 1 + ); + expect(result.interpretation).toBe('error'); + }); + + it('checks failure pattern on non-zero exit if no error keywords', () => { + const failurePattern: OutputPattern = { type: 'regex', regex: 'NotFound' }; + const result = interpretVerificationOutput( + 'NotFound: Resource does not exist', + 1, + undefined, + failurePattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('returns error for non-zero exit when no patterns match', () => { + const result = interpretVerificationOutput( + 'Some output without keywords', + 127 + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + expect(result.reason).toContain('exit code 127'); + }); + }); + + describe('expected pattern matching', () => { + it('returns matches_expected when expected pattern matches', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = interpretVerificationOutput( + '{"Status": "Enabled"}', + 0, + expectedPattern + ); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + expect(result.extractedValue).toBe('Enabled'); + }); + + it('returns matches_failure when expected pattern does not match', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = interpretVerificationOutput( + '{"Status": "Disabled"}', + 0, + expectedPattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + expect(result.reason).toContain('Expected pattern not found'); + }); + }); + + describe('failure pattern matching', () => { + it('returns matches_failure when failure pattern matches', () => { + // Use a pattern that MATCHES the failure state (e.g., Status = Disabled) + const failurePattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Disabled' }; + const result = interpretVerificationOutput( + '{"Status": "Disabled"}', + 0, + undefined, + failurePattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + }); + + describe('combined pattern matching', () => { + it('prioritizes expected pattern over failure pattern', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const failurePattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Disabled' }; + const result = interpretVerificationOutput( + '{"Status": "Enabled"}', + 0, + expectedPattern, + failurePattern + ); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + }); + + it('falls through to failure pattern when expected does not match', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const failurePattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Disabled' }; + const result = interpretVerificationOutput( + '{"Status": "Disabled"}', + 0, + expectedPattern, + failurePattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + }); + + describe('no patterns case', () => { + it('returns ambiguous when no patterns defined', () => { + const result = interpretVerificationOutput( + 'Some output', + 0 + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('ambiguous'); + expect(result.reason).toContain('No patterns defined'); + }); + }); + + describe('real-world scenarios', () => { + it('handles S3 versioning check - enabled', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const result = interpretVerificationOutput( + '{"Status": "Enabled", "MFADelete": "Disabled"}', + 0, + expectedPattern + ); + expect(result.matches).toBe(true); + expect(result.interpretation).toBe('matches_expected'); + }); + + it('handles S3 versioning check - disabled', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'Status', expected_value: 'Enabled' }; + const failurePattern: OutputPattern = { type: 'regex', regex: '^\\{\\}$' }; + const result = interpretVerificationOutput( + '{}', + 0, + expectedPattern, + failurePattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('handles RDS snapshots check - snapshots exist', () => { + const expectedPattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = interpretVerificationOutput( + '[{"DBSnapshotIdentifier": "snap-1"}, {"DBSnapshotIdentifier": "snap-2"}]', + 0, + expectedPattern + ); + expect(result.matches).toBe(true); + expect(result.extractedValue).toBe(2); + }); + + it('handles RDS snapshots check - no snapshots', () => { + const expectedPattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = interpretVerificationOutput( + '[]', + 0, + expectedPattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('handles DynamoDB PITR check - enabled', () => { + const expectedPattern: OutputPattern = { type: 'json_field_equals', path: 'ContinuousBackupsStatus', expected_value: 'ENABLED' }; + const result = interpretVerificationOutput( + '{"ContinuousBackupsStatus": "ENABLED", "PointInTimeRecoveryDescription": {"PointInTimeRecoveryStatus": "ENABLED"}}', + 0, + expectedPattern + ); + expect(result.matches).toBe(true); + }); + + it('handles AWS CLI error response', () => { + const result = interpretVerificationOutput( + 'An error occurred (AccessDenied) when calling the DescribeBucketVersioning operation', + 255 + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('error'); + }); + + it('handles AWS CLI resource not found - returns error for outputs containing error keyword', () => { + // Note: AWS CLI outputs with "error" keyword are treated as errors, not as expected failure conditions + // This is because "error" typically indicates something unexpected happened + const failurePattern: OutputPattern = { type: 'regex', regex: 'NoSuchBucket|NotFound|does not exist' }; + const result = interpretVerificationOutput( + 'An error occurred (NoSuchBucket) when calling the GetBucketVersioning operation', + 254, + undefined, + failurePattern + ); + expect(result.matches).toBe(false); + // "error" keyword in output triggers error interpretation + expect(result.interpretation).toBe('error'); + }); + + it('handles failure pattern on non-zero exit without error keywords', () => { + // When output doesn't contain "error", "Error", or "AccessDenied", failure pattern is checked + const failurePattern: OutputPattern = { type: 'regex', regex: 'NoSuchBucket|NotFound' }; + const result = interpretVerificationOutput( + 'NoSuchBucket: The specified bucket does not exist', + 1, + undefined, + failurePattern + ); + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + }); + }); + + describe('edge cases', () => { + it('handles unicode in output', () => { + const pattern: OutputPattern = { type: 'regex', regex: '名前' }; + const result = matchPattern('名前: テスト', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('handles very large JSON output', () => { + const largeArray = Array(1000).fill({ id: 'test', value: 123 }); + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern(JSON.stringify(largeArray), 0, pattern); + expect(result.matches).toBe(true); + expect(result.extractedValue).toBe(1000); + }); + + it('handles empty string path in json_field_exists - does not match', () => { + const pattern: OutputPattern = { type: 'json_field_exists', path: '' }; + const result = matchPattern('{"field": "value"}', 0, pattern); + // Empty path splits to [''] which doesn't match any key + expect(result.matches).toBe(false); + expect(result.interpretation).toBe('matches_failure'); + }); + + it('handles multiline output', () => { + const pattern: OutputPattern = { type: 'regex', regex: 'Status:\\s*ACTIVE' }; + const result = matchPattern('Name: test\nStatus: ACTIVE\nRegion: us-east-1', 0, pattern); + expect(result.matches).toBe(true); + }); + + it('handles Windows-style line endings', () => { + const pattern: OutputPattern = { type: 'json_array_not_empty' }; + const result = matchPattern('[\r\n {"id": 1}\r\n]', 0, pattern); + expect(result.matches).toBe(true); + }); + }); +}); diff --git a/tests/platform-foundation.test.ts b/tests/platform-foundation.test.ts index 7263ef1..15e288e 100644 --- a/tests/platform-foundation.test.ts +++ b/tests/platform-foundation.test.ts @@ -612,7 +612,7 @@ describe('platform foundation', () => { }; } - if (request.query === 'list-type=2&max-keys=1') { + if (request.query === 'list-type=2&max-keys=1000') { return { statusCode: 200, body: '',