-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
feed.xml
335 lines (212 loc) · 51.7 KB
/
feed.xml
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
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" >
<generator uri="https://jekyllrb.com/" version="4.1.1">Jekyll</generator>
<link href="https://old.tacosdedatos.com/tag/pytest/feed.xml" rel="self" type="application/atom+xml" />
<link href="https://old.tacosdedatos.com/" rel="alternate" type="text/html" />
<updated>2021-08-01T20:46:16+00:00</updated>
<id>https://old.tacosdedatos.com/tag/pytest/feed.xml</id>
<title type="html">🌮 tacos de datos | Aprende visualización de datos en español. | </title>
<subtitle>Tu sitio para aprender de visualización y ciencia de datos en español. Consejos, recursos y mejores prácticas para tus proyectos de tecnología, periodismo de datos y análisis estadísticos.</subtitle>
<entry>
<title type="html">Probando nuestro código con pytest</title>
<link href="https://old.tacosdedatos.com/pruebas-unitarias-pytest" rel="alternate" type="text/html" title="Probando nuestro código con pytest" />
<published>2020-05-12T10:00:00+00:00</published>
<updated>2020-05-12T10:00:00+00:00</updated>
<id>https://old.tacosdedatos.com/pruebas-unitarias-pytest</id>
<content type="html" xml:base="https://old.tacosdedatos.com/pruebas-unitarias-pytest"><h4 id="aviso">Aviso</h4>
<p>A lo largo de este post estaré probando las funciones del código que escribí para el post sobre la <a href="https://tacosdedatos.com/generacion-automatica-datasets">generación automática de datasets</a>; sin embargo no es necesario que leas ese post primero, pero seguramente te ayudará a ponerle más contexto al código que aquí se presenta.</p>
<h2 id="qué-es-pytest">¿Qué es <em>pytest</em>?</h2>
<p><em>pytest</em> es un <em>framework</em> para Python que ofrece la recolección automática de los <em>tests</em>, aserciones simples, soporte para <em>fixtures</em>, <em>debugeo</em> y mucho más… no te preocupes si algunas de estas palabras no te hacen mucho sentido; intentaré aclararlos más adelante a lo largo de este post.</p>
<p>Por cierto, <em>pytest</em> no es el único <em>framework</em> disponible; también está <em>nose</em>, <em>doctest</em>, <em>testify</em>… pero <em>pytest</em> es el que uso y de el que conozco más.</p>
<p>Para obtener <em>pytest</em> lo puedes descargar desde PyPI con tu gestor de paquetes de elección:</p>
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pip <span class="nb">install </span>pytest
</code></pre></div></div>
<h2 id="escribiendo-nuestros-tests">Escribiendo nuestros <em>tests</em></h2>
<p>Para escribir las pruebas es necesario escribir funciones que comiencen con el prefijo <code class="language-plaintext highlighter-rouge">test_</code>. Es necesario que las llamemos así ya que al momento de ejecutar <em>pytest</em> debemos especificar un directorio raíz, a partir de este directorio <em>pytest</em> leerá todos los archivos buscando funciones que comiencen con <code class="language-plaintext highlighter-rouge">test_</code>. Por ejemplo, si miras el <a href="https://github.com/fferegrino/medium-collector">repositorio de <em>medium-collector</em></a>, verás que todos los <em>tests</em> están contenidos dentro de un folder apropiadamente llamado <em>tests</em>. Para ejecutar todas las pruebas, lo que tenemos que hacer es ejecutar <em>pytest</em> con esta carpeta como argumento:</p>
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pytest tests/
</code></pre></div></div>
<h2 id="parametrizando-nuestras-pruebas">Parametrizando nuestras pruebas</h2>
<p>Comencemos por escribir un test sencillo: una sola entrada, una sola salida. y sin llamadas a servicios externos. Me refiero a una función que toma una cadena codificada (como esta: <code class="language-plaintext highlighter-rouge">=?UTF-8?B?VGhlcmXigJlz?= more to the story</code>) y regresa otra cadena (como esta: <code class="language-plaintext highlighter-rouge">There’s more to the story</code>), en este caso estoy hablando sobre la función <a href="https://github.com/fferegrino/medium-collector/blob/v0.0.0/medium_collector/download/parser.py#L12"><code class="language-plaintext highlighter-rouge">get_subject</code> method</a>:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">get_subject</span><span class="p">(</span><span class="n">subject</span><span class="p">):</span>
<span class="n">subject_parts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">subjects</span> <span class="o">=</span> <span class="n">email</span><span class="p">.</span><span class="n">header</span><span class="p">.</span><span class="n">decode_header</span><span class="p">(</span><span class="n">subject</span><span class="p">)</span>
<span class="k">for</span> <span class="n">content</span><span class="p">,</span> <span class="n">encoding</span> <span class="ow">in</span> <span class="n">subjects</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">subject_parts</span><span class="p">.</span><span class="n">append</span><span class="p">(</span><span class="n">content</span><span class="p">.</span><span class="n">decode</span><span class="p">(</span><span class="n">encoding</span> <span class="ow">or</span> <span class="s">"utf8"</span><span class="p">))</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">subject_parts</span><span class="p">.</span><span class="n">append</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
<span class="k">return</span> <span class="s">""</span><span class="p">.</span><span class="n">join</span><span class="p">(</span><span class="n">subject_parts</span><span class="p">)</span>
</code></pre></div></div>
<p>Para escribir una prueba unitaria es tan “simple” como hacer esto:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">test_get_subject</span><span class="p">():</span>
<span class="n">expected</span> <span class="o">=</span> <span class="s">"There's more to the story"</span>
<span class="n">actual</span> <span class="o">=</span> <span class="n">get_subject</span><span class="p">(</span><span class="s">"=?UTF-8?B?VGhlcmXigJlz?= more to the story"</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">expected</span> <span class="o">==</span> <span class="n">actual</span>
</code></pre></div></div>
<p>Sin embargo, esta funcion necesita ser probada con el caso en donde toda la cadena está codificada, o el caso en donde no lo está. Para cubrir estos casos tendríamos que escribir métodos como <code class="language-plaintext highlighter-rouge">test_get_subject_all_encoded</code> y <code class="language-plaintext highlighter-rouge">test_get_subject_none_encoded</code>, pero eso sería una duplicación absurda de código, para solucionar este problema de <strong>probar el mismo código con múltiples valores de entrada</strong> podemos hacer uso de la <strong>parametrización</strong> usando el decorador <code class="language-plaintext highlighter-rouge">@pytest.mark.parametrize</code>:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">pytest</span>
<span class="o">@</span><span class="n">pytest</span><span class="p">.</span><span class="n">mark</span><span class="p">.</span><span class="n">parametrize</span><span class="p">(</span>
<span class="p">[</span><span class="s">"input_subject"</span><span class="p">,</span> <span class="s">"expected"</span><span class="p">],</span>
<span class="p">[</span>
<span class="c1"># Input 1
</span> <span class="p">(</span>
<span class="s">"=?UTF-8?B?V2hlbiBhICQxMDAsMDAwIFNhbGFyeSBJc27igJl0IEVub3VnaCB8IEFkYW0gUGFyc29ucyBpbiBNYWtpbmcgb2YgYSBNaWxsaW8=?= =?UTF-8?B?bmFpcmU=?="</span><span class="p">,</span>
<span class="s">"When a $100,000 Salary Isn’t Enough | Adam Parsons in Making of a Millionaire"</span><span class="p">,</span>
<span class="p">),</span>
<span class="c1"># Input 2
</span> <span class="p">(</span>
<span class="s">"=?UTF-8?B?VGhlcmXigJlz?= more to the story"</span><span class="p">,</span>
<span class="s">"There’s more to the story"</span>
<span class="p">),</span>
<span class="c1"># Input 3
</span> <span class="p">(</span>
<span class="s">"7 Things Rich People Advise But Never Do | David O. in The Startup"</span><span class="p">,</span>
<span class="s">"7 Things Rich People Advise But Never Do | David O. in The Startup"</span><span class="p">,</span>
<span class="p">),</span>
<span class="p">],</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">test_get_subject</span><span class="p">(</span><span class="n">input_subject</span><span class="p">,</span> <span class="n">expected</span><span class="p">):</span>
<span class="n">actual</span> <span class="o">=</span> <span class="n">get_subject</span><span class="p">(</span><span class="n">input_subject</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">actual</span> <span class="o">==</span> <span class="n">expected</span>
</code></pre></div></div>
<p>El código anterior le indica a <em>pytest</em> que ejecute la prueba <code class="language-plaintext highlighter-rouge">test_get_subject</code> tres veces, cada una reemplazando <code class="language-plaintext highlighter-rouge">input_subject</code> y <code class="language-plaintext highlighter-rouge">expected</code> con sus valores correspondientes especificados en el segundo argumento de <code class="language-plaintext highlighter-rouge">parametrize</code>.</p>
<h2 id="fixtures">Fixtures</h2>
<p>En algunas ocasiones tal vez tengamos <strong>pruebas que comiencen desde cierto estado</strong>, este estado puede ser tener datos en una base de datos, tener archivos en alguna carpeta, o tal vez simplemente tener el objeto correcto como entrada a la función; es ahí donde las <em>fixtures</em> son útiles.</p>
<p>Por ejemplo, en el repositorio de <em>medium-colletor</em> hay una función llamada <code class="language-plaintext highlighter-rouge">parse_mail</code> que, como el nombre lo sugiere, podemos usar para extraer información de un objeto de la clase <code class="language-plaintext highlighter-rouge">email.message.Message</code>. Esta es una versión simplificada de la implementación del método:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">parse_mail</span><span class="p">(</span><span class="n">email_message</span><span class="p">):</span>
<span class="n">html</span> <span class="o">=</span> <span class="n">get_html</span><span class="p">(</span><span class="n">email_message</span><span class="p">)</span>
<span class="n">mail_info</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">"id"</span><span class="p">:</span> <span class="n">email_message</span><span class="p">[</span><span class="s">"Message-ID"</span><span class="p">],</span>
<span class="s">"to"</span><span class="p">:</span> <span class="n">email_message</span><span class="p">[</span><span class="s">"To"</span><span class="p">],</span>
<span class="s">"from"</span><span class="p">:</span> <span class="n">email_message</span><span class="p">[</span><span class="s">"From"</span><span class="p">],</span>
<span class="s">"subject"</span><span class="p">:</span> <span class="n">get_subject</span><span class="p">(</span><span class="n">email_message</span><span class="p">[</span><span class="s">"Subject"</span><span class="p">]),</span>
<span class="s">"date"</span><span class="p">:</span> <span class="n">email_message</span><span class="p">[</span><span class="s">"Date"</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">return</span> <span class="n">mail_info</span><span class="p">,</span> <span class="n">html</span>
</code></pre></div></div>
<p>Para probar esta función necesitamos un objeto de la clase <code class="language-plaintext highlighter-rouge">Message</code>, pero en realidad no quiero tener que conectarme a nuestro servidor de email cada vez que ejecutemos la prueba; este es el escenario perfecto para usar una <em>fixture</em>. Para definir una, tenemos que isar algo como el siguiente código:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">@</span><span class="n">pytest</span><span class="p">.</span><span class="n">fixture</span>
<span class="k">def</span> <span class="nf">dummy_mail</span><span class="p">():</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">MIMEMultipart</span><span class="p">(</span><span class="s">"alternative"</span><span class="p">)</span>
<span class="n">msg</span><span class="p">[</span><span class="s">"Subject"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"Link"</span>
<span class="n">msg</span><span class="p">[</span><span class="s">"From"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"you@this.com"</span>
<span class="n">msg</span><span class="p">[</span><span class="s">"To"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"me@that.com"</span>
<span class="n">msg</span><span class="p">[</span><span class="s">"Message-ID"</span><span class="p">]</span> <span class="o">=</span> <span class="s">"123"</span>
<span class="n">msg</span><span class="p">[</span><span class="s">"Date"</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">.</span><span class="n">now</span><span class="p">().</span><span class="n">strftime</span><span class="p">(</span><span class="s">"%a, %d %b %Y %H:%M:%S +0000 (UTC)"</span><span class="p">)</span>
<span class="n">text</span> <span class="o">=</span> <span class="s">"Hi!"</span>
<span class="n">html</span> <span class="o">=</span> <span class="sa">f</span><span class="s">"&lt;html&gt;&lt;head&gt;&lt;/head&gt;&lt;body&gt;&lt;p&gt;</span><span class="si">{</span><span class="n">text</span><span class="si">}</span><span class="s">&lt;br&gt;&lt;/body&gt;&lt;/html&gt;"</span>
<span class="n">msg</span><span class="p">.</span><span class="n">attach</span><span class="p">(</span><span class="n">MIMEText</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s">"plain"</span><span class="p">))</span>
<span class="n">msg</span><span class="p">.</span><span class="n">attach</span><span class="p">(</span><span class="n">MIMEText</span><span class="p">(</span><span class="n">html</span><span class="p">,</span> <span class="s">"html"</span><span class="p">))</span>
<span class="k">return</span> <span class="n">msg</span>
</code></pre></div></div>
<p>Lo primero que hay que notar es que <code class="language-plaintext highlighter-rouge">@pytest.fixture</code> es usado como decorador de… ¿¡una función!? Sí, así es, una <em>fixture</em> no es nada más que una función cuyo valor de retorno debe ser el valor que queremos que esa <em>fixture</em> tenga. En este caso, el valor de nuestra <em>fixture</em> será un objeto de la clase <code class="language-plaintext highlighter-rouge">MIMEMultipart</code> que hereda de <code class="language-plaintext highlighter-rouge">Message</code> que es justo lo que queremos.</p>
<p>Ahora, para usar nuestra <em>fixture</em> llamada <code class="language-plaintext highlighter-rouge">dummy_mail</code> en nuestra prueba es suficiente con pasarla como argumento en nuestra función de prueba:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">test_parse_mail</span><span class="p">(</span><span class="n">dummy_mail</span><span class="p">):</span>
<span class="n">expected_mail_info</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">"id"</span><span class="p">:</span> <span class="s">"ad841b37bd4b9b5403b575432f67f5ed2d68ed40"</span><span class="p">,</span>
<span class="s">"to"</span><span class="p">:</span> <span class="s">"a4747a50dad63531704f5ab32509bb0c60b7350f"</span><span class="p">,</span>
<span class="s">"from"</span><span class="p">:</span> <span class="s">"you@this.com"</span><span class="p">,</span>
<span class="s">"subject"</span><span class="p">:</span> <span class="s">"Link"</span><span class="p">,</span>
<span class="s">"date"</span><span class="p">:</span> <span class="n">ANY</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">mail_info</span><span class="p">,</span> <span class="n">decoded</span> <span class="o">=</span> <span class="n">parse_mail</span><span class="p">(</span><span class="n">dummy_mail</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">mail_info</span> <span class="o">==</span> <span class="n">expected_mail_info</span>
<span class="k">assert</span> <span class="n">decoded</span> <span class="o">==</span> <span class="s">"&lt;html&gt;&lt;head&gt;&lt;/head&gt;&lt;body&gt;&lt;p&gt;Hi!&lt;br&gt;&lt;/body&gt;&lt;/html&gt;"</span>
</code></pre></div></div>
<p>Cuando ejecutamos <em>pytest</em>, este tratará de resolverlas antes de que se ejecute cualquier prueba que las use, y una ves que estas estén listas, los métodos de prueba reciben los valores especificados en cada método asociado. Este mecanismo permite algunos otros usos interesantes de los que hablaré más adelante.</p>
<h3 id="una-característica-extra-de-las-fixtures">Una característica extra de las <em>fixtures</em></h3>
<p>Las <em>fixtures</em> de <em>pytest</em> son geniales, y otro de sus usos es cuando queremos reutilizar el mismo fragmento de código en dos o más funciones de prueba. Imagina que necesitamos usar un objeto de la clase <code class="language-plaintext highlighter-rouge">Message</code> para dos pruebas. Podríamos haber declarado una variable global, digamos <code class="language-plaintext highlighter-rouge">MESSAGE = MIMEMultipart("alternative")</code> y después usarla en nuestros métodos así:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">test_parse_mail_1</span><span class="p">():</span>
<span class="n">parse_mail</span><span class="p">(</span><span class="n">MESSAGE</span><span class="p">)</span>
<span class="c1"># ...
</span>
<span class="k">def</span> <span class="nf">test_parse_mail_2</span><span class="p">():</span>
<span class="n">parse_mail</span><span class="p">(</span><span class="n">MESSAGE</span><span class="p">)</span>
<span class="c1"># ...
</span></code></pre></div></div>
<p>Pero en este caso, ambos tests estarían usando la misma variable, <code class="language-plaintext highlighter-rouge">MESSAGE</code> lo que significa que cualquier cambio hecho por <code class="language-plaintext highlighter-rouge">test_parse_mail_1</code> afectaría el <code class="language-plaintext highlighter-rouge">MESSAGE</code> que <code class="language-plaintext highlighter-rouge">test_parse_mail_2</code> recibe, esto rompe el propósito de las pruebas unitarias, ya que nuestros <em>tests</em> no estarían aislados. Sin embargo, cuando usamos <em>fixtures</em>, cada función de prueba recibe una copia nueva de lo que sea que regrese nuestra función marcada con <code class="language-plaintext highlighter-rouge">@pytest.fixture</code>, haciendo fácil y sencillo usarlas una y otra vez.</p>
<h2 id="patching">Patching</h2>
<p>Sin lugar a dudas, algunas partes de nuestro código dependerán de librerías de terceros o a servicios externos que no queremos ejecutar o contactar cuando ejecutamos nuestras pruebas. Ya sea porque la librería que estamos usando consume muchos recursos o es un sistema productivo que no debería ser tocado durante las pruebas, aquí es cuando el <strong>patching</strong> brilla por su utilidad; este nos ayuda a <strong>reemplazar el comportamiento (o valores de retorno) de una llamada a una función</strong> con lo que nosotros dispongamos.</p>
<p>Imagina que la función <code class="language-plaintext highlighter-rouge">get_html</code> contiene código que es muy <em>“costoso”</em> ejecutar, y no lo queremos que este código se ejecute cada vez que llamamos al test <code class="language-plaintext highlighter-rouge">test_parse_mail</code>, entonces podemos <em>parcharlo</em> (tengo que decir que el <em>patching</em> no es una funcionalidad de <em>pytest</em> si no que viene con Python por default).</p>
<p>Hay dos formas de <em>“parchar”</em> nuestro código: una de ellas es haciendo uso de la instrucción <code class="language-plaintext highlighter-rouge">with</code>, pasando el nombre completo de la función que queremos <em>“parchar”</em>. Un test que aplica un <em>patch</em> a la función <code class="language-plaintext highlighter-rouge">get_html</code> dentro de <code class="language-plaintext highlighter-rouge">parse_email</code> se vería así:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">from</span> <span class="nn">unittest.mock</span> <span class="kn">import</span> <span class="n">patch</span>
<span class="k">def</span> <span class="nf">test_parse_mail</span><span class="p">(</span><span class="n">dummy_mail</span><span class="p">):</span>
<span class="n">expected_mail_info</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">"id"</span><span class="p">:</span> <span class="s">"ad841b37bd4b9b5403b575432f67f5ed2d68ed40"</span><span class="p">,</span>
<span class="c1"># ...
</span> <span class="p">}</span>
<span class="k">with</span> <span class="n">patch</span><span class="p">(</span><span class="s">"medium_collector.download.parser.get_html"</span><span class="p">,</span>
<span class="n">return_value</span><span class="o">=</span><span class="s">"Hello"</span><span class="p">)</span> <span class="k">as</span> <span class="n">patched</span><span class="p">:</span>
<span class="n">mail_info</span><span class="p">,</span> <span class="n">decoded</span> <span class="o">=</span> <span class="n">parse_mail</span><span class="p">(</span><span class="n">dummy_mail</span><span class="p">)</span>
<span class="n">patched</span><span class="p">.</span><span class="n">assert_called_once</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">mail_info</span> <span class="o">==</span> <span class="n">expected_mail_info</span>
<span class="k">assert</span> <span class="n">decoded</span> <span class="o">==</span> <span class="s">"Hello"</span>
</code></pre></div></div>
<p>En el fragmento anterior estamos <em>“parchando”</em> la función y estableciendo el valor de <code class="language-plaintext highlighter-rouge">"Hello"</code> como su valor de retorno con <code class="language-plaintext highlighter-rouge">return_value</code>. Esto significa que <code class="language-plaintext highlighter-rouge">"Hello"</code> será regresado cada vez que la función es ejecutada. Ahora que la función original no es realmente ejecutada, es importante que nos cercioremos que nuestro código está llamando a esta función, para esto podemos utilizar el método <code class="language-plaintext highlighter-rouge">assert_called_once</code> para verificar que lo hemos llamado.</p>
<h3 id="los-peligros-del-patching">Los peligros del <em>patching</em></h3>
<p>El <em>parcheo</em> podría parecer una solución fácil para evitar conectarse con servicios externos o llamadas a funciones costosas. Pero debes tener en cuenta que cuando <em>parchamos</em> algo, estamos asumiendo muchas cosas sobre el código que estamos <em>parchando</em>, estas asunciones son:</p>
<ul>
<li>Sabemos el comportamiento esperado del código que estamos <em>parchando</em>, es decir, sabemos sus valores de retorno y bajo que circunstancias falla.</li>
<li>Puedes, con completa seguridad, regresar un objeto que se comporte como el valor que originalmente sería retornado por la función real.</li>
</ul>
<p>Cuando aplicas un parche a una función, toma en cuenta que esta puede retornar un valor “complejo” que sea difícil de reproducir, y que <em>“parcharlo”</em> mal resultaría en tu código siendo probado ante un escenario que nunca ocurrirá en la vida real. Para evitar esto, tal vez tengas que examinar muy a detalla cuales son los valores de retorno de lo que estás <em>“parchando”</em> con el fin de hacerlo correctamente.</p>
<p>Otro problema muy común con el <em>patching</em> es que en nos podemos dejar llevar y terminar <em>“parchando”</em> todo… lo que, a final de cuentas nos pone en la situación de estar probando nuestro código en escenarios poco realistas. Si en algún momento te encuentras haciendo esto, es mejor que te detengas y reconsideres si las pruebas unitarias son la mejor solución para probar tu código… tal vez las pruebas de integración sean una mejor solución para tu problema de <em>testing</em>.</p>
<h2 id="fixtures-avanzadas"><em>Fixtures</em> avanzadas</h2>
<p>Como lo mencioné anteriormente, la forma en la que <em>pytest</em> resuelve las <em>fixtures</em> puede ser usada para darle a nuestro código más flexibilidad. En el repositorio de <em>medium-collector</em> hay una función que carga algunos archivos a un <em>bucket</em> de S3 usando la librería <em>boto</em>, esta es la función <code class="language-plaintext highlighter-rouge">upload_files</code>, que se ve más o menos así:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">upload_files</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="n">bucket</span><span class="p">):</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">boto3</span><span class="p">.</span><span class="n">client</span><span class="p">(</span>
<span class="s">"s3"</span><span class="p">,</span>
<span class="n">aws_access_key_id</span><span class="o">=</span><span class="n">config</span><span class="p">(</span><span class="s">"ACCESS_KEY"</span><span class="p">),</span>
<span class="n">aws_secret_access_key</span><span class="o">=</span><span class="n">config</span><span class="p">(</span><span class="s">"SECRET_KEY"</span><span class="p">),</span>
<span class="n">region_name</span><span class="o">=</span><span class="s">"eu-west-2"</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">client</span><span class="p">.</span><span class="n">upload_file</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">file</span><span class="p">),</span> <span class="n">bucket</span><span class="p">,</span> <span class="nb">file</span><span class="p">.</span><span class="n">name</span><span class="p">)</span><span class="mi">2</span>
</code></pre></div></div>
<p>Claro que no quero estar conectándome a AWS cada vez que ejecuto las pruebas; aquí es donde la librería <em>moto</em> aparece para rescatarme. En palabras de sus creadores: <em>“Moto es una librería que permite que tus tests fácilmente finjan comunicarse con servicios de AWS”</em>. La forma en la que ellos sugieren usarla es a través de un manejador de contexto:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">test_my_model_save</span><span class="p">():</span>
<span class="k">with</span> <span class="n">mock_s3</span><span class="p">():</span>
<span class="n">conn</span> <span class="o">=</span> <span class="n">boto3</span><span class="p">.</span><span class="n">resource</span><span class="p">(</span><span class="s">'s3'</span><span class="p">,</span> <span class="n">region_name</span><span class="o">=</span><span class="s">'us-east-1'</span><span class="p">)</span>
</code></pre></div></div>
<p>Para probar nuestra función debemos cumplir dos condiciones antes de llamar a <code class="language-plaintext highlighter-rouge">upload_files</code>:</p>
<ol>
<li>Imitar S3; no queremos estar conectándonos a AWS en nuestras pruebas unitarias,</li>
<li>Tener un <em>bucket</em> que ya exista; nuestro código asume que uno ya existe</li>
</ol>
<p>Para lograr estas dos cosas con un <em>fixture</em> podemos hacer algo como esto:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">@</span><span class="n">pytest</span><span class="p">.</span><span class="n">fixture</span>
<span class="k">def</span> <span class="nf">bucket</span><span class="p">():</span>
<span class="k">return</span> <span class="s">"my_special_bucket"</span>
<span class="o">@</span><span class="n">pytest</span><span class="p">.</span><span class="n">fixture</span>
<span class="k">def</span> <span class="nf">mock_storage</span><span class="p">(</span><span class="n">bucket</span><span class="p">):</span>
<span class="o">@</span><span class="n">contextmanager</span>
<span class="k">def</span> <span class="nf">inner</span><span class="p">(</span><span class="n">create_bucket</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="k">with</span> <span class="n">mock_s3</span><span class="p">():</span>
<span class="n">conn</span> <span class="o">=</span> <span class="n">boto3</span><span class="p">.</span><span class="n">client</span><span class="p">(</span><span class="s">"s3"</span><span class="p">,</span> <span class="n">region_name</span><span class="o">=</span><span class="s">"eu-east-1"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">create_bucket</span><span class="p">:</span>
<span class="n">conn</span><span class="p">.</span><span class="n">create_bucket</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="n">bucket</span><span class="p">)</span>
<span class="k">yield</span>
<span class="k">return</span> <span class="n">inner</span>
</code></pre></div></div>
<p>Esta <em>fixture</em> es, en realidad, una función (<code class="language-plaintext highlighter-rouge">inner</code>) que gracias al decorador <code class="language-plaintext highlighter-rouge">contextmanager</code> podemos llamar con la instrucción <code class="language-plaintext highlighter-rouge">with</code>. En términos de la implementación puedes ver que estamos usando <code class="language-plaintext highlighter-rouge">mock_s3</code> como lo recomiendan los desarrolladores de <em>moto</em>, dentro de este contexto creamos un cliente de <em>boto3</em>, luego, dependiendo de un parámetro pasado a nuestra función <code class="language-plaintext highlighter-rouge">inner</code> decidimos si creamos o no la <em>bucket</em>; por último, y como este se trata de un manejador de contexto usamos la instrucción <code class="language-plaintext highlighter-rouge">yield</code> que le indicará a <em>pytest</em> que nuestra <em>fixture</em> está lista para ser usada.</p>
<p>Ah, no sé si te diste cuenta, pero <code class="language-plaintext highlighter-rouge">mock_storage</code> toma como argumento otra <em>fixture</em> (<code class="language-plaintext highlighter-rouge">bucket</code> en este caso). Esa es otra de las excelentes características de <em>pytest</em>: permite crear ciertas dependencias entre nuestras <em>fixtures</em>, y esta es resuleta antes de que se ejecuten nuestras pruebas.</p>
<p>Ahora sí, estamos listos a probar nuestra función <code class="language-plaintext highlighter-rouge">upload_files</code> con esta función:</p>
<div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">test_upload_files</span><span class="p">(</span><span class="n">bucket</span><span class="p">,</span> <span class="n">mock_storage</span><span class="p">):</span>
<span class="k">with</span> <span class="n">mock_storage</span><span class="p">(</span><span class="n">create_bucket</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="n">upload_files</span><span class="p">(</span><span class="n">files_path</span><span class="p">)</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">boto3</span><span class="p">.</span><span class="n">client</span><span class="p">(</span><span class="s">"s3"</span><span class="p">,</span> <span class="n">region_name</span><span class="o">=</span><span class="s">"eu-east-1"</span><span class="p">)</span>
<span class="n">contents</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">list_objects</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="n">bucket</span><span class="p">)[</span><span class="s">"Contents"</span><span class="p">]</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">contents</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
</code></pre></div></div>
<h2 id="practica">¡Practica!</h2>
<p>Me hubiera encantado preparar un notebook o cualquier otra forma de entorno interactivo que pudieras usar para jugar y experimentar un poco con los <em>tests</em>, pero creo que para este tema, es mejor que te ensucies las manos con un poco de código verdadero. Te invito a que descargues el código de la aplicación <a href="https://github.com/fferegrino/medium-collector"><em>medium-collector</em> repo</a> y ejecutes los test por ti mism@.</p>
<h2 id="más-allá-de-las-pruebas-unitarias">Más allá de las pruebas unitarias</h2>
<p>A pesar de que <em>pytest</em> es fabuloso para realizar pruebas unitarias, nada nos detiene de usarlo para otras pruebas, aún más más complejas; hablo de pruebas de integración o tal vez hasta de <em>end-to-end</em>. Con herramientas como <em>Docker</em>, <em>localstack</em> y otras más, es posible crear un poderos <em>framework</em> de pruebas para todos tus proyectos de Python. En un post futuro voy a hablar de cómo es que se puede utilizar todo el poder de estas herramientas para crear un test de <em>end-to-end</em>, así que asegúrate de seguir el blog y de seguirme en Twitter en <a href="https://twitter.com/io_exception">@io_exception</a>.</p></content>
<author>
<name>Antonio Feregrino Bolaños</name>
</author>
<category term="blog" />
<category term="python" />
<category term="pytest" />
<summary type="html">Aviso A lo largo de este post estaré probando las funciones del código que escribí para el post sobre la generación automática de datasets; sin embargo no es necesario que leas ese post primero, pero seguramente te ayudará a ponerle más contexto al código que aquí se presenta.</summary>
</entry>
</feed>