Merge pull request #3049 from simonbaird/validate-input-text-color-output

Support red/green color for ec validate input text output

Author: simonbaird

cmd/validate/input.go

@@ -43,8 +43,10 @@ func validateInputCmd(validate InputValidationFunc) *cobra.Command {
 		effectiveTime       string
 		filePaths           []string
 		filterType          string
+		forceColor          bool
 		info                bool
 		namespaces          []string
+		noColor             bool
 		output              []string
 		policy              policy.Policy
 		policyConfiguration string
@@ -213,6 +215,8 @@ func validateInputCmd(validate InputValidationFunc) *cobra.Command {
 				return err
 			}
 
+			utils.SetColorEnabled(data.noColor, data.forceColor)
+
 			p := format.NewTargetParser(input.Text, format.Options{ShowSuccesses: showSuccesses, ShowWarnings: showWarnings}, cmd.OutOrStdout(), utils.FS(cmd.Context()))
 			if err := report.WriteAll(data.output, p); err != nil {
 				return err
@@ -264,6 +268,12 @@ func validateInputCmd(validate InputValidationFunc) *cobra.Command {
 		- "include-exclude": Uses traditional include/exclude filtering without pipeline intentions
 		- "ec-policy": Uses Enterprise Contract policy filtering with pipeline intention support`))
 
+	cmd.Flags().BoolVar(&data.noColor, "no-color", false, hd.Doc(`
+		Disable color when using text output even when the current terminal supports it`))
+
+	cmd.Flags().BoolVar(&data.forceColor, "color", false, hd.Doc(`
+		Enable color when using text output even when the current terminal does not support it`))
+
 	if err := cmd.MarkFlagRequired("file"); err != nil {
 		panic(err)
 	}

docs/modules/ROOT/pages/ec_validate_input.adoc

@@ -39,6 +39,7 @@ of the git repo. For git repos not hosted on 'github.com' or 'gitlab.com', prefi
 
 == Options
 
+--color:: Enable color when using text output even when the current terminal does not support it (Default: false)
 --effective-time:: Run policy checks with the provided time. Useful for testing rules with
 effective dates in the future. The value can be "now" (default) - for
 current time, or a RFC3339 formatted value, e.g. 2022-11-18T00:00:00Z. (Default: now)
@@ -50,6 +51,7 @@ current time, or a RFC3339 formatted value, e.g. 2022-11-18T00:00:00Z. (Default:
 --info:: Include additional information on the failures. For instance for policy
 violations, include the title and the description of the failed policy
 rule. (Default: false)
+--no-color:: Disable color when using text output even when the current terminal supports it (Default: false)
 -o, --output:: Write output to a file in a specific format, e.g. yaml=/tmp/output.yaml. Use empty string
 path for stdout, e.g. yaml. May be used multiple times. Possible formats are:
 json, yaml, text, summary. In following format and file path

features/__snapshots__/validate_input.snap

@@ -28,6 +28,22 @@
 
 [valid policy URL:stderr - 1]
 
+---
+[valid policy URL with text output:stdout - 1]
+Success: true
+Result: SUCCESS
+Violations: 0, Warnings: 0, Successes: 1
+Input File: pipeline_definition.yaml
+
+Results:
+✓ [Success] main.acceptor
+  FilePath: pipeline_definition.yaml
+
+
+---
+
+[valid policy URL with text output:stderr - 1]
+
 ---
 
 [policy with multiple sources:stdout - 1]

features/validate_input.feature

@@ -27,6 +27,29 @@ Feature: validate input
     Then the exit status should be 0
     Then the output should match the snapshot
 
+  Scenario: valid policy URL with text output
+    Given a git repository named "happy-day-config" with
+      | policy.yaml | examples/happy_config.yaml |
+    Given a git repository named "happy-day-policy" with
+      | main.rego | examples/happy_day.rego |
+    Given a pipeline definition file named "pipeline_definition.yaml" containing
+    """
+    ---
+    apiVersion: tekton.dev/v1
+    kind: Pipeline
+    metadata:
+      name: basic-build
+    spec:
+      tasks:
+      - name: appstudio-init
+        taskRef:
+          name: init
+          version: "0.1"
+    """
+    When ec command is run with "validate input --file pipeline_definition.yaml --policy git::https://${GITHOST}/git/happy-day-config.git --output text --show-successes --color"
+    Then the exit status should be 0
+    Then the output should match the snapshot
+
   Scenario: policy URL with no rego files
     Given a git repository named "sad-day-config" with
       | policy.yaml | examples/sad_config.yaml |