Commit 4e09b52
authored
feat(core): new validation report schema (#37970)
### Reason for this change
The CDK CLI `validate` command (aws/aws-cdk-cli#1515) introduces a new validation report schema in `cloud-assembly-schema`. The framework needs to produce output matching this new schema so the CLI can consume it via `Manifest.loadValidationReport`.
The old report format (`policy-validation-report.json`) must remain available for backwards compatibility with older CLI versions.
### Description of changes
- Adds a new `formatJson` method to `PolicyValidationReportFormatter` that produces the new schema-compliant report format:
- Top-level `version` field (cloud assembly schema version)
- Flat `pluginName`/`conclusion` (replaces nested `summary`)
- Typed `severity` enum (`fatal|error|warning|info|custom`)
- `violatingConstructs` with `constructFqn`, `libraryVersion`, `cloudFormationResource`, `stackTraces`
- `suggestedFix` (replaces `fix`)
- New report is written to `validation-report.json` by default
- Old report (`policy-validation-report.json`) is only written when `@aws-cdk/core:validationReportJson` context key is set to `true`
- Renames old format interfaces to `Legacy*`, new ones get the clean names
- Adds constants to `cx-api`: `VALIDATION_REPORT_FILE`, `LEGACY_VALIDATION_REPORT_FILE`, `VALIDATION_REPORT_JSON_CONTEXT`
### Describe any new or updated permissions being added
N/A
### Description of how you validated changes
- All 47 validation unit tests pass
- Added tests for legacy report opt-in and default behavior
- Verified report output passes JSON schema validation matching `validation-report.schema.json` from the CLI PR
### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*1 parent 8e25d78 commit 4e09b52
4 files changed
Lines changed: 274 additions & 78 deletions
File tree
- packages/aws-cdk-lib
- core
- lib
- private
- validation/private
- test/validation
- cx-api/lib
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| |||
198 | 198 | | |
199 | 199 | | |
200 | 200 | | |
201 | | - | |
202 | | - | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
203 | 205 | | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
204 | 213 | | |
205 | 214 | | |
206 | 215 | | |
| |||
Lines changed: 138 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
| 50 | + | |
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
| 76 | + | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| |||
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
106 | 151 | | |
107 | 152 | | |
108 | 153 | | |
| |||
113 | 158 | | |
114 | 159 | | |
115 | 160 | | |
116 | | - | |
| 161 | + | |
117 | 162 | | |
118 | 163 | | |
119 | 164 | | |
| |||
187 | 232 | | |
188 | 233 | | |
189 | 234 | | |
190 | | - | |
| 235 | + | |
191 | 236 | | |
192 | 237 | | |
193 | 238 | | |
| |||
234 | 279 | | |
235 | 280 | | |
236 | 281 | | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
237 | 368 | | |
238 | 369 | | |
239 | 370 | | |
| |||
0 commit comments