Documentation: better build-system tutorial
Project: http://git-wip-us.apache.org/repos/asf/zest-qi4j/repo Commit: http://git-wip-us.apache.org/repos/asf/zest-qi4j/commit/982ea0fa Tree: http://git-wip-us.apache.org/repos/asf/zest-qi4j/tree/982ea0fa Diff: http://git-wip-us.apache.org/repos/asf/zest-qi4j/diff/982ea0fa Branch: refs/heads/develop Commit: 982ea0faec6e2225fe40086bb1cdf5a5e23b0214 Parents: e821bd2 Author: Paul Merlin <[email protected]> Authored: Sat Jul 18 12:03:57 2015 +0200 Committer: Paul Merlin <[email protected]> Committed: Sat Jul 18 12:03:57 2015 +0200 ---------------------------------------------------------------------- .../src/docs/tutorials/howto-build-system.txt | 48 ++++++++------------ 1 file changed, 20 insertions(+), 28 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/982ea0fa/manual/src/docs/tutorials/howto-build-system.txt ---------------------------------------------------------------------- diff --git a/manual/src/docs/tutorials/howto-build-system.txt b/manual/src/docs/tutorials/howto-build-system.txt index 6730a38..2fa78b5 100644 --- a/manual/src/docs/tutorials/howto-build-system.txt +++ b/manual/src/docs/tutorials/howto-build-system.txt @@ -18,7 +18,7 @@ /////////////////////////////////////////////////////////////// [[build-system,Build System]] -= Build System = += Zest⢠Build System = This tutorial is intended for developpers who want to build the Zest⢠SDK themselves. It describe the Zest⢠SDK Build System from compilation to publication of artifacts for consumption by other @@ -131,40 +131,18 @@ If a +version+ property is not defined, the build system will refuse to make a r == Tests == -NOTE: See the https://builds.apache.org/view/S-Z/view/Zest/[Zest⢠Continuous Integration] for current tests results - -// TODO - -=== Regression tests === - -They are not part of the default build. - -// TODO - - -=== Performance tests === - -Performance tests provide performance mesurements for typical Zest⢠use cases. -They are not part of the default build. - -// TODO - - -=== Complex tests === - -Complex tests are the ones that requires manual operation to be executed. -They are not part of the default build. - -// TODO +Unit and integration tests are located near the code under test. +You'll find theses tests across the whole SDK. +NOTE: See the https://builds.apache.org/view/S-Z/view/Zest/[Zest⢠Continuous Integration] for current tests results === Unit tests requiring external services === -NOTE: The HTML test reports generated by Gradle show skipped tests. - Among unit tests, some require an external service to be run. For example, the MongoDB EntityStore extension requires an actual MongoDB server to run its tests. +NOTE: The HTML test reports generated by Gradle show skipped tests. + All thoses tests should be part of the default build and check if the service is available at its default location on +localhost+ and skip if not. This is easily achieved using http://junit.sourceforge.net/javadoc/org/junit/Assume.html[JUnit assumptions]. @@ -178,6 +156,20 @@ We'll list here services that the unit tests will use if available. - PostgreSQL for +extensions/entitystore-sql+ and +extensions/indexing-sql+ (need setup, see test source) - MySQL for +extensions/entitystore-sql+ (need setup, see test source) +=== Performance tests === + +Performance tests provide performance mesurements for typical Zest⢠use cases. +They are not part of the default build and are located in the `tests/performance` directory of the SDK. + +They can be run with the following Gradle command: + +[source,bash] +----------- +./gradlew :org.qi4j.tests:org.qi4j.test.performance:testPerf +----------- + +Results will then be available in the test reports. + == Releasing the Zest⢠SDK ==
