@kirrosh/zond 0.22.0 → 0.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +648 -0
- package/README.md +58 -6
- package/package.json +9 -6
- package/src/cli/argv.ts +122 -0
- package/src/cli/commands/add-api.ts +134 -0
- package/src/cli/commands/api/annotate/idempotency.ts +59 -0
- package/src/cli/commands/api/annotate/index.ts +525 -0
- package/src/cli/commands/api/annotate/lifecycle.ts +74 -0
- package/src/cli/commands/api/annotate/overlay.ts +206 -0
- package/src/cli/commands/api/annotate/pagination.ts +60 -0
- package/src/cli/commands/api/annotate/prompts.ts +183 -0
- package/src/cli/commands/api/annotate/readback.ts +58 -0
- package/src/cli/commands/api/annotate/resources.ts +91 -0
- package/src/cli/commands/api/annotate/seed-bodies.ts +61 -0
- package/src/cli/commands/audit.ts +480 -0
- package/src/cli/commands/bootstrap.ts +710 -0
- package/src/cli/commands/catalog.ts +35 -0
- package/src/cli/commands/check.ts +348 -0
- package/src/cli/commands/checks.ts +756 -0
- package/src/cli/commands/ci-init.ts +43 -0
- package/src/cli/commands/clean.ts +212 -0
- package/src/cli/commands/cleanup.ts +262 -0
- package/src/cli/commands/completions.ts +16 -0
- package/src/cli/commands/coverage.ts +605 -132
- package/src/cli/commands/db.ts +178 -7
- package/src/cli/commands/describe.ts +37 -2
- package/src/cli/commands/discover.ts +1236 -0
- package/src/cli/commands/doctor.ts +607 -0
- package/src/cli/commands/fixtures.ts +402 -0
- package/src/cli/commands/generate.ts +420 -46
- package/src/cli/commands/init/bootstrap.ts +30 -1
- package/src/cli/commands/{init.ts → init/index.ts} +99 -5
- package/src/cli/commands/init/skills.ts +56 -3
- package/src/cli/commands/init/templates/agents.md +65 -61
- package/src/cli/commands/init/templates/skills/zond-checks.md +397 -0
- package/src/cli/commands/init/templates/skills/zond-triage.md +210 -0
- package/src/cli/commands/init/templates/skills/zond.md +592 -125
- package/src/cli/commands/init/templates/zond-config.yml +8 -9
- package/src/cli/commands/prepare-fixtures.ts +135 -0
- package/src/cli/commands/probe/mass-assignment.ts +503 -0
- package/src/cli/commands/probe/security.ts +454 -0
- package/src/cli/commands/probe/static.ts +255 -0
- package/src/cli/commands/probe/webhooks.ts +161 -0
- package/src/cli/commands/probe.ts +459 -0
- package/src/cli/commands/reference.ts +87 -0
- package/src/cli/commands/refresh-api.ts +169 -0
- package/src/cli/commands/remove-api.ts +150 -0
- package/src/cli/commands/report-bundle.ts +318 -0
- package/src/cli/commands/report.ts +241 -0
- package/src/cli/commands/request.ts +379 -4
- package/src/cli/commands/run.ts +842 -53
- package/src/cli/commands/session.ts +244 -0
- package/src/cli/commands/use.ts +18 -1
- package/src/cli/index.ts +20 -3
- package/src/cli/json-envelope.ts +112 -3
- package/src/cli/json-schemas.ts +263 -0
- package/src/cli/program.ts +198 -635
- package/src/cli/resolve.ts +105 -0
- package/src/cli/status-filter.ts +124 -0
- package/src/cli/util/api-context.ts +85 -0
- package/src/cli/version.ts +5 -0
- package/src/core/anti-fp/bootstrap.ts +34 -0
- package/src/core/anti-fp/index.ts +33 -0
- package/src/core/anti-fp/registry.ts +44 -0
- package/src/core/anti-fp/rules/baseline-echo.ts +74 -0
- package/src/core/anti-fp/rules/schemathesis/body_negation_becomes_valid.ts +52 -0
- package/src/core/anti-fp/rules/schemathesis/coverage_phase_boundary_positive.ts +38 -0
- package/src/core/anti-fp/rules/schemathesis/has_unverifiable_mutations.ts +35 -0
- package/src/core/anti-fp/rules/schemathesis/index.ts +24 -0
- package/src/core/anti-fp/rules/schemathesis/string_type_mutation_becomes_valid.ts +53 -0
- package/src/core/anti-fp/rules/subscription-gated/index.ts +11 -0
- package/src/core/anti-fp/rules/subscription-gated/paid-plan-403.ts +75 -0
- package/src/core/anti-fp/types.ts +68 -0
- package/src/core/checks/checks/_crud-helpers.ts +133 -0
- package/src/core/checks/checks/_negative_mutator.ts +133 -0
- package/src/core/checks/checks/_readback-helpers.ts +133 -0
- package/src/core/checks/checks/content_type_conformance.ts +39 -0
- package/src/core/checks/checks/cross_call_references.ts +134 -0
- package/src/core/checks/checks/ensure_resource_availability.ts +62 -0
- package/src/core/checks/checks/idempotency_replay.ts +246 -0
- package/src/core/checks/checks/ignored_auth.ts +211 -0
- package/src/core/checks/checks/index.ts +65 -0
- package/src/core/checks/checks/lifecycle_transitions.ts +273 -0
- package/src/core/checks/checks/missing_required_header.ts +40 -0
- package/src/core/checks/checks/negative_data_rejection.ts +45 -0
- package/src/core/checks/checks/not_a_server_error.ts +27 -0
- package/src/core/checks/checks/open_cors_on_sensitive.ts +131 -0
- package/src/core/checks/checks/pagination_invariants.ts +238 -0
- package/src/core/checks/checks/positive_data_acceptance.ts +36 -0
- package/src/core/checks/checks/rate_limit_headers_absent.ts +77 -0
- package/src/core/checks/checks/response_headers_conformance.ts +74 -0
- package/src/core/checks/checks/response_schema_conformance.ts +30 -0
- package/src/core/checks/checks/status_code_conformance.ts +61 -0
- package/src/core/checks/checks/unsupported_method.ts +63 -0
- package/src/core/checks/checks/use_after_free.ts +78 -0
- package/src/core/checks/index.ts +30 -0
- package/src/core/checks/mode.ts +79 -0
- package/src/core/checks/recommended-action.ts +64 -0
- package/src/core/checks/registry.ts +78 -0
- package/src/core/checks/runner.ts +874 -0
- package/src/core/checks/sarif.ts +230 -0
- package/src/core/checks/stateful.ts +121 -0
- package/src/core/checks/types.ts +189 -0
- package/src/core/classifier/recommended-action.ts +222 -0
- package/src/core/context/current.ts +22 -6
- package/src/core/context/session.ts +78 -0
- package/src/core/coverage/loader.ts +185 -0
- package/src/core/coverage/reasons.ts +300 -0
- package/src/core/diagnostics/db-analysis.ts +151 -11
- package/src/core/diagnostics/failure-class.ts +120 -0
- package/src/core/diagnostics/failure-hints.ts +212 -9
- package/src/core/diagnostics/spec-pointer.ts +99 -0
- package/src/core/diagnostics/suggested-fixes.ts +156 -0
- package/src/core/exporter/case-study/index.ts +270 -0
- package/src/core/exporter/curl.ts +40 -0
- package/src/core/exporter/exporter.ts +48 -0
- package/src/core/exporter/html-report/escape.ts +24 -0
- package/src/core/exporter/html-report/index.ts +479 -0
- package/src/core/exporter/html-report/script.ts +100 -0
- package/src/core/exporter/html-report/styles.ts +408 -0
- package/src/core/generator/chunker.ts +42 -16
- package/src/core/generator/coverage-phase.ts +0 -0
- package/src/core/generator/create-body.ts +89 -0
- package/src/core/generator/data-factory.ts +445 -19
- package/src/core/generator/describe.ts +1 -1
- package/src/core/generator/fixtures-builder.ts +325 -0
- package/src/core/generator/index.ts +7 -5
- package/src/core/generator/openapi-reader.ts +37 -3
- package/src/core/generator/path-param-disambig.ts +114 -0
- package/src/core/generator/resources-builder.ts +648 -0
- package/src/core/generator/schema-utils.ts +11 -3
- package/src/core/generator/serializer.ts +103 -13
- package/src/core/generator/suite-generator.ts +419 -111
- package/src/core/generator/types.ts +8 -0
- package/src/core/identity/identity-file.ts +129 -0
- package/src/core/lint/affects.ts +28 -0
- package/src/core/lint/config.ts +96 -0
- package/src/core/lint/format.ts +42 -0
- package/src/core/lint/index.ts +94 -0
- package/src/core/lint/reporter.ts +128 -0
- package/src/core/lint/rules/consistency.ts +158 -0
- package/src/core/lint/rules/heuristics.ts +97 -0
- package/src/core/lint/rules/strictness.ts +109 -0
- package/src/core/lint/types.ts +96 -0
- package/src/core/lint/walker.ts +248 -0
- package/src/core/meta/meta-store.ts +6 -73
- package/src/core/output/README.md +91 -0
- package/src/core/output/index.ts +13 -0
- package/src/core/output/run.ts +126 -0
- package/src/core/output/types.ts +129 -0
- package/src/core/parser/env-interpolation.ts +104 -0
- package/src/core/parser/filter.ts +57 -0
- package/src/core/parser/schema.ts +129 -4
- package/src/core/parser/types.ts +19 -1
- package/src/core/parser/variables.ts +0 -0
- package/src/core/parser/yaml-parser.ts +58 -12
- package/src/core/probe/bootstrap.ts +34 -0
- package/src/core/probe/dry-run-envelope.ts +57 -0
- package/src/core/probe/mass-assignment-probe-class.ts +198 -0
- package/src/core/probe/mass-assignment-probe.ts +1122 -0
- package/src/core/probe/mass-assignment-template.ts +212 -0
- package/src/core/probe/method-probe.ts +43 -76
- package/src/core/probe/method-shared.ts +69 -0
- package/src/core/probe/negative-probe.ts +183 -149
- package/src/core/probe/orphan-tracker.ts +188 -0
- package/src/core/probe/path-discovery.ts +440 -0
- package/src/core/probe/probe-harness.ts +120 -0
- package/src/core/probe/registry.ts +89 -0
- package/src/core/probe/runner.ts +136 -0
- package/src/core/probe/security-probe-class.ts +201 -0
- package/src/core/probe/security-probe.ts +1453 -0
- package/src/core/probe/shared.ts +505 -0
- package/src/core/probe/static-probe-class.ts +125 -0
- package/src/core/probe/types.ts +165 -0
- package/src/core/probe/verdict-aggregator.ts +33 -0
- package/src/core/probe/webhooks-probe.ts +284 -0
- package/src/core/reporter/console.ts +41 -2
- package/src/core/reporter/index.ts +2 -3
- package/src/core/reporter/json.ts +11 -1
- package/src/core/reporter/junit.ts +27 -12
- package/src/core/reporter/ndjson.ts +37 -0
- package/src/core/reporter/types.ts +3 -0
- package/src/core/runner/assertions.ts +58 -1
- package/src/core/runner/async-pool.ts +108 -0
- package/src/core/runner/auth-path.ts +8 -0
- package/src/core/runner/ci-context.ts +72 -0
- package/src/core/runner/executor.ts +264 -20
- package/src/core/runner/form-encode.ts +51 -0
- package/src/core/runner/http-client.ts +75 -2
- package/src/core/runner/learn-drift.ts +293 -0
- package/src/core/runner/preflight-vars.ts +149 -0
- package/src/core/runner/progress-tracker.ts +73 -0
- package/src/core/runner/rate-limiter.ts +89 -17
- package/src/core/runner/run-kind.ts +39 -0
- package/src/core/runner/schema-validator.ts +312 -0
- package/src/core/runner/send-request.ts +153 -20
- package/src/core/runner/types.ts +38 -0
- package/src/core/secrets/registry.ts +164 -0
- package/src/core/secrets/secrets-file.ts +115 -0
- package/src/core/selectors/operation-filter.ts +144 -0
- package/src/core/setup-api.ts +415 -16
- package/src/core/severity/category.ts +94 -0
- package/src/core/severity/index.ts +121 -0
- package/src/core/spec/layers.ts +154 -0
- package/src/core/util/format-eta.ts +21 -0
- package/src/core/utils.ts +5 -1
- package/src/core/workspace/config.ts +129 -0
- package/src/core/workspace/manifest.ts +283 -0
- package/src/core/workspace/output-rotation.ts +62 -0
- package/src/core/workspace/triage-path.ts +87 -0
- package/src/db/lint-runs.ts +47 -0
- package/src/db/migrate.ts +126 -0
- package/src/db/migrations/0001_run_kind.sql +25 -0
- package/src/db/migrations/sql.d.ts +4 -0
- package/src/db/queries/collections.ts +133 -0
- package/src/db/queries/coverage.ts +9 -0
- package/src/db/queries/dashboard.ts +59 -0
- package/src/db/queries/results.ts +128 -0
- package/src/db/queries/runs.ts +235 -0
- package/src/db/queries/sessions.ts +42 -0
- package/src/db/queries/settings.ts +28 -0
- package/src/db/queries/types.ts +172 -0
- package/src/db/queries.ts +72 -802
- package/src/db/schema.ts +178 -50
- package/src/cli/commands/export.ts +0 -144
- package/src/cli/commands/guide.ts +0 -127
- package/src/cli/commands/init/templates/skills/scenarios.md +0 -97
- package/src/cli/commands/probe-methods.ts +0 -108
- package/src/cli/commands/probe-validation.ts +0 -124
- package/src/cli/commands/serve.ts +0 -114
- package/src/cli/commands/sync.ts +0 -268
- package/src/cli/commands/update.ts +0 -189
- package/src/cli/commands/validate.ts +0 -34
- package/src/core/diagnostics/render-md.ts +0 -112
- package/src/core/exporter/postman.ts +0 -963
- package/src/core/generator/guide-builder.ts +0 -253
- package/src/core/meta/types.ts +0 -19
- package/src/core/parser/index.ts +0 -21
- package/src/core/runner/execute-run.ts +0 -132
- package/src/core/runner/index.ts +0 -12
- package/src/core/sync/spec-differ.ts +0 -38
- package/src/web/data/collection-state.ts +0 -362
- package/src/web/routes/api.ts +0 -314
- package/src/web/routes/dashboard.ts +0 -350
- package/src/web/routes/runs.ts +0 -64
- package/src/web/schemas.ts +0 -121
- package/src/web/server.ts +0 -134
- package/src/web/static/htmx.min.cjs +0 -1
- package/src/web/static/style.css +0 -1148
- package/src/web/views/endpoints-tab.ts +0 -174
- package/src/web/views/explorer-tab.ts +0 -402
- package/src/web/views/health-strip.ts +0 -92
- package/src/web/views/layout.ts +0 -48
- package/src/web/views/results.ts +0 -210
- package/src/web/views/runs-tab.ts +0 -126
- package/src/web/views/suites-tab.ts +0 -181
|
@@ -0,0 +1,505 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared helpers for probe generators (negative-probe, mass-assignment-probe).
|
|
3
|
+
*/
|
|
4
|
+
import type { OpenAPIV3 } from "openapi-types";
|
|
5
|
+
import type { EndpointInfo, SecuritySchemeInfo } from "../generator/types.ts";
|
|
6
|
+
|
|
7
|
+
export function convertPath(path: string): string {
|
|
8
|
+
return path.replace(/\{([^}]+)\}/g, "{{$1}}");
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
function slugify(s: string): string {
|
|
12
|
+
return s
|
|
13
|
+
.toLowerCase()
|
|
14
|
+
.replace(/[^a-z0-9]+/g, "-")
|
|
15
|
+
.replace(/^-|-$/g, "");
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Build a short, distinguishable alias for an OpenAPI path-param name —
|
|
20
|
+
* used to keep probe filenames readable when several `{...id}` segments
|
|
21
|
+
* collapse to the same `by-id` (TASK-159, m-9 P3).
|
|
22
|
+
*
|
|
23
|
+
* organization_id_or_slug → "org"
|
|
24
|
+
* project_id_or_slug → "proj"
|
|
25
|
+
* replay_id → "replay"
|
|
26
|
+
* userId → "user"
|
|
27
|
+
* foo → "foo"
|
|
28
|
+
* id → "id"
|
|
29
|
+
*
|
|
30
|
+
* The general rule: drop trailing `_id` / `_slug` / `_or_slug` /
|
|
31
|
+
* `Id` / `Slug`, then slugify and trim to the first segment. We also
|
|
32
|
+
* canonicalise a couple of common common SaaS-style names to short aliases
|
|
33
|
+
* (`organization` → `org`, `project` → `proj`).
|
|
34
|
+
*/
|
|
35
|
+
export function placeholderAlias(rawName: string): string {
|
|
36
|
+
let name = rawName.trim();
|
|
37
|
+
// Strip the OpenAPI noisy suffixes.
|
|
38
|
+
name = name.replace(/_or_slug$/i, "");
|
|
39
|
+
name = name.replace(/(_id|_slug)$/i, "");
|
|
40
|
+
name = name.replace(/(Id|Slug)$/g, "");
|
|
41
|
+
const slug = slugify(name);
|
|
42
|
+
if (!slug || slug === "id") return "id";
|
|
43
|
+
// Canonical short aliases for frequent long names.
|
|
44
|
+
const canonical: Record<string, string> = {
|
|
45
|
+
organization: "org",
|
|
46
|
+
project: "proj",
|
|
47
|
+
repository: "repo",
|
|
48
|
+
environment: "env",
|
|
49
|
+
application: "app",
|
|
50
|
+
integration: "intg",
|
|
51
|
+
notification: "notif",
|
|
52
|
+
};
|
|
53
|
+
const first = slug.split("-")[0]!;
|
|
54
|
+
if (canonical[first]) return canonical[first];
|
|
55
|
+
// Fall back to the slug, capped at 12 chars so really long names don't
|
|
56
|
+
// blow up the filename.
|
|
57
|
+
return slug.length > 12 ? slug.slice(0, 12) : slug;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Replace every `{name}` segment in an OpenAPI path with `by-<alias>`,
|
|
62
|
+
* preserving placeholder identity (TASK-159).
|
|
63
|
+
*/
|
|
64
|
+
export function pathWithByAliases(path: string): string {
|
|
65
|
+
return path.replace(/\{([^}]+)\}/g, (_, name) => `by-${placeholderAlias(name)}`);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export function endpointStem(ep: EndpointInfo): string {
|
|
69
|
+
const path = pathWithByAliases(ep.path)
|
|
70
|
+
.replace(/^\//, "")
|
|
71
|
+
.replace(/\//g, "-");
|
|
72
|
+
return slugify(`${ep.method.toLowerCase()}-${path}`);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function getAuthHeaders(
|
|
76
|
+
ep: EndpointInfo,
|
|
77
|
+
schemes: SecuritySchemeInfo[],
|
|
78
|
+
tokenVarFor?: (s: SecuritySchemeInfo) => string,
|
|
79
|
+
): Record<string, string> | undefined {
|
|
80
|
+
if (ep.security.length === 0) return undefined;
|
|
81
|
+
const tokenVar = (s: SecuritySchemeInfo) => tokenVarFor?.(s) ?? "auth_token";
|
|
82
|
+
|
|
83
|
+
// Prefer bearer / apiKey schemes over basic when an endpoint declares
|
|
84
|
+
// multiple alternatives (ARV-147). Stripe v1 publishes `security: [basicAuth,
|
|
85
|
+
// bearerAuth]` with both pointing at the same `auth_token` value, but
|
|
86
|
+
// basicAuth expects base64(user:password) — feeding it a raw `sk_test_…`
|
|
87
|
+
// produces a 401. zond request already hardcodes Bearer for this reason
|
|
88
|
+
// (send-request.ts TASK-231); the generator + probes now agree by walking
|
|
89
|
+
// ep.security twice: first looking for a non-basic match, then falling
|
|
90
|
+
// back to basic only if nothing else worked.
|
|
91
|
+
const tryScheme = (scheme: SecuritySchemeInfo): Record<string, string> | undefined => {
|
|
92
|
+
if (scheme.type === "http") {
|
|
93
|
+
if (scheme.scheme === "bearer" || !scheme.scheme) {
|
|
94
|
+
return { Authorization: `Bearer {{${tokenVar(scheme)}}}` };
|
|
95
|
+
}
|
|
96
|
+
if (scheme.scheme === "basic") {
|
|
97
|
+
return { Authorization: `Basic {{${tokenVar(scheme)}}}` };
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
if (scheme.type === "apiKey" && scheme.in === "header" && scheme.apiKeyName) {
|
|
101
|
+
if (scheme.apiKeyName === "Authorization") {
|
|
102
|
+
return { Authorization: `Bearer {{${tokenVar(scheme)}}}` };
|
|
103
|
+
}
|
|
104
|
+
return { [scheme.apiKeyName]: "{{api_key}}" };
|
|
105
|
+
}
|
|
106
|
+
return undefined;
|
|
107
|
+
};
|
|
108
|
+
|
|
109
|
+
const isBasic = (s: SecuritySchemeInfo): boolean =>
|
|
110
|
+
s.type === "http" && s.scheme === "basic";
|
|
111
|
+
|
|
112
|
+
// Pass 1: skip basic.
|
|
113
|
+
for (const secName of ep.security) {
|
|
114
|
+
const scheme = schemes.find((s) => s.name === secName);
|
|
115
|
+
if (!scheme || isBasic(scheme)) continue;
|
|
116
|
+
const headers = tryScheme(scheme);
|
|
117
|
+
if (headers) return headers;
|
|
118
|
+
}
|
|
119
|
+
// Pass 2: basic-only fallback.
|
|
120
|
+
for (const secName of ep.security) {
|
|
121
|
+
const scheme = schemes.find((s) => s.name === secName);
|
|
122
|
+
if (!scheme || !isBasic(scheme)) continue;
|
|
123
|
+
const headers = tryScheme(scheme);
|
|
124
|
+
if (headers) return headers;
|
|
125
|
+
}
|
|
126
|
+
return undefined;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/** Path with placeholders replaced by valid-but-nonexistent IDs. */
|
|
130
|
+
function pathWithPlaceholders(ep: EndpointInfo, badId: string): string {
|
|
131
|
+
return ep.path.replace(/\{([^}]+)\}/g, (_, name: string) => {
|
|
132
|
+
const param = ep.parameters.find((p) => p.name === name && p.in === "path");
|
|
133
|
+
const schema = param?.schema as OpenAPIV3.SchemaObject | undefined;
|
|
134
|
+
if (badId === "valid-shape") {
|
|
135
|
+
if (schema?.format === "uuid") return "00000000-0000-0000-0000-000000000000";
|
|
136
|
+
if (schema?.type === "integer" || schema?.type === "number") return "999999999";
|
|
137
|
+
return "nonexistent-zzzzz";
|
|
138
|
+
}
|
|
139
|
+
return badId;
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Render a path for probe execution. The "attacked" param (if any) is replaced
|
|
145
|
+
* with `attacked.value`; remaining params are rendered as either runtime
|
|
146
|
+
* placeholders (`{{name}}`, resolved from `.env.yaml` by `zond run`) when
|
|
147
|
+
* `useRealParents=true`, or as synthetic-by-type sentinels in the legacy mode.
|
|
148
|
+
*
|
|
149
|
+
* The output is the final path string written into the YAML — no further
|
|
150
|
+
* `convertPath` pass is required (and would in fact corrupt the doubled
|
|
151
|
+
* braces).
|
|
152
|
+
*
|
|
153
|
+
* Why `useRealParents` exists (TASK-135 / m-8): probe-validation used to bake
|
|
154
|
+
* `nonexistent-zzzzz` into every parent path-param, which short-circuits to
|
|
155
|
+
* 404 on real APIs (e.g. `/orgs/zzzzz/repos/{repo}/commits` never reaches the
|
|
156
|
+
* `{repo}` validator). Using the real parent slug from the env restores
|
|
157
|
+
* recall — the API actually walks past the parent and starts validating the
|
|
158
|
+
* leaf, so 5xx bugs there become observable.
|
|
159
|
+
*/
|
|
160
|
+
export function renderPath(
|
|
161
|
+
ep: EndpointInfo,
|
|
162
|
+
attacked: { name: string; value: string } | null,
|
|
163
|
+
opts: { useRealParents: boolean },
|
|
164
|
+
): string {
|
|
165
|
+
return ep.path.replace(/\{([^}]+)\}/g, (_, name: string) => {
|
|
166
|
+
if (attacked && name === attacked.name) return attacked.value;
|
|
167
|
+
if (opts.useRealParents) return `{{${name}}}`;
|
|
168
|
+
const param = ep.parameters.find((p) => p.name === name && p.in === "path");
|
|
169
|
+
const schema = param?.schema as OpenAPIV3.SchemaObject | undefined;
|
|
170
|
+
if (schema?.format === "uuid") return "00000000-0000-0000-0000-000000000000";
|
|
171
|
+
if (schema?.type === "integer" || schema?.type === "number") return "999999999";
|
|
172
|
+
return "nonexistent-zzzzz";
|
|
173
|
+
});
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
export function isMutating(method: string): boolean {
|
|
177
|
+
const m = method.toUpperCase();
|
|
178
|
+
return m === "POST" || m === "PUT" || m === "PATCH";
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* TASK-259: pre-run banner shown to stderr before any mutating probe runs
|
|
183
|
+
* on a live API. Lists the probe's name and reminds the user that:
|
|
184
|
+
* 1. resources will be created and deleted on the target;
|
|
185
|
+
* 2. seeded `.env.yaml` fixtures (slug/id/name) may go stale because
|
|
186
|
+
* probes may rename or replace them;
|
|
187
|
+
* 3. `--no-cleanup` keeps created resources around for inspection.
|
|
188
|
+
*
|
|
189
|
+
* Emits to stderr (not stdout) so it doesn't pollute --json envelopes or
|
|
190
|
+
* the Markdown digest. Suppressed when `quiet` is true (used in CI/JSON
|
|
191
|
+
* paths where the structured envelope already carries warnings).
|
|
192
|
+
*/
|
|
193
|
+
export function printMutationBanner(
|
|
194
|
+
probeName: string,
|
|
195
|
+
vars: Record<string, string>,
|
|
196
|
+
opts?: { quiet?: boolean },
|
|
197
|
+
): void {
|
|
198
|
+
if (opts?.quiet) return;
|
|
199
|
+
const fixtureKeys = Object.keys(vars).filter((k) =>
|
|
200
|
+
/(_id|_slug|_uuid|_name|_token)$/i.test(k) || /^(monitor|project|team|alert_rule|rule|organization)_id_or_slug$/.test(k),
|
|
201
|
+
);
|
|
202
|
+
const fixtureLine = fixtureKeys.length > 0
|
|
203
|
+
? ` FK fixtures that may go stale: ${fixtureKeys.slice(0, 8).join(", ")}${fixtureKeys.length > 8 ? `, +${fixtureKeys.length - 8} more` : ""}\n`
|
|
204
|
+
: "";
|
|
205
|
+
process.stderr.write(
|
|
206
|
+
`\n` +
|
|
207
|
+
`⚠ ${probeName} mutates live data on the target API.\n` +
|
|
208
|
+
` It creates and (by default) deletes resources via POST/PUT/PATCH/DELETE.\n` +
|
|
209
|
+
`${fixtureLine}` +
|
|
210
|
+
` Recovery if FK fixtures change: re-run \`zond prepare-fixtures --api <name>\` to refresh \`.env.yaml\`.\n` +
|
|
211
|
+
` Pass \`--no-cleanup\` to keep probe-created resources for inspection.\n` +
|
|
212
|
+
`\n`,
|
|
213
|
+
);
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* TASK-259: count probe verdicts whose cleanup DELETE was attempted but
|
|
218
|
+
* failed (network error, or 4xx other than 404). 404 is intentionally
|
|
219
|
+
* treated as success: the resource is gone, possibly already removed by
|
|
220
|
+
* the API itself or by the test under inspection. Used to surface an
|
|
221
|
+
* "N orphans, manual cleanup needed" line in the CLI summary.
|
|
222
|
+
*/
|
|
223
|
+
/**
|
|
224
|
+
* TASK-264: does this OpenAPI path template have ANY `{param}` segment
|
|
225
|
+
* whose name matches a non-empty entry in `vars` (a seeded fixture)?
|
|
226
|
+
* Used by `--isolated` to gate PUT/PATCH/DELETE attacks.
|
|
227
|
+
*
|
|
228
|
+
* Permissive on the var-side: we treat `audience_id`, `audience-slug`,
|
|
229
|
+
* `audience` as the same fixture so spec-naming variations don't leak.
|
|
230
|
+
*/
|
|
231
|
+
export function pathTouchesSeededVar(path: string, vars: Record<string, string>): boolean {
|
|
232
|
+
const placeholders = [...path.matchAll(/\{([^}]+)\}/g)].map(m => m[1]!);
|
|
233
|
+
if (placeholders.length === 0) return false;
|
|
234
|
+
const filledKeys = new Set(
|
|
235
|
+
Object.keys(vars).filter(k => {
|
|
236
|
+
const v = vars[k];
|
|
237
|
+
return typeof v === "string" && v.trim().length > 0;
|
|
238
|
+
}).map(k => k.toLowerCase().replace(/[-_]/g, "")),
|
|
239
|
+
);
|
|
240
|
+
for (const ph of placeholders) {
|
|
241
|
+
const norm = ph.toLowerCase().replace(/[-_]/g, "");
|
|
242
|
+
if (filledKeys.has(norm)) return true;
|
|
243
|
+
// Strip the OpenAPI noisy suffixes (e.g. `_id`, `_or_slug`) and try again.
|
|
244
|
+
const stripped = norm.replace(/(idorslug|orslug|id|slug)$/i, "");
|
|
245
|
+
if (stripped && filledKeys.has(stripped)) return true;
|
|
246
|
+
}
|
|
247
|
+
return false;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
export function countCleanupFailures(
|
|
251
|
+
verdicts: Array<{ cleanup?: { attempted: boolean; status?: number; error?: string } }>,
|
|
252
|
+
): number {
|
|
253
|
+
let n = 0;
|
|
254
|
+
for (const v of verdicts) {
|
|
255
|
+
const c = v.cleanup;
|
|
256
|
+
if (!c || !c.attempted) continue;
|
|
257
|
+
if (c.error) { n++; continue; }
|
|
258
|
+
if (c.status != null && c.status >= 400 && c.status !== 404) n++;
|
|
259
|
+
}
|
|
260
|
+
return n;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
function escapeRegex(s: string): string {
|
|
264
|
+
return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Strip a single trailing slash so `/keys/` and `/keys` compare equal.
|
|
269
|
+
* common SaaS-style APIs mix both forms; without this normalisation, the
|
|
270
|
+
* counterpart lookup misses on every collection that ends in `/`,
|
|
271
|
+
* leaking created resources during probe runs.
|
|
272
|
+
*/
|
|
273
|
+
function stripTrailingSlash(p: string): string {
|
|
274
|
+
return p.length > 1 && p.endsWith("/") ? p.slice(0, -1) : p;
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
function pathsEqual(a: string, b: string): boolean {
|
|
278
|
+
return stripTrailingSlash(a) === stripTrailingSlash(b);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Find DELETE counterpart for resource-creating endpoint:
|
|
283
|
+
* - POST /collection → DELETE /collection/{id}
|
|
284
|
+
* - PUT /collection/{id} → DELETE /collection/{id}
|
|
285
|
+
* - PATCH /collection/{id} → DELETE /collection/{id}
|
|
286
|
+
*
|
|
287
|
+
* Trailing-slash tolerant on both sides (TASK-139-style fix carried
|
|
288
|
+
* into shared.ts after round-4 dogfooding showed a real-world `POST /keys/`
|
|
289
|
+
* leaked DSN keys because the regex required identical slash forms).
|
|
290
|
+
*/
|
|
291
|
+
export function findDeleteCounterpart(
|
|
292
|
+
ep: EndpointInfo,
|
|
293
|
+
all: EndpointInfo[],
|
|
294
|
+
): EndpointInfo | undefined {
|
|
295
|
+
const m = ep.method.toUpperCase();
|
|
296
|
+
const base = stripTrailingSlash(ep.path);
|
|
297
|
+
if (m === "POST") {
|
|
298
|
+
const re = new RegExp(`^${escapeRegex(base)}/\\{[^}]+\\}/?$`);
|
|
299
|
+
return all.find(e => e.method.toUpperCase() === "DELETE" && !e.deprecated && re.test(e.path));
|
|
300
|
+
}
|
|
301
|
+
if (m === "PUT" || m === "PATCH") {
|
|
302
|
+
return all.find(e => e.method.toUpperCase() === "DELETE" && !e.deprecated && pathsEqual(e.path, ep.path));
|
|
303
|
+
}
|
|
304
|
+
return undefined;
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Find GET-by-id counterpart for follow-up reads after a mutating request:
|
|
309
|
+
* - POST /collection → GET /collection/{id}
|
|
310
|
+
* - PUT /collection/{id} → GET /collection/{id} (same path)
|
|
311
|
+
* - PATCH /collection/{id} → GET /collection/{id} (same path)
|
|
312
|
+
*
|
|
313
|
+
* See `findDeleteCounterpart` for the trailing-slash rationale.
|
|
314
|
+
*/
|
|
315
|
+
export function findGetByIdCounterpart(
|
|
316
|
+
ep: EndpointInfo,
|
|
317
|
+
all: EndpointInfo[],
|
|
318
|
+
): EndpointInfo | undefined {
|
|
319
|
+
const m = ep.method.toUpperCase();
|
|
320
|
+
const base = stripTrailingSlash(ep.path);
|
|
321
|
+
if (m === "POST") {
|
|
322
|
+
const re = new RegExp(`^${escapeRegex(base)}/\\{[^}]+\\}/?$`);
|
|
323
|
+
return all.find(e => e.method.toUpperCase() === "GET" && !e.deprecated && re.test(e.path));
|
|
324
|
+
}
|
|
325
|
+
if (m === "PUT" || m === "PATCH") {
|
|
326
|
+
return all.find(e => e.method.toUpperCase() === "GET" && !e.deprecated && pathsEqual(e.path, ep.path));
|
|
327
|
+
}
|
|
328
|
+
return undefined;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
/** Pick the response field that holds the new resource's id. */
|
|
332
|
+
export function captureFieldFor(ep: EndpointInfo): string {
|
|
333
|
+
const success = ep.responses.find(r => r.statusCode >= 200 && r.statusCode < 300 && r.schema);
|
|
334
|
+
const schema = success?.schema;
|
|
335
|
+
if (schema?.properties) {
|
|
336
|
+
if ("id" in schema.properties) return "id";
|
|
337
|
+
for (const [name, propSchema] of Object.entries(schema.properties)) {
|
|
338
|
+
const s = propSchema as OpenAPIV3.SchemaObject;
|
|
339
|
+
if (s.type === "integer" || s.format === "uuid") return name;
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
return "id";
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
export function headersEqual(a: Record<string, string>, b: Record<string, string>): boolean {
|
|
346
|
+
const ka = Object.keys(a);
|
|
347
|
+
const kb = Object.keys(b);
|
|
348
|
+
if (ka.length !== kb.length) return false;
|
|
349
|
+
for (const k of ka) if (a[k] !== b[k]) return false;
|
|
350
|
+
return true;
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* Resolve auth headers with live values from `vars` (used by probe runtimes
|
|
355
|
+
* and path-discovery). Mirrors `getAuthHeaders` but produces concrete header
|
|
356
|
+
* values, not `{{auth_token}}` placeholders.
|
|
357
|
+
*/
|
|
358
|
+
export function liveAuthHeaders(
|
|
359
|
+
ep: EndpointInfo,
|
|
360
|
+
schemes: SecuritySchemeInfo[],
|
|
361
|
+
vars: Record<string, string>,
|
|
362
|
+
): Record<string, string> {
|
|
363
|
+
if (ep.security.length === 0) {
|
|
364
|
+
// ARV-218 (R15/F25): for bare specs (no components.securitySchemes,
|
|
365
|
+
// empty per-endpoint .security — GitHub publishes its OpenAPI this
|
|
366
|
+
// way), zond's workspace-level conventions still wire `auth_token`
|
|
367
|
+
// end-to-end (ARV-201 seeds it in .env.yaml; zond request — see
|
|
368
|
+
// resolveAdHocRequest — auto-attaches `Authorization: Bearer
|
|
369
|
+
// {{auth_token}}`). Mirror that fallback into the live-call path so
|
|
370
|
+
// probes (mass-assignment / security) and stateful create-steps don't
|
|
371
|
+
// 401 their baseline on these specs. Without this, the whole
|
|
372
|
+
// depth-pass on GitHub-style APIs stays unauth even after ARV-212
|
|
373
|
+
// emitted the suite-level Bearer header for `zond run`.
|
|
374
|
+
if (schemes.length === 0) {
|
|
375
|
+
const tok = vars["auth_token"];
|
|
376
|
+
if (typeof tok === "string" && tok.length > 0) {
|
|
377
|
+
return { Authorization: `Bearer ${tok}` };
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
return {};
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
// Two-pass walk: prefer bearer/apiKey over basic (ARV-148, mirrors the
|
|
384
|
+
// generator-side fix in `getAuthHeaders` above). Without this, every
|
|
385
|
+
// prepare-fixtures discover/seed request on Stripe-style APIs picks the
|
|
386
|
+
// first declared scheme (basicAuth) and ships the raw `sk_test_…` token
|
|
387
|
+
// as Basic Auth credentials → Stripe base64-decodes the garbage and
|
|
388
|
+
// returns 401 across 98/98 vars.
|
|
389
|
+
const tryScheme = (scheme: SecuritySchemeInfo): Record<string, string> | undefined => {
|
|
390
|
+
if (scheme.type === "http") {
|
|
391
|
+
if (scheme.scheme === "bearer" || !scheme.scheme) {
|
|
392
|
+
const tok = vars["auth_token"];
|
|
393
|
+
if (tok) return { Authorization: `Bearer ${tok}` };
|
|
394
|
+
}
|
|
395
|
+
if (scheme.scheme === "basic") {
|
|
396
|
+
const tok = vars["auth_token"];
|
|
397
|
+
if (tok) return { Authorization: `Basic ${tok}` };
|
|
398
|
+
}
|
|
399
|
+
}
|
|
400
|
+
if (scheme.type === "apiKey" && scheme.in === "header" && scheme.apiKeyName) {
|
|
401
|
+
if (scheme.apiKeyName === "Authorization") {
|
|
402
|
+
const tok = vars["auth_token"];
|
|
403
|
+
if (tok) return { Authorization: `Bearer ${tok}` };
|
|
404
|
+
}
|
|
405
|
+
const key = vars["api_key"];
|
|
406
|
+
if (key) return { [scheme.apiKeyName]: key };
|
|
407
|
+
}
|
|
408
|
+
return undefined;
|
|
409
|
+
};
|
|
410
|
+
|
|
411
|
+
const isBasic = (s: SecuritySchemeInfo): boolean =>
|
|
412
|
+
s.type === "http" && s.scheme === "basic";
|
|
413
|
+
|
|
414
|
+
// Pass 1: skip basic.
|
|
415
|
+
for (const secName of ep.security) {
|
|
416
|
+
const scheme = schemes.find(s => s.name === secName);
|
|
417
|
+
if (!scheme || isBasic(scheme)) continue;
|
|
418
|
+
const headers = tryScheme(scheme);
|
|
419
|
+
if (headers) return headers;
|
|
420
|
+
}
|
|
421
|
+
// Pass 2: basic fallback.
|
|
422
|
+
for (const secName of ep.security) {
|
|
423
|
+
const scheme = schemes.find(s => s.name === secName);
|
|
424
|
+
if (!scheme || !isBasic(scheme)) continue;
|
|
425
|
+
const headers = tryScheme(scheme);
|
|
426
|
+
if (headers) return headers;
|
|
427
|
+
}
|
|
428
|
+
return {};
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
// ──────────────────────────────────────────────
|
|
432
|
+
// ARV-153: semantic classification of POST operations
|
|
433
|
+
// ──────────────────────────────────────────────
|
|
434
|
+
|
|
435
|
+
/**
|
|
436
|
+
* ARV-153: action verbs that, when they appear as the last path segment,
|
|
437
|
+
* mark a POST as "operates on an existing resource" rather than
|
|
438
|
+
* "allocates a new one". A DELETE counterpart is meaningless for these —
|
|
439
|
+
* there's nothing to delete because nothing new was created.
|
|
440
|
+
*
|
|
441
|
+
* Examples that fit this pattern:
|
|
442
|
+
* POST /v1/charges/{id}/capture
|
|
443
|
+
* POST /v1/customers/{id}/sources/{src}/verify
|
|
444
|
+
* POST /v1/payment_intents/{id}/cancel
|
|
445
|
+
* POST /v1/users/{id}/activate
|
|
446
|
+
* POST /api/messages/{id}/resend
|
|
447
|
+
*
|
|
448
|
+
* Compound forms ("mark-as-read", "send-email", "verify-otp") are also
|
|
449
|
+
* recognised — we look at the first slug segment ("mark", "send", "verify").
|
|
450
|
+
*
|
|
451
|
+
* Conservative on purpose: a misclassified create-resource attacked without
|
|
452
|
+
* cleanup leaks. Verbs that double as nouns ("filter", "lock"…) are kept
|
|
453
|
+
* out; add only when a real-world spec proves the false-positive risk is
|
|
454
|
+
* lower than the recall win.
|
|
455
|
+
*/
|
|
456
|
+
const ACTION_VERBS = new Set([
|
|
457
|
+
"accept", "acknowledge", "activate", "approve", "archive", "attach",
|
|
458
|
+
"cancel", "capture", "check", "claim", "clone", "close", "complete",
|
|
459
|
+
"confirm", "copy", "deactivate", "decline", "decrypt", "demote", "deploy",
|
|
460
|
+
"detach", "disable", "disconnect", "dismiss", "dispatch", "duplicate",
|
|
461
|
+
"enable", "encrypt", "execute", "expire", "export", "fail", "finalize",
|
|
462
|
+
"fork", "ignore", "import", "invalidate", "invite", "link", "lookup",
|
|
463
|
+
"merge", "mute", "notify", "pause", "ping", "preview", "process",
|
|
464
|
+
"promote", "publish", "purge", "queue", "reactivate", "rebuild", "redeem",
|
|
465
|
+
"refresh", "refund", "register", "reject", "release", "remind",
|
|
466
|
+
"render", "renew", "reopen", "report", "reprocess", "request", "resend",
|
|
467
|
+
"reset", "resolve", "restart", "restore", "resubmit", "resume", "retry",
|
|
468
|
+
"revert", "review", "revoke", "rollback", "rotate", "run", "schedule",
|
|
469
|
+
"search", "send", "settle", "share", "snooze", "start", "stop", "submit",
|
|
470
|
+
"subscribe", "suspend", "swap", "sync", "test", "transfer", "trigger",
|
|
471
|
+
"unarchive", "unassign", "unblock", "unlink", "unlock", "unmute",
|
|
472
|
+
"unpublish", "unshare", "unsubscribe", "unsuspend", "validate", "verify",
|
|
473
|
+
"void", "withdraw",
|
|
474
|
+
]);
|
|
475
|
+
|
|
476
|
+
export type PostSemantics = "action" | "create-resource" | "unknown";
|
|
477
|
+
|
|
478
|
+
/** ARV-153: classify a POST endpoint by looking at the last path segment.
|
|
479
|
+
* Returns "action" when the verb at the tail clearly identifies the
|
|
480
|
+
* operation as a side-effecting verb against an existing resource (no
|
|
481
|
+
* new resource allocated → no DELETE counterpart needed). Conservative:
|
|
482
|
+
* unknown verbs fall back to "create-resource", which keeps the existing
|
|
483
|
+
* cleanup-feasibility gate intact for safety. */
|
|
484
|
+
export function classifyPostSemantics(ep: EndpointInfo): PostSemantics {
|
|
485
|
+
if (ep.method.toUpperCase() !== "POST") return "unknown";
|
|
486
|
+
const segments = ep.path.split("/").filter(Boolean);
|
|
487
|
+
if (segments.length === 0) return "unknown";
|
|
488
|
+
const last = segments[segments.length - 1]!.toLowerCase();
|
|
489
|
+
if (last.startsWith("{")) return "unknown";
|
|
490
|
+
if (ACTION_VERBS.has(last)) return "action";
|
|
491
|
+
// Compound action forms: "mark-as-read", "send-email", "verify-otp",
|
|
492
|
+
// "request_reset", "do.export". Use first slug as the verb candidate.
|
|
493
|
+
const head = last.split(/[-_.]/)[0]!;
|
|
494
|
+
if (head && ACTION_VERBS.has(head)) return "action";
|
|
495
|
+
return "create-resource";
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
export function hasJsonBody(ep: EndpointInfo): boolean {
|
|
499
|
+
return (
|
|
500
|
+
ep.method !== "GET" &&
|
|
501
|
+
ep.method !== "DELETE" &&
|
|
502
|
+
ep.requestBodyContentType === "application/json" &&
|
|
503
|
+
ep.requestBodySchema !== undefined
|
|
504
|
+
);
|
|
505
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `StaticProbe` — Probe-contract wrapper around the static-input probe
|
|
3
|
+
* generators (validation + methods) (m-17 / ARV-49).
|
|
4
|
+
*
|
|
5
|
+
* Static probes don't make HTTP calls — they emit YAML suites the user
|
|
6
|
+
* later runs through `zond run`. dryRun lists the endpoints + classes
|
|
7
|
+
* that would have suites generated; run() invokes the generators and
|
|
8
|
+
* returns the produced files via `extras` (the CLI handler is
|
|
9
|
+
* responsible for writing them — see `probe-static.ts`). This keeps
|
|
10
|
+
* static under the same Probe contract as live probes (ARV-49 #3)
|
|
11
|
+
* without forcing an artificial dry-run / run distinction the
|
|
12
|
+
* generator never had.
|
|
13
|
+
*/
|
|
14
|
+
import type { Probe, ProbeContext, ProbeFlags, EndpointPlan, ProbeResult, ProbeReportFormat, ProbeEndpointResult } from "./types.ts";
|
|
15
|
+
import { generateNegativeProbes } from "./negative-probe.ts";
|
|
16
|
+
import { generateMethodProbes } from "./method-probe.ts";
|
|
17
|
+
|
|
18
|
+
const ALL_CLASSES = ["validation", "methods"] as const;
|
|
19
|
+
type StaticClass = typeof ALL_CLASSES[number];
|
|
20
|
+
|
|
21
|
+
const FLAGS: ProbeFlags = {
|
|
22
|
+
api: true,
|
|
23
|
+
tag: true,
|
|
24
|
+
include: true,
|
|
25
|
+
exclude: true,
|
|
26
|
+
// Static probes have no live mode — dry-run vs run is not meaningful.
|
|
27
|
+
// The interface still requires the slot; we expose it as a no-op
|
|
28
|
+
// (`dryRun` returns the same list `run` would produce, just without
|
|
29
|
+
// writing files).
|
|
30
|
+
dryRun: false,
|
|
31
|
+
listTags: true,
|
|
32
|
+
json: true,
|
|
33
|
+
output: true,
|
|
34
|
+
report: true,
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
function classesFromCtx(ctx: ProbeContext): StaticClass[] {
|
|
38
|
+
const raw = ctx.classes ?? [...ALL_CLASSES];
|
|
39
|
+
return raw.filter((c): c is StaticClass => c === "validation" || c === "methods");
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export class StaticProbe implements Probe {
|
|
43
|
+
readonly name = "static";
|
|
44
|
+
readonly description =
|
|
45
|
+
"Generate static-input probe suites: validation (bogus types/values) + methods (undeclared HTTP methods). Spec-only; no live traffic.";
|
|
46
|
+
readonly commonFlags = FLAGS;
|
|
47
|
+
|
|
48
|
+
async dryRun(ctx: ProbeContext): Promise<EndpointPlan[]> {
|
|
49
|
+
const classes = classesFromCtx(ctx);
|
|
50
|
+
return ctx.endpoints.map((ep) => ({
|
|
51
|
+
path: ep.path,
|
|
52
|
+
method: ep.method.toUpperCase(),
|
|
53
|
+
planned: true,
|
|
54
|
+
classes_planned: [...classes],
|
|
55
|
+
fields_planned: [],
|
|
56
|
+
skip_reason: null,
|
|
57
|
+
}));
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
async run(ctx: ProbeContext): Promise<ProbeResult> {
|
|
61
|
+
const classes = classesFromCtx(ctx);
|
|
62
|
+
const include: StaticClass[] = classes;
|
|
63
|
+
|
|
64
|
+
const endpoints: ProbeEndpointResult[] = [];
|
|
65
|
+
let totalProbes = 0;
|
|
66
|
+
const warnings: string[] = [];
|
|
67
|
+
const suitesPerClass: Record<string, unknown> = {};
|
|
68
|
+
|
|
69
|
+
if (include.includes("validation")) {
|
|
70
|
+
const r = generateNegativeProbes({
|
|
71
|
+
endpoints: ctx.endpoints,
|
|
72
|
+
securitySchemes: ctx.securitySchemes,
|
|
73
|
+
maxProbesPerEndpoint: ctx.options["maxPerEndpoint"] as number | undefined,
|
|
74
|
+
noCleanup: ctx.options["noCleanup"] === true,
|
|
75
|
+
useRealParents: ctx.options["useRealParents"] !== false,
|
|
76
|
+
});
|
|
77
|
+
suitesPerClass["validation"] = {
|
|
78
|
+
suites: r.suites,
|
|
79
|
+
probedEndpoints: r.probedEndpoints,
|
|
80
|
+
skippedEndpoints: r.skippedEndpoints,
|
|
81
|
+
totalProbes: r.totalProbes,
|
|
82
|
+
warnings: r.warnings,
|
|
83
|
+
};
|
|
84
|
+
totalProbes += r.totalProbes;
|
|
85
|
+
for (const w of r.warnings) warnings.push(w);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
if (include.includes("methods")) {
|
|
89
|
+
const r = generateMethodProbes({
|
|
90
|
+
endpoints: ctx.endpoints,
|
|
91
|
+
securitySchemes: ctx.securitySchemes,
|
|
92
|
+
});
|
|
93
|
+
suitesPerClass["methods"] = {
|
|
94
|
+
suites: r.suites,
|
|
95
|
+
probedPaths: r.probedPaths,
|
|
96
|
+
skippedPaths: r.skippedPaths,
|
|
97
|
+
totalProbes: r.totalProbes,
|
|
98
|
+
};
|
|
99
|
+
totalProbes += r.totalProbes;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
return {
|
|
103
|
+
endpoints,
|
|
104
|
+
summary: {
|
|
105
|
+
totalEndpoints: ctx.endpoints.length,
|
|
106
|
+
probed: ctx.endpoints.length,
|
|
107
|
+
by_status: { ok: ctx.endpoints.length, high: 0, low: 0, inconclusive: 0, skipped: 0 },
|
|
108
|
+
},
|
|
109
|
+
warnings,
|
|
110
|
+
extras: { classes: include, suites: suitesPerClass, totalProbes },
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
report(format: ProbeReportFormat, result: ProbeResult): string | object {
|
|
115
|
+
if (format === "markdown") {
|
|
116
|
+
const totalProbes = (result.extras?.["totalProbes"] as number) ?? 0;
|
|
117
|
+
const classes = (result.extras?.["classes"] as string[]) ?? [];
|
|
118
|
+
return `Generated ${totalProbes} static-input probe(s) for class(es): ${classes.join(", ")}`;
|
|
119
|
+
}
|
|
120
|
+
return {
|
|
121
|
+
summary: result.summary,
|
|
122
|
+
...(result.extras ?? {}),
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
}
|