# HG changeset patch # User Maxim Dounin # Date 1268270268 -10800 # Node ID c4021ebb41b6287066ead490f09789356d4b9d2d # Parent 342b31c8f3af74e162b353685a04283ebf772f7f Tests: rewrite README to be more complete. diff --git a/README b/README --- a/README +++ b/README @@ -3,20 +3,37 @@ Test suite for nginx. Use prove to run tests as one usually do for perl tests. Individual tests may be run as well. -Tests assume that nginx sources are in directory nginx at the same level -as directory with tests, and nginx was already configured and built (i.e. -nginx binary available as ../nginx/objs/nginx from test directory). +Note: tests run nginx (and backend daemons if needed) listening on localhost +and may use various ports in 8000 .. 8999 range. + +Usage: + + $ TEST_NGINX_BINARY=/path/to/nginx prove . -Note: some tests may fail since they are for bugs not fixed in public code. +By default tests expect nginx binary to be at ../nginx/objs/nginx. + +Environment variables: + +TEST_NGINX_BINARY + + Sets path to nginx binary to be tested, defaults to "../nginx/objs/nginx". + +TEST_NGINX_VERBOSE -Note: tests run nginx (and backend daemons if needed) listening on localhost. -Currently this includes following ports: 8025, 8026, 8080, 8081, 8110, 8111, -8143, 8144. + Be a bit more verbose (in particular, print requests sent and responses + got from nginx). Note that this requires prove -v (or HARNESS_VERBOSE). + +TEST_NGINX_LEAVE + + If set temporary directory with configs and logs won't be deleted on test + completion. Usefull for debugging. -Tests for memcached required memcached itself and Cache::Memcached to be -installed. +TEST_NGINX_CATLOG + + Cat error log to stdout after test completion. Usefull for debugging. -Currently each test creates it's own temporary directory and uses it for -logs etc. One may instruct tests not to remove the temp directory (e.g. -for analysis of failed test) by setting TEST_NGINX_LEAVE environment -variable. +TEST_NGINX_UNSAFE + + Run unsafe tests. + +Happy testing!