RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-20 10:01:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge PR #35541 into master

Browse Source 
* refs/pull/35541/head:
	doc/dev: mention -l, -e and -n among useful options
	doc/dev: add info on how to retest QA changes without rebuilding

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
This commit is contained in:
Patrick Donnelly 2020-06-15 16:41:43 -07:00
commit efe4de1290
No known key found for this signature in database
GPG Key ID: 3A2A7E25BEA8AADB
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/dev/developer_guide/running-tests-using-teuth.rst
View File

@ -63,9 +63,38 @@ After building is complete, proceed to trigger tests -
`Pulpito`_ page created for the tests triggered.
Other frequently used/useful options are ``-d`` (or ``--distro``),
``--distroversion``, ``--filter-out``, ``--timeout``, ``flavor``, ``-rerun``.
Run ``teuthology-suite --help`` to read description of these and every other
options available.
``--distroversion``, ``--filter-out``, ``--timeout``, ``flavor``, ``-rerun``,
``-l`` (for limiting number of jobs) , ``-n`` (for how many times job would
run) and ``-e`` (for email notifications). Run ``teuthology-suite --help``
to read description of these and every other options available.
Testing QA changes (without re-building binaires)
-------------------------------------------------
While writing a PR you might need to test your PR repeatedly using teuthology.
If you are making non-QA changes, you need to follow the standard process of
triggering builds, waiting for it to finish and then triggering tests and
wait for the result. But if changes you made are purely changes in qa/,
you don't need rebuild the binaries. Instead you can test binaries built for
the ceph-ci branch and instruct ``teuthology-suite`` command to use a separate
branch for running tests. The separate branch can be passed to the command
by using ``--suite-repo`` and ``--suite-branch``. Pass the link to the GitHub
fork where your PR branch exists to the first option and pass the PR branch
name to the second option.
For example, if you want to make changes in ``qa/`` after testing ``branch-x``
(of which has ceph-ci branch is ``wip-username-branch-x``) by running
following command::
teuthology-suite -v -m smithi -c wip-username-branch-x -s fs -p 50 --filter cephfs-shell
You can make the modifications locally, update the PR branch and then
trigger tests from your PR branch as follows::
teuthology-suite -v -m smithi -c wip-username-branch-x -s fs -p 50 --filter cephfs-shell --suite-repo https://github.com/username/ceph --suite-branch branch-x
You can verify if the tests were run using this branch by looking at values
for the keys ``suite_branch``, ``suite_repo`` and ``suite_sha1`` in the job
config printed at the very beginning of the teuthology job.
About Suites and Filters
------------------------