From 11adadb1852a18aa25e7684268464b67b5d14da5 Mon Sep 17 00:00:00 2001
From: Yann Hamon <yann@mandragor.org>
Date: Sun, 16 Oct 2022 14:57:49 +0200
Subject: [PATCH] Update flags description, add integration tests and update
 readme

---
 Readme.md            | 15 +++++++++++++--
 acceptance.bats      | 12 ++++++++++++
 pkg/config/config.go |  4 ++--
 3 files changed, 27 insertions(+), 4 deletions(-)

diff --git a/Readme.md b/Readme.md
index 46dda20..4d26201 100644
--- a/Readme.md
+++ b/Readme.md
@@ -92,11 +92,11 @@ Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]...
   -output string
         output format - json, junit, tap, text (default "text")
   -reject string
-        comma-separated list of kinds to reject
+        comma-separated list of kinds or GVKs to reject
   -schema-location value
         override schemas location search path (can be specified multiple times)
   -skip string
-        comma-separated list of kinds to ignore
+        comma-separated list of kinds or GVKs to ignore
   -strict
         disallow additional properties not in schema or duplicated keys
   -summary
@@ -145,6 +145,17 @@ cat fixtures/valid.yaml  | ./bin/kubeconform -summary
 Summary: 1 resource found parsing stdin - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
 ```
 
+* Validating a file, ignoring its resource using both Kind, and GVK (Group, Version, Kind) notations
+```
+# This will ignore ReplicationController for all apiVersions
+./bin/kubeconform -summary -skip ReplicationController fixtures/valid.yaml
+Summary: 1 resource found in 1 file - Valid: 0, Invalid: 0, Errors: 0, Skipped: 1
+
+# This will ignore ReplicationController only for apiVersion v1
+$ ./bin/kubeconform -summary -skip v1/ReplicationController fixtures/valid.yaml
+Summary: 1 resource found in 1 file - Valid: 0, Invalid: 0, Errors: 0, Skipped: 1
+```
+
 * Validating a folder, increasing the number of parallel workers
 ```
 $ ./bin/kubeconform -summary -n 16 fixtures
diff --git a/acceptance.bats b/acceptance.bats
index e16c220..a8525ad 100755
--- a/acceptance.bats
+++ b/acceptance.bats
@@ -218,6 +218,18 @@ resetCacheFolder() {
   [ "$output" = "fixtures/valid.yaml - bob ReplicationController skipped" ]
 }
 
+@test "Skip when parsing a resource with a GVK to skip" {
+  run bin/kubeconform -verbose -skip v1/ReplicationController fixtures/valid.yaml
+  [ "$status" -eq 0 ]
+  [ "$output" = "fixtures/valid.yaml - bob ReplicationController skipped" ]
+}
+
+@test "Do not skip when parsing a resource with a GVK to skip, where the Kind matches but not the version" {
+  run bin/kubeconform -verbose -skip v2/ReplicationController fixtures/valid.yaml
+  [ "$status" -eq 0 ]
+  [ "$output" = "fixtures/valid.yaml - ReplicationController bob is valid" ]
+}
+
 @test "Fail when parsing a resource from a kind to reject" {
   run bin/kubeconform -verbose -reject ReplicationController fixtures/valid.yaml
   [ "$status" -eq 1 ]
diff --git a/pkg/config/config.go b/pkg/config/config.go
index 85be2a0..b64a3c1 100644
--- a/pkg/config/config.go
+++ b/pkg/config/config.go
@@ -65,8 +65,8 @@ func FromFlags(progName string, args []string) (Config, string, error) {
 
 	flags.StringVar(&c.KubernetesVersion, "kubernetes-version", "master", "version of Kubernetes to validate against, e.g.: 1.18.0")
 	flags.Var(&schemaLocationsParam, "schema-location", "override schemas location search path (can be specified multiple times)")
-	flags.StringVar(&skipKindsCSV, "skip", "", "comma-separated list of kinds to ignore")
-	flags.StringVar(&rejectKindsCSV, "reject", "", "comma-separated list of kinds to reject")
+	flags.StringVar(&skipKindsCSV, "skip", "", "comma-separated list of kinds or GVKs to ignore")
+	flags.StringVar(&rejectKindsCSV, "reject", "", "comma-separated list of kinds or GVKs to reject")
 	flags.BoolVar(&c.Debug, "debug", false, "print debug information")
 	flags.BoolVar(&c.ExitOnError, "exit-on-error", false, "immediately stop execution when the first error is encountered")
 	flags.BoolVar(&c.IgnoreMissingSchemas, "ignore-missing-schemas", false, "skip files with missing schemas instead of failing")