fix: rename duration to timeout (#55)

Signed-off-by: Charles-Edouard Brétéché <[email protected]>

README.md

@@ -2,4 +2,4 @@
 
 This repository contains the tool used by kyverno for defining and running end to end tests.
 
-It can be used to test any Kubernetes operator.
+It can be used to test any Kubernetes operator.

pkg/commands/test/command.go

@@ -124,7 +124,7 @@ func Command() *cobra.Command {
 			return nil
 		},
 	}
-	cmd.Flags().DurationVar(&options.timeout.Duration, "duration", 30*time.Second, "The duration to use as default for configuration.")
+	cmd.Flags().DurationVar(&options.timeout.Duration, "timeout", 30*time.Second, "The timeout to use as default for configuration.")
 	cmd.Flags().StringVar(&options.config, "config", "", "Chainsaw configuration file.")
 	cmd.Flags().StringSliceVar(&options.testDirs, "testDirs", []string{}, "Directories containing test cases to run.")
 	cmd.Flags().BoolVar(&options.skipDelete, "skipDelete", false, "If set, do not delete the resources after running the tests.")

pkg/commands/test/command_test.go

@@ -26,18 +26,18 @@ func TestChainsawCommand(t *testing.T) {
 			out:     filepath.Join(basePath, "default.txt"),
 		},
 		{
-			name: "with duration",
+			name: "with timeout",
 			args: []string{
-				"--duration",
+				"--timeout",
 				"10s",
 			},
 			wantErr: false,
 			out:     filepath.Join(basePath, "without_config.txt"),
 		},
 		{
-			name: "invalid duration",
+			name: "invalid timeout",
 			args: []string{
-				"--duration",
+				"--timeout",
 				"invalid",
 			},
 			wantErr: true,
@@ -118,7 +118,7 @@ func TestChainsawCommand(t *testing.T) {
 			args: []string{
 				"--config",
 				filepath.Join(basePath, "config/config_all_fields.yaml"),
-				"--duration",
+				"--timeout",
 				"10s",
 			},
 			wantErr: false,

website/docs/commands/chainsaw_test.md

@@ -10,7 +10,6 @@ chainsaw test [flags]... [test directories]...
 
 ```
       --config string          Chainsaw configuration file.
-      --duration duration      The duration to use as default for configuration. (default 30s)
       --fullName               Use full test case folder path instead of folder name.
   -h, --help                   help for test
       --namespace string       Namespace to use for tests.
@@ -22,6 +21,7 @@ chainsaw test [flags]... [test directories]...
       --stopOnFirstFailure     Stop the test upon encountering the first failure.
       --suppress strings       Logs to suppress.
       --testDirs strings       Directories containing test cases to run.
+      --timeout duration       The timeout to use as default for configuration. (default 30s)
 ```
 
 ### SEE ALSO