redact_test.go

package redact

import (
	"encoding/json"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/require"
	_ "go.undefinedlabs.com/scopeagent/autoinstrument"
	v1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func Test_getSlug(t *testing.T) {
	tests := []struct {
		name  string
		input string
		want  string
	}{
		{
			name:  "all alphanumeric",
			input: "aBC123",
			want:  "aBC123",
		},
		{
			name:  "dashes",
			input: "abc-123",
			want:  "abc-123",
		},
		{
			name:  "spaces",
			input: "abc 123",
			want:  "abc-123",
		},
		{
			name:  "aymbols",
			input: "abc%^123!@#",
			want:  "abc123",
		},
		{
			name:  "kotsadm-redact",
			input: "kotsadm-redact",
			want:  "kotsadm-redact-metadata",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			req := require.New(t)
			req.Equal(tt.want, getSlug(tt.input))
		})
	}
}

func Test_getRedactSpec(t *testing.T) {
	tests := []struct {
		name      string
		configMap v1.ConfigMap
		want      string
		errstring string
	}{
		{
			name: "old spec only", // this test shows the code path when the redact specs haven't been updated
			configMap: v1.ConfigMap{
				TypeMeta:   metav1.TypeMeta{},
				ObjectMeta: metav1.ObjectMeta{},
				Data: map[string]string{
					"kotsadm-redact": `
kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: kotsadm-redact
spec:
  redactors: #there are comments here
  - name: replace password
    fileSelector:
      file: data/my-password-dump
    removals:
      values:
      - abc123
  - name: all files
    removals:
      regex:
      - redactor: (another)(?P<mask>.*)(here)
      - selector: S3_ENDPOINT
        redactor: '("value": ").*(")'
      yamlPath:
      - abc.xyz.*`,
				},
			},
			want: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: kotsadm-redact
spec:
  redactors:
  - name: replace password
    fileSelector:
      file: data/my-password-dump
    removals:
      values:
      - abc123
  - name: all files
    removals:
      regex:
      - redactor: (another)(?P<mask>.*)(here)
      - selector: S3_ENDPOINT
        redactor: '("value": ").*(")'
      yamlPath:
      - abc.xyz.*
`,
			errstring: "",
		},
		{
			name: "multiple new specs only",
			configMap: v1.ConfigMap{
				TypeMeta:   metav1.TypeMeta{},
				ObjectMeta: metav1.ObjectMeta{},
				Data: map[string]string{
					"replace-password": `{"metadata":{"name":"replace password","slug":"replace-password","createdAt":"2020-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":true,"description":""},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: replace password\nspec:\n  redactors:\n  - name: replace password\n    fileSelector:\n      file: data/my-password-dump\n    removals:\n      values:\n      - abc123\n"}`,
					"all-files":        `{"metadata":{"name":"all files","slug":"all-files","createdAt":"2020-06-15T14:26:10.721733-04:00","updatedAt":"2020-06-15T14:26:10.721734-04:00","enabled":true,"description":""},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: all files\nspec:\n  redactors:\n  - name: all files\n    removals:\n      regex:\n      - redactor: (another)(?P\u003cmask\u003e.*)(here)\n      - selector: S3_ENDPOINT\n        redactor: '(\"value\": \").*(\")'\n      yamlPath:\n      - abc.xyz.*\n"}`,
				},
			},
			want: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: kotsadm-redact
spec:
  redactors:
  - name: all files
    removals:
      regex:
      - redactor: (another)(?P<mask>.*)(here)
      - selector: S3_ENDPOINT
        redactor: '("value": ").*(")'
      yamlPath:
      - abc.xyz.*
  - name: replace password
    fileSelector:
      file: data/my-password-dump
    removals:
      values:
      - abc123
`,
			errstring: "",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			req := require.New(t)

			got, errstring, err := getRedactSpec(&tt.configMap)
			req.NoError(err)
			req.Equal(tt.want, got)
			req.Equal(tt.errstring, errstring)
		})
	}
}

func Test_splitRedactors(t *testing.T) {
	tests := []struct {
		name        string
		spec        string
		existingMap map[string]string
		want        map[string]RedactorMetadata
	}{
		{
			name: "no existing map",
			spec: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: kotsadm-redact
spec:
  redactors:
  - name: replace password
    fileSelector:
      file: data/my-password-dump
    removals:
      values:
      - abc123
  - name: all files
    removals:
      regex:
      - redactor: (another)(?P<mask>.*)(here)
      - selector: S3_ENDPOINT
        redactor: '("value": ").*(")'
      yamlPath:
      - abc.xyz.*
`,
			want: map[string]RedactorMetadata{
				"all-files": {
					Metadata: RedactorList{
						Name:    "all files",
						Slug:    "all-files",
						Enabled: true,
					},
					Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: all files
spec:
  redactors:
  - name: all files
    removals:
      regex:
      - redactor: (another)(?P<mask>.*)(here)
      - selector: S3_ENDPOINT
        redactor: '("value": ").*(")'
      yamlPath:
      - abc.xyz.*
`,
				},
				"replace-password": {
					Metadata: RedactorList{
						Name:    "replace password",
						Slug:    "replace-password",
						Enabled: true,
					},
					Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: replace password
spec:
  redactors:
  - name: replace password
    fileSelector:
      file: data/my-password-dump
    removals:
      values:
      - abc123
`,
				},
			},
		},
		{
			name: "no additions, remove old key",
			spec: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: kotsadm-redact`,
			existingMap: map[string]string{
				"kotsadm-redact": "should be removed",
				"other-key":      `{"metadata":{"name":"other key","slug":"other-key","createdAt":"2020-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":false,"description":""},"redact":"should be unchanged"}`,
			},
			want: map[string]RedactorMetadata{
				"other-key": {
					Metadata: RedactorList{
						Name:        "other key",
						Slug:        "other-key",
						Enabled:     false,
						Description: "",
					},
					Redact: "should be unchanged",
				},
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			req := require.New(t)

			got, err := splitRedactors(tt.spec, tt.existingMap)
			req.NoError(err)
			req.Len(got, len(tt.want))
			for idx, val := range tt.want {
				gotIdx, ok := got[idx]
				fmt.Printf("\n\n%s\n\n", gotIdx)
				req.True(ok)
				gotIdxParsed := RedactorMetadata{}
				req.NoError(json.Unmarshal([]byte(gotIdx), &gotIdxParsed))
				req.Equal(val.Redact, gotIdxParsed.Redact)

				// set timestamps equal
				gotIdxParsed.Metadata.Updated = val.Metadata.Updated
				gotIdxParsed.Metadata.Created = val.Metadata.Created
				req.Equal(val.Metadata, gotIdxParsed.Metadata)
			}
		})
	}
}

func Test_setRedactYaml(t *testing.T) {
	previousTime, err := time.Parse(time.RFC3339, "2010-06-15T14:26:10.721619-04:00")
	if err != nil {
		panic(err)
	}

	testTime, err := time.Parse(time.RFC3339, "2020-06-15T14:26:10.721619-04:00")
	if err != nil {
		panic(err)
	}

	type args struct {
		slug        string
		description string
		enabled     bool
		newRedact   bool
		yamlBytes   []byte
		data        map[string]string
	}
	tests := []struct {
		name         string
		args         args
		newMap       map[string]string
		newMetadata  *RedactorMetadata
		expectedSlug string
	}{
		{
			name: "create new redact",
			args: args{
				slug:        "new-redact",
				description: "new description",
				enabled:     true,
				newRedact:   true,
				yamlBytes: []byte(`kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: new redact`),
				data: nil,
			},
			newMap: map[string]string{
				"new-redact": `{"metadata":{"name":"new redact","slug":"new-redact","createdAt":"2020-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":true,"description":"new description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: new redact"}`,
			},
			newMetadata: &RedactorMetadata{
				Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: new redact`,
				Metadata: RedactorList{
					Name:        "new redact",
					Slug:        "new-redact",
					Enabled:     true,
					Description: "new description",
					Created:     testTime,
					Updated:     testTime,
				},
			},
		},
		{
			name: "update existing redact, leave other untouched",
			args: args{
				slug:        "new-redact",
				description: "a description",
				enabled:     true,
				yamlBytes: []byte(`kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: update redact`),
				data: map[string]string{
					"new-redact":      `{"metadata":{"name":"new redact","slug":"new-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2010-06-15T14:26:10.721619-04:00","enabled":true,"description":"new description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: new redact"}`,
					"leave-untouched": `other keys should not be modified`,
				},
			},
			newMap: map[string]string{
				"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":true,"description":"a description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact"}`,
				"leave-untouched": `other keys should not be modified`,
			},
			newMetadata: &RedactorMetadata{
				Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: update redact`,
				Metadata: RedactorList{
					Name:        "update redact",
					Slug:        "update-redact",
					Enabled:     true,
					Description: "a description",
					Created:     previousTime,
					Updated:     testTime,
				},
			},
		},
		{
			name: "update existing redact without changing slug",
			args: args{
				slug:        "update-redact",
				description: "updated description",
				enabled:     true,
				yamlBytes: []byte(`kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: update redact
spec: {}`),
				data: map[string]string{
					"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2010-06-15T14:26:10.721619-04:00","enabled":true,"description":"a description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact"}`,
					"leave-untouched": `other keys should not be modified`,
				},
			},
			newMap: map[string]string{
				"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":true,"description":"updated description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact\nspec: {}"}`,
				"leave-untouched": `other keys should not be modified`,
			},
			newMetadata: &RedactorMetadata{
				Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: update redact
spec: {}`,
				Metadata: RedactorList{
					Name:        "update redact",
					Slug:        "update-redact",
					Enabled:     true,
					Description: "updated description",
					Created:     previousTime,
					Updated:     testTime,
				},
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			req := require.New(t)

			newMap, newMetadata, err := setRedactYaml(tt.args.slug, tt.args.description, tt.args.enabled, tt.args.newRedact, testTime, tt.args.yamlBytes, tt.args.data)
			req.NoError(err)

			req.Equal(tt.newMap, newMap)
			req.Equal(tt.newMetadata, newMetadata)
		})
	}
}

func Test_setRedactEnabled(t *testing.T) {
	previousTime, err := time.Parse(time.RFC3339, "2010-06-15T14:26:10.721619-04:00")
	if err != nil {
		panic(err)
	}

	testTime, err := time.Parse(time.RFC3339, "2020-06-15T14:26:10.721619-04:00")
	if err != nil {
		panic(err)
	}

	type args struct {
		slug    string
		enabled bool
		data    map[string]string
	}
	tests := []struct {
		name         string
		args         args
		newMap       map[string]string
		newMetadata  *RedactorMetadata
		expectedSlug string
	}{
		{
			name: "update existing redact",
			args: args{
				slug:    "update-redact",
				enabled: false,
				data: map[string]string{
					"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2010-06-15T14:26:10.721619-04:00","enabled":true,"description":"a description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact"}`,
					"leave-untouched": `other keys should not be modified`,
				},
			},
			newMap: map[string]string{
				"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":false,"description":"a description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact"}`,
				"leave-untouched": `other keys should not be modified`,
			},
			newMetadata: &RedactorMetadata{
				Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: update redact`,
				Metadata: RedactorList{
					Name:        "update redact",
					Slug:        "update-redact",
					Enabled:     false,
					Description: "a description",
					Created:     previousTime,
					Updated:     testTime,
				},
			},
		},
		{
			name: "updated time changes even if enabled does not",
			args: args{
				slug:    "update-redact",
				enabled: true,
				data: map[string]string{
					"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2010-06-15T14:26:10.721619-04:00","enabled":true,"description":"a description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact"}`,
					"leave-untouched": `other keys should not be modified`,
				},
			},
			newMap: map[string]string{
				"update-redact":   `{"metadata":{"name":"update redact","slug":"update-redact","createdAt":"2010-06-15T14:26:10.721619-04:00","updatedAt":"2020-06-15T14:26:10.721619-04:00","enabled":true,"description":"a description"},"redact":"kind: Redactor\napiVersion: troubleshoot.replicated.com/v1beta1\nmetadata:\n  name: update redact"}`,
				"leave-untouched": `other keys should not be modified`,
			},
			newMetadata: &RedactorMetadata{
				Redact: `kind: Redactor
apiVersion: troubleshoot.replicated.com/v1beta1
metadata:
  name: update redact`,
				Metadata: RedactorList{
					Name:        "update redact",
					Slug:        "update-redact",
					Enabled:     true,
					Description: "a description",
					Created:     previousTime,
					Updated:     testTime,
				},
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			req := require.New(t)

			newMap, newMetadata, err := setRedactEnabled(tt.args.slug, tt.args.enabled, testTime, tt.args.data)
			req.NoError(err)

			req.Equal(tt.newMap, newMap)
			req.Equal(tt.newMetadata, newMetadata)
		})
	}
}