Files
poky/meta/lib/patchtest
Trevor Gamblin dab2dcae89 patchtest: add test_commit_message_user_tags
This test makes patchtest check to ensure that there aren't any
GitHub-style user account names being tagged in the commit message, e.g.
it should catch lines like:

"fix added by @threexc"

This is desired so that if (for example) we add upstream changelogs in
recipe upgrade commit messages verbatim, we don't end up subscribing any
associated maintainers to our repo mirrors' updates by accident.

There is a small possibility of a false positive with this test, where
if someone is mentioning Python decorators in their commit message (or
similar syntax from other languages), it will fail when it should pass.
However, having this test in place to guard against username inclusion
is more important that the occasional false positive for that reason.

With this addition, a failure will look like:

|FAIL: test commit message user tags: Mbox includes one or more GitHub-style username tags. Ensure that any "@" symbols are stripped out of usernames (test_mbox.TestMbox.test_commit_message_user_tags)

(From OE-Core rev: 8278d82d8203212bb159eb3805d4a5617c5370df)

Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-23 17:35:23 +01:00
..

patchtest selftests for openembedded-core

This directory provides a test suite and selftest script for use with the patchtest repository: https://git.yoctoproject.org/patchtest/

To setup for use:

  1. Clone https://git.openembedded.org/openembedded-core (this repo) and https://git.openembedded.org/bitbake/
  2. Clone https://git.yoctoproject.org/patchtest
  3. Install the necessary Python modules: in meta/lib/patchtest or the patchtest repo, do pip install -r requirements.txt
  4. Add patchtest to PATH: export PATH=/path/to/patchtest/repo:$PATH
  5. Initialize the environment: source oe-init-build-env
  6. Add meta-selftest to bblayers.conf: bitbake-layers add-layer /path/to/meta-selftest/ (the selftests use this layer's recipes as test targets)
  7. Finally, run the selftest script: ./meta/lib/patchtest/selftest/selftest

For more information on using patchtest, see the patchtest repo at https://git.yoctoproject.org/patchtest/.