<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
<link rel="stylesheet" href="../css/reveal.css">
- <link rel="stylesheet" href="../css/theme/OPNFV.css" id="theme">
+ <link rel="stylesheet" href="../css/theme/OPNFV-Berlin.css" id="theme">
<!-- Code syntax highlighting -->
<link rel="stylesheet" href="../lib/css/zenburn.css">
<!-- Any section element inside of this container is displayed as a slide -->
<div class="slides">
- <section data-background="../img/title-bg.png" data-background-transition="none">
- <h1>Test API</h1>
- <h3>Clean, Easy, Complete</h3>
- <br>
- <h4>OPNFV testing community</h4>
- <h5>OPNFV Design Summit, 20/6/2016, Berlin</h5>
- <br>
+ <section data-background="../img/title-bg-berlin.png" data-background-transition="none">
+ <br><br><br><br><br>
+ <h1>Test API</h1>
+ <h3>Clean, Easy, Complete</h3>
+ <br>
+ <h4>OPNFV testing community</h4>
+ <h5>OPNFV Design Summit, 20/6/2016, Berlin</h5>
+ <br>
</section>
<section data-markdown>
# Agenda
- * A test API: what for?
+ * testAPI: what for?
* API overview
* API evolution
+ * Roadmap
</section>
- <section>
- <section data-markdown>
- # A test API: what for?
- </section>
- <section data-markdown>
- ## Give a consistant view for
- * Test projects
- * Test cases
- * Test resources (Pods)
- * Test results
- </section>
-
- <section data-markdown>
- ## Unify result display
- * From many projects
- * Many formats (log, html, json, ..)
- * Many locations (in VM, Jumphost, external DB,...)
- </section>
-
- <section data-markdown>
- ## Help building
- * Dashboards
- * Automatic reporting
- </section>
- </section>
-
- <section>
- <section data-markdown>
- # API overview
- </section>
- <section data-markdown>
- ## API in Brahmaputra
- * Tornado + MongoDB
- * Simple data models aggreed with the testing group
- * No unit tests
- * Wiki and rst documentation
- </section>
-
- <section data-markdown>
- ## API in Brahmaputra
- 
- </section>
- <section data-markdown>
- ## API in Brahmaputra
- 
- https://wiki.opnfv.org/display/functest/Collection+Of+Test+Results
- </section>
-
- <section data-markdown>
- ## Lessons learned in B.
- * Wiki documentation is painful
- * result modl too simple
- * version used for scenario
- * no version
- * no overall criteria (passed/failed)
- * need unit tests for data model evolution
- </section>
- <section data-markdown>
- ## Colorado refactoring
- * done by Serena Feng (ZTE)
- * update of the data model (based on lesson learned)
- * creation of a swagger tornado framework for the doc
- * creation of unit tests
- </section>
- </section>
-
- <section>
- <section data-markdown>
- #API evolution
- </section>
-<section>
- <h3>Test API evolution</h3>
- <table>
- <thead>
- <tr>
- <th>Field</th>
- <th>Brahmaputra</th>
- <th>Colorado</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>date</td>
- <td>creation_date</td>
- <td>start_date and stop_date</td>
- </tr>
- <tr>
- <td>version</td>
- <td>used as scenario</td>
- <td>git version</td>
- </tr>
- <tr>
- <td>scenario</td>
- <td>N.R</td>
- <td>used for scenario</td>
- </tr>
- <tr>
- <td>test_criteria</td>
- <td>N.R</td>
- <td>passed/failed</td>
- </tr>
- <tr>
- <td>trust_indictator</td>
- <td>N.R</td>
- <td>between 0 and 1</td>
- </tr>
- <tr>
- <td>last</td>
- <td>N.R</td>
- <td>get last N results</td>
- </tr>
- </tbody>
- </table>
- </section>
- <section data-markdown>
- ## Swagger doc
+ <section>
+ <section data-markdown>
+ # test API: what for?
+ </section>
+ <section data-markdown>
+ ## Consistant view for
+ * Resources (Pods)
+ * Projects
+ * Test cases
+ * Results
+ </section>
+
+ <section data-markdown>
+ ## Status Currently
+ * From many projects
+ * Many formats (log, html, json, ..)
+ * Many locations (in VM, Jumphost, external DB,...)
+ </section>
+ <section data-markdown>
+ <script type='text/template'>
+ ## Achieve using testAPI
+ * Uniform API: testAPI
+ * Uniform format: JSON
+ * Universal Location: http://testresults.opnfv.org
+ <aside class='notes'>
+ By using testAPI, we hope to provide a uniform way of collection and saving test results to a universal location
+ </aside>
+ </script>
+ </section>
+
+ <section data-markdown>
+ ## Help building
+ * Dashboards
+ * Automatic reporting
+ </section>
+ </section>
+
+ <section>
+ <section data-markdown>
+ # API overview
+ </section>
+ <section data-markdown>
+ ## Storage structure
+ 
+ </section>
+ <section data-markdown>
+ ## API in Brahmaputra
+ 
+ https://wiki.opnfv.org/display/functest/Collection+Of+Test+Results
+ </section>
+
+ <section data-markdown>
+ ## API status in Brahmaputra
+ * Simple data models aggreed with the testing group
+ * No unit tests
+ * Wiki and rst documentation
+ </section>
+
+ <section data-markdown>
+ ## Lessons learned in B.
+ * Painful wiki documentation
+ * Simple result model
+ * Misuse version as scenario
+ * No version actually
+ * No overall criteria (PASS/FAIL)
+ * Difficult refactoring
+ </section>
+ <section>
+ <h2>Colorado refactoring</h2>
+ <ul>
+ <li>Unit tests</li>
+ <li>Update of the data model</li>
+ <li>Tornado_swagger for the documentation</li>
+ <li>URL and MongoDB collection renaming</li>
+ <li>Scripts to support databse backup/restore/update</li>
+ <li>Support installation</li>
+ <aside class='notes'>
+ So you can discover and understand the capabilities of the service without
+ access to source code, documentation, or through network traffic inspection,
+ and also you can interact with the testAPI directly through swagger website.
+ </aside>
+ </ul>
+ <p class="fragment fade-up"><b>All done in Colorado!</b></p>
+ </section>
+ </section>
+
+ <section>
+ <section data-markdown>
+ # API Evoluation
+ </section>
+
+ <section>
+ <h2> URI changes...</h2>
+ <div style="text-align:left"">
+ <p> testresults.opnfv.org/<span style="color:lightblue">testapi</span> => <br>testresults.opnfv.org/<span style="color:yellow">test/api/v1</span> </p>
+
+ <p> /test/api/v1/<b>pods</b></p>
+ <p> /test/api/v1/<b>projects</b></p>
+ <p> /test/api/v1/projects/qtip/<b>cases</b></p>
+ <p> /test/api/v1/<b>results</b></p>
+ </div>
+ </section>
+ <section data-markdown>
+ ## One new field for pods
+ | Field | Colorado |
+ | :--- | :--- |
+ | role | community_pod, ci_pod, .. |
+ </section>
+ <section data-markdown>
+ ## Changed fields for results
+ | Item | Brahmaputra | Colorado |
+ | :--- | :--- | :--- |
+ | date | creation_date | start_date and stop_date |
+ | version | used as scenario | opnfv release version |
+ </section>
+ <section data-markdown>
+ <script type='text/template'>
+ ## New fields for results
+ | Item | Colorado |
+ | :--- | :--- |
+ | scenario | used for scenario |
+ | criteria | PASS/FAILED |
+ | trust_indicator | between 0 and 1|
+ <aside class='notes'>
+ to detect if the test case is stable over time and further more to avoid
+ running it systematically and saving time for other long duration test cases
+ </aside>
+ </script>
+ </section>
+ <section data-markdown>
+ ## One new filter for results
+ | Item | Colorado |
+ | :--- | :--- |
+ | last | get last N results|
+ </section>
+ <section data-markdown>
+ http://testresults.opnfv.org/test/swagger/spec.html
- </section>
-<section>
- <h2>unit tests</h2>
- <pre><code class="hljs" data-trim contenteditable>
+ </section>
+ <section>
+ <h2>unit tests</h2>
+
<pre><code class="hljs" data-trim contenteditable>
umry8364@umry8364-Latitude-E6400:~/Dev/OPNFV/releng/utils/test/result_collection_api$ ./run_test.sh
Tests running...
WARNING:tornado.general:404 GET /dashboard/v1/results?case=vPing&pod=zte-pod1&version=C&installer=fuel&period=5 (127.0.0.1): Project name missing
Ran 74 tests in 1.848s
OK
- </code></pre>
+ </code></pre>
+ </section>
</section>
- </section>
+
<section>
- <h3>Thank you</h3>
- <img width="600" data-src="../img/colorado.png" alt="tests">
+ <section data-markdown>
+ # Roadmap
+ </section>
+ <section data-markdown>
+ ## Roadmap
+ * Dockerize testAPI
+ * Automatic update of testAPI
+ * Command Line Interface
+ * Automatic update for pods/projects/testcases
+ </section>
+ <section data-markdown>
+ # suggestions ...
+ </section>
+ <section>
+ <h3>Thank you</h3>
+ <img width="600" data-src="../img/colorado.png" alt="tests">
+ </section>
</section>
-
</div>
- <div class='footer'>
- <img src="../img/logo-OPNFV.png" alt="OPNFV logo">
- </div>
+ <img src="../img/logo-OPNFV-Berlin.png" alt="OPNFV logo">
+ </div>
</div>
<script src="../lib/js/head.min.js"></script>
Code Review / functest.git / blobdiff