blob: b3e0dc11fc8ae269c0332b144038dc0be39883f1 [file] [log] [blame]
Steven Rostedta75fece2010-11-02 14:58:27 -04001#
Steven Rostedta57419b2010-11-02 15:13:54 -04002# Config file for ktest.pl
Steven Rostedta75fece2010-11-02 14:58:27 -04003#
4# Note, all paths must be absolute
5#
6
Steven Rostedta57419b2010-11-02 15:13:54 -04007# Options set in the beginning of the file are considered to be
8# default options. These options can be overriden by test specific
9# options, with the following exceptions:
Steven Rostedta75fece2010-11-02 14:58:27 -040010#
Steven Rostedta75fece2010-11-02 14:58:27 -040011# LOG_FILE
12# CLEAR_LOG
13# POWEROFF_ON_SUCCESS
14# REBOOT_ON_SUCCESS
15#
Steven Rostedta57419b2010-11-02 15:13:54 -040016# Test specific options are set after the label:
17#
18# TEST_START
19#
20# The options after a TEST_START label are specific to that test.
21# Each TEST_START label will set up a new test. If you want to
22# perform a test more than once, you can add the ITERATE label
23# to it followed by the number of times you want that test
24# to iterate. If the ITERATE is left off, the test will only
25# be performed once.
26#
27# TEST_START ITERATE 10
28#
29# You can skip a test by adding SKIP (before or after the ITERATE
30# and number)
31#
32# TEST_START SKIP
33#
34# TEST_START SKIP ITERATE 10
35#
36# TEST_START ITERATE 10 SKIP
37#
38# The SKIP label causes the options and the test itself to be ignored.
39# This is useful to set up several different tests in one config file, and
40# only enabling the ones you want to use for a current test run.
41#
42# You can add default options anywhere in the file as well
43# with the DEFAULTS tag. This allows you to have default options
44# after the test options to keep the test options at the top
45# of the file. You can even place the DEFAULTS tag between
46# test cases (but not in the middle of a single test case)
47#
48# TEST_START
49# MIN_CONFIG = /home/test/config-test1
50#
51# DEFAULTS
52# MIN_CONFIG = /home/test/config-default
53#
54# TEST_START ITERATE 10
55#
56# The above will run the first test with MIN_CONFIG set to
57# /home/test/config-test-1. Then 10 tests will be executed
58# with MIN_CONFIG with /home/test/config-default.
59#
60# You can also disable defaults with the SKIP option
61#
62# DEFAULTS SKIP
63# MIN_CONFIG = /home/test/config-use-sometimes
64#
65# DEFAULTS
66# MIN_CONFIG = /home/test/config-most-times
67#
68# The above will ignore the first MIN_CONFIG. If you want to
69# use the first MIN_CONFIG, remove the SKIP from the first
70# DEFAULTS tag and add it to the second. Be careful, options
71# may only be declared once per test or default. If you have
72# the same option name under the same test or as default
73# ktest will fail to execute, and no tests will run.
74#
Steven Rostedta75fece2010-11-02 14:58:27 -040075
Steven Rostedt77d942c2011-05-20 13:36:58 -040076#### Config variables ####
77#
78# This config file can also contain "config variables".
79# These are assigned with ":=" instead of the ktest option
80# assigment "=".
81#
82# The difference between ktest options and config variables
83# is that config variables can be used multiple times,
84# where each instance will override the previous instance.
85# And that they only live at time of processing this config.
86#
87# The advantage to config variables are that they can be used
88# by any option or any other config variables to define thing
89# that you may use over and over again in the options.
90#
91# For example:
92#
93# USER := root
94# TARGET := mybox
95# TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
96#
97# TEST_START
98# MIN_CONFIG = config1
99# TEST = ${TEST_CASE}
100#
101# TEST_START
102# MIN_CONFIG = config2
103# TEST = ${TEST_CASE}
104#
105# TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test2
106#
107# TEST_START
108# MIN_CONFIG = config1
109# TEST = ${TEST_CASE}
110#
111# TEST_START
112# MIN_CONFIG = config2
113# TEST = ${TEST_CASE}
114#
115# TEST_DIR := /home/me/test
116#
117# BUILD_DIR = ${TEST_DIR}/linux.git
118# OUTPUT_DIR = ${TEST_DIR}/test
119#
120# Note, the config variables are evaluated immediately, thus
121# updating TARGET after TEST_CASE has been assigned does nothing
122# to TEST_CASE.
123#
124# As shown in the example, to evaluate a config variable, you
125# use the ${X} convention. Simple $X will not work.
126#
127# If the config variable does not exist, the ${X} will not
128# be evaluated. Thus:
129#
130# MAKE_CMD = PATH=/mypath:${PATH} make
131#
132# If PATH is not a config variable, then the ${PATH} in
133# the MAKE_CMD option will be evaluated by the shell when
134# the MAKE_CMD option is passed into shell processing.
Steven Rostedta57419b2010-11-02 15:13:54 -0400135
Steven Rostedt2a625122011-05-20 15:48:59 -0400136#### Using options in other options ####
137#
138# Options that are defined in the config file may also be used
139# by other options. All options are evaulated at time of
140# use (except that config variables are evaluated at config
141# processing time).
142#
143# If an ktest option is used within another option, instead of
144# typing it again in that option you can simply use the option
145# just like you can config variables.
146#
147# MACHINE = mybox
148#
149# TEST = ssh root@${MACHINE} /path/to/test
150#
151# The option will be used per test case. Thus:
152#
153# TEST_TYPE = test
154# TEST = ssh root@{MACHINE}
155#
156# TEST_START
157# MACHINE = box1
158#
159# TEST_START
160# MACHINE = box2
161#
162# For both test cases, MACHINE will be evaluated at the time
163# of the test case. The first test will run ssh root@box1
164# and the second will run ssh root@box2.
165
Steven Rostedta57419b2010-11-02 15:13:54 -0400166#### Mandatory Default Options ####
167
168# These options must be in the default section, although most
169# may be overridden by test options.
Steven Rostedta75fece2010-11-02 14:58:27 -0400170
171# The machine hostname that you will test
172#MACHINE = target
173
174# The box is expected to have ssh on normal bootup, provide the user
175# (most likely root, since you need privileged operations)
176#SSH_USER = root
177
178# The directory that contains the Linux source code
179#BUILD_DIR = /home/test/linux.git
180
181# The directory that the objects will be built
182# (can not be same as BUILD_DIR)
183#OUTPUT_DIR = /home/test/build/target
184
185# The location of the compiled file to copy to the target
186# (relative to OUTPUT_DIR)
187#BUILD_TARGET = arch/x86/boot/bzImage
188
189# The place to put your image on the test machine
190#TARGET_IMAGE = /boot/vmlinuz-test
191
192# A script or command to reboot the box
Steven Rostedta57419b2010-11-02 15:13:54 -0400193#
Steven Rostedta75fece2010-11-02 14:58:27 -0400194# Here is a digital loggers power switch example
195#POWER_CYCLE = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=CCL'
Steven Rostedta57419b2010-11-02 15:13:54 -0400196#
Steven Rostedta75fece2010-11-02 14:58:27 -0400197# Here is an example to reboot a virtual box on the current host
198# with the name "Guest".
Steven Rostedta57419b2010-11-02 15:13:54 -0400199#POWER_CYCLE = virsh destroy Guest; sleep 5; virsh start Guest
Steven Rostedta75fece2010-11-02 14:58:27 -0400200
201# The script or command that reads the console
Steven Rostedta57419b2010-11-02 15:13:54 -0400202#
Steven Rostedta75fece2010-11-02 14:58:27 -0400203# If you use ttywatch server, something like the following would work.
204#CONSOLE = nc -d localhost 3001
Steven Rostedta57419b2010-11-02 15:13:54 -0400205#
Steven Rostedta75fece2010-11-02 14:58:27 -0400206# For a virtual machine with guest name "Guest".
Steven Rostedta57419b2010-11-02 15:13:54 -0400207#CONSOLE = virsh console Guest
Steven Rostedta75fece2010-11-02 14:58:27 -0400208
209# Required version ending to differentiate the test
210# from other linux builds on the system.
211#LOCALVERSION = -test
212
213# The grub title name for the test kernel to boot
214# (Only mandatory if REBOOT_TYPE = grub)
215#
Steven Rostedta57419b2010-11-02 15:13:54 -0400216# Note, ktest.pl will not update the grub menu.lst, you need to
217# manually add an option for the test. ktest.pl will search
218# the grub menu.lst for this option to find what kernel to
219# reboot into.
220#
Steven Rostedta75fece2010-11-02 14:58:27 -0400221# For example, if in the /boot/grub/menu.lst the test kernel title has:
222# title Test Kernel
Steven Rostedta57419b2010-11-02 15:13:54 -0400223# kernel vmlinuz-test
Steven Rostedta75fece2010-11-02 14:58:27 -0400224#GRUB_MENU = Test Kernel
225
226# A script to reboot the target into the test kernel
227# (Only mandatory if REBOOT_TYPE = script)
228#REBOOT_SCRIPT =
229
230#### Optional Config Options (all have defaults) ####
231
Steven Rostedta57419b2010-11-02 15:13:54 -0400232# Start a test setup. If you leave this off, all options
233# will be default and the test will run once.
234# This is a label and not really an option (it takes no value).
235# You can append ITERATE and a number after it to iterate the
236# test a number of times, or SKIP to ignore this test.
237#
238#TEST_START
239#TEST_START ITERATE 5
240#TEST_START SKIP
Steven Rostedta75fece2010-11-02 14:58:27 -0400241
Steven Rostedtdc895682010-11-02 15:22:53 -0400242# Have the following options as default again. Used after tests
243# have already been defined by TEST_START. Optionally, you can
244# just define all default options before the first TEST_START
245# and you do not need this option.
246#
247# This is a label and not really an option (it takes no value).
248# You can append SKIP to this label and the options within this
249# section will be ignored.
250#
251# DEFAULTS
252# DEFAULTS SKIP
253
Steven Rostedta75fece2010-11-02 14:58:27 -0400254# The default test type (default test)
255# The test types may be:
Steven Rostedtcd8e3682011-08-18 16:35:44 -0400256# build - only build the kernel, do nothing else
257# install - build and install, but do nothing else (does not reboot)
258# boot - build, install, and boot the kernel
259# test - build, boot and if TEST is set, run the test script
Steven Rostedta57419b2010-11-02 15:13:54 -0400260# (If TEST is not set, it defaults back to boot)
Steven Rostedta75fece2010-11-02 14:58:27 -0400261# bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
262# patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
263#TEST_TYPE = test
264
Steven Rostedta57419b2010-11-02 15:13:54 -0400265# Test to run if there is a successful boot and TEST_TYPE is test.
266# Must exit with 0 on success and non zero on error
267# default (undefined)
268#TEST = ssh user@machine /root/run_test
269
270# The build type is any make config type or special command
Steven Rostedta75fece2010-11-02 14:58:27 -0400271# (default randconfig)
272# nobuild - skip the clean and build step
Steven Rostedta57419b2010-11-02 15:13:54 -0400273# useconfig:/path/to/config - use the given config and run
274# oldconfig on it.
275# This option is ignored if TEST_TYPE is patchcheck or bisect
Steven Rostedta75fece2010-11-02 14:58:27 -0400276#BUILD_TYPE = randconfig
277
278# The make command (default make)
279# If you are building a 32bit x86 on a 64 bit host
280#MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
281
Steven Rostedtdc895682010-11-02 15:22:53 -0400282# Any build options for the make of the kernel (not for other makes, like configs)
283# (default "")
284#BUILD_OPTIONS = -j20
285
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400286# If you need an initrd, you can add a script or code here to install
287# it. The environment variable KERNEL_VERSION will be set to the
Steven Rostedta57419b2010-11-02 15:13:54 -0400288# kernel version that is used. Remember to add the initrd line
289# to your grub menu.lst file.
290#
291# Here's a couple of examples to use:
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400292#POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_VERSION
Steven Rostedta57419b2010-11-02 15:13:54 -0400293#
294# or on some systems:
295#POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
Steven Rostedt8b37ca82010-11-02 14:58:33 -0400296
Steven Rostedte0a87422011-09-30 17:50:48 -0400297# If for some reason you just want to boot the kernel and you do not
298# want the test to install anything new. For example, you may just want
299# to boot test the same kernel over and over and do not want to go through
300# the hassle of installing anything, you can set this option to 1
301# (default 0)
302#NO_INSTALL = 1
303
Steven Rostedt0bd6c1a2011-06-14 20:39:31 -0400304# If there is a script that you require to run before the build is done
305# you can specify it with PRE_BUILD.
306#
307# One example may be if you must add a temporary patch to the build to
308# fix a unrelated bug to perform a patchcheck test. This will apply the
309# patch before each build that is made. Use the POST_BUILD to do a git reset --hard
310# to remove the patch.
311#
312# (default undef)
313#PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
314
315# To specify if the test should fail if the PRE_BUILD fails,
316# PRE_BUILD_DIE needs to be set to 1. Otherwise the PRE_BUILD
317# result is ignored.
318# (default 0)
319# PRE_BUILD_DIE = 1
320
321# If there is a script that should run after the build is done
322# you can specify it with POST_BUILD.
323#
324# As the example in PRE_BUILD, POST_BUILD can be used to reset modifications
325# made by the PRE_BUILD.
326#
327# (default undef)
328#POST_BUILD = cd ${BUILD_DIR} && git reset --hard
329
330# To specify if the test should fail if the POST_BUILD fails,
331# POST_BUILD_DIE needs to be set to 1. Otherwise the POST_BUILD
332# result is ignored.
333# (default 0)
334#POST_BUILD_DIE = 1
335
Steven Rostedta75fece2010-11-02 14:58:27 -0400336# Way to reboot the box to the test kernel.
337# Only valid options so far are "grub" and "script"
338# (default grub)
339# If you specify grub, it will assume grub version 1
340# and will search in /boot/grub/menu.lst for the title $GRUB_MENU
341# and select that target to reboot to the kernel. If this is not
342# your setup, then specify "script" and have a command or script
343# specified in REBOOT_SCRIPT to boot to the target.
Steven Rostedta57419b2010-11-02 15:13:54 -0400344#
345# The entry in /boot/grub/menu.lst must be entered in manually.
346# The test will not modify that file.
Steven Rostedta75fece2010-11-02 14:58:27 -0400347#REBOOT_TYPE = grub
348
Steven Rostedta75fece2010-11-02 14:58:27 -0400349# The min config that is needed to build for the machine
Steven Rostedta57419b2010-11-02 15:13:54 -0400350# A nice way to create this is with the following:
Steven Rostedta75fece2010-11-02 14:58:27 -0400351#
Steven Rostedta57419b2010-11-02 15:13:54 -0400352# $ ssh target
353# $ lsmod > mymods
354# $ scp mymods host:/tmp
355# $ exit
356# $ cd linux.git
357# $ rm .config
358# $ make LSMOD=mymods localyesconfig
359# $ grep '^CONFIG' .config > /home/test/config-min
360#
361# If you want even less configs:
362#
363# log in directly to target (do not ssh)
364#
365# $ su
366# # lsmod | cut -d' ' -f1 | xargs rmmod
367#
368# repeat the above several times
369#
370# # lsmod > mymods
371# # reboot
372#
373# May need to reboot to get your network back to copy the mymods
374# to the host, and then remove the previous .config and run the
375# localyesconfig again. The CONFIG_MIN generated like this will
376# not guarantee network activity to the box so the TEST_TYPE of
377# test may fail.
378#
379# You might also want to set:
Steven Rostedta75fece2010-11-02 14:58:27 -0400380# CONFIG_CMDLINE="<your options here>"
381# randconfig may set the above and override your real command
382# line options.
Steven Rostedta57419b2010-11-02 15:13:54 -0400383# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400384#MIN_CONFIG = /home/test/config-min
385
386# Sometimes there's options that just break the boot and
387# you do not care about. Here are a few:
388# # CONFIG_STAGING is not set
389# Staging drivers are horrible, and can break the build.
390# # CONFIG_SCSI_DEBUG is not set
391# SCSI_DEBUG may change your root partition
392# # CONFIG_KGDB_SERIAL_CONSOLE is not set
393# KGDB may cause oops waiting for a connection that's not there.
394# This option points to the file containing config options that will be prepended
395# to the MIN_CONFIG (or be the MIN_CONFIG if it is not set)
Steven Rostedta57419b2010-11-02 15:13:54 -0400396#
397# Note, config options in MIN_CONFIG will override these options.
398#
399# (default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400400#ADD_CONFIG = /home/test/config-broken
401
Steven Rostedtdc895682010-11-02 15:22:53 -0400402# The location on the host where to write temp files
Steven Rostedt48920632011-06-14 20:42:19 -0400403# (default /tmp/ktest/${MACHINE})
404#TMP_DIR = /tmp/ktest/${MACHINE}
Steven Rostedtdc895682010-11-02 15:22:53 -0400405
406# Optional log file to write the status (recommended)
407# Note, this is a DEFAULT section only option.
408# (default undefined)
409#LOG_FILE = /home/test/logfiles/target.log
410
411# Remove old logfile if it exists before starting all tests.
412# Note, this is a DEFAULT section only option.
413# (default 0)
414#CLEAR_LOG = 0
415
416# Line to define a successful boot up in console output.
417# This is what the line contains, not the entire line. If you need
418# the entire line to match, then use regural expression syntax like:
419# (do not add any quotes around it)
420#
421# SUCCESS_LINE = ^MyBox Login:$
422#
423# (default "login:")
424#SUCCESS_LINE = login:
425
Steven Rostedt1c8a6172010-11-09 12:55:40 -0500426# In case the console constantly fills the screen, having
427# a specified time to stop the test after success is recommended.
428# (in seconds)
429# (default 10)
430#STOP_AFTER_SUCCESS = 10
431
432# In case the console constantly fills the screen, having
433# a specified time to stop the test after failure is recommended.
434# (in seconds)
435# (default 60)
436#STOP_AFTER_FAILURE = 60
437
Steven Rostedt2d01b262011-03-08 09:47:54 -0500438# In case the console constantly fills the screen, having
439# a specified time to stop the test if it never succeeds nor fails
440# is recommended.
441# Note: this is ignored if a success or failure is detected.
442# (in seconds)
443# (default 600, -1 is to never stop)
444#STOP_TEST_AFTER = 600
445
Steven Rostedtdc895682010-11-02 15:22:53 -0400446# Stop testing if a build fails. If set, the script will end if
447# a failure is detected, otherwise it will save off the .config,
448# dmesg and bootlog in a directory called
449# MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
450# if the STORE_FAILURES directory is set.
451# (default 1)
452# Note, even if this is set to zero, there are some errors that still
453# stop the tests.
454#DIE_ON_FAILURE = 1
455
456# Directory to store failure directories on failure. If this is not
457# set, DIE_ON_FAILURE=0 will not save off the .config, dmesg and
458# bootlog. This option is ignored if DIE_ON_FAILURE is not set.
459# (default undefined)
460#STORE_FAILURES = /home/test/failures
461
462# Build without doing a make mrproper, or removing .config
463# (default 0)
464#BUILD_NOCLEAN = 0
465
466# As the test reads the console, after it hits the SUCCESS_LINE
467# the time it waits for the monitor to settle down between reads
468# can usually be lowered.
469# (in seconds) (default 1)
470#BOOTED_TIMEOUT = 1
471
472# The timeout in seconds when we consider the box hung after
473# the console stop producing output. Be sure to leave enough
474# time here to get pass a reboot. Some machines may not produce
475# any console output for a long time during a reboot. You do
476# not want the test to fail just because the system was in
477# the process of rebooting to the test kernel.
478# (default 120)
479#TIMEOUT = 120
480
481# In between tests, a reboot of the box may occur, and this
482# is the time to wait for the console after it stops producing
483# output. Some machines may not produce a large lag on reboot
484# so this should accommodate it.
485# The difference between this and TIMEOUT, is that TIMEOUT happens
486# when rebooting to the test kernel. This sleep time happens
487# after a test has completed and we are about to start running
488# another test. If a reboot to the reliable kernel happens,
489# we wait SLEEP_TIME for the console to stop producing output
490# before starting the next test.
491# (default 60)
492#SLEEP_TIME = 60
493
494# The time in between bisects to sleep (in seconds)
495# (default 60)
496#BISECT_SLEEP_TIME = 60
497
Steven Rostedt27d934b2011-05-20 09:18:18 -0400498# The time in between patch checks to sleep (in seconds)
499# (default 60)
500#PATCHCHECK_SLEEP_TIME = 60
501
Steven Rostedtdc895682010-11-02 15:22:53 -0400502# Reboot the target box on error (default 0)
503#REBOOT_ON_ERROR = 0
504
505# Power off the target on error (ignored if REBOOT_ON_ERROR is set)
506# Note, this is a DEFAULT section only option.
507# (default 0)
508#POWEROFF_ON_ERROR = 0
509
510# Power off the target after all tests have completed successfully
511# Note, this is a DEFAULT section only option.
512# (default 0)
513#POWEROFF_ON_SUCCESS = 0
514
515# Reboot the target after all test completed successfully (default 1)
516# (ignored if POWEROFF_ON_SUCCESS is set)
517#REBOOT_ON_SUCCESS = 1
518
519# In case there are isses with rebooting, you can specify this
520# to always powercycle after this amount of time after calling
521# reboot.
522# Note, POWERCYCLE_AFTER_REBOOT = 0 does NOT disable it. It just
523# makes it powercycle immediately after rebooting. Do not define
524# it if you do not want it.
525# (default undefined)
526#POWERCYCLE_AFTER_REBOOT = 5
527
528# In case there's isses with halting, you can specify this
529# to always poweroff after this amount of time after calling
530# halt.
531# Note, POWEROFF_AFTER_HALT = 0 does NOT disable it. It just
532# makes it poweroff immediately after halting. Do not define
533# it if you do not want it.
534# (default undefined)
535#POWEROFF_AFTER_HALT = 20
536
537# A script or command to power off the box (default undefined)
538# Needed for POWEROFF_ON_ERROR and SUCCESS
539#
540# Example for digital loggers power switch:
541#POWER_OFF = wget --no-proxy -O /dev/null -q --auth-no-challenge 'http://admin:admin@power/outlet?5=OFF'
542#
543# Example for a virtual guest call "Guest".
544#POWER_OFF = virsh destroy Guest
545
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500546# The way to execute a command on the target
547# (default ssh $SSH_USER@$MACHINE $SSH_COMMAND";)
548# The variables SSH_USER, MACHINE and SSH_COMMAND are defined
549#SSH_EXEC = ssh $SSH_USER@$MACHINE $SSH_COMMAND";
550
551# The way to copy a file to the target
552# (default scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE)
553# The variables SSH_USER, MACHINE, SRC_FILE and DST_FILE are defined.
554#SCP_TO_TARGET = scp $SRC_FILE $SSH_USER@$MACHINE:$DST_FILE
555
556# The nice way to reboot the target
557# (default ssh $SSH_USER@$MACHINE reboot)
558# The variables SSH_USER and MACHINE are defined.
559#REBOOT = ssh $SSH_USER@$MACHINE reboot
560
Steven Rostedtf1a5b962011-06-13 10:30:00 -0400561# The way triple faults are detected is by testing the kernel
562# banner. If the kernel banner for the kernel we are testing is
563# found, and then later a kernel banner for another kernel version
564# is found, it is considered that we encountered a triple fault,
565# and there is no panic or callback, but simply a reboot.
566# To disable this (because it did a false positive) set the following
567# to 0.
568# (default 1)
569#DETECT_TRIPLE_FAULT = 0
570
Steven Rostedta75fece2010-11-02 14:58:27 -0400571#### Per test run options ####
Steven Rostedta57419b2010-11-02 15:13:54 -0400572# The following options are only allowed in TEST_START sections.
573# They are ignored in the DEFAULTS sections.
Steven Rostedta75fece2010-11-02 14:58:27 -0400574#
Steven Rostedta57419b2010-11-02 15:13:54 -0400575# All of these are optional and undefined by default, although
576# some of these options are required for TEST_TYPE of patchcheck
577# and bisect.
Steven Rostedta75fece2010-11-02 14:58:27 -0400578#
Steven Rostedta57419b2010-11-02 15:13:54 -0400579#
580# CHECKOUT = branch
Steven Rostedta75fece2010-11-02 14:58:27 -0400581#
582# If the BUILD_DIR is a git repository, then you can set this option
583# to checkout the given branch before running the TEST. If you
584# specify this for the first run, that branch will be used for
Steven Rostedta57419b2010-11-02 15:13:54 -0400585# all preceding tests until a new CHECKOUT is set.
Steven Rostedta75fece2010-11-02 14:58:27 -0400586#
Steven Rostedta57419b2010-11-02 15:13:54 -0400587#
Steven Rostedt9064af52011-06-13 10:38:48 -0400588# TEST_NAME = name
589#
590# If you want the test to have a name that is displayed in
591# the test result banner at the end of the test, then use this
592# option. This is useful to search for the RESULT keyword and
593# not have to translate a test number to a test in the config.
Steven Rostedta57419b2010-11-02 15:13:54 -0400594#
595# For TEST_TYPE = patchcheck
Steven Rostedta75fece2010-11-02 14:58:27 -0400596#
597# This expects the BUILD_DIR to be a git repository, and
Steven Rostedta57419b2010-11-02 15:13:54 -0400598# will checkout the PATCHCHECK_START commit.
Steven Rostedta75fece2010-11-02 14:58:27 -0400599#
Steven Rostedta57419b2010-11-02 15:13:54 -0400600# The option BUILD_TYPE will be ignored.
Steven Rostedta75fece2010-11-02 14:58:27 -0400601#
Steven Rostedta57419b2010-11-02 15:13:54 -0400602# The MIN_CONFIG will be used for all builds of the patchcheck. The build type
603# used for patchcheck is oldconfig.
Steven Rostedta75fece2010-11-02 14:58:27 -0400604#
Steven Rostedta57419b2010-11-02 15:13:54 -0400605# PATCHCHECK_START is required and is the first patch to
606# test (the SHA1 of the commit). You may also specify anything
607# that git checkout allows (branch name, tage, HEAD~3).
608#
609# PATCHCHECK_END is the last patch to check (default HEAD)
610#
611# PATCHCHECK_TYPE is required and is the type of test to run:
Steven Rostedta75fece2010-11-02 14:58:27 -0400612# build, boot, test.
613#
614# Note, the build test will look for warnings, if a warning occurred
Steven Rostedt19902072011-06-14 20:46:25 -0400615# in a file that a commit touches, the build will fail, unless
616# IGNORE_WARNINGS is set for the given commit's sha1
617#
618# IGNORE_WARNINGS can be used to disable the failure of patchcheck
619# on a particuler commit (SHA1). You can add more than one commit
620# by adding a list of SHA1s that are space delimited.
Steven Rostedta75fece2010-11-02 14:58:27 -0400621#
622# If BUILD_NOCLEAN is set, then make mrproper will not be run on
623# any of the builds, just like all other TEST_TYPE tests. But
624# what makes patchcheck different from the other tests, is if
625# BUILD_NOCLEAN is not set, only the first and last patch run
626# make mrproper. This helps speed up the test.
627#
628# Example:
Steven Rostedta57419b2010-11-02 15:13:54 -0400629# TEST_START
630# TEST_TYPE = patchcheck
631# CHECKOUT = mybranch
632# PATCHCHECK_TYPE = boot
633# PATCHCHECK_START = 747e94ae3d1b4c9bf5380e569f614eb9040b79e7
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500634# PATCHCHECK_END = HEAD~2
Steven Rostedt19902072011-06-14 20:46:25 -0400635# IGNORE_WARNINGS = 42f9c6b69b54946ffc0515f57d01dc7f5c0e4712 0c17ca2c7187f431d8ffc79e81addc730f33d128
Steven Rostedta75fece2010-11-02 14:58:27 -0400636#
637#
Steven Rostedta75fece2010-11-02 14:58:27 -0400638#
Steven Rostedta57419b2010-11-02 15:13:54 -0400639# For TEST_TYPE = bisect
Steven Rostedta75fece2010-11-02 14:58:27 -0400640#
Steven Rostedta57419b2010-11-02 15:13:54 -0400641# You can specify a git bisect if the BUILD_DIR is a git repository.
642# The MIN_CONFIG will be used for all builds of the bisect. The build type
643# used for bisecting is oldconfig.
644#
645# The option BUILD_TYPE will be ignored.
646#
647# BISECT_TYPE is the type of test to perform:
Steven Rostedta75fece2010-11-02 14:58:27 -0400648# build - bad fails to build
649# boot - bad builds but fails to boot
650# test - bad boots but fails a test
651#
Steven Rostedta57419b2010-11-02 15:13:54 -0400652# BISECT_GOOD is the commit (SHA1) to label as good (accepts all git good commit types)
653# BISECT_BAD is the commit to label as bad (accepts all git bad commit types)
Steven Rostedta75fece2010-11-02 14:58:27 -0400654#
655# The above three options are required for a bisect operation.
656#
Steven Rostedta57419b2010-11-02 15:13:54 -0400657# BISECT_REPLAY = /path/to/replay/file (optional, default undefined)
Steven Rostedta75fece2010-11-02 14:58:27 -0400658#
659# If an operation failed in the bisect that was not expected to
660# fail. Then the test ends. The state of the BUILD_DIR will be
Steven Rostedta57419b2010-11-02 15:13:54 -0400661# left off at where the failure occurred. You can examine the
Steven Rostedta75fece2010-11-02 14:58:27 -0400662# reason for the failure, and perhaps even find a git commit
663# that would work to continue with. You can run:
664#
665# git bisect log > /path/to/replay/file
666#
Steven Rostedta57419b2010-11-02 15:13:54 -0400667# The adding:
Steven Rostedta75fece2010-11-02 14:58:27 -0400668#
Steven Rostedta57419b2010-11-02 15:13:54 -0400669# BISECT_REPLAY= /path/to/replay/file
Steven Rostedta75fece2010-11-02 14:58:27 -0400670#
Steven Rostedta57419b2010-11-02 15:13:54 -0400671# And running the test again. The test will perform the initial
672# git bisect start, git bisect good, and git bisect bad, and
673# then it will run git bisect replay on this file, before
674# continuing with the bisect.
675#
676# BISECT_START = commit (optional, default undefined)
677#
678# As with BISECT_REPLAY, if the test failed on a commit that
Steven Rostedta75fece2010-11-02 14:58:27 -0400679# just happen to have a bad commit in the middle of the bisect,
Steven Rostedta57419b2010-11-02 15:13:54 -0400680# and you need to skip it. If BISECT_START is defined, it
681# will checkout that commit after doing the initial git bisect start,
682# git bisect good, git bisect bad, and running the git bisect replay
683# if the BISECT_REPLAY is set.
Steven Rostedta75fece2010-11-02 14:58:27 -0400684#
Steven Rostedtc23dca72011-03-08 09:26:31 -0500685# BISECT_SKIP = 1 (optional, default 0)
686#
687# If BISECT_TYPE is set to test but the build fails, ktest will
688# simply fail the test and end their. You could use BISECT_REPLAY
689# and BISECT_START to resume after you found a new starting point,
690# or you could set BISECT_SKIP to 1. If BISECT_SKIP is set to 1,
691# when something other than the BISECT_TYPE fails, ktest.pl will
692# run "git bisect skip" and try again.
693#
Steven Rostedt3410f6f2011-03-08 09:38:12 -0500694# BISECT_FILES = <path> (optional, default undefined)
695#
696# To just run the git bisect on a specific path, set BISECT_FILES.
697# For example:
698#
699# BISECT_FILES = arch/x86 kernel/time
700#
701# Will run the bisect with "git bisect start -- arch/x86 kernel/time"
702#
Steven Rostedta57419b2010-11-02 15:13:54 -0400703# BISECT_REVERSE = 1 (optional, default 0)
Steven Rostedta75fece2010-11-02 14:58:27 -0400704#
705# In those strange instances where it was broken forever
706# and you are trying to find where it started to work!
Steven Rostedta57419b2010-11-02 15:13:54 -0400707# Set BISECT_GOOD to the commit that was last known to fail
708# Set BISECT_BAD to the commit that is known to start working.
709# With BISECT_REVERSE = 1, The test will consider failures as
710# good, and success as bad.
Steven Rostedta75fece2010-11-02 14:58:27 -0400711#
Steven Rostedtc960bb92011-03-08 09:22:39 -0500712# BISECT_MANUAL = 1 (optional, default 0)
713#
714# In case there's a problem with automating the bisect for
715# whatever reason. (Can't reboot, want to inspect each iteration)
716# Doing a BISECT_MANUAL will have the test wait for you to
717# tell it if the test passed or failed after each iteration.
718# This is basicall the same as running git bisect yourself
719# but ktest will rebuild and install the kernel for you.
720#
Steven Rostedta57419b2010-11-02 15:13:54 -0400721# BISECT_CHECK = 1 (optional, default 0)
Steven Rostedta75fece2010-11-02 14:58:27 -0400722#
723# Just to be sure the good is good and bad is bad, setting
Steven Rostedta57419b2010-11-02 15:13:54 -0400724# BISECT_CHECK to 1 will start the bisect by first checking
725# out BISECT_BAD and makes sure it fails, then it will check
726# out BISECT_GOOD and makes sure it succeeds before starting
727# the bisect (it works for BISECT_REVERSE too).
Steven Rostedta75fece2010-11-02 14:58:27 -0400728#
Steven Rostedta57419b2010-11-02 15:13:54 -0400729# You can limit the test to just check BISECT_GOOD or
730# BISECT_BAD with BISECT_CHECK = good or
731# BISECT_CHECK = bad, respectively.
Steven Rostedta75fece2010-11-02 14:58:27 -0400732#
733# Example:
Steven Rostedta57419b2010-11-02 15:13:54 -0400734# TEST_START
735# TEST_TYPE = bisect
736# BISECT_GOOD = v2.6.36
737# BISECT_BAD = b5153163ed580e00c67bdfecb02b2e3843817b3e
738# BISECT_TYPE = build
739# MIN_CONFIG = /home/test/config-bisect
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500740#
741#
742#
743# For TEST_TYPE = config_bisect
744#
745# In those cases that you have two different configs. One of them
746# work, the other does not, and you do not know what config causes
747# the problem.
748# The TEST_TYPE config_bisect will bisect the bad config looking for
749# what config causes the failure.
750#
751# The way it works is this:
752#
753# First it finds a config to work with. Since a different version, or
754# MIN_CONFIG may cause different dependecies, it must run through this
755# preparation.
756#
757# Overwrites any config set in the bad config with a config set in
758# either the MIN_CONFIG or ADD_CONFIG. Thus, make sure these configs
759# are minimal and do not disable configs you want to test:
760# (ie. # CONFIG_FOO is not set).
761#
762# An oldconfig is run on the bad config and any new config that
763# appears will be added to the configs to test.
764#
765# Finally, it generates a config with the above result and runs it
766# again through make oldconfig to produce a config that should be
767# satisfied by kconfig.
768#
769# Then it starts the bisect.
770#
771# The configs to test are cut in half. If all the configs in this
772# half depend on a config in the other half, then the other half
773# is tested instead. If no configs are enabled by either half, then
774# this means a circular dependency exists and the test fails.
775#
776# A config is created with the test half, and the bisect test is run.
777#
778# If the bisect succeeds, then all configs in the generated config
779# are removed from the configs to test and added to the configs that
780# will be enabled for all builds (they will be enabled, but not be part
781# of the configs to examine).
782#
783# If the bisect fails, then all test configs that were not enabled by
784# the config file are removed from the test. These configs will not
785# be enabled in future tests. Since current config failed, we consider
786# this to be a subset of the config that we started with.
787#
788# When we are down to one config, it is considered the bad config.
789#
790# Note, the config chosen may not be the true bad config. Due to
791# dependencies and selections of the kbuild system, mulitple
792# configs may be needed to cause a failure. If you disable the
793# config that was found and restart the test, if the test fails
794# again, it is recommended to rerun the config_bisect with a new
795# bad config without the found config enabled.
796#
797# The option BUILD_TYPE will be ignored.
798#
799# CONFIG_BISECT_TYPE is the type of test to perform:
800# build - bad fails to build
801# boot - bad builds but fails to boot
802# test - bad boots but fails a test
803#
Steven Rostedt30f75da2011-06-13 10:35:35 -0400804# CONFIG_BISECT is the config that failed to boot
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500805#
Steven Rostedt30f75da2011-06-13 10:35:35 -0400806# If BISECT_MANUAL is set, it will pause between iterations.
807# This is useful to use just ktest.pl just for the config bisect.
808# If you set it to build, it will run the bisect and you can
809# control what happens in between iterations. It will ask you if
810# the test succeeded or not and continue the config bisect.
811#
812# CONFIG_BISECT_GOOD (optional)
813# If you have a good config to start with, then you
814# can specify it with CONFIG_BISECT_GOOD. Otherwise
815# the MIN_CONFIG is the base.
Steven Rostedtc960bb92011-03-08 09:22:39 -0500816#
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500817# Example:
818# TEST_START
819# TEST_TYPE = config_bisect
820# CONFIG_BISECT_TYPE = build
821# CONFIG_BISECT = /home/test/Ā¢onfig-bad
822# MIN_CONFIG = /home/test/config-min
Steven Rostedtc960bb92011-03-08 09:22:39 -0500823# BISECT_MANUAL = 1
Steven Rostedtd1fbd7e2010-11-08 17:41:37 -0500824#
Steven Rostedt4c4ab122011-07-15 21:16:17 -0400825#
826#
827# For TEST_TYPE = make_min_config
828#
829# After doing a make localyesconfig, your kernel configuration may
830# not be the most useful minimum configuration. Having a true minimum
831# config that you can use against other configs is very useful if
832# someone else has a config that breaks on your code. By only forcing
833# those configurations that are truly required to boot your machine
834# will give you less of a chance that one of your set configurations
835# will make the bug go away. This will give you a better chance to
836# be able to reproduce the reported bug matching the broken config.
837#
838# Note, this does take some time, and may require you to run the
839# test over night, or perhaps over the weekend. But it also allows
840# you to interrupt it, and gives you the current minimum config
841# that was found till that time.
842#
843# Note, this test automatically assumes a BUILD_TYPE of oldconfig
844# and its test type acts like boot.
845# TODO: add a test version that makes the config do more than just
846# boot, like having network access.
847#
Steven Rostedtb9066f62011-07-15 21:25:24 -0400848# To save time, the test does not just grab any option and test
849# it. The Kconfig files are examined to determine the dependencies
850# of the configs. If a config is chosen that depends on another
851# config, that config will be checked first. By checking the
852# parents first, we can eliminate whole groups of configs that
853# may have been enabled.
854#
855# For example, if a USB device config is chosen and depends on CONFIG_USB,
856# the CONFIG_USB will be tested before the device. If CONFIG_USB is
857# found not to be needed, it, as well as all configs that depend on
858# it, will be disabled and removed from the current min_config.
859#
Steven Rostedt4c4ab122011-07-15 21:16:17 -0400860# OUTPUT_MIN_CONFIG is the path and filename of the file that will
861# be created from the MIN_CONFIG. If you interrupt the test, set
862# this file as your new min config, and use it to continue the test.
863# This file does not need to exist on start of test.
864# This file is not created until a config is found that can be removed.
Steven Rostedt35ce5952011-07-15 21:57:25 -0400865# If this file exists, you will be prompted if you want to use it
866# as the min_config (overriding MIN_CONFIG) if START_MIN_CONFIG
867# is not defined.
Steven Rostedt4c4ab122011-07-15 21:16:17 -0400868# (required field)
869#
870# START_MIN_CONFIG is the config to use to start the test with.
871# you can set this as the same OUTPUT_MIN_CONFIG, but if you do
872# the OUTPUT_MIN_CONFIG file must exist.
873# (default MIN_CONFIG)
874#
875# IGNORE_CONFIG is used to specify a config file that has configs that
876# you already know must be set. Configs are written here that have
877# been tested and proved to be required. It is best to define this
878# file if you intend on interrupting the test and running it where
879# it left off. New configs that it finds will be written to this file
880# and will not be tested again in later runs.
881# (optional)
882#
883# Example:
884#
885# TEST_TYPE = make_min_config
886# OUTPUT_MIN_CONFIG = /path/to/config-new-min
887# START_MIN_CONFIG = /path/to/config-min
888# IGNORE_CONFIG = /path/to/config-tested
889#