-
Notifications
You must be signed in to change notification settings - Fork 6
/
tests.xml
2856 lines (2470 loc) · 77.9 KB
/
tests.xml
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
<!--
This file supports testing of RDataTracker (rdt) and rdtLite.
Each test case runs either rdt or rdtLite and compares both its
standard output and the created prov.json file to an expected result.
This comparison ignores differences related to file paths, platform
executed on and timestamps. When all tests are run, the comparison also
ignores elapsed times. Each test case also has separate update targets
that can be used to update the expected results.
To run a test, use:
> ant -file tests.xml <testName>-<rdt|rdtLite>
To update a test, use:
> ant -file tests.xml update-<testName>-<rdt|rdtLite>
For example, to run and update basic test on rdt, use:
> ant -file tests.xml basic-rdt
> ant -file tests.xml update-basic-rdt
When you run a test, it will create serveral files and subdirectories
in either the rdt or rdtLite subdirectory for the test, such as:
test.out - standard output from executing the test
prov_<testName>/prov.json - ddg from executing the test
After a test is run, the .out files and the prov.json files are compared
to expected_ files with the same names. The differences are displayed
on standard output. If the tests work as before, the only differences
you should see are in the execution time. If either test-all-rdt or
test-all-rdtLite target is run, there will be no differences displayed.
If the test results differ from the expected results as reported by the
diff output at the end of the test case run, examine the results. If the
new version is incorrect, you should fix the problem and try again. If
the new version is correct, then you have either fixed a bug or added
an enhancement and should update the expected results. To do that, you
run an update task. Update tasks are only provided for individual tests
to reduce the likelihood that somebody would inadvertently update all the
expected results.
To add a new test case, duplicate one of the existing test and update tasks,
modify the name of the task and the value passed to run-test and update-expected.
This should be the name of the test and the name of the directory it lives in.
It is important that each test script lives in its own directory. The script inside
that directory should have the same name, with .R or .Rmd appended to it.
When you add a new test case, you should also add it to one of the tasks that
group together test cases:
normal-tests - for basic R tests.
source-tests - for tests that use the source function.
script-tests - for real R scripts that are short-running.
bug-tests - tests that trigger a bug.
================================================================================
This target runs a single test independent on rdt or rdtLite:
ProvJson - compares test ddg to the prov-json schema to check for compliance
This is a list of available individual tests.
Please include either -rdt or -rdtLite to run the test (except rdtOnly).
AnnotateOnOff (currently unused)
AssignOperators
basic
CalculateSqrt
Connection
console
ControlConstruct
DailySolarRadiation
DataFunction
DataType
ddgDeepNesting
DDGStatement
DollarOperator
Empty
FileNodes
fromEnv
FunctionAnnotation
FunctionNonlocals
FunctionOrigin
HFDatasetPreview
HigherOrderFunc
NoDetails
NoDevOff
OddParameter
Plot1
Plot2
Plot3
Return
rdtOnly (runs only on rdt)
RMarkdown
S4Object
Scope
SourceFunc
Warning
The target "normal-tests-rdt" will run the following tests using rdt, and
"normal-tests-rdtLite" will run the following tests using rdtLite:
basic
Empty
NoDetails
S4Object
Scope
Return
OddParameter
fromEnv
FunctionAnnotation
FuncctionNonlocals
ControlConstruct
DataFunction
DollarOperator
Warning
Plot1
Plot2
Plot3
FileNodes
NoDevOff
DataType
HigherOrderFunc
AssignOperators
FunctionOrigin
RMarkdown
DDGStatement
Connection
rdtOnly (runs only when rdt is used)
The targets "source-tests-rdt" "source-tests-rdtLite" will run the following:
SourceFunc
console
The targets "bug-tests-rdt" "bug-tests-rdtLite" will run the following:
ddgDeepNesting
The targets "script-tests-rdt" "script-tests-rdtLite" will run the following
short-running real scripts:
CalculateSqrt
DailySolarRadiation
HFDatasetPreview
The targets "test-all-rdt" and "test-all-rdtLite" will run all of the tests above.
These targets will cause the build to fail when there are differences.
================================================================================
NOTE (for Windows users, specifically on Windows 10):
This currently does not work on command-line interfaces such as Command Prompt
that do not have UNIX commands enabled as `diff` is a UNIX command.
Please use a UNIX-commands-enabled shell such as Git Bash and Cygwin.
In Environment Variables, please also set the following:
To the `Path` system variable, please add the following:
- path to the `bin` folder for Apache Ant
- path to the `bin` folder for R
- path to RStudio\bin\pandoc.
- path to the `bin` folder for Java to use DDGExplorer/provViz
Additional System Variables:
- R_LIBS_USER : path to the directory where user libraries are located.
- ANT_HOME : path to Apache Ant (the general directory, not the bin folder)
Please also note that paths that include version numbers in their names
(such as those for R) need to be manually changed when the library is updated.
-->
<project
name="TESTS"
xmlns:if="ant:if"
xmlns:unless="ant:unless"
default="test-all-rdtLite"
>
<!-- ========== Setup ========== -->
<!-- base directory -->
<dirname
property="TESTS.basedir"
file="${ant.file.TESTS}"
/>
<!-- Replace \ (backslashes) with / (forwardslashes) on Windows -->
<loadresource property="FILE.basedir">
<propertyresource name="TESTS.basedir"/>
<filterchain>
<tokenfilter>
<filetokenizer/>
<replacestring from="\" to="/"/>
</tokenfilter>
</filterchain>
</loadresource>
<!-- ========== End: Setup ========== -->
<!-- ========== Functions for Running Tests ========== -->
<!--
Run a specified test.
Parameters passed in are:
@param all : true if running all tests, false otherwise
@param tool : the name of the provenance collection tool
@param test-name : the name of the test run
@param console-mode : true if on console mode (console test), unset otherwise
@param rmd : true if the script file is a RMarkdown file, unset otherwise
-->
<target name="run-test">
<!-- additional properties -->
<property name="test-dir" value="scriptTests/${test-name}"/>
<property name="working-dir" value="${test-dir}/${tool}"/>
<property name="local-dir" value="${working-dir}/local"/>
<!--
Set the value of test-script.
If the property rmd is true, test-script is a .rmd file.
Otherwise, the rmd property is unset and test-script is a .r file.
(the conditional for the setting test-script to a .r file is unnecessary
as the value for properties can not be changed once set)
-->
<condition property="test-script" value="${FILE.basedir}/${test-dir}/${test-name}.Rmd">
<istrue value="${rmd}"/>
</condition>
<property name="test-script" value="${FILE.basedir}/${test-dir}/${test-name}.R"/>
<!-- Set the value of prov-dir. If this is a test simulating running from
the console, the provenance is in a directory named prov_console. Otherwise,
the provenance directory is named after the test. (the conditional for the
setting test-script to a .r file is unnecessary as the value for properties
can not be changed once set)
-->
<condition property="prov-dir" value="${working-dir}/prov_console">
<istrue value="${console-mode}"/>
</condition>
<property name="prov-dir" value="${working-dir}/prov_${test-name}"/>
<!--
Set the value of run-script. This is the file that actually runs the test.
If the property console-mode is true, then we are testing on console mode (console test).
Otherwise, the console-mode property is unset and we are running tests using sourceTest.r.
-->
<condition property="run-script" value="consoleTest.r">
<istrue value="${console-mode}"/>
</condition>
<property name="run-script" value="sourceTest.r"/>
<!-- clean local folder: files in it are used for comparison -->
<delete dir="${local-dir}" quiet="true"/>
<mkdir dir="${local-dir}"/>
<!--
builds consoleTest.r in working directory if in console mode (console-mode = true),
copies sourceTest.r into working directory otherwise (console-mode is unset)
-->
<concat if:true="${console-mode}" destfile="${working-dir}/consoleTest.r">
<fileset file="${FILE.basedir}/scriptTests/consoleTest-pre.r"/>
<fileset file="${test-script}"/>
<fileset file="${FILE.basedir}/scriptTests/consoleTest-post.r"/>
</concat>
<copy unless:true="${console-mode}"
file="scriptTests/sourceTest.r"
todir="${working-dir}" overwrite="true"
/>
<!-- replace placeholders in run script with correct script name and directory -->
<replaceregexp file="${working-dir}/${run-script}"
match="\[DIR_LOCAL\]"
replace="${FILE.basedir}/${working-dir}"
flags="g"
/>
<replaceregexp file="${working-dir}/${run-script}"
match="\[SCRIPT\]"
replace="${test-script}"
flags="g"
/>
<replaceregexp file="${working-dir}/${run-script}"
match="\[DIR_DDG\]"
replace="${FILE.basedir}/${working-dir}"
flags="g"
/>
<!-- Delete any Rplots file created by a prior execution -->
<delete file="${working-dir}/Rplots.pdf"/>
<!-- Delete prov dirctory created by a prior execution -->
<delete dir="${prov-dir}" quiet="true"/>
<!-- RUN THE TEST! (by executing the run script)-->
<exec executable="Rscript" dir="${working-dir}" output="${FILE.basedir}/${working-dir}/test.out">
<arg line="${run-script}"/>
<arg value="${tool}"/>
<arg value="${details}"/>
</exec>
<!-- PROV-JSON COMPLIANCE TEST -->
<antcall target="prov-json-compliance-test" />
<!-- process output and expected files to prepare for comparison -->
<antcall target="prepare-to-compare"/>
<!-- compare .out and .json files -->
<antcall target="compare-out"/>
<antcall target="compare-json"/>
</target> <!-- End: run-test -->
<!--
prov-json compliance test
Tests the produced .json file for prov-json compliance.
-->
<target name="prov-json-compliance-test">
<available file="${prov-dir}/prov.json" property="json.exists"/>
<fail message="${prov-dir}/prov.json does not exist.">
<condition>
<not><isset property="json.exists"/></not>
</condition>
</fail>
<exec executable="Rscript" dir="scriptTests/ProvJson" resultproperty="compliant">
<arg value="complianceTest.r" />
<arg path="scriptTests/ProvJson/schema.json" />
<arg path="${prov-dir}/prov.json" />
</exec>
<fail message="prov.json is not prov-json compliant.">
<condition>
<and>
<equals arg1="${all}" arg2="true" />
<equals arg1="${compliant}" arg2="1"/>
</and>
</condition>
</fail>
</target> <!-- End: prov-json-compliance-test -->
<!-- process output and expected files to prepare for comparison -->
<target name="prepare-to-compare">
<!--
Copy output files (.out and prov.json) into local folder
Copy expected outputs into local folder
Append .local to all files
-->
<copy todir="${local-dir}" overwrite="true">
<fileset file="${prov-dir}/prov.json"/>
<fileset dir="${working-dir}">
<include name="*.out"/>
<include name="*_prov.json"/>
</fileset>
<globmapper from="*" to="*.local"/>
</copy>
<!-- Delete all local environment information (except sourced scripts & installed packages) -->
<replaceregexp flags="g">
<regexp pattern='(\t+("rdt:architecture"|"rdt:operatingSystem"|"rdt:language"|"rdt:langVersion"|"rdt:ui"|"rdt:pandoc"|"rdt:script"|"rdt:scriptTimeStamp"|"rdt:workingDirectory"|"rdt:provDirectory"|"rdt:provTimestamp"): (.*)\r?\n(,\r?\n)?)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!--
Delete all sourced script timestamp occurrences
There are 3 different cases:
"rdt:sourcedScriptTimeStamps": "", // no additional sourced scripts
"rdt:sourcedScriptTimeStamps": ["2018-01-11T06.29.26EST"], // 1 additional sourced script
// multiple additional sourced scripts
"rdt:sourcedScriptTimeStamps": [
"2018-01-11T06.29.26EST",
"2018-01-11T06.29.26EST",
"2018-01-11T06.29.26EST",
],
-->
<replaceregexp flags="g">
<regexp pattern='(\t+"rdt:sourcedScriptTimeStamps": (""|\[\r?\n?(\t*"?([0-9]{4}-[0-9]{2}-[0-9]{2}(T| )[0-9]{2}(.|:)[0-9]{2}(.|:)[0-9]{2}[A-Z]{0,3}[+|-]?[0-9]{0,2})?"?,?\r?\n?)+\]),)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- Delete all entity timestamp occurrences -->
<replaceregexp flags="g">
<regexp pattern='(\t+"rdt:timestamp": ("?([0-9]{4}-[0-9]{2}-[0-9]{2}(T| )[0-9]{2}(.|:)[0-9]{2}(.|:)[0-9]{2}[A-Z]{0,3}[+|-]?[0-9]{0,2})?"?,)\r?\n)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- Delete all entity scope occurrences -->
<replaceregexp flags="g">
<regexp pattern='(\t+"rdt:scope": ("(.*)",)\r?\n)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- Delete all elapsed time occurrences -->
<replaceregexp flags="g">
<regexp pattern='(\t+"rdt:(total)?(e|E)lapsedTime": ("?[0-9]*\.?[0-9]+"?,)\r?\n)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- Delete all hash values. pdf files include creation dates, so these will not match. -->
<replaceregexp flags="g">
<regexp pattern='(\t+"rdt:(script)?(h|H)ash": ("[0-9a-f]*"?,)\r?\n)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- Delete hash values of sourced scripts -->
<replaceregexp flags="g">
<!--<regexp pattern='(\t+"rdt:sourcedScriptHashes": (""|\[\r?\n?(\t*"?([0-9a-f]*)?"?,)?\r?\n?)+\]),)'/>-->
<regexp pattern='(\t+"rdt:sourcedScriptHashes": (""|\[\r?\n?(\t*"?[0-9a-f]*"?,?\r?\n?)+\],))'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- all: Further edit the .local files if running all the tests -->
<antcall if:true="${all}" target="all-edits"/>
<!-- github: Further edit the .local files if running tests on github -->
<antcall if:true="${github}" target="github-edits"/>
<!-- Replace file paths to test directory with [DIR] -->
<replaceregexp flags="gi">
<regexp pattern="${FILE.basedir}/${test-dir}"/>
<substitution expression="\[DIR\]"/>
<fileset dir="${local-dir}">
<patternset refid="local_files"/>
</fileset>
</replaceregexp>
<!-- Remove location attributes that use absolute paths.
These will vary between architectures. It is important
that these follow the rule that replaces local file
paths with [DIR] so we don't lose those. -->
<replaceregexp flags="g">
<regexp pattern='(\t+"rdt:location": "(.:)?/(.*)\r?\n)'/>
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local"/>
</patternset>
</fileset>
</replaceregexp>
<!-- Fix line endings on all local files so diff works well -->
<fixcrlf srcdir="${local-dir}"
includes="*.local"
eol="lf"
eof="remove"
tab="remove"
tablength="2"
/>
</target> <!-- End: prepare-to-compare -->
<!-- all: Further edits the .local files for tests when run on all tests -->
<target name="all-edits">
<!-- remove library versions
some examples of library version strings:
"version": "1.5",
"version": 0.3.0",
"version": "3.98-1.10",
"version": "2.41-3",
-->
<replaceregexp flags="g">
<regexp pattern='(\t+"version": ("[0-9]+.?[0-9]*.?[0-9]*-?[0-9]*.?[0-9]*"),\r?\n)' />
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.local" />
</patternset>
</fileset>
</replaceregexp>
<!-- remove tool.version and json.version strings from json.local files -->
<replaceregexp>
<!-- Putting the json version back in -->
<regexp pattern='\s+"rdt:tool.version".*${line.separator}\s+"rdt:json.version": .*${line.separator}' />
<substitution expression=""/>
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.json.local" />
</patternset>
</fileset>
</replaceregexp>
<!-- remove execution time from .out.local files -->
<replaceregexp>
<regexp pattern='Execution Time = ([0-9]*\.[0-9]+)${line.separator}' />
<substitution expression='' />
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.out.local" />
</patternset>
</fileset>
</replaceregexp>
</target> <!-- End: all-edits -->
<target name="github-edits">
<!-- remove the library section -->
<replaceregexp flags="m">
<regexp pattern='\"rdt:l1(.*${line.separator})*.*wasInformedBy' />
<substitution expression='},"wasInformedBy' />
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.json.local" />
</patternset>
</fileset>
</replaceregexp>
<!-- In case there is no wasInformedBy section -->
<replaceregexp flags="m">
<regexp pattern='\"rdt:l1(.*${line.separator})*.*wasGeneratedBy' />
<substitution expression='},"wasGeneratedBy' />
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.json.local" />
</patternset>
</fileset>
</replaceregexp>
<!-- In case there is no wasInformedBy and no wasGeneratedBy section -->
<replaceregexp flags="m">
<regexp pattern='\"rdt:l1(.*${line.separator})*.*used' />
<substitution expression='},"used' />
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.json.local" />
</patternset>
</fileset>
</replaceregexp>
<!-- In case there is no wasInformedBy, no wasGeneratedBy, and no used section -->
<replaceregexp flags="m">
<regexp pattern='\"rdt:l1(.*${line.separator})*' />
<substitution expression='' />
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.json.local" />
</patternset>
</fileset>
</replaceregexp>
<!-- remove the hadMember section -->
<replaceregexp flags="m">
<regexp pattern='hadMember(.*${line.separator})*' />
<substitution expression='' />
<fileset dir="${local-dir}">
<patternset id="local_files">
<include name="*.json.local" />
</patternset>
</fileset>
</replaceregexp>
</target>
<!-- Compare .out files -->
<target name="compare-out">
<echo></echo>
<echo> Diff of (1) test.out.local and (2) expected_test.out.local:</echo>
<echo></echo>
<!-- execute diff on .out files-->
<exec executable="diff">
<arg value="--strip-trailing-cr"/>
<arg file="${local-dir}/test.out.local"/>
<arg file="${local-dir}/expected_test.out.local"/>
</exec>
<!-- compare the diff -->
<exec executable="cmp" failonerror="false" resultproperty="return.code.out">
<arg file="${local-dir}/test.out.local"/>
<arg file="${local-dir}/expected_test.out.local"/>
</exec>
<!-- all: Fails if a test does not pass -->
<fail message="Does not match expected output.">
<condition>
<and>
<equals arg1="${all}" arg2="true" />
<equals arg1="${return.code.out}" arg2="1"/>
</and>
</condition>
</fail>
</target> <!-- End: compare-out -->
<!-- Compare prov.json files -->
<target name="compare-json">
<echo></echo>
<echo> Diff of (1) prov.json.local and (2) expected_prov.json.local:</echo>
<echo></echo>
<!-- execute diff on .json files-->
<exec executable="diff">
<arg value="--strip-trailing-cr"/>
<arg file="${local-dir}/prov.json.local"/>
<arg file="${local-dir}/expected_prov.json.local"/>
</exec>
<!-- compare the diff -->
<exec executable="cmp" failonerror="false" resultproperty="return.code.json">
<arg file="${local-dir}/prov.json.local"/>
<arg file="${local-dir}/expected_prov.json.local"/>
</exec>
<!-- all: Fails if a test does not pass -->
<fail message="Does not match expected output.">
<condition>
<and>
<equals arg1="${all}" arg2="true" />
<equals arg1="${return.code.json}" arg2="1"/>
</and>
</condition>
</fail>
</target> <!-- End: compare-json -->
<!-- ========== End: Functions for Running Tests ========== -->
<!-- ========== Functions for Updating Tests ========== -->
<!--
Updates the expected result files for a test case.
This should only be used when the expected results have changed for the better!
Parameters passed in are:
@param tool : the name of the provenance collection tool
@param test-name : the name of the test run
@param console-mode : true if on console mode (console test), unset otherwise
-->
<target name="update-expected">
<!-- additional properties -->
<property name="test-dir" value="scriptTests/${test-name}"/>
<property name="working-dir" value="${test-dir}/${tool}"/>
<!-- Set the value of prov-dir. If this is a test simulating running from
the console, the provenance is in a directory named prov_console. Otherwise,
the provenance directory is named after the test. (the conditional for the
setting test-script to a .r file is unnecessary as the value for properties
can not be changed once set)
-->
<condition property="prov-dir" value="${working-dir}/prov_console">
<istrue value="${console-mode}"/>
</condition>
<property name="prov-dir" value="${working-dir}/prov_${test-name}"/>
<!-- Confirm that the user wants to update the expected results. -->
<input
message="Do you want to update the expected results for ${working-dir}?"
validargs="y,n"
addproperty="do.update"
/>
<condition property="do.abort">
<not>
<equals arg1="y" arg2="${do.update}"/>
</not>
</condition>
<fail if="do.abort">Update aborted by user.</fail>
<!-- tmp directory for storing expected results while editing -->
<property name="expected-dir" value="${working-dir}/expected"/>
<mkdir dir="${expected-dir}"/>
<!-- copy .out and prov.json file into tmp folder -->
<copy todir="${expected-dir}" overwrite="true">
<fileset file="${working-dir}/test.out"/>
<fileset file="${prov-dir}/prov.json"/>
</copy>
<!-- replace file paths to test directory with [DIR] -->
<replaceregexp flags="gi">
<regexp pattern="${FILE.basedir}/${test-dir}"/>
<substitution expression="\[DIR\]"/>
<fileset dir="${expected-dir}"/>
</replaceregexp>
<!-- copy edited files up to become the new expected results -->
<copy file="${expected-dir}/test.out"
tofile="${working-dir}/expected_test.out"
overwrite="true"
/>
<copy file="${expected-dir}/prov.json"
tofile="${working-dir}/expected_prov.json"
overwrite="true"
/>
<!-- delete tmp directory -->
<delete dir="${expected-dir}" quiet="true"/>
</target> <!-- End: update-expected -->
<!-- ========== End: Functions for Updating Tests ========== -->
<!-- ========== Individual Test Targets (alphabetical order) ========== -->
<!-- AnnotateOnOffTest -->
<target name="AnnotateOnOff"> <!-- helper -->
<condition property="all" value="false"> <!-- default value -->
<not>
<isset property="all"/>
</not>
</condition>
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<echo>This test is currently unused.</echo>
<!--<antcall target="run-test">
<param name="test-name" value="AnnotateOnOff"/>
<param name="details" value="true"/>
</antcall>-->
</target>
<target name="update-AnnotateOnOff"> <!-- helper -->
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<echo>This test is currently unused.</echo>
<!--<antcall target="update-expected">
<param name="test-name" value="AnnotateOnOff"/>
</antcall>-->
</target>
<target name="AnnotateOnOff-rdt">
<antcall target="AnnotateOnOff">
<param name="all" value="false"/>
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="AnnotateOnOff-rdtLite">
<antcall target="AnnotateOnOff">
<param name="all" value="false"/>
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<target name="update-AnnotateOnOff-rdt">
<antcall target="update-AnnotateOnOff">
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="update-AnnotateOnOff-rdtLite">
<antcall target="update-AnnotateOnOff">
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<!-- AssignmentOperatorsTest -->
<target name="AssignOperators"> <!-- helper -->
<condition property="all" value="false"> <!-- default value -->
<not>
<isset property="all"/>
</not>
</condition>
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="run-test">
<param name="test-name" value="AssignOperators"/>
<param name="details" value="true"/>
</antcall>
</target>
<target name="update-AssignOperators"> <!-- helper -->
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="update-expected">
<param name="test-name" value="AssignOperators"/>
</antcall>
</target>
<target name="AssignOperators-rdt">
<antcall target="AssignOperators">
<param name="all" value="false"/>
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="AssignOperators-rdtLite">
<antcall target="AssignOperators">
<param name="all" value="false"/>
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<target name="update-AssignOperators-rdt">
<antcall target="update-AssignOperators">
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="update-AssignOperators-rdtLite">
<antcall target="update-AssignOperators">
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<!-- basicTest -->
<target name="basic"> <!-- helper -->
<condition property="all" value="false"> <!-- default value -->
<not>
<isset property="all"/>
</not>
</condition>
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="run-test">
<param name="test-name" value="basic"/>
<param name="details" value="true"/>
</antcall>
</target>
<target name="update-basic"> <!-- helper -->
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="update-expected">
<param name="test-name" value="basic"/>
</antcall>
</target>
<target name="basic-rdt">
<antcall target="basic">
<param name="all" value="false"/>
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="basic-rdtLite">
<antcall target="basic">
<param name="all" value="false"/>
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<target name="update-basic-rdt">
<antcall target="update-basic">
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="update-basic-rdtLite">
<antcall target="update-basic">
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<!-- CalculateSquareRoot -->
<target name="CalculateSqrt"> <!-- helper -->
<condition property="all" value="false"> <!-- default value -->
<not>
<isset property="all"/>
</not>
</condition>
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="run-test">
<param name="test-name" value="CalculateSqrt"/>
<param name="details" value="true"/>
</antcall>
</target>
<target name="update-CalculateSqrt"> <!-- helper -->
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="update-expected">
<param name="test-name" value="CalculateSqrt"/>
</antcall>
</target>
<target name="CalculateSqrt-rdt">
<antcall target="CalculateSqrt">
<param name="all" value="false"/>
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="CalculateSqrt-rdtLite">
<antcall target="CalculateSqrt">
<param name="all" value="false"/>
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<target name="update-CalculateSqrt-rdt">
<antcall target="update-CalculateSqrt">
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="update-CalculateSqrt-rdtLite">
<antcall target="update-CalculateSqrt">
<param name="tool" value="rdtLite"/>
</antcall>
</target>
<!-- ConnectionTest -->
<target name="Connection"> <!-- helper -->
<condition property="all" value="false"> <!-- default value -->
<not>
<isset property="all"/>
</not>
</condition>
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="run-test">
<param name="test-name" value="Connection"/>
<param name="details" value="true"/>
</antcall>
</target>
<target name="update-Connection"> <!-- helper -->
<condition property="tool" value="rdtLite"> <!-- default value -->
<not>
<isset property="tool"/>
</not>
</condition>
<antcall target="update-expected">
<param name="test-name" value="Connection"/>
</antcall>
</target>
<target name="Connection-rdt">
<antcall target="Connection">
<param name="all" value="false"/>
<param name="tool" value="rdt"/>
</antcall>
</target>
<target name="Connection-rdtLite">
<antcall target="Connection">
<param name="all" value="false"/>
<param name="tool" value="rdtLite"/>
</antcall>