aboutsummaryrefslogtreecommitdiff
path: root/src/testing/testing_api_cmd_merchant_get_order.c
blob: 34c2b0b06b6cf03f35c77113ef2949f281dc7024 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
/*
  This file is part of TALER
  Copyright (C) 2020 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_api_cmd_merchant_get_order.c
 * @brief command to test GET /private/orders/$ORDER_ID.
 * @author Jonathan Buchanan
 */
#include "platform.h"
#include <taler/taler_exchange_service.h>
#include <taler/taler_testing_lib.h>
#include "taler_merchant_service.h"
#include "taler_merchant_testing_lib.h"


/**
 * State for a GET /private/orders/$ORDER_ID CMD.
 */
struct MerchantGetOrderState
{
  /**
   * The merchant base URL.
   */
  const char *merchant_url;

  /**
   * Expected HTTP response code for this CMD.
   */
  unsigned int http_status;

  /**
   * The handle to the current GET /private/orders/$ORDER_ID request.
   */
  struct TALER_MERCHANT_OrderMerchantGetHandle *ogh;

  /**
   * The interpreter state.
   */
  struct TALER_TESTING_Interpreter *is;

  /**
   * Reference to a command that created an order.
   */
  const char *order_reference;

  /**
   * Expected order status.
   */
  enum TALER_MERCHANT_OrderStatusCode osc;

  /**
   * A NULL-terminated list of refunds associated with this order.
   */
  const char **refunds;

  /**
   * The length of @e refunds.
   */
  unsigned int refunds_length;

  /**
   * A NULL-terminated list of transfers associated with this order.
   */
  const char **transfers;

  /**
   * The length of @e transfers.
   */
  unsigned int transfers_length;

  /**
   * A list of forget commands that apply to this order's contract terms.
   */
  const char **forgets;

  /**
   * The length of @e forgets.
   */
  unsigned int forgets_length;

  /**
   * Whether the order was refunded or not.
   */
  bool refunded;

  /**
   * Whether the order was wired or not.
   */
  bool wired;
};


/**
 * Forget part of the contract terms.
 *
 * @param cls pointer to the result of the forget operation.
 * @param object_id name of the object to forget.
 * @param parent parent of the object at @e object_id.
 */
static void
apply_forget (void *cls,
              const char *object_id,
              json_t *parent)
{
  int *res = cls;

  if (GNUNET_SYSERR ==
      TALER_JSON_contract_part_forget (parent,
                                       object_id))
    *res = GNUNET_SYSERR;
}


/**
 * Callback to process a GET /orders/$ID request
 *
 * @param cls closure
 * @param hr HTTP response details
 * @param osr order status response details (on success)
 */
