[taler-merchant] 227/277: implement library method for DELETE /orders/ and tests

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository merchant.

commit 9bae03573f31f22893839bbbbdaeba94821e3a57
Author: Jonathan Buchanan <jonathan.russ.buchanan@gmail.com>
AuthorDate: Fri Jun 19 21:06:03 2020 -0400

    implement library method for DELETE /orders/ and tests
---
 src/backend/taler-merchant-httpd.c         |   7 ++
 src/include/taler_merchant_testing_lib.h   |  17 +++
 src/lib/Makefile.am                        |   1 +
 src/lib/merchant_api_delete_order.c        | 188 +++++++++++++++++++++++++++++
 src/testing/Makefile.am                    |   1 +
 src/testing/test_merchant_api.c            |   4 +
 src/testing/testing_api_cmd_delete_order.c | 179 +++++++++++++++++++++++++++
 7 files changed, 397 insertions(+)

diff --git a/src/backend/taler-merchant-httpd.c 
b/src/backend/taler-merchant-httpd.c
index e5d37a6..804e10e 100644
--- a/src/backend/taler-merchant-httpd.c
+++ b/src/backend/taler-merchant-httpd.c
@@ -856,6 +856,13 @@ url_handler (void *cls,
       .have_id_segment = true,
       .handler = &TMH_private_post_orders_ID_refund
     },
