ceph/qa
Patrick Donnelly 3767887144
Merge PR #57215 into main
* refs/pull/57215/head:
	doc: document new --output-file switch
	test/cli: ignore tmp_file_template
	qa/workunits: add --output-file test in cephtool workunit
	common,ceph: add output file switch to dump json to
	common/options: add configs for temporary files made by daemons
	common/Formatter: write the pending string on flush

Reviewed-by: Leonid Usov <leonid.usov@ibm.com>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
2024-05-22 21:15:07 -04:00
..
archs
btrfs
cephfs qa: ignore variation of PG_DEGRADED health warning 2024-04-30 10:03:12 -04:00
client
clusters
config qa/config/crimson_qa_overrides: adjust mgr_stats_period 2024-05-02 15:49:21 +00:00
crontab
debug
distros
erasure-code
libceph
machine_types
mds
mgr_ttl_cache
mon/bootstrap
mon_election qa: add missing terminating newline 2024-04-29 12:22:26 -04:00
msgr
nightlies
objectstore
objectstore_cephfs
objectstore_debug
overrides
packages
qa_scripts
rbd
releases
rgw
rgw_bucket_sharding
rgw_frontend
rgw_pool_type
standalone
suites Merge pull request #56114 from xxhdx1985126/wip-seastore-teuthology-max-test-attr-len 2024-05-19 13:28:24 +03:00
tasks qa/cephfs/test_quiesce: test proper handling of remote authpins 2024-05-21 00:10:20 +03:00
timezone
workunits Merge PR #57215 into main 2024-05-22 21:15:07 -04:00
.gitignore
.qa
CMakeLists.txt
find-used-ports.sh
loopall.sh
lsan.supp
Makefile
mypy.ini
README
run_xfstests_qemu.sh
run_xfstests-obsolete.sh
run_xfstests.sh
run-standalone.sh
runallonce.sh
runoncfuse.sh
runonkclient.sh
setup-chroot.sh
test_import.py
tox.ini
valgrind.supp

ceph-qa-suite
-------------

clusters/    - some predefined cluster layouts
suites/      - set suite

The suites directory has a hierarchical collection of tests.  This can be
freeform, but generally follows the convention of

  suites/<test suite name>/<test group>/...

A test is described by a yaml fragment.

A test can exist as a single .yaml file in the directory tree.  For example:

 suites/foo/one.yaml
 suites/foo/two.yaml

is a simple group of two tests.

A directory with a magic '+' file represents a test that combines all
other items in the directory into a single yaml fragment.  For example:

 suites/foo/bar/+
 suites/foo/bar/a.yaml
 suites/foo/bar/b.yaml
 suites/foo/bar/c.yaml

is a single test consisting of a + b + c.

A directory with a magic '%' file represents a test matrix formed from
all other items in the directory.  For example,

 suites/baz/%
 suites/baz/a.yaml
 suites/baz/b/b1.yaml
 suites/baz/b/b2.yaml
 suites/baz/c.yaml
 suites/baz/d/d1.yaml
 suites/baz/d/d2.yaml

is a 4-dimensional test matrix.  Two dimensions (a, c) are trivial (1
item), so this is really 2x2 = 4 tests, which are

  a + b1 + c + d1
  a + b1 + c + d2
  a + b2 + c + d1
  a + b2 + c + d2

A directory with a magic '$' file, or a directory whose name ends with '$',
represents a test where one of the non-magic items is chosen randomly.  For
example, both

 suites/foo/$
 suites/foo/a.yaml
 suites/foo/b.yaml
 suites/foo/c.yaml

and

 suites/foo$/a.yaml
 suites/foo$/b.yaml
 suites/foo$/c.yaml

is a single test, either a, b or c.  This can be used in conjunction with the
'%' file in the same (see below) or other directories to run a series of tests
without causing an unwanted increase in the total number of jobs run.

Symlinks are okay.

One particular use of symlinks is to combine '%' and the latter form of '$'
feature.  Consider supported_distros directory containing fragments that define
os_type and os_version:

 supported_distros/%
 supported_distros/centos.yaml
 supported_distros/rhel.yaml
 supported_distros/ubuntu.yaml

A test that links supported_distros as distros (a name that doesn't end with
'$') will be run three times: on centos, rhel and ubuntu.  A test that links
supported_distros as distros$ will be run just once: either on centos, rhel or
ubuntu, chosen randomly.

The teuthology code can be found in https://github.com/ceph/teuthology.git