static void
merchant_get_order_cb (
  void *cls,
  const struct TALER_MERCHANT_HttpResponse *hr,
  const struct TALER_MERCHANT_OrderStatusResponse *osr)
{
  /* FIXME, deeper checks should be implemented here. */
  struct MerchantGetOrderState *gos = cls;

  gos->ogh = NULL;
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "GET /private/orders/$ID completed with status %u\n",
              hr->http_status);
  if (gos->http_status != hr->http_status)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Unexpected response code %u (%d) to command %s\n",
                hr->http_status,
                (int) hr->ec,
                TALER_TESTING_interpreter_get_current_label (gos->is));
    TALER_TESTING_interpreter_fail (gos->is);
    return;
  }
  switch (hr->http_status)
  {
  case MHD_HTTP_OK:
    // FIXME: use gts->tip_reference here to
    // check if the data returned matches that from the POST / PATCH
    if (gos->osc != osr->status)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Order paid does not match\n");
      TALER_TESTING_interpreter_fail (gos->is);
      return;
    }
    switch (osr->status)
    {
    case TALER_MERCHANT_OSC_PAID:
      {
        const struct TALER_TESTING_Command *order_cmd;
        struct TALER_Amount refunded_total;

        order_cmd = TALER_TESTING_interpreter_lookup_command (
          gos->is,
          gos->order_reference);

        {
          const json_t *expected_contract_terms;
          json_t *ct;

          if (GNUNET_OK !=
              TALER_TESTING_get_trait_contract_terms (order_cmd,
                                                      0,
                                                      &expected_contract_terms))
          {
            GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                        "Could not fetch order contract terms\n");
            TALER_TESTING_interpreter_fail (gos->is);
            return;
          }

          ct = json_deep_copy (expected_contract_terms);

          /* Apply all forgets, then compare */
          for (unsigned int i = 0; i < gos->forgets_length; ++i)
          {
            const struct TALER_TESTING_Command *forget_cmd;
            const unsigned int *paths_length;

            forget_cmd = TALER_TESTING_interpreter_lookup_command (
              gos->is,
              gos->forgets[i]);

            if (GNUNET_OK !=
                TALER_TESTING_get_trait_uint32 (forget_cmd,
                                                0,
                                                &paths_length))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Couldn't fetch forget paths length\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }

            for (unsigned int j = 0; j < *paths_length; ++j)
            {
              const char *path;
              int res = GNUNET_OK;

              if (GNUNET_OK !=
                  TALER_TESTING_get_trait_string (forget_cmd,
                                                  j,
                                                  &path))
              {
                GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                            "Couldn't fetch forget path\n");
                TALER_TESTING_interpreter_fail (gos->is);
                return;
              }

              GNUNET_assert (GNUNET_OK ==
                             TALER_JSON_expand_path (ct,
                                                     path,
                                                     &apply_forget,
                                                     &res));
              GNUNET_assert (GNUNET_OK == res);
            }
          }

          if (1 != json_equal (ct,
                               osr->details.paid.contract_terms))
          {
            GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                        "Order contract terms do not match\n");
            TALER_TESTING_interpreter_fail (gos->is);
            return;
          }

          json_decref (ct);
        }
        if (gos->wired != osr->details.paid.wired)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Order wired does not match\n");
          TALER_TESTING_interpreter_fail (gos->is);
          return;
        }
        if (gos->transfers_length != osr->details.paid.wts_len)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Number of transfers found does not match\n");
          TALER_TESTING_interpreter_fail (gos->is);
          return;
        }
        for (unsigned int i = 0; i < gos->transfers_length; ++i)
        {
          const struct TALER_TESTING_Command *transfer_cmd;

          transfer_cmd = TALER_TESTING_interpreter_lookup_command (
            gos->is,
            gos->transfers[i]);
          {
            const struct TALER_WireTransferIdentifierRawP *wtid;

            if (GNUNET_OK !=
                TALER_TESTING_get_trait_wtid (transfer_cmd,
                                              0,
                                              &wtid))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Could not fetch wire transfer id\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
            if (0 != GNUNET_memcmp (wtid,
                                    &osr->details.paid.wts[i].wtid))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Wire transfer id does not match\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
          }
          {
            const char *exchange_url;

            if (GNUNET_OK !=
                TALER_TESTING_get_trait_string (transfer_cmd,
                                                1,
                                                &exchange_url))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Could not fetch wire transfer exchange url\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
            if (0 != strcmp (exchange_url,
                             osr->details.paid.wts[i].exchange_url))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Wire transfer exchange url does not match\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
          }
          {
            struct TALER_Amount transfer_total;
            const struct TALER_Amount *transfer_amount;
            const struct TALER_Amount *transfer_fee;

            if ((GNUNET_OK !=
                 TALER_TESTING_get_trait_amount_obj (transfer_cmd,
                                                     0,
                                                     &transfer_amount)) ||
                (GNUNET_OK !=
                 TALER_TESTING_get_trait_amount_obj (transfer_cmd,
                                                     1,
                                                     &transfer_fee)))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Could not fetch wire transfer amount/fee\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
            if (0 > TALER_amount_add (&transfer_total,
                                      transfer_amount,
                                      transfer_fee))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Could not total wire transfer\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
            if ((GNUNET_OK != TALER_amount_cmp_currency (&transfer_total,
                                                         &osr->details.paid.wts[
                                                           i]
                                                         .total_amount)) ||
                (0 != TALER_amount_cmp (&transfer_total,
                                        &osr->details.paid.wts[i].total_amount)))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Wire transfer total does not match\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
          }
        }
        if (gos->refunded != osr->details.paid.refunded)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Order refunded does not match\n");
          TALER_TESTING_interpreter_fail (gos->is);
          return;
        }
        if (gos->refunds_length != osr->details.paid.refunds_len)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Number of refunds found does not match\n");
          TALER_TESTING_interpreter_fail (gos->is);
          return;
        }
        if (0 < gos->refunds_length)
          GNUNET_assert (GNUNET_OK ==
                         TALER_amount_set_zero (
                           osr->details.paid.refund_amount.currency,
                           &refunded_total));
        for (unsigned int i = 0; i < gos->refunds_length; ++i)
        {
          const struct TALER_TESTING_Command *refund_cmd;

          refund_cmd = TALER_TESTING_interpreter_lookup_command (
            gos->is,
            gos->refunds[i]);
          {
            const char *expected_amount_str;
            struct TALER_Amount expected_amount;
            struct TALER_Amount *amount_found =
              &osr->details.paid.refunds[i].refund_amount;

            if (GNUNET_OK !=
                TALER_TESTING_get_trait_string (refund_cmd,
                                                0,
                                                &expected_amount_str))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Could not fetch refund amount\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
            GNUNET_assert (GNUNET_OK ==
                           TALER_string_to_amount (expected_amount_str,
                                                   &expected_amount));
            GNUNET_assert (0 <= TALER_amount_add (&refunded_total,
                                                  &refunded_total,
                                                  amount_found));
            if ((GNUNET_OK !=
                 TALER_amount_cmp_currency (&expected_amount,
                                            &refunded_total)) ||
                (0 != TALER_amount_cmp (&expected_amount,
                                        &refunded_total)))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Refund amounts do not match\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
          }
          {
            const char *expected_reason;

            if (GNUNET_OK !=
                TALER_TESTING_get_trait_string (refund_cmd,
                                                1,
                                                &expected_reason))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Could not fetch reason\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
            if (0 != strcmp (expected_reason,
                             osr->details.paid.refunds[i].reason))
            {
              GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                          "Refund reason does not match\n");
              TALER_TESTING_interpreter_fail (gos->is);
              return;
            }
          }
        }

        if (gos->wired != osr->details.paid.wired)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Order wired does not match\n");
          TALER_TESTING_interpreter_fail (gos->is);
          return;
        }
      }
      break;
    case TALER_MERCHANT_OSC_CLAIMED:
      /* FIXME: Check contract terms... */
      break;
    case TALER_MERCHANT_OSC_UNPAID:
      {
        /* FIXME: Check all of the members of `pud` */
        struct TALER_MERCHANT_PayUriData pud;
        const struct TALER_TESTING_Command *order_cmd;
        const char *order_id;
        const struct TALER_ClaimTokenP *claim_token;

        if (GNUNET_OK !=
            TALER_MERCHANT_parse_pay_uri (osr->details.unpaid.taler_pay_uri,
                                          &pud))
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Taler pay uri `%s' is malformed\n",
                      osr->details.unpaid.taler_pay_uri);
          TALER_TESTING_interpreter_fail (gos->is);
          return;
        }

        order_cmd = TALER_TESTING_interpreter_lookup_command (
          gos->is,
          gos->order_reference);

        if (GNUNET_OK !=
            TALER_TESTING_get_trait_order_id (order_cmd,
                                              0,
                                              &order_id))
        {
          TALER_MERCHANT_parse_pay_uri_free (&pud);
          TALER_TESTING_FAIL (gos->is);
        }

        if (GNUNET_OK !=
            TALER_TESTING_get_trait_claim_token (order_cmd,
                                                 0,
                                                 &claim_token))
        {
          TALER_MERCHANT_parse_pay_uri_free (&pud);
          TALER_TESTING_FAIL (gos->is);
        }
        {
          char *port;
          char *host;

          if (GNUNET_OK !=
              GNUNET_CONFIGURATION_get_value_string (gos->is->cfg,
                                                     "merchant",
                                                     "PORT",
                                                     &port))
          {
            /* How did we get here without a configured port? */
            GNUNET_break (0);
            TALER_TESTING_interpreter_fail (gos->is);
            TALER_MERCHANT_parse_pay_uri_free (&pud);
            return;
          }
          GNUNET_asprintf (&host,
                           "localhost:%s",
                           port);
          GNUNET_free (port);
          if ((0 != strcmp (host,
                            pud.merchant_host)) ||
              (NULL != pud.merchant_prefix_path) ||
              (0 != strcmp (order_id,
                            pud.order_id)) ||
              (NULL != pud.ssid))
          {
            GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                        "Order pay uri `%s' does not match, wanted %s/%s\n",
                        osr->details.unpaid.taler_pay_uri,
                        host,
                        order_id);
            TALER_TESTING_interpreter_fail (gos->is);
            TALER_MERCHANT_parse_pay_uri_free (&pud);
            GNUNET_free (host);
            return;
          }
          GNUNET_free (host);
        }
        /* The claim token is not given in the pay uri if the order
           has been claimed already. */
        if ( (NULL != pud.claim_token) &&
             ( (NULL == claim_token) ||
               (0 != GNUNET_memcmp (claim_token,
                                    pud.claim_token)) ) )
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      "Order pay uri claim token does not match (%d/%d/%d/%d)\n",
                      NULL == pud.claim_token,
                      NULL == claim_token,
                      (NULL != pud.claim_token) &&
                      GNUNET_is_zero (pud.claim_token),
                      (NULL != claim_token) &&
                      GNUNET_is_zero (claim_token));
          TALER_TESTING_interpreter_fail (gos->is);
          TALER_MERCHANT_parse_pay_uri_free (&pud);
          return;
        }
        TALER_MERCHANT_parse_pay_uri_free (&pud);
      }
      break;
    }
    break;
  default:
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Unhandled HTTP status.\n");
  }
  TALER_TESTING_interpreter_next (gos->is);
}


/**
 * Run the "GET order" CMD.
 *
 * @param cls closure.
 * @param cmd command being run now.
 * @param is interpreter state.
 */
static void
merchant_get_order_run (void *cls,
                        const struct TALER_TESTING_Command *cmd,
                        struct TALER_TESTING_Interpreter *is)
{
  struct MerchantGetOrderState *gos = cls;
  const struct TALER_TESTING_Command *order_cmd;
  const char *order_id;
  const struct GNUNET_HashCode *h_contract;

  order_cmd = TALER_TESTING_interpreter_lookup_command (
    is,
    gos->order_reference);

  if (GNUNET_OK !=
      TALER_TESTING_get_trait_order_id (order_cmd,
                                        0,
                                        &order_id))
    TALER_TESTING_FAIL (is);

  if (GNUNET_OK !=
      TALER_TESTING_get_trait_h_contract_terms (order_cmd,
                                                0,
                                                &h_contract))
    TALER_TESTING_FAIL (is);

  gos->is = is;
  gos->ogh = TALER_MERCHANT_merchant_order_get (is->ctx,
                                                gos->merchant_url,
                                                order_id,
                                                NULL,
                                                true,
                                                GNUNET_TIME_UNIT_ZERO,
                                                &merchant_get_order_cb,
                                                gos);
}


