Github user johnmccabe commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/999#discussion_r43692507
--- Diff: sandbox/brooklyn-sandbox-test-framework/README.md ---
@@ -0,0 +1,94 @@
+# Entities
+
+## TestCase
+A logical grouping for tests eg Restart tests
+```
+type: org.apache.brooklyn.test.framework.TestCase
+ name: Stop Test
+ brooklyn.children:
+ - ***
+ - ***
+```
+
+## TestSensor
+Entity that tests a sensor value on another entity eg service.isUp == TRUE
+
+#### Configuration
+| Key | Description | Required |
+| --- | ----------- | -------- |
+| target | The target entity to test | yes (no if *targetId* is supplied) |
+| targetId | The id of the target entity to test | yes (no if *target* is
supplied) |
+| assert | Assertions to be evaluated | yes |
+| timeout | The duration to wait on a result | no |
+
+```
+type: org.apache.brooklyn.test.framework.TestSensor
+target: $brooklyn:component("nginx1")
+sensor: service.isUp
+equals: true
+timeout: 5m
+```
+
+## TestEffector
+Entity that invokes an effector on another entity eg restart
+
+#### Configuration
+| Key | Description | Required |
+| --- | ----------- | -------- |
+| target | The target entity to effect | yes (no if *targetId* is
supplied) |
+| targetId | The id of the target entity to effect | yes (no if *target*
is supplied) |
+| effector | The name of the effector to invoke | yes |
+| params | Parameters to pass to the effector | no |
+| timeout | The duration to wait on a response from an effector | no |
+
+#### Sensors
+| Key | Description |
+| --- | ----------- |
+| result | The result of invoking the effector (null if no result) |
+
+```
+type: org.apache.brooklyn.test.framework.TestEffector
+name: Deploy WAR
+target: $brooklyn:component("tomcat")
+effector: deploy
+params:
+ url: https://tomcat.apache.org/tomcat-6.0-doc/appdev/sample/sample.war
+ targetName: sample1
+```
+
+## TestHtmlCall
+Entity that makes a HTTP Request and tests the response
+
+#### Configuration
+| Key | Description | Required |
+| --- | ----------- | -------- |
+| target | The target entity to effect | yes (no if *targetId* is
supplied) |
+| targetId | The id of the target entity to effect | yes (no if *target*
is supplied) |
--- End diff --
`target`/`targetId` aren't used, need to add `assert` - see the javadoc for
the assertion keywords
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
