define PLC_MAIL_FROM_ADDRESS
[tests.git] / system / TestResources.readme
1 Historically, all the site-dependant configuration was part of the svn
2 tree.
3
4 However this turned out to be a wrong choice as the actual test h/w
5 configuration changes over time, so when you try to test e.g. a 4.2
6 build in 2009, you get a very old description of the test hardware.
7
8 So, here's the way out
9
10 ==================== loading local resources
11
12 - the test code expects to find a module named LocalTestResources in $HOME
13 - and this module is expected to define the following stuff
14
15 * one object named local_resources that implement the following methods
16
17 * local_resources.localize (plcs,options) -> plcs
18 --> this is called on the plcs obtained after the configs are loaded, 
19     and should return the altered plc
20
21 * local_resources.local_pre (plc) -> boolean
22 --> this is the implementation of the local_pre step on TestPlc
23 does any required house cleaning, like turning down qemu instances or the like
24
25 * local_resources.local_post (plc) -> boolean
26 --> this is the implementation of the local_post step on TestPlc
27
28 local_pre and local_post are parts of the default set of steps
29
30 * local_list (plc) -> boolean
31 * local_cleanup (plc) -> boolean
32
33
34 ===================== template
35
36 The TestResources class can be used as a template for implementing local_resources
37 See OnelabTestResources for how to use it