mirror of
https://github.com/fleetdm/fleet
synced 2026-05-24 09:28:54 +00:00
d5eee802eb
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #40496 # Details This is the first phase of an effort to detect unknown keys in GitOps .yml files. In the regular `fleetctl gitops` case, it will fail when unknown keys are detected. This behavior can be changed with a new `--allow-unknown-keys` flag which will log the issues and continue. In this first phase we are detecting unknown keys in _most_ GitOps sections, other than the top-level `org_settings:` and `settings:` sections which have more complicated typing. I will tackle those separately as they require a bit more thought. Also ultimately I'd like us to be doing this validation in a more top-down fashion in one place, rather than spreading it across the code by doing it in each individual section, but this is a good first step. As a bonus, I invited my pal Mr. Levenshtein to the party so that we can make suggestions when unknown keys are detected, like: ``` * unknown key "queyr" in "./lib/some-report.yml"; did you mean "query"? ``` > Note: the goal is to return as many validation errors as possible to the user, so they don't have to keep running `fleetctl gitops` to get the next error. I did _not_ update any other errors to stop returning early, in an effort to keep this as low-touch as possible. # Checklist for submitter If some of the following don't apply, delete the relevant line. - [X] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. ## Testing - [X] Added/updated automated tests - [X] QA'd all new/changed functionality manually - [X] Tested this against existing it-and-security folder and one with updated keys from https://github.com/fleetdm/fleet/pull/40959; no unknown keys detected - [X] Added unknown keys at various levels, GitOps errored with helpful messages - [X] Same as above but with `--allow-unknown-keys`; GitOps outputted helpful messages but continued. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * GitOps runs now fail when unknown or misspelled keys are present in configuration files. * New CLI flag --allow-unknown-keys lets unknown keys be treated as warnings instead of errors. * Unknown-key messages include suggested valid key names to help correct mistakes. * **Tests** * Expanded test coverage to validate unknown-key detection and the allow-as-warning option. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Ian Littman <iansltx@gmail.com> |
||
|---|---|---|
| .. | ||
| testdata | ||
| testing_utils | ||
| api.go | ||
| api_test.go | ||
| apply.go | ||
| apply_test.go | ||
| config.go | ||
| config_test.go | ||
| convert.go | ||
| convert_test.go | ||
| debug.go | ||
| debug_test.go | ||
| delete.go | ||
| delete_test.go | ||
| docker_test.go | ||
| flags.go | ||
| fleetctl.go | ||
| generate.go | ||
| generate_gitops.go | ||
| generate_gitops_test.go | ||
| generate_test.go | ||
| get.go | ||
| get_test.go | ||
| gitops.go | ||
| gitops_test.go | ||
| goquery.go | ||
| hosts.go | ||
| hosts_test.go | ||
| kill_process.go | ||
| kill_process_windows.go | ||
| login.go | ||
| logout.go | ||
| logout_test.go | ||
| mdm.go | ||
| mdm_test.go | ||
| package.go | ||
| preview.go | ||
| query.go | ||
| query_output.go | ||
| query_test.go | ||
| scripts.go | ||
| scripts_test.go | ||
| session_test.go | ||
| setup.go | ||
| testing_utils.go | ||
| trigger.go | ||
| trigger_test.go | ||
| upgrade_packs.go | ||
| upgrade_packs_test.go | ||
| user.go | ||
| users_test.go | ||
| vulnerability_data_stream.go | ||