diff options
| -rw-r--r-- | README | 66 |
1 files changed, 39 insertions, 27 deletions
@@ -29,52 +29,64 @@ A future version will most probably drop D-Bus dependency and replace it with a less painful IPC. -How to run it -------------- +Running tests using Portage +--------------------------- -First, you need to have an overlay for the tests. If you intend to use portage, -`pms-tester` can create an temporary repository and use it automatically. To do -so, run: +The Portage backend is the only backend supporting running tests using a random, +unconfigured directory. Thus, running the test suite is as simple as: - pms-tester -R /tmp/your-repo-location + pms-tester -R /tmp/temporary-repo-location -If you intend to test another PM, you need to either create the repository -yourself or use the above command to let `pms-tester` create it for you. Notice -you'll need to have portage installed for that. Afterwards, you need to add -the repository to your PM configuration. +This will cover all the necessary steps of setting up the repository, creating +ebuilds, setting `PORTDIR_OVERLAY` and running the test suite. Please note that +it doesn't remove the repository afterwards -- it is intended to be reusable. -For example, setting up a test repository for portage configs can be achieved -through: + +Running tests using other PMs +----------------------------- + +If the intent is to use another PM than Portage, one must first create +an (empty) repository for test suite and add it to PMs repository list. + +The simplest way of doing that involves using the Portage backend once again: + + pms-tester -R /var/cache/pms-tests --create-repo-only + +One may also create and name the repository manually: umask 022 - mkdir -p /usr/local/portage/pms-tests/profiles - echo 'pms-test-suite' > /usr/local/portage/pms-tests/profiles/repo_name + mkdir -p /var/cache/pms-tests/profiles + echo 'pms-test-suite' > /var/cache/pms-tests/profiles/repo_name + +In both cases, it is necessary to add the repository to PMs config; for Portage +that would be: + echo 'PORTDIR_OVERLAY="${PORTDIR_OVERLAY} - /usr/local/portage/pms-tests' >> /etc/make.conf + /var/cache/pms-tests' >> /etc/make.conf -The newly-created repository can be then referenced by name: +The newly-created repository will be then referenced by its name: - pms-tester -r pms-test-suite -p yourpm + pms-tester -p pkgcore -`pms-test-suite` is the default name, and pms-tester will use it when no `-r` -nor `-R` is specified. Thus, the above could be simplified to: +If a different name was used, that would be: - pms-tester -p yourpm + pms-tester -r repository-name -p pkgcore Getting nice HTML results ------------------------- -By default, pms-tester simply runs all tests and returns information about test -failures. If you'd like to get a nice HTML output instead (like [the one -published by me][1]), please use: +By default, pms-tester simply runs all tests and prints status information +and details on test failures. If you'd like to get a nice HTML output instead +(like [the one published by me][1]), please use: - pms-tester -p yourpm -o html -O myoutput.html + pms-tester -o html -O myoutput.html -You can run the test suite using multiple PMs as well: +This will, however, create output for a single PM only. In order to use multiple +ones, just specify all of them: - pms-tester -p pkgcore -p portage -p paludis -o html -O myoutput.html + pms-tester -p paludis -p pkgcore -p portage -o html -O myoutput.html -[1]:http://dev.gentoo.org/~mgorny/pms-test-suite-output.html +[1]:http://www.gentoo.org/proj/en/qa/pms/pms-test-suite-output.html <!-- vim:se syn=markdown :--> |