# This is a test suite for kconfiglib, primarily testing compatibility with the # C kconfig implementation by comparing outputs. It should be run from the # top-level kernel directory with # # $ python Kconfiglib/kconfigtest.py # # Some additional options can be turned on by passing arguments. With no argument, # they default to off. # # - speedy: # Run scripts/kconfig/conf directly when comparing outputs instead of using # 'make' targets. Makes things a lot faster, but could break if Kconfig # files start depending on additional environment variables besides ARCH and # SRCARCH. (These would be set in the Makefiles in that case.) Safe as of # Linux 3.7.0-rc8. # # - obsessive: # By default, only valid arch/defconfig pairs will be tested. With this # enabled, every arch will be tested with every defconfig, which increases # the test time from minutes to hours. Occassionally finds (usually very # obscure) bugs, and I make sure everything passes with it. # # - log: # Log timestamped failures of the defconfig test to test_defconfig_fails in # the root. Especially handy in obsessive mode. # # For example, to run in speedy mode with logging, run # # $ python Kconfiglib/kconfigtest.py speedy log # # (PyPy also works, and runs the defconfig tests roughly 20% faster on my # machine. Some of the other tests get an even greater speed-up.) # # The tests have been roughly arranged in order of time needed. # # All tests should pass. Report regressions to kconfiglib@gmail.com import kconfiglib import os import re import subprocess import sys import textwrap import time speedy_mode = False obsessive_mode = False log_mode = False # Assume that the value of KERNELVERSION does not affect the configuration # (true as of Linux 2.6.38-rc3). Here we could fetch the correct version # instead. os.environ["KERNELVERSION"] = "2" # Prevent accidental loading of configuration files by removing # KCONFIG_ALLCONFIG from the environment os.environ.pop("KCONFIG_ALLCONFIG", None) # Number of arch/defconfig pairs tested so far nconfigs = 0 def run_tests(): global speedy_mode, obsessive_mode, log_mode for s in sys.argv[1:]: if s == "speedy": speedy_mode = True print "Speedy mode enabled" elif s == "obsessive": obsessive_mode = True print "Obsessive mode enabled" elif s == "log": log_mode = True print "Log mode enabled" else: print "Unrecognized option '{0}'".format(s) return run_selftests() run_compatibility_tests() def run_selftests(): """Runs tests on specific configurations provided by us.""" print "Running selftests...\n" # # is_modifiable() # print "Testing is_modifiable()..." c = kconfiglib.Config("Kconfiglib/tests/Kmodifiable") for s in (c["VISIBLE"], c["TRISTATE_SELECTED_TO_M"], c["VISIBLE_STRING"], c["VISIBLE_INT"], c["VISIBLE_HEX"]): assert_true(s.is_modifiable(), "{0} should be modifiable".format(s.get_name())) for s in (c["NOT_VISIBLE"], c["SELECTED_TO_Y"], c["BOOL_SELECTED_TO_M"], c["NOT_VISIBLE_STRING"], c["NOT_VISIBLE_INT"], c["NOT_VISIBLE_HEX"]): assert_false(s.is_modifiable(), "{0} should not be modifiable".format(s.get_name())) # # get_lower/upper_bound() and get_assignable_values() # print "Testing get_lower/upper_bound() and get_assignable_values()..." c = kconfiglib.Config("Kconfiglib/tests/Kbounds") def assert_bounds(sym, lower, upper): sym = c[sym] low = sym.get_lower_bound() high = sym.get_upper_bound() assert_true(low == lower and high == upper, "Incorrectly calculated bounds for {0}: {1}-{2}. " "Expected {3}-{4}.".format(sym.get_name(), low, high, lower, upper)) # See that we get back the corresponding range from # get_assignable_values() if low is None: vals = sym.get_assignable_values() assert_true(vals == [], "get_assignable_values() thinks there should be " "assignable values for {0} ({1}) but not " "get_lower/upper_bound()".format(sym.get_name(), vals)) else: tri_to_int = { "n" : 0, "m" : 1, "y" : 2 } bound_range = ["n", "m", "y"][tri_to_int[low] : tri_to_int[high] + 1] assignable_range = sym.get_assignable_values() assert_true(bound_range == assignable_range, "get_lower/upper_bound() thinks the range for {0} " "should be {1} while get_assignable_values() thinks " "it should be {2}".format(sym.get_name(), bound_range, assignable_range)) assert_bounds("Y_VISIBLE_BOOL", "n", "y") assert_bounds("Y_VISIBLE_TRISTATE", "n", "y") assert_bounds("M_VISIBLE_BOOL", "n", "y") assert_bounds("M_VISIBLE_TRISTATE", "n", "m") assert_bounds("Y_SELECTED_BOOL", None, None) assert_bounds("M_SELECTED_BOOL", None, None) assert_bounds("Y_SELECTED_TRISTATE", None, None) assert_bounds("M_SELECTED_TRISTATE", "m", "y") assert_bounds("M_SELECTED_M_VISIBLE_TRISTATE", None, None) assert_bounds("STRING", None, None) assert_bounds("INT", None, None) assert_bounds("HEX", None, None) # # eval() (Already well exercised. Just test some basics.) # # TODO: Stricter syntax checking? print "Testing eval()..." c = kconfiglib.Config("Kconfiglib/tests/Keval") def assert_val(expr, val): res = c.eval(expr) assert_true(res == val, "'{0}' evaluated to {1}, expected {2}".\ format(expr, res, val)) # No modules assert_val("n", "n") assert_val("m", "n") assert_val("y", "y") assert_val("M", "y") # Modules c["MODULES"].set_value("y") assert_val("n", "n") assert_val("m", "m") assert_val("y", "y") assert_val("M", "m") assert_val("(Y || N) && (m && y)", "m") # # Text queries # # TODO: Get rid of extra \n's at end of texts? print "Testing text queries..." c = kconfiglib.Config("Kconfiglib/tests/Ktext") assert_equals(c["NO_HELP"].get_help(), None) assert_equals(c["S"].get_help(), "help for\nS\n") assert_equals(c.get_choices()[0].get_help(), "help for\nC\n") assert_equals(c.get_comments()[0].get_text(), "a comment") assert_equals(c.get_menus()[0].get_title(), "a menu") # # Location queries # print "Testing location queries..." kl = "Kconfiglib/tests/Klocation" c = kconfiglib.Config(kl) def assert_file_and_locations(filename, linenrs, tuples): for f, l in tuples: assert_true(f == filename, f) assert_true(l == linenrs.pop(0), "!!!") assert_file_and_locations(kl, [2, 14], c["A"].get_def_locations()) assert_file_and_locations(kl, [5, 6, 18, 19], c["A"].get_ref_locations()) assert_file_and_locations(kl, [7], c.get_choices()[0].get_def_locations()) assert_file_and_locations(kl, [4], [c.get_menus()[0].get_location()]) assert_file_and_locations(kl, [16], [c.get_comments()[0].get_location()]) assert_equals(c["NOT_DEFINED"].get_def_locations(), []) assert_file_and_locations(kl, [6, 15], c["NOT_DEFINED"].get_ref_locations()) # # Object relations # c = kconfiglib.Config("Kconfiglib/tests/Krelation") A, B, C, D, E, F, G, H, I = c["A"], c["B"], c["C"], c["D"], c["E"], c["F"],\ c["G"], c["H"], c["I"] choice_1, choice_2 = c.get_choices() assert_true([menu.get_title() for menu in c.get_menus()] == ["m1", "m2", "m3", "m4"], "menu ordering is broken") menu_1, menu_2, menu_3, menu_4 = c.get_menus() print "Testing object relations..." assert_true(A.get_parent() is None, "A should not have a parent") assert_true(B.get_parent() is choice_1, "B's parent should be the first choice") assert_true(E.get_parent() is menu_1, "E's parent should be the first menu") assert_true(c["E"].get_parent().get_parent() is None, "E's grandparent should be None") assert_true(c["G"].get_parent() is choice_2, "G's parent should be the second choice") assert_true(c["G"].get_parent().get_parent() is menu_2, "G's grandparent should be the second menu") # # Object fetching (same test file) # print "Testing object fetching..." assert_equals(c.get_symbol("NON_EXISTENT"), None) assert_true(c.get_symbol("A") is A, "get_symbol() is broken") assert_true(c.get_top_level_items() == [A, choice_1, menu_1, menu_3, menu_4], "Wrong items at top level") assert_true(c.get_symbols(False) == [A, B, C, D, E, F, G, H, I], "get_symbols() is broken") assert_true(choice_1.get_items() == [B, C, D], "Wrong get_items() items in 'choice'") # Test Kconfig quirk assert_true(choice_1.get_actual_items() == [B, D], "Wrong get_actual_items() items in 'choice'") assert_true(menu_1.get_items() == [E, menu_2, I], "Wrong items in first menu") assert_true(menu_1.get_symbols() == [E, I], "Wrong symbols in first menu") assert_true(menu_1.get_items(True) == [E, menu_2, F, choice_2, G, H, I], "Wrong recursive items in first menu") assert_true(menu_1.get_symbols(True) == [E, F, G, H, I], "Wrong recursive symbols in first menu") assert_true(menu_2.get_items() == [F, choice_2], "Wrong items in second menu") assert_true(menu_2.get_symbols() == [F], "Wrong symbols in second menu") assert_true(menu_2.get_items(True) == [F, choice_2, G, H], "Wrong recursive items in second menu") assert_true(menu_2.get_symbols(True) == [F, G, H], "Wrong recursive symbols in second menu") print def run_compatibility_tests(): """Runs tests on configurations from the kernel. Tests compability with the C implementation by comparing outputs.""" print "Running compatibility tests...\n" # The set of tests that want to run for all architectures in the kernel # tree -- currently, all tests. The boolean flag indicates whether .config # (generated by the C implementation) should be compared to ._config # (generated by us) after each invocation. all_arch_tests = [(test_config_absent, True), (test_all_no, True), (test_all_yes, True), (test_call_all, False), # Needs to report success/failure for each arch/defconfig # combo, hence False. (test_defconfig, False)] print "Loading Config instances for all architectures..." arch_configs = get_arch_configs() for (test_fn, compare_configs) in all_arch_tests: print "Resetting all architecture Config instances prior to next test..." for arch in arch_configs: arch.reset() # The test description is taken from the docstring of the corresponding # function print textwrap.dedent(test_fn.__doc__) for conf in arch_configs: rm_configs() # This should be set correctly for any 'make *config' commands the # test might run. SRCARCH is selected automatically from ARCH, so # we don't need to set that. os.environ["ARCH"] = conf.get_arch() # This won't get set for us in speedy mode if speedy_mode: os.environ["SRCARCH"] = conf.get_srcarch() test_fn(conf) if compare_configs: sys.stdout.write(" {0:<14}".format(conf.get_arch())) if equal_confs(): print "OK" else: print "FAIL" fail() print "" if all_ok(): print "All OK" print nconfigs, "arch/defconfig pairs tested" else: print "Some tests failed" def get_arch_configs(): """Returns a list with Config instances corresponding to all arch Kconfigs.""" # TODO: Could this be made more robust across kernel versions by checking # for the existence of particular arches? def add_arch(ARCH, res): os.environ["SRCARCH"] = archdir os.environ["ARCH"] = ARCH res.append(kconfiglib.Config(base_dir = ".")) res = [] for archdir in os.listdir("arch"): # No longer broken as of 3.7.0-rc8 #if archdir == "h8300": # Broken Kconfig as of Linux 2.6.38-rc3 #continue if os.path.exists(os.path.join("arch", archdir, "Kconfig")): add_arch(archdir, res) # Some arches define additional ARCH settings with ARCH != SRCARCH. # (Search for "Additional ARCH settings for" in the Makefile.) We # test those as well. if archdir == "x86": add_arch("i386", res) add_arch("x86_64", res) elif archdir == "sparc": add_arch("sparc32", res) add_arch("sparc64", res) elif archdir == "sh": add_arch("sh64", res) elif archdir == "tile": add_arch("tilepro", res) add_arch("tilegx", res) # Don't want subsequent 'make *config' commands in tests to see this del os.environ["ARCH"] del os.environ["SRCARCH"] return res # The weird docstring formatting is to get the format right when we print the # docstring ourselves def test_all_no(conf): """ Test if our examples/allnoconfig.py script generates the same .config as 'make allnoconfig' for each architecture. Runs the script via 'make scriptconfig' and needs to reparse the configurations, so kinda slow even in speedy mode.""" # TODO: Support speedy mode for running the script shell("make scriptconfig SCRIPT=Kconfiglib/examples/allnoconfig.py") shell("mv .config ._config") if speedy_mode: shell("scripts/kconfig/conf --allnoconfig Kconfig") else: shell("make allnoconfig") def test_all_yes(conf): """ Test if our examples/allyesconfig.py script generates the same .config as 'make allyesconfig' for each architecture. Runs the script via 'make scriptconfig' and needs to reparse the configurations, so kinda slow even in speedy mode.""" # TODO: Support speedy mode for running the script shell("make scriptconfig SCRIPT=Kconfiglib/examples/allyesconfig.py") shell("mv .config ._config") if speedy_mode: shell("scripts/kconfig/conf --allyesconfig Kconfig") else: shell("make allyesconfig") def test_call_all(conf): """ Call all public methods on all symbols, menus, choices and comments (nearly all public methods: some are hard to test like this, but are exercised by other tests) for all architectures to make sure we never crash or hang. Also do misc. sanity checks.""" print " For {0}...".format(conf.get_arch()) conf.get_arch() conf.get_srcarch() conf.get_srctree() conf.get_config_filename() conf.get_defconfig_filename() conf.get_top_level_items() conf.eval("y && ARCH") # Syntax error caught_exception = False try: conf.eval("y && && y") except kconfiglib.Kconfig_Syntax_Error: caught_exception = True if not caught_exception: fail("No exception generated for expression with syntax error") conf.get_config_header() conf.get_base_dir() conf.reset() conf.get_symbols(False) conf.get_mainmenu_text() for s in conf.get_symbols(): s.reset() s.calc_value() s.calc_default_value() s.get_user_value() s.get_name() s.get_upper_bound() s.get_lower_bound() s.get_assignable_values() s.get_type() s.get_visibility() s.get_parent() s.get_sibling_symbols() s.get_sibling_items() s.get_referenced_symbols() s.get_referenced_symbols(True) s.get_selected_symbols() s.get_help() s.get_config() # Check get_ref/def_location() sanity if s.is_special(): if s.is_from_environment(): # Special symbols from the environment should have define # locations if s.get_def_locations() == []: fail("The symbol '{0}' is from the environment but " "lacks define locations".format(s.get_name())) else: # Special symbols that are not from the environment should be # defined and have no define locations if not s.is_defined(): fail("The special symbol '{0}' is not defined". format(s.get_name())) if not s.get_def_locations() == []: fail("The special symbol '{0}' has recorded def. "\ "locations".format(s.get_name())) else: # Non-special symbols should have define locations iff they are # defined if s.is_defined(): if s.get_def_locations() == []: fail("'{0}' defined but lacks recorded locations".\ format(s.get_name())) else: if s.get_def_locations() != []: fail("'{0}' undefined but has recorded locations".\ format(s.get_name())) if s.get_ref_locations() == []: fail("'{0}' both undefined and unreferenced".\ format(s.get_name())) s.get_ref_locations() s.is_modifiable() s.is_defined() s.is_from_environment() s.has_ranges() s.is_choice_item() s.is_choice_selection() s.__str__() for c in conf.get_choices(): c.get_name() c.get_selection() c.get_selection_from_defaults() c.get_user_selection() c.get_type() c.get_name() c.get_items() c.get_actual_items() c.get_parent() c.get_referenced_symbols() c.get_referenced_symbols(True) c.get_def_locations() c.get_visibility() c.calc_mode() c.is_optional() c.__str__() for m in conf.get_menus(): m.get_items() m.get_symbols(False) m.get_symbols(True) m.get_depends_on_visibility() m.get_visible_if_visibility() m.get_title() m.get_parent() m.get_referenced_symbols() m.get_referenced_symbols(True) m.get_location() m.__str__() for c in conf.get_comments(): c.get_text() c.get_parent() c.get_referenced_symbols() c.get_referenced_symbols(True) c.get_location() c.__str__() def test_config_absent(conf): """ Test if kconfiglib generates the same configuration as 'make alldefconfig' for each architecture.""" conf.write_config("._config") if speedy_mode: shell("scripts/kconfig/conf --alldefconfig Kconfig") else: shell("make alldefconfig") def test_defconfig(conf): """ Test if kconfiglib generates the same .config as scripts/kconfig/conf for each architecture/defconfig pair. In obsessive mode, this test includes nonsensical groupings of arches with defconfigs from other arches (every arch/defconfig combination) and takes hours to run. This test appends any failures to a file test_defconfig_fails in the root.""" global nconfigs defconfigs = [] def add_configs_for_arch(arch): arch_dir = os.path.join("arch", arch) # Some arches have a "defconfig" in the root of their arch// # directory root_defconfig = os.path.join(arch_dir, "defconfig") if os.path.exists(root_defconfig): defconfigs.append(root_defconfig) # Assume all files in the arch//configs directory (if it # exists) are configurations defconfigs_dir = os.path.join(arch_dir, "configs") if not os.path.exists(defconfigs_dir): return if not os.path.isdir(defconfigs_dir): print "Warning: '{0}' is not a directory - skipping"\ .format(defconfigs_dir) return for dirpath, dirnames, filenames in os.walk(defconfigs_dir): for filename in filenames: defconfigs.append(os.path.join(dirpath, filename)) if obsessive_mode: # Collect all defconfigs. This could be done once instead, but it's # a speedy operation comparatively. for arch in os.listdir("arch"): add_configs_for_arch(arch) else: add_configs_for_arch(conf.get_arch()) # Test architecture for each defconfig for defconfig in defconfigs: rm_configs() nconfigs += 1 conf.load_config(defconfig) conf.write_config("._config") if speedy_mode: shell("scripts/kconfig/conf --defconfig='{0}' Kconfig".\ format(defconfig)) else: shell("cp {0} .config".format(defconfig)) # It would be a bit neater if we could use 'make *_defconfig' # here (for example, 'make i386_defconfig' loads # arch/x86/configs/i386_defconfig' if ARCH = x86/i386/x86_64), # but that wouldn't let us test nonsensical combinations of # arches and defconfigs, which is a nice way to find obscure # bugs. shell("make kconfiglibtestconfig") sys.stdout.write(" {0:<14}with {1:<60} ". format(conf.get_arch(), defconfig)) if equal_confs(): print "OK" else: print "FAIL" fail() if log_mode: with open("test_defconfig_fails", "a") as fail_log: fail_log.write("{0} {1} with {2} did not match\n" .format(time.strftime("%d %b %Y %H:%M:%S", time.localtime()), conf.get_arch(), defconfig)) # # Helper functions # devnull = open(os.devnull, "w") def shell(cmd): subprocess.call(cmd, shell = True, stdout = devnull, stderr = devnull) def rm_configs(): """Delete any old ".config" (generated by the C implementation) and "._config" (generated by us), if present.""" def rm_if_exists(f): if os.path.exists(f): os.remove(f) rm_if_exists(".config") rm_if_exists("._config") def equal_confs(): with open(".config") as menu_conf: l1 = menu_conf.readlines() with open("._config") as my_conf: l2 = my_conf.readlines() # Skip the header generated by 'conf' unset_re = r"# CONFIG_(\w+) is not set" i = 0 for line in l1: if not line.startswith("#") or \ re.match(unset_re, line): break i += 1 return (l1[i:] == l2) _all_ok = True def assert_true(cond, msg): """Fails and prints 'msg' if 'conf' is False.""" if not cond: fail(msg) def assert_false(cond, msg): """Fails and prints 'msg' if 'conf' is True.""" if cond: fail(msg) def assert_equals(x, y): """Fails if 'x' does not equal 'y'.""" if x != y: fail("'{0}' does not equal '{1}'".format(x, y)) def fail(msg = None): global _all_ok if msg is not None: print "Fail: " + msg _all_ok = False def all_ok(): return _all_ok if __name__ == "__main__": run_tests()