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 Provildes mul, div, and include files for the z80 tests.
24 # * python 1.5 or above
26 # The paths below assume that sdcc, sdcc-extra, and gbdk-lib all reside in
30 # Starting at the bottom
31 # Set of source test suites
32 # Each source suite is processesd producing multiple device specific test suites.
33 # Each device specific test suite is compiled.
34 # Each device specific test suite is run, and the output recorded.
35 # The output from each device specific test suite derrived from a source
36 # test suite are collated.
38 # Uncomment this to show only errors and the summary.
39 # Comment this out for debugging.
42 # All original tests live in TESTS_DIR and below
44 # All suite results go in RESULTS_DIR
46 # All data relating to supported ports live in their own directory
50 # Itermediate data directories
51 # Directory that generated cases and the related object code go.
54 # Script that takes a source test suite and generates the iterations
55 GENERATE_CASES = generate-cases.py
57 # Magically generate the list of configured ports to test.
58 # Each directory under ports/ is used as a port name. Each port is tested.
59 # The port name must be the same as the one used in the SDCC '-mxxx' argument.
60 # Each port must have a spec.mk which describes how to build the object
61 # files and how to run the emulator.
62 ALL_PORTS = $(filter-out CVS,$(notdir $(wildcard $(PORTS_DIR)/*)))
64 # Test all of the ports
66 for i in $(ALL_PORTS); do $(MAKE) inter-port-clean test-port PORT=$$i; done
68 # Helper rule for testing the z80 port only
70 $(MAKE) inter-port-clean clean test-port PORT=z80
73 # Begin per-port rules
74 # List of all of the known source test suites.
75 ALL_TESTS = $(shell find $(TESTS_DIR) -name "*.c")
77 # Intermediate directory
78 PORT_CASES_DIR = $(CASES_DIR)/$(PORT)
79 PORT_RESULTS_DIR = $(RESULTS_DIR)/$(PORT)
80 # Each test generates a result log file
81 PORT_RESULTS = $(ALL_TESTS:$(TESTS_DIR)/%.c=$(PORT_RESULTS_DIR)/%.out)
84 SDCC_EXTRA_DIR = ../../../sdcc-extra
86 # Defaults. Override in spec.mk if required.
88 SDCC = $(SDCC_DIR)/bin/sdcc
91 # Extension of object intermediate files
93 # Extension of files that can be run in the emulator
95 # Currently unused. Extension to append to intermediate directories.
98 # Only include if we're in a per-port call.
100 include $(PORTS_DIR)/$(PORT)/spec.mk
103 SDCCFLAGS += -Ifwk/include
105 # List of intermediate files to keep. Pretty much keep everything as
106 # disk space is free.
107 .PRECIOUS: $(PORT_CASES_DIR)/% %$(OBJEXT) %$(EXEEXT)
109 # Rule to generate the iterations of a test suite off the soure suite.
110 $(PORT_CASES_DIR)/%$(DIREXT): $(TESTS_DIR)/%.c $(GENERATE_CASES)
111 rm -rf $(CASES_DIR)/tests
112 mkdir -p $(CASES_DIR)/tests
114 python $(GENERATE_CASES) $< > /dev/null
115 cp $(CASES_DIR)/tests/*.c $@
118 # Rule linking the combined results log to all of the files in the
119 # iteration directory.
120 $(PORT_RESULTS_DIR)/%.out: $(PORT_CASES_DIR)/%$(DIREXT)
121 $(MAKE) iterations PORT=$(PORT) CASES=$<
123 # Rule to summaries the results for one port after all of the tests
125 port-results: port-dirs $(PORT_RESULTS)
126 echo Summary for \'$(PORT)\': `cat $(PORT_RESULTS) | python collate-results.py`
129 mkdir -p $(PORT_CASES_DIR) $(PORT_RESULTS_DIR)
131 test-port: port-results
133 # Begin rules that process each iteration generated from the source
136 # List of all of the generated iteration source files.
137 SUB_CASES = $(wildcard $(CASES)/*.c)
138 # List of all the sub result logs generated from the iterations.
139 SUB_RESULTS = $(SUB_CASES:%.c=%.out)
140 # Overall target. Concatenation of all of the sub results.
141 RESULTS = $(CASES:$(CASES_DIR)/%$(DIREXT)=$(RESULTS_DIR)/%.out)
143 iterations: $(RESULTS)
145 # Rule to generate the overall target from the sub results.
146 $(RESULTS): $(SUB_RESULTS)
147 cat $(SUB_RESULTS) > $@
149 # The remainder of the rules are in $PORT/spec.mak. The port needs to
150 # be able to turn an iterated test suite into a sub result, normally
152 # 1. Compile the required library files
153 # 2. Compile this test suite.
154 # 3. Link 1, 2, and any required stdlib into an executable.
155 # 4. Run the executable inside an emulator, and capture the text
158 # The emulator must exit when main() returns.
163 rm -rf $(CASES_DIR) $(RESULTS_DIR)