Joey Adams rightly points out that the current keys are a mess: ideally the
filenames, test keys and structure names in ccanlint should be the same.
First step is to make the test names all regular, of basic form <noun>_<verb>
(eg "tests_exist" rather than "has-tests").
25 files changed:
*
* Ccanlint:
* // valgrind breaks fcntl locks.
*
* Ccanlint:
* // valgrind breaks fcntl locks.
+ * tests_pass_valgrind FAIL
*/
int main(int argc, char *argv[])
{
*/
int main(int argc, char *argv[])
{
*
* Ccanlint:
* // hash fails because it accesses data in 4 byte quantities for speed.
*
* Ccanlint:
* // hash fails because it accesses data in 4 byte quantities for speed.
- * valgrind-tests --partial-loads-ok=yes
+ * tests_pass_valgrind --partial-loads-ok=yes
*/
int main(int argc, char *argv[])
{
*/
int main(int argc, char *argv[])
{
}
struct ccanlint build = {
}
struct ccanlint build = {
+ .key = "module_builds",
.name = "Module can be built from object files",
.check = do_build,
.can_run = can_build,
.name = "Module can be built from object files",
.check = do_build,
.can_run = can_build,
}
struct ccanlint build_objs = {
}
struct ccanlint build_objs = {
- .key = "build-objects",
+ .key = "objects_build",
.name = "Module object files can be built",
.check = check_objs_build,
.can_run = can_build,
.name = "Module object files can be built",
.check = check_objs_build,
.can_run = can_build,
}
struct ccanlint check_build = {
}
struct ccanlint check_build = {
.name = "Module can be linked against trivial program",
.check = check_use_build,
.can_run = can_build,
.name = "Module can be linked against trivial program",
.check = check_use_build,
.can_run = can_build,
}
struct ccanlint depends_built = {
}
struct ccanlint depends_built = {
- .key = "depends-built",
+ .key = "depends_build",
.name = "Module's CCAN dependencies can be found or built",
.check = check_depends_built,
.can_run = can_build,
.name = "Module's CCAN dependencies can be found or built",
.check = check_depends_built,
.can_run = can_build,
}
struct ccanlint depends_exist = {
}
struct ccanlint depends_exist = {
- .key = "depends-exist",
- .name = "Module's CCAN dependencies are present",
+ .key = "depends_exist",
+ .name = "Module's CCAN dependencies can be found",
.check = check_depends_exist,
};
.check = check_depends_exist,
};
}
struct ccanlint includes_build = {
}
struct ccanlint includes_build = {
+ .key = "main_header_compiles",
.name = "Modules main header compiles",
.check = check_includes_build,
.can_run = can_build,
.name = "Modules main header compiles",
.check = check_includes_build,
.can_run = can_build,
}
struct ccanlint has_info = {
}
struct ccanlint has_info = {
.name = "Module has _info file",
.check = check_has_info,
.handle = create_info_template,
.name = "Module has _info file",
.check = check_has_info,
.handle = create_info_template,
}
struct ccanlint has_main_header = {
}
struct ccanlint has_main_header = {
- .key = "has-main-header",
+ .key = "main_header_exists",
.name = "Module has main header file",
.check = check_has_main_header,
};
.name = "Module has main header file",
.check = check_has_main_header,
};
}
struct ccanlint compile_coverage_tests = {
}
struct ccanlint compile_coverage_tests = {
- .key = "compile-coverage-tests",
- .name = "Module tests compile with profiling",
+ .key = "tests_compile_coverage",
+ .name = "Module tests compile with " COVERAGE_CFLAGS,
.check = do_compile_coverage_tests,
.can_run = can_run_coverage,
};
.check = do_compile_coverage_tests,
.can_run = can_run_coverage,
};
}
struct ccanlint compile_test_helpers = {
}
struct ccanlint compile_test_helpers = {
- .key = "compile-helpers",
+ .key = "tests_helpers_compile",
.name = "Module test helper objects compile",
.check = do_compile_test_helpers,
.can_run = can_run,
.name = "Module test helper objects compile",
.check = do_compile_test_helpers,
.can_run = can_run,
}
struct ccanlint compile_tests = {
}
struct ccanlint compile_tests = {
- .key = "compile-tests",
+ .key = "tests_compile",
.name = "Module tests compile",
.check = do_compile_tests,
.can_run = can_build,
.name = "Module tests compile",
.check = do_compile_tests,
.can_run = can_build,
}
struct ccanlint depends_accurate = {
}
struct ccanlint depends_accurate = {
- .key = "depends-accurate",
- .name = "Module's CCAN dependencies are the only ccan files #included",
+ .key = "depends_accurate",
+ .name = "Module's CCAN dependencies are the only CCAN files #included",
.check = check_depends_accurate,
};
.check = check_depends_accurate,
};
}
struct ccanlint examples_compile = {
}
struct ccanlint examples_compile = {
- .key = "examples-compile",
+ .key = "examples_compile",
.name = "Module examples compile",
.check = build_examples,
.can_run = can_run,
.name = "Module examples compile",
.check = build_examples,
.can_run = can_run,
}
struct ccanlint examples_run = {
}
struct ccanlint examples_run = {
.name = "Module examples with expected output give that output",
.check = run_examples,
.can_run = can_run,
.name = "Module examples with expected output give that output",
.check = run_examples,
.can_run = can_run,
}
struct ccanlint has_examples = {
}
struct ccanlint has_examples = {
- .key = "has-examples",
- .name = "_info and header files have examples",
+ .key = "examples_exist",
+ .name = "_info and main header file have Example: sections",
.check = extract_examples,
};
.check = extract_examples,
};
}
struct ccanlint has_info_documentation = {
}
struct ccanlint has_info_documentation = {
- .key = "info-documentation",
+ .key = "info_documentation_exists",
.name = "Module has documentation in _info",
.check = check_has_info_documentation,
};
.name = "Module has documentation in _info",
.check = check_has_info_documentation,
};
}
struct ccanlint has_tests = {
}
struct ccanlint has_tests = {
- .key = "has-tests",
- .name = "Module has tests",
+ .key = "tests_exist",
+ .name = "Module has test directory with tests in it",
.check = check_has_tests,
};
.check = check_has_tests,
};
}
struct ccanlint idempotent = {
}
struct ccanlint idempotent = {
+ .key = "headers_idempotent",
.name = "Module headers are #ifndef/#define wrapped",
.check = check_idempotent,
.handle = handle_idem,
.name = "Module headers are #ifndef/#define wrapped",
.check = check_idempotent,
.handle = handle_idem,
}
struct ccanlint has_license = {
}
struct ccanlint has_license = {
- .key = "has-license",
- .name = "Module has license",
+ .key = "license_exists",
+ .name = "Module has License: entry in _info, and LICENSE symlink/file",
.check = check_has_license,
};
.check = check_has_license,
};
}
struct ccanlint run_coverage_tests = {
}
struct ccanlint run_coverage_tests = {
- .key = "test-coverage",
- .name = "Code coverage of module tests",
+ .key = "tests_coverage",
+ .name = "Module's tests cover all the code",
.check = do_run_coverage_tests,
};
.check = do_run_coverage_tests,
};
}
struct ccanlint run_tests = {
}
struct ccanlint run_tests = {
.name = "Module's run and api tests pass",
.check = do_run_tests,
.handle = run_under_debugger,
.name = "Module's run and api tests pass",
.check = do_run_tests,
.handle = run_under_debugger,
}
struct ccanlint run_tests_vg = {
}
struct ccanlint run_tests_vg = {
- .key = "valgrind-tests",
+ .key = "tests_pass_valgrind",
.name = "Module's run and api tests succeed under valgrind",
.can_run = can_run_vg,
.check = do_run_tests_vg,
.name = "Module's run and api tests succeed under valgrind",
.can_run = can_run_vg,
.check = do_run_tests_vg,
REGISTER_TEST(run_tests_vg, &run_tests, NULL);
struct ccanlint run_tests_vg_leak = {
REGISTER_TEST(run_tests_vg, &run_tests, NULL);
struct ccanlint run_tests_vg_leak = {
- .key = "valgrind-leaks",
+ .key = "tests_pass_valgrind_noleaks",
.name = "Module's run and api tests leak memory",
.check = do_leakcheck_vg,
};
.name = "Module's run and api tests leak memory",
.check = do_leakcheck_vg,
};
}
struct ccanlint trailing_whitespace = {
}
struct ccanlint trailing_whitespace = {
- .key = "trailing-whitespace",
+ .key = "no_trailing_whitespace",
.name = "Module's source code has no trailing whitespace",
.check = check_trailing_whitespace,
};
.name = "Module's source code has no trailing whitespace",
.check = check_trailing_whitespace,
};
projects / ccan / commitdiff