feat: Gator sync test support

[anlandu]

What this PR does / why we need it:
Certain templates require replicating into OPA to enable correct evaluation. These templates can use the annotation metadata.gatekeeper.sh/requires-sync-data to indicate which resources need to be synced. This template annotation is descriptive, not prescriptive. The prescription of which resources to sync is done in SyncSet resources and/or the Gatekeeper Config resource. The management of these various requirements can get challenging as the number of templates requiring replicated data increases.

gator sync test aims to mitigate this challenge by enabling the user to verify their sync configuration is correct. The user passes in any number of Constraint Templates, SyncSets, and a Gatekeeper Config object, along with a GVK manifest listing the GVKs supported by the cluster under test, and the command will determine which requirements enumerated by the Constraint Templates are unfulfilled by the given SyncSet(s), Config, and/or manifest.

PRD

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
xref #2393

Special notes for your reviewer:

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 35.79545% with 226 lines in your changes are missing coverage. Please review.

Project coverage is 46.43%. Comparing base (3350319) to head (935b85b).
Report is 58 commits behind head on master.

Files	Patch %	Lines
apis/gvkmanifest/v1alpha1/zz_generated.deepcopy.go	0.00%	105 Missing ⚠️
pkg/gator/reader/read_resources.go	0.00%	58 Missing ⚠️
cmd/gator/sync/test/test.go	0.00%	25 Missing ⚠️
pkg/gator/sync/test/test.go	79.34%	12 Missing and 7 partials ⚠️
pkg/cachemanager/parser/syncannotationreader.go	30.00%	14 Missing ⚠️
cmd/gator/sync/sync.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3098      +/-   ##
==========================================
- Coverage   54.49%   46.43%   -8.06%     
==========================================
  Files         134      225      +91     
  Lines       12329    15112    +2783     
==========================================
+ Hits         6719     7018     +299     
- Misses       5116     7283    +2167     
- Partials      494      811     +317     

Flag	Coverage Δ
unittests	46.43% <35.79%> (-8.06%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[anlandu]

@julianKatz @acpana

[acpana]

This looks really good 💯 !! Thanks for working on it.

A few questions and suggestions.

[anlandu]

@ritazh Definitely! I'll finish up these last comments next week.

[julianKatz]

Do we not have helper methods like these in the code somewhere already? Perhaps not but they seem to straightforward and helpful i'd be surprised.

[anlandu]

That's a great question lol, do you remember seeing anything back when these were written in the gator test PR

[acpana]

LGTM modulo small nit around testing

[anlandu]

Thanks for all the comments so far, let me know if you have any thoughts @ritazh @sozercan @maxsmythe!

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.