mirror of
https://github.com/replicatedhq/troubleshoot.git
synced 2026-02-14 10:19:54 +00:00
a9d2180dd6
* fix: prevent redactors from corrupting binary files (#102) Redactors were adding newlines to files without them, corrupting binary files during support bundle collection (51 bytes → 53 bytes). Created LineReader to track original newline state and only restore newlines when they were present in the original file. - Added pkg/redact/line_reader.go - Refactored single_line.go, multi_line.go, literal.go - Added 48 tests, all passing - Verified: binary files now preserved byte-for-byte Fixes #102 * fix: handle empty lines correctly in MultiLineRedactor - Check line1 == nil instead of len(line1) == 0 for empty file detection - Fixes edge case where file containing only '\n' would be dropped - Addresses bugbot finding about empty line handling * fix: handle empty lines correctly in MultiLineRedactor - Check line1 != nil instead of len(line1) > 0 in both locations - Fixes edge case where empty trailing lines would be dropped - Fix test isolation in literal_test.go (move ResetRedactionList to parent) - Addresses bugbot findings about empty line handling * fmt * chore: update regression baselines from run 20107431959 * adding defense * fix: propagate non-EOF errors in all early return paths Ensure non-EOF errors (like buffer overflow) are properly propagated to caller in both pre-loop early returns. Addresses bugbot finding. * fix: use unique test names to prevent redaction list pollution Use t.Name() instead of hardcoded 'test' to ensure each test has unique redactor name, preventing parallel test interference --------- Co-authored-by: hedge-sparrow <sparrow@spooky.academy>
522 lines
12 KiB
Go
522 lines
12 KiB
Go
package collect
|
|
|
|
import (
|
|
"testing"
|
|
|
|
troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
|
|
"github.com/replicatedhq/troubleshoot/pkg/multitype"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestCollector_RunCollectorSyncNoRedact(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
Collect *troubleshootv1beta2.Collect
|
|
Redactors []*troubleshootv1beta2.Redact
|
|
want map[string]string
|
|
}{
|
|
{
|
|
name: "data with custom redactor",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Name: "",
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Values: nil,
|
|
Regex: []troubleshootv1beta2.Regex{
|
|
{Redactor: `abc`},
|
|
{Redactor: `(another)(?P<mask>.*)(here)`},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": ` 123
|
|
another***HIDDEN***here
|
|
pwd=***HIDDEN***;`,
|
|
},
|
|
},
|
|
{
|
|
name: "data with custom redactor at a restricted path",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Name: "",
|
|
FileSelector: troubleshootv1beta2.FileSelector{
|
|
File: "data/*",
|
|
},
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Values: nil,
|
|
Regex: []troubleshootv1beta2.Regex{
|
|
{Redactor: `(another)(?P<mask>.*)(here)`},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": `abc 123
|
|
another***HIDDEN***here
|
|
pwd=***HIDDEN***;`,
|
|
},
|
|
},
|
|
{
|
|
name: "data with custom redactor at other path",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Name: "",
|
|
FileSelector: troubleshootv1beta2.FileSelector{
|
|
File: "notdata/*",
|
|
},
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Values: nil,
|
|
Regex: []troubleshootv1beta2.Regex{
|
|
{Redactor: `(another)(?P<mask>.*)(here)`},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": `abc 123
|
|
another line here
|
|
pwd=***HIDDEN***;`,
|
|
},
|
|
},
|
|
{
|
|
name: "data with custom redactor at second path",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Name: "",
|
|
FileSelector: troubleshootv1beta2.FileSelector{
|
|
Files: []string{
|
|
"notData/*",
|
|
"data/*",
|
|
},
|
|
},
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Values: nil,
|
|
Regex: []troubleshootv1beta2.Regex{
|
|
{Redactor: `(another)(?P<mask>.*)(here)`},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": `abc 123
|
|
another***HIDDEN***here
|
|
pwd=***HIDDEN***;`,
|
|
},
|
|
},
|
|
{
|
|
name: "data with literal string replacer",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "data/collectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Name: "",
|
|
FileSelector: troubleshootv1beta2.FileSelector{
|
|
Files: []string{
|
|
"data/*/*",
|
|
},
|
|
},
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Values: []string{
|
|
`abc`,
|
|
`123`,
|
|
`another`,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/data/collectorname": `***HIDDEN*** ***HIDDEN***
|
|
***HIDDEN*** line here
|
|
pwd=***HIDDEN***;`,
|
|
},
|
|
},
|
|
{
|
|
name: "data with custom yaml redactor",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Removals: troubleshootv1beta2.Removals{
|
|
YamlPath: []string{
|
|
`abc`,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": `abc 123
|
|
another line here`,
|
|
},
|
|
},
|
|
{
|
|
name: "custom multiline redactor",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `xyz123
|
|
abc
|
|
xyz123
|
|
xyz123
|
|
abc`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Regex: []troubleshootv1beta2.Regex{
|
|
{
|
|
Selector: "abc",
|
|
Redactor: "xyz(123)",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": `xyz123
|
|
abc
|
|
123
|
|
xyz123
|
|
abc`,
|
|
},
|
|
},
|
|
{
|
|
name: "excluded data",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
Exclude: multitype.FromString("true"),
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{},
|
|
want: map[string]string{},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
req := require.New(t)
|
|
|
|
var result CollectorResult
|
|
|
|
collector, _ := GetCollector(tt.Collect, "", "", nil, nil, nil)
|
|
regCollector, _ := collector.(Collector)
|
|
|
|
if excluded, err := regCollector.IsExcluded(); !excluded {
|
|
req.NoError(err)
|
|
|
|
result, err = regCollector.Collect(nil)
|
|
req.NoError(err)
|
|
|
|
err = RedactResult("", result, tt.Redactors)
|
|
|
|
req.NoError(err)
|
|
}
|
|
|
|
// convert to string to make differences easier to see
|
|
toString := map[string]string{}
|
|
for k, v := range result {
|
|
toString[k] = string(v)
|
|
}
|
|
req.EqualValues(tt.want, toString)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestCollector_RunCollectorSync(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
Collect *troubleshootv1beta2.Collect
|
|
Redactors []*troubleshootv1beta2.Redact
|
|
want map[string]string
|
|
}{
|
|
{
|
|
name: "data with custom redactor - but redaction disabled",
|
|
Collect: &troubleshootv1beta2.Collect{
|
|
Data: &troubleshootv1beta2.Data{
|
|
CollectorMeta: troubleshootv1beta2.CollectorMeta{
|
|
CollectorName: "datacollectorname",
|
|
},
|
|
Name: "data",
|
|
Data: `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
Redactors: []*troubleshootv1beta2.Redact{
|
|
{
|
|
Name: "",
|
|
Removals: troubleshootv1beta2.Removals{
|
|
Values: nil,
|
|
Regex: []troubleshootv1beta2.Regex{
|
|
{Redactor: `abc`},
|
|
{Redactor: `(another)(?P<mask>.*)(here)`},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: map[string]string{
|
|
"data/datacollectorname": `abc 123
|
|
another line here
|
|
pwd=somethinggoeshere;`,
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
req := require.New(t)
|
|
|
|
var result CollectorResult
|
|
|
|
collector, _ := GetCollector(tt.Collect, "", "", nil, nil, nil)
|
|
regCollector, _ := collector.(Collector)
|
|
|
|
if excluded, err := regCollector.IsExcluded(); !excluded {
|
|
req.NoError(err)
|
|
|
|
result, err = regCollector.Collect(nil)
|
|
req.NoError(err)
|
|
}
|
|
|
|
// convert to string to make differences easier to see
|
|
toString := map[string]string{}
|
|
for k, v := range result {
|
|
toString[k] = string(v)
|
|
}
|
|
req.EqualValues(tt.want, toString)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestCollector_DedupCollectors(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
Collectors []*troubleshootv1beta2.Collect
|
|
want []*troubleshootv1beta2.Collect
|
|
}{
|
|
{
|
|
name: "multiple cluster info",
|
|
Collectors: []*troubleshootv1beta2.Collect{
|
|
{
|
|
ClusterInfo: &troubleshootv1beta2.ClusterInfo{},
|
|
},
|
|
{
|
|
ClusterInfo: &troubleshootv1beta2.ClusterInfo{},
|
|
},
|
|
},
|
|
want: []*troubleshootv1beta2.Collect{
|
|
{
|
|
ClusterInfo: &troubleshootv1beta2.ClusterInfo{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "multiple cluster resources with matching namespace lists",
|
|
Collectors: []*troubleshootv1beta2.Collect{
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1", "namespace2"},
|
|
},
|
|
},
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1", "namespace2"},
|
|
},
|
|
},
|
|
},
|
|
want: []*troubleshootv1beta2.Collect{
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1", "namespace2"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "multiple cluster resources with unnique namespace lists",
|
|
Collectors: []*troubleshootv1beta2.Collect{
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1", "namespace2"},
|
|
},
|
|
},
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1000", "namespace2000"},
|
|
},
|
|
},
|
|
},
|
|
want: []*troubleshootv1beta2.Collect{
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1", "namespace2"},
|
|
},
|
|
},
|
|
{
|
|
ClusterResources: &troubleshootv1beta2.ClusterResources{
|
|
Namespaces: []string{"namespace1000", "namespace2000"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
got := DedupCollectors(tc.Collectors)
|
|
assert.Equal(t, tc.want, got)
|
|
})
|
|
}
|
|
}
|
|
func TestEnsureCopyLast(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
allCollectors []Collector
|
|
want []Collector
|
|
}{
|
|
{
|
|
name: "no copy collectors",
|
|
allCollectors: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
},
|
|
want: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
},
|
|
},
|
|
{
|
|
name: "only copy collectors",
|
|
allCollectors: []Collector{
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
},
|
|
want: []Collector{
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
},
|
|
},
|
|
{
|
|
name: "mixed collectors",
|
|
allCollectors: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectCopy{},
|
|
&CollectClusterResources{},
|
|
&CollectCopy{},
|
|
},
|
|
want: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
},
|
|
},
|
|
{
|
|
name: "copy collectors at the beginning",
|
|
allCollectors: []Collector{
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
},
|
|
want: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
},
|
|
},
|
|
{
|
|
name: "copy collectors at the end",
|
|
allCollectors: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
},
|
|
want: []Collector{
|
|
&CollectClusterInfo{},
|
|
&CollectClusterResources{},
|
|
&CollectCopy{},
|
|
&CollectCopy{},
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got := EnsureCopyLast(tt.allCollectors)
|
|
assert.Equal(t, tt.want, got)
|
|
})
|
|
}
|
|
}
|