~james/core

core/spindle/models/logger_test.go -rw-r--r-- 6.0 KiB
452f17b7 — james chore(import): snapshot james.dad.town/core at f70c71c7696a 16 hours ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package models

import (
	"encoding/json"
	"os"
	"path/filepath"
	"strings"
	"testing"
)

func testWorkflowId(name string) WorkflowId {
	return WorkflowId{PipelineId: PipelineId("rkey1"), Name: name}
}

func readDataContents(t *testing.T, path string) []string {
	t.Helper()
	raw, err := os.ReadFile(path)
	if err != nil {
		t.Fatal(err)
	}

	var got []string
	for _, encoded := range strings.Split(strings.TrimSpace(string(raw)), "\n") {
		var line LogLine
		if err := json.Unmarshal([]byte(encoded), &line); err != nil {
			t.Fatalf("decode log line %q: %v", encoded, err)
		}
		got = append(got, line.Content)
	}
	return got
}

func TestDataWriterMasksSecretSplitAcrossWrites(t *testing.T) {
	dir := t.TempDir()
	secret := "hunter2-super-secret-token"
	wid := testWorkflowId("mask")
	logger, err := NewFileWorkflowLogger(dir, wid, []string{secret})
	if err != nil {
		t.Fatal(err)
	}
	w := logger.DataWriter(0, "stdout")

	for _, ch := range strings.Split("prefix "+secret+" suffix", "") {
		if _, err := w.Write([]byte(ch)); err != nil {
			t.Fatal(err)
		}
	}
	if err := logger.Close(); err != nil {
		t.Fatal(err)
	}

	raw, err := os.ReadFile(filepath.Join(dir, wid.String()+".log"))
	if err != nil {
		t.Fatal(err)
	}
	if strings.Contains(string(raw), secret) {
		t.Errorf("log contains raw secret: %s", raw)
	}
	if !strings.Contains(string(raw), "***") {
		t.Errorf("log does not contain masked marker: %s", raw)
	}
	// trailing bytes land in the final flush entry contiguously
	if !strings.Contains(string(raw), "suffix") {
		t.Errorf("log lost trailing output: %s", raw)
	}
	if got := strings.Join(readDataContents(t, filepath.Join(dir, wid.String()+".log")), "\n"); got != "prefix *** suffix" {
		t.Errorf("masked output changed: %q", got)
	}
}

func TestDataWriterMasksSingleFrame(t *testing.T) {
	dir := t.TempDir()
	secret := "hunter2-super-secret-token"
	wid := testWorkflowId("frame")
	logger, err := NewFileWorkflowLogger(dir, wid, []string{secret})
	if err != nil {
		t.Fatal(err)
	}
	w := logger.DataWriter(0, "stdout")
	if _, err := w.Write([]byte("token is " + secret + " ok")); err != nil {
		t.Fatal(err)
	}
	if err := logger.Close(); err != nil {
		t.Fatal(err)
	}

	raw, err := os.ReadFile(filepath.Join(dir, wid.String()+".log"))
	if err != nil {
		t.Fatal(err)
	}
	if strings.Contains(string(raw), secret) {
		t.Errorf("log contains raw secret: %s", raw)
	}
	if !strings.Contains(string(raw), "en is *** ok") {
		t.Errorf("masked entry mangled: %s", raw)
	}
}

func TestDataWriterNoMaskPassthrough(t *testing.T) {
	dir := t.TempDir()
	wid := testWorkflowId("plain")
	logger, err := NewFileWorkflowLogger(dir, wid, nil)
	if err != nil {
		t.Fatal(err)
	}
	w := logger.DataWriter(0, "stdout")
	if _, err := w.Write([]byte("hello")); err != nil {
		t.Fatal(err)
	}
	if _, err := w.Write([]byte(" world")); err != nil {
		t.Fatal(err)
	}
	if err := logger.Close(); err != nil {
		t.Fatal(err)
	}

	raw, err := os.ReadFile(filepath.Join(dir, wid.String()+".log"))
	if err != nil {
		t.Fatal(err)
	}
	if !strings.Contains(string(raw), "hello") || !strings.Contains(string(raw), " world") {
		t.Errorf("log missing output: %s", raw)
	}
}