+    /* DELETE /orders/$ID: */
+    {
+      .url_prefix = "/orders/",
+      .method = MHD_HTTP_METHOD_DELETE,
+      .have_id_segment = true,
+      .handler = &TMH_private_delete_orders_ID
+    },
     /* POST /reserves: */
     {
       .url_prefix = "/reserves",
diff --git a/src/include/taler_merchant_testing_lib.h 
b/src/include/taler_merchant_testing_lib.h
index 089e542..e2cec7b 100644
--- a/src/include/taler_merchant_testing_lib.h
+++ b/src/include/taler_merchant_testing_lib.h
@@ -554,6 +554,23 @@ TALER_TESTING_cmd_merchant_order_refund (const char *label,
                                          unsigned int http_code);
 
 
+/**
+ * Define a "DELETE order" CMD.
+ *
+ * @param label command label.
+ * @param merchant_url base URL of the merchant serving the
+ *        DELETE /instances/$ID request.
+ * @param order_id the ID of the instance to query
+ * @param http_status expected HTTP response code.
+ * @return the command.
+ */
+struct TALER_TESTING_Command
+TALER_TESTING_cmd_merchant_delete_order (const char *label,
+                                         const char *merchant_url,
+                                         const char *order_id,
+                                         unsigned int http_status);
+
+
 /* ******************* /transfers *************** */
 
 
diff --git a/src/lib/Makefile.am b/src/lib/Makefile.am
index d0bfaeb..7254c20 100644
--- a/src/lib/Makefile.am
+++ b/src/lib/Makefile.am
@@ -16,6 +16,7 @@ libtalermerchant_la_LDFLAGS = \
 libtalermerchant_la_SOURCES = \
   merchant_api_common.c \
   merchant_api_delete_instance.c \
+  merchant_api_delete_order.c \
   merchant_api_delete_product.c \
   merchant_api_delete_reserve.c \
   merchant_api_get_config.c \
diff --git a/src/lib/merchant_api_delete_order.c 
b/src/lib/merchant_api_delete_order.c
new file mode 100644
index 0000000..4b08e8c
--- /dev/null
+++ b/src/lib/merchant_api_delete_order.c
@@ -0,0 +1,188 @@
+/*
+  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 Lesser General Public License as published by the Free 
Software
+  Foundation; either version 2.1, 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 Lesser General Public License for more 
details.
+
+  You should have received a copy of the GNU Lesser General Public License 
along with
+  TALER; see the file COPYING.LGPL.  If not, see
+  <http://www.gnu.org/licenses/>
+*/
+/**
+ * @file lib/merchant_api_delete_order.c
+ * @brief Implementation of the DELETE /orders/$ORDER_ID request of the 
merchant's HTTP API
+ * @author Jonathan Buchanan
+ */
+#include "platform.h"
+#include <curl/curl.h>
+#include <jansson.h>
+#include <microhttpd.h> /* just for HTTP status codes */
+#include <gnunet/gnunet_util_lib.h>
+#include <gnunet/gnunet_curl_lib.h>
+#include "taler_merchant_service.h"
+#include <taler/taler_json_lib.h>
+#include <taler/taler_signatures.h>
+
+/**
+ * Handle for a DELETE /orders/$ID operation.
+ */
+struct TALER_MERCHANT_OrderDeleteHandle
+{
+  /**
+   * The url for this request.
+   */
+  char *url;
+
+  /**
+   * Handle for the request.
+   */
+  struct GNUNET_CURL_Job *job;
+
+  /**
+   * Function to call with the result.
+   */
+  TALER_MERCHANT_OrderDeleteCallback cb;
+
+  /**
+   * Closure for @a cb.
+   */
+  void *cb_cls;
+
+  /**
+   * Reference to the execution context.
+   */
+  struct GNUNET_CURL_Context *ctx;
+};
+
+
+/**
+ * Function called when we're done processing the
+ * HTTP DELETE /orders/$ORDER_ID request.
+ *
+ * @param cls the `struct TALER_MERCHANT_OrderDeleteHandle`
+ * @param response_code HTTP response code, 0 on error
+ * @param json response body, NULL if not in JSON
+ */
+static void
+handle_delete_order_finished (void *cls,
+                              long response_code,
+                              const void *response)
+{
+  struct TALER_MERCHANT_OrderDeleteHandle *odh = cls;
+  struct TALER_MERCHANT_HttpResponse hr = {
+    .http_status = (unsigned int) response_code,
+    .reply = NULL,
+  };
+
+  odh->job = NULL;
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Got /orders/$ID response with status code %u\n",
+              (unsigned int) response_code);
+  switch (response_code)
+  {
+  case MHD_HTTP_NO_CONTENT:
+    break;
+  case MHD_HTTP_NOT_FOUND:
+    break;
+  case MHD_HTTP_CONFLICT:
+    break;
+  default:
+    /* unexpected response code */
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Unexpected response code %u\n",
+                (unsigned int) response_code);
+    break;
+  }
+  odh->cb (odh->cb_cls,
+           &hr);
+  TALER_MERCHANT_order_delete_cancel (odh);
+}
+
+
+/**
+ * Make a DELETE /orders/$ID request to delete a order from our
+ * inventory.
+ *
+ * @param ctx the context
+ * @param backend_url HTTP base URL for the backend
+ * @param order_id identifier of the order
+ * @param cb function to call with the backend's deletion status
+ * @param cb_cls closure for @a cb
+ * @return the request handle; NULL upon error
+ */
+struct TALER_MERCHANT_OrderDeleteHandle *
+TALER_MERCHANT_order_delete (
+  struct GNUNET_CURL_Context *ctx,
+  const char *backend_url,
+  const char *order_id,
+  TALER_MERCHANT_OrderDeleteCallback cb,
+  void *cb_cls)
+{
+  struct TALER_MERCHANT_OrderDeleteHandle *odh;
+
+  odh = GNUNET_new (struct TALER_MERCHANT_OrderDeleteHandle);
+  odh->ctx = ctx;
+  odh->cb = cb;
+  odh->cb_cls = cb_cls;
+  {
+    char *path;
+
+    GNUNET_asprintf (&path,
+                     "private/orders/%s",
+                     order_id);
+
+    odh->url = TALER_url_join (backend_url,
+                               path,
+                               NULL);
+    GNUNET_free (path);
+  }
+  if (NULL == odh->url)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Could not construct request url.\n");
+    GNUNET_free (odh);
+    return NULL;
+  }
+
+  {
+    CURL *eh;
+
+    eh = curl_easy_init ();
+    GNUNET_assert (CURLE_OK ==
+                   curl_easy_setopt (eh,
+                                     CURLOPT_URL,
+                                     odh->url));
+    GNUNET_assert (CURLE_OK ==
+                   curl_easy_setopt (eh,
+                                     CURLOPT_CUSTOMREQUEST,
+                                     MHD_HTTP_METHOD_DELETE));
+    odh->job = GNUNET_CURL_job_add (ctx,
+                                    eh,
+                                    GNUNET_YES,
+                                    &handle_delete_order_finished,
+                                    odh);
+  }
+  return odh;
+}
+
+
+/**
+ * Cancel DELETE /orders/$ID operation.
+ *
+ * @param odh operation to cancel
+ */
+void
+TALER_MERCHANT_order_delete_cancel (
+  struct TALER_MERCHANT_OrderDeleteHandle *odh)
+{
+  if (NULL != odh->job)
+    GNUNET_CURL_job_cancel (odh->job);
+  GNUNET_free (odh->url);
+  GNUNET_free (odh);
+}
diff --git a/src/testing/Makefile.am b/src/testing/Makefile.am
index 92da57f..228113d 100644
--- a/src/testing/Makefile.am
+++ b/src/testing/Makefile.am
@@ -27,6 +27,7 @@ libtalermerchanttesting_la_SOURCES = \
   testing_api_cmd_get_tips.c \
   testing_api_cmd_get_transfers.c \
   testing_api_cmd_delete_instance.c \
+  testing_api_cmd_delete_order.c \
   testing_api_cmd_delete_product.c \
   testing_api_cmd_delete_reserve.c \
   testing_api_cmd_lock_product.c \
