Merge pull request #479 from replicatedhq/divolgin/no-files

Allow text analyzer to not generate an error if no files match

Author: divolgin

config/crds/troubleshoot.sh_analyzers.yaml

@@ -1070,6 +1070,8 @@ spec:
                           type: BoolString
                         fileName:
                           type: string
+                        ignoreIfNoFiles:
+                          type: boolean
                         outcomes:
                           items:
                             properties:

config/crds/troubleshoot.sh_preflights.yaml

@@ -1070,6 +1070,8 @@ spec:
                           type: BoolString
                         fileName:
                           type: string
+                        ignoreIfNoFiles:
+                          type: boolean
                         outcomes:
                           items:
                             properties:

config/crds/troubleshoot.sh_supportbundles.yaml

@@ -1101,6 +1101,8 @@ spec:
                           type: BoolString
                         fileName:
                           type: string
+                        ignoreIfNoFiles:
+                          type: boolean
                         outcomes:
                           items:
                             properties:

pkg/analyze/text_analyze.go

@@ -24,12 +24,16 @@ func analyzeTextAnalyze(analyzer *troubleshootv1beta2.TextAnalyze, getCollectedF
 	}
 
 	if len(collected) == 0 {
+		if analyzer.IgnoreIfNoFiles {
+			return nil, nil
+		}
+
 		return []*AnalyzeResult{
 			{
 				Title:   checkName,
 				IconKey: "kubernetes_text_analyze",
 				IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
-				IsFail:  false,
+				IsWarn:  true,
 				Message: "No matching files",
 			},
 		}, nil

pkg/apis/troubleshoot/v1beta2/analyzer_shared.go

@@ -117,12 +117,13 @@ type NodeResourceSelectors struct {
 }
 
 type TextAnalyze struct {
-	AnalyzeMeta   `json:",inline" yaml:",inline"`
-	CollectorName string     `json:"collectorName,omitempty" yaml:"collectorName,omitempty"`
-	FileName      string     `json:"fileName,omitempty" yaml:"fileName,omitempty"`
-	RegexPattern  string     `json:"regex,omitempty" yaml:"regex,omitempty"`
-	RegexGroups   string     `json:"regexGroups,omitempty" yaml:"regexGroups,omitempty"`
-	Outcomes      []*Outcome `json:"outcomes" yaml:"outcomes"`
+	AnalyzeMeta     `json:",inline" yaml:",inline"`
+	CollectorName   string     `json:"collectorName,omitempty" yaml:"collectorName,omitempty"`
+	FileName        string     `json:"fileName,omitempty" yaml:"fileName,omitempty"`
+	RegexPattern    string     `json:"regex,omitempty" yaml:"regex,omitempty"`
+	RegexGroups     string     `json:"regexGroups,omitempty" yaml:"regexGroups,omitempty"`
+	IgnoreIfNoFiles bool       `json:"ignoreIfNoFiles,omitempty" yaml:"ignoreIfNoFiles,omitempty"`
+	Outcomes        []*Outcome `json:"outcomes" yaml:"outcomes"`
 }
 
 type DatabaseAnalyze struct {

schemas/analyzer-troubleshoot-v1beta2.json

@@ -1615,6 +1615,9 @@
                   "fileName": {
                     "type": "string"
                   },
+                  "ignoreIfNoFiles": {
+                    "type": "boolean"
+                  },
                   "outcomes": {
                     "type": "array",
                     "items": {

schemas/preflight-troubleshoot-v1beta2.json

@@ -1615,6 +1615,9 @@
                   "fileName": {
                     "type": "string"
                   },
+                  "ignoreIfNoFiles": {
+                    "type": "boolean"
+                  },
                   "outcomes": {
                     "type": "array",
                     "items": {

schemas/supportbundle-troubleshoot-v1beta2.json

@@ -1661,6 +1661,9 @@
                   "fileName": {
                     "type": "string"
                   },
+                  "ignoreIfNoFiles": {
+                    "type": "boolean"
+                  },
                   "outcomes": {
                     "type": "array",
                     "items": {