Skip to content

Validate config.yml on server startup #37

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

Open
NDB-7 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Validate config.yml on server startup #37

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
22 changes: 22 additions & 0 deletions server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,24 @@ class DeploymentStatus:
is_dev: bool = False


REQUIRED_REPO_FIELDS = {
f.name for f in dataclasses.fields(RepoConfig)
if f.default == dataclasses.MISSING and f.default_factory == dataclasses.MISSING
}


def validate_config(repo: dict):
missing = REQUIRED_REPO_FIELDS - repo.keys()
if missing:
raise SystemExit(f"[config] Repo '{repo.get('name', '?')}' is missing fields: {missing}")
if not os.path.isdir(repo["path"]):
raise SystemExit(f"[config] Path does not exist for repo '{repo['name']}': {repo['path']}")
unknown_fields = repo.keys() - {f.name for f in dataclasses.fields(RepoConfig)} # set of all fields in RepoConfig
if unknown_fields:
logger.warning(f"[config] Repo '{repo.get('name', '?')}' has unknown fields: {unknown_fields}")
return unknown_fields


def get_args():
parser = argparse.ArgumentParser(description="SCE CICD Server")
parser.add_argument(
Expand Down Expand Up @@ -400,6 +418,10 @@ def should_skip_deployment(files_changed: List[str], ignore_patterns: List[str])
# make a new entry into the result dictionary
# the key is a tuple of the repo name and branch
# the value is a RepoToWatch object
unknown_fields = validate_config(r)
if unknown_fields: # removes any extra fields not in RepoConfig
for f in unknown_fields:
r.pop(f)
cfg = RepoConfig(**r)
REPO_MAP[(cfg.name, cfg.branch)] = cfg
except Exception:
Expand Down