testing/ktest/sample.conf

13 # default options. These options can be overridden by test specific
21 # Test specific options are set after the label:
25 # The options after a TEST_START label are specific to that test.
26 # Each TEST_START label will set up a new test. If you want to
27 # perform a test more than once, you can add the ITERATE label
28 # to it followed by the number of times you want that test
29 # to iterate. If the ITERATE is left off, the test will only
34 # You can skip a test by adding SKIP (before or after the ITERATE
43 # The SKIP label causes the options and the test itself to be ignored.
45 # only enabling the ones you want to use for a current test run.
49 # after the test options to keep the test options at the top
51 # test cases (but not in the middle of a single test case)
54 # MIN_CONFIG = /home/test/config-test1
57 # MIN_CONFIG = /home/test/config-default
61 # The above will run the first test with MIN_CONFIG set to
62 # /home/test/config-test-1. Then 10 tests will be executed
63 # with MIN_CONFIG with /home/test/config-default.
68 # MIN_CONFIG = /home/test/config-use-sometimes
71 # MIN_CONFIG = /home/test/config-most-times
76 # may only be declared once per test or default. If you have
77 # the same option name under the same test or as default
112 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
116 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-normal
124 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
127 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-tests
130 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-cpu
133 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-network
141 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-32
143 # BUILD_TYPE = useconfig:${CONFIG_DIR}/config-64
166 # Notice the use of parentheses. Without any parentheses the above would be
177 # file can include other files, add new test cases or default
222 # TEST_CASE := ssh ${USER}@${TARGET} /path/to/my/test
226 # TEST = ${TEST_CASE}
230 # TEST = ${TEST_CASE}
236 # TEST = ${TEST_CASE}
240 # TEST = ${TEST_CASE}
242 # TEST_DIR := /home/me/test
245 # OUTPUT_DIR = ${TEST_DIR}/test
284 # TEST = ssh root@${MACHINE} /path/to/test
286 # The option will be used per test case. Thus:
288 # TEST_TYPE = test
289 # TEST = ssh root@{MACHINE}
297 # For both test cases, MACHINE will be evaluated at the time
298 # of the test case. The first test will run ssh root@box1
304 # may be overridden by test options.
306 # The machine hostname that you will test
314 #BUILD_DIR = /home/test/linux.git
318 #OUTPUT_DIR = /home/test/build/target
324 # The place to put your image on the test machine
325 #TARGET_IMAGE = /boot/vmlinuz-test
330 #POWER_CYCLE = wget --no-proxy -O /dev/null -q  --auth-no-challenge 'http://admin:admin@power/outle…
339 #CONSOLE = nc -d localhost 3001
351 # Required version ending to differentiate the test
353 #LOCALVERSION = -test
365 # The grub title name for the test kernel to boot
369 # manually add an option for the test. ktest.pl will search
373 # For example, if in the /boot/grub/menu.lst the test kernel title has:
374 # title Test Kernel
375 # kernel vmlinuz-test
381 # for: menuentry 'Test Kernel'
382 # do a: GRUB_MENU = 'Test Kernel'
389 #GRUB_MENU = Test Kernel
393 # test kernel.
403 # test kernel in the syslinux config file.
405 #SYSLINUX_LABEL = "test-kernel"
407 # A script to reboot the target into the test kernel
432 #  MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | $MAIL_PATH/$MAILER -t $MAILTO
434 #  MAIL_COMMAND = "$MAIL_PATH/$MAILER -s \'$SUBJECT\' $MAILTO <<< \'$MESSAGE\'
440 #MAIL_COMMAND = echo \'Subject: $SUBJECT\n\n$MESSAGE\' | $MAIL_PATH/$MAILER -t $MAILTO
450 # Users can cancel the test by Ctrl^C
454 # If a test ends with an error and EMAIL_ON_ERROR is set as well
455 # as a LOG_FILE is defined, then the log of the failing test will
461 # test file. That is, if this is set to 100000, then only the
467 # Start a test setup. If you leave this off, all options
468 # will be default and the test will run once.
471 # test a number of times, or SKIP to ignore this test.
489 # If you want to execute some command before the first test runs
491 # or an option in the first test case. All other test cases will
492 # ignore it. If both the default and first test have this option
493 # set, then the first test will take precedence.
500 # default or any test case can override it. If multiple test cases
501 # set this option, then the last test case that set it will take
508 # environment, use kernel-install command.
510 #POST_KTEST = ssh root@Test "/usr/bin/kernel-install remove $KERNEL_VERSION"
512 # The default test type (default test)
513 # The test types may be:
514 #   build   - only build the kernel, do nothing else
515 #   install - build and install, but do nothing else (does not reboot)
516 #   boot    - build, install, and boot the kernel
517 #   test    - build, boot and if TEST is set, run the test script
518 #          (If TEST is not set, it defaults back to boot)
519 #   bisect - Perform a bisect on the kernel (see BISECT_TYPE below)
520 #   patchcheck - Do a test on a series of commits in git (see PATCHCHECK below)
521 #TEST_TYPE = test
523 # Test to run if there is a successful boot and TEST_TYPE is test.
526 #TEST = ssh user@machine /root/run_test
530 #   nobuild - skip the clean and build step
531 #   useconfig:/path/to/config - use the given config and run
538 #MAKE_CMD = CC=i386-gcc AS=i386-as make ARCH=i386
542 #BUILD_OPTIONS = -j20
550 #PRE_INSTALL = ssh user@target rm -rf '/lib/modules/*-test*'
558 #POST_INSTALL = ssh user@target /sbin/mkinitrd --allow-missing -f /boot/initramfs-test.img $KERNEL_…
561 #POST_INSTALL = ssh user@target /sbin/dracut -f /boot/initramfs-test.img $KERNEL_VERSION
564 # environment, use kernel-install command.
566 #POST_INSTALL = ssh root@Test "/usr/bin/kernel-install add $KERNEL_VERSION /boot/vmlinuz-$KERNEL_VE…
569 # want the test to install anything new. For example, you may just want
570 # to boot test the same kernel over and over and do not want to go through
575 # If there is a command that you want to run before the individual test
581 # To kill the entire test if PRE_TEST is defined but fails set this
586 # If there is a command you want to run after the individual test case
590 #POST_TEST = cd ${BUILD_DIR}; git reset --hard
596 # fix a unrelated bug to perform a patchcheck test. This will apply the
597 # patch before each build that is made. Use the POST_BUILD to do a git reset --hard
601 #PRE_BUILD = cd ${BUILD_DIR} && patch -p1 < /tmp/temp.patch
603 # To specify if the test should fail if the PRE_BUILD fails,
616 #POST_BUILD = cd ${BUILD_DIR} && git reset --hard
618 # To specify if the test should fail if the POST_BUILD fails,
624 # Way to reboot the box to the test kernel.
643 # The test will not modify that file.
649 # test image.
674 #   $ cd linux.git
677 #   $ grep '^CONFIG' .config > /home/test/config-min
684 #   # lsmod | cut -d' ' -f1 | xargs rmmod
695 # test may fail.
702 #MIN_CONFIG = /home/test/config-min
718 #ADD_CONFIG = /home/test/config-broken
727 #LOG_FILE = /home/test/logfiles/target.log
747 # a new test kernel to it. Otherwise ktest.pl will wait till
753 # a specified time to stop the test after success is recommended.
759 # a specified time to stop the test after failure is recommended.
765 # a specified time to stop the test if it never succeeds nor fails
769 # (default 600, -1 is to never stop)
772 # Stop testing if a build fails. If set, the script will end if
775 # MACHINE-TEST_TYPE_BUILD_TYPE-fail-yyyymmddhhmmss
786 #STORE_FAILURES = /home/test/failures
790 # test succeeds.
792 #STORE_SUCCESSES = /home/test/successes
794 # Build without doing a make mrproper, or removing .config
798 # As the test reads the console, after it hits the SUCCESS_LINE
808 # not want the test to fail just because the system was in
809 # the process of rebooting to the test kernel.
813 # The timeout in seconds when to test if the box can be rebooted
830 # when rebooting to the test kernel. This sleep time happens
831 # after a test has completed and we are about to start running
832 # another test. If a reboot to the reliable kernel happens,
834 # before starting the next test.
845 # If for some reason, the console is outputting content without
869 # Reboot the target after all test completed successfully (default 1)
895 #POWER_OFF = wget --no-proxy -O /dev/null -q  --auth-no-challenge 'http://admin:admin@power/outlet?…
956 # If you don't care if there are non-used options, enable this
957 # option. Be careful though, a non-used option is usually a sign
963 # traces, ktest.pl will detect these and fail a boot or test run
965 # call traces, and will not fail a test if the kernel produces
970 #### Per test run options ####
982 #  to checkout the given branch before running the TEST. If you
989 #  If you want the test to have a name that is displayed in
990 #  the test result banner at the end of the test, then use this
992 #  not have to translate a test number to a test in the config.
1005 #   test (the SHA1 of the commit). You may also specify anything
1020 #  PATCHCHECK_TYPE is required and is the type of test to run:
1021 #      build, boot, test.
1023 #   Note, the build test will look for warnings, if a warning occurred
1035 #   make mrproper. This helps speed up the test.
1056 #  BISECT_TYPE is the type of test to perform:
1057 #	build	- bad fails to build
1058 #	boot	- bad builds but fails to boot
1059 #	test	- bad boots but fails a test
1069 #   fail. Then the test ends. The state of the BUILD_DIR will be
1080 #   And running the test again. The test will perform the initial
1087 #   As with BISECT_REPLAY, if the test failed on a commit that
1096 #   If BISECT_TYPE is set to test but the build fails, ktest will
1097 #   simply fail the test and end their. You could use BISECT_REPLAY
1100 #   when something other than the BISECT_TYPE fails, ktest.pl will
1110 #   Will run the bisect with "git bisect start -- arch/x86 kernel/time"
1118 #   With BISECT_REVERSE = 1, The test will consider failures as
1125 #   Doing a BISECT_MANUAL will have the test wait for you to
1126 #   tell it if the test passed or failed after each iteration.
1134 #   out BISECT_BAD and makes sure it fails, then it will check
1138 #   You can limit the test to just check BISECT_GOOD or
1146 #   test is ran before it says the kernel is good. The first failure
1158 #   In case the specificed test returns something other than just
1159 #   0 for good, and non-zero for bad, you can override 0 being
1164 #   In case the specificed test returns something other than just
1165 #   0 for good, and non-zero for bad, you can override non-zero being
1170 #   If you need to abort the bisect if the test discovers something
1172 #   code returned by the test in order to abort the bisect.
1176 #   If the test detects that the current commit is neither good
1179 #   test returns when it should skip the current commit.
1185 #   "abort" or "skip" (without the quotes).
1198 #   MIN_CONFIG = /home/test/config-bisect
1236 #   If you stop the test, you can copy them to a new location to
1244 #  CONFIG_BISECT_TYPE is the type of test to perform:
1245 #	build	- bad fails to build
1246 #	boot	- bad builds but fails to boot
1247 #	test	- bad boots but fails a test
1255 #  the test succeeded or not and continue the config bisect.
1267 #  and the test will not return a result.
1268 #  Set it to "good" to test only the good config and set it
1269 #  to "bad" to only test the bad config.
1274 #    `pwd`/config-bisect.pl # the location ktest.pl was executed from.
1276 #    `dirname <ktest.pl>`/config-bisect.pl # The directory that holds ktest.pl
1278 #    ${BUILD_DIR}/tools/testing/ktest/config-bisect.pl
1285 #   CONFIG_BISECT = /home/test/config-bad
1286 #   MIN_CONFIG = /home/test/config-min
1303 #  test over night, or perhaps over the weekend. But it also allows
1307 #  Note, this test automatically assumes a BUILD_TYPE of oldconfig
1308 #  and its test type acts like boot.
1309 #  TODO: add a test version that makes the config do more than just
1312 #  To save time, the test does not just grab any option and test
1325 #   be created from the MIN_CONFIG. If you interrupt the test, set
1326 #   this file as your new min config, and use it to continue the test.
1327 #   This file does not need to exist on start of test.
1334 #  START_MIN_CONFIG is the config to use to start the test with.
1342 #   file if you intend on interrupting the test and running it where
1347 #  MIN_CONFIG_TYPE can be either 'boot' or 'test'. With 'boot' it will
1348 #   test if the created config can just boot the machine. If this is
1349 #   set to 'test', then the TEST option must be defined and the created
1351 #   config lets the test succeed. This is useful to make sure the final
1364 #  OUTPUT_MIN_CONFIG = /path/to/config-new-min
1365 #  START_MIN_CONFIG = /path/to/config-min
1366 #  IGNORE_CONFIG = /path/to/config-tested
1367 #  MIN_CONFIG_TYPE = test
1368 #  TEST = ssh ${USER}@${MACHINE} echo hi
1378 # The test "make_warnings_file" will let you create a new warnings
1381 # What this test does is to run just a build, you still need to
1382 # specify BUILD_TYPE to tell the test what type of config to use.
1383 # A BUILD_TYPE of nobuild will fail this test.
1385 # The test will do the build and scan for all warnings. Any warning