summaryrefslogtreecommitdiff
path: root/testrig/transportcontroller.go
blob: 00f8ad2a625c5a14911036bed8d857bec0d7cccb (plain)
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package testrig

import (
	"bytes"
	"encoding/json"
	"encoding/xml"
	"io"
	"net/http"
	"strings"
	"sync"

	"github.com/superseriousbusiness/activity/pub"
	"github.com/superseriousbusiness/activity/streams"
	"github.com/superseriousbusiness/activity/streams/vocab"
	"github.com/superseriousbusiness/gotosocial/internal/ap"
	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
	"github.com/superseriousbusiness/gotosocial/internal/federation"
	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
	"github.com/superseriousbusiness/gotosocial/internal/httpclient"
	"github.com/superseriousbusiness/gotosocial/internal/log"
	"github.com/superseriousbusiness/gotosocial/internal/state"
	"github.com/superseriousbusiness/gotosocial/internal/transport"
)

const (
	applicationJSON         = "application/json"
	applicationActivityJSON = "application/activity+json"
	textCSV                 = "text/csv"
	textPlain               = "text/plain"
)

// NewTestTransportController returns a test transport controller with the given http client.
//
// Obviously for testing purposes you should not be making actual http calls to other servers.
// To obviate this, use the function NewMockHTTPClient in this package to return a mock http
// client that doesn't make any remote calls but just returns whatever you tell it to.
//
// Unlike the other test interfaces provided in this package, you'll probably want to call this function
// PER TEST rather than per suite, so that the do function can be set on a test by test (or even more granular)
// basis.
func NewTestTransportController(state *state.State, client pub.HttpClient) transport.Controller {
	return transport.NewController(state, NewTestFederatingDB(state), &federation.Clock{}, client)
}

type MockHTTPClient struct {
	do func(req *http.Request) (*http.Response, error)

	TestRemoteStatuses    map[string]vocab.ActivityStreamsNote
	TestRemotePeople      map[string]vocab.ActivityStreamsPerson
	TestRemoteGroups      map[string]vocab.ActivityStreamsGroup
	TestRemoteServices    map[string]vocab.ActivityStreamsService
	TestRemoteAttachments map[string]RemoteAttachmentFile
	TestRemoteEmojis      map[string]vocab.TootEmoji
	TestTombstones        map[string]*gtsmodel.Tombstone

	SentMessages sync.Map
}

