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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Introduction: libuhttpmock Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libuhttpmock Reference Manual">
<link rel="up" href="pt01.html" title="Part I. Integrating libuhttpmock into new projects">
<link rel="prev" href="pt01.html" title="Part I. Integrating libuhttpmock into new projects">
<link rel="next" href="ch02.html" title="Testing Workflow">
<meta name="generator" content="GTK-Doc V1.32.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="pt01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
<a name="id-1.2.2"></a>Introduction</h2></div></div></div>
<p>
libuhttpmock works by recording the Soup Session your application uses.
It traces the requests your application makes and the reply it receives
from the (online) server you query. After capturing an initial trace,
libuhttpmock will be able to reply to your application's requests
the same way the actual servers would and as such help you detect
unwanted changes in behaviour in your application.
</p>
<div class="example">
<a name="id-1.2.2.3"></a><p class="title"><b>Example 1. A sample implementation of a test with libuhttpmock</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cm">/*</span>
<span class="cm"> * Copyright (C) 2020 Rasmus Thomsen <oss@cogitri.dev></span>
<span class="cm"> */</span>
<span class="cp">#include</span> <span class="cpf"><gio/gio.h></span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf"><glib.h></span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf"><libsoup/soup.h></span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf"><uhttpmock/uhm.h></span><span class="cp"></span>
<span class="n">UhmServer</span><span class="o">*</span> <span class="n">mock_server</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="kt">void</span>
<span class="nf">test_mock</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">GError</span><span class="p">)</span> <span class="n">error</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">SoupLogger</span><span class="p">)</span> <span class="n">soup_logger</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">SoupMessage</span><span class="p">)</span> <span class="n">soup_message</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">SoupMessageBody</span><span class="p">)</span> <span class="n">soup_response_message_body</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">SoupSession</span><span class="p">)</span> <span class="n">soup_session</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autofree</span> <span class="n">gchar</span> <span class="o">*</span><span class="n">server_url</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">guint</span> <span class="n">http_status_code</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="cm">/*</span>
<span class="cm"> * Start recording the trace if in online mode, otherwise read trace to comapre</span>
<span class="cm"> * Replace "testname" with the name of the test. This needs to be unique among</span>
<span class="cm"> * your test suite!</span>
<span class="cm"> */</span>
<span class="n">uhm_server_start_trace</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">,</span> <span class="s">"testname"</span><span class="p">,</span> <span class="o">&</span><span class="n">error</span><span class="p">);</span>
<span class="n">g_assert</span> <span class="p">(</span><span class="n">error</span> <span class="o">==</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">soup_session</span> <span class="o">=</span> <span class="n">soup_session_new</span> <span class="p">();</span>
<span class="cm">/* Query actual server if online mode is activated */</span>
<span class="k">if</span> <span class="p">(</span><span class="n">uhm_server_get_enable_online</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">))</span> <span class="p">{</span>
<span class="n">server_url</span> <span class="o">=</span> <span class="n">g_strdup</span> <span class="p">(</span><span class="s">"https://jsonplaceholder.typicode.com/todos/1"</span><span class="p">);</span>
<span class="cm">/*</span>
<span class="cm"> * Allow usage of the self-signed certificate we generate in</span>
<span class="cm"> * main (). Make sure this is _only_ set during testing!</span>
<span class="cm"> */</span>
<span class="n">g_object_set</span> <span class="p">(</span><span class="n">soup_session</span><span class="p">,</span> <span class="s">"ssl-strict"</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">const</span> <span class="n">gchar</span> <span class="o">*</span><span class="n">server_address</span> <span class="o">=</span> <span class="n">uhm_server_get_address</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">);</span>
<span class="n">guint</span> <span class="n">server_port</span> <span class="o">=</span> <span class="n">uhm_server_get_port</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">);</span>
<span class="n">server_url</span> <span class="o">=</span> <span class="n">g_strdup_printf</span> <span class="p">(</span><span class="s">"https://%s:%u"</span><span class="p">,</span> <span class="n">server_address</span><span class="p">,</span> <span class="n">server_port</span><span class="p">);</span>
<span class="p">}</span>
<span class="cm">/* Set uhttpmock as soup logger so it can capture the trace */</span>
<span class="n">soup_logger</span> <span class="o">=</span> <span class="n">soup_logger_new</span> <span class="p">(</span><span class="n">SOUP_LOGGER_LOG_BODY</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span>
<span class="n">soup_logger_set_printer</span> <span class="p">(</span><span class="n">soup_logger</span><span class="p">,</span> <span class="n">uhm_server_received_message_chunk_from_soup</span><span class="p">,</span> <span class="n">mock_server</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">soup_session_add_feature</span> <span class="p">(</span><span class="n">soup_session</span><span class="p">,</span> <span class="n">SOUP_SESSION_FEATURE</span> <span class="p">(</span><span class="n">soup_logger</span><span class="p">));</span>
<span class="cm">/*</span>
<span class="cm"> * Send the message - usually your application would process the</span>
<span class="cm"> * response from uhttpmock, do further requests, etc. afterwards</span>
<span class="cm"> */</span>
<span class="n">soup_message</span> <span class="o">=</span> <span class="n">soup_message_new</span> <span class="p">(</span><span class="s">"GET"</span><span class="p">,</span> <span class="n">server_url</span><span class="p">);</span>
<span class="n">http_status_code</span> <span class="o">=</span> <span class="n">soup_session_send_message</span> <span class="p">(</span><span class="n">soup_session</span><span class="p">,</span> <span class="n">soup_message</span><span class="p">);</span>
<span class="n">g_assert</span> <span class="p">(</span><span class="n">http_status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">);</span>
<span class="cm">/* End the trace - in online mode this will save the trace, otherwise it'd compare it. */</span>
<span class="n">uhm_server_end_trace</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">);</span>
<span class="p">}</span>
<span class="kt">int</span>
<span class="nf">main</span> <span class="p">(</span><span class="kt">int</span> <span class="n">argc</span><span class="p">,</span> <span class="kt">char</span> <span class="o">**</span><span class="n">argv</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">g_autofree</span> <span class="n">gchar</span> <span class="o">*</span><span class="n">cert_path</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autofree</span> <span class="n">gchar</span> <span class="o">*</span><span class="n">key_path</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autofree</span> <span class="n">gchar</span> <span class="o">*</span><span class="n">trace_path</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">GError</span><span class="p">)</span> <span class="n">error</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">GFile</span><span class="p">)</span> <span class="n">trace_dir</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_autoptr</span><span class="p">(</span><span class="n">GTlsCertificate</span><span class="p">)</span> <span class="n">tls_cert</span> <span class="o">=</span> <span class="nb">NULL</span><span class="p">;</span>
<span class="n">g_test_init</span> <span class="p">(</span><span class="o">&</span><span class="n">argc</span><span class="p">,</span> <span class="o">&</span><span class="n">argv</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="cm">/*</span>
<span class="cm"> * Setup the mock server with the directory to write traces to.</span>
<span class="cm"> * replace "testsuitename" with the name of the testsuite. This must</span>
<span class="cm"> * be unique among your project!</span>
<span class="cm"> */</span>
<span class="n">mock_server</span> <span class="o">=</span> <span class="n">uhm_server_new</span> <span class="p">();</span>
<span class="n">trace_path</span> <span class="o">=</span> <span class="n">g_test_build_filename</span> <span class="p">(</span><span class="n">G_TEST_DIST</span><span class="p">,</span> <span class="s">"traces"</span><span class="p">,</span> <span class="s">"testsuitename"</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">trace_dir</span> <span class="o">=</span> <span class="n">g_file_new_for_path</span> <span class="p">(</span><span class="n">trace_path</span><span class="p">);</span>
<span class="n">uhm_server_set_trace_directory</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">,</span> <span class="n">trace_dir</span><span class="p">);</span>
<span class="cm">/*</span>
<span class="cm"> * Set up self signed cert for HTTPS. The cert doesn't actually need to be</span>
<span class="cm"> * secret - it can be distributed with your program or be generated during</span>
<span class="cm"> * build time with: openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -nodes</span>
<span class="cm"> */</span>
<span class="n">cert_path</span> <span class="o">=</span> <span class="n">g_test_build_filename</span> <span class="p">(</span><span class="n">G_TEST_DIST</span><span class="p">,</span> <span class="s">"sslcertdir"</span><span class="p">,</span> <span class="s">"cert.pem"</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">key_path</span> <span class="o">=</span> <span class="n">g_test_build_filename</span> <span class="p">(</span><span class="n">G_TEST_DIST</span><span class="p">,</span> <span class="s">"sslcertdir"</span><span class="p">,</span> <span class="s">"key.pem"</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">tls_cert</span> <span class="o">=</span> <span class="n">g_tls_certificate_new_from_files</span> <span class="p">(</span><span class="n">cert_path</span><span class="p">,</span> <span class="n">key_path</span><span class="p">,</span> <span class="o">&</span><span class="n">error</span><span class="p">);</span>
<span class="n">g_assert</span> <span class="p">(</span><span class="n">error</span> <span class="o">==</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">uhm_server_set_tls_certificate</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">,</span> <span class="n">tls_cert</span><span class="p">);</span>
<span class="cm">/*</span>
<span class="cm"> * TRUE, TRUE => Logging mode, records what actual server replies</span>
<span class="cm"> * FALSE, TRUE => Comparing mode, checks actual server still replies as expected from trace</span>
<span class="cm"> * FALSE, FALSE => Testing mode, requests are answered by mock server as per trace</span>
<span class="cm"> *</span>
<span class="cm"> * As such, you usually want TRUE, TRUE for the initial recording or if you/the server changed</span>
<span class="cm"> * something (and as such expect a legitimate change in the trace) and then FALSE, FALSE</span>
<span class="cm"> * to actually engage the tests.</span>
<span class="cm"> */</span>
<span class="n">uhm_server_set_enable_logging</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">,</span> <span class="n">TRUE</span><span class="p">);</span>
<span class="n">uhm_server_set_enable_online</span> <span class="p">(</span><span class="n">mock_server</span><span class="p">,</span> <span class="n">TRUE</span><span class="p">);</span>
<span class="n">g_test_add_func</span> <span class="p">(</span><span class="s">"/test/mock"</span><span class="p">,</span> <span class="n">test_mock</span><span class="p">);</span>
<span class="k">return</span> <span class="n">g_test_run</span> <span class="p">();</span>
<span class="p">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break"><p>
This example can be compiled using:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="n">gcc</span> <span class="o">-</span><span class="n">o</span> <span class="n">uhttpsample</span> <span class="n">uhttpsample</span><span class="p">.</span><span class="n">c</span> <span class="err">$</span><span class="p">(</span><span class="n">pkg</span><span class="o">-</span><span class="n">config</span> <span class="o">--</span><span class="n">cflags</span> <span class="o">--</span><span class="n">libs</span> <span class="n">gio</span><span class="o">-</span><span class="mf">2.0</span> <span class="n">glib</span><span class="o">-</span><span class="mf">2.0</span> <span class="n">libsoup</span><span class="o">-</span><span class="mf">2.4</span> <span class="n">libuhttpmock</span><span class="o">-</span><span class="mf">0.0</span><span class="p">)</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
Afterwards, executing <code class="code">./uhttpsample</code> will run the test suite. Initially it will
record a trace of the requests done by the test_mock function and the responses
it receives, because <code class="code">uhm_server_set_enable_logging</code> and
<code class="code">uhm_server_set_enable_online</code> are both set to <code class="code">TRUE</code>. Upon setting
both of these to <code class="code">FALSE</code>, libuhttpmock will read the trace it
created earlier and will fail the test (by returning an HTTP status code indicating failure
for the faulty query your application makes) in case something is different - e.g. because
your application queried a different URL than expected. Keep in mind that by default
libuhttpmock will only compare the URI and methods of messages, but no headers and
not the message bodies. To override this behaviour, you can connect to the
<code class="code">compare-messages</code> signal on <code class="code">UhmServer</code> to implement your own
custom handler for checking if messages are as expected.
</p>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32.1</div>
</body>
</html>
|
