-
Notifications
You must be signed in to change notification settings - Fork 0
/
updaters_test.go
502 lines (388 loc) · 16.6 KB
/
updaters_test.go
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
package format
import (
"bufio"
"bytes"
msbtest "code.google.com/p/mike-bland/go/testing"
"os"
"os/exec"
"strings"
"testing"
)
func checkUpdate(expected_msg, expected_result, original string,
updaters []Updater, t *testing.T) {
b := new(bytes.Buffer)
output := bufio.NewWriter(b)
msg := UpdatePost(updaters,
bufio.NewReader(strings.NewReader(original)),
output)
output.Flush()
result := b.String()
if result != expected_result {
t.Errorf("%s: updated blog text does not match "+
"expectation:\nexpected:\n%s\n--------\nactual:\n%s",
msbtest.FileAndLine(), expected_result, result)
}
if msg != expected_msg {
t.Errorf("%s: blog update message does not match "+
"expectation:\nexpected:\n%s\n--------\nactual:\n%s",
msbtest.FileAndLine(), expected_msg, msg)
}
}
func TestFootnoteUpdaterEmptyPost(t *testing.T) {
checkUpdate("", "", "", []Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterNothingToUpdate(t *testing.T) {
checkUpdate("",
"nothing to update here\n",
"nothing to update here\n",
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterExpandNewFootnote(t *testing.T) {
const original = `A new footnote to expand.[#test-doc: New note.]
<div class="footnote">
</div>
`
const expected = `A new footnote to expand.["(#test-doc-r1). ^1^":#test-doc-1]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]New note.
</div>
`
checkUpdate("1 new footnote", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterNewNoteAfterExisting(t *testing.T) {
const original = `Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1] A new footnote to expand.[#test-doc: New note.]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Existing note.
</div>
`
const expected = `Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1] A new footnote to expand.["(#test-doc-r2). ^2^":#test-doc-2]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Existing note.
["(#test-doc-2). ^2^":#test-doc-r2]New note.
</div>
`
checkUpdate("1 new footnote", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterNewNoteBeforeExisting(t *testing.T) {
const original = `A new footnote to expand.[#test-doc: New note.] Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Existing note.
</div>
`
const expected = `A new footnote to expand.["(#test-doc-r1). ^1^":#test-doc-1] Existing footnote.["(#test-doc-r2). ^2^":#test-doc-2]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]New note.
["(#test-doc-2). ^2^":#test-doc-r2]Existing note.
</div>
`
checkUpdate("1 new footnote", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterNewNoteBetweenExisting(t *testing.T) {
const original = `Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1] A new footnote to expand.[#test-doc: New note.] Existing footnote.["(#test-doc-r2). ^2^":#test-doc-2]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First existing note.
["(#test-doc-2). ^2^":#test-doc-r2]Second existing note.
</div>
`
const expected = `Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1] A new footnote to expand.["(#test-doc-r2). ^2^":#test-doc-2] Existing footnote.["(#test-doc-r3). ^3^":#test-doc-3]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First existing note.
["(#test-doc-2). ^2^":#test-doc-r2]New note.
["(#test-doc-3). ^3^":#test-doc-r3]Second existing note.
</div>
`
checkUpdate("1 new footnote", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterExistingNoteBetweenNew(t *testing.T) {
const original = `A new footnote to expand.[#test-doc: First new note.] Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1] A new footnote to expand.[#test-doc: Second new note.] Existing footnote.["(#test-doc-r2). ^2^":#test-doc-2]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First existing note.
["(#test-doc-2). ^2^":#test-doc-r2]Second existing note.
</div>
`
const expected = `A new footnote to expand.["(#test-doc-r1). ^1^":#test-doc-1] Existing footnote.["(#test-doc-r2). ^2^":#test-doc-2] A new footnote to expand.["(#test-doc-r3). ^3^":#test-doc-3] Existing footnote.["(#test-doc-r4). ^4^":#test-doc-4]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First new note.
["(#test-doc-2). ^2^":#test-doc-r2]First existing note.
["(#test-doc-3). ^3^":#test-doc-r3]Second new note.
["(#test-doc-4). ^4^":#test-doc-r4]Second existing note.
</div>
`
checkUpdate("2 new footnotes", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterThreeNewNotesInARow(t *testing.T) {
const original = `A new footnote to expand.[#test-doc: First new note.] A new footnote to expand.[#test-doc: Second new note.] A new footnote to expand.[#test-doc: Third new note.] Existing footnote.["(#test-doc-r1). ^1^":#test-doc-1]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Existing note.
</div>
`
const expected = `A new footnote to expand.["(#test-doc-r1). ^1^":#test-doc-1] A new footnote to expand.["(#test-doc-r2). ^2^":#test-doc-2] A new footnote to expand.["(#test-doc-r3). ^3^":#test-doc-3] Existing footnote.["(#test-doc-r4). ^4^":#test-doc-4]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First new note.
["(#test-doc-2). ^2^":#test-doc-r2]Second new note.
["(#test-doc-3). ^3^":#test-doc-r3]Third new note.
["(#test-doc-4). ^4^":#test-doc-r4]Existing note.
</div>
`
checkUpdate("3 new footnotes", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterReorderExistingFootnotes(t *testing.T) {
const original = `These two footnotes have been reordered.["(#test-doc-r2). ^2^":#test-doc-2] This may happen during editing.["(#test-doc-r1). ^1^":#test-doc-1]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Original first note.
["(#test-doc-2). ^2^":#test-doc-r2]Original second note.
</div>
`
const expected = `These two footnotes have been reordered.["(#test-doc-r1). ^1^":#test-doc-1] This may happen during editing.["(#test-doc-r2). ^2^":#test-doc-2]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Original second note.
["(#test-doc-2). ^2^":#test-doc-r2]Original first note.
</div>
`
checkUpdate("existing footnotes reordered", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterReorderExistingFootnotesWithNewFootnotes(t *testing.T) {
const original = `This is a new note.[#test-doc: First new note.] These two footnotes have been reordered.["(#test-doc-r2). ^2^":#test-doc-2] Here's another new note.[#test-doc: Second new note.] This may happen during editing.["(#test-doc-r1). ^1^":#test-doc-1] One more new note.[#test-doc: Third new note.]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]Original first note.
["(#test-doc-2). ^2^":#test-doc-r2]Original second note.
</div>
`
const expected = `This is a new note.["(#test-doc-r1). ^1^":#test-doc-1] These two footnotes have been reordered.["(#test-doc-r2). ^2^":#test-doc-2] Here's another new note.["(#test-doc-r3). ^3^":#test-doc-3] This may happen during editing.["(#test-doc-r4). ^4^":#test-doc-4] One more new note.["(#test-doc-r5). ^5^":#test-doc-5]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First new note.
["(#test-doc-2). ^2^":#test-doc-r2]Original second note.
["(#test-doc-3). ^3^":#test-doc-r3]Second new note.
["(#test-doc-4). ^4^":#test-doc-r4]Original first note.
["(#test-doc-5). ^5^":#test-doc-r5]Third new note.
</div>
`
checkUpdate("3 new footnotes, existing footnotes reordered", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterTenExistingFootnotesNoChange(t *testing.T) {
// This makes sure that the order of existing footnotes is not
// misreported as having changed, since ["1", ..., "10"] will be
// reported as unsorted.
const original = `First.["(#test-doc-r1). ^1^":#test-doc-1] Second.["(#test-doc-r2). ^2^":#test-doc-2] Third.["(#test-doc-r3). ^3^":#test-doc-3]
Fourth.["(#test-doc-r4). ^4^":#test-doc-4] Fifth.["(#test-doc-r5). ^5^":#test-doc-5] Sixth.["(#test-doc-r6). ^6^":#test-doc-6]
Seventh.["(#test-doc-r7). ^7^":#test-doc-7] Eighth.["(#test-doc-r8). ^8^":#test-doc-8] Ninth.["(#test-doc-r9). ^9^":#test-doc-9]
Tenth.["(#test-doc-r10). ^10^":#test-doc-10]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]First note.
["(#test-doc-2). ^2^":#test-doc-r2]Second note.
["(#test-doc-3). ^3^":#test-doc-r3]Third note.
["(#test-doc-4). ^4^":#test-doc-r4]Fourth note.
["(#test-doc-5). ^5^":#test-doc-r5]Fifth note.
["(#test-doc-6). ^6^":#test-doc-r6]Sixth note.
["(#test-doc-7). ^7^":#test-doc-r7]Seventh note.
["(#test-doc-8). ^8^":#test-doc-r8]Eighth note.
["(#test-doc-9). ^9^":#test-doc-r9]Ninth note.
["(#test-doc-10). ^10^":#test-doc-r10]Tenth note.
</div>
`
checkUpdate("", original, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFootnoteUpdaterExtraParagraphsInAnExistingFootnoteArePreserved(t *testing.T) {
const original = `This existing reference's text should be preserved.["(#test-doc-r1). ^1^":#test-doc-1]
<div class="footnote">
["(#test-doc-1). ^1^":#test-doc-r1]This is the first line of the first note.
Shouldn't matter how many lines it has.
bq.. Even if it appears as a blockquote or something.
A multiple line blockquote.
p. They should all be preserved.
</div>
`
checkUpdate("", original, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFoonoteUpdaterTitleHasNumbers(t *testing.T) {
const original = `Some text.[#test-2012: This footnote title has numbers.]
<div class="footnote">
</div>
`
const expected = `Some text.["(#test-2012-r1). ^1^":#test-2012-1]
<div class="footnote">
["(#test-2012-1). ^1^":#test-2012-r1]This footnote title has numbers.
</div>
`
checkUpdate("1 new footnote", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestFoonoteUpdaterFootnoteHasBracketedLink(t *testing.T) {
const original = `Some text.[#test-2012: This footnote title has ["a link in brackets":http://example.com/].]
<div class="footnote">
</div>
`
const expected = `Some text.["(#test-2012-r1). ^1^":#test-2012-1]
<div class="footnote">
["(#test-2012-1). ^1^":#test-2012-r1]This footnote title has ["a link in brackets":http://example.com/].
</div>
`
checkUpdate("1 new footnote", expected, original,
[]Updater{NewFootnoteUpdater()}, t)
}
func TestTableOfContentsUpdaterEmptyPost(t *testing.T) {
checkUpdate("", "", "", []Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterNothingToUpdate(t *testing.T) {
checkUpdate("",
"nothing to update here\n",
"nothing to update here\n",
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterFirstNewHeadline(t *testing.T) {
const original = `p(toc).
h3(section#test-doc-first). First Headline
`
const expected = `p(toc). "First Headline":#test-doc-first
h3(section#test-doc-first). First Headline
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterChangeExistingHeadlines(t *testing.T) {
const original = `p(toc). "Old Headline":#test-doc-old
h3(section#test-doc-new). New Headline
`
const expected = `p(toc). "New Headline":#test-doc-new
h3(section#test-doc-new). New Headline
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterReorderExistingHeadlines(t *testing.T) {
const original = `p(toc). "Headline C":#test-doc-c
"Headline A":#test-doc-a
"Headline B":#test-doc-b
h3(section#test-doc-a). Headline A
h3(section#test-doc-b). Headline B
h3(section#test-doc-c). Headline C
`
const expected = `p(toc). "Headline A":#test-doc-a
"Headline B":#test-doc-b
"Headline C":#test-doc-c
h3(section#test-doc-a). Headline A
h3(section#test-doc-b). Headline B
h3(section#test-doc-c). Headline C
`
checkUpdate("existing headlines reordered", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterHeadlineIsLink(t *testing.T) {
const original = `p(toc).
h3(section#test-doc-headline-is-link). "Headline Is Link":http://www.example.com/
`
const expected = `p(toc). "Headline Is Link":#test-doc-headline-is-link
h3(section#test-doc-headline-is-link). "Headline Is Link":http://www.example.com/
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterHeadlineWithLinkEmbedded(t *testing.T) {
const original = `p(toc).
h3(section#test-doc-headline-with-link-embedded). Headline With "Link":http://www.example.com/ Embedded
`
const expected = `p(toc). "Headline With Link Embedded":#test-doc-headline-with-link-embedded
h3(section#test-doc-headline-with-link-embedded). Headline With "Link":http://www.example.com/ Embedded
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterHeadlineWithFootnote(t *testing.T) {
const original = `p(toc).
h3(section#test-doc-headline-with-footnote). Headline With Footnote["(#test-doc-r1). ^1^":#test-doc-1]
`
const expected = `p(toc). "Headline With Footnote":#test-doc-headline-with-footnote
h3(section#test-doc-headline-with-footnote). Headline With Footnote["(#test-doc-r1). ^1^":#test-doc-1]
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterHeadlineWithNewFootnote(t *testing.T) {
const original = `p(toc).
h3(section#test-doc-headline-with-new-footnote). Headline With New Footnote[#test-doc: It shouldn't matter which order the parsers are run in for this to work]
`
const expected = `p(toc). "Headline With New Footnote":#test-doc-headline-with-new-footnote
h3(section#test-doc-headline-with-new-footnote). Headline With New Footnote[#test-doc: It shouldn't matter which order the parsers are run in for this to work]
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterHeadlineIsLinkWithFootnote(t *testing.T) {
const original = `p(toc).
h3(section#test-doc-headline-is-link-with-footnote). ["Headline Is Link With Footnote":http://www.example.com/][#test-doc: New note.]
`
const expected = `p(toc). "Headline Is Link With Footnote":#test-doc-headline-is-link-with-footnote
h3(section#test-doc-headline-is-link-with-footnote). ["Headline Is Link With Footnote":http://www.example.com/][#test-doc: New note.]
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestTableOfContentsUpdaterHeadlineWithLinkEmbeddedWithFootnote(
t *testing.T) {
const original = `p(toc).
h3(section#test-doc-headline-with-link-embedded-with-footnote). Headline With ["Link":http://www.example.com/] Embedded With Footnote[#test-doc: Brackets around link for extra security, and parsing drama.]
`
const expected = `p(toc). "Headline With Link Embedded With Footnote":#test-doc-headline-with-link-embedded-with-footnote
h3(section#test-doc-headline-with-link-embedded-with-footnote). Headline With ["Link":http://www.example.com/] Embedded With Footnote[#test-doc: Brackets around link for extra security, and parsing drama.]
`
checkUpdate("1 new/changed headline", expected, original,
[]Updater{new(TableOfContentsUpdater)}, t)
}
func TestGoldenFile(t *testing.T) {
testdata_dir := msbtest.TestFileDir() + "/testdata/"
original_name := testdata_dir + "updates-test.textile"
original, orig_err := os.Open(original_name)
if orig_err != nil {
t.Fatalf("failed to open original file: %s: %s",
original_name, orig_err)
}
result_name := os.TempDir() + "updates-test-result.textile"
result, result_err := os.Create(result_name)
if result_err != nil {
t.Fatalf("failed to open output file: %s: %s",
result_name, result_err)
}
defer func() {
if t.Failed() {
return
}
remove_err := os.Remove(result_name)
if remove_err != nil {
t.Errorf("could not remove output file: %s",
result_name)
}
}()
msg := UpdatePost(
[]Updater{
NewFootnoteUpdater(),
new(TableOfContentsUpdater),
},
bufio.NewReader(original), result)
expected_msg := "8 new footnotes, existing footnotes reordered; " +
"2 new/changed headlines, existing headlines reordered"
if msg != expected_msg {
t.Errorf("result message does not match:\n"+
"expected: %s\n"+"actual: %s\n",
expected_msg, msg)
}
golden_name := testdata_dir + "updates-test-golden.textile"
diff_cmd := exec.Command("/usr/bin/diff", golden_name, result_name)
var diff_out bytes.Buffer
diff_cmd.Stdout = &diff_out
diff_err := diff_cmd.Run()
if diff_err != nil {
t.Fatalf("diff failed: %s\n%s\nto reproduce: %s",
diff_err, diff_out.String(),
strings.Join(diff_cmd.Args, " "))
}
}