// NewMockHTTPClient returns a client that conforms to the pub.HttpClient interface.
//
// If do is nil, then a standard response set will be mocked out, which includes models stored in the
// testrig, and webfinger responses as well.
//
// If do is not nil, then the given do function will always be used, which allows callers
// to customize how the client is mocked.
//
// Note that you should never ever make ACTUAL http calls with this thing.
func NewMockHTTPClient(do func(req *http.Request) (*http.Response, error), relativeMediaPath string, extraPeople ...ap.Accountable) *MockHTTPClient {
	mockHTTPClient := &MockHTTPClient{}

	if do != nil {
		mockHTTPClient.do = do
		return mockHTTPClient
	}

	mockHTTPClient.TestRemoteStatuses = NewTestFediStatuses()
	mockHTTPClient.TestRemotePeople = NewTestFediPeople()
	mockHTTPClient.TestRemoteGroups = NewTestFediGroups()
	mockHTTPClient.TestRemoteServices = NewTestFediServices()
	mockHTTPClient.TestRemoteAttachments = NewTestFediAttachments(relativeMediaPath)
	mockHTTPClient.TestRemoteEmojis = NewTestFediEmojis()
	mockHTTPClient.TestTombstones = NewTestTombstones()

	mockHTTPClient.do = func(req *http.Request) (*http.Response, error) {
		var (
			responseCode          = http.StatusNotFound
			responseBytes         = []byte(`{"error":"404 not found"}`)
			responseContentType   = applicationJSON
			responseContentLength = len(responseBytes)
			extraHeaders          = make(map[string]string, 0)
			reqURLString          = req.URL.String()
		)

		if req.Method == http.MethodPost {
			b, err := io.ReadAll(req.Body)
			if err != nil {
				panic(err)
			}

			if sI, loaded := mockHTTPClient.SentMessages.LoadOrStore(reqURLString, [][]byte{b}); loaded {
				s, ok := sI.([][]byte)
				if !ok {
					panic("SentMessages entry wasn't [][]byte")
				}
				s = append(s, b)
				mockHTTPClient.SentMessages.Store(reqURLString, s)
			}

			responseCode = http.StatusOK
			responseBytes = []byte(`{"ok":"accepted"}`)
			responseContentType = applicationJSON
			responseContentLength = len(responseBytes)
		} else if strings.Contains(reqURLString, ".well-known/webfinger") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = WebfingerResponse(req)
		} else if strings.Contains(reqURLString, ".weird-webfinger-location/webfinger") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = WebfingerResponse(req)
		} else if strings.Contains(reqURLString, ".well-known/host-meta") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = HostMetaResponse(req)
		} else if strings.Contains(reqURLString, ".well-known/nodeinfo") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = WellKnownNodeInfoResponse(req)
		} else if strings.Contains(reqURLString, "/robots.txt") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = RobotsTxtResponse(req)
		} else if strings.Contains(reqURLString, "/nodeinfo/2.1") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = NodeInfoResponse(req)
		} else if strings.Contains(reqURLString, "lists.example.org") {
			responseCode, responseBytes, responseContentType, responseContentLength, extraHeaders = DomainPermissionSubscriptionResponse(req)
		} else if note, ok := mockHTTPClient.TestRemoteStatuses[reqURLString]; ok {
			// the request is for a note that we have stored
			noteI, err := streams.Serialize(note)
			if err != nil {
				panic(err)
			}
			noteJSON, err := json.Marshal(noteI)
			if err != nil {
				panic(err)
			}
			responseCode = http.StatusOK
			responseBytes = noteJSON
			responseContentType = applicationActivityJSON
			responseContentLength = len(noteJSON)
		} else if person, ok := mockHTTPClient.TestRemotePeople[reqURLString]; ok {
			// the request is for a person that we have stored
			personI, err := streams.Serialize(person)
			if err != nil {
				panic(err)
			}
			personJSON, err := json.Marshal(personI)
			if err != nil {
				panic(err)
			}
			responseCode = http.StatusOK
			responseBytes = personJSON
			responseContentType = applicationActivityJSON
			responseContentLength = len(personJSON)
		} else if group, ok := mockHTTPClient.TestRemoteGroups[reqURLString]; ok {
			// the request is for a person that we have stored
			groupI, err := streams.Serialize(group)
			if err != nil {
				panic(err)
			}
			groupJSON, err := json.Marshal(groupI)
			if err != nil {
				panic(err)
			}
			responseCode = http.StatusOK
			responseBytes = groupJSON
			responseContentType = applicationActivityJSON
			responseContentLength = len(groupJSON)
		} else if service, ok := mockHTTPClient.TestRemoteServices[reqURLString]; ok {
			serviceI, err := streams.Serialize(service)
			if err != nil {
				panic(err)
			}
			serviceJSON, err := json.Marshal(serviceI)
			if err != nil {
				panic(err)
			}
			responseCode = http.StatusOK
			responseBytes = serviceJSON
			responseContentType = applicationActivityJSON
			responseContentLength = len(serviceJSON)
		} else if emoji, ok := mockHTTPClient.TestRemoteEmojis[reqURLString]; ok {
			emojiI, err := streams.Serialize(emoji)
			if err != nil {
				panic(err)
			}
			emojiJSON, err := json.Marshal(emojiI)
			if err != nil {
				panic(err)
			}
			responseCode = http.StatusOK
			responseBytes = emojiJSON
			responseContentType = applicationActivityJSON
			responseContentLength = len(emojiJSON)
		} else if attachment, ok := mockHTTPClient.TestRemoteAttachments[reqURLString]; ok {
			responseCode = http.StatusOK
			responseBytes = attachment.Data
			responseContentType = attachment.ContentType
			responseContentLength = len(attachment.Data)
		} else if _, ok := mockHTTPClient.TestTombstones[reqURLString]; ok {
			responseCode = http.StatusGone
			responseBytes = []byte{}
			responseContentType = "text/html"
			responseContentLength = 0
		} else {
			for _, person := range extraPeople {
				// For any extra people, check if the
				// request matches one of:
				//
				//   - Public key URI
				//   - ActivityPub URI/id
				//   - Web URL.
				//
				// Since this is a test environment,
				// just assume all these values have
				// been properly set.
				if reqURLString == person.GetW3IDSecurityV1PublicKey().At(0).Get().GetJSONLDId().GetIRI().String() ||
					reqURLString == person.GetJSONLDId().GetIRI().String() ||
					reqURLString == person.GetActivityStreamsUrl().At(0).GetIRI().String() {
					personI, err := streams.Serialize(person)
					if err != nil {
						panic(err)
					}
					personJSON, err := json.Marshal(personI)
					if err != nil {
						panic(err)
					}
					responseCode = http.StatusOK
					responseBytes = personJSON
					responseContentType = applicationActivityJSON
					responseContentLength = len(personJSON)
				}
			}
		}

		log.Debugf(nil, "returning response %s", string(responseBytes))

		reader := bytes.NewReader(responseBytes)
		readCloser := io.NopCloser(reader)

		header := http.Header{
			"Content-Type": {responseContentType},
		}
		for k, v := range extraHeaders {
			header.Add(k, v)
		}

		return &http.Response{
			Request:       req,
			StatusCode:    responseCode,
			Body:          readCloser,
			ContentLength: int64(responseContentLength),
			Header:        header,
		}, nil
	}

	return mockHTTPClient
}

