path: root/src/testing/testing_api_cmd_wallet_get_order.c

/*
  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 lib/testing_api_cmd_wallet_get_order.c
 * @brief command to test GET /order/$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 /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;

  /**
   * Whether the order has refunds pending.
   */
  bool refund_pending;
};


/**
 * 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 refund_pending #GNUNET_YES if there are refunds waiting to be
 *        obtained, #GNUNET_NO if all refunds have been obtained, #GNUNET_SYSERR
 *        on 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
 */
static void
wallet_get_order_cb (
  void *cls,
  const struct TALER_MERCHANT_HttpResponse *hr,
  enum GNUNET_GenericReturnValue paid,
  enum GNUNET_GenericReturnValue refunded,
  enum GNUNET_GenericReturnValue refund_pending,
  struct TALER_Amount *refund_amount,
  const char *taler_pay_uri,
  const char *already_paid_order_id)
{
  /* FIXME, deeper checks should be implemented here. */
  struct WalletGetOrderState *gos = cls;
  bool paid_b = (paid == GNUNET_YES);
  bool refunded_b = (refunded == GNUNET_YES);
  bool refund_pending_b = (refund_pending == 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->refund_pending != refund_pending_b)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Order refund pending does not match\n");
      TALER_TESTING_interpreter_fail (gos->is);
      return;
    }
    if (!paid_b)
    {
      /* 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 (taler_pay_uri,
                                        &pud))
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "Taler pay uri is malformed\n");
        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_TESTING_FAIL (gos->is);

      if (GNUNET_OK !=
          TALER_TESTING_get_trait_claim_token (order_cmd,
                                               0,
                                               &claim_token))
        TALER_TESTING_FAIL (gos->is);

      if ((0 != strcmp ("localhost:8080",
                        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 does not match\n");
        TALER_TESTING_interpreter_fail (gos->is);
        TALER_MERCHANT_parse_pay_uri_free (&pud);
        return;
      }
      /* 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 does not match\n");
        TALER_TESTING_interpreter_fail (gos->is);
        TALER_MERCHANT_parse_pay_uri_free (&pud);
        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,
                                              false,
                                              &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 refund_pending whether the order has refunds that haven't been obtained.
 * @param http_status expected HTTP response code for the request.
 */
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,
                                    bool refund_pending,
                                    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->refund_pending = refund_pending;
  {
    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 */