The following is provided as a reference for those interested in understanding
how the test suite works, and how to add and maintain tests.

Overview of types of tests
==========================

Darcs has tests in two formats.  Unit tests that directly test Haskell
functions are written in Haskell and live in src/unit.lhs.  Functional
tests that test the darcs binary are written in Shell and live in
tests/. Additionally, there are some functional tests which are
expected to fail, kept in bugs/ and used for documenting bugs and ToDos.

Haskell tests
--------------------------

These are QuickCheck tests primarily testing the Darcs core.

Shell tests
---------------------------

Shell tests are useful because they are easy to create from a copy/paste
of actual shell commands executed. They are considered successful if no
bad exit codes are returned from the commands in the script.

How to run tests
=============================

"make unit" builds the unit tests, "./unit" runs them. They take a while.
Output like "good" and "OK, passed 100 tests." is good. Output like
"*** Gave up! Passed only n tests." is a shortage of QuickCheck test
cases, not a test failure.

"make test" causes all the functional tests in "tests/" to be run against
repositories in the old, hashed, and darcs2 formats.

"make bugs" runs the scripts in "bugs/", also on all three types of
repository, with the expectation that they currently fail.

Because "make test" can take a long time to run, it's useful to run fewer
tests at once.  To help with that, the following make targets are also
available:

  make test-old        # darcs1 old format
  make test-hashed     # darcs1 hashed format
  make test-format2    # darcs2 hashed format
  make bugs-old
  make bugs-hashed
  make bugs-format2


Running specific tests
------------------------------

Add test file names to tests_to_run to do only those tests:

  echo annotate.pl > tests/tests_to_run
  echo annotate.sh >> tests/tests_to_run
  make test-old # or whichever you like!


Running a single test
-----------------------------

Shell tests are run with the shell_harness script:

  perl shell_harness annotate.sh

("chmod +x shell_harness" to use it directly.)


Tips for writing (and reading) tests
====================================

- Avoid including a repo format type to "darcs init"
  This insures that all three repo formats will be tested.
  However, if you know that the test only passes under some
  repo formats, *do* explicitly include a format option to "darcs init".


Tips for writing tests
----------------------

- Copy an existing test, which will already have the following properties:

- Simply call darcs using "darcs" as you would in the shell.  It is the
  responsibility of the test harness to ensure that the darcs we are
  testing is first in the path.

- Always use Bash explicitly - this improves the portability of our tests.

- Always add this near the top of the script:

   set -ev

  The "v" causes the contents of the script to be printed as part of the run,
  which is helpful for debugging.  The "e" causes the script to exit as soon as
  there is an error.

- Try to avoid defining functions where possible.  This makes them
  harder to run and generally harder to use.  There are certainly cases
  where it is appropriate to define a function, but please do not do
  this just to avoid a little duplication.

- Also try to be careful using certain utilities; 'yes' is prohibited since
  it can cause infinite loops on Mac OS X; 'find' can be very useful, but
  options and behavior can differ from GNU find to the BSD finds to Solaris's
  find and so on. In general, stick to POSIX flags and functionality.

- There is a utility script intended for factoring out common calls and
  functions, called 'lib'. It can be invoked by adding a line like '. lib' to
  your shell script. lib provides 'set -ev', a common definition of 'not', and
  'abort_windows' for use in scripts which shouldn't run under Windows.
  You don't have to use lib if you don't want to, or if it causes problems.