1 # Ocean Interpreter test code
3 Regular testing is, of course, important for developing any software.
4 The Ocean interpreted is no exception. This document allows easy
7 - a collection of test program
8 - the expected output of these programs when run with various arguments
9 - some "Makefile" code to tie it all together.
11 Three different sorts of tests are run. As soon as any fail, the whole
14 1/ Each program is run and the output is compared against the expected
16 2/ Each program is then run under valgrind, and an error is reported
17 if valgrind detects an error, or if it reports and lost or unfreed
19 3/ Each program is parsed and printed, then the result is parsed and printed.
20 The two results must match.
21 4/ Each program is run with a version of `oceani` with test-coverage
22 recording enabled. Once all programs have successfully run and
23 all the coverage data is available, we check that all lines have
24 been tested at least once. A few exceptions are allowed such as
25 lines that call `abort()`. If any non-exceptional lines have not
26 been run, this final test fails.
27 Until the tests suite is (more) completed, we only throw and error
28 if fewer than 75% of the lines have been tested.
30 Each test has a name, which used to identify the section in this file, and optionally some
31 arguments separated from the name by commas. For each test, there is a section named
32 "output:" followed by the name-and-arguments.
34 ###### File: oceani-tests.mk
39 tests:: oceani_test_suite
40 oceani_test_suite: oceani coverage_oceani
41 @echo -n Checking grammar ...
42 @./parsergen --report --LALR --tag Parser oceani.mdc | grep " - no conflicts" > /dev/null || \
43 { echo "Grammar contains conflicts, please review" ; exit 1; }
45 @rm -rf coverage; mkdir -p coverage
47 @for T in $(oceani_tests); do \
48 echo -n "Test $$T.. "; \
49 i="$$IFS"; IFS=,; set $$T; IFS="$$i"; t=$$1; shift; \
50 ./md2c oceani-tests.mdc "output: $$T" | grep -v '^#' > .tmp.want; \
51 ./oceani --section "test: $$t" oceani-tests.mdc $${1+"$$@"} > .tmp.have; \
52 if ! cmp -s .tmp.want .tmp.have; then \
53 echo "FAILED"; diff -u .tmp.want .tmp.have ; exit 1; fi ;\
54 echo -n "printing.. "; \
55 echo '``````' > .tmp.code1; echo '``````' > .tmp.code2 ;\
56 ./oceani --noexec --print --section "test: $$t" oceani-tests.mdc >> .tmp.code1; \
57 ./oceani --noexec --print .tmp.code1 >> .tmp.code2 || exit 1;\
58 if ! cmp -s .tmp.code1 .tmp.code2; then \
59 echo " Failed"; diff -u .tmp.code1 .tmp.code2; exit 1 ; fi ; \
60 echo -n "extra-newlines.. "; \
62 ' .tmp.code1 > .tmp.code1a; \
63 echo '``````' > .tmp.code2a ;\
64 ./oceani --noexec --print .tmp.code1a >> .tmp.code2a || exit 1;\
65 if ! cmp -s .tmp.code1 .tmp.code2a; then \
66 echo " Failed"; diff -u .tmp.code1 .tmp.code2a; exit 1; fi ; \
67 echo -n "exec-after-print.. "; \
68 ./oceani .tmp.code1 $${1+"$$@"} > .tmp.have ; \
69 if ! cmp -s .tmp.want .tmp.have; then \
70 echo " FAILED"; diff -u .tmp.want .tmp.have; exit 1;fi; \
72 ./coverage_oceani --print --section "test: $$t" oceani-tests.mdc $${1+"$$@"} > /dev/null ; \
73 ./coverage_oceani -tpbn --section "test: $$t" oceani-tests.mdc > /dev/null 2>&1; \
78 @for i in coverage/#*.gcda; do mv $$i coverage/$${i##*#}; done
79 @gcov -o coverage oceani.mdc > /dev/null 2> /dev/null
80 @mv *.gcov coverage ; [ -f .gcov ] && mv .gcov coverage || true
81 @ awk '/NOTEST/ { next } /^ *[1-9]/ {ran+=1} /^ *###/ {skip+=1} \
82 END {printf "coverage: %6.2f%%\n", ran * 100 / (ran + skip); \
83 if (ran < (ran + skip) *0.956) exit(1) }' \
84 coverage/oceani.mdc.gcov
87 @[ -n "$$SKIP_VALGRIND" ] || for T in $(oceani_tests); do \
88 echo -n "Valgrind $$T.. "; \
89 i="$$IFS"; IFS=,; set $$T; IFS="$$i"; t=$$1; shift; \
90 if ! valgrind --error-exitcode=1 --log-file=.tmp.valg ./oceani --section "test: $$t" oceani-tests.mdc $${1+"$$@"} \
91 > /dev/null 2>&1 ; then \
92 echo "FAILED"; cat .tmp.valg; exit 1; fi ; \
93 if grep 'LEAK SUMMARY' .tmp.valg > /dev/null; then \
94 echo "valgrind found LEAKS"; cat .tmp.valg ; exit 1 ; fi; \
95 if grep 'in use at exit [1-9]' .tmp.valg > /dev/null; then \
96 echo "valgrind found memory in use at exit"; cat .tmp.valg ; exit 1 ; fi; \
100 coverage_oceani: oceani.c
101 $(CC) $(CFLAGS) --coverage -fprofile-dir=coverage -o coverage_oceani oceani.c $(LDLIBS)
103 ## Values and variables
105 The first test stores values in variables and performs various
106 calculations on them.
109 oceani_tests += "valvar"
116 a := 23; b:=12 ; b1 := -b
117 print a, b, a+b, a-b, a*b, a/b, a%b
118 print a<b, a<=b, a>b, a>=b, a<a, a==b, a==a
119 print +a, +b, +b1, -a, -b, -b1
120 x := True; y := False
121 print x and y, x or y, x and x, y or y, x and not x, x < y
123 c ::= "This is a string"
124 d ::= " field theory"
127 aconst :: string = "unchanging"
136 ###### output: valvar
138 23 12 35 11 276 1.91667 11
139 False False True True False False True
141 False True True False False False
142 This is a string field theory This is a string field theory
145 Next we change the value of variables
148 oceani_tests += "setvar"
155 a = (a + a) * (a + a)
159 ###### output: setvar
165 oceani_tests += "consts"
170 four ::= 2 + 2 ; five ::= 10/2
171 const pie ::= "I like Pie";
172 cake ::= "The cake is"
176 print "Hello World, what lovely oceans you have!"
177 print "are there", five, "?"
178 print pi, pie, "but", cake
180 ###### output: consts
181 Hello World, what lovely oceans you have!
183 3.14159 I like Pie but The cake is a lie
185 Test merging of variables from multiple cases
188 oceani_tests += varmerge
190 ###### test: varmerge
193 for i:=0; then i=i+1; while i < 5:
203 for i:=0; then i=i+1; while i < 5:
210 // re-declare a CondScope variable
215 ###### output: varmerge
216 zero , one , two , three , many ,
219 ## Conditions and Loops
221 Now we need to test if/else and some different loops
224 oceani_tests += cond_loop
226 ###### test: cond_loop
234 for b:=1; then b=b+b; while b < 100:
237 // Newtons method for square root of 2
243 current := guess * guess
244 use +(current - target) > 0.000000001
246 guess = (guess + (target / guess) ) / 2
249 print "error is ", target - guess * guess
251 for j:=0; then j = j+3 ; while j < 10:
252 if j != 0 and then 20 / j > 3:
253 print "20 /", j," =", 20 / j
255 print "I won't calculate 20 /", j
256 pi ::= 3.1415926535897
257 if 355/113 == pi or else +(pi - 355/113) < 0.001:
259 print "lower" if 355/113 < pi else "higher"
261 if pi > 3 then print "pi exceeds three"; else print "need more pie"
262 if (pi < 3) { print "not enough pi" } else { print "pi sufficient" }
263 for { i := 0; sum := 0 }
269 print "sum 1..10 is", sum
278 ###### output: cond_loop
285 error is -4.51095e-12
286 I won't calculate 20 / 0
289 I won't calculate 20 / 9
299 The demonstration code presented in the interpreted is suitable for the test suite.
300 Here I break it into two parts, keeping the array code separate.
303 oceani_tests += "sayhello,55,33,hello,True"
304 oceani_tests += "sayhello,12,60,there,False"
306 ###### test: sayhello
308 func main(av:[ac::number]string)
309 A := $av[1]; B := $av[2]
311 bbool := av[ac-1] == "True"
312 print "Hello World, what lovely oceans you have!"
313 /* When a variable is defined in both branches of an 'if',
314 * and used afterwards, the variables are merged.
320 print "Is", A, "bigger than", B,"? ", bigger
321 /* If a variable is not used after the 'if', no
322 * merge happens, so types can be different
325 double:string = "yes"
326 print A, "is more than twice", B, "?", double
329 print "double", B, "is", double
340 print "GCD of", A, "and", B,"is", a
342 print a, "is not positive, cannot calculate GCD"
344 print b, "is not positive, cannot calculate GCD"
349 print "Fibonacci:", f1,f2,
359 print astr ++ " was the str"
361 print "I found the str over " ++ astr
363 /* Binary search... */
381 print "Yay, I found", target
383 print "Closest I found was", lo
385 ###### output: sayhello,55,33,hello,True
386 Hello World, what lovely oceans you have!
387 Is 55 bigger than 33 ? yes
389 GCD of 55 and 33 is 11
390 Fibonacci: 1 1 2 3 5 8 13 21 34 55 89 144
392 Closest I found was 77.3438
394 ###### output: sayhello,12,60,there,False
395 Hello World, what lovely oceans you have!
396 Is 12 bigger than 60 ? no
398 GCD of 12 and 60 is 12
399 Fibonacci: 1 1 2 3 5 8 13 21 34 55 89 144
400 I found the str over there
401 Closest I found was 77.3438
404 oceani_tests += "insert_sort"
405 ###### test: insert_sort
410 for i:=1; then i = i + 1; while i < size:
411 n := list[i-1] * list[i-1]
412 list[i] = (n / 100) % 10000
415 for i:=0; then i = i + 1; while i < size:
416 print "list[",i,"]=",list[i]
418 for i := 1; then i=i+1; while i < size:
419 for j:=i-1; then j=j-1; while j >= 0:
420 if list[j] > list[j+1]:
425 for i:=0; then i = i + 1; while i < size:
426 print "list[",i,"]=",list[i]
428 ###### output: insert_sort
544 We already have some array tests, but this is where we put other
545 ad-hoc things array related.
548 oceani_tests += arrays
556 bools[3] = strings[1] == "Hello"
557 bools[1] = strings[2] <= "there"
559 for i:=0; then i=i+1; while i<5:
563 ra[6] = 42 // mustn't crash
564 print '', bools[i], ra[j-1],
567 ###### output: arrays
568 False 0 True 1 False 4 False 9 False 16
572 Time to test if structure declarations and accesses work correctly.
575 oceani_tests += structs
583 active:Boolean = True
585 struct baz { a:number; b:Boolean; }
591 for i:=0; then i=i+1; while i < 4:
599 info[i].size[0] = i*i
601 info[i].active = False
603 for i:=0; then i=i+1; while i < 4:
604 print info[i].name, info[i].active, info[i].size[0]
606 ###### output: structs
613 ## Test code with syntax errors
615 Syntax errors aren't handled well yet - the result is almost always a
616 single message about the first error. So this section will be fairly
617 thin until we add proper parsing recovery in the face of common errors.
619 A special case of syntax errors is token errors, when a token is only
620 accepted because the parser doesn't know quite enough to reject it.
621 There are handled better as they are quite local, so a single test
622 program can trigger most of the possible errors.
624 To handle erronous code, we need a different set of tests, as we need to
625 capture `stderr`. The same test code will be used for type errors too.
626 As error messages contain the line number, and we don't want changes to
627 this file to change the reported numbers, we copy the code into a
628 separate file first, then run from there.
631 @for t in $(oceani_failing_tests); do \
632 echo -n "Test $$t ... "; \
633 ./md2c oceani-tests.mdc "output: $$t" | grep -v '^#' > .tmp.want; \
634 echo '``````' > .tmp.code; \
635 ./md2c oceani-tests.mdc "test: $$t" | grep -v '^#' >> .tmp.code; \
636 ./oceani .tmp.code > .tmp.have 2>&1; \
637 if ! cmp -s .tmp.want .tmp.have; then \
638 echo "FAILED"; diff -u .tmp.want .tmp.have ; exit 1; fi ;\
640 ./coverage_oceani --section "test: $$t" oceani-tests.mdc > /dev/null 2>&1 ;\
644 oceani_failing_tests := syn1
645 oceani_failing_tests += tokerr
650 if then else while do
653 .tmp.code:3:11: Syntax error in statement: then
657 a := 1i // imaginary numbers aren't understood
658 b:[2i]number // array sizes are handled separately
659 c:[3.14159]Boolean // array sizes must be integers
660 d:[1_000_000_000_000]number // they mustn't be huge
661 patn: string = "foo[ ,_]*bar"re // regexp strings are just a dream
664 This is a multiline string
665 With an unsupportable suffix
669 yy:[unknowable]number
671 zz:[zzsize]string // size must be constant, use ::=
673 // These numbers should be bad in all contexts: FIXME
676 ###### output: tokerr
677 .tmp.code:3:13: error: unsupported number suffix: 1i
678 .tmp.code:4:11: error: unsupported number suffix: 2i
679 .tmp.code:5:11: error: array size must be an integer: 3.14159
680 .tmp.code:6:11: error: array size is too large: 1_000_000_000_000
681 .tmp.code:7:23: error: unsupported string suffix: "foo[ ,_]*bar"re
682 .tmp.code:9:17: error: unsupported string suffix: """
683 This is a multiline string
684 With an unsupportable suffix
686 .tmp.code:14:11: error: undefined type: unknown
687 .tmp.code:15:12: error: name undeclared: unknowable
688 .tmp.code:17:12: error: array size must be a constant: zzsize
689 .tmp.code:20:12: error: unrecognised number: 00123
691 ## Tests for type errors
693 Type error don't cause parsing to abort, so we can fit many in the
694 one test program. Some type errors are found during the parse, others
695 during type analysis which doesn't run if parsing failed. So we cannot
696 fit everything in one.
698 These programs were generated by looking for the
699 various places that `type_err()` are called.
702 oceani_failing_tests += type_err1 type_err2 type_err3 type_err4
704 ###### test: type_err1
707 print "hello" ++ 5, 5 ++ "hello"
712 if 3 * 4 and not True: print "Weird"
714 ###### output: type_err1
715 .tmp.code:3:25: error: expected string found number
716 .tmp.code:3:28: error: expected string found number
717 .tmp.code:6:8: error: Cannot assign to a constant: b
718 .tmp.code:5:8: info: name was defined as a constant here
719 .tmp.code:6:8: error: Cannot assign to a constant: b
720 .tmp.code:5:8: info: name was defined as a constant here
721 .tmp.code:8:11: error: Arithmetic returns number but Boolean expected
722 oceani: type error in program - not running.
724 ###### test: type_err2
734 ###### output: type_err2
735 .tmp.code:4:8: error: variable 'a' redeclared
736 .tmp.code:3:8: info: this is where 'a' was first declared
737 .tmp.code:5:8: error: variable 'a' redeclared
738 .tmp.code:3:8: info: this is where 'a' was first declared
739 .tmp.code:6:8: error: variable 'a' redeclared
740 .tmp.code:3:8: info: this is where 'a' was first declared
741 .tmp.code:7:8: error: variable 'a' redeclared
742 .tmp.code:3:8: info: this is where 'a' was first declared
743 .tmp.code:8:8: Variable declared with no type or value: c
745 ###### test: type_err3
754 c = "hello" ++ (True and False)
756 print 45 + ( "Hello" ++ "there")
766 case "Hello": print "Hello"
768 a1:[5]number; a2:[5]number; a3:[10]number; a4:[5]string
783 // trigger 'labels not permitted' error message
784 while 1 if True else False:
788 ###### output: type_err3
789 .tmp.code:8:12: error: expected number but variable 'c' is string
790 .tmp.code:7:8: info: this is where 'c' was set to string
791 .tmp.code:8:12: error: Arithmetic returns number but string expected
792 .tmp.code:7:8: info: variable 'c' was set as string here.
793 .tmp.code:9:24: error: Boolean operation found where string expected
794 .tmp.code:10:12: error: Comparison returns Boolean but string expected
795 .tmp.code:7:8: info: variable 'c' was set as string here.
796 .tmp.code:11:21: error: Concat returns string but number expected
797 .tmp.code:12:8: error: string cannot be indexed
798 .tmp.code:12:8: error: string cannot be indexed
799 .tmp.code:21:13: error: expected number found string
800 .tmp.code:17:16: error: expected number, found string
801 .tmp.code:24:8: error: cannot assign value of type [5]number
802 .tmp.code:25:13: error: expected [5]number but variable 'a3' is [10]number
803 .tmp.code:23:36: info: this is where 'a3' was set to [10]number
804 .tmp.code:25:8: error: cannot assign value of type [5]number
805 .tmp.code:26:13: error: expected [5]number but variable 'a4' is [5]string
806 .tmp.code:23:51: info: this is where 'a4' was set to [5]string
807 .tmp.code:26:8: error: cannot assign value of type [5]number
808 .tmp.code:27:16: error: expected number found string
809 .tmp.code:28:16: error: expected string found Boolean
810 .tmp.code:29:12: error: have number but need string
811 .tmp.code:7:8: info: variable 'c' was set as string here.
812 .tmp.code:32:8: error: variable used but not declared: foo
813 .tmp.code:32:8: error: field reference attempted on none, not a struct
814 .tmp.code:32:16: error: expected none found number
815 .tmp.code:33:14: error: field reference attempted on string, not a struct
816 .tmp.code:34:14: error: cannot find requested field in foo
817 .tmp.code:35:17: error: have string but need number
818 .tmp.code:39:29: error: expected number (labels not permitted) found Boolean
819 oceani: type error in program - not running.
821 ###### test: type_err4
826 ###### output: type_err4
827 .tmp.code:3:14: error: variable used but not declared: b
828 .tmp.code:3:16: error: expected none found number
829 .tmp.code:3:14: info: variable 'b' was set as none here.
830 oceani: type error in program - not running.
833 oceani_failing_tests += type_err_const type_err_const1 missing_program
835 ###### test: type_err_const
838 bar ::= "string" + 56
845 // trigger duplicate-main error
850 ###### output: type_err_const
851 .tmp.code:4:16: error: expected number found string
852 .tmp.code:6:8: error: name already declared: bar
853 .tmp.code:4:8: info: this is where 'bar' was first declared
854 .tmp.code:8:8: error: variable 'foo' redeclared
855 .tmp.code:3:8: info: this is where 'foo' was first declared
856 .tmp.code:13:8: error: variable 'foo' redeclared
857 .tmp.code:3:8: info: this is where 'foo' was first declared
858 .tmp.code:13:8: "main" defined a second time
860 ###### test: type_err_const1
868 ###### output: type_err_const1
869 .tmp.code:3:12: Syntax error in constant: :
870 .tmp.code:4:12: Syntax error in constant: :
872 ###### test: missing_program
876 ###### output: missing_program
877 oceani: no main function found.
879 ## Test erroneous command line args
881 To improve coverage, we want to test correct handling of strange command
882 line arguments. These tests won't use code, so the exiting test types
883 won't work. So we need to be able to explicitly give the command line,
884 and the expected output, and have that tested and the coverage assessed.
885 Rather than having to spell out the whole command name, just give "cmd",
886 and discard that. Requiring but discarding the command make an empty
887 command list possible.
890 @for t in $(oceani_special_tests); do \
891 echo -n "Test $$t ... ";\
892 i="$$IFS"; IFS=,; set $$t; IFS="$$i"; shift ;\
893 ./md2c oceani-tests.mdc "output: $$t" | grep -v '^#' > .tmp.want; \
894 ./oceani $${1+"$$@"} > .tmp.have 2>&1 ;\
895 if ! cmp -s .tmp.want .tmp.have; then \
896 echo "FAILED"; diff -u .tmp.want .tmp.have ; exit 1; fi ;\
898 ./coverage_oceani $${1+"$$@"} > /dev/null 2>&1 ;\
902 oceani_special_tests += "cmd"
903 oceani_special_tests += "cmd,-zyx"
904 oceani_special_tests += "cmd,nofile"
905 oceani_special_tests += "cmd,/dev/null"
906 oceani_special_tests += "cmd,--section,toast:nothing,oceani-tests.mdc"
909 oceani: no input file given
911 ###### output: cmd,-zyx
912 ./oceani: invalid option -- 'z'
913 Usage: oceani --trace --print --noexec --brackets --section=SectionName prog.ocn
915 ###### output: cmd,nofile
916 oceani: cannot open nofile
918 ###### output: cmd,/dev/null
919 oceani: could not find any code in /dev/null
921 ###### output: cmd,--section,toast:nothing,oceani-tests.mdc
922 oceani: cannot find section toast:nothing