-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathslides.html
2119 lines (2054 loc) · 125 KB
/
slides.html
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
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en"><head>
<script src="slides_files/libs/clipboard/clipboard.min.js"></script>
<script src="slides_files/libs/quarto-html/tabby.min.js"></script>
<script src="slides_files/libs/quarto-html/popper.min.js"></script>
<script src="slides_files/libs/quarto-html/tippy.umd.min.js"></script>
<link href="slides_files/libs/quarto-html/tippy.css" rel="stylesheet">
<link href="slides_files/libs/quarto-html/light-border.css" rel="stylesheet">
<link href="slides_files/libs/quarto-html/quarto-syntax-highlighting-66ab7fd5e73b7f0a764e0d49b3e29ab1.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<link href="slides_files/libs/quarto-contrib/fontawesome6-1.2.0/all.min.css" rel="stylesheet">
<link href="slides_files/libs/quarto-contrib/fontawesome6-1.2.0/latex-fontsize.css" rel="stylesheet"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta name="generator" content="quarto-1.7.13">
<meta name="author" content="Indrajeet Patil">
<meta name="dcterms.date" content="2025-01-26 01:02:33.444844">
<meta name="keywords" content="snapshot testing, testthat, shinytest2, vdiffr, r programming">
<title>Introduction to Snapshot Testing in R</title>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
<link rel="stylesheet" href="slides_files/libs/revealjs/dist/reset.css">
<link rel="stylesheet" href="slides_files/libs/revealjs/dist/reveal.css">
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
/* CSS for syntax highlighting */
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ color: #003b4f; background-color: #f1f3f5; }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span { color: #003b4f; } /* Normal */
code span.al { color: #ad0000; } /* Alert */
code span.an { color: #5e5e5e; } /* Annotation */
code span.at { color: #657422; } /* Attribute */
code span.bn { color: #ad0000; } /* BaseN */
code span.bu { } /* BuiltIn */
code span.cf { color: #003b4f; font-weight: bold; } /* ControlFlow */
code span.ch { color: #20794d; } /* Char */
code span.cn { color: #8f5902; } /* Constant */
code span.co { color: #5e5e5e; } /* Comment */
code span.cv { color: #5e5e5e; font-style: italic; } /* CommentVar */
code span.do { color: #5e5e5e; font-style: italic; } /* Documentation */
code span.dt { color: #ad0000; } /* DataType */
code span.dv { color: #ad0000; } /* DecVal */
code span.er { color: #ad0000; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #ad0000; } /* Float */
code span.fu { color: #4758ab; } /* Function */
code span.im { color: #00769e; } /* Import */
code span.in { color: #5e5e5e; } /* Information */
code span.kw { color: #003b4f; font-weight: bold; } /* Keyword */
code span.op { color: #5e5e5e; } /* Operator */
code span.ot { color: #003b4f; } /* Other */
code span.pp { color: #ad0000; } /* Preprocessor */
code span.sc { color: #5e5e5e; } /* SpecialChar */
code span.ss { color: #20794d; } /* SpecialString */
code span.st { color: #20794d; } /* String */
code span.va { color: #111111; } /* Variable */
code span.vs { color: #20794d; } /* VerbatimString */
code span.wa { color: #5e5e5e; font-style: italic; } /* Warning */
</style>
<link rel="stylesheet" href="slides_files/libs/revealjs/dist/theme/quarto-423d414d36ce366a9d05f36d06304417.css">
<link rel="stylesheet" href="style.css">
<link href="slides_files/libs/revealjs/plugin/quarto-line-highlight/line-highlight.css" rel="stylesheet">
<link href="slides_files/libs/revealjs/plugin/reveal-menu/menu.css" rel="stylesheet">
<link href="slides_files/libs/revealjs/plugin/reveal-menu/quarto-menu.css" rel="stylesheet">
<link href="slides_files/libs/revealjs/plugin/quarto-support/footer.css" rel="stylesheet">
<style type="text/css">
.reveal div.sourceCode {
margin: 0;
overflow: auto;
}
.reveal div.hanging-indent {
margin-left: 1em;
text-indent: -1em;
}
.reveal .slide:not(.center) {
height: 100%;
}
.reveal .slide.scrollable {
overflow-y: auto;
}
.reveal .footnotes {
height: 100%;
overflow-y: auto;
}
.reveal .slide .absolute {
position: absolute;
display: block;
}
.reveal .footnotes ol {
counter-reset: ol;
list-style-type: none;
margin-left: 0;
}
.reveal .footnotes ol li:before {
counter-increment: ol;
content: counter(ol) ". ";
}
.reveal .footnotes ol li > p:first-child {
display: inline-block;
}
.reveal .slide ul,
.reveal .slide ol {
margin-bottom: 0.5em;
}
.reveal .slide ul li,
.reveal .slide ol li {
margin-top: 0.4em;
margin-bottom: 0.2em;
}
.reveal .slide ul[role="tablist"] li {
margin-bottom: 0;
}
.reveal .slide ul li > *:first-child,
.reveal .slide ol li > *:first-child {
margin-block-start: 0;
}
.reveal .slide ul li > *:last-child,
.reveal .slide ol li > *:last-child {
margin-block-end: 0;
}
.reveal .slide .columns:nth-child(3) {
margin-block-start: 0.8em;
}
.reveal blockquote {
box-shadow: none;
}
.reveal .tippy-content>* {
margin-top: 0.2em;
margin-bottom: 0.7em;
}
.reveal .tippy-content>*:last-child {
margin-bottom: 0.2em;
}
.reveal .slide > img.stretch.quarto-figure-center,
.reveal .slide > img.r-stretch.quarto-figure-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.reveal .slide > img.stretch.quarto-figure-left,
.reveal .slide > img.r-stretch.quarto-figure-left {
display: block;
margin-left: 0;
margin-right: auto;
}
.reveal .slide > img.stretch.quarto-figure-right,
.reveal .slide > img.r-stretch.quarto-figure-right {
display: block;
margin-left: auto;
margin-right: 0;
}
</style>
</head>
<body class="quarto-light">
<div class="reveal">
<div class="slides">
<section id="introduction-to-snapshot-testing-in-r" class="slide level2" style="margin-top: 1em;"><h2>Introduction to Snapshot Testing in R</h2>
<!-- Don't render this file manually. Run `renderer.R` script instead. -->
<!-- Need to install extension from https://github.com/quarto-ext/fontawesome -->
<!-- Run `quarto install extension quarto-ext/fontawesome` in terminal -->
<div style="margin-top: 0.5em; margin-bottom: 0.5em; font-size: 1em">
<p>Indrajeet Patil</p>
</div>
<div style="margin-top: 1em; font-size:0.75em">
<p><img data-src="media/logos_combined.jpeg" class="absolute" style="width: 750px; height: 300px; "></p>
</div>
</section><section id="unit-testing" class="slide level2 smaller"><h2>Unit testing</h2>
<p>The goal of a unit test is to capture the <em>expected</em> output of a function using <em>code</em> and making sure that <em>actual</em> output after any changes matches the expected output.</p>
<p><a href="https://testthat.r-lib.org/"><code>{testthat}</code></a> is a popular framework for writing unit tests in R.</p>
<div class="columns">
<div class="column" style="width:60%;">
<div class="callout callout-important callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Benefits of unit testing</strong></p>
</div>
<div class="callout-content">
<ul>
<li>insures against unintentionally changing function behaviour</li>
<li>prevents re-introducing already fixed bugs</li>
<li>acts as the most basic form of developer-focused documentation</li>
<li>catches breaking changes coming from upstream dependencies</li>
<li>etc.</li>
</ul>
</div>
</div>
</div>
</div><div class="column" style="width:40%;">
<div class="callout callout-tip callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Test output</strong></p>
</div>
<div class="callout-content">
<p>Test pass only when actual function behaviour matches expected.</p>
<table class="caption-top">
<colgroup>
<col style="width: 32%">
<col style="width: 32%">
<col style="width: 34%">
</colgroup>
<thead><tr class="header">
<th style="text-align: left;">actual</th>
<th style="text-align: left;">expected</th>
<th style="text-align: left;">tests</th>
</tr></thead>
<tbody>
<tr class="odd">
<td style="text-align: left;"><p><i class="fa-regular fa-file-lines fa-2xl" aria-label="file-lines"></i></p></td>
<td style="text-align: left;"><p><i class="fa-regular fa-file-lines fa-2xl" aria-label="file-lines"></i></p></td>
<td style="text-align: left;"><p><i class="fa-regular fa-circle-check fa-2xl" aria-label="circle-check"></i></p></td>
</tr>
<tr class="even">
<td style="text-align: left;"><p><i class="fa-regular fa-file fa-2xl" aria-label="file"></i></p></td>
<td style="text-align: left;"><p><i class="fa-regular fa-file-lines fa-2xl" aria-label="file-lines"></i></p></td>
<td style="text-align: left;"><p><i class="fa-regular fa-circle-xmark fa-2xl" aria-label="circle-xmark"></i></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div></div>
</section><section id="unit-testing-with-testthat-a-recap" class="slide level2 smaller"><h2>Unit testing with <code>{testthat}</code>: A recap</h2>
<div class="columns">
<div class="column" style="width:50%;">
<div class="callout callout-important callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Test organization</strong></p>
</div>
<div class="callout-content">
<p>Testing infrastructure for R package has the following hierarchy:</p>
<table class="caption-top">
<colgroup>
<col style="width: 44%">
<col style="width: 55%">
</colgroup>
<thead><tr class="header">
<th style="text-align: left;">Component</th>
<th style="text-align: left;">Role</th>
</tr></thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">
<br><i class="fa-regular fa-file-code fa-2xl" aria-label="file-code"></i> <strong>Test file</strong>
</td>
<td style="text-align: left;">Tests for <code>R/foo.R</code> will typically be in <code>tests/testthat/test-foo.R</code>.</td>
</tr>
<tr class="even">
<td style="text-align: left;">
<i class="fa-solid fa-flask fa-2xl" aria-label="flask"></i> <strong>Tests</strong>
</td>
<td style="text-align: left;">A single file can contain multiple tests.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">
<i class="fa-solid fa-equals fa-2xl" aria-label="equals"></i> <strong>Expectations</strong>
</td>
<td style="text-align: left;">A single test can have multiple expectations.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div><div class="column" style="width:50%;">
<div class="callout callout-tip callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Example test file</strong></p>
</div>
<div class="callout-content">
<ul>
<li><p>Every test is a call to <code><a href="https://testthat.r-lib.org/reference/test_that.html">testthat::test_that()</a></code> function.</p></li>
<li><p>Every expectation is represented by <code>testthat::expect_*()</code> function.</p></li>
<li><p>You can generate a test file using <code>usethis::use_test()</code> function.</p></li>
</ul>
<div class="sourceCode" id="cb1"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href=""></a><span class="co"># File: tests/testthat/test-op.R</span></span>
<span id="cb1-2"><a href=""></a></span>
<span id="cb1-3"><a href=""></a><span class="co"># test-1</span></span>
<span id="cb1-4"><a href=""></a><span class="fu">test_that</span>(<span class="st">"multiplication works"</span>, {</span>
<span id="cb1-5"><a href=""></a> <span class="fu">expect_equal</span>(<span class="dv">2</span> <span class="sc">*</span> <span class="dv">2</span>, <span class="dv">4</span>) <span class="co"># expectation-1</span></span>
<span id="cb1-6"><a href=""></a> <span class="fu">expect_equal</span>(<span class="sc">-</span><span class="dv">2</span> <span class="sc">*</span> <span class="dv">2</span>, <span class="sc">-</span><span class="dv">4</span>) <span class="co"># expectation-2</span></span>
<span id="cb1-7"><a href=""></a>})</span>
<span id="cb1-8"><a href=""></a></span>
<span id="cb1-9"><a href=""></a><span class="co"># test-2</span></span>
<span id="cb1-10"><a href=""></a><span class="fu">test_that</span>(<span class="st">"addition works"</span>, {</span>
<span id="cb1-11"><a href=""></a> <span class="fu">expect_equal</span>(<span class="dv">2</span> <span class="sc">+</span> <span class="dv">2</span>, <span class="dv">4</span>) <span class="co"># expectation-1</span></span>
<span id="cb1-12"><a href=""></a> <span class="fu">expect_equal</span>(<span class="sc">-</span><span class="dv">2</span> <span class="sc">+</span> <span class="dv">2</span>, <span class="dv">0</span>) <span class="co"># expectation-2</span></span>
<span id="cb1-13"><a href=""></a>})</span>
<span id="cb1-14"><a href=""></a></span>
<span id="cb1-15"><a href=""></a>...</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div>
</div>
</div></div>
</section><section id="what-is-different-about-snapshot-testing" class="slide level2"><h2>What is different about snapshot testing?</h2>
<div class="fragment">
<p>A <strong>unit test</strong> records the code to describe expected output.</p>
<p><br></p>
<p>(actual) <i class="fa-regular fa-file-code fa-2xl" aria-label="file-code"></i> <i class="fa-solid fa-arrows-left-right fa-2xl" aria-label="arrows-left-right"></i> <i class="fa-solid fa-file-code fa-2xl" aria-label="file-code"></i> (expected)</p>
<p><br></p>
</div>
<div class="fragment">
<p>A <strong>snapshot test</strong> records expected output in a separate, human-readable file.</p>
<p><br></p>
<p>(actual) <i class="fa-regular fa-file-code fa-2xl" aria-label="file-code"></i> <i class="fa-solid fa-arrows-left-right fa-2xl" aria-label="arrows-left-right"></i> <i class="fa-solid fa-file-lines fa-2xl" aria-label="file-lines"></i> (expected)</p>
</div>
</section><section id="why-do-you-need-snapshot-testing" class="slide level2"><h2>Why do you need snapshot testing?</h2>
<p>If you develop R packages and have struggled to</p>
<div>
<ul>
<li class="fragment">test that text output <em>prints</em> as expected</li>
<li class="fragment">test that an entire file <em>is</em> as expected</li>
<li class="fragment">test that generated graphical output <em>looks</em> as expected</li>
<li class="fragment">update such tests <em>en masse</em>
</li>
</ul>
</div>
<div class="fragment">
<p>then you should be excited to know more about <em>snapshot tests</em> (aka <em>golden tests</em>)! 🤩</p>
</div>
</section><section><section id="prerequisites" class="title-slide slide level1 center"><h1>Prerequisites</h1>
<p>Familiarity with writing unit tests using <a href="https://testthat.r-lib.org/index.html" target="_blank"><code>{testthat}</code></a>.</p>
<p>If not, have a look at <a href="https://r-pkgs.org/testing-basics.html" target="_blank">this</a> chapter from <em>R Packages</em> book.</p>
</section><section id="section" class="slide level2"><h2></h2>
<p><br></p>
<div class="callout callout-important callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong><em>Nota bene</em></strong></p>
</div>
<div class="callout-content">
<p>In the following slides, in all snapshot tests, I include the following line of code:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb2-1"><a href=""></a><span class="fu">local_edition</span>(<span class="dv">3</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p><strong>You don’t need to do this in your package tests!</strong></p>
<p>It’s sufficient to update the <code>DESCRIPTION</code> file to use <a href="https://testthat.r-lib.org">testthat</a> 3rd edition:</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb3-1"><a href=""></a>Config<span class="sc">/</span>testthat<span class="sc">/</span>edition<span class="sc">:</span> <span class="dv">3</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>For more, see <a href="https://testthat.r-lib.org/articles/third-edition.html" target="_blank">this</a> article.</p>
</div>
</div>
</div>
</section></section><section><section id="testing-text-outputs" class="title-slide slide level1 center"><h1>Testing text outputs</h1>
<p>Snapshot tests can be used to test that text output <em>prints</em> as expected.</p>
<p>Important for testing functions that pretty-print R objects to the console, create elegant and informative exceptions, etc.</p>
</section><section id="example-function" class="slide level2 smaller"><h2>Example function</h2>
<p>Let’s say you want to write a unit test for the following function:</p>
<div class="columns">
<div class="column" style="width:60%;">
<p><strong>Source code</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb4"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb4-1"><a href=""></a>print_movies <span class="ot"><-</span> <span class="cf">function</span>(keys, values) {</span>
<span id="cb4-2"><a href=""></a> <span class="fu">paste0</span>(</span>
<span id="cb4-3"><a href=""></a> <span class="st">"Movie: </span><span class="sc">\n</span><span class="st">"</span>,</span>
<span id="cb4-4"><a href=""></a> <span class="fu">paste0</span>(<span class="st">" "</span>, keys, <span class="st">": "</span>, values, <span class="at">collapse =</span> <span class="st">"</span><span class="sc">\n</span><span class="st">"</span>)</span>
<span id="cb4-5"><a href=""></a> )</span>
<span id="cb4-6"><a href=""></a>}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div><div class="column" style="width:40%;">
<p><strong>Output</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb5-1"><a href=""></a><span class="fu">cat</span>(<span class="fu">print_movies</span>(</span>
<span id="cb5-2"><a href=""></a> <span class="fu">c</span>(<span class="st">"Title"</span>, <span class="st">"Director"</span>),</span>
<span id="cb5-3"><a href=""></a> <span class="fu">c</span>(<span class="st">"Salaam Bombay!"</span>, <span class="st">"Mira Nair"</span>)</span>
<span id="cb5-4"><a href=""></a>))</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>Movie:
Title: Salaam Bombay!
Director: Mira Nair</code></pre>
</div>
</div>
</div></div>
<div class="fragment">
<p><br></p>
<p>Note that you want to test that the printed output <em>looks</em> as expected.</p>
<p>Therefore, you need to check for all the little bells and whistles in the printed output.</p>
</div>
</section><section id="example-test" class="slide level2 smaller"><h2>Example test</h2>
<p>Even testing this simple function is a bit painful because you need to keep track of every escape character, every space, etc.</p>
<div class="cell">
<div class="sourceCode cell-code" id="cb7"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb7-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`print_movies()` prints as expected"</span>, {</span>
<span id="cb7-2"><a href=""></a> <span class="fu">expect_equal</span>(</span>
<span id="cb7-3"><a href=""></a> <span class="fu">print_movies</span>(</span>
<span id="cb7-4"><a href=""></a> <span class="fu">c</span>(<span class="st">"Title"</span>, <span class="st">"Director"</span>),</span>
<span id="cb7-5"><a href=""></a> <span class="fu">c</span>(<span class="st">"Salaam Bombay!"</span>, <span class="st">"Mira Nair"</span>)</span>
<span id="cb7-6"><a href=""></a> ),</span>
<span id="cb7-7"><a href=""></a> <span class="st">"Movie: </span><span class="sc">\n</span><span class="st"> Title: Salaam Bombay!</span><span class="sc">\n</span><span class="st"> Director: Mira Nair"</span></span>
<span id="cb7-8"><a href=""></a> )</span>
<span id="cb7-9"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>Test passed 🥳</code></pre>
</div>
</div>
<div class="fragment">
<p>With a more complex code, it’d be impossible for a human to reason about what the output is supposed to look like.</p>
</div>
<div class="fragment">
<div class="callout callout-important callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Important</strong></p>
</div>
<div class="callout-content">
<p>If this is a utility function used by many other functions, changing its behaviour would entail <em>manually</em> changing expected outputs for many tests.</p>
<p>This is not maintainable! 😩</p>
</div>
</div>
</div>
</div>
</section><section id="alternative-snapshot-test" class="slide level2 smaller"><h2>Alternative: Snapshot test</h2>
<p>Instead, you can use <code>expect_snapshot()</code>, which, when run for the first time, generates a Markdown file with expected/reference output.</p>
<div class="cell">
<div class="sourceCode cell-code" id="cb9"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb9-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`print_movies()` prints as expected"</span>, {</span>
<span id="cb9-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb9-3"><a href=""></a> <span class="fu">expect_snapshot</span>(<span class="fu">cat</span>(<span class="fu">print_movies</span>(</span>
<span id="cb9-4"><a href=""></a> <span class="fu">c</span>(<span class="st">"Title"</span>, <span class="st">"Director"</span>),</span>
<span id="cb9-5"><a href=""></a> <span class="fu">c</span>(<span class="st">"Salaam Bombay!"</span>, <span class="st">"Mira Nair"</span>)</span>
<span id="cb9-6"><a href=""></a> )))</span>
<span id="cb9-7"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: `print_movies()` prints as expected ────────────────────────────────
Adding new snapshot:
Code
cat(print_movies(c("Title", "Director"), c("Salaam Bombay!", "Mira Nair")))
Output
Movie:
Title: Salaam Bombay!
Director: Mira Nair</code></pre>
</div>
</div>
<div class="fragment">
<div class="callout callout-warning callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Warning</strong></p>
</div>
<div class="callout-content">
<p>The first time a snapshot is created, it becomes <em>the truth</em> against which future function behaviour will be compared.</p>
<p>Thus, it is <strong>crucial</strong> that you carefully check that the output is indeed as expected. 🔎</p>
</div>
</div>
</div>
</div>
</section><section id="human-readable-markdown-file" class="slide level2 smaller"><h2>Human-readable Markdown file</h2>
<p>Compared to your unit test code representing the expected output</p>
<div class="sourceCode" id="cb11"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb11-1"><a href=""></a><span class="st">"Movie: </span><span class="sc">\n</span><span class="st"> Title: Salaam Bombay!</span><span class="sc">\n</span><span class="st"> Director: Mira Nair"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>notice how much more human-friendly the Markdown output is!</p>
<div class="sourceCode" id="cb12"><pre class="sourceCode numberSource md number-lines code-with-copy"><code class="sourceCode markdown"><span id="cb12-1"><a href=""></a>Code</span>
<span id="cb12-2"><a href=""></a> cat(print_movies(c("Title", "Director"), c("Salaam Bombay!", "Mira Nair")))</span>
<span id="cb12-3"><a href=""></a>Output</span>
<span id="cb12-4"><a href=""></a> Movie: </span>
<span id="cb12-5"><a href=""></a> Title: Salaam Bombay!</span>
<span id="cb12-6"><a href=""></a> Director: Mira Nair</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>It is easy to <em>see</em> what the printed text output is <em>supposed</em> to look like. In other words, snapshot tests are useful when the <em>intent</em> of the code can only be verified by a human.</p>
<div class="fragment">
<div class="callout callout-note callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>More about snapshot Markdown files</strong></p>
</div>
<div class="callout-content">
<ul>
<li><p>If test file is called <code>test-foo.R</code>, the snapshot will be saved to <code>test/testthat/_snaps/foo.md</code>.</p></li>
<li><p>If there are multiple snapshot tests in a single file, corresponding snapshots will also share the same <code>.md</code> file.</p></li>
<li><p>By default, <code>expect_snapshot()</code> will capture the code, the object values, and any side-effects.</p></li>
</ul>
</div>
</div>
</div>
</div>
</section><section id="what-test-success-looks-like" class="slide level2 smaller"><h2>What test success looks like</h2>
<p>If you run the test again, it’ll succeed:</p>
<div class="cell">
<div class="sourceCode cell-code" id="cb13"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb13-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`print_movies()` prints as expected"</span>, {</span>
<span id="cb13-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb13-3"><a href=""></a> <span class="fu">expect_snapshot</span>(<span class="fu">cat</span>(<span class="fu">print_movies</span>(</span>
<span id="cb13-4"><a href=""></a> <span class="fu">c</span>(<span class="st">"Title"</span>, <span class="st">"Director"</span>),</span>
<span id="cb13-5"><a href=""></a> <span class="fu">c</span>(<span class="st">"Salaam Bombay!"</span>, <span class="st">"Mira Nair"</span>)</span>
<span id="cb13-6"><a href=""></a> )))</span>
<span id="cb13-7"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>Test passed 🥳</code></pre>
</div>
</div>
<div class="fragment">
<p><br></p>
<div class="callout callout-note callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Why does my test fail on a re-run?</strong></p>
</div>
<div class="callout-content">
<p>If testing a snapshot you just generated fails on re-running the test, this is most likely because your test is not deterministic. For example, if your function deals with random number generation.</p>
<p>In such cases, setting a seed (e.g. <code>set.seed(42)</code>) should help.</p>
</div>
</div>
</div>
</div>
</section><section id="what-test-failure-looks-like" class="slide level2 smaller"><h2>What test failure looks like</h2>
<p>When function changes, snapshot doesn’t match the reference, and the test fails:</p>
<div class="columns">
<div class="column" style="width:35%;">
<p><strong>Changes to function</strong></p>
<div class="sourceCode" id="cb15" data-code-line-numbers="5"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb15-1"><a href=""></a>print_movies <span class="ot"><-</span> <span class="cf">function</span>(keys, values) {</span>
<span id="cb15-2"><a href=""></a> <span class="fu">paste0</span>(</span>
<span id="cb15-3"><a href=""></a> <span class="st">"Movie: </span><span class="sc">\n</span><span class="st">"</span>,</span>
<span id="cb15-4"><a href=""></a> <span class="fu">paste0</span>(</span>
<span id="cb15-5"><a href=""></a> <span class="st">" "</span>, keys, <span class="st">"- "</span>, values,</span>
<span id="cb15-6"><a href=""></a> <span class="at">collapse =</span> <span class="st">"</span><span class="sc">\n</span><span class="st">"</span></span>
<span id="cb15-7"><a href=""></a> )</span>
<span id="cb15-8"><a href=""></a> )</span>
<span id="cb15-9"><a href=""></a>}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p><br></p>
<p>Failure message provides expected (<code>-</code>) vs observed (<code>+</code>) diff.</p>
</div><div class="column" style="width:65%;">
<p><strong>Test failure</strong></p>
<div class="sourceCode" id="cb16"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb16-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`print_movies()` prints as expected"</span>, {</span>
<span id="cb16-2"><a href=""></a> <span class="fu">expect_snapshot</span>(<span class="fu">cat</span>(<span class="fu">print_movies</span>(</span>
<span id="cb16-3"><a href=""></a> <span class="fu">c</span>(<span class="st">"Title"</span>, <span class="st">"Director"</span>),</span>
<span id="cb16-4"><a href=""></a> <span class="fu">c</span>(<span class="st">"Salaam Bombay!"</span>, <span class="st">"Mira Nair"</span>)</span>
<span id="cb16-5"><a href=""></a> )))</span>
<span id="cb16-6"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell">
<div class="cell-output cell-output-stdout">
<pre><code>── Failure: `print_movies()` prints as expected ────────────────────────────────
Snapshot of code has changed:
old[2:6] vs new[2:6]
cat(print_movies(c("Title", "Director"), c("Salaam Bombay!", "Mira Nair")))
Output
Movie:
- Title: Salaam Bombay!
+ Title- Salaam Bombay!
- Director: Mira Nair
+ Director- Mira Nair
* Run `testthat::snapshot_accept('slides.qmd')` to accept the change.
* Run `testthat::snapshot_review('slides.qmd')` to interactively review the change.</code></pre>
</div>
<div class="cell-output cell-output-error">
<pre><code>Error:
! Test failed</code></pre>
</div>
</div>
</div></div>
</section><section id="fixing-tests" class="slide level2 smaller"><h2>Fixing tests</h2>
<p>Message accompanying failed tests make it explicit how to fix them.</p>
<div class="fragment">
<ul>
<li>If the change was <em>deliberate</em>, you can accept the new snapshot as the current <em>truth</em>.</li>
</ul>
<div class="sourceCode" id="cb19"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb19-1"><a href=""></a><span class="sc">*</span> Run <span class="st">`</span><span class="at">snapshot_accept('foo.md')</span><span class="st">`</span> to accept the change</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ul>
<li>If this was <em>unexpected</em>, you can review the changes, and decide whether to change the snapshot or to correct the function behaviour instead.</li>
</ul>
<div class="sourceCode" id="cb20"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb20-1"><a href=""></a><span class="sc">*</span> Run <span class="st">`</span><span class="at">snapshot_review('foo.md')</span><span class="st">`</span> to interactively review the change</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<div class="fragment">
<p><br></p>
<div class="callout callout-tip callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Fixing multiple snapshot tests</strong></p>
</div>
<div class="callout-content">
<p>If this is a utility function used by many other functions, changing its behaviour would lead to failure of many tests.</p>
<p>You can update <em>all</em> new snapshots with <code>snapshot_accept()</code>. And, of course, check the diffs to make sure that the changes are expected.</p>
</div>
</div>
</div>
</div>
</section><section id="capturing-messages-and-warnings" class="slide level2 smaller"><h2>Capturing messages and warnings</h2>
<p>So far you have tested text output printed to the console, but you can also use snapshots to capture messages, warnings, and errors.</p>
<div class="columns">
<div class="column" style="width:50%;">
<p><strong>message</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb21"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb21-1"><a href=""></a>f <span class="ot"><-</span> <span class="cf">function</span>() <span class="fu">message</span>(<span class="st">"Some info for you."</span>)</span>
<span id="cb21-2"><a href=""></a></span>
<span id="cb21-3"><a href=""></a><span class="fu">test_that</span>(<span class="st">"f() messages"</span>, {</span>
<span id="cb21-4"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb21-5"><a href=""></a> <span class="fu">expect_snapshot</span>(<span class="fu">f</span>())</span>
<span id="cb21-6"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: f() messages ───────────────────────────────────────────────────────
Adding new snapshot:
Code
f()
Message
Some info for you.</code></pre>
</div>
</div>
</div><div class="column" style="width:50%;">
<p><strong>warning</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb23"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb23-1"><a href=""></a>g <span class="ot"><-</span> <span class="cf">function</span>() <span class="fu">warning</span>(<span class="st">"Managed to recover."</span>)</span>
<span id="cb23-2"><a href=""></a></span>
<span id="cb23-3"><a href=""></a><span class="fu">test_that</span>(<span class="st">"g() warns"</span>, {</span>
<span id="cb23-4"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb23-5"><a href=""></a> <span class="fu">expect_snapshot</span>(<span class="fu">g</span>())</span>
<span id="cb23-6"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: g() warns ──────────────────────────────────────────────────────────
Adding new snapshot:
Code
g()
Condition
Warning in `g()`:
Managed to recover.</code></pre>
</div>
</div>
</div></div>
<div class="callout callout-tip callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Tip</strong></p>
</div>
<div class="callout-content">
<p>Snapshot records both the <em>condition</em> and the corresponding <em>message</em>.</p>
<p>You can now rest assured that the users are getting informed the way you want! 😌</p>
</div>
</div>
</div>
</section><section id="capturing-errors" class="slide level2 smaller"><h2>Capturing errors</h2>
<p>In case of an error, the function <code>expect_snapshot()</code> itself will produce an error. You have two ways around this:</p>
<div class="columns">
<div class="column" style="width:50%;">
<p><strong>Option-1</strong> (recommended)</p>
<div class="sourceCode" id="cb25" data-code-line-numbers="3"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb25-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`log()` errors"</span>, {</span>
<span id="cb25-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb25-3"><a href=""></a> <span class="fu">expect_snapshot</span>(<span class="fu">log</span>(<span class="st">"x"</span>), <span class="at">error =</span> <span class="cn">TRUE</span>)</span>
<span id="cb25-4"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell">
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: `log()` errors ─────────────────────────────────────────────────────
Adding new snapshot:
Code
log("x")
Condition
Error in `log()`:
! non-numeric argument to mathematical function</code></pre>
</div>
</div>
</div><div class="column" style="width:50%;">
<p><strong>Option-2</strong></p>
<div class="sourceCode" id="cb27" data-code-line-numbers="3"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb27-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`log()` errors"</span>, {</span>
<span id="cb27-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb27-3"><a href=""></a> <span class="fu">expect_snapshot_error</span>(<span class="fu">log</span>(<span class="st">"x"</span>))</span>
<span id="cb27-4"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell">
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: `log()` errors ─────────────────────────────────────────────────────
Adding new snapshot:
non-numeric argument to mathematical function</code></pre>
</div>
</div>
</div></div>
<div class="callout callout-tip callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Which option should I use?</strong></p>
</div>
<div class="callout-content">
<ul>
<li><p>If you want to capture both the code and the error message, use <code>expect_snapshot(..., error = TRUE)</code>.</p></li>
<li><p>If you want to capture only the error message, use <code>expect_snapshot_error()</code>.</p></li>
</ul>
</div>
</div>
</div>
</section><section id="further-reading" class="slide level2 smaller"><h2>Further reading</h2>
<ul>
<li><p><a href="https://testthat.r-lib.org">testthat</a> article on <a href="https://testthat.r-lib.org/articles/snapshotting.html" target="_blank">snapshot testing</a></p></li>
<li><p>Introduction to <a href="https://ro-che.info/articles/2017-12-04-golden-tests" target="_blank">golden testing</a></p></li>
<li><p>Docs for <a href="https://jestjs.io/docs/snapshot-testing" target="_blank">Jest</a> library in JavaScript, which inspired snapshot testing implementation in <a href="https://testthat.r-lib.org">testthat</a></p></li>
</ul></section></section><section><section id="testing-graphical-outputs" class="title-slide slide level1 center"><h1>Testing graphical outputs</h1>
<p>To create graphical expectations, you will use <a href="https://testthat.r-lib.org">testthat</a> extension package: <a href="https://vdiffr.r-lib.org/" target="_blank"><code>{vdiffr}</code></a>.</p>
</section><section id="how-does-vdiffr-work" class="slide level2 smaller"><h2>How does <code>{vdiffr}</code> work?</h2>
<p><a href="https://vdiffr.r-lib.org/">vdiffr</a> introduces <code>expect_doppelganger()</code> to generate <a href="https://testthat.r-lib.org">testthat</a> expectations for graphics. It does this by writing SVG snapshot files for outputs!</p>
<div class="fragment">
<p>The figure to test can be:</p>
<ul>
<li>a <code>ggplot</code> object (from <code><a href="https://ggplot2.tidyverse.org/reference/ggplot.html">ggplot2::ggplot()</a></code>)</li>
<li>a <code>recordedplot</code> object (from <code><a href="https://rdrr.io/r/grDevices/recordplot.html">grDevices::recordPlot()</a></code>)</li>
<li>any object with a <code><a href="https://rdrr.io/r/base/print.html">print()</a></code> method</li>
</ul>
</div>
<div class="fragment">
<div class="callout callout-note callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Note</strong></p>
</div>
<div class="callout-content">
<ul>
<li><p>If test file is called <code>test-foo.R</code>, the snapshot will be saved to <code>test/testthat/_snaps/foo</code> folder.</p></li>
<li><p>In this folder, there will be one <code>.svg</code> file for every test in <code>test-foo.R</code>.</p></li>
<li><p>The name for the <code>.svg</code> file will be sanitized version of <code>title</code> argument to <code>expect_doppelganger()</code>.</p></li>
</ul>
</div>
</div>
</div>
</div>
</section><section id="example-function-1" class="slide level2 smaller"><h2>Example function</h2>
<p>Let’s say you want to write a unit test for the following function:</p>
<div class="columns">
<div class="column" style="width:50%;">
<p><strong>Source code</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb29"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb29-1"><a href=""></a><span class="fu">library</span>(ggplot2)</span>
<span id="cb29-2"><a href=""></a></span>
<span id="cb29-3"><a href=""></a>create_scatter <span class="ot"><-</span> <span class="cf">function</span>() {</span>
<span id="cb29-4"><a href=""></a> <span class="fu">ggplot</span>(mtcars, <span class="fu">aes</span>(wt, mpg)) <span class="sc">+</span></span>
<span id="cb29-5"><a href=""></a> <span class="fu">geom_point</span>(<span class="at">size =</span> <span class="dv">3</span>, <span class="at">alpha =</span> <span class="fl">0.75</span>) <span class="sc">+</span></span>
<span id="cb29-6"><a href=""></a> <span class="fu">geom_smooth</span>(<span class="at">method =</span> <span class="st">"lm"</span>)</span>
<span id="cb29-7"><a href=""></a>}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
</div><div class="column" style="width:50%;">
<p><strong>Output</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb30"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb30-1"><a href=""></a><span class="fu">create_scatter</span>()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output-display">
<div>
<figure><p><img data-src="slides_files/figure-revealjs/unnamed-chunk-17-1.png" style="width:100.0%"></p>
</figure>
</div>
</div>
</div>
</div></div>
<div class="fragment">
<p>Note that you want to test that the graphical output <em>looks</em> as expected, and this expectation is difficult to capture with a unit test.</p>
</div>
</section><section id="graphical-snapshot-test" class="slide level2 smaller"><h2>Graphical snapshot test</h2>
<p>You can use <code>expect_doppelganger()</code> from <a href="https://vdiffr.r-lib.org/">vdiffr</a> to test this!</p>
<div class="fragment">
<p>The <em>first time</em> you run the test, it’d generate an <code>.svg</code> file with expected output.</p>
<div class="cell">
<div class="sourceCode cell-code" id="cb31"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb31-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`create_scatter()` plots as expected"</span>, {</span>
<span id="cb31-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb31-3"><a href=""></a> <span class="fu">expect_doppelganger</span>(</span>
<span id="cb31-4"><a href=""></a> <span class="at">title =</span> <span class="st">"create scatter"</span>,</span>
<span id="cb31-5"><a href=""></a> <span class="at">fig =</span> <span class="fu">create_scatter</span>(),</span>
<span id="cb31-6"><a href=""></a> )</span>
<span id="cb31-7"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: `create_scatter()` plots as expected ───────────────────────────────
Adding new file snapshot: 'tests/testthat/_snaps/create-scatter.svg'</code></pre>
</div>
</div>
</div>
<div class="fragment">
<div class="callout callout-warning callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Warning</strong></p>
</div>
<div class="callout-content">
<p>The first time a snapshot is created, it becomes <em>the truth</em> against which future function behaviour will be compared.</p>
<p>Thus, it is <strong>crucial</strong> that you carefully check that the output is indeed as expected. 🔎</p>
<p>You can open <code>.svg</code> snapshot files in a web browser for closer inspection.</p>
</div>
</div>
</div>
</div>
</section><section id="what-test-success-looks-like-1" class="slide level2 smaller"><h2>What test success looks like</h2>
<p>If you run the test again, it’ll succeed:</p>
<div class="cell">
<div class="sourceCode cell-code" id="cb33"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb33-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`create_scatter()` plots as expected"</span>, {</span>
<span id="cb33-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb33-3"><a href=""></a> <span class="fu">expect_doppelganger</span>(</span>
<span id="cb33-4"><a href=""></a> <span class="at">title =</span> <span class="st">"create scatter"</span>,</span>
<span id="cb33-5"><a href=""></a> <span class="at">fig =</span> <span class="fu">create_scatter</span>(),</span>
<span id="cb33-6"><a href=""></a> )</span>
<span id="cb33-7"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>Test passed 😀</code></pre>
</div>
</div>
</section><section id="what-test-failure-looks-like-1" class="slide level2 smaller"><h2>What test failure looks like</h2>
<p>When function changes, snapshot doesn’t match the reference, and the test fails:</p>
<div class="columns">
<div class="column" style="width:40%;">
<p><strong>Changes to function</strong></p>
<div class="sourceCode" id="cb35" data-code-line-numbers="3"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb35-1"><a href=""></a>create_scatter <span class="ot"><-</span> <span class="cf">function</span>() {</span>
<span id="cb35-2"><a href=""></a> <span class="fu">ggplot</span>(mtcars, <span class="fu">aes</span>(wt, mpg)) <span class="sc">+</span></span>
<span id="cb35-3"><a href=""></a> <span class="fu">geom_point</span>(<span class="at">size =</span> <span class="dv">2</span>, <span class="at">alpha =</span> <span class="fl">0.85</span>) <span class="sc">+</span></span>
<span id="cb35-4"><a href=""></a> <span class="fu">geom_smooth</span>(<span class="at">method =</span> <span class="st">"lm"</span>)</span>
<span id="cb35-5"><a href=""></a>}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div><div class="column" style="width:60%;">
<p><strong>Test failure</strong></p>
<!-- Currently, doesn't work properly with on GHA workflow -->
<!-- The exact error is the following: -->
<!-- Error: Can't find `tests/testthat/` in current directory -->
<div class="sourceCode" id="cb36"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb36-1"><a href=""></a><span class="fu">test_that</span>(<span class="st">"`create_scatter()` plots as expected"</span>, {</span>
<span id="cb36-2"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb36-3"><a href=""></a> <span class="fu">expect_doppelganger</span>(</span>
<span id="cb36-4"><a href=""></a> <span class="at">title =</span> <span class="st">"create scatter"</span>,</span>
<span id="cb36-5"><a href=""></a> <span class="at">fig =</span> <span class="fu">create_scatter</span>(),</span>
<span id="cb36-6"><a href=""></a> )</span>
<span id="cb36-7"><a href=""></a>})</span>
<span id="cb36-8"><a href=""></a></span>
<span id="cb36-9"><a href=""></a>── <span class="fu">Failure</span> (<span class="st">'<text>:3'</span>)<span class="sc">:</span> <span class="st">`</span><span class="at">create_scatter()</span><span class="st">`</span> plots as expected ──────────────────</span>
<span id="cb36-10"><a href=""></a>Snapshot of <span class="st">`</span><span class="at">testcase</span><span class="st">`</span> to <span class="st">'slides.qmd/create-scatter.svg'</span> has changed</span>
<span id="cb36-11"><a href=""></a>Run <span class="st">`</span><span class="at">testthat::snapshot_review('slides.qmd/')</span><span class="st">`</span> to review changes</span>
<span id="cb36-12"><a href=""></a>Backtrace<span class="sc">:</span></span>
<span id="cb36-13"><a href=""></a> <span class="fl">1.</span> vdiffr<span class="sc">::</span><span class="fu">expect_doppelganger</span>(...)</span>
<span id="cb36-14"><a href=""></a> <span class="fl">3.</span> testthat<span class="sc">::</span><span class="fu">expect_snapshot_file</span>(...)</span>
<span id="cb36-15"><a href=""></a>Error <span class="cf">in</span> <span class="st">`</span><span class="at">reporter$stop_if_needed()</span><span class="st">`</span><span class="sc">:</span></span>
<span id="cb36-16"><a href=""></a><span class="sc">!</span> Test failed</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div></div>
</section><section id="fixing-tests-1" class="slide level2 smaller"><h2>Fixing tests</h2>
<p>Running <code>snapshot_review()</code> launches a Shiny app which can be used to either accept or reject the new output(s).</p>
<div class="cell">
<div class="cell-output-display">
<div>
<figure><p><video data-src="media/shiny_app_graphics.mov" style="width:60.0%" controls=""><a href="media/shiny_app_graphics.mov">Video</a></video></p>
</figure>
</div>
</div>
</div>
</section><section id="section-1" class="slide level2"><h2></h2>
<div class="callout callout-tip callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Why are my snapshots for plots failing?! 😔</strong></p>
</div>
<div class="callout-content">
<p>If tests fail even if the function didn’t change, it can be due to any of the following reasons:</p>
<ul>
<li>R’s graphics engine changed</li>
<li>
<a href="https://ggplot2.tidyverse.org">ggplot2</a> itself changed</li>
<li>non-deterministic behaviour</li>
<li>changes in system libraries</li>
</ul>
<p>For these reasons, snapshot tests for plots tend to be fragile and are not run on CRAN machines by default.</p>
</div>
</div>
</div>
</section><section id="further-reading-1" class="slide level2"><h2>Further reading</h2>
<ul>
<li>
<a href="https://vdiffr.r-lib.org/">vdiffr</a> package <a href="https://vdiffr.r-lib.org/" target="_blank">website</a>
</li>
</ul></section></section><section><section id="testing-entire-files" class="title-slide slide level1 center"><h1>Testing entire files</h1>
<p>Whole file snapshot testing makes sure that media, data frames, text files, etc. are as expected.</p>
</section><section id="writing-test" class="slide level2 smaller"><h2>Writing test</h2>
<p>Let’s say you want to test JSON files generated by <code><a href="https://jeroen.r-universe.dev/jsonlite/reference/read_json.html">jsonlite::write_json()</a></code>.</p>
<div class="columns">
<div class="column" style="width:50%;">
<p><strong>Test</strong></p>
<div class="cell">
<div class="sourceCode cell-code" id="cb37"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb37-1"><a href=""></a><span class="co"># File: tests/testthat/test-write-json.R</span></span>
<span id="cb37-2"><a href=""></a><span class="fu">test_that</span>(<span class="st">"json writer works"</span>, {</span>
<span id="cb37-3"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb37-4"><a href=""></a> </span>
<span id="cb37-5"><a href=""></a> r_to_json <span class="ot"><-</span> <span class="cf">function</span>(x) {</span>
<span id="cb37-6"><a href=""></a> path <span class="ot"><-</span> <span class="fu">tempfile</span>(<span class="at">fileext =</span> <span class="st">".json"</span>)</span>
<span id="cb37-7"><a href=""></a> jsonlite<span class="sc">::</span><span class="fu">write_json</span>(x, path)</span>
<span id="cb37-8"><a href=""></a> path</span>
<span id="cb37-9"><a href=""></a> }</span>
<span id="cb37-10"><a href=""></a></span>
<span id="cb37-11"><a href=""></a> x <span class="ot"><-</span> <span class="fu">list</span>(<span class="dv">1</span>, <span class="fu">list</span>(<span class="st">"x"</span> <span class="ot">=</span> <span class="st">"a"</span>))</span>
<span id="cb37-12"><a href=""></a> <span class="fu">expect_snapshot_file</span>(<span class="fu">r_to_json</span>(x), <span class="st">"demo.json"</span>)</span>
<span id="cb37-13"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>── Warning: json writer works ──────────────────────────────────────────────────
Adding new file snapshot: 'tests/testthat/_snaps/demo.json'</code></pre>
</div>
</div>
<p><strong>Snapshot</strong></p>
<div class="sourceCode" id="cb39"><pre class="sourceCode numberSource json number-lines code-with-copy"><code class="sourceCode json"><span id="cb39-1"><a href=""></a><span class="ot">[[</span><span class="dv">1</span><span class="ot">],</span><span class="fu">{</span><span class="dt">"x"</span><span class="fu">:</span><span class="ot">[</span><span class="st">"a"</span><span class="ot">]</span><span class="fu">}</span><span class="ot">]</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div><div class="column" style="width:50%;">
<div class="callout callout-note callout-titled callout-style-default">
<div class="callout-body">
<div class="callout-title">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<p><strong>Note</strong></p>
</div>
<div class="callout-content">
<ul>
<li><p>To snapshot a file, you need to write a helper function that provides its path.</p></li>
<li><p>If a test file is called <code>test-foo.R</code>, the snapshot will be saved to <code>test/testthat/_snaps/foo</code> folder.</p></li>
<li><p>In this folder, there will be one file (e.g. <code>.json</code>) for every <code>expect_snapshot_file()</code> expectation in <code>test-foo.R</code>.</p></li>
<li><p>The name for snapshot file is taken from <code>name</code> argument to <code>expect_snapshot_file()</code>.</p></li>
</ul>
</div>
</div>
</div>
</div></div>
</section><section id="what-test-success-looks-like-2" class="slide level2 smaller"><h2>What test success looks like</h2>
<p>If you run the test again, it’ll succeed:</p>
<div class="cell">
<div class="sourceCode cell-code" id="cb40"><pre class="sourceCode numberSource r number-lines code-with-copy"><code class="sourceCode r"><span id="cb40-1"><a href=""></a><span class="co"># File: tests/testthat/test-write-json.R</span></span>
<span id="cb40-2"><a href=""></a><span class="fu">test_that</span>(<span class="st">"json writer works"</span>, {</span>
<span id="cb40-3"><a href=""></a> <span class="fu">local_edition</span>(<span class="dv">3</span>)</span>
<span id="cb40-4"><a href=""></a> </span>
<span id="cb40-5"><a href=""></a> r_to_json <span class="ot"><-</span> <span class="cf">function</span>(x) {</span>
<span id="cb40-6"><a href=""></a> path <span class="ot"><-</span> <span class="fu">tempfile</span>(<span class="at">fileext =</span> <span class="st">".json"</span>)</span>
<span id="cb40-7"><a href=""></a> jsonlite<span class="sc">::</span><span class="fu">write_json</span>(x, path)</span>
<span id="cb40-8"><a href=""></a> path</span>
<span id="cb40-9"><a href=""></a> }</span>
<span id="cb40-10"><a href=""></a></span>
<span id="cb40-11"><a href=""></a> x <span class="ot"><-</span> <span class="fu">list</span>(<span class="dv">1</span>, <span class="fu">list</span>(<span class="st">"x"</span> <span class="ot">=</span> <span class="st">"a"</span>))</span>
<span id="cb40-12"><a href=""></a> <span class="fu">expect_snapshot_file</span>(<span class="fu">r_to_json</span>(x), <span class="st">"demo.json"</span>)</span>
<span id="cb40-13"><a href=""></a>})</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>Test passed 🎉</code></pre>
</div>
</div>