forked from qgis-it/qgis-it.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
processing_tests.html
402 lines (369 loc) · 23.6 KB
/
processing_tests.html
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<!doctype html>
<html>
<head>
<title>Gruppo degli utenti italiani di QGIS</title>
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.0.3/css/bootstrap.min.css">
<link href='http://fonts.googleapis.com/css?family=Lato:900,100' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="styles.css">
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
<script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.0.3/js/bootstrap.min.js"></script>
<script>
$(function(){
// bind change event to select
$('#other_groups').bind('change', function () {
var url = $(this).val(); // get selected value
if (url) { // require a URL
window.location = url; // redirect
}
return false;
});
});
</script>
</head>
<body>
<!-- QGIS.org NAVBAR -->
<!-- This is the old navbar, not static!-->
<!-- <div class="navbar navbar-default" role="navigation"> -->
<!--new navbar position: fixed on top -->
<div class="navbar navbar-fixed-top" role="navigation">
<div class="container-fluid">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://qgis.org/it/site/"></a>
</div>
<div class="collapse navbar-collapse" id="nav-collapse">
<ul class="nav navbar-nav">
<li><a href="http://qgis.org/it/site/about/index.html">Scopri QGIS</a></li>
<li><a href="http://qgis.org/it/site/forusers/index.html">Per gli utenti</a></li>
<li><a href="http://qgis.org/it/site/getinvolved/index.html">Partecipa</a></li>
<li><a href="http://qgis.org/it/docs/index.html">Documentazione</a></li>
<li><a href="http://qgis.it/traduzione.html">Traduzione</a></li>
<li class="navbar-dropdown">
<div class="select-dropdown">
<select id="other_groups">
<option value="" title="none">Altri gruppi utenti QGIS</option>
<optgroup label="America">
<option title="USA" value="http://qgis.us/">U.S.A.</option>
</optgroup>
<optgroup label="Europa">
<option title="UK" value="http://qgis.uk/">Gran Bretagna</option>
<option title="IE" value="https://ieqgis.wordpress.com/category/qgis/">Irlanda</option>
<option title="Olanda" value="http://www.qgis.nl/">Olanda</option>
<option title="Portogallo" value="http://qgis.pt/">Portogallo</option>
<option title="Svizzera" value="http://qgis.ch">Svizzera</option>
<optgroup label="Oceania">
<option title="ANZ" value="https://sites.google.com/site/ausqgis/home">Australia & NZ</option>
</optgroup>
</select>
</div>
</li>
</ul>
</div>
</div>
</div>
<!-- TITLE & PAGE NAV -->
<div class="container">
<div class="container-page">
<div class="row">
<div class="col-xs-12 page-title">Gruppo degli utenti italiani di QGIS</div>
</div>
<div class="row">
<div class="col-sm-12 col-md-8">
<ul class="page-nav">
<li>
<a href="http://qgis.it/#about">Obiettivi</a>
</li>
<li>
<a href="http://qgis.it/#meetings">Partecipa</a>
</li>
<li>
<a href="http://qgis.it/#cooperate">Collabora</a>
</li>
<li>
<a href="http://qgis.it/#support">Sostieni</a>
</li>
<li>
<a href="http://qgis.it/processing_tests.html">Processing Test</a>
</li>
<li>
<a href="http://qgis.it/#translation">Traduzioni</a>
</li>
<li>
<a href="http://qgis.it/#contact">Contatti</a>
</li>
</ul>
</div>
</div>
<h2 class="featurette-heading">Come aggiungere un test per Processing in QGIS</h2>
<p class="lead">
Questo articolo nasce dopo aver discusso alla scorsa Hack Fest di Padova. Un sentito grazie a tutte le persone che hanno mostrato interesse all'argomento.
<br>
La guida ufficiale dell'architettura dei test è disponibile <a href="https://github.com/qgis/QGIS/tree/master/python/plugins/processing/tests">qui
</a></p>
<h3 class="featurette-heading">Come funzionano gli unit test</h3>
<p class="lead">
Gli unit test sono una parte di ogni programma (anche se non è proprio la parte più interessante da scrivere) perchè permettono di scovare eventuali errori <strong>prima</strong> del rilascio di una versione del software.
<br>
Per intenderci meglio: uno sviluppatore cambia qualcosa in un algoritmo ma scrive male una stringa. Questo algoritmo <strong>non</strong> funzionerà.
<br>
Gli unit test servono proprio a <strong>prevenire</strong> questi errori.
<br>
La teoria è molto semplice. Un test lancia l'algoritmo e confronta questi output con dei risultati veri e che sono stati verificati.
<br>
Se l'output è diverso dal risultato attesto il test fallisce e si viene informati dell'errore (quale riga ha causato quale errore).
</p>
<h3 class="featurette-heading">Cosa sono gli unit test di Processing</h3>
<p class="lead">
Nel caso specifico di Processing gli output di un algoritmo (ovvero dei vettori o dei raster) vengono confrontati con layer verificati da chi ha creato il test. Se durante il confronto qualcosa non torna (layer è in una posizione diversa, dovrebbe essere un punto invece è una linea, non c'è proprio un risultato, ecc..) il test fallisce.
<br>
Il codice di QGIS è ospitato su <a href="https://github.com/">Github</a>. Il <em>motore</em> dei test è invece ospitato su <a href="https://travis-ci.org/">Travis</a>.
<br>
Detta in parole semplici: quando uno sviluppatore cambia qualcosa nel codice e manda le sue modifiche (chiamate <strong>commit</strong>) al codice sorgente, Travis inizia una vera e propria compilazione di QGIS in remoto.
<br>
Durante la compilazione vengono fatti girare i vari test e se qualcosa non va si capisce subito quale modifica ha causato l'errore.
<br>
Questo sistema di prevenzione ha un <strong>valore intrinseco immenso</strong> in quanto per tutti gli algoritmi (ma non solo, infatti ogni <em>pezzo</em> di QGIS può essere accompagnato da un test) di cui esiste un test si ha la garanzia che funzionino e che continuino a funzionare.
</p>
<h2 class="featurette-heading">Come si creano test per Processing</h2>
<p class="lead">
Tutti (ma proprio tutti) possono aggiungere dei test per Processing. Il processo è un po' macchinoso, ma ne vale la pena.
</p>
<h3 class="featurette-heading">Requisiti</h3>
<p class="lead">
L'architettura dei test necessita di alcuni software e accorgimenti, in particolare si appoggia interamente al software di controllo versioni <a href="https://git-scm.com/">git</a>. Oltre a git consiglio l'utilizzo di un editor di testo avanzato (non avanzatissimo però ecco, non un blocco note).
<br>
Il flusso di lavoro, anche se complesso, è piuttosto lineare:
<ul class="lead">
<li>creazione account su <a href="https://github.com/">Github</a></li>
<li>fork del repository di QGIS sul proprio account. Questa operazione permette di avere una copia del codice di QGIS ma sul proprio account</li>
<li>clonazione della copia <em>forkata</em>. Ovvero copiare sulla macchina locale la copia personale di QGIS</li>
<li>utilizzare l'ultima versione di QGIS master</li>
<li>scegliere un algoritmo di cui non esiste ancora un test</li>
<li>lanciare l'algoritmo e verificare che il risultato sia corretto</li>
<li>copiare il test e i risultati in una particolare cartella di QGIS</li>
<li>inviare il test e i risultati dal computer locale alla pripria copia su github</li>
<li>fare una pull request, ovvero chiedere che le modifiche della proprio copia di QGIS vengano incorporate nel codice sorgente <em>vero</em></li>
</ul>
<p class="lead">
Ammetto che il tutto può spaventare, ma è più lineare di quello che si può immaginare. Procediamo per punti.
</p>
<br>
</p>
<h4 class="featurette-heading-minus">0. scaricare e installare git sul proprio computer</h4>
<p class="lead">
La procedura è semplice anche per chi usa Windows. Rimando al sito ufficiale per tutte le informazioni <a href="https://git-scm.com/downloads">git</a>
</p>
<h4 class="featurette-heading-minus">1. creare un account su github</h4>
<p class="lead">
Anche in questo caso non c'è tanto da spiegare, si fa tutto dal sito di <a href="https://github.com/">Github</a>
</p>
<h4 class="featurette-heading-minus">2. Fare un <em>fork</em> di QGIS</h4>
<p class="lead">
Questa procedura viene interamente fatta dal sito di <a href="https://github.com/">Github</a>
</p>
<ul class="lead">
<li>cercare il repository di QGIS</li>
</ul>
<div class="figure">
<img src="images/processing_test/repo_qgis.png" width=60% height=60%>
</div>
<ul class="lead">
<li>cliccare sul pulsante <strong>fork</strong></li>
</ul>
<div class="figure">
<img src="images/processing_test/fork_qgis.png" width=60% height=60%>
<p class="caption">alt text</p>
</div>
<ul class="lead">
<li>a questo punto si avrà la copia <em>forkata</em> di QGIS sul proprio account di github</li>
</ul>
<div class="figure">
<img src="images/processing_test/forked_qgis.png" width=60% height=60%>
</div>
<h4 class="featurette-heading-minus">3. clonare il fork sul proprio computer</h4>
<p class="lead">
La procedura cambia a seconda del sistema operativo. Di seguito un esempio su una macchina Linux
</p>
<ul class="lead">
<li>
aprire un terminale e spostarsi nella cartella in cui si vuole clonare il repository forkato. Una volta scelta la cartella bisogna copiare l'url di github del fork...
</li>
</ul>
<div class="figure">
<img src="images/processing_test/copy_fork.png" width=60% height=60%>
</div>
<ul class="lead">
<li>
... e incollarlo nel terminale con il seguente comando <code>git clone [email protected]:ghtmtt/QGIS.git</code>:
</li>
</ul>
<div class="figure">
<img src="images/processing_test/clone_fork.png" width=40% height=40%>
</div>
<p class="lead">
ora basta aspettare un po' (il repository di QGIS pesa poco più di un GB) e si avrà una esatta copia locale su cui si potrà lavorare
</p>
<h4 class="featurette-heading-minus">4. Usare l'ultima versione di QGIS master</h4>
<p class="lead">
Anche se i test possono essere aggiunti per qualunque versione di QGIS il consiglio è quello di utilizzare l'ultima versione di QGIS disponibile.
</p>
<h4 class="featurette-heading-minus">5. Scegliere un algoritmo di cui ancora non esiste un test</h4>
<p class="lead">
Ci sono già diversi algoritmi di Processing che sono accompagnati da test. L'elenco di tutti i test già eseguiti è presente in un file <code>qgis_algorithm_tests.yaml</code>. Questo file si trova dentro il repository appena clonato, ovvero nella cartella: <code>QGIS/python/plugins/processing/tests/testdata</code>
</p>
<p class="lead">
Per vedere quali algoritmi hanno già un test si può aprire il file <code>qgis_algorithm_tests.yaml</code> cercare il nome <strong>inglese</strong> dell'algoritmo. Per esempio l'algoritmo <code>Densify geometries</code> ha già un test e lo si può trovare cercando <code>qgis:densifygeometries</code>:
<div class="figure">
<img src="images/processing_test/densify_test.png" width=40% height=40%>
</div>
</p>
<p class="lead">È quindi <strong>fondamentale</strong> cercare <strong>prima</strong> gli algoritmi sprovvisti di test per evitare di creare dei doppioni.
</p>
<h4 class="featurette-heading-minus">6. Lanciare l'algoritmo e verificare che il risultato sia corretto</h4>
<p class="lead">
Tutta questa parte si svolge <strong>dentro</strong> QGIS.
</p>
<p class="lead">
L'architettura dei test è accompagnata da alcuni dati predefiniti da utilizzare. Se i dati forniti non dovessero essere adatti si possono tranquillamente aggiungere altri dati nel repository.
</p>
<p class="lead">
Questi dati (ed eventualmente anche dati creati ad hoc) sono nella cartella: <code>QGIS/QGIS/python/plugins/processing/tests/testdata/custom</code> del repository locale di QGIS.
</p>
<p class="lead">
Affinchè i test funzionino correttamente è <strong>fondamentale</strong> usare <strong>solamente</strong> dati presenti in questa cartella.
Quindi caricate i dati predefiniti in questa cartella e scegliete l'algoritmo che volete testare, in questo esempio l'algoritmo <code>Difference</code>:
</p>
<div class="figure">
<img src="images/processing_test/loading_data.png" width=80% height=80%>
</div>
<p class="lead">
Lanciare l'algoritmo e verificare che il risultato sia corretto.
</p>
<h4 class="featurette-heading-minus">7. Copiare il test e i risultati in una particolare cartella di QGIS</h4>
<p class="lead">
Se tutto si è svolto correttamente, il risultato deve essere salvato come file <strong>gml</strong> nella cartella <code>QGIS/QGIS/python/plugins/processing/tests/testdata/expected</code> del repository di QGIS:
</p>
<div class="figure">
<img src="images/processing_test/difference.png" width=60% height=60%>
</div>
<p class="lead">
Se avete lanciato l'algoritmo con i dati di input dalla cartella corretta e avete salvato il risultato nella cartella coerente, siete pronti per copiare una specifica stringa che l'architettura degli unit test ha creato.
</p>
<p class="lead">
Cliccate su Processing --> Storico e Log e espandete il menu degli algoritmi. Il primo della lista è l'algoritmo più recente che avete lanciato. Facendo click con il tasto denstro compare l'opzione <code>Create Test</code>:
</p>
<div class="figure">
<img src="images/processing_test/create_test.png" width=50% height=50%>
</div>
<p class="lead">
e si aprirà una nuova finestra con una stringa di testo:
</p>
<div class="figure">
<img src="images/processing_test/unit_test.png" width=50% height=50%>
</div>
<p class="lead">
Questa string va copiata e incollata in fondo al file <code>qgis_algorithm_tests.yaml</code> che si trova nella cartella <code>QGIS/python/plugins/processing/tests/testdata</code>.
</p>
<p class="lead">
State <strong>attenti</strong> all'indentazione, ovvero all'allineamento del testo copiato: deve essere perfettamente coerente con gli altri test.
</p>
<h4 class="featurette-heading-minus">8. Inviare il test e i risultati dal computer locale alla pripria copia su Github</h4>
<p class="lead">
Il test è pronto: avete infatti creato dei dati nuovi (il layer gml) e avete copiato la stringa dello unit test nel file corretto.
</p>
<p class="lead">
Il prossimo passaggio consiste nel sincronizzare la cartella locale del repository sul vostro computer con il repository <em>forkato</em> ovvero quello presente sull'vostro account di github.
</p>
<p class="lead">
Tutte queste procedure vengono fatte tramite <strong>git</strong>. Sul <a href="http://docs.qgis.org/2.18/en/docs/documentation_guidelines/first_contribution.html#using-git-command-line-tools">sito di QGIS</a> c'è un'ottima spiegazione (anche se riguarda la documentazione) di come utlizzare git. Il procedimento è esattemente lo stesso.
</p>
<p class="lead">
Di seguito un esempio per Linux. Aprite un terminale e spostatevi nella cartella del repository, nel seguente esempio la cartella è <code>QGIS</code>:
</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">cd</span> QGIS</code></pre></div>
<p class="lead">
potete verificare i cambiamenti che avete fatto con il comando <code>git status</code> che restituisce:
</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">
<span class="kw">git status</span>
<span class="kw">On branch master</span>
<span class="kw">Your branch is ahead of <span class="st">'origin/master'</span> by 104 commits.</span>
<span class="kw">(use</span> <span class="st">"git push"</span> to publish your local commits<span class="kw">)</span>
<span class="kw">Untracked</span> files:
<span class="kw">(use</span> <span class="st">"git add <file>..."</span> to include in what will be committed<span class="kw">)</span>
<span class="kw">python/plugins/processing/tests/testdata/expected/difference.gml</span>
<span class="kw">python/plugins/processing/tests/testdata/expected/difference.xsd</span>
<span class="kw">nothing</span> added to commit but untracked files present (use <span class="st">"git add"</span> to track)</code>
</pre></div>
<p class="lead">
Il consiglio è quello di <strong>NON</strong> usare il branch <code>master</code> ma di crearne uno vostro che potete sempre cancellare e aggiornare, ma di cui siete sicuri che non avrà alcun effetto sul branch principale. Il comando per creare un branch è il seguente:
</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">git</span> checkout -b processing_test_difference</code></pre></div>
<p class="lead">
dove <code>processing_test_difference</code> è il nome del branch che potete modificare come volete.
</p>
<p class="lead">
Aggiungete i file con il comando <code>git add .</code> accompagnato in un secondo momento dal comando <code>git commit -m "test for difference algorithm added"</code> dove fra <code>""</code> dovete specificare il messaggio di cosa avete fatto:
</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">
<span class="kw">git add .</span>
<span class="kw">git commit -m</span>
<span class="st">"test for difference algorithm added"</span>
<span class="kw">prova</span> f3fcde1 test for difference algorithm added
<span class="kw">2</span> files changed, 47 insertions(+)
<span class="kw">create</span> mode 100644 python/plugins/processing/tests/testdata/expected/difference.gml
<span class="kw">create</span> mode 100644 python/plugins/processing/tests/testdata/expected/difference.xsd</code>
</pre>
</div>
<p class="lead">
a questo punto per sincronizzare il repository locale con quello del vostro account su github lanciate il comando:
</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">git</span> push origin processing_test_difference</code></pre></div>
<p class="lead">
Quindi state inviando le modifiche del branch processing_test_difference al branch origin che è il nome predefinito del repository di github.
</p>
<h4 class="featurette-heading-minus">9. Fare una pull request, ovvero chiedere che le modifiche della proprio copia di QGIS vengano incorporate nel codice sorgente <em>vero</em></h4>
<p class="lead">
Sul vostro repository di github vedrete un messaggio del genere:
</p>
<div class="figure">
<img src="images/processing_test/push_origin.png" width=60% height=60%>
</div>
<p class="lead">
cliccando sul pulsante <code>Compare & pull request</code> potete chiedere che le modifiche del vostro repository vengano mandate anche al repository originale di QGIS. Compilate con cura i vari campi. importante è che le modifiche del vostro branch siano mandate al branch master di QGIS e che il titolo della Pull Request sia esplicativo. Questo permetterà agli sviluppatori di velocizzare la verifica delle modifiche:
</p>
<div class="figure">
<img src="images/processing_test/pull_request.png" width=80% height=80%>
</div>
<p class="lead">
Quando siete sicuri cliccate su <code>Create Pull Request</code>. Verrete reindirizzati all'elenco di tutte le Pull Request di QGIS dove potete vedere l'avanzamento della compilazione remota di QGIS e verificare che il procedimento sia stato effettuato correttamente:
</p>
<p class="lead">
Quando gli sviluppatori lo riterranno opportuno uniranno la vostra Pull Request (tecnicamente faranno un <em>merge</em>) e quell'algoritmo di QGIS sarà cosi blindato.
</p>
<!-- PAGE FOOTER -->
<footer class="footer">
<div class="container">
<ul id="social">
<li id="facebook"><a href="https://www.facebook.com/qgis.it" class="external"><div></div></a></li>
<li id="github"><a href="http://github.com/qgis/" class="external"><div></div></a></li>
<li id="contact"><a href="mailto:[email protected]?subject=Info_sito"><div></div></a></li>
<!-- qualche social non ancora attivo
<li id="twitter"><a href="##local twitter account" class="external"><div></div></a></li>
<li id="gplus"><a href="##local gplus account" class="external"><div></div></a></li>
-->
</ul>
</div>
<p class="footer credit">If not stated otherwise, all content is licensed under <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 licence (CC BY-SA)</a></p>
<p class="footer credit">Select graphics from<a href="http://thenounproject.com"> The Noun Project</a></p>
</footer>
</body>
</html>