ceph/qa/README

   1 ceph-qa-suite
   2 -------------
   3
   4 clusters/    - some predefined cluster layouts
   5 suites/      - set suite
   6
   7 The suites directory has a hierarchical collection of tests.  This can be
   8 freeform, but generally follows the convention of
   9
  10   suites/<test suite name>/<test group>/...
  11
  12 A test is described by a yaml fragment.
  13
  14 A test can exist as a single .yaml file in the directory tree.  For example:
  15
  16  suites/foo/one.yaml
  17  suites/foo/two.yaml
  18
  19 is a simple group of two tests.
  20
  21 A directory with a magic '+' file represents a test that combines all
  22 other items in the directory into a single yaml fragment.  For example:
  23
  24  suites/foo/bar/+
  25  suites/foo/bar/a.yaml
  26  suites/foo/bar/b.yaml
  27  suites/foo/bar/c.yaml
  28
  29 is a single test consisting of a + b + c.
  30
  31 A directory with a magic '%' file represents a test matrix formed from
  32 all other items in the directory.  For example,
  33
  34  suites/baz/%
  35  suites/baz/a.yaml
  36  suites/baz/b/b1.yaml
  37  suites/baz/b/b2.yaml
  38  suites/baz/c.yaml
  39  suites/baz/d/d1.yaml
  40  suites/baz/d/d2.yaml
  41
  42 is a 4-dimensional test matrix.  Two dimensions (a, c) are trivial (1
  43 item), so this is really 2x2 = 4 tests, which are
  44
  45   a + b1 + c + d1
  46   a + b1 + c + d2
  47   a + b2 + c + d1
  48   a + b2 + c + d2
  49
  50 A directory with a magic '$' file represents a test where one of the other
  51 items is chosen randomly. For example,
  52
  53 suites/foo/$
  54 suites/foo/a.yaml
  55 suites/foo/b.yaml
  56 suites/foo/c.yaml
  57
  58 is a single test.  It will be either a.yaml, b.yaml or c.yaml.  This can be
  59 used in conjunction with the '%' file in other directories to run a series of
  60 tests without causing an unwanted increase in the total number of jobs run.
  61
  62 Symlinks are okay.
  63
  64 The teuthology code can be found in https://github.com/ceph/teuthology.git