func (m *MockHTTPClient) Do(req *http.Request) (*http.Response, error) {
	return m.do(req)
}

func (m *MockHTTPClient) DoSigned(req *http.Request, sign httpclient.SignFunc) (*http.Response, error) {
	return m.do(req)
}

func HostMetaResponse(req *http.Request) (
	responseCode int,
	responseBytes []byte,
	responseContentType string,
	responseContentLength int,
	extraHeaders map[string]string,
) {
	var hm *apimodel.HostMeta

	if req.URL.String() == "https://misconfigured-instance.com/.well-known/host-meta" {
		hm = &apimodel.HostMeta{
			XMLNS: "http://docs.oasis-open.org/ns/xri/xrd-1.0",
			Link: []apimodel.Link{
				{
					Rel:      "lrdd",
					Type:     "application/xrd+xml",
					Template: "https://misconfigured-instance.com/.weird-webfinger-location/webfinger?resource={uri}",
				},
			},
		}
	}

	if hm == nil {
		log.Debugf(nil, "hostmeta response not available for %s", req.URL)
		responseCode = http.StatusNotFound
		responseBytes = []byte(``)
		responseContentType = "application/xml"
		responseContentLength = len(responseBytes)
		return
	}

	hmXML, err := xml.Marshal(hm)
	if err != nil {
		panic(err)
	}
	responseCode = http.StatusOK
	responseBytes = hmXML
	responseContentType = "application/xml"
	responseContentLength = len(hmXML)
	return
}

