| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- Running the Tests
- -----------------
- The tests are run via
- make
- To also run the component tests, you need to initialize the git submodules once
- via:
- git submodule update --init --recursive
- This will fetch the necessary binary data for the DEB and RPM component tests,
- and the tests are from now on included within each regular test run.
- Some tests reach out to the network. To run these in addition to all
- other tests use:
- make all+net
- You can run the tests in a debian/sid docker container by using
- tests/helpers/run-in-docker.
- Building the API Docs
- ---------------------
- You can build the API docs using
- make apidocs
- Contributing Patches
- --------------------
- Make sure the tests pass before sending in patch. You can either send it to the
- mailing list or add it to a bug report against git-buildpackage on
- http://bugs.debian.org/src:git-buildpackage
- Layout
- ------
- gbp/scripts/*.py - the actual gbp commands (buildpackage, dch, …)
- gbp/scripts/common/ - code shared between Debian and RPM commands
- gbp/deb/ - Debian package handling (control, dsc, …)
- gbp/rpm/ - RPM package handling (spec files, …)
- gbp/git/ - Git repository interaction
- tests/*.py - unit tests
- tests/doctests - doctests that also serve as examples
- tests/component/ - component tests that invoke actual commands
- Interfaces
- ----------
- A gbp command in gbp/scripts/<commmand>.py must provide these interfaces:
- When one invokes `gbp <command>` gbp/scripts/<commmand>.py is imported by
- gbp/scripts/supercommand.py
- which then invokes it's *main* function with all given command line arguments.
- It is expected to return with the exit status that should be passed back to the
- shell.
- When one invokes `gbp config <command>` gbp/scripts/<commmand>.py is imported by
- gbp/scripts/config.py
- which then invokes it's *build_parser* function with the command name as argument.
- It is expected to return a GbpConfigParser with all config files parsed.
|
