diff --git a/README.md b/README.md index b8cad3bb9..6d9930146 100644 --- a/README.md +++ b/README.md @@ -55,3 +55,8 @@ Please refer to the [lorax-composer](https://github.com/weldr/lorax)'s documenat ### Upload action * Each image can be, but does not have to be, uploaded to a remote location * One image can be uploaded to multiple locations + + +## Testing + +See [test/README.md](test/README.md) diff --git a/test/README.md b/test/README.md new file mode 100644 index 000000000..6c1f612f5 --- /dev/null +++ b/test/README.md @@ -0,0 +1,29 @@ +# osbuild-composer testing information + + +## Integration testing + +This will consume the osbuild-composer API surface via the `composer-cli` +command line interface. Implementation is under `cmd/osbuild-tests/`. + +The easiest way to get started with integration testing from a git +checkout is: + +* `make rpm` to build the software under test +* `dnf install output/x86_64/golang-github-osbuild-composer-*.rpm` - this will + install both osbuild-composer, its -debuginfo, -debugsource and -tests packages +* `systemctl start osbuild-composer` +* `/usr/libexec/tests/osbuild-composer/osbuild-tests` to execute the test suite. + It is best that you use a fresh system for installing and running the tests! + +**NOTE:** + +The easiest way to start osbuild-composer is via systemd because it takes care +of setting up the UNIX socket for the API server. + +If you are working on a pull request that adds more integration tests +(without modifying osbuild-composer itself) then you can execute the test suite +from the local directory without installing it: + +* `make build` - will build everything under `cmd/` +* `./osbuild-tests` - will execute the freshly built integration test suite