/*
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
*/
/**
* @file lib/testing_api_cmd_wallet_get_order.c
* @brief command to test GET /order/$ORDER_ID
* @author Jonathan Buchanan
*/
#include "platform.h"
#include
#include
#include "taler_merchant_service.h"
#include "taler_merchant_testing_lib.h"
/**
* State for a GET /orders/$ORDER_ID CMD.
*/
struct WalletGetOrderState
{
/**
* 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 /orders/$ORDER_ID request.
*/
struct TALER_MERCHANT_OrderWalletGetHandle *ogh;
/**
* The interpreter state.
*/
struct TALER_TESTING_Interpreter *is;
/**
* Reference to a command that created an order.
*/
const char *order_reference;
/**
* Whether the order was paid or not.
*/
bool paid;
/**
* Whether the order was refunded or not.
*/
bool refunded;
/**
* A NULL-terminated list of refunds associated with this order.
*/
const char **refunds;
/**
* The length of @e refunds.
*/
unsigned int refunds_length;
};
/**
* Callback to process a GET /orders/$ID request
*
* @param cls closure
* @param hr HTTP response details
* @param paid #GNUNET_YES if the payment is settled, #GNUNET_NO if not
* settled, #GNUNET_SYSERR on error
* (note that refunded payments are returned as paid!)
* @param refunded #GNUNET_YES if there is at least on refund on this payment,
* #GNUNET_NO if refunded, #GNUNET_SYSERR or error
* @param refunded_amount amount that was refunded, NULL if there
* was no refund
* @param taler_pay_uri the URI that instructs the wallets to process
* the payment
* @param already_paid_order_id equivalent order that this customer
* paid already, or NULL for none
* @param merchant_pub public key of the merchant
* @param num_refunds length of the @a refunds array
* @param refunds details about the refund processing
*/
static void
wallet_get_order_cb (
void *cls,
const struct TALER_MERCHANT_HttpResponse *hr,
enum GNUNET_GenericReturnValue paid,
enum GNUNET_GenericReturnValue refunded,
struct TALER_Amount *refund_amount,
const char *taler_pay_uri,
const char *already_paid_order_id,
const struct TALER_MerchantPublicKeyP *merchant_pub,
unsigned int num_refunds,
const struct TALER_MERCHANT_RefundDetail *refunds)
{
/* FIXME, deeper checks should be implemented here. */
struct WalletGetOrderState *gos = cls;
bool paid_b = (paid == GNUNET_YES);
bool refunded_b = (refunded == GNUNET_YES);
gos->ogh = NULL;
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 gos->order_reference here to
// check if the data returned matches that from the POST / PATCH
if (gos->paid != paid_b)
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Order paid does not match\n");
TALER_TESTING_interpreter_fail (gos->is);
return;
}
if (gos->refunded != refunded_b)
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Order refunded does not match\n");
TALER_TESTING_interpreter_fail (gos->is);
return;
}
if (gos->refunds_length != num_refunds)
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Order refunds count does not match\n");
TALER_TESTING_interpreter_fail (gos->is);
return;
}
for (unsigned int i = 0; i < num_refunds; ++i)
{
const struct TALER_TESTING_Command *refund_cmd;
const char *expected_amount_str;
struct TALER_Amount expected_amount;
refund_cmd = TALER_TESTING_interpreter_lookup_command (
gos->is,
gos->refunds[i]);
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));
if ((GNUNET_OK !=
TALER_amount_cmp_currency (&expected_amount,
&refunds[i].refund_amount)) ||
(0 != TALER_amount_cmp (&expected_amount,
&refunds[i].refund_amount)))
{
GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
"Refund amounts do not match\n");
TALER_TESTING_interpreter_fail (gos->is);
return;
}
}
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
wallet_get_order_run (void *cls,
const struct TALER_TESTING_Command *cmd,
struct TALER_TESTING_Interpreter *is)
{
struct WalletGetOrderState *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_wallet_order_get (is->ctx,
gos->merchant_url,
order_id,
h_contract,
GNUNET_TIME_UNIT_ZERO,
NULL,
NULL,
&wallet_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
wallet_get_order_cleanup (void *cls,
const struct TALER_TESTING_Command *cmd)
{
struct WalletGetOrderState *gos = cls;
if (NULL != gos->ogh)
{
TALER_LOG_WARNING ("Get tip operation did not complete\n");
TALER_MERCHANT_wallet_order_get_cancel (gos->ogh);
}
GNUNET_free (gos);
}
/**
* Define a GET /orders/$ORDER_ID CMD.
*
* @param label the command label
* @param merchant_url base URL of the merchant which will
* serve the request.
* @param order_reference reference to a command that created an order.
* @param paid whether the order has been paid for or not.
* @param refunded whether the order has been refunded.
* @param http_status expected HTTP response code for the request.
* @param ... NULL-terminated list of labels (const char *) of
* refunds (commands) we expect to be aggregated in the transfer
* (assuming @a http_code is #MHD_HTTP_OK). If @e refunded is false,
* this parameter is ignored.
*/
struct TALER_TESTING_Command
TALER_TESTING_cmd_wallet_get_order (const char *label,
const char *merchant_url,
const char *order_reference,
bool paid,
bool refunded,
unsigned int http_status,
...)
{
struct WalletGetOrderState *gos;
gos = GNUNET_new (struct WalletGetOrderState);
gos->merchant_url = merchant_url;
gos->order_reference = order_reference;
gos->http_status = http_status;
gos->paid = paid;
gos->refunded = refunded;
gos->refunds_length = 0;
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 = &wallet_get_order_run,
.cleanup = &wallet_get_order_cleanup
};
return cmd;
}
}
/* end of testing_api_cmd_wallet_get_order.c */