path: root/src/testing/testing_api_cmd_merchant_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_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;

  /**
   * 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 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;
  const struct TALER_TESTING_Command *order_cmd;

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

  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 gts->tip_reference here to
    // check if the data returned matches that from the POST / PATCH
    if (gos->paid != osr->paid)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Order paid does not match\n");
      TALER_TESTING_interpreter_fail (gos->is);
      return;
    }
    if (gos->paid)
    {
      const struct TALER_TESTING_Command *order_cmd;

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

      {
        const json_t *expected_contract_terms;

        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;
        }
        if (1 != json_equal (expected_contract_terms,
                             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;
        }
      }

      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;
      }
      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));
          if ((GNUNET_OK !=
               TALER_amount_cmp_currency (&expected_amount,
                                          amount_found)) ||
              (0 != TALER_amount_cmp (&expected_amount,
                                      amount_found)))
          {
            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;
          }
        }
      }
    }
    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,
                                                false,
                                                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_free (gos);
}


/**
 * Define a GET /private/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_merchant_get_order (const char *label,
                                      const char *merchant_url,
                                      const char *order_reference,
                                      bool paid,
                                      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->paid = paid;
  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 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 /poll-payment
 * command expired or we got a response.  Checks if the
 * result is what we expected.
 *
 * @param cls a `struct PollPaymentConcludeState`
 */
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 /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;
  if (MHD_HTTP_OK != 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 (pos->is));
    TALER_TESTING_interpreter_fail (pos->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
    break;
  default:
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Unhandled HTTP status.\n");
  }
  pos->http_status = hr->http_status;
  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" 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;
  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 */