/**
 * Free the state of a "GET order" CMD, and possibly
 * cancel a pending operation thereof.
 *
 * @param cls closure.
 * @param cmd command being run.
 */
static void
merchant_get_order_cleanup (void *cls,
                            const struct TALER_TESTING_Command *cmd)
{
  struct MerchantGetOrderState *gos = cls;

  if (NULL != gos->ogh)
  {
    TALER_LOG_WARNING ("Get tip operation did not complete\n");
    TALER_MERCHANT_merchant_order_get_cancel (gos->ogh);
  }
  GNUNET_array_grow (gos->transfers,
                     gos->transfers_length,
                     0);
  GNUNET_array_grow (gos->refunds,
                     gos->refunds_length,
                     0);
  GNUNET_array_grow (gos->forgets,
                     gos->forgets_length,
                     0);
  GNUNET_free (gos);
}


struct TALER_TESTING_Command
TALER_TESTING_cmd_merchant_get_order (const char *label,
                                      const char *merchant_url,
                                      const char *order_reference,
                                      enum TALER_MERCHANT_OrderStatusCode osc,
                                      bool refunded,
                                      unsigned int http_status,
                                      ...)
{
  struct MerchantGetOrderState *gos;

  gos = GNUNET_new (struct MerchantGetOrderState);
  gos->merchant_url = merchant_url;
  gos->order_reference = order_reference;
  gos->osc = osc;
  gos->refunded = refunded;
  gos->http_status = http_status;
  if (refunded)
  {
    const char *clabel;
    va_list ap;

    va_start (ap, http_status);
    while (NULL != (clabel = va_arg (ap, const char *)))
    {
      GNUNET_array_append (gos->refunds,
                           gos->refunds_length,
                           clabel);
    }
    va_end (ap);
  }
  {
    struct TALER_TESTING_Command cmd = {
      .cls = gos,
      .label = label,
      .run = &merchant_get_order_run,
      .cleanup = &merchant_get_order_cleanup
    };

    return cmd;
  }
}


struct TALER_TESTING_Command
TALER_TESTING_cmd_merchant_get_order2 (const char *label,
                                       const char *merchant_url,
                                       const char *order_reference,
                                       enum TALER_MERCHANT_OrderStatusCode osc,
                                       bool wired,
                                       const char **transfers,
                                       bool refunded,
                                       const char **refunds,
                                       const char **forgets,
                                       unsigned int http_status)
{
  struct MerchantGetOrderState *gos;

  gos = GNUNET_new (struct MerchantGetOrderState);
  gos->merchant_url = merchant_url;
  gos->order_reference = order_reference;
  gos->osc = osc;
  gos->wired = wired;
  gos->refunded = refunded;
  gos->http_status = http_status;
  gos->transfers = NULL;
  gos->transfers_length = 0;
  gos->refunds = NULL;
  gos->refunds_length = 0;
  gos->forgets = NULL;
  gos->forgets_length = 0;
  if (wired)
  {
    for (const char **clabel = transfers; *clabel != NULL; ++clabel)
    {
      GNUNET_array_append (gos->transfers,
                           gos->transfers_length,
                           *clabel);
    }
  }
  if (refunded)
  {
    for (const char **clabel = refunds; *clabel != NULL; ++clabel)
    {
      GNUNET_array_append (gos->refunds,
                           gos->refunds_length,
                           *clabel);
    }
  }
  if (NULL != forgets)
  {
    for (const char **clabel = forgets; *clabel != NULL; ++clabel)
    {
      GNUNET_array_append (gos->forgets,
                           gos->forgets_length,
                           *clabel);
    }
  }
  {
    struct TALER_TESTING_Command cmd = {
      .cls = gos,
      .label = label,
      .run = &merchant_get_order_run,
      .cleanup = &merchant_get_order_cleanup
    };

    return cmd;
  }
}


struct MerchantPollOrderConcludeState
{
  /**
   * The interpreter state.
   */
  struct TALER_TESTING_Interpreter *is;

  /**
   * Reference to a command that can provide a poll order start command.
   */
  const char *start_reference;

  /**
   * Task to wait for the deadline.
   */
  struct GNUNET_SCHEDULER_Task *task;

  /**
   * Expected HTTP response status code.
   */
  unsigned int expected_http_status;
};


struct MerchantPollOrderStartState
{
  /**
   * The merchant base URL.
   */
  const char *merchant_url;

  /**
   * The handle to the current GET /private/orders/$ORDER_ID request.
   */
  struct TALER_MERCHANT_OrderMerchantGetHandle *ogh;

  /**
   * The interpreter state.
   */
  struct TALER_TESTING_Interpreter *is;

  /**
   * Reference to a command that created an order.
   */
  const char *order_id;

  /**
   * How long to wait for server to return a response.
   */
  struct GNUNET_TIME_Relative timeout;

  /**
   * Conclude state waiting for completion (if any).
   */
  struct MerchantPollOrderConcludeState *cs;

  /**
   * The HTTP status code returned by the backend.
   */
  unsigned int http_status;

