Version 4.1 by gjo on 2013/07/04 15:04
Hide last authors
gjo 4.1 1 To verify the continous work will be correct, a Junit regressiontest was implemented.
gjo 3.1 2
gjo 4.1 3 In these test a model (SCL) and the corresponding ESO file is needed. The test will generate a VHDL component from the model and a testbench from the ESO file and test them against each other. This will be done for all models that are stored in the models repository (if it is completely programmed ).
gjo 3.1 4
5 == What is needed ==
6
7 ----
8
9 The main thing that is needed is the ISE Suite. It contains a compiler to compile the SCL-VHDL file and a simulator (ISIM) to test the SCL-VHDL-Model.
10
11 A very big advantage is that the ISE compiler and simulator can be controlled by a shell command. As we want to control and start this test with eclipse, this interface will be used. So Eclipse is additional needed. The whole test is a JUnit test.
12
13 == Result ==
14
15 ----
16
17 This JUnit test, test all models in the appopriate repository. For every test a JUnit error trace will be generated. By this way it is traceable which models testing fails or work.
18
19 Example: JUnit failure trace. Two models were tested //test.scl// and //test1.scl//
20
21 |=(((
22 JUnit Test Without Failure (test.scl)
23 )))
24 |(((
25 [[image:attach:junit.PNG]]
26 )))
27 |=(% colspan="1" %)(% colspan="1" %)
28 (((
29 JUnit Test With Failure (test1.scl)
30 )))
31 |(% colspan="1" %)(% colspan="1" %)
32 (((
33 [[image:attach:junit_fail.PNG]]
34 )))
35
gjo 4.1 36 A very good thing is that the JUnit error trace contains the missed assertions. So it is exactly traceable where the failure appeared.
gjo 3.1 37
38 == Technical View ==
39
40 ----
41
42 Now a little more technical
43
44 === ISE Compiler ===
45
gjo 4.1 46 The ISE compiler is accessable through a shell command. To get the compiler to work, we must give the compiler a set of parameters.
gjo 3.1 47
gjo 4.1 48 A compiler command looks like this:
gjo 3.1 49
50 {{code}}
51 fuse -intstyle ise -incremental -o tb_test_isim_beh -prj test.prj
52
53 fuse: the ISE compiler
54 instyle: compile message level
55 incremental: build files incremental
56 o: object file (runnable exe)
57 prj: project file
58 {{/code}}
59
gjo 4.1 60 The object file is an executeable file which is needed for simulation.
gjo 3.1 61
gjo 4.1 62 The project file (prj) contains all vhdl that are needed for the current compile process. In our test case these are all file that describe the model and the testbench file.
gjo 3.1 63
64 === ISE Compiler ===
65
gjo 4.1 66 The ISE simulator is accessable through a shell command. To get the simulator to work, we must give the simulator a set of parameters.
gjo 3.1 67
gjo 4.1 68 A simulation command looks like this:
gjo 3.1 69
70 {{code}}
71 tb_test_isim_beh.exe -intstyle ise -tclbatch tes.cmd -log out.log -sdfnowarn
72
73 instyle: compile message level
74 tclbatch: a file which contains simulation information
75 log: specifies the log file
76 sdfnowarn: supress warnings
77 {{/code}}
78
79 === prj File ===
80
gjo 4.1 81 The project file contain all relevant vhd file which are needed for a succesfull compile. In this case the testbench file is also included because it should be tested afterwards.
gjo 3.1 82
83 Here an example of the project file is shown.
84
85 {{code}}
86 vhdl work "abo.vhd"
87 vhdl work "abo_tb.vhd"
88 {{/code}}
89
gjo 4.1 90 The abo.vhd corresponds to the SCL model and contains the component that behaves like the model. abo_tb.vhd is the generated testbench from core ESO file.
gjo 3.1 91
92 === cmd File ===
93
gjo 4.1 94 The command file contains simulation information. In this case we only need the time that the simulation must take.
gjo 3.1 95
gjo 4.1 96 Here an example of a command file:
gjo 3.1 97
98 {{code}}
99 run 1000 ns;
100 quit
101 {{/code}}
102
103 === batch file ===
104
gjo 4.1 105 To run everything automatically, a batch file was generated, which executes the compiling and simulation process.
gjo 3.1 106
107 Here an example of such a batch file:
108
109 {{code}}
110 ise_path="/C/Xilinx/14.5/ISE_DS/ISE/"
111 project="test.prj"
112 toplevelEntity="test_tb"
113 simulation_tcl="test.cmd"
114
115 export PLATFORM=nt
116 export XILINX=$ise_path
117 export PATH=$PATH:$XILINX/bin/$PLATFORM
118 export LD_LIBRARY_PATH=$XILINX/lib/$PLATFORM
119
120 binary="tb_test_isim_beh"
121 compile_params="-intstyle ise -incremental -o "$binary" -prj "$project
122 sim_params="-intstyle ise -tclbatch "$simulation_tcl" -log out.log -sdfnowarn"
123 tmp_out="sim_out.txt"
124
125 fuse $compile_params $toplevelEntity
126 "./"$binary".exe" $sim_params
127 echo -e out.log | cat out.log | grep 'Error:' | sed 's/at.*ps: //' >> $tmp_out
128 {{/code}}
129
gjo 4.1 130 This file would not be explained in detail. In the first block the needed files will be assigned. In the second block the ISE Path will be set. In the third part the compile and simulation parameter are set and in the last part the compilation and simulation is executed.
gjo 3.1 131
132 Some small hints:
133
gjo 4.1 134 * toplevelEntiy specifies the toplevel entity, which should be used, in our case the testbench entity.
135 * sim_out.txt is the log file which will be used later, to fill failure information into the JUnit failure trace.
136 * last line: this line takes the simulation log file and performs a string operation which that pipes only the errors to the sim_out.txt
gjo 3.1 137
138 === The proper Test ===
139
gjo 4.1 140 And how does the simulation works? Here is a little control flow diagram which expresses what will be done with each model that will be tested.
gjo 3.1 141
gjo 4.1 142 [[image:attach:junit_workflow.PNG]]
gjo 3.1 143
gjo 4.1 144 Some additional detailed information:
145
146 For every model which should be tested, a folder with its model name is created. The generated files will be saved to this folder. These folders won't be deleted after the test, they will be deleted befor a new test take place. So it is possible to look at these folders for more information if there are any errors.
147
gjo 3.1 148
149
150
151
152
153
154

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage