Merge lp:~cprov/tanuki-agent/tutorial-results into lp:tanuki-agent

[Celso Providelo]

Using api-example.py binary and adding test-result reference queries.

Using api-example.py binary and adding test-result reference queries.

[Evan (ev)]

Minor nits.

review: Needs Fixing

[Facundo Batista (facundo)]

Awesome

review: Approve

[lp:~cprov/tanuki-agent/tutorial-results]

118. By Celso Providelo on 2015-10-21

addressing review comments.

[Celso Providelo (cprov)]

Thank, Evan and Facundo.

Review comments addressed, might be worth another glance on language and flow.

[Celso Providelo (cprov)]

Well, we can iterate further ... let's land it and quit conflicting with other branches around.

review: Approve

[Evan (ev)]

review: Approve

=== modified file 'docs/tutorial.md'
--- docs/tutorial.md	2015-10-21 10:10:49 +0000
+++ docs/tutorial.md	2015-10-21 18:35:24 +0000
@@ -125,10 +125,6 @@
 
 See https://developer.ubuntu.com/en/snappy/start/ for further details.
 
-Also, install Paramiko dependency:
-
-    $ sudo apt-get install python-paramiko
-
 Next, you will create an image for RPI2 from the rolling/edge channel, with our test-snap pre-installed:
 
     $ wget http://people.canonical.com/~cprov/snappy/raspberrypi2/test-snap\_1\_all.snap
@@ -179,7 +175,7 @@
 
 So, in the agent directory execute the following from your computer (where you already authenticated during the lab setup above):
 
-    ./scripts/api_example.py -X POST config.ini \
+    ./api_example.py -X POST config.ini \
         https://spi.canonical.com/orgs/$ORGANIZATION/products/manifests
     --data '{
             "image\_name": "tutorial-raspi2-image",
@@ -205,7 +201,7 @@
 
 So, execute the following:
 
-    ./scripts/api_example.py -X POST config.ini \
+    ./api_example.py -X POST config.ini \
     https://spi.canonical.com/orgs/$ORGANIZATION/tests/specs --data '{
         "platform": "spi-tutorial-raspi2",
                 "image_name": "tutorial-raspi2-image",
@@ -228,13 +224,13 @@
 
 Now we’ll tell SPI manually that a new version of the snap we’re using for the tutorial is available:
 
-    ./scripts/api_example.py -X POST config.ini \    
+    ./api_example.py -X POST config.ini \    
     https://spi.canonical.com/orgs/$ORGANIZATION/snap-revisions --data '{
     "name": "test-snap.spi-test",
     "revision": 2
     }'
 
-In the response there is a image_unique_id that will be used next, please keep it around.
+In the response there is a ```test_opportunity_id``` and ```image_unique_id``` that will be used next, please keep it around.
 
 At this point the SPI has generated a message that is waiting to be consumed by our Agent, and when that message arrives the Agent will try to run the commands to provision, setup and run the tests. For that we need to put useful commands in the config file. So, edit ```config.ini``` and replace the following three fields (the path needs to be absolute, be sure to replace the correct values):
 
@@ -242,6 +238,10 @@
     setupcommand = PATH_TO_AGENT/rpi2-sample-provkit/setup
     testcommand = PATH_TO_AGENT/rpi2-sample-provkit/runtest
 
+You will need to install some supporting libraries to use the Raspberry Pi 2 sample Provisioning Kit:
+
+    $ sudo apt-get install python-paramiko python-requests
+
 Next step, then, is to start the Agent to get that message and start running the test. As of this moment, we’d need to set up the Raspberry Pi manually, so the Agent after receiving the test to run will produce some instructions to get an image and burn it into the device, so please follow those instructions and let the Agent know when you’re ready (it will wait for you to press Enter).
 
 So, run:
@@ -257,24 +257,29 @@
 system, where they stands (to be run, or already run, etc), checking the
 events in the system:
 
-    ./scripts/api_example.py config.ini \
-    https://spi.canonical.com/orgs/$ORGANIZATION/tests/events?image_name=tutorial-raspi2-image
-
-Also, you can see the results produced for all the organization, doing
-
-    ./scripts/api_example.py config.ini \
-    https://spi.canonical.com/orgs/$ORGANIZATION/tests/events?image_name=tutorial-raspi2-image
+    ./api_example.py config.ini \
+    https://spi.canonical.com/orgs/$ORGANIZATION/tests/events?test_opportunity_id=<test_opportunity_id>
 
 Or even check the results for an specific image (you can get the image
 id from the response of the query when you told the system above that a
 new snap revision was available):
 
-    ./scripts/api_example.py config.ini \
-    https://spi.canonical.com/orgs/$ORGANIZATION/tests/events?image_name=tutorial-raspi2-image/<unique_image_id>
-
-<!--
-ToDo: add example to query the actual result
--->
+    ./api_example.py config.ini \
+    https://spi.canonical.com/orgs/$ORGANIZATION/tests/events?image_unique_id=<unique_image_id>
+
+You can see the results produced for all products within an organisation by running:
+
+    ./api_example.py config.ini https://spi.canonical.com/orgs/$ORGANIZATION/tests/events
+
+All tests containing 'RESULT_POSTED' events will have results to be retrieved from SPI:
+
+    ./api_example.py config.ini https://spi.canonical.com/orgs/$ORGANIZATION/results
+
+Or you may directly poll for specific results using filters, as below:
+
+    ./api_example.py config.ini https://spi.canonical.com/orgs/$ORGANIZATION/results?image_unique_id=<image_unique_id>
+    ./api_example.py config.ini https://spi.canonical.com/orgs/$ORGANIZATION/results?image_name=tutorial-raspi2-image
+
 
 ## Other Testing Scenarios