Skip to content

validate-blocked-edges.py: enforce CamelCase names #4059

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

Merged
openshift-merge-robot merged 1 commit into from
Sep 7, 2023
Merged

validate-blocked-edges.py: enforce CamelCase names #4059

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
11 changes: 8 additions & 3 deletions hack/validate-blocked-edges.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
#!/usr/bin/env python

import os

import re
import util

# Risk names must be CamelCase to be assignable to condition.Reason
# https://github.com/openshift/api/blob/8891815aa476232109dccf6c11b8611d209445d9/vendor/k8s.io/apimachinery/pkg/apis/meta/v1/types.go#L1519-L1520C3
# Note that our regex is stricter, we should never need names more complicated than this.
NAME_RE = re.compile(r'^[A-Z][A-Za-z0-9_]*$')


def validate_blocked_edges(directory):
for path, data in util.walk_yaml(directory=directory, allowed_extensions=('.yaml',)):
Expand All @@ -24,8 +29,8 @@ def validate_blocked_edge(data, path):

if 'url' in data and not data['url'].startswith('https://'):
raise ValueError('url must be an https:// URI, not {!r}'.format(data['url']))
if 'name' in data and (not isinstance(data['name'], str) or ' ' in data['name']):
raise ValueError('name must be a CamelCase reason, not {!r}'.format(data['name']))
if 'name' in data and not (isinstance(data['name'], str) and NAME_RE.match(data['name'])):
raise ValueError('name must be a CamelCase reason, not {!r} (must match {!r}'.format(data['name'], NAME_RE.pattern))
if 'message' in data and not isinstance(data['message'], str):
raise ValueError('message must be a string, not {!r}'.format(data['message']))
if 'matchingRules' in data:
Expand Down