func WellKnownNodeInfoResponse(req *http.Request) (
	responseCode int,
	responseBytes []byte,
	responseContentType string,
	responseContentLength int,
	extraHeaders map[string]string,
) {
	var wkr *apimodel.WellKnownResponse

	switch req.URL.String() {
	case "https://fossbros-anonymous.io/.well-known/nodeinfo":
		wkr = &apimodel.WellKnownResponse{
			Links: []apimodel.Link{
				{
					Rel:  "http://nodeinfo.diaspora.software/ns/schema/2.1",
					Href: "https://fossbros-anonymous.io/nodeinfo/2.1",
				},
			},
		}
	case "https://furtive-nerds.example.org/.well-known/nodeinfo":
		wkr = &apimodel.WellKnownResponse{
			Links: []apimodel.Link{
				{
					Rel:  "http://nodeinfo.diaspora.software/ns/schema/2.1",
					Href: "https://furtive-nerds.example.org/nodeinfo/2.1",
				},
			},
		}
	case "https://really.furtive-nerds.example.org/.well-known/nodeinfo":
		wkr = &apimodel.WellKnownResponse{
			Links: []apimodel.Link{
				{
					Rel:  "http://nodeinfo.diaspora.software/ns/schema/2.1",
					Href: "https://really.furtive-nerds.example.org/nodeinfo/2.1",
				},
			},
		}
		extraHeaders = map[string]string{"X-Robots-Tag": "noindex,nofollow"}
	default:
		log.Debugf(nil, "nodeinfo response not available for %s", req.URL)
		responseCode = http.StatusNotFound
		responseBytes = []byte(``)
		responseContentType = "application/json"
		responseContentLength = len(responseBytes)
		return
	}

	niJSON, err := json.Marshal(wkr)
	if err != nil {
		panic(err)
	}
	responseCode = http.StatusOK
	responseBytes = niJSON
	responseContentType = "application/json"
	responseContentLength = len(niJSON)

	return
}

func NodeInfoResponse(req *http.Request) (
	responseCode int,
	responseBytes []byte,
	responseContentType string,
	responseContentLength int,
	extraHeaders map[string]string,
) {
	var ni *apimodel.Nodeinfo

	switch req.URL.String() {
	case "https://fossbros-anonymous.io/nodeinfo/2.1":
		ni = &apimodel.Nodeinfo{
			Version: "2.1",
			Software: apimodel.NodeInfoSoftware{
				Name:       "Hellsoft",
				Version:    "6.6.6",
				Repository: "https://forge.hellsoft.fossbros-anonymous.io",
				Homepage:   "https://hellsoft.fossbros-anonymous.io",
			},
			Protocols: []string{"activitypub"},
		}
	case "https://furtive-nerds.example.org/nodeinfo/2.1":
		ni = &apimodel.Nodeinfo{
			Version: "2.1",
			Software: apimodel.NodeInfoSoftware{
				Name:       "GoToSocial",
				Version:    "1.3.1.2",
				Repository: "https://github.com/superseriousbusiness/gotosocial",
				Homepage:   "https://docs.gotosocial.org",
			},
			Protocols: []string{"activitypub"},
		}
	case "https://really.furtive-nerds.example.org/nodeinfo/2.1":
		ni = &apimodel.Nodeinfo{
			Version: "2.1",
			Software: apimodel.NodeInfoSoftware{
				Name:       "GoToSocial",
				Version:    "1.3.1.2",
				Repository: "https://github.com/superseriousbusiness/gotosocial",
				Homepage:   "https://docs.gotosocial.org",
			},
			Protocols: []string{"activitypub"},
		}
	default:
		log.Debugf(nil, "nodeinfo response not available for %s", req.URL)
		responseCode = http.StatusNotFound
		responseBytes = []byte(``)
		responseContentType = "application/json"
		responseContentLength = len(responseBytes)
		return
	}

	niJSON, err := json.Marshal(ni)
	if err != nil {
		panic(err)
	}
	responseCode = http.StatusOK
	responseBytes = niJSON
	responseContentType = "application/json"
	responseContentLength = len(niJSON)

	return
}

