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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
|
/*
This file is part of TALER
Copyright (C) 2023 Taler Systems SA
TALER is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3, or
(at your option) any later version.
TALER is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public
License along with TALER; see the file COPYING. If not, see
<http://www.gnu.org/licenses/>
*/
/**
* @file testing/testing_api_cmd_coin_history.c
* @brief Implement the /coins/$COIN_PUB/history test command.
* @author Christian Grothoff
*/
#include "platform.h"
#include "taler_json_lib.h"
#include <gnunet/gnunet_curl_lib.h>
#include "taler_testing_lib.h"
/**
* State for a "history" CMD.
*/
struct HistoryState
{
/**
* Public key of the coin being analyzed.
*/
struct TALER_CoinSpendPublicKeyP coin_pub;
/**
* Label to the command which created the coin to check,
* needed to resort the coin key.
*/
const char *coin_reference;
/**
* Handle to the "coin history" operation.
*/
struct TALER_EXCHANGE_CoinsHistoryHandle *rsh;
/**
* Expected coin balance.
*/
const char *expected_balance;
/**
* Private key of the coin being analyzed.
*/
const struct TALER_CoinSpendPrivateKeyP *coin_priv;
/**
* Interpreter state.
*/
struct TALER_TESTING_Interpreter *is;
/**
* Expected HTTP response code.
*/
unsigned int expected_response_code;
};
/**
* Closure for analysis_cb().
*/
struct AnalysisContext
{
/**
* Coin public key we are looking at.
*/
const struct TALER_CoinSpendPublicKeyP *coin_pub;
/**
* Length of the @e history array.
*/
unsigned int history_length;
/**
* Array of history items to match.
*/
const struct TALER_EXCHANGE_CoinHistoryEntry *history;
/**
* Array of @e history_length of matched entries.
*/
bool *found;
/**
* Set to true if an entry could not be found.
*/
bool failure;
};
/**
* Compare @a h1 and @a h2.
*
* @param h1 a history entry
* @param h2 a history entry
* @return 0 if @a h1 and @a h2 are equal
*/
static int
history_entry_cmp (
const struct TALER_EXCHANGE_CoinHistoryEntry *h1,
const struct TALER_EXCHANGE_CoinHistoryEntry *h2)
{
if (h1->type != h2->type)
return 1;
if (0 != TALER_amount_cmp (&h1->amount,
&h2->amount))
return 1;
switch (h1->type)
{
case TALER_EXCHANGE_CTT_NONE:
GNUNET_break (0);
break;
case TALER_EXCHANGE_CTT_DEPOSIT:
if (0 != GNUNET_memcmp (&h1->details.deposit.sig,
&h2->details.deposit.sig))
return 1;
return 0;
case TALER_EXCHANGE_CTT_MELT:
if (0 != GNUNET_memcmp (&h1->details.melt.h_age_commitment,
&h2->details.melt.h_age_commitment))
return 1;
/* Note: most other fields are not initialized
in the trait as they are hard to extract from
the API */
return 0;
case TALER_EXCHANGE_CTT_REFUND:
if (0 != GNUNET_memcmp (&h1->details.refund.sig,
&h2->details.refund.sig))
return 1;
return 0;
case TALER_EXCHANGE_CTT_RECOUP:
if (0 != GNUNET_memcmp (&h1->details.recoup.coin_sig,
&h2->details.recoup.coin_sig))
return 1;
/* Note: exchange_sig, exchange_pub and timestamp are
fundamentally not available in the initiating command */
return 0;
case TALER_EXCHANGE_CTT_RECOUP_REFRESH:
if (0 != GNUNET_memcmp (&h1->details.recoup_refresh.coin_sig,
&h2->details.recoup_refresh.coin_sig))
return 1;
/* Note: exchange_sig, exchange_pub and timestamp are
fundamentally not available in the initiating command */
return 0;
case TALER_EXCHANGE_CTT_OLD_COIN_RECOUP:
if (0 != GNUNET_memcmp (&h1->details.old_coin_recoup.new_coin_pub,
&h2->details.old_coin_recoup.new_coin_pub))
return 1;
/* Note: exchange_sig, exchange_pub and timestamp are
fundamentally not available in the initiating command */
return 0;
case TALER_EXCHANGE_CTT_PURSE_DEPOSIT:
/* coin_sig is not initialized */
if (0 != GNUNET_memcmp (&h1->details.purse_deposit.purse_pub,
&h2->details.purse_deposit.purse_pub))
return 1;
if (0 != strcmp (h1->details.purse_deposit.exchange_base_url,
h2->details.purse_deposit.exchange_base_url))
return 1;
return 0;
case TALER_EXCHANGE_CTT_PURSE_REFUND:
if (0 != GNUNET_memcmp (&h1->details.purse_refund.exchange_sig,
&h2->details.purse_refund.exchange_sig))
return 1;
return 0;
case TALER_EXCHANGE_CTT_RESERVE_OPEN_DEPOSIT:
if (0 != GNUNET_memcmp (&h1->details.reserve_open_deposit.coin_sig,
&h2->details.reserve_open_deposit.coin_sig))
return 1;
return 0;
}
GNUNET_assert (0);
return -1;
}
/**
* Check if @a cmd changed the coin, if so, find the
* entry in our history and set the respective index in found
* to true. If the entry is not found, set failure.
*
* @param cls our `struct AnalysisContext *`
* @param cmd command to analyze for impact on history
*/
static void
analyze_command (void *cls,
const struct TALER_TESTING_Command *cmd)
{
struct AnalysisContext *ac = cls;
const struct TALER_CoinSpendPublicKeyP *coin_pub = ac->coin_pub;
const struct TALER_EXCHANGE_CoinHistoryEntry *history = ac->history;
unsigned int history_length = ac->history_length;
bool *found = ac->found;
if (TALER_TESTING_cmd_is_batch (cmd))
{
struct TALER_TESTING_Command *cur;
struct TALER_TESTING_Command *bcmd;
cur = TALER_TESTING_cmd_batch_get_current (cmd);
if (GNUNET_OK !=
TALER_TESTING_get_trait_batch_cmds (cmd,
&bcmd))
{
GNUNET_break (0);
ac->failure = true;
return;
}
for (unsigned int i = 0; NULL != bcmd[i].label; i++)
{
struct TALER_TESTING_Command *step = &bcmd[i];
analyze_command (ac,
step);
if (ac->failure)
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Entry for batch step `%s' missing in history\n",
step->label);
return;
}
if (step == cur)
break; /* if *we* are in a batch, make sure not to analyze commands past 'now' */
}
return;
}
for (unsigned int j = 0; true; j++)
{
const struct TALER_CoinSpendPublicKeyP *rp;
const struct TALER_EXCHANGE_CoinHistoryEntry *he;
bool matched = false;
if (GNUNET_OK !=
TALER_TESTING_get_trait_coin_pub (cmd,
j,
&rp))
break; /* command does nothing for coins */
if (0 !=
GNUNET_memcmp (rp,
coin_pub))
continue; /* command affects some _other_ coin */
if (GNUNET_OK !=
TALER_TESTING_get_trait_coin_history (cmd,
j,
&he))
{
/* NOTE: only for debugging... */
if (0 == j)
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
"Command `%s' has the coin_pub, but lacks coin history trait\n",
cmd->label);
return; /* command does nothing for coins */
}
for (unsigned int i = 0; i<history_length; i++)
{
if (found[i])
continue; /* already found, skip */
if (0 ==
history_entry_cmp (he,
&history[i]))
{
found[i] = true;
matched = true;
break;
}
}
if (! matched)
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Command `%s' coin history entry #%u not found\n",
cmd->label,
j);
ac->failure = true;
return;
}
}
}
/**
* Check that the coin balance and HTTP response code are
* both acceptable.
*
* @param cls closure.
* @param rs HTTP response details
*/
static void
coin_history_cb (void *cls,
const struct TALER_EXCHANGE_CoinHistory *rs)
{
struct HistoryState *ss = cls;
struct TALER_TESTING_Interpreter *is = ss->is;
struct TALER_Amount eb;
unsigned int hlen;
ss->rsh = NULL;
if (ss->expected_response_code != rs->hr.http_status)
{
TALER_TESTING_unexpected_status (ss->is,
rs->hr.http_status,
ss->expected_response_code);
return;
}
if (MHD_HTTP_OK != rs->hr.http_status)
{
TALER_TESTING_interpreter_next (is);
return;
}
GNUNET_assert (GNUNET_OK ==
TALER_string_to_amount (ss->expected_balance,
&eb));
if (0 != TALER_amount_cmp (&eb,
&rs->details.ok.balance))
{
GNUNET_break (0);
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Unexpected balance for coin: %s\n",
TALER_amount_to_string (&rs->details.ok.balance));
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Expected balance of: %s\n",
TALER_amount_to_string (&eb));
TALER_TESTING_interpreter_fail (ss->is);
return;
}
hlen = json_array_size (rs->details.ok.history);
{
bool found[GNUNET_NZL (hlen)];
struct TALER_EXCHANGE_CoinHistoryEntry rhist[GNUNET_NZL (hlen)];
struct AnalysisContext ac = {
.coin_pub = &ss->coin_pub,
.history = rhist,
.history_length = hlen,
.found = found
};
const struct TALER_EXCHANGE_DenomPublicKey *dk;
struct TALER_Amount total_in;
struct TALER_Amount total_out;
struct TALER_Amount hbal;
dk = TALER_EXCHANGE_get_denomination_key_by_hash (
TALER_TESTING_get_keys (is),
&rs->details.ok.h_denom_pub);
memset (found,
0,
sizeof (found));
memset (rhist,
0,
sizeof (rhist));
if (GNUNET_OK !=
TALER_EXCHANGE_parse_coin_history (
TALER_TESTING_get_keys (is),
dk,
rs->details.ok.history,
&ss->coin_pub,
&total_in,
&total_out,
hlen,
rhist))
{
GNUNET_break (0);
json_dumpf (rs->hr.reply,
stderr,
JSON_INDENT (2));
TALER_TESTING_interpreter_fail (ss->is);
return;
}
if (0 >
TALER_amount_subtract (&hbal,
&total_in,
&total_out))
{
GNUNET_break (0);
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Coin credits: %s\n",
TALER_amount2s (&total_in));
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Coin debits: %s\n",
TALER_amount2s (&total_out));
TALER_TESTING_interpreter_fail (ss->is);
return;
}
if (0 != TALER_amount_cmp (&hbal,
&rs->details.ok.balance))
{
GNUNET_break (0);
TALER_TESTING_interpreter_fail (ss->is);
return;
}
(void) ac;
TALER_TESTING_iterate (is,
true,
&analyze_command,
&ac);
if (ac.failure)
{
json_dumpf (rs->hr.reply,
stderr,
JSON_INDENT (2));
TALER_TESTING_interpreter_fail (ss->is);
return;
}
#if FIXME
for (unsigned int i = 0; i<hlen; i++)
{
if (found[i])
continue;
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"History entry at index %u of type %d not justified by command history\n",
i,
rs->details.ok.history[i].type);
json_dumpf (rs->hr.reply,
stderr,
JSON_INDENT (2));
TALER_TESTING_interpreter_fail (ss->is);
return;
}
#endif
}
TALER_TESTING_interpreter_next (is);
}
/**
* Run the command.
*
* @param cls closure.
* @param cmd the command being executed.
* @param is the interpreter state.
*/
static void
history_run (void *cls,
const struct TALER_TESTING_Command *cmd,
struct TALER_TESTING_Interpreter *is)
{
struct HistoryState *ss = cls;
const struct TALER_TESTING_Command *create_coin;
char *cref;
unsigned int idx;
ss->is = is;
GNUNET_assert (
GNUNET_OK ==
TALER_TESTING_parse_coin_reference (
ss->coin_reference,
&cref,
&idx));
create_coin
= TALER_TESTING_interpreter_lookup_command (is,
cref);
if (NULL == create_coin)
{
GNUNET_break (0);
TALER_TESTING_interpreter_fail (is);
return;
}
if (GNUNET_OK !=
TALER_TESTING_get_trait_coin_priv (create_coin,
idx,
&ss->coin_priv))
{
GNUNET_break (0);
TALER_LOG_ERROR ("Failed to find coin_priv for history query\n");
TALER_TESTING_interpreter_fail (is);
return;
}
GNUNET_CRYPTO_eddsa_key_get_public (&ss->coin_priv->eddsa_priv,
&ss->coin_pub.eddsa_pub);
ss->rsh = TALER_EXCHANGE_coins_history (
TALER_TESTING_interpreter_get_context (is),
TALER_TESTING_get_exchange_url (is),
ss->coin_priv,
0,
&coin_history_cb,
ss);
}
/**
* Offer internal data from a "history" CMD, to other commands.
*
* @param cls closure.
* @param[out] ret result.
* @param trait name of the trait.
* @param index index number of the object to offer.
* @return #GNUNET_OK on success.
*/
static enum GNUNET_GenericReturnValue
history_traits (void *cls,
const void **ret,
const char *trait,
unsigned int index)
{
struct HistoryState *hs = cls;
struct TALER_TESTING_Trait traits[] = {
TALER_TESTING_make_trait_coin_pub (0,
&hs->coin_pub),
TALER_TESTING_trait_end ()
};
return TALER_TESTING_get_trait (traits,
ret,
trait,
index);
}
/**
* Cleanup the state from a "coin history" CMD, and possibly
* cancel a pending operation thereof.
*
* @param cls closure.
* @param cmd the command which is being cleaned up.
*/
static void
history_cleanup (void *cls,
const struct TALER_TESTING_Command *cmd)
{
struct HistoryState *ss = cls;
if (NULL != ss->rsh)
{
TALER_TESTING_command_incomplete (ss->is,
cmd->label);
TALER_EXCHANGE_coins_history_cancel (ss->rsh);
ss->rsh = NULL;
}
GNUNET_free (ss);
}
struct TALER_TESTING_Command
TALER_TESTING_cmd_coin_history (const char *label,
const char *coin_reference,
const char *expected_balance,
unsigned int expected_response_code)
{
struct HistoryState *ss;
GNUNET_assert (NULL != coin_reference);
ss = GNUNET_new (struct HistoryState);
ss->coin_reference = coin_reference;
ss->expected_balance = expected_balance;
ss->expected_response_code = expected_response_code;
{
struct TALER_TESTING_Command cmd = {
.cls = ss,
.label = label,
.run = &history_run,
.cleanup = &history_cleanup,
.traits = &history_traits
};
return cmd;
}
}
|