diff --git a/src/testing/test_merchant_api.c b/src/testing/test_merchant_api.c
index fa7f80d..9362be3 100644
--- a/src/testing/test_merchant_api.c
+++ b/src/testing/test_merchant_api.c
@@ -346,6 +346,10 @@ run (void *cls,
                                           "withdraw-coin-1",
                                           "EUR:5",
                                           "EUR:4.99"),
+    TALER_TESTING_cmd_merchant_delete_order ("delete-order-1",
+                                             merchant_url,
+                                             "1",
+                                             MHD_HTTP_NO_CONTENT),
     TALER_TESTING_cmd_check_bank_empty ("check_bank_empty-1"),
     CMD_EXEC_AGGREGATOR ("run-aggregator"),
     TALER_TESTING_cmd_check_bank_transfer ("check_bank_transfer-498c",
diff --git a/src/testing/testing_api_cmd_delete_order.c 
b/src/testing/testing_api_cmd_delete_order.c
new file mode 100644
index 0000000..6a86c17
--- /dev/null
+++ b/src/testing/testing_api_cmd_delete_order.c
@@ -0,0 +1,179 @@
+/*
+  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_delete_order.c
+ * @brief command to test DELETE /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 of a "DELETE /order/$ORDER_ID" CMD.
+ */
+struct DeleteOrderState
+{
+
+  /**
+   * Handle for a "DELETE order" request.
+   */
+  struct TALER_MERCHANT_OrderDeleteHandle *odh;
+
+  /**
+   * The interpreter state.
+   */
+  struct TALER_TESTING_Interpreter *is;
+
+  /**
+   * Base URL of the merchant serving the request.
+   */
+  const char *merchant_url;
+
+  /**
+   * ID of the order to run DELETE for.
+   */
+  const char *order_id;
+
+  /**
+   * Expected HTTP response code.
+   */
+  unsigned int http_status;
+
+};
+
+
+/**
+ * Callback for a DELETE /orders/$ID operation.
+ *
+ * @param cls closure for this function
+ */
+static void
+delete_order_cb (void *cls,
+                 const struct TALER_MERCHANT_HttpResponse *hr)
+{
+  struct DeleteOrderState *dos = cls;
+
+  dos->odh = NULL;
+  if (dos->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 (dos->is));
+    TALER_TESTING_interpreter_fail (dos->is);
+    return;
+  }
+  switch (hr->http_status)
+  {
+  case MHD_HTTP_OK:
+    break;
+  default:
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                "Unhandled HTTP status.\n");
+  }
+  TALER_TESTING_interpreter_next (dos->is);
+}
+
+
+/**
+ * Run the "DELETE order" CMD.
+ *
+ *
+ * @param cls closure.
+ * @param cmd command being run now.
+ * @param is interpreter state.
+ */
+static void
+delete_order_run (void *cls,
+                  const struct TALER_TESTING_Command *cmd,
+                  struct TALER_TESTING_Interpreter *is)
+{
+  struct DeleteOrderState *dos = cls;
+
+  dos->is = is;
+  dos->odh = TALER_MERCHANT_order_delete (is->ctx,
+                                          dos->merchant_url,
+                                          dos->order_id,
+                                          &delete_order_cb,
+                                          dos);
+  GNUNET_assert (NULL != dos->odh);
+}
+
+
+/**
+ * Free the state of a "DELETE order" CMD, and possibly
+ * cancel a pending operation thereof.
+ *
+ * @param cls closure.
+ * @param cmd command being run.
+ */
+static void
+delete_order_cleanup (void *cls,
+                      const struct TALER_TESTING_Command *cmd)
+{
+  struct DeleteOrderState *dos = cls;
+
+  if (NULL != dos->odh)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                "DELETE /orders/$ORDER_ID operation did not complete\n");
+    TALER_MERCHANT_order_delete_cancel (dos->odh);
+  }
+  GNUNET_free (dos);
+}
+
+
+/**
+ * Define a "DELETE order" CMD.
+ *
+ * @param label command label.
+ * @param merchant_url base URL of the merchant serving the
+ *        DELETE /instances/$ID request.
+ * @param order_id the ID of the instance to query
+ * @param http_status expected HTTP response code.
+ * @return the command.
+ */
+struct TALER_TESTING_Command
+TALER_TESTING_cmd_merchant_delete_order (const char *label,
+                                         const char *merchant_url,
+                                         const char *order_id,
+                                         unsigned int http_status)
+{
+  struct DeleteOrderState *dos;
+
+  dos = GNUNET_new (struct DeleteOrderState);
+  dos->merchant_url = merchant_url;
+  dos->order_id = order_id;
+  dos->http_status = http_status;
+  {
+    struct TALER_TESTING_Command cmd = {
+      .cls = dos,
+      .label = label,
+      .run = &delete_order_run,
+      .cleanup = &delete_order_cleanup
+    };
+
+    return cmd;
+  }
+}

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.