2 # Config file for autotest.pl
4 # Note, all paths must be absolute
7 # Almost all options may be overwritten per test run, by appending
8 # a [x] to the config. For example, to change the test type for
9 # the third iteration of tests, you can specify:
10 # (1 is for the first test, 2 for the second, and so on)
12 # TEST_TYPE[3] = build
14 # The options that can not be changed like this are:
22 #### Mandatory Config Options ####
24 # The machine hostname that you will test
27 # The box is expected to have ssh on normal bootup, provide the user
28 # (most likely root, since you need privileged operations)
31 # The directory that contains the Linux source code
32 #BUILD_DIR = /home/test/linux.git
34 # The directory that the objects will be built
35 # (can not be same as BUILD_DIR)
36 #OUTPUT_DIR = /home/test/build/target
38 # The location of the compiled file to copy to the target
39 # (relative to OUTPUT_DIR)
40 #BUILD_TARGET = arch/x86/boot/bzImage
42 # The place to put your image on the test machine
43 #TARGET_IMAGE = /boot/vmlinuz-test
45 # A script or command to reboot the box
46 # Here is a digital loggers power switch example
47 #POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
48 # Here is an example to reboot a virtual box on the current host
49 # with the name "Guest".
50 #POWER_CYCLE = virsh list | grep '\<Guest\>' | awk '{printf ("%d", $1)}' | xargs virsh destroy; sleep 5; virsh start Guest
52 # The script or command that reads the console
53 # If you use ttywatch server, something like the following would work.
54 #CONSOLE = nc -d localhost 3001
55 # For a virtual machine with guest name "Guest".
56 #CONSOLE = virsh console `virsh list | grep '\<Guest\>' | awk '{printf ("%d", $1)}'`
58 # Required version ending to differentiate the test
59 # from other linux builds on the system.
62 # The grub title name for the test kernel to boot
63 # (Only mandatory if REBOOT_TYPE = grub)
65 # For example, if in the /boot/grub/menu.lst the test kernel title has:
67 #GRUB_MENU = Test Kernel
69 # A script to reboot the target into the test kernel
70 # (Only mandatory if REBOOT_TYPE = script)
73 #### Optional Config Options (all have defaults) ####
75 # The number of tests to run (default 5)
78 # The default test type (default test)
79 # The test types may be:
80 # build - only build the kernel, do nothing else
81 # boot - build and boot the kernel
82 # test - build, boot and if TEST is set, run the test script
83 # bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
84 # patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
87 # The build type is any make config type or a command.
88 # (default randconfig)
89 # nobuild - skip the clean and build step
90 #BUILD_TYPE = randconfig
92 # The make command (default make)
93 # If you are building a 32bit x86 on a 64 bit host
94 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
96 # If you need an initrd, you can add a script or code here to install
97 # it. The environment variable KERNEL_VERSION will be set to the
98 # kernel version that is used.
99 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
101 # Way to reboot the box to the test kernel.
102 # Only valid options so far are "grub" and "script"
104 # If you specify grub, it will assume grub version 1
105 # and will search in /boot/grub/menu.lst for the title $GRUB_MENU
106 # and select that target to reboot to the kernel. If this is not
107 # your setup, then specify "script" and have a command or script
108 # specified in REBOOT_SCRIPT to boot to the target.
111 # Line to define success in output. (default "login:")
112 # This is what the line contains, not the entire line. If you need
113 # the entire line to match, then use regural expression syntax like
115 #SUCCESS_LINE = login:
117 # As the test reads the console, after it hits the SUCCESS_LINE
118 # the time it waits for the monitor to settle down between reads
119 # can usually be lowered.
120 # (in seconds) (default 1)
123 # The timeout in seconds when we consider the box hung after
124 # the console stop producing output.
128 # The location on the host where to write temp files
129 # (default /tmp/autotest)
130 #TMP_DIR = /tmp/autotest
132 # In between tests, a reboot of the box may occur, and this
133 # is the time to wait for the console after it stops producing
134 # output. Some machines may not produce a large lag on reboot
135 # so this should accommodate it.
139 # The time in between bisects to sleep (in seconds)
140 # Can be less than SLEEP_TIME since bisects do more work
141 # in between boots. (default 60)
142 #BISECT_SLEEP_TIME = 60
144 # Build without doing a make mrproper, or removing .config
148 # Reboot the target box on error (default 0)
151 # Power off the target on error (ignored if REBOOT_ON_ERROR is set)
153 #POWEROFF_ON_ERROR = 0
155 # Power off the target after all tests have completed successfully
157 #POWEROFF_ON_SUCCESS = 0
159 # Reboot the target after all test completed successfully (default 1)
160 # (ignored if POWEROFF_ON_SUCCESS is set)
161 #REBOOT_ON_SUCCESS = 1
163 # Stop testing if a build fails. If set, the script will end if
164 # a failure is detected, otherwise it will save off the .config,
165 # dmesg and bootlog in a directory called
166 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
167 # if the STORE_FAILURES directory is set.
169 # Note, even if this is set to zero, there are some errors that still
173 # Directory to store failure directories on failure. If this is not
174 # set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
176 #STORE_FAILURES = /home/test/failures
178 # A script or command to power off the box (default undef)
179 # Needed for POWEROFF_ON_ERROR and SUCCESS
180 # Example for digital loggers power switch:
181 #POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
182 # Example for a virtual guest call "Guest".
183 #POWER_OFF = virsh list | grep '\<GuestF12\>' | awk '{printf ("%d", $1)}' | xargs virsh destroy
185 # Any build options for the make (default "")
186 #BUILD_OPTIONS = -j20
188 # Optional log file to write the status (recommended)
190 #LOG_FILE = /home/test/logfiles/target.log
192 # Remove old logfile if it exists before starting all tests.
196 # Test to run if there is a successful boot and TEST_TYPE is test.
197 # Must exit with 0 on success and non zero on error
199 #TEST = ssh user@machine /root/run_test
200 #TEST[1] = ssh root@mxtest /root/run_test
202 # The min config that is needed to build for the machine
203 # A nice way to get this to work, is to do a "lsmod > mymods" on the target
204 # copy it to the build server, and then run "make LSMOD=mymods localyesconfig".
205 # Then copy all the options that are set: "grep '^CONFIG' > /home/test/config-min"
207 # You might want to set:
208 # CONFIG_CMDLINE="<your options here>"
209 # randconfig may set the above and override your real command
212 #MIN_CONFIG = /home/test/config-min
214 # Sometimes there's options that just break the boot and
215 # you do not care about. Here are a few:
216 # # CONFIG_STAGING is not set
217 # Staging drivers are horrible, and can break the build.
218 # # CONFIG_SCSI_DEBUG is not set
219 # SCSI_DEBUG may change your root partition
220 # # CONFIG_KGDB_SERIAL_CONSOLE is not set
221 # KGDB may cause oops waiting for a connection that's not there.
222 # This option points to the file containing config options that will be prepended
223 # to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
224 # before running it through randconfig
226 #ADD_CONFIG = /home/test/config-broken
228 #### Per test run options ####
229 # These are options are per build only. The only exist with the [x]
230 # syntax, and there is no general option.
232 # All are optional and undef by default
234 # CHECKOUT[x] = branch
236 # If the BUILD_DIR is a git repository, then you can set this option
237 # to checkout the given branch before running the TEST. If you
238 # specify this for the first run, that branch will be used for
239 # all preceding tests until a new CHECKOUT[x] is set.
241 # For TEST_TYPE[x] = patchcheck
243 # This expects the BUILD_DIR to be a git repository, and
244 # will checkout the PATCHCHECK_START[x].
246 # PATCHCHECK_START[x] is required and is the first patch to
247 # test (the SHA1 of the commit).
249 # PATCHCHECK_END[x] is the last patch to check (default HEAD)
251 # PATCHCHECK_TYPE[x] is required and is the type of test to run:
254 # Note, the build test will look for warnings, if a warning occurred
255 # in a file that a commit touches, the build will fail.
257 # If BUILD_NOCLEAN is set, then make mrproper will not be run on
258 # any of the builds, just like all other TEST_TYPE tests. But
259 # what makes patchcheck different from the other tests, is if
260 # BUILD_NOCLEAN is not set, only the first and last patch run
261 # make mrproper. This helps speed up the test.
264 # TEST_TYPE[1] = patchcheck
265 # CHECKOUT[1] = mybranch
266 # PATCHCHECK_TYPE[1] = boot
267 # PATCHCHECK_START[1] = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
268 # PATCHCHEKC_END[1] = b8b2663bd7c9da04ac804659b9f617c199d0252c
271 # For TEST_TYPE[x] = bisect
273 # You can specify a git bisect if the BUILD_DIR is a git repository.
274 # The MIN_CONFIG will be used for all builds of the bisect. The build type
275 # used for bisecting is oldconfig.
277 # BISECT_TYPE[x] is the type of test to perform:
278 # build - bad fails to build
279 # boot - bad builds but fails to boot
280 # test - bad boots but fails a test
282 # BISECT_GOOD[x] is the commit (SHA1) to label as good
283 # BISECT_BAD[x] is the commit to label as bad
285 # The above three options are required for a bisect operation.
287 # BISECT_REPLAY[x] = /path/to/replay/file (optional, default undefined)
289 # If an operation failed in the bisect that was not expected to
290 # fail. Then the test ends. The state of the BUILD_DIR will be
291 # left off at where the failur occurred. You can examine the
292 # reason for the failure, and perhaps even find a git commit
293 # that would work to continue with. You can run:
295 # git bisect log > /path/to/replay/file
297 # and if BISECT_REPLAY[x] is set, the test will run git bisect replay
298 # before continuing with the bisect.
300 # BISECT_START[x] = commit (optional, default undefined)
302 # As with BISECT_REPLAY[x], if the test failed on a commit that
303 # just happen to have a bad commit in the middle of the bisect,
304 # and you need to skip it. If BISECT_START[x] is defined, it
305 # will checkout that commit before continuing with the bisect.
307 # Note, BISECT_REPLAY[x] is executed before BISECT_START[x].
309 # BISECT_REVERSE[x] = 1 (optional, default 0)
311 # In those strange instances where it was broken forever
312 # and you are trying to find where it started to work!
313 # Set BISECT_GOOD[x] to the commit that was last known to fail
314 # Set BISECT_BAD[x] to the commit that is known where it started
315 # to work. With BISECT_REVERSE[x] = 1, The test will consider
316 # failures as good, and success as bad.
318 # BISECT_CHECK[x] = 1 (optional, default 0)
320 # Just to be sure the good is good and bad is bad, setting
321 # BISECT_CHECK[x] to 1 will start the bisect by first checking
322 # out BISECT_BAD[x] and makes sure it fails, then it will check
323 # out BISECT_GOOD[x] and makes sure it succeeds before starting
324 # the bisect (it works for BISECT_REVERSE[x] too).
326 # You can limit the test to just check BISECT_GOOD[x] or
327 # BISECT_BAD[x] with BISECT_CHECK[x] = good or
328 # BISECT_CHECK[x] = bad, respectively.
331 # TEST_TYPE[1] = bisect
332 # BISECT_GOOD[1] = v2.6.36
333 # BISECT_BAD[1] = b5153163ed580e00c67bdfecb02b2e3843817b3e
334 # BISECT_TYPE[1] = build
335 # MIN_CONFIG[1] = /home/test/config-bisect