YAML Syntax Errors in Continuous Audit Metrics #57
Comments
|
Refer to PR #59. Fixed the schema related issues. |
|
Sounds like we should also add yamllint to the actions. E.g. jobs: |
|
Agree w/ @pritikin. Should we additional rules for the CAM yaml in addition to foundational yaml linting? Are there any such rules that we want to advance in validation as part of github actions? |
|
Some syntax errors are just the result of working on new metrics as a draft. The tool we built already does a form of YAML syntax verification. I'm not sure it was effectively used recently, which might explain some syntax errors. The objective is, however, to run that validation tool automatically each time the YAML dataset is updated. But having valid YAML is only half the problem: we also need to check that the YAML dataset complies with our "schema". For example, |
|
I added a YAML schema validator in PR #63 |
|
I did some tests with If you run But in reality, these are not YAML errors. If we disable these checks, and re-run the This seems to suggest that running an additional linter for YAML is not necessary. |
|
PR #66 fixes the remaining closing quote issues. I think the rest are fixed at this point. Using the schema in PR #66 I see the following errors. They are related to metrics that do not have sloRecommendations (something starred on the wiki and maintained as required in the JSON schema) or rules without any text (also mandated but missing in some current metrics). Similarly implementationGuidelines are missing for two metrics. |
Per discussion in #52 (comment), there are some YAML syntax and formatting errors that need to be addressed. There are probably a few methods to test this out yourself, but I happened to encounter this because I occasionally use VS Code and use the YAML Language Support Plugin, ID:
redhat.vscode-yamland it presented the following errors. Since they are JSON-like, I will embed them in a code snippet below.If you want assistance from outside contributors, feel free to indicate and I can try to assist, time permitting and if you are interested.
[{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Implicit keys need to be on a single line", "source": "YAML", "startLineNumber": 1222, "startColumn": 3, "endLineNumber": 1222, "endColumn": 78 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Implicit map keys need to be followed by map values", "source": "YAML", "startLineNumber": 1222, "startColumn": 3, "endLineNumber": 1222, "endColumn": 78 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Missing closing 'quote", "source": "YAML", "startLineNumber": 1301, "startColumn": 1, "endLineNumber": 1301, "endColumn": 2 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Implicit map keys need to be followed by map values", "source": "YAML", "startLineNumber": 1302, "startColumn": 1, "endLineNumber": 1302, "endColumn": 3 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Missing closing 'quote", "source": "YAML", "startLineNumber": 1302, "startColumn": 2, "endLineNumber": 1302, "endColumn": 3 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Map keys must be unique", "source": "YAML", "startLineNumber": 1303, "startColumn": 1, "endLineNumber": 1303, "endColumn": 14 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Implicit map keys need to be followed by map values", "source": "YAML", "startLineNumber": 1371, "startColumn": 1, "endLineNumber": 1371, "endColumn": 3 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Missing closing 'quote", "source": "YAML", "startLineNumber": 1371, "startColumn": 2, "endLineNumber": 1371, "endColumn": 3 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Implicit keys need to be on a single line", "source": "YAML", "startLineNumber": 1381, "startColumn": 1, "endLineNumber": 1381, "endColumn": 3 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Implicit map keys need to be followed by map values", "source": "YAML", "startLineNumber": 1381, "startColumn": 1, "endLineNumber": 1381, "endColumn": 3 }][{ "resource": "/c:/Users/myusername/path/to/code/continuous-audit-metrics/data/primary-dataset.yml", "owner": "_generated_diagnostic_collection_name_#6", "severity": 8, "message": "Missing closing 'quote", "source": "YAML", "startLineNumber": 1415, "startColumn": 1, "endLineNumber": 1415, "endColumn": 1 }]The text was updated successfully, but these errors were encountered: