summaryrefslogtreecommitdiff
path: root/cmdtests/README.txt
diff options
context:
space:
mode:
authorVirgil Dupras <hsoft@hardcoded.net>2018-08-15 10:26:51 -0400
committerVirgil Dupras <hsoft@hardcoded.net>2018-08-15 10:26:51 -0400
commite046d875a0bc655c522fc30760e61c8b2b3408d8 (patch)
treefbe3276280258bbe9414b47b1282483bd8a40384 /cmdtests/README.txt
parent8d0df18f0275376a5c7e6c133abaa99e7c05b737 (diff)
downloadgentoolkit-e046d875a0bc655c522fc30760e61c8b2b3408d8.tar.gz
Add functional tests through "cmdtests"
These tests run a list of commands on both the system gentoolkit and the source from the active work directory, and then compares the results. It's a great way to verify that a refactoring didn't introduce an unwanted change in behavior.
Diffstat (limited to 'cmdtests/README.txt')
-rw-r--r--cmdtests/README.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/cmdtests/README.txt b/cmdtests/README.txt
new file mode 100644
index 0000000..192a7fc
--- /dev/null
+++ b/cmdtests/README.txt
@@ -0,0 +1,16 @@
+Use the "runtests.sh" script to test the output of all commands in "cmds.txt"
+against the output that the version of gentoolkit installed on the system
+yields.
+
+It's a great way to verify that a refactoring didn't affect output.
+
+Usage:
+
+$ cd cmdtests
+$ ./runtests.sh
+
+You can also test against a specific version of gentoolkit instead. Clone a
+copy of gentoolkit to test against and then do:
+
+$ cd cmdtests
+$ ./runtests.sh /path/to/othergentoolkit/pym