Merge lp:~fginther/ubuntu-ci-services-itself/testrunner-doc-update into lp:ubuntu-ci-services-itself

[Francis Ginther]

Formatting and progress message updates for the test-runner.

Formatting and progress message updates for the test-runner.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:137
http://s-jenkins.ubuntu-ci:8080/job/uci-engine-ci/167/
Executed test runs:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/uci-engine-ci/167/rebuild

review: Needs Fixing (continuous-integration)

Unmerged revisions

137. By Francis Ginther on 2014-01-25

Formatting and progress message updates.

=== modified file 'docs/components/test-runner.rst'
--- docs/components/test-runner.rst	2014-02-06 15:29:01 +0000
+++ docs/components/test-runner.rst	2014-02-18 14:05:04 +0000
@@ -5,7 +5,7 @@
 Purpose
 =======
 
-* Performs package testing on a given image.
+Performs package testing on a given image.
 
 Future
 ======
@@ -26,13 +26,31 @@
 This run the DEP8 tests for each package in 'package_list' on 'image_id' and
 is sent by the 'Lander'.
 
+*URL Pattern*
+
+  http://test-runner-url:8080/api/v1/test_image (HTTP POST)
+
+*Parameters*
+
+ * test_request_id: The ticket identifier for this request.
+ * image_url: The location of the image to be tested.
+ * package_name: A list of binary packages to test.
+
+*Example*
 .. code-block:: none
 
+<<<<<<< TREE
   test_image(ticket_id, image_id, package_list, progress_trigger)
+=======
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"test_request_id": "1", "image_url": "http://image-store-url/ticket-1-image.img", "package_name": ["libfoo", "baz-utils"], "progress_trigger": "ticket-1-test-runner"}' http://test-runner-url:8080/api/v1/test_image
+>>>>>>> MERGE-SOURCE
 
+<<<<<<< TREE
 The caller is responsible for providing a unique 'progress_trigger'
 identifier. This unique identifier is used to define the rabbit queue and
 the data store container.
+=======
+>>>>>>> MERGE-SOURCE
 
 This is composed of:
  * boots the image from 'image_id',
@@ -45,6 +63,7 @@
 with the 'Lander'.
 
 
+<<<<<<< TREE
 done
 ----
 
@@ -59,12 +78,69 @@
 
 progress
 --------
+=======
+Progress is communicated to the lander at regular intervals using the following
+messages:
+
+*Completed*
+
+This ends the processing of a 'done' request when all tests pass and is sent to
+the 'Lander'.
+
+.. code-block:: none
+
+  {
+      "state": "COMPLETED",
+      "exit": True
+      "test_request_id": test_request_id,
+      "image_url": image_url,
+      "package_name": pakage_name,
+      "progress_trigger": progress_trigger,
+      "test_result": test_result,
+      "artifacts": artifacts
+  }
+
+*Failed*
+
+This ends the processing of a 'done' request when a test fails and is sent to
+the 'Lander'.
+
+.. code-block:: none
+
+  {
+      "state": "FAILED",
+      "exit": True
+      "test_request_id": test_request_id,
+      "image_url": image_url,
+      "package_name": pakage_name,
+      "progress_trigger": progress_trigger,
+      "test_result": test_result,
+      "artifacts": artifacts
+  }
+
+*In Progress*
+>>>>>>> MERGE-SOURCE
 
 This is sent to the 'Lander' to provide feedback during the test run.
 
 .. code-block:: none
 
+<<<<<<< TREE
   progress(progress_trigger, message='% or ETA', current, total)
+=======
+  {
+      "state": "STATUS",
+      "test_request_id": test_request_id,
+      "image_url": image_url,
+      "package_name": pakage_name,
+      "progress_trigger": progress_trigger,
+      "message" = "% or ETA",
+      "current" = current,
+      "total" = total
+  }
+
+  test_request_id, message='% or ETA', current, total)
+>>>>>>> MERGE-SOURCE
 
 
 Based on test execution feedback, a progress message is sent at regular