From 5b0259ec6eb02a9cd39c25d5e29bec00704ebe1a Mon Sep 17 00:00:00 2001
From: Arthur Barr <arthur.barr@uk.ibm.com>
Date: Wed, 29 Nov 2017 12:36:48 +0000
Subject: [PATCH] Add test comments

---
 test/docker/docker_api_test.go | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/test/docker/docker_api_test.go b/test/docker/docker_api_test.go
index 297e1e6..66bd7a4 100644
--- a/test/docker/docker_api_test.go
+++ b/test/docker/docker_api_test.go
@@ -62,6 +62,7 @@ func TestLicenseView(t *testing.T) {
 	}
 }
 
+// TestGoldenPath starts a queue manager successfully
 func TestGoldenPath(t *testing.T) {
 	cli, err := client.NewEnvClient()
 	if err != nil {
@@ -149,6 +150,8 @@ func TestWithVolume(t *testing.T) {
 	waitForReady(t, cli, ctr2.ID)
 }
 
+// TestNoVolumeWithRestart ensures a queue manager container can be stopped
+// and restarted cleanly
 func TestNoVolumeWithRestart(t *testing.T) {
 	cli, err := client.NewEnvClient()
 	if err != nil {
@@ -169,7 +172,7 @@ func TestNoVolumeWithRestart(t *testing.T) {
 	waitForReady(t, cli, id)
 }
 
-// Test the case where `crtmqm` will fail
+// TestCreateQueueManagerFail causes a failure of `crtmqm`
 func TestCreateQueueManagerFail(t *testing.T) {
 	cli, err := client.NewEnvClient()
 	if err != nil {
@@ -195,7 +198,7 @@ func TestCreateQueueManagerFail(t *testing.T) {
 	}
 }
 
-// Test the case where `strmqm` will fail
+// TestStartQueueManagerFail causes a failure of `strmqm`
 func TestStartQueueManagerFail(t *testing.T) {
 	cli, err := client.NewEnvClient()
 	if err != nil {
@@ -221,6 +224,10 @@ func TestStartQueueManagerFail(t *testing.T) {
 	}
 }
 
+// TestVolumeUnmount runs a queue manager with a volume, and then forces an
+// unmount of the volume.  The health check should then fail.
+// This simulates behaviour seen in some cloud environments, where network
+// attached storage gets unmounted.
 func TestVolumeUnmount(t *testing.T) {
 	cli, err := client.NewEnvClient()
 	if err != nil {