  /**
   * When the request should be completed by.
   */
  struct GNUNET_TIME_Absolute deadline;
};


/**
 * Task called when either the timeout for the GET /private/order/$ID command
 * expired or we got a response.  Checks if the result is what we expected.
 *
 * @param cls a `struct MerchantPollOrderConcludeState`
 */
static void
conclude_task (void *cls)
{
  struct MerchantPollOrderConcludeState *ppc = cls;
  const struct TALER_TESTING_Command *poll_cmd;
  struct MerchantPollOrderStartState *cps;
  struct GNUNET_TIME_Absolute now;

  ppc->task = NULL;
  poll_cmd =
    TALER_TESTING_interpreter_lookup_command (ppc->is,
                                              ppc->start_reference);
  if (NULL == poll_cmd)
    TALER_TESTING_FAIL (ppc->is);
  cps = poll_cmd->cls;
  if (NULL != cps->ogh)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected poll GET /private/orders/$ORDER_ID to have completed, but it did not!\n");
    TALER_TESTING_FAIL (ppc->is);
  }
  if (cps->http_status != ppc->expected_http_status)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected HTTP status %u, got %u\n",
                ppc->expected_http_status,
                cps->http_status);
    TALER_TESTING_FAIL (ppc->is);
  }
  now = GNUNET_TIME_absolute_get ();
  if ((GNUNET_TIME_absolute_add (cps->deadline,
                                 GNUNET_TIME_UNIT_SECONDS).abs_value_us <
       now.abs_value_us) )
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected answer to be delayed until %llu, but got response at %llu\n",
                (unsigned long long) cps->deadline.abs_value_us,
                (unsigned long long) now.abs_value_us);
    TALER_TESTING_FAIL (ppc->is);
  }
  TALER_TESTING_interpreter_next (ppc->is);
}


/**
 * Callback to process a GET /private/orders/$ID request
 *
 * @param cls closure
 * @param hr HTTP response details
 * @param osr order status response details (on success)
 */
static void
merchant_poll_order_cb (
  void *cls,
  const struct TALER_MERCHANT_HttpResponse *hr,
  const struct TALER_MERCHANT_OrderStatusResponse *osr)
{
  /* FIXME, deeper checks should be implemented here. */
  struct MerchantPollOrderStartState *pos = cls;

  pos->ogh = NULL;
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "GET /private/orders/$ID finished with status %u.\n",
              hr->http_status);
  pos->http_status = hr->http_status;
  switch (hr->http_status)
  {
  case MHD_HTTP_OK:
    // FIXME: keep data from 'osr' here for checking?
    break;
  default:
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Unhandled HTTP status.\n");
  }
  if (NULL != pos->cs)
  {
    GNUNET_SCHEDULER_cancel (pos->cs->task);
    pos->cs->task = GNUNET_SCHEDULER_add_now (&conclude_task,
                                              pos->cs);
  }
}


/**
 * Run the "GET order" CMD.
 *
 * @param cls closure.
 * @param cmd command being run now.
 * @param is interpreter state.
 */
static void
merchant_poll_order_start_run (void *cls,
                               const struct TALER_TESTING_Command *cmd,
                               struct TALER_TESTING_Interpreter *is)
{
  struct MerchantPollOrderStartState *pos = cls;

  /* add 1s grace time to timeout */
  pos->deadline
    = GNUNET_TIME_absolute_add (GNUNET_TIME_relative_to_absolute (pos->timeout),
                                GNUNET_TIME_UNIT_SECONDS);
  pos->is = is;
  pos->ogh = TALER_MERCHANT_merchant_order_get (is->ctx,
                                                pos->merchant_url,
                                                pos->order_id,
                                                NULL,
                                                false,
                                                pos->timeout,
                                                &merchant_poll_order_cb,
                                                pos);
  GNUNET_assert (NULL != pos->ogh);
  /* We CONTINUE to run the interpreter while the long-polled command
     completes asynchronously! */
  TALER_TESTING_interpreter_next (pos->is);
}


