File: marbl_test.go

package info (click to toggle)
golang-github-google-martian 2.1.0%2Bgit20181219.d0b5ad3-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 1,140 kB
  • sloc: makefile: 3
file content (405 lines) | stat: -rw-r--r-- 11,374 bytes parent folder | download
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
// Copyright 2015 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package marbl

import (
	"bytes"
	"io"
	"net/http"
	"strconv"
	"strings"
	"testing"
	"time"

	"github.com/google/martian"
	"github.com/google/martian/proxyutil"
)

func TestMarkAPIRequestsWithHeader(t *testing.T) {
	areq, err := http.NewRequest("POST", "http://localhost:8080/configure", nil)
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	ctx, remove, err := martian.TestContext(areq, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer remove()

	ctx.APIRequest()

	req, err := http.NewRequest("GET", "http://example.com", nil)
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	_, removereq, err := martian.TestContext(req, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer removereq()

	var b bytes.Buffer

	s := NewStream(&b)
	s.LogRequest("00000000", areq)
	s.LogRequest("00000001", req)
	s.Close()

	headers := make(map[string]string)
	reader := NewReader(&b)

	for {
		frame, err := reader.ReadFrame()
		if frame == nil {
			break
		}
		if err != nil && err != io.EOF {
			t.Fatalf("reader.ReadFrame(): got %v, want no error or io.EOF", err)
		}

		headerFrame, ok := frame.(Header)
		if !ok {
			t.Fatalf("frame.(Header): couldn't convert frame '%v' to a headerFrame", frame)
		}
		headers[headerFrame.ID+headerFrame.Name] = headerFrame.Value
	}

	apih, ok := headers["00000000:api"]
	if !ok {
		t.Errorf("headers[00000000:api]: got no such header, want :api (headers were: %v)", headers)
	}

	if got, want := apih, "true"; got != want {
		t.Errorf("headers[%q]: got %v, want %q", "00000000:api", got, want)
	}

	_, ok = headers["00000001:api"]
	if got, want := ok, false; got != want {
		t.Error("headers[00000001:api]: got :api header, want no header for non-api requests")
	}
}

func TestSendTimestampWithLogRequest(t *testing.T) {
	req, err := http.NewRequest("POST", "http://example.com", nil)
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	_, remove, err := martian.TestContext(req, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer remove()

	var b bytes.Buffer
	s := NewStream(&b)

	before := time.Now().UnixNano() / 1000 / 1000
	s.LogRequest("Fake_Id0", req)
	s.Close()
	after := time.Now().UnixNano() / 1000 / 1000

	headers := make(map[string]string)
	reader := NewReader(&b)

	for {
		frame, err := reader.ReadFrame()
		if frame == nil {
			break
		}
		if err != nil && err != io.EOF {
			t.Fatalf("reader.ReadFrame(): got %v, want no error or io.EOF", err)
		}

		headerFrame, ok := frame.(Header)
		if !ok {
			t.Fatalf("frame.(Header): couldn't convert frame '%v' to a headerFrame", frame)
		}
		headers[headerFrame.Name] = headerFrame.Value
	}

	timestr, ok := headers[":timestamp"]
	if !ok {
		t.Fatalf("headers[:timestamp]: got no such header, want :timestamp (headers were: %v)", headers)
	}
	ts, err := strconv.ParseInt(timestr, 10, 64)
	if err != nil {
		t.Fatalf("strconv.ParseInt: got %s, want no error. Invalidly formatted timestamp ('%s')", err, timestr)
	}
	if ts < before || ts > after {
		t.Fatalf("headers[:timestamp]: got %d, want timestamp between %d and %d", ts, before, after)
	}
}

func TestSendTimestampWithLogResponse(t *testing.T) {
	req, err := http.NewRequest("POST", "http://example.com", nil)
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	_, remove, err := martian.TestContext(req, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer remove()

	res := proxyutil.NewResponse(200, nil, req)
	var b bytes.Buffer
	s := NewStream(&b)

	before := time.Now().UnixNano() / 1000 / 1000
	s.LogResponse("Fake_Id1", res)
	s.Close()
	after := time.Now().UnixNano() / 1000 / 1000

	headers := make(map[string]string)
	reader := NewReader(&b)

	for {
		frame, err := reader.ReadFrame()
		if frame == nil {
			break
		}
		if err != nil && err != io.EOF {
			t.Fatalf("reader.ReadFrame(): got %v, want no error or io.EOF", err)
		}

		headerFrame, ok := frame.(Header)
		if !ok {
			t.Fatalf("frame.(Header): couldn't convert frame '%v' to a headerFrame", frame)
		}
		headers[headerFrame.Name] = headerFrame.Value
	}

	timestr, ok := headers[":timestamp"]
	if !ok {
		t.Fatalf("headers[:timestamp]: got no such header, want :timestamp (headers were: %v)", headers)
	}
	ts, err := strconv.ParseInt(timestr, 10, 64)
	if err != nil {
		t.Fatalf("strconv.ParseInt: got %s, want no error. Invalidly formatted timestamp ('%s')", err, timestr)
	}
	if ts < before || ts > after {
		t.Fatalf("headers[:timestamp]: got %d, want timestamp between %d and %d (headers were: %v)", ts, before, after, headers)
	}
}

func TestBodyLoggingWithOneRead(t *testing.T) {
	// Test scenario:
	// 1. Prepare HTTP request with body containing a string.
	// 2. Initialize marbl logging on this request.
	// 3. Read body of the request in single Read() and verity that it matches
	//    original string.
	// 4. Parse marbl data, extract DataFrames and verify that they match
	// .  original string.
	body := "hello, world"
	req, err := http.NewRequest("POST", "http://example.com", strings.NewReader(body))
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	_, remove, err := martian.TestContext(req, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer remove()

	var b bytes.Buffer
	s := NewStream(&b)
	s.LogRequest("Fake_Id0", req)

	// Read request body into big slice.
	bodybytes := make([]byte, 100)

	// First read. Due to implementation details of strings.Read
	// it reads all bytes but doesn't return EOF.
	n, err := req.Body.Read(bodybytes)
	if n != len(body) {
		t.Fatalf("req.Body.Read(): expected to read %v bytes but read %v", len(body), n)
	}
	if body != string(bodybytes[:n]) {
		t.Fatalf("req.Body.Read(): expected to read %v but read %v", body, string(bodybytes[:n]))
	}
	if err != nil {
		t.Fatalf("req.Body.Read(): first read expected to be successful but got error %v", err)
	}

	// second read. We already consumed the whole string on the first read
	// so now it should be 0 bytes and EOF.
	n, err = req.Body.Read(bodybytes)
	if n != 0 {
		t.Fatalf("req.Body.Read(): expected to read 0 bytes but read %v", n)
	}
	if err != io.EOF {
		t.Fatalf("req.Body.Read(): expected EOF but got %v", err)
	}

	s.Close()
	reader := NewReader(&b)
	bodybytes = readAllDataFrames(reader, "Fake_Id0", t)
	if len(bodybytes) != len(body) {
		t.Fatalf("readAllDataFrames(): expected .marbl data to have %v bytes, but got %v", len(body), len(bodybytes))
	}
	if body != string(bodybytes) {
		t.Fatalf("readAllDataFrames(): expected .marbl data to have string %v but got %v", body, string(bodybytes))
	}
}

func TestBodyLogging_ManyReads(t *testing.T) {
	// Test scenario:
	// 1. Prepare HTTP request with body containing a string.
	// 2. Initialize marbl logging on this request.
	// 3. Read body of the request in many reads, 1 byte per read and
	// .  verify that it matches original string.
	// 4. Parse marbl data, extract DataFrames and verify that they match
	// .  original string.
	body := "hello, world"
	req, err := http.NewRequest("POST", "http://example.com", strings.NewReader(body))
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	_, remove, err := martian.TestContext(req, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer remove()

	var b bytes.Buffer
	s := NewStream(&b)
	s.LogRequest("Fake_Id0", req)

	// Read request body into single byte slice.
	bodybytes := make([]byte, 1)

	for i := 0; i < len(body); i++ {
		// first read
		n, err := req.Body.Read(bodybytes)
		if n != 1 {
			t.Fatalf("req.Body.Read(): expected to read 1 byte but read %v", n)
		}
		if body[i] != bodybytes[0] {
			t.Fatalf("req.Body.Read(): expected to read %v but read %v", body[i], bodybytes[0])
		}
		if err != nil {
			t.Fatalf("req.Body.Read(): read expected to be successfully but got error %v", err)
		}
	}

	// last read. We already consumed the whole string on the previous reads
	// so now it should be 0 bytes and EOF.
	n, err := req.Body.Read(bodybytes)
	if n != 0 {
		t.Fatalf("req.Body.Read(): expected to read 0 bytes but read %v", n)
	}
	if err != io.EOF {
		t.Fatalf("req.Body.Read(): expected EOF but got %v", err)
	}

	s.Close()
	reader := NewReader(&b)
	bodybytes = readAllDataFrames(reader, "Fake_Id0", t)
	if len(bodybytes) != len(body) {
		t.Fatalf("readAllDataFrames(): expected .marbl data to have %v bytes, but got %v", len(body), len(bodybytes))
	}
	if body != string(bodybytes) {
		t.Fatalf("readAllDataFrames(): expected .marbl data to have string %v but got %v", body, string(bodybytes))
	}
}

func TestReturnOriginalRequestPathAndQuery(t *testing.T) {
	req, err := http.NewRequest("GET", "http://example.com/foo%20bar?baz%20qux", nil)
	if err != nil {
		t.Fatalf("http.NewRequest(): got %v, want no error", err)
	}

	_, remove, err := martian.TestContext(req, nil, nil)
	if err != nil {
		t.Fatalf("TestContext(): got %v, want no error", err)
	}
	defer remove()

	var b bytes.Buffer
	s := NewStream(&b)

	s.LogRequest("Fake_Id0", req)
	s.Close()

	headers := make(map[string]string)
	reader := NewReader(&b)

	for {
		frame, err := reader.ReadFrame()
		if frame == nil {
			break
		}
		if err != nil && err != io.EOF {
			t.Fatalf("reader.ReadFrame(): got %v, want no error or io.EOF", err)
		}

		headerFrame, ok := frame.(Header)
		if !ok {
			t.Fatalf("frame.(Header): couldn't convert frame '%v' to a headerFrame", frame)
		}
		headers[headerFrame.Name] = headerFrame.Value
	}

	path := headers[":path"]
	if path != "/foo%20bar" {
		t.Fatalf("headers[:path]: expected /foo%%20bar but got %s", path)
	}
	query := headers[":query"]
	if query != "baz%20qux" {
		t.Fatalf("headers[:query]: expected baz%%20qux but got %s", query)
	}
}

// readAllDataFrames reads all DataFrames with reader, filters the one that match provided
// id and assembles data from all frames into single slice. It expects that
// there is only one slice of DataFrames with provided id.
func readAllDataFrames(reader *Reader, id string, t *testing.T) []byte {
	res := make([]byte, 0)
	term := false
	var i uint32
	for {
		frame, _ := reader.ReadFrame()
		if frame == nil {
			break
		}
		if frame.FrameType() == DataFrame {
			df := frame.(Data)
			if df.ID != id {
				continue
			}
			if term {
				t.Fatal("DataFrame after terminal frame are not allowed.")
			}
			if df.Index != i {
				t.Fatalf("expected DataFrame index %v but got %v", i, df.Index)
			}
			term = df.Terminal
			res = append(res, df.Data...)
			i++
		}
	}
	
	if !term {
		t.Fatal("didn't see terminal DataFrame")
	}
	
	return res
}