2 # Part of SDCC - http://sdcc.sourceforge.net/
3 # Michael Hope <michaelh@juju.net.nz> 2001
5 # This Makefile builds and runs the test suites under tests/ for each
6 # one of the supported ports located under ports/. The test suite
7 # results are summarised and individual test failures are logged. The
8 # expected result is a single line per port summarising the number of
9 # failures, test points, and test cases. The philosophy is that
10 # checked in code should always pass the suite with no failures, as
11 # then if there are failures then it is in the current developers code.
13 # Only the required suites are run. Changing sdcc causes all to be
14 # re-run. Changing one suite causes just that to be run. Changing
15 # one of the library files should cause all to re-run
18 # * The sdcc-extra package, available from CVS.
19 # o cvs -d cvs.sdcc.sourceforge.net:/cvsroot/sdcc co sdcc-extra
20 # o Provides the emulators
21 # * The gbdk-lib package from gbdk.
22 # o cvs -d cvs.gbdk.sourceforge.net:/cvsroot/gbdk co gbdk-lib
23 # o Proviles mul, div, and include files for the z80 tests.
24 # * python 1.5 or above
25 # * uCsim for the mcs51 port
27 # The paths below assume that sdcc, sdcc-extra, and gbdk-lib all reside in
31 # Starting at the bottom
32 # Set of source test suites
33 # Each source suite is processesd producing multiple device specific test suites.
34 # Each device specific test suite is compiled.
35 # Each device specific test suite is run, and the output recorded.
36 # The output from each device specific test suite derrived from a source
37 # test suite are collated.
39 # Uncomment this to show only errors and the summary.
40 # Comment this out for debugging.
45 # All original tests live in TESTS_DIR and below
47 TESTS_NAME = $(TESTS_DIR)
48 # All suite results go in RESULTS_DIR
50 # All data relating to supported ports live in their own directory
54 # Itermediate data directories
55 # Directory that generated cases and the related object code go.
58 # Script that takes a source test suite and generates the iterations
59 GENERATE_CASES = generate-cases.py
61 # Magically generate the list of configured ports to test.
62 # Each directory under ports/ is used as a port name. Each port is tested.
63 # Each port must have a spec.mk which describes how to build the object
64 # files and how to run the emulator.
65 ALL_PORTS = $(filter-out CVS xa51 ucz80 gbz80 pic16,$(notdir $(wildcard $(PORTS_DIR)/*)))
67 # These ports will be cleaned with 'make clean'
68 CLEAN_PORTS = $(filter-out CVS,$(notdir $(wildcard $(PORTS_DIR)/*)))
74 # Test all of the ports
76 for i in $(ALL_PORTS); do $(MAKE) make_library test-port PORT=$$i; done
78 # Helper rule for testing the z80 port only
80 $(MAKE) test-port PORT=z80
82 # Helper rule for testing the z80 port only
84 $(MAKE) test-port PORT=gbz80
86 # Helper rule for testing the mcs51 port only
88 $(MAKE) test-port PORT=mcs51
91 $(MAKE) test-port PORT=mcs51-medium
94 $(MAKE) test-port PORT=mcs51-large
96 test-mcs51-stack-auto:
97 $(MAKE) test-port PORT=mcs51-stack-auto
99 test-mcs51-xstack-auto:
100 $(MAKE) make_library test-port PORT=mcs51-xstack-auto
102 # Helper rule for testing the ds390 port only
104 $(MAKE) test-port PORT=ds390
106 # Helper rule for testing the z80 port only(use ucSim simulator)
108 $(MAKE) test-port PORT=ucz80
110 # Helper rule for testing the hc08 port only(use ucSim simulator)
112 $(MAKE) test-port PORT=hc08
114 # Helper rule for testing the xa51 port only(use ucSim simulator)
116 $(MAKE) test-port PORT=xa51
118 ### Helper rule for testing the host cc only
120 $(MAKE) test-port PORT=host
123 $(MAKE) test-port PORT=host
125 # Begin per-port rules
126 # List of all of the known source test suites.
127 ALL_TESTS = $(shell find $(TESTS_DIR) -name "*.c")
129 # Intermediate directory
130 PORT_CASES_DIR = $(CASES_DIR)/$(PORT)
131 PORT_RESULTS_DIR = $(RESULTS_DIR)/$(PORT)
132 # Each test generates a result log file
133 PORT_RESULTS = $(ALL_TESTS:$(TESTS_DIR)/%.c=$(PORT_RESULTS_DIR)/%.out)
136 SDCC_EXTRA_DIR = ../../../sdcc-extra
137 INC_DIR = $(SDCC_DIR)/device/include
139 # Defaults. Override in spec.mk if required.
141 SDCC = $(SDCC_DIR)/bin/sdcc
144 # Extension of object intermediate files
146 # Extension of files that can be run in the emulator
148 # Currently unused. Extension to append to intermediate directories.
151 # Only include if we're in a per-port call.
153 include $(PORTS_DIR)/$(PORT)/spec.mk
156 make_library: $(MAKE_LIBRARY)
158 SDCCFLAGS += -Ifwk/include -Itests -I$(INC_DIR)
160 # List of intermediate files to keep. Pretty much keep everything as
161 # disk space is free.
162 .PRECIOUS: $(PORT_CASES_DIR)/% %$(OBJEXT) %$(EXEEXT)
164 # Rule to generate the iterations of a test suite off the soure suite.
165 $(PORT_CASES_DIR)/%/iterations.stamp: $(TESTS_DIR)/%.c $(GENERATE_CASES)
168 mkdir -p `dirname $@`
169 python $(GENERATE_CASES) $< `dirname $@` > /dev/null
172 # Rule linking the combined results log to all of the files in the
173 # iteration directory.
174 $(PORT_RESULTS_DIR)/%.out: $(PORT_CASES_DIR)/%/iterations.stamp
175 $(MAKE) iterations PORT=$(PORT) CASES=`dirname $<`
177 # Rule to summaries the results for one port after all of the tests
179 port-results: port-dirs $(PORT_RESULTS)
180 echo Summary for \'$(PORT)\': `cat $(PORT_RESULTS) | python collate-results.py`
183 mkdir -p $(PORT_CASES_DIR) $(PORT_RESULTS_DIR)
185 test-port: port-results
187 # Begin rules that process each iteration generated from the source
190 # List of all of the generated iteration source files.
191 SUB_CASES = $(sort $(wildcard $(CASES)/*.c))
192 # List of all the sub result logs generated from the iterations.
193 SUB_RESULTS = $(SUB_CASES:%.c=%.out)
194 # Overall target. Concatenation of all of the sub results.
195 RESULTS = $(CASES:$(CASES_DIR)/%$(DIREXT)=$(RESULTS_DIR)/%.out)
197 iterations: $(RESULTS)
199 # Rule to generate the overall target from the sub results.
200 $(RESULTS): $(SUB_RESULTS)
201 cat $(SUB_RESULTS) > $@
203 # The remainder of the rules are in $PORT/spec.mak. The port needs to
204 # be able to turn an iterated test suite into a sub result, normally
206 # 1. Compile the required library files
207 # 2. Compile this test suite.
208 # 3. Link 1, 2, and any required stdlib into an executable.
209 # 4. Run the executable inside an emulator, and capture the text
212 # The emulator must exit when main() returns.
217 rm -rf $(CASES_DIR) $(RESULTS_DIR) *.pyc fwk/lib/timeout fwk/lib/timeout.exe
218 for i in $(CLEAN_PORTS); do $(MAKE) -f $(PORTS_DIR)/$$i/spec.mk _clean PORTS_DIR=$(PORTS_DIR) PORT=$$i; done