notmuch/test
Tomi Ollila 2593df5271 test/basic: replaced find -perm +111 with portable alternative
The find option syntax `-perm +111` is deprecated gnu find feature.
The replacement `( -perm -100 -o -perm -10 -o -perm 1 )` should also
work outside of the GNU domain.
2013-06-24 22:49:51 -07:00
..
corpus/cur test: add two new messages to corpus with iso-8859-1 encoding 2011-12-31 23:04:01 -04:00
emacs-show.expected-output test: Move tests from emacs to emacs-show 2012-10-18 08:45:16 -03:00
emacs.expected-output test: emacs: new tests "notmuch-show: {, un}collapse all messages in thread" 2012-10-20 12:10:24 -03:00
test.expected-output test: Better handling of stdout and stderr 2010-11-16 11:28:06 -08:00
valgrind test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability 2011-05-27 14:03:28 -07:00
.gitignore Adding parse-time to test/.gitignore 2012-12-06 17:14:24 -04:00
aggregate-results.sh test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability 2011-05-27 14:03:28 -07:00
arg-test.c test: fix an evident copy-paste error in argument parsing test 2012-12-04 09:07:32 -04:00
argument-parsing test: fix an evident copy-paste error in argument parsing test 2012-12-04 09:07:32 -04:00
atomicity test/atomicity: use a more portable 'cp' form 2012-09-01 23:17:10 -03:00
atomicity.gdb test: Test atomicity of notmuch new. 2011-09-12 23:36:00 -03:00
author-order test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability 2011-05-27 14:03:28 -07:00
basic test/basic: replaced find -perm +111 with portable alternative 2013-06-24 22:49:51 -07:00
config cli: config: do not overwrite symlinks when saving config file 2013-04-14 18:38:07 -03:00
count test: notmuch count --batch and --input options 2013-04-01 09:38:48 -04:00
crypto test: conform to content length, encoding fields 2012-12-17 09:11:57 -04:00
database-test.c test: add database routines for testing 2012-12-02 15:51:32 -04:00
database-test.h test: add database routines for testing 2012-12-02 15:51:32 -04:00
dump-restore dump/restore: Use Xapian queries for batch-tag format 2013-01-06 22:40:32 -04:00
emacs emacs: Use streaming S-expr parser for search 2013-06-01 09:00:40 -03:00
emacs-address-cleaning test: always source test-lib.sh as ./test-lib.sh 2012-11-24 22:07:46 -04:00
emacs-address-cleaning.el emacs: More address cleaning. 2012-02-03 21:24:48 -04:00
emacs-hello test: always source test-lib.sh as ./test-lib.sh 2012-11-24 22:07:46 -04:00
emacs-large-search-buffer test: Remove extraneous Emacs error handling test 2013-06-01 08:53:19 -03:00
emacs-show emacs: Use the minibuffer for CLI error reporting 2013-01-06 22:47:35 -04:00
emacs-subject-to-filename test: Don't print 'nil' at the beginning of emacs-subject-to-filename 2012-11-29 09:24:12 -04:00
emacs-test-functions test: always source test-lib.sh as ./test-lib.sh 2012-11-24 22:07:46 -04:00
encoding test: use subtest name for generated message subject by default 2012-03-18 09:14:22 -03:00
excludes test: add tests for search --exclude=all 2013-05-13 21:32:46 -03:00
from-guessing test: whitespace-cleanup for most test/* files 2012-01-22 09:12:12 -04:00
gnupg-secret-key.asc test: add crypto tests for signature verification and decryption 2011-05-27 16:22:00 -07:00
gnupg-secret-key.NOTE test: add crypto tests for signature verification and decryption 2011-05-27 16:22:00 -07:00
help-test test: added --stderr=FILE tests 2013-05-29 20:01:38 -03:00
hex-escaping test/hex-escaping: new test for hex escaping routines 2012-12-02 15:51:32 -04:00
hex-xcode.c test/hex-xcode: new test binary 2012-12-02 09:14:59 -04:00
hooks test: add tests for hooks 2011-12-11 13:59:39 -04:00
json test: conform to content length, encoding fields 2012-12-17 09:11:57 -04:00
long-id test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability 2011-05-27 14:03:28 -07:00
maildir-sync notmuch-restore: replace positional argument for input with option 2012-08-06 08:52:45 -03:00
Makefile fix sum moar typos [build scripts, Makefiles] 2011-06-23 15:44:59 -07:00
Makefile.local Changing build tool for test/random-corpus to CXX instead of CC. 2012-12-06 17:14:36 -04:00
missing-headers sprinters: bugfix when NULL passed for a string. 2012-08-12 21:25:01 +02:00
multipart test: conform to content length, encoding fields 2012-12-17 09:11:57 -04:00
new new: Skip ignored broken symlinks 2012-11-26 22:17:20 -04:00
notmuch-test test: add tests for the handling of References and In-Reply-To headers 2013-05-13 21:27:01 -03:00
parse-time-string test: add smoke tests for the date/time parser module 2012-10-31 16:50:57 -03:00
parse-time.c test: add new test tool parse-time for date/time parser 2012-10-31 16:44:55 -03:00
python python: Remove find_message_by_filename workaround 2012-05-23 22:32:02 -03:00
random-corpus.c cli: config: make notmuch_config_open() "is new" parameter input only 2013-03-07 09:39:12 -04:00
raw test: remove "Generate some messages" test from raw 2012-03-18 09:14:22 -03:00
README test/README: mention the test_expect_equal_json and *sanitize* functions 2013-03-07 09:38:26 -04:00
reply test: add tests for notmuch reply From guessing 2012-05-24 21:56:35 -03:00
reply-to-sender test: add tests for "notmuch reply" --reply-to=sender 2012-01-14 11:11:18 -04:00
search test: add some exclude tests 2012-04-07 23:06:21 -03:00
search-by-folder test: Nix increment_mtime. 2011-06-29 15:26:45 -07:00
search-date test: add tests for date:since..until range queries 2012-10-31 17:14:07 -03:00
search-folder-coherence test: use subtest name for generated message subject by default 2012-03-18 09:14:22 -03:00
search-insufficient-from-quoting Update some more recent tests to use /usr/bin/env to find bash 2011-05-27 14:08:04 -07:00
search-limiting test: add tests for notmuch search --offset and --limit 2011-11-15 19:25:58 -04:00
search-output test: Uniformly canonicalize actual and expected JSON 2012-08-03 20:14:47 -03:00
search-position-overlap-bug test: whitespace-cleanup for most test/* files 2012-01-22 09:12:12 -04:00
setup cli: config: fix config file save when the file does not exist 2013-05-12 07:46:44 -03:00
sexp test: conform to content length, encoding fields 2012-12-17 09:11:57 -04:00
smtp-dummy.c test/smtp-dummy: add --background option and functionality 2012-10-20 17:45:52 -03:00
symbol-hiding test: whitespace-cleanup for most test/* files 2012-01-22 09:12:12 -04:00
symbol-test.cc lib/cli: Make notmuch_database_open return a status code 2012-05-05 10:11:57 -03:00
tagging test: notmuch tag --remove-all 2013-03-30 18:34:22 -04:00
test-lib-common.sh test: factor out part of test-lib.sh into test-lib-common.sh 2012-11-25 21:11:59 -04:00
test-lib.el test: delay watchdog checks in emacs. 2013-01-29 19:17:07 -04:00
test-lib.sh test/test-lib.sh: separate signaled exit 2013-02-18 20:17:17 -04:00
test-verbose test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability 2011-05-27 14:03:28 -07:00
text test: notmuch search --format=text0 2012-12-18 17:04:17 -04:00
thread-naming test: update tests to reflect the exclude flag 2012-03-02 08:35:02 -04:00
thread-order test: change "#!/bin/bash" to "#!/usr/bin/env bash" enhances portability 2011-05-27 14:03:28 -07:00
thread-replies lib/database.cc: change how the parent of a message is calculated 2013-05-13 21:29:13 -03:00
uuencode fix sum moar typos [test-case data] 2011-06-23 15:59:11 -07:00

Notmuch test suite
==================
This directory contains the test suite for notmuch.

When fixing bugs or enhancing notmuch, you are strongly encouraged to
add tests in this directory to cover what you are trying to fix or
enhance.

Prerequisites
-------------
Some tests require external dependencies to run. Without them, they
will be skipped, or (rarely) marked failed. Please install these, so
that you know if you break anything.

  - dtach(1)
  - emacs(1)
  - emacsclient(1)
  - gdb(1)
  - gpg(1)
  - python(1)

Running Tests
-------------
The easiest way to run tests is to say "make test", (or simply run the
notmuch-test script). Either command will run all available tests.

Alternately, you can run a specific subset of tests by simply invoking
one of the executable scripts in this directory, (such as ./search,
./reply, etc). Note that you will probably want "make test-binaries"
before running individual tests.

The following command-line options are available when running tests:

--debug::
	This may help the person who is developing a new test.
	It causes the command defined with test_debug to run.

--immediate::
	This causes the test to immediately exit upon the first
	failed test.

--valgrind::
	Execute notmuch with valgrind and exit with status
	126 on errors (just like regular tests, this will only stop
	the test script when running under -i).  Valgrind errors
	go to stderr, so you might want to pass the -v option, too.

	Since it makes no sense to run the tests with --valgrind and
	not see any output, this option implies --verbose.  For
	convenience, it also implies --tee.

--tee::
	In addition to printing the test output to the terminal,
	write it to files named 't/test-results/$TEST_NAME.out'.
	As the names depend on the tests' file names, it is safe to
	run the tests with this option in parallel.

--root=<dir>::
	This runs the testsuites specified under a separate directory.
	However, caution is advised, as not all tests are maintained
	with this relocation in mind, so some tests may behave
	differently.

	Pointing this argument at a tmpfs filesystem can improve the
	speed of the test suite for some users.

When invoking the test suite via "make test" any of the above options
can be specified as follows:

	make test OPTIONS="--verbose"

You can choose an emacs binary (and corresponding emacsclient) to run
the tests in one of the following ways.

	TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test
	TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs
	make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient

Skipping Tests
--------------
If, for any reason, you need to skip one or more tests, you can do so
by setting the NOTMUCH_SKIP_TESTS variable to the name of one or more
sections of tests.

For example:

    $ NOTMUCH_SKIP_TESTS="search reply" make test

Even more fine-grained skipping is possible by appending a test number
(or glob pattern) after the section name. For example, the first
search test and the second reply test could be skipped with:

    $ NOTMUCH_SKIP_TESTS="search.1 reply.2" make test

Note that some tests in the existing test suite rely on previous test
items, so you cannot arbitrarily skip any test and expect the
remaining tests to be unaffected.

Writing Tests
-------------
The test script is written as a shell script.  It should start with
the standard "#!/usr/bin/env bash" with copyright notices, and an
assignment to variable 'test_description', like this:

	#!/usr/bin/env bash
	#
	# Copyright (c) 2005 Junio C Hamano
	#

	test_description='xxx test (option --frotz)

	This test exercises the "notmuch xxx" command when
	given the option --frotz.'

Source 'test-lib.sh'
--------------------
After assigning test_description, the test script should source
test-lib.sh like this:

	. ./test-lib.sh

This test harness library does the following things:

 - If the script is invoked with command line argument --help
   (or -h), it shows the test_description and exits.

 - Creates a temporary directory with default notmuch-config and a
   mail store with a corpus of mail, (initially, 50 early messages
   sent to the notmuch list). This directory is
   test/tmp.<test-basename>. The path to notmuch-config is exported in
   NOTMUCH_CONFIG environment variable and mail store path is stored
   in MAIL_DIR variable.

 - Defines standard test helper functions for your scripts to
   use.  These functions are designed to make all scripts behave
   consistently when command line arguments --verbose (or -v),
   --debug (or -d), and --immediate (or -i) is given.

End with test_done
------------------
Your script will be a sequence of tests, using helper functions
from the test harness library.  At the end of the script, call
'test_done'.

Test harness library
--------------------
There are a handful helper functions defined in the test harness
library for your script to use.

 test_expect_success <message> <script>

   This takes two strings as parameter, and evaluates the
   <script>.  If it yields success, test is considered
   successful.  <message> should state what it is testing.

 test_begin_subtest <message>

   Set the test description message for a subsequent test_expect_equal
   invocation (see below).

 test_subtest_known_broken

   Mark the current test as broken.  Such tests are expected to fail.
   Unlike the normal tests, which say "PASS" on success and "FAIL" on
   failure, these will say "FIXED" on success and "BROKEN" on failure.
   Failures from these tests won't cause -i (immediate) to stop.  A
   test must call this before any test_expect_* function.

 test_expect_equal <output> <expected>

   This is an often-used convenience function built on top of
   test_expect_success. It uses the message from the last
   test_begin_subtest call, so call before calling
   test_expect_equal. This function generates a successful test if
   both the <output> and <expected> strings are identical. If not, it
   will generate a failure and print the difference of the two
   strings.

 test_expect_equal_file <file1> <file2>

   Identical to test_expect_equal, except that <file1> and <file2>
   are files instead of strings.  This is a much more robust method to
   compare formatted textual information, since it also notices
   whitespace and closing newline differences.

 test_expect_equal_json <output> <expected>

   Identical to test_expect_equal, except that the two strings are
   treated as JSON and canonicalized before equality testing.  This is
   useful to abstract away from whitespace differences in the expected
   output and that generated by running a notmuch command.

 test_debug <script>

   This takes a single argument, <script>, and evaluates it only
   when the test script is started with --debug command line
   argument.  This is primarily meant for use during the
   development of a new test script.

 test_emacs <emacs-lisp-expressions>

   This function executes the provided emacs lisp script within
   emacs. The script can be a sequence of emacs lisp expressions,
   (that is, they will be evaluated within a progn form). Emacs
   stdout and stderr is not available, the common way to get output
   is to save it to a file. There are some auxiliary functions
   useful in emacs tests provided in test-lib.el. Do not use `setq'
   for setting variables in Emacs tests because it affects other
   tests that may run in the same Emacs instance.  Use `let' instead
   so the scope of the changed variables is limited to a single test.

 test_emacs_expect_t <emacs-lisp-expressions>

  This function executes the provided emacs lisp script within
  emacs in a manner similar to 'test_emacs'. The expressions should
  return the value `t' to indicate that the test has passed. If the
  test does not return `t' then it is considered failed and all data
  returned by the test is reported to the tester.

 test_done

   Your test script must have test_done at the end.  Its purpose
   is to summarize successes and failures in the test script and
   exit with an appropriate error code.

There are also a number of notmuch-specific auxiliary functions and
variables which are useful in writing tests:

  generate_message

    Generates a message with an optional template. Most tests will
    actually prefer to call add_message. See below.

  add_message

    Generate a message and add it to the database (by calling "notmuch
    new"). It is sufficient to simply call add_message with no
    arguments if you don't care about the content of the message. If
    more control is needed, arguments can be provide to specify many
    different header values for the new message. See the documentation
    within test-lib.sh or refer to many example calls within existing
    tests.

  add_email_corpus

    This function should be called at the beginning of a test file
    when a test needs to operate on a non-empty body of messages. It
    will initialize the mail database to a known state of 50 sample
    messages, (culled from the early history of the notmuch mailing
    list).

  notmuch_counter_reset
  $notmuch_counter_command
  notmuch_counter_value

    These allow to count how many times notmuch binary is called.
    notmuch_counter_reset() function generates a script that counts
    how many times it is called and resets the counter to zero.  The
    function sets $notmuch_counter_command variable to the path to the
    generated script that should be called instead of notmuch to do
    the counting.  The notmuch_counter_value() function prints the
    current counter value.

There are also functions which remove various environment-dependent
values from notmuch output; these are useful to ensure that test
results remain consistent across different machines.

 notmuch_search_sanitize
 notmuch_show_sanitize
 notmuch_show_sanitize_all
 notmuch_json_show_sanitize

   All these functions should receive the text to be sanitized as the
   input of a pipe, e.g.
   output=`notmuch search "..." | notmuch_search_sanitize`