aboutsummaryrefslogtreecommitdiffstats
path: root/docs/com/pres/Summit/Berlin-2016/testapi.html
blob: 16f97c44d64c681dedc35df5c2c47ff8055d69c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<!doctype html>
<html lang="en">

	<head>
		<meta charset="utf-8">

		<title>OPNFV presentation</title>

		<meta name="description" content="TestAPI">
		<meta name="author" content="Serena Feng">

		<meta name="apple-mobile-web-app-capable" content="yes" />
		<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />

		<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-Berlin.css" id="theme">

		<!-- Code syntax highlighting -->
		<link rel="stylesheet" href="../../../lib/css/zenburn.css">

		<!-- Printing and PDF exports -->
		<script>
			var link = document.createElement( 'link' );
			link.rel = 'stylesheet';
			link.type = 'text/css';
			link.href = window.location.search.match( /print-pdf/gi ) ? '../../../css/print/pdf.css' : '../../../css/print/paper.css';
			document.getElementsByTagName( 'head' )[0].appendChild( link );
		</script>

		<!--[if lt IE 9]>
		<script src="lib/js/html5shiv.js"></script>
		<![endif]-->
	</head>

	<body>

		<div class="reveal">
			<!-- Any section element inside of this container is displayed as a slide -->
			<div class="slides">

				<section data-background="../../../img/title-bg-berlin.png" data-background-transition="none">
					<br><br><br><br><br>
					<h1>TestAPI</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
					* TestAPI: what for?
					* API overview
					* API evolution
					* Roadmap
				</section>

				<section>
					<section data-markdown>
						# TestAPI: 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
						![TestAPI](https://wiki.opnfv.org/download/attachments/2926452/results_collection_structure.png?version=1&modificationDate=1459196347000&api=v2 "OPNFV API page")
					</section>
					<section data-markdown>
						## API in Brahmaputra
						![TestAPI](../../../img/testapi0.png)
						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
						![alt text](../../../img/testapi1.png "TestAPI swagger interface")
					</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
WARNING:tornado.access:404 GET /dashboard/v1/results?case=vPing&pod=zte-pod1&version=C&installer=fuel&period=5 (127.0.0.1) 2.30ms
WARNING:tornado.general:400 POST /api/v1/projects (127.0.0.1): name missing
............
WARNING:tornado.access:400 POST /api/v1/projects (127.0.0.1) 1.13ms
WARNING:tornado.access:403 PUT /api/v1/projects/functest/cases/vping_1 (127.0.0.1) 2.95ms
WARNING:tornado.general:404 PUT /api/v1/projects/functest/cases/notFound (127.0.0.1): {'project_name': u'functest', 'name': u'notFound'} could not be found in table [testcases]
WARNING:tornado.access:404 PUT /api/v1/projects/functest/cases/notFound (127.0.0.1) 2.85ms

Ran 74 tests in 1.848s
OK
						</code></pre>
					</section>
				</section>

				<section>
					<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-Berlin.png" alt="OPNFV logo">
			</div>
		</div>

		<script src="../../../lib/js/head.min.js"></script>
		<script src="../../../js/reveal.js"></script>

		<script>

			// Full list of configuration options available at:
			// https://github.com/hakimel/reveal.js#configuration
			Reveal.initialize({
				controls: true,
				progress: true,
				history: true,
				center: true,

				transition: 'slide', // none/fade/slide/convex/concave/zoom

				// Optional reveal.js plugins
				dependencies: [
					{ src: '../../../lib/js/classList.js', condition: function() { return !document.body.classList; } },
					{ src: '../../../plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
					{ src: '../../../plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
					{ src: '../../../plugin/highlight/highlight.js', async: true, condition: function() { return !!document.querySelector( 'pre code' ); }, callback: function() { hljs.initHighlightingOnLoad(); } },
					{ src: '../../../plugin/zoom-js/zoom.js', async: true },
					{ src: '../../../plugin/notes/notes.js', async: true }
				]
			});

		</script>

	</body>
</html>