summaryrefslogtreecommitdiff
path: root/src/lib/testing_api_cmd_track.c
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-01-19 15:23:19 +0100
committerFlorian Dold <florian.dold@gmail.com>2020-01-19 15:23:33 +0100
commit72a629a8be1ed2adc7402285e0f19f8f06816a26 (patch)
tree499468c12eaf06e8ad514db7b1ff684462c99ac2 /src/lib/testing_api_cmd_track.c
parentdbf85bbc0d23b044aa47be67ceae4e6ecd709298 (diff)
downloadexchange-72a629a8be1ed2adc7402285e0f19f8f06816a26.tar.gz
exchange-72a629a8be1ed2adc7402285e0f19f8f06816a26.tar.bz2
exchange-72a629a8be1ed2adc7402285e0f19f8f06816a26.zip
move testing logic and integration tests into separate directory
Diffstat (limited to 'src/lib/testing_api_cmd_track.c')
-rw-r--r--src/lib/testing_api_cmd_track.c806
1 files changed, 0 insertions, 806 deletions
diff --git a/src/lib/testing_api_cmd_track.c b/src/lib/testing_api_cmd_track.c
deleted file mode 100644
index 51ad45be4..000000000
--- a/src/lib/testing_api_cmd_track.c
+++ /dev/null
@@ -1,806 +0,0 @@
-/*
- This file is part of TALER
- Copyright (C) 2014-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_track.c
- * @brief Implement the testing CMDs for the /track operations.
- * @author Marcello Stanisci
- */
-#include "platform.h"
-#include "taler_json_lib.h"
-#include <gnunet/gnunet_curl_lib.h>
-#include "exchange_api_handle.h"
-#include "taler_testing_lib.h"
-
-/**
- * State for a "track transaction" CMD.
- */
-struct TrackTransactionState
-{
-
- /**
- * If non NULL, will provide a WTID to be compared against
- * the one returned by the "track transaction" operation.
- */
- const char *bank_transfer_reference;
-
- /**
- * The WTID associated by the transaction being tracked.
- */
- struct TALER_WireTransferIdentifierRawP wtid;
-
- /**
- * Expected HTTP response code.
- */
- unsigned int expected_response_code;
-
- /**
- * Reference to any operation that can provide a transaction.
- * Will be the transaction to track.
- */
- const char *transaction_reference;
-
- /**
- * Index of the coin involved in the transaction. Recall:
- * at the exchange, the tracking is done _per coin_.
- */
- unsigned int coin_index;
-
- /**
- * Handle to the "track transaction" pending operation.
- */
- struct TALER_EXCHANGE_TrackTransactionHandle *tth;
-
- /**
- * Interpreter state.
- */
- struct TALER_TESTING_Interpreter *is;
-};
-
-
-/**
- * State for a "track transfer" CMD.
- */
-struct TrackTransferState
-{
-
- /**
- * Expected amount for the WTID being tracked.
- */
- const char *expected_total_amount;
-
- /**
- * Expected fee for this WTID.
- */
- const char *expected_wire_fee;
-
- /**
- * Expected HTTP response code.
- */
- unsigned int expected_response_code;
-
- /**
- * Reference to any operation that can provide a WTID.
- * Will be the WTID to track.
- */
- const char *wtid_reference;
-
- /**
- * Reference to any operation that can provide wire details.
- * Those wire details will then be matched against the credit
- * bank account of the tracked WTID. This way we can test that
- * a wire transfer paid back one particular bank account.
- */
- const char *wire_details_reference;
-
- /**
- * Reference to any operation that can provide an amount.
- * This way we can check that the transferred amount matches
- * our expectations.
- */
- const char *total_amount_reference;
-
- /**
- * Index to the WTID to pick, in case @a wtid_reference has
- * many on offer.
- */
- unsigned int index;
-
- /**
- * Handle to a pending "track transfer" operation.
- */
- struct TALER_EXCHANGE_TrackTransferHandle *tth;
-
- /**
- * Interpreter state.
- */
- struct TALER_TESTING_Interpreter *is;
-};
-
-
-/**
- * Checks what is returned by the "track transaction" operation.
- * Checks that the HTTP response code is acceptable, and - if the
- * right reference is non NULL - that the wire transfer subject
- * line matches our expectations.
- *
- * @param cls closure.
- * @param http_status HTTP status code we got.
- * @param ec taler-specific error code.
- * @param exchange_pub public key of the exchange
- * @param json original json reply (may include signatures, those
- * have then been validated already).
- * @param wtid wire transfer identifier, NULL if exchange did not
- * execute the transaction yet.
- * @param execution_time actual or planned execution time for the
- * wire transfer.
- * @param coin_contribution contribution to the total amount of
- * the deposited coin (can be NULL).
- */
-static void
-deposit_wtid_cb (void *cls,
- unsigned int http_status,
- enum TALER_ErrorCode ec,
- const struct TALER_ExchangePublicKeyP *exchange_pub,
- const json_t *json,
- const struct TALER_WireTransferIdentifierRawP *wtid,
- struct GNUNET_TIME_Absolute execution_time,
- const struct TALER_Amount *coin_contribution)
-{
- struct TrackTransactionState *tts = cls;
- struct TALER_TESTING_Interpreter *is = tts->is;
- struct TALER_TESTING_Command *cmd = &is->commands[is->ip];
-
- (void) coin_contribution;
- (void) exchange_pub;
- tts->tth = NULL;
- if (tts->expected_response_code != http_status)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- "Unexpected response code %u to command %s in %s:%u\n",
- http_status,
- cmd->label,
- __FILE__,
- __LINE__);
- json_dumpf (json, stderr, 0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
- switch (http_status)
- {
- case MHD_HTTP_OK:
- tts->wtid = *wtid;
- if (NULL != tts->bank_transfer_reference)
- {
- const struct TALER_TESTING_Command *bank_transfer_cmd;
- const struct TALER_WireTransferIdentifierRawP *wtid_want;
-
- /* _this_ wire transfer subject line. */
- bank_transfer_cmd = TALER_TESTING_interpreter_lookup_command
- (is, tts->bank_transfer_reference);
- if (NULL == bank_transfer_cmd)
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_wtid
- (bank_transfer_cmd, 0, &wtid_want))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- /* Compare that expected and gotten subjects match. */
- if (0 != GNUNET_memcmp (wtid,
- wtid_want))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
- }
- break;
- case MHD_HTTP_ACCEPTED:
- /* allowed, nothing to check here */
- break;
- case MHD_HTTP_NOT_FOUND:
- /* allowed, nothing to check here */
- break;
- default:
- GNUNET_break (0);
- break;
- }
- TALER_TESTING_interpreter_next (tts->is);
-}
-
-
-/**
- * Run the command.
- *
- * @param cls closure.
- * @param cmd the command to execute.
- * @param is the interpreter state.
- */
-static void
-track_transaction_run (void *cls,
- const struct TALER_TESTING_Command *cmd,
- struct TALER_TESTING_Interpreter *is)
-{
- struct TrackTransactionState *tts = cls;
- const struct TALER_TESTING_Command *transaction_cmd;
- const struct TALER_CoinSpendPrivateKeyP *coin_priv;
- struct TALER_CoinSpendPublicKeyP coin_pub;
- const json_t *contract_terms;
- const json_t *wire_details;
- struct GNUNET_HashCode h_wire_details;
- struct GNUNET_HashCode h_contract_terms;
- const struct TALER_MerchantPrivateKeyP *merchant_priv;
-
- tts->is = is;
- transaction_cmd
- = TALER_TESTING_interpreter_lookup_command (tts->is,
- tts->transaction_reference);
- if (NULL == transaction_cmd)
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_coin_priv (transaction_cmd,
- tts->coin_index,
- &coin_priv))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- GNUNET_CRYPTO_eddsa_key_get_public (&coin_priv->eddsa_priv,
- &coin_pub.eddsa_pub);
-
- /* Get the strings.. */
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_wire_details (transaction_cmd,
- 0,
- &wire_details))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_contract_terms (transaction_cmd,
- 0,
- &contract_terms))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- if ( (NULL == wire_details) ||
- (NULL == contract_terms) )
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- /* Should not fail here, json has been parsed already */
- GNUNET_assert
- ( (GNUNET_OK ==
- TALER_JSON_merchant_wire_signature_hash (wire_details,
- &h_wire_details)) &&
- (GNUNET_OK ==
- TALER_JSON_hash (contract_terms,
- &h_contract_terms)) );
-
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_merchant_priv (transaction_cmd,
- 0,
- &merchant_priv))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- tts->tth = TALER_EXCHANGE_track_transaction (is->exchange,
- merchant_priv,
- &h_wire_details,
- &h_contract_terms,
- &coin_pub,
- &deposit_wtid_cb,
- tts);
- GNUNET_assert (NULL != tts->tth);
-}
-
-
-/**
- * Cleanup the state from a "track transaction" CMD, and possibly
- * cancel a operation thereof.
- *
- * @param cls closure.
- * @param cmd the command which is being cleaned up.
- */
-static void
-track_transaction_cleanup (void *cls,
- const struct TALER_TESTING_Command *cmd)
-{
- struct TrackTransactionState *tts = cls;
-
- if (NULL != tts->tth)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
- "Command %u (%s) did not complete\n",
- tts->is->ip,
- cmd->label);
- TALER_EXCHANGE_track_transaction_cancel (tts->tth);
- tts->tth = NULL;
- }
- GNUNET_free (tts);
-}
-
-
-/**
- * Offer internal data from a "track transaction" CMD.
- *
- * @param cls closure.
- * @param[out] ret result (could be anything).
- * @param trait name of the trait.
- * @param index index number of the object to offer.
- * @return #GNUNET_OK on success.
- */
-static int
-track_transaction_traits (void *cls,
- const void **ret,
- const char *trait,
- unsigned int index)
-{
- struct TrackTransactionState *tts = cls;
- struct TALER_TESTING_Trait traits[] = {
- TALER_TESTING_make_trait_wtid (0, &tts->wtid),
- TALER_TESTING_trait_end ()
- };
-
- return TALER_TESTING_get_trait (traits,
- ret,
- trait,
- index);
-}
-
-
-/**
- * Create a "track transaction" command.
- *
- * @param label the command label.
- * @param transaction_reference reference to a deposit operation,
- * will be used to get the input data for the track.
- * @param coin_index index of the coin involved in the transaction.
- * @param expected_response_code expected HTTP response code.
- * @param bank_transfer_reference reference to a command that
- * can offer a WTID so as to check that against what WTID
- * the tracked operation has. Set as NULL if not needed.
- * @return the command.
- */
-struct TALER_TESTING_Command
-TALER_TESTING_cmd_track_transaction (const char *label,
- const char *transaction_reference,
- unsigned int coin_index,
- unsigned int expected_response_code,
- const char *bank_transfer_reference)
-{
- struct TrackTransactionState *tts;
-
- tts = GNUNET_new (struct TrackTransactionState);
- tts->transaction_reference = transaction_reference;
- tts->expected_response_code = expected_response_code;
- tts->bank_transfer_reference = bank_transfer_reference;
- tts->coin_index = coin_index;
- {
- struct TALER_TESTING_Command cmd = {
- .cls = tts,
- .label = label,
- .run = &track_transaction_run,
- .cleanup = &track_transaction_cleanup,
- .traits = &track_transaction_traits
- };
-
- return cmd;
- }
-}
-
-
-/**
- * Cleanup the state for a "track transfer" CMD, and possibly
- * cancel a pending operation thereof.
- *
- * @param cls closure.
- * @param cmd the command which is being cleaned up.
- */
-static void
-track_transfer_cleanup (void *cls,
- const struct TALER_TESTING_Command *cmd)
-{
-
- struct TrackTransferState *tts = cls;
-
- if (NULL != tts->tth)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
- "Command %u (%s) did not complete\n",
- tts->is->ip,
- cmd->label);
- TALER_EXCHANGE_track_transfer_cancel (tts->tth);
- tts->tth = NULL;
- }
- GNUNET_free (tts);
-}
-
-
-/**
- * Check whether the HTTP response code from a "track transfer"
- * operation is acceptable, and all other values like total amount,
- * wire fees and hashed wire details as well.
- *
- * @param cls closure.
- * @param http_status HTTP status code we got.
- * @param ec taler-specific error code.
- * @param exchange_pub public key the exchange used for signing
- * the response.
- * @param json original json reply (may include signatures, those
- * have then been validated already).
- * @param h_wire hash of the wire transfer address the transfer
- * went to, or NULL on error.
- * @param execution_time time when the exchange claims to have
- * performed the wire transfer.
- * @param total_amount total amount of the wire transfer, or NULL
- * if the exchange could not provide any @a wtid (set only
- * if @a http_status is "200 OK").
- * @param wire_fee wire fee that was charged by the exchange.
- * @param details_length length of the @a details array.
- * @param details array with details about the combined
- * transactions.
- */
-static void
-track_transfer_cb (void *cls,
- unsigned int http_status,
- enum TALER_ErrorCode ec,
- const struct TALER_ExchangePublicKeyP *exchange_pub,
- const json_t *json,
- const struct GNUNET_HashCode *h_wire,
- struct GNUNET_TIME_Absolute execution_time,
- const struct TALER_Amount *total_amount,
- const struct TALER_Amount *wire_fee,
- unsigned int details_length,
- const struct TALER_TrackTransferDetails *details)
-{
- struct TrackTransferState *tts = cls;
- struct TALER_TESTING_Interpreter *is = tts->is;
- struct TALER_TESTING_Command *cmd = &is->commands[is->ip];
- struct TALER_Amount expected_amount;
-
- (void) exchange_pub;
- tts->tth = NULL;
- if (tts->expected_response_code != http_status)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- "Unexpected response code %u to command %s in %s:%u\n",
- http_status,
- cmd->label,
- __FILE__,
- __LINE__);
- json_dumpf (json, stderr, 0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- switch (http_status)
- {
- case MHD_HTTP_OK:
- if (NULL == tts->expected_total_amount)
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
- if (NULL == tts->expected_wire_fee)
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_string_to_amount (tts->expected_total_amount,
- &expected_amount))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
- if (0 != TALER_amount_cmp (total_amount,
- &expected_amount))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- "Total amount missmatch to command %s - "
- "%s vs %s\n",
- cmd->label,
- TALER_amount_to_string (total_amount),
- TALER_amount_to_string (&expected_amount));
- json_dumpf (json, stderr, 0);
- fprintf (stderr, "\n");
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_string_to_amount (tts->expected_wire_fee,
- &expected_amount))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (0 != TALER_amount_cmp (wire_fee,
- &expected_amount))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- "Wire fee missmatch to command %s\n",
- cmd->label);
- json_dumpf (json, stderr, 0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- /**
- * Optionally checking: (1) wire-details for this transfer
- * match the ones from a referenced "deposit" operation -
- * or any operation that could provide wire-details. (2)
- * Total amount for this transfer matches the one from any
- * referenced command that could provide one.
- */if (NULL != tts->wire_details_reference)
- {
- const struct TALER_TESTING_Command *wire_details_cmd;
- const json_t *wire_details;
- struct GNUNET_HashCode h_wire_details;
-
- if (NULL == (wire_details_cmd
- = TALER_TESTING_interpreter_lookup_command
- (is, tts->wire_details_reference)))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_wire_details (wire_details_cmd,
- 0,
- &wire_details))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- GNUNET_assert
- (GNUNET_OK ==
- TALER_JSON_merchant_wire_signature_hash (wire_details,
- &h_wire_details));
-
- if (0 != GNUNET_memcmp (&h_wire_details,
- h_wire))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- "Wire hash missmath to command %s\n",
- cmd->label);
- json_dumpf (json, stderr, 0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
- }
- if (NULL != tts->total_amount_reference)
- {
- const struct TALER_TESTING_Command *total_amount_cmd;
- const struct TALER_Amount *total_amount_from_reference;
-
- if (NULL == (total_amount_cmd
- = TALER_TESTING_interpreter_lookup_command
- (is, tts->total_amount_reference)))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (GNUNET_OK !=
- TALER_TESTING_get_trait_amount_obj (total_amount_cmd,
- 0,
- &total_amount_from_reference))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
-
- if (0 != TALER_amount_cmp (total_amount,
- total_amount_from_reference))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- "Amount missmath to command %s\n",
- cmd->label);
- json_dumpf (json, stderr, 0);
- TALER_TESTING_interpreter_fail (is);
- return;
- }
- }
- }
- TALER_TESTING_interpreter_next (is);
-}
-
-
-/**
- * Run the command.
- *
- * @param cls closure.
- * @param cmd the command under execution.
- * @param is the interpreter state.
- */
-static void
-track_transfer_run (void *cls,
- const struct TALER_TESTING_Command *cmd,
- struct TALER_TESTING_Interpreter *is)
-{
- /* looking for a wtid to track .. */
- struct TrackTransferState *tts = cls;
- struct TALER_WireTransferIdentifierRawP wtid;
- const struct TALER_WireTransferIdentifierRawP *wtid_ptr;
-
- /* If no reference is given, we'll use a all-zeros
- * WTID */
- memset (&wtid, 0, sizeof (wtid));
- wtid_ptr = &wtid;
-
- tts->is = is;
- if (NULL != tts->wtid_reference)
- {
- const struct TALER_TESTING_Command *wtid_cmd;
-
- wtid_cmd = TALER_TESTING_interpreter_lookup_command
- (tts->is, tts->wtid_reference);
-
- if (NULL == wtid_cmd)
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
-
- if (GNUNET_OK != TALER_TESTING_get_trait_wtid
- (wtid_cmd, tts->index, &wtid_ptr))
- {
- GNUNET_break (0);
- TALER_TESTING_interpreter_fail (tts->is);
- return;
- }
- GNUNET_assert (NULL != wtid_ptr);
- }
- tts->tth = TALER_EXCHANGE_track_transfer (is->exchange,
- wtid_ptr,
- &track_transfer_cb,
- tts);
- GNUNET_assert (NULL != tts->tth);
-}
-
-
-/**
- * Make a "track transfer" CMD where no "expected"-arguments,
- * except the HTTP response code, are given. The best use case
- * is when what matters to check is the HTTP response code, e.g.
- * when a bogus WTID was passed.
- *
- * @param label the command label
- * @param wtid_reference reference to any command which can provide
- * a wtid. If NULL is given, then a all zeroed WTID is
- * used that will at 99.9999% probability NOT match any
- * existing WTID known to the exchange.
- * @param index index number of the WTID to track, in case there
- * are multiple on offer.
- * @param expected_response_code expected HTTP response code.
- * @return the command.
- */
-struct TALER_TESTING_Command
-TALER_TESTING_cmd_track_transfer_empty (const char *label,
- const char *wtid_reference,
- unsigned int index,
- unsigned int expected_response_code)
-{
- struct TrackTransferState *tts;
-
- tts = GNUNET_new (struct TrackTransferState);
- tts->wtid_reference = wtid_reference;
- tts->index = index;
- tts->expected_response_code = expected_response_code;
- {
- struct TALER_TESTING_Command cmd = {
- .cls = tts,
- .label = label,
- .run = &track_transfer_run,
- .cleanup = &track_transfer_cleanup
- };
-
- return cmd;
- }
-}
-
-
-/**
- * Make a "track transfer" command, specifying which amount and
- * wire fee are expected.
- *
- * @param label the command label.
- * @param wtid_reference reference to any command which can provide
- * a wtid. Will be the one tracked.
- * @param index in case there are multiple WTID offered, this
- * parameter selects a particular one.
- * @param expected_response_code expected HTTP response code.
- * @param expected_total_amount how much money we expect being moved
- * with this wire-transfer.
- * @param expected_wire_fee expected wire fee.
- * @return the command
- */
-struct TALER_TESTING_Command
-TALER_TESTING_cmd_track_transfer (const char *label,
- const char *wtid_reference,
- unsigned int index,
- unsigned int expected_response_code,
- const char *expected_total_amount,
- const char *expected_wire_fee)
-{
- struct TrackTransferState *tts;
-
- tts = GNUNET_new (struct TrackTransferState);
- tts->wtid_reference = wtid_reference;
- tts->index = index;
- tts->expected_response_code = expected_response_code;
- tts->expected_total_amount = expected_total_amount;
- tts->expected_wire_fee = expected_wire_fee;
- {
- struct TALER_TESTING_Command cmd = {
- .cls = tts,
- .label = label,
- .run = &track_transfer_run,
- .cleanup = &track_transfer_cleanup
- };
-
- return cmd;
- }
-}
-
-
-/* end of testing_api_cmd_track.c */