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 @rm -rf coverage; mkdir -p coverage
43 @for T in $(oceani_tests); do \
44 echo -n "Test $$T ... "; \
45 i="$$IFS"; IFS=,; set $$T; IFS="$$i"; t=$$1; shift; \
46 ./md2c oceani-tests.mdc "output: $$T" | grep -v '^#' > .tmp.want; \
47 ./oceani --section "test: $$t" oceani-tests.mdc $${1+"$$@"} > .tmp.have; \
48 if ! cmp -s .tmp.want .tmp.have; then \
49 echo "FAILED"; diff -u .tmp.want .tmp.have ; exit 1; fi ;\
50 echo -n "passed ... "; \
51 if ! valgrind ./oceani --section "test: $$t" oceani-tests.mdc $${1+"$$@"} \
52 > /dev/null 2> .tmp.valg; then \
53 echo "valgrind FAILED"; cat .tmp.valg; exit 1; fi ; \
54 echo -n "valgrind passed ... "; \
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 ;\
58 if ! cmp -s .tmp.code1 .tmp.code2; then \
59 echo "Printing Failed"; diff -u .tmp.code1 .tmp.code2; exit1 ; fi ; \
60 echo "Printing passed"; \
61 ./coverage_oceani --print --section "test: $$t" oceani-tests.mdc $${1+"$$@"} > /dev/null ; \
62 ./coverage_oceani -tpbn --section "test: $$t" oceani-tests.mdc > /dev/null 2>&1; \
67 @gcov -o coverage oceani.mdc > /dev/null 2> /dev/null
68 @mv *.gcov coverage ; [ -f .gcov ] && mv .gcov coverage
69 @ awk '/^ *[1-9]/ {ran+=1} /^ *###/ {skip+=1} \
70 END {printf "coverage: %6.2f%%\n", ran * 100 / (ran + skip); \
71 if (ran < (ran + skip) *0.75) exit(1) }' \
72 coverage/oceani.mdc.gcov
75 coverage_oceani: oceani.c
76 $(CC) $(CFLAGS) --coverage -fprofile-dir=coverage -o coverage_oceani oceani.c $(LDLIBS)
78 ## Values and variables
80 The first test stores values in variables and performs various
84 oceani_tests += "valvar"
91 print a, b, a+b, a-b, a*b, a/b, a%b
92 print a<b, a<=b, a>b, a>=b, a<a, a==b, a==a
94 c ::= "This is a string"
100 23 12 35 11 276 1.91667 11
101 False False True True False False True
102 This is a string field theory This is a string field theory
104 Next we change the value of variables
107 oceani_tests += "setvar"
114 a = (a + a) * (a + a)
118 ###### output: setvar
121 ## Conditions and Loops
123 Now we need to test if/else and some different loops
126 oceani_tests += cond_loop
128 ###### test: cond_loop
136 for b:=1; then b=b+b; while b < 100:
139 // Newtons method for square root of 2
145 current := guess * guess
146 use +(current - target) > 0.000000001
148 guess = (guess + (target / guess) ) / 2
151 print "error is ", target - guess * guess
153 ###### output: cond_loop
160 error is -4.51095e-12
164 The demonstration code presented in the interpreted is suitable for the test suite.
165 Here I break it into two parts, keeping the array code separate.
168 oceani_tests += "sayhello,55,33"
169 oceani_tests += "sayhello,12,60"
171 ###### test: sayhello
174 print "Hello World, what lovely oceans you have!"
175 /* When a variable is defined in both branches of an 'if',
176 * and used afterwards, the variables are merged.
182 print "Is", A, "bigger than", B,"? ", bigger
183 /* If a variable is not used after the 'if', no
184 * merge happens, so types can be different
187 double:string = "yes"
188 print A, "is more than twice", B, "?", double
191 print "double", B, "is", double
202 print "GCD of", A, "and", B,"is", a
204 print a, "is not positive, cannot calculate GCD"
206 print b, "is not positive, cannot calculate GCD"
211 print "Fibonacci:", f1,f2,
220 /* Binary search... */
237 print "Yay, I found", target
239 print "Closest I found was", mid
241 ###### output: sayhello,55,33
242 Hello World, what lovely oceans you have!
243 Is 55 bigger than 33 ? yes
245 GCD of 55 and 33 is 11
246 Fibonacci: 1 1 2 3 5 8 13 21 34 55 89 144
247 Closest I found was 77.3438
249 ###### output: sayhello,12,60
250 Hello World, what lovely oceans you have!
251 Is 12 bigger than 60 ? no
253 GCD of 12 and 60 is 12
254 Fibonacci: 1 1 2 3 5 8 13 21 34 55 89 144
255 Closest I found was 77.3438
258 oceani_tests += "insert_sort"
259 ###### test: insert_sort
264 for i:=1; then i = i + 1; while i < size:
265 n := list[i-1] * list[i-1]
266 list[i] = (n / 100) % 10000
269 for i:=0; then i = i + 1; while i < size:
270 print "list[",i,"]=",list[i]
272 for i := 1; then i=i+1; while i < size:
273 for j:=i-1; then j=j-1; while j >= 0:
274 if list[j] > list[j+1]:
279 for i:=0; then i = i + 1; while i < size:
280 print "list[",i,"]=",list[i]
282 ###### output: insert_sort
396 ## Test erroneous command line args
398 To improve coverage, we want to test correct handling of strange command
399 line arguments. These tests won't use code, so the exiting test types
400 won't work. So we need to be able to explicitly give the command line,
401 and the expected output, and have that tested and the coverage assessed.
402 Rather than having to spell out the whole command name, just give "cmd",
403 and discard that. Requiring but discarding the command make an empty
404 command list possible.
407 @for t in $(oceani_special_tests); do \
408 echo -n "Test $$t ... ";\
409 i="$$IFS"; IFS=,; set $$t; IFS="$$i"; shift ;\
410 ./md2c oceani-tests.mdc "output: $$t" | grep -v '^#' > .tmp.want; \
411 ./oceani $${1+"$$@"} > .tmp.have 2>&1 ;\
412 if ! cmp -s .tmp.want .tmp.have; then \
413 echo "FAILED"; diff -u .tmp.want .tmp.have ; exit 1; fi ;\
415 ./coverage_oceani $${1+"$$@"} > /dev/null 2>&1 ;\
420 oceani_special_tests += "cmd"
421 oceani_special_tests += "cmd,-zyx"
422 oceani_special_tests += "cmd,nofile"
423 oceani_special_tests += "cmd,/dev/null"
424 oceani_special_tests += "cmd,--section,toast:nothing,oceani-tests.mdc"
427 oceani: no input file given
429 ###### output: cmd,-zyx
430 ./oceani: invalid option -- 'z'
431 Usage: oceani --trace --print --noexec --brackets--section=SectionName prog.ocn
433 ###### output: cmd,nofile
434 oceani: cannot open nofile
436 ###### output: cmd,/dev/null
437 oceani: could not find any code in /dev/null
439 ###### output: cmd,--section,toast:nothing,oceani-tests.mdc
440 oceani: cannot find section toast:nothing