mirror of
https://github.com/replicatedhq/troubleshoot.git
synced 2026-04-15 07:16:34 +00:00
Benjamin YangandNoah Campbell
17518349ff
* created roadmap and yaml claude agent * Update roadmap.md * Fix textAnalyze analyzer to auto-match exec collector nested paths - Auto-detect exec output files (*-stdout.txt, *-stderr.txt, *-errors.json) - Convert simple filenames to wildcard patterns automatically - Preserve existing wildcard patterns - Fixes 'No matching file' errors for exec + textAnalyze workflows --------- Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
1011 lines
28 KiB
Go
1011 lines
28 KiB
Go
package analyzer
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func Test_textAnalyze(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
analyzer troubleshootv1beta2.TextAnalyze
|
|
expectResult []AnalyzeResult
|
|
files map[string][]byte
|
|
}{
|
|
{
|
|
name: "success case 1",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile-1.txt",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "pass",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
},
|
|
},
|
|
{
|
|
name: "failure case 1",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-2",
|
|
FileName: "cfile-2.txt",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-2",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-2/cfile-2.txt": []byte(""),
|
|
},
|
|
},
|
|
{
|
|
name: "success case 2",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-3",
|
|
FileName: "cfile-3.txt",
|
|
RegexPattern: "",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-3",
|
|
Message: "Invalid analyzer",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-3/cfile-3.txt": []byte("Connection to service succeeded"),
|
|
},
|
|
},
|
|
{
|
|
name: "success case 3",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-5",
|
|
FileName: "cfile-5.txt",
|
|
RegexPattern: "([a-zA-Z0-9\\-_:*\\s])*succe([a-zA-Z0-9\\-_:*\\s!])*",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-5",
|
|
Message: "success",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-5/cfile-5.txt": []byte("Connection to service succeeded!"),
|
|
},
|
|
},
|
|
{
|
|
name: "failure case 3",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-4",
|
|
FileName: "cfile-4.txt",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-4",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-4/cfile-4.txt": []byte("A different message"),
|
|
},
|
|
},
|
|
{
|
|
name: "failure case 4",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-6",
|
|
FileName: "cfile-6.txt",
|
|
RegexPattern: "([a-zA-Z0-9\\-_:*\\s])*succe([a-zA-Z0-9\\-_:*\\s!])*",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-6",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-6/cfile-6.txt": []byte("A different message"),
|
|
},
|
|
},
|
|
{
|
|
name: "warn case 1",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Warn: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "warning",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-6",
|
|
FileName: "cfile-6.txt",
|
|
RegexPattern: "([a-zA-Z0-9\\-_:*\\s])*succe([a-zA-Z0-9\\-_:*\\s!])*",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: true,
|
|
IsFail: false,
|
|
Title: "text-collector-6",
|
|
Message: "warning",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-6/cfile-6.txt": []byte("A different message"),
|
|
},
|
|
},
|
|
{
|
|
name: "multiple results case 1",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "pass",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
"text-collector-1/cfile-2.txt": []byte("no success here"),
|
|
"text-collector-2/cfile-3.txt": []byte("Yes it all succeeded"),
|
|
},
|
|
},
|
|
{
|
|
name: "multiple results case 2 globbing",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile*.log",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
"text-collector-1/cfile-2.log": []byte("no success here"),
|
|
"text-collector-2/cfile-3.txt": []byte("Yes it all succeeded"),
|
|
},
|
|
},
|
|
{
|
|
name: "multiple results with both warn and fail case 1, only fail",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
},
|
|
},
|
|
{
|
|
Warn: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "warning",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "pass",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
"text-collector-1/cfile-2.txt": []byte("no success here"),
|
|
"text-collector-2/cfile-3.txt": []byte("Yes it all succeeded"),
|
|
},
|
|
},
|
|
{
|
|
name: "Fail on error case 1", // regexes are not case insensitive by default
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
When: "false",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
When: "true",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile-1.txt",
|
|
RegexPattern: "error",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("There is an error."),
|
|
},
|
|
},
|
|
{
|
|
name: "case insensitive failure case 1", // regexes are not case insensitive by default
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile-1.txt",
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all SUCCEEDED"),
|
|
},
|
|
},
|
|
{
|
|
name: "case insensitive success case 1",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "pass",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile-1.txt",
|
|
RegexPattern: "(?i)succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "pass",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all SUCCEEDED"),
|
|
},
|
|
},
|
|
|
|
{
|
|
name: "compare group with integer",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
When: "val > 10",
|
|
Message: "val is greater than 10",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "val is not greater than 10",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile-1.txt",
|
|
RegexGroups: `value: (?P<val>\d+)`,
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "val is greater than 10",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13&h=16",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("value: 15\nother: 10"),
|
|
},
|
|
},
|
|
{
|
|
name: "compare group with integer (failure)",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
When: "val > 10",
|
|
Message: "val is greater than 10",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "val is not greater than 10",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile-1.txt",
|
|
RegexGroups: `value: (?P<val>\d+)`,
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "val is not greater than 10",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13&h=16",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("value: 2\nother: 10"),
|
|
},
|
|
},
|
|
// This test ensures that the Outcomes.Pass.Message can be templated using the findings of the regular expression groups.
|
|
{
|
|
name: "Outcome pass message is templated with regex groups",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
When: `Feature == insert-feature-name-here`,
|
|
Message: "Feature {{ .Feature }} is enabled for CR {{ .CRName }} in namespace {{ .Namespace }}",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-templated-regex-message",
|
|
FileName: "cfile-1.txt",
|
|
RegexGroups: `"name":\s*"(?P<CRName>.*?)".*namespace":\s*"(?P<Namespace>.*?)".*feature":\s*.*"(?P<Feature>insert-feature-name-here.*?)"`,
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-templated-regex-message",
|
|
Message: "Feature insert-feature-name-here is enabled for CR insert-cr-name-here in namespace default",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13&h=16",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-templated-regex-message/cfile-1.txt": []byte(`{"level":"INFO","timestamp":"2022-05-17T20:37:41Z","caller":"controller/controller.go:317","message":"Feature enabled","context":{"name":"insert-cr-name-here","namespace":"default","feature":"insert-feature-name-here"}}`),
|
|
},
|
|
},
|
|
// This test ensures that the Outcomes.Warn.Message can be templated using the findings of the regular expression groups.
|
|
{
|
|
name: "Outcome warn message is templated with regex groups",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
When: `Warning == ""`,
|
|
Message: "No warning found",
|
|
},
|
|
},
|
|
// The Warn case is triggered if warning != ""
|
|
{
|
|
Warn: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "Warning for CR with name {{ .CRName }} in namespace {{ .Namespace }}",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-templated-regex-message",
|
|
FileName: "cfile-1.txt",
|
|
RegexGroups: `"name":\s*"(?P<CRName>.*?)".*namespace":\s*"(?P<Namespace>.*?)".*warning":\s*.*"(?P<Error>mywarning.*?)"`,
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: true,
|
|
IsFail: false,
|
|
Title: "text-collector-templated-regex-message",
|
|
Message: "Warning for CR with name insert-cr-name-here in namespace default",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13&h=16",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-templated-regex-message/cfile-1.txt": []byte(`{"level":"WARN","timestamp":"2022-05-17T20:37:41Z","caller":"controller/controller.go:317","message":"Reconciler error","context":{"name":"insert-cr-name-here","namespace":"default","warning":"mywarning"}}`),
|
|
},
|
|
},
|
|
// This test ensures that the Outcomes.Fail.Message can be templated using the findings of the regular expression groups.
|
|
{
|
|
name: "Outcome fail message is templated with regex groups",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
When: `Error == ""`,
|
|
Message: "No error found",
|
|
},
|
|
},
|
|
// The Fail case is triggered if warning != ""
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "Error for CR with name {{ .CRName }} in namespace {{ .Namespace }}",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-templated-regex-message",
|
|
FileName: "cfile-1.txt",
|
|
RegexGroups: `"name":\s*"(?P<CRName>.*?)".*namespace":\s*"(?P<Namespace>.*?)".*error":\s*.*"(?P<Error>myerror.*?)"`,
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-templated-regex-message",
|
|
Message: "Error for CR with name insert-cr-name-here in namespace default",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg?w=13&h=16",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-templated-regex-message/cfile-1.txt": []byte(`{"level":"ERROR","timestamp":"2022-05-17T20:37:41Z","caller":"controller/controller.go:317","message":"Reconciler error","context":{"name":"insert-cr-name-here","namespace":"default","error":"myerror"}}`),
|
|
},
|
|
},
|
|
{
|
|
name: "exclude files case 1 globbing",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile*.txt",
|
|
ExcludeFiles: []string{"*previous.txt"},
|
|
RegexPattern: "success",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
"text-collector-1/cfile-previous.txt": []byte("no success here"),
|
|
},
|
|
},
|
|
{
|
|
name: "exclude files case 2 globbing",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile*.txt",
|
|
ExcludeFiles: []string{"*previous.txt", "cfile-2.txt"},
|
|
RegexPattern: "success",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "text-collector-1",
|
|
Message: "fail",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
"text-collector-1/cfile-previous.txt": []byte("no success here"),
|
|
"text-collector-1/cfile-2.txt": []byte("no success here"),
|
|
},
|
|
},
|
|
{
|
|
name: "exclude files case 3 globbing",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "success",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "fail",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "text-collector-1",
|
|
FileName: "cfile*.txt",
|
|
ExcludeFiles: []string{"*previous.txt"},
|
|
RegexPattern: "succeeded",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "success",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "text-collector-1",
|
|
Message: "success",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"text-collector-1/cfile-1.txt": []byte("Yes it all succeeded"),
|
|
"text-collector-1/cfile-previous.txt": []byte("no success here"),
|
|
"text-collector-1/cfile-2.txt": []byte("Yes it all succeeded"),
|
|
},
|
|
},
|
|
{
|
|
name: "exec collector auto-path matching for stdout",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "Command output found",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "Command output not found",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "netbox-branch-check",
|
|
FileName: "netbox-branch-check-stdout.txt", // Simple filename, but file is nested deeper
|
|
RegexPattern: "success",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "netbox-branch-check",
|
|
Message: "Command output found",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
// File is stored in exec-style nested path: {collector}/{namespace}/{pod}/{collector}-stdout.txt
|
|
"netbox-branch-check/netbox-enterprise/netbox-enterprise-858bcb8d4-cdgk7/netbox-branch-check-stdout.txt": []byte("operation success completed"),
|
|
},
|
|
},
|
|
{
|
|
name: "exec collector auto-path matching for stderr",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "No errors in stderr",
|
|
When: "false",
|
|
},
|
|
},
|
|
{
|
|
Fail: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "Error found in stderr",
|
|
When: "true",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "my-exec-collector",
|
|
FileName: "my-exec-collector-stderr.txt",
|
|
RegexPattern: "error",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: false,
|
|
IsWarn: false,
|
|
IsFail: true,
|
|
Title: "my-exec-collector",
|
|
Message: "Error found in stderr",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"my-exec-collector/default/my-pod-12345/my-exec-collector-stderr.txt": []byte("connection error occurred"),
|
|
},
|
|
},
|
|
{
|
|
name: "exec collector no auto-match when wildcards already present",
|
|
analyzer: troubleshootv1beta2.TextAnalyze{
|
|
Outcomes: []*troubleshootv1beta2.Outcome{
|
|
{
|
|
Pass: &troubleshootv1beta2.SingleOutcome{
|
|
Message: "Found with existing wildcard",
|
|
},
|
|
},
|
|
},
|
|
CollectorName: "test-collector",
|
|
FileName: "*/test-collector-stdout.txt", // Already has wildcard, should not be modified
|
|
RegexPattern: "output",
|
|
},
|
|
expectResult: []AnalyzeResult{
|
|
{
|
|
IsPass: true,
|
|
IsWarn: false,
|
|
IsFail: false,
|
|
Title: "test-collector",
|
|
Message: "Found with existing wildcard",
|
|
IconKey: "kubernetes_text_analyze",
|
|
IconURI: "https://troubleshoot.sh/images/analyzer-icons/text-analyze.svg",
|
|
},
|
|
},
|
|
files: map[string][]byte{
|
|
"test-collector/something/test-collector-stdout.txt": []byte("some output here"),
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
req := require.New(t)
|
|
|
|
getFiles := func(n string, excludeFiles []string) (map[string][]byte, error) {
|
|
matching := make(map[string][]byte)
|
|
for k, v := range test.files {
|
|
if strings.HasPrefix(k, n) {
|
|
matching[k] = v
|
|
}
|
|
}
|
|
|
|
for k, v := range test.files {
|
|
if ok, _ := filepath.Match(n, k); ok {
|
|
matching[k] = v
|
|
}
|
|
}
|
|
|
|
if len(excludeFiles) > 0 {
|
|
for k := range matching {
|
|
for _, ex := range excludeFiles {
|
|
if ok, _ := filepath.Match(ex, k); ok {
|
|
delete(matching, k)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if len(matching) == 0 {
|
|
return nil, fmt.Errorf("File not found: %s", n)
|
|
}
|
|
return matching, nil
|
|
}
|
|
|
|
a := AnalyzeTextAnalyze{
|
|
analyzer: &test.analyzer,
|
|
}
|
|
|
|
actual, err := analyzeTextAnalyze(&test.analyzer, getFiles, a.Title())
|
|
req.NoError(err)
|
|
|
|
unPointered := []AnalyzeResult{}
|
|
for _, v := range actual {
|
|
unPointered = append(unPointered, *v)
|
|
}
|
|
req.ElementsMatch(test.expectResult, unPointered)
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_compareRegex(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
conditional string
|
|
foundMatches map[string]string
|
|
expected bool
|
|
}{
|
|
{
|
|
name: "Loss < 5",
|
|
conditional: "Loss < 5",
|
|
foundMatches: map[string]string{
|
|
"Transmitted": "5",
|
|
"Received": "4",
|
|
"Loss": "20",
|
|
},
|
|
expected: false,
|
|
},
|
|
{
|
|
name: "Hostname = icecream",
|
|
conditional: "Hostname = icecream",
|
|
foundMatches: map[string]string{
|
|
"Something": "5",
|
|
"Hostname": "icecream",
|
|
},
|
|
expected: true,
|
|
},
|
|
{
|
|
name: "Day >= 23",
|
|
conditional: "Day >= 23",
|
|
foundMatches: map[string]string{
|
|
"day": "5",
|
|
"Day": "24",
|
|
},
|
|
expected: true,
|
|
},
|
|
{
|
|
name: "empty conditional",
|
|
conditional: "",
|
|
foundMatches: map[string]string{},
|
|
expected: true,
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
req := require.New(t)
|
|
|
|
actual, err := compareRegex(test.conditional, test.foundMatches)
|
|
req.NoError(err)
|
|
|
|
req.Equal(test.expected, actual)
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_NoFilesInBundle(t *testing.T) {
|
|
getFiles := func(n string, excludeFiles []string) (map[string][]byte, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
a := AnalyzeTextAnalyze{
|
|
analyzer: &troubleshootv1beta2.TextAnalyze{
|
|
CollectorName: "text-collector-1",
|
|
IgnoreIfNoFiles: true,
|
|
},
|
|
}
|
|
|
|
actual, err := analyzeTextAnalyze(a.analyzer, getFiles, a.Title())
|
|
require.NoError(t, err)
|
|
assert.Nil(t, actual)
|
|
|
|
aa := AnalyzeTextAnalyze{
|
|
analyzer: &troubleshootv1beta2.TextAnalyze{},
|
|
}
|
|
|
|
actual, err = analyzeTextAnalyze(aa.analyzer, getFiles, a.Title())
|
|
require.NoError(t, err)
|
|
require.Len(t, actual, 1)
|
|
assert.Equal(t, "No matching files", actual[0].Message)
|
|
assert.True(t, actual[0].IsWarn)
|
|
}
|