Repository: incubator-brooklyn Updated Branches: refs/heads/master 0ff4216a8 -> e8e0fced3
Docs: minor improvements - Improve tests.md - Fix formatting Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/8527d7e0 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/8527d7e0 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/8527d7e0 Branch: refs/heads/master Commit: 8527d7e0ba8351d9afb1aee1550ec3e7ac8c12bf Parents: fd22cc0 Author: Aled Sage <[email protected]> Authored: Tue Mar 10 16:54:52 2015 +0000 Committer: Aled Sage <[email protected]> Committed: Tue Mar 10 17:22:42 2015 +0000 ---------------------------------------------------------------------- docs/guide/dev/code/tests.md | 11 ++++++++--- docs/guide/dev/tips/index.md | 1 + docs/guide/java/entities.md | 17 +++++++++-------- 3 files changed, 18 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/8527d7e0/docs/guide/dev/code/tests.md ---------------------------------------------------------------------- diff --git a/docs/guide/dev/code/tests.md b/docs/guide/dev/code/tests.md index 6d2bbab..460cc23 100644 --- a/docs/guide/dev/code/tests.md +++ b/docs/guide/dev/code/tests.md @@ -19,8 +19,13 @@ We have the following tests groups: To run these from the command line, use something like the following: * normal: `mvn clean install` -* integration: `mvn clean verify -PEssentials,Locations,Entities,Integration -Dmaven.test.failure.ignore=true` -* Live: `mvn clean verify -PEntities,Locations,Entities,Live -Dmaven.test.failure.ignore=true` -* Live-sanity: `mvn clean verify -PEntities,Locations,Entities,Live-sanity -Dmaven.test.failure.ignore=true` +* integration: `mvn clean verify -PEssentials,Locations,Entities,Integration -Dmaven.test.failure.ignore=true --fail-never` +* Live: `mvn clean verify -PEntities,Locations,Entities,Live -Dmaven.test.failure.ignore=true --fail-never` +* Live-sanity: `mvn clean verify -PEntities,Locations,Entities,Live-sanity -Dmaven.test.failure.ignore=true --fail-never` + +To run a single test, use something like the following: + +* run a single test class: `mvn -Dtest=brooklyn.enricher.EnrichersTest -DfailIfNoTests=false test` +* run a single test method: `mvn -Dtest=brooklyn.enricher.EnrichersTest#testAdding -DfailIfNoTests=false test` <!-- TODO describe how to run each of these, as a group, and individually; and profiles --> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/8527d7e0/docs/guide/dev/tips/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/dev/tips/index.md b/docs/guide/dev/tips/index.md index ac173c0..8a45d46 100644 --- a/docs/guide/dev/tips/index.md +++ b/docs/guide/dev/tips/index.md @@ -23,6 +23,7 @@ title: Miscellaneous Tips and Tricks <a name="EntityDesign"></a> + ## Entity Design Tips * Look at related entities and understand what they've done, in particular which http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/8527d7e0/docs/guide/java/entities.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/entities.md b/docs/guide/java/entities.md index aae674d..c7fc43e 100644 --- a/docs/guide/java/entities.md +++ b/docs/guide/java/entities.md @@ -16,13 +16,13 @@ What to Extend -- Implementation Classes - entity implementation class hierarchy - - ``SoftwareProcess`` as the main starting point for base entities (corresponding to software processes), - and subclasses such as ``VanillaJavaApp`` - - ``DynamicCluster`` (multiple instances of the same entity in a location) and - ``DynamicFabric`` (clusters in multiple location) for automatically creating many instances, - supplied with an ``EntityFactory`` (e.g. ``BaseEntityFactory``) in the ``factory`` flag - - abstract ``Group`` for collecting entities which are parented elsewhere in the hierachy - - ``AbstractEntity`` if nothing else fits + - `SoftwareProcess` as the main starting point for base entities (corresponding to software processes), + and subclasses such as `VanillaJavaApp` + - `DynamicCluster` (multiple instances of the same entity in a location) and + `DynamicFabric` (clusters in multiple location) for automatically creating many instances, + supplied with an `EntityFactory` (e.g. `BaseEntityFactory`) in the `factory` flag + - `AbstractGroup` for collecting entities which are parented elsewhere in the hierachy + - `AbstractEntity` if nothing else fits - traits (mixins, otherwise known as interfaces with statics) to define available config keys, sensors, and effectors; and conveniences e.g. ``StartableMethods.{start,stop}`` is useful for entities which implement ``Startable`` @@ -123,4 +123,5 @@ TODO more drivers such as jmx, etc are planned Testing ------- -* Run in a mock ``SimulatedLocation``, defining new metaclass methods to be able to start there and assert the correct behaviour when that is invoked +* Unit tests can make use of `SimulatedLocation` and `TestEntity`, and can extend `BrooklynAppUnitTestSupport`. +* Integration tests and use a `LocalhostMachineProvisioningLocation`, and can also extend `BrooklynAppUnitTestSupport`.
