Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lint: validate avd_id #331

Merged
merged 1 commit into from
Jan 31, 2025
Merged

lint: validate avd_id #331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions .regal/rules/custom/regal/rules/custom/invalid-metadata/invalid_metadata.rego
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,35 @@ report contains _violation_check(lib_metadata_schema) if _is_lib_package

report contains _violation_check(check_metadata_schema) if not _is_lib_package

report contains violation if {
some annot in _pkg_annotations
message := _validate_avd_id(annot.custom.avd_id)
violation := _build_violation(annot, [message])
}

_is_lib_package if input["package"].path[1].value == "lib"

_violation_check(schema) := violation if {
some annot in input["package"].annotations
annot.scope == "package"
_pkg_annotations := [annot | some annot in input["package"].annotations; annot.scope == "package"]

_avd_id_pattern := `^AVD-(AWS|GCP|DIG|AZU|KCV|KSV|DS|GIT|NIF|KUBE|OPNSTK|CLDSTK|OCI)-\d+$`

_validate_avd_id(id) := sprintf("avd_id (%s): Does not match pattern '%s'", [id, _avd_id_pattern]) if {
not regex.match(_avd_id_pattern, id)
}

_build_violation(annot, errors) := result.fail(
rego.metadata.chain(),
object.union(
result.location(annot),
{"description": concat("\n", errors)},
),
)

_violation_check(schema) := _build_violation(annot, error_messages) if {
some annot in _pkg_annotations
[match, errors] := json.match_schema(annot.custom, schema)
not match

error_messages := [err.error | some err in errors]

violation := result.fail(
rego.metadata.chain(),
object.union(
result.location(annot),
{"description": concat("\n", error_messages)},
),
)
}

lib_metadata_schema := {
Expand Down