func TestDataWriterDoesNotSplitSafeFragmentsIntoLogLines(t *testing.T) {
	dir := t.TempDir()
	wid := testWorkflowId("line-boundaries")
	logger, err := NewFileWorkflowLogger(dir, wid, []string{"a-secret-with-a-long-window"})
	if err != nil {
		t.Fatal(err)
	}
	w := logger.DataWriter(0, "stdout")
	want := []string{
		"first line",
		"second line",
		"third line",
		"fourth line",
		"fifth line",
		"sixth line",
		"seventh line",
		"eighth line",
	}
	for _, line := range want {
		if _, err := w.Write([]byte(line + "\n")); err != nil {
			t.Fatal(err)
		}
	}
	if err := logger.Close(); err != nil {
		t.Fatal(err)
	}

	got := readDataContents(t, filepath.Join(dir, wid.String()+".log"))

	if joined := strings.Join(got, "\n"); joined != strings.Join(want, "\n") {
		t.Fatalf("log content was split at masking window:\n got: %q\nwant: %q", joined, strings.Join(want, "\n"))
	}
}

func TestDataWriterEmitsShortLinesBeforeClose(t *testing.T) {
	dir := t.TempDir()
	wid := testWorkflowId("live")
	logger, err := NewFileWorkflowLogger(dir, wid, []string{"q7Zp2LmX9vRt4KsW8nYb"})
	if err != nil {
		t.Fatal(err)
	}
	defer logger.Close()
	w := logger.DataWriter(0, "stdout")
	if _, err := w.Write([]byte("A=42\n")); err != nil {
		t.Fatal(err)
	}

	if got := readDataContents(t, filepath.Join(dir, wid.String()+".log")); len(got) != 1 || got[0] != "A=42" {
		t.Fatalf("a finished line was held back until close: %q", got)
	}
}

func TestDataWriterMasksSecretSplitAcrossLines(t *testing.T) {
	dir := t.TempDir()
	wid := testWorkflowId("split-lines")
	logger, err := NewFileWorkflowLogger(dir, wid, []string{"hunter2-super-secret-token", "line-one\nline-two"})
	if err != nil {
		t.Fatal(err)
	}
	w := logger.DataWriter(0, "stdout")
	for _, chunk := range []string{"a hunter2-su", "per-secret-token b\nline-o", "ne\nline-t", "wo\n"} {
		if _, err := w.Write([]byte(chunk)); err != nil {
			t.Fatal(err)
		}
	}
	if err := logger.Close(); err != nil {
		t.Fatal(err)
	}

	got := strings.Join(readDataContents(t, filepath.Join(dir, wid.String()+".log")), "\n")
	if want := "a *** b\n***\n***"; got != want {
		t.Fatalf("secret split across writes was not masked: %q", got)
	}
}

func TestDataWriterMasksMultilineSecret(t *testing.T) {
	dir := t.TempDir()
	secret := "line-one\nline-two"
	wid := testWorkflowId("multiline-mask")
	logger, err := NewFileWorkflowLogger(dir, wid, []string{secret})
	if err != nil {
		t.Fatal(err)
	}
	w := logger.DataWriter(0, "stdout")
	chunk := strings.Repeat("p", 40) + "\nline-one\nline-two\n" + strings.Repeat("t", 30) + "\nsuffix\n"
	if _, err := w.Write([]byte(chunk)); err != nil {
		t.Fatal(err)
	}
	if err := logger.Close(); err != nil {
		t.Fatal(err)
	}

	got := strings.Join(readDataContents(t, filepath.Join(dir, wid.String()+".log")), "\n")
	want := strings.Repeat("p", 40) + "\n***\n***\n" + strings.Repeat("t", 30) + "\nsuffix"
	if got != want {
		t.Fatalf("multiline secret was not masked: %q", got)
	}
}