From: Jan Safranek Date: Tue, 5 Apr 2011 06:22:18 +0000 (+0200) Subject: Added README for the tool test suite X-Git-Tag: v0.38~116 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d290b875fb303d30fa682b1d3abbb3609167568d;p=thirdparty%2Flibcgroup.git Added README for the tool test suite Added README for the tool test suite Changelog: - fixed spelling errors reported by Ivana Signed-off-by: Jan Safranek Acked-by: Ivana Hutarova Varekova --- diff --git a/tests/tools/README b/tests/tools/README new file mode 100644 index 00000000..ec4703ec --- /dev/null +++ b/tests/tools/README @@ -0,0 +1,35 @@ +libcgroup tools test suite +========================== + +These files should test libcgroup tools, not the libcgroup library itself! All +the tools use the library so it gets pretty well tested, but that's just a side +effect, not an intention. + +Usage +----- + +There are few requirements to run this test: + - !!! YOU MUST RUN THE TESTS AS ROOT !!! - the tests need to mount/unmount + stuff. The tests should not destroy anything important, but use a virtual + machine if possible, just to be sure. + - You must have no cgroup mounted (i.e. run cgclear before starting the test + suite). + - The tests require various tools to be present in $PATH or at the specified + location, among others: + diff, awk, su, /bin/bash, /bin/sleep + - The tests require that user and group named 'nobody' exists, some processes + with be started with its UID/GID. + - The tests mounts/unmounts cpu, cpuacct, freezer and net_cls controllers. + Make sure your kernel supports them. + +If you have met all above prerequisites just run 'make check' in this directory +as root. + +Design +------ +There is very simple testenv.sh script, which contains common functions for all +tests. It includes also simple example how to write a test. + +The tests themselves are just simple shell scripts, which either end with exit +status 0 (=success) or nonzero (=error). The tests should clean after themselves +(incl. unmounting all groups and removing all temp. files).