/**
 * Free the state of a "GET order" CMD, and possibly
 * cancel a pending operation thereof.
 *
 * @param cls closure.
 * @param cmd command being run.
 */
static void
merchant_poll_order_start_cleanup (void *cls,
                                   const struct TALER_TESTING_Command *cmd)
{
  struct MerchantPollOrderStartState *pos = cls;

  if (NULL != pos->ogh)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                "Command `%s' was not terminated\n",
                TALER_TESTING_interpreter_get_current_label (
                  pos->is));
    TALER_MERCHANT_merchant_order_get_cancel (pos->ogh);
  }
  GNUNET_free (pos);
}


/**
 * Start a long poll for GET /private/orders/$ORDER_ID.
 */
struct TALER_TESTING_Command
TALER_TESTING_cmd_poll_order_start (const char *label,
                                    const char *merchant_url,
                                    const char *order_id,
                                    struct GNUNET_TIME_Relative timeout)
{
  struct MerchantPollOrderStartState *pos;

  pos = GNUNET_new (struct MerchantPollOrderStartState);
  pos->order_id = order_id;
  pos->merchant_url = merchant_url;
  pos->timeout = timeout;
  {
    struct TALER_TESTING_Command cmd = {
      .cls = pos,
      .label = label,
      .run = &merchant_poll_order_start_run,
      .cleanup = &merchant_poll_order_start_cleanup
    };

    return cmd;
  }
}


/**
 * Run the "GET order conclude" CMD.
 *
 * @param cls closure.
 * @param cmd command being run now.
 * @param is interpreter state.
 */
static void
merchant_poll_order_conclude_run (void *cls,
                                  const struct TALER_TESTING_Command *cmd,
                                  struct TALER_TESTING_Interpreter *is)
{
  struct MerchantPollOrderConcludeState *poc = cls;
  const struct TALER_TESTING_Command *poll_cmd;
  struct MerchantPollOrderStartState *pos;

  poc->is = is;
  poll_cmd =
    TALER_TESTING_interpreter_lookup_command (is,
                                              poc->start_reference);
  if (NULL == poll_cmd)
    TALER_TESTING_FAIL (poc->is);
  GNUNET_assert (poll_cmd->run == &merchant_poll_order_start_run);
  pos = poll_cmd->cls;
  pos->cs = poc;
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Waiting on GET /private/orders/$ID of %s (%s)\n",
              poc->start_reference,
              (NULL == pos->ogh)
              ? "finished"
              : "active");
  if (NULL == pos->ogh)
    poc->task = GNUNET_SCHEDULER_add_now (&conclude_task,
                                          poc);
  else
    poc->task = GNUNET_SCHEDULER_add_at (pos->deadline,
                                         &conclude_task,
                                         poc);
}


/**
 * Free the state of a "GET order" CMD, and possibly
 * cancel a pending operation thereof.
 *
 * @param cls closure.
 * @param cmd command being run.
 */
static void
merchant_poll_order_conclude_cleanup (void *cls,
                                      const struct TALER_TESTING_Command *cmd)
{
  struct MerchantPollOrderConcludeState *poc = cls;

  if (NULL != poc->task)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                "Command `%s' was not terminated\n",
                TALER_TESTING_interpreter_get_current_label (
                  poc->is));
    GNUNET_SCHEDULER_cancel (poc->task);
    poc->task = NULL;
  }
  GNUNET_free (poc);
}


/**
 * Complete a long poll for GET /private/orders/$ORDER_ID.
 */
struct TALER_TESTING_Command
TALER_TESTING_cmd_poll_order_conclude (const char *label,
                                       unsigned int http_status,
                                       const char *poll_start_reference)
{
  struct MerchantPollOrderConcludeState *cps;

  cps = GNUNET_new (struct MerchantPollOrderConcludeState);
  cps->start_reference = poll_start_reference;
  cps->expected_http_status = http_status;
  {
    struct TALER_TESTING_Command cmd = {
      .cls = cps,
      .label = label,
      .run = &merchant_poll_order_conclude_run,
      .cleanup = &merchant_poll_order_conclude_cleanup
    };

    return cmd;
  }
}


/* end of testing_api_cmd_merchant_get_order.c */