func RobotsTxtResponse(req *http.Request) (
	responseCode int,
	responseBytes []byte,
	responseContentType string,
	responseContentLength int,
	extraHeaders map[string]string,
) {
	var robots string

	switch req.URL.String() {
	case "https://furtive-nerds.example.org/robots.txt":
		// Disallow nodeinfo.
		robots = "User-agent: *\nDisallow: /nodeinfo"
	case "https://robotic.furtive-nerds.example.org/robots.txt":
		// Disallow everything.
		robots = "User-agent: *\nDisallow: /"
	default:
		log.Debugf(nil, "robots response not available for %s", req.URL)
		responseCode = http.StatusNotFound
		responseBytes = []byte(``)
		responseContentType = "text/plain"
		responseContentLength = len(responseBytes)
		return
	}

	responseCode = http.StatusOK
	responseBytes = []byte(robots)
	responseContentType = "text/plain"
	responseContentLength = len(responseBytes)

	return
}

func WebfingerResponse(req *http.Request) (
	responseCode int,
	responseBytes []byte,
	responseContentType string,
	responseContentLength int,
	extraHeaders map[string]string,
) {
	var wfr *apimodel.WellKnownResponse

	switch req.URL.String() {
	case "https://unknown-instance.com/.well-known/webfinger?resource=acct%3Asome_group%40unknown-instance.com":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:some_group@unknown-instance.com",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://unknown-instance.com/groups/some_group",
				},
			},
		}
	case "https://owncast.example.org/.well-known/webfinger?resource=acct%3Argh%40owncast.example.org":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:rgh@example.org",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://owncast.example.org/federation/user/rgh",
				},
			},
		}
	case "https://unknown-instance.com/.well-known/webfinger?resource=acct%3Abrand_new_person%40unknown-instance.com":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:brand_new_person@unknown-instance.com",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://unknown-instance.com/users/brand_new_person",
				},
			},
		}
	case "https://xn--pnycde-zxa8b.example.org/.well-known/webfinger?resource=acct%3Abrand_new_person%40xn--pnycde-zxa8b.example.org":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:brand_new_person@unknown-instance.com",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://unknown-instance.com/users/brand_new_person",
				},
			},
		}
	case "https://turnip.farm/.well-known/webfinger?resource=acct%3Aturniplover6969%40turnip.farm":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:turniplover6969@turnip.farm",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://turnip.farm/users/turniplover6969",
				},
			},
		}
	case "https://fossbros-anonymous.io/.well-known/webfinger?resource=acct%3Afoss_satan%40fossbros-anonymous.io":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:foss_satan@fossbros-anonymous.io",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "http://fossbros-anonymous.io/users/foss_satan",
				},
			},
		}
	case "https://example.org/.well-known/webfinger?resource=acct%3ASome_User%40example.org":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:Some_User@example.org",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://example.org/users/Some_User",
				},
			},
		}
	case "https://misconfigured-instance.com/.weird-webfinger-location/webfinger?resource=acct%3Asomeone%40misconfigured-instance.com":
		wfr = &apimodel.WellKnownResponse{
			Subject: "acct:someone@misconfigured-instance.com",
			Links: []apimodel.Link{
				{
					Rel:  "self",
					Type: applicationActivityJSON,
					Href: "https://misconfigured-instance.com/users/someone",
				},
			},
		}
	}

	if wfr == nil {
		log.Debugf(nil, "webfinger response not available for %s", req.URL)
		responseCode = http.StatusNotFound
		responseBytes = []byte(`{"error":"not found"}`)
		responseContentType = applicationJSON
		responseContentLength = len(responseBytes)
		return
	}

	wfrJSON, err := json.Marshal(wfr)
	if err != nil {
		panic(err)
	}
	responseCode = http.StatusOK
	responseBytes = wfrJSON
	responseContentType = applicationJSON
	responseContentLength = len(wfrJSON)
	return
}

func DomainPermissionSubscriptionResponse(req *http.Request) (
	responseCode int,
	responseBytes []byte,
	responseContentType string,
	responseContentLength int,
	extraHeaders map[string]string,
) {

	const (
		lastModified        = "Sat, 21 Sep 2024 22:00:00 GMT"
		futureLastModified  = "Mon, 15 Jan 2300 22:00:00 GMT"
		garbageLastModified = "I LIKE BIG BUTTS AND I CANNOT LIE"

		csvResp = `#domain,#severity,#reject_media,#reject_reports,#public_comment,#obfuscate
bumfaces.net,suspend,false,false,big jerks,false
peepee.poopoo,suspend,false,false,harassment,false
nothanks.com,suspend,false,false,,false`
		csvRespETag = "\"bigbums6969\""

		textResp = `bumfaces.net
peepee.poopoo
nothanks.com`
		textRespETag = "\"this is a legit etag i swear\""
		jsonResp     = `[
  {
    "domain": "bumfaces.net",
    "suspended_at": "2020-05-13T13:29:12.000Z",
    "public_comment": "big jerks"
  },
    {
    "domain": "peepee.poopoo",
    "suspended_at": "2020-05-13T13:29:12.000Z",
    "public_comment": "harassment"
  },
    {
    "domain": "nothanks.com",
    "suspended_at": "2020-05-13T13:29:12.000Z"
  }
]`
		jsonRespETag = "\"don't modify me daddy\""
	)

	switch req.URL.String() {
	case "https://lists.example.org/baddies.csv":
		extraHeaders = map[string]string{
			"Last-Modified": lastModified,
			"ETag":          csvRespETag,
		}
		if req.Header.Get("If-None-Match") == csvRespETag {
			// Cached.
			responseCode = http.StatusNotModified
		} else {
			responseBytes = []byte(csvResp)
			responseContentType = textCSV
			responseCode = http.StatusOK
		}
		responseContentLength = len(responseBytes)

	case "https://lists.example.org/baddies.txt":
		extraHeaders = map[string]string{
			"Last-Modified": lastModified,
			"ETag":          textRespETag,
		}
		if req.Header.Get("If-None-Match") == textRespETag {
			// Cached.
			responseCode = http.StatusNotModified
		} else {
			responseBytes = []byte(textResp)
			responseContentType = textPlain
			responseCode = http.StatusOK
		}
		responseContentLength = len(responseBytes)

	case "https://lists.example.org/baddies.json":
		extraHeaders = map[string]string{
			"Last-Modified": lastModified,
			"ETag":          jsonRespETag,
		}
		if req.Header.Get("If-None-Match") == jsonRespETag {
			// Cached.
			responseCode = http.StatusNotModified
		} else {
			responseBytes = []byte(jsonResp)
			responseContentType = applicationJSON
			responseCode = http.StatusOK
		}
		responseContentLength = len(responseBytes)

	case "https://lists.example.org/baddies.csv?future=true":
		extraHeaders = map[string]string{
			// Provide the future last modified value.
			"Last-Modified": futureLastModified,
			"ETag":          csvRespETag,
		}
		if req.Header.Get("If-None-Match") == csvRespETag {
			// Cached.
			responseCode = http.StatusNotModified
		} else {
			responseBytes = []byte(csvResp)
			responseContentType = textCSV
			responseCode = http.StatusOK
		}
		responseContentLength = len(responseBytes)

	case "https://lists.example.org/baddies.csv?garbage=true":
		extraHeaders = map[string]string{
			// Provide the garbage last modified value.
			"Last-Modified": garbageLastModified,
			"ETag":          csvRespETag,
		}
		if req.Header.Get("If-None-Match") == csvRespETag {
			// Cached.
			responseCode = http.StatusNotModified
		} else {
			responseBytes = []byte(csvResp)
			responseContentType = textCSV
			responseCode = http.StatusOK
		}
		responseContentLength = len(responseBytes)

	default:
		responseCode = http.StatusNotFound
		responseBytes = []byte(`{"error":"not found"}`)
		responseContentType = applicationJSON
		responseContentLength = len(responseBytes)
	}

	return
}