taler/exchange
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Commenting the "track"(s) CMDs.

Browse Source
This commit is contained in:
Marcello Stanisci 2018-05-28 15:31:50 +02:00
parent 25ca8f90ad
commit d08d25e101
No known key found for this signature in database
GPG Key ID: 8D526861953F4C0F
1 changed files with 110 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

191
src/exchange-lib/testing_api_cmd_track.c
View File

@ -18,29 +18,30 @@
*/ */
/** /**
* @file exchange/testing_api_cmd_status.c * @file exchange/testing_api_cmd_track.c
* @brief Implement the /reserve/status test command. * @brief Implement the testing CMDs for the /track operations.
* @author Marcello Stanisci * @author Marcello Stanisci
*/ */
#include "platform.h" #include "platform.h"
#include "taler_json_lib.h" #include "taler_json_lib.h"
#include <gnunet/gnunet_curl_lib.h> #include <gnunet/gnunet_curl_lib.h>
#include "exchange_api_handle.h" #include "exchange_api_handle.h"
#include "taler_testing_lib.h" #include "taler_testing_lib.h"
/**
* State for a "track transaction" CMD.
*/
struct TrackTransactionState struct TrackTransactionState
{ {
/** /**
* Which #OC_CHECK_BANK_TRANSFER wtid should this match? NULL * If non NULL, will provide a WTID to be compared against
* for none. * the one returned by the "track transaction" operation.
*/ */
const char *bank_transfer_reference; const char *bank_transfer_reference;
/** /**
* Wire transfer identifier, set if #MHD_HTTP_OK was the * The WTID associated by the transaction being tracked.
* response code.
*/ */
struct TALER_WireTransferIdentifierRawP wtid; struct TALER_WireTransferIdentifierRawP wtid;
@ -51,17 +52,18 @@ struct TrackTransactionState
/** /**
* Reference to any operation that can provide a transaction. * Reference to any operation that can provide a transaction.
* Tipically a /deposit operation. * Will be the transaction to track.
*/ */
const char *transaction_reference; const char *transaction_reference;
/** /**
* Index of the coin involved in the transaction. * Index of the coin involved in the transaction. Recall:
* at the exchange, the tracking is done _per coin_.
*/ */
unsigned int coin_index; unsigned int coin_index;
/** /**
* Handle to the deposit wtid request. * Handle to the "track transaction" pending operation.
*/ */
struct TALER_EXCHANGE_TrackTransactionHandle *tth; struct TALER_EXCHANGE_TrackTransactionHandle *tth;
@ -76,11 +78,15 @@ struct TrackTransactionState
struct TALER_TESTING_Interpreter *is; struct TALER_TESTING_Interpreter *is;
}; };
/**
* State for a "track transfer" CMD.
*/
struct TrackTransferState struct TrackTransferState
{ {
/** /**
* Expected amount for this WTID. * Expected amount for the WTID being tracked.
*/ */
const char *expected_total_amount; const char *expected_total_amount;
@ -96,31 +102,38 @@ struct TrackTransferState
/** /**
* Reference to any operation that can provide a WTID. * Reference to any operation that can provide a WTID.
* Will be the WTID to track.
*/ */
const char *wtid_reference; const char *wtid_reference;
/** /**
* Reference to any operation that can provide wire details. * 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; const char *wire_details_reference;
/** /**
* Reference to any operation that can provide an amount. * 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; const char *total_amount_reference;
/** /**
* Index to the WTID to pick. * Index to the WTID to pick, in case @a wtid_reference has
* many on offer.
*/ */
unsigned int index; unsigned int index;
/** /**
* Handle to the deposit wtid request. * Handle to a pending "track transfer" operation.
*/ */
struct TALER_EXCHANGE_TrackTransferHandle *tth; struct TALER_EXCHANGE_TrackTransferHandle *tth;
/** /**
* Handle to the exchange. * Connection handle to the exchange.
*/ */
struct TALER_EXCHANGE_Handle *exchange; struct TALER_EXCHANGE_Handle *exchange;
@ -132,24 +145,25 @@ struct TrackTransferState
/** /**
* Function called with detailed wire transfer data. * 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 cls closure.
* @param http_status HTTP status code we got, 0 on exchange * @param http_status HTTP status code we got.
* protocol violation * @param ec taler-specific error code.
* @param ec taler-specific error code, #TALER_EC_NONE on success
* @param exchange_pub public key the exchange used for signing
* @param json original json reply (may include signatures, those * @param json original json reply (may include signatures, those
* have then been validated already) * have then been validated already).
* @param wtid wire transfer identifier used by the exchange, NULL * @param wtid wire transfer identifier, NULL if exchange did not
* if exchange did not yet execute the transaction * execute the transaction yet.
* @param execution_time actual or planned execution time for the * @param execution_time actual or planned execution time for the
* wire transfer * wire transfer.
* @param coin_contribution contribution to the @a total_amount of * @param coin_contribution contribution to the @a total_amount of
* the deposited coin (may be NULL) * the deposited coin (can be NULL).
* @param total_amount total amount of the wire transfer, or NULL * @param total_amount total amount of the wire transfer, or NULL
* if the exchange could not provide any @a wtid (set only * if the exchange could not provide any @a wtid (set only
* if @a http_status is #MHD_HTTP_OK) * if @a http_status is #MHD_HTTP_OK).
*/ */
static void static void
deposit_wtid_cb deposit_wtid_cb
@ -186,8 +200,10 @@ deposit_wtid_cb
const struct TALER_TESTING_Command *bank_transfer_cmd; const struct TALER_TESTING_Command *bank_transfer_cmd;
char *ws; char *ws;
/* _this_ wire transfer subject line. */
ws = GNUNET_STRINGS_data_to_string_alloc (wtid, ws = GNUNET_STRINGS_data_to_string_alloc (wtid,
sizeof (*wtid)); sizeof (*wtid));
bank_transfer_cmd = TALER_TESTING_interpreter_lookup_command bank_transfer_cmd = TALER_TESTING_interpreter_lookup_command
(is, tts->bank_transfer_reference); (is, tts->bank_transfer_reference);
@ -198,6 +214,7 @@ deposit_wtid_cb
return; return;
} }
/* expected wire transfer subject line. */
const char *transfer_subject; const char *transfer_subject;
if (GNUNET_OK != TALER_TESTING_get_trait_transfer_subject if (GNUNET_OK != TALER_TESTING_get_trait_transfer_subject
@ -208,6 +225,7 @@ deposit_wtid_cb
return; return;
} }
/* Compare that expected and gotten subjects match. */
if (0 != strcmp (ws, transfer_subject)) if (0 != strcmp (ws, transfer_subject))
{ {
GNUNET_break (0); GNUNET_break (0);
@ -235,8 +253,8 @@ deposit_wtid_cb
/** /**
* Run the command. * Run the command.
* *
* @param cls closure, typically a #struct WireState. * @param cls closure.
* @param cmd the command to execute, a /track/transaction one. * @param cmd the command to execute.
* @param is the interpreter state. * @param is the interpreter state.
*/ */
void void
@ -335,9 +353,10 @@ track_transaction_run (void *cls,
} }
/** /**
* Cleanup the state. * Cleanup the state from a "track transaction" CMD, and possibly
* cancel a operation thereof.
* *
* @param cls closure, typically a #struct WireState. * @param cls closure.
* @param cmd the command which is being cleaned up. * @param cmd the command which is being cleaned up.
*/ */
void void
@ -361,16 +380,16 @@ track_transaction_cleanup
/** /**
* Extract information from a command that is useful for other * Offer internal data from a "track transaction" CMD.
* commands.
* *
* @param cls closure * @param cls closure.
* @param ret[out] result (could be anything) * @param ret[out] result (could be anything).
* @param trait name of the trait * @param trait name of the trait.
* @param selector more detailed information about which object * @param selector more detailed information about which object
* to return in case there were multiple generated * to return in case there were multiple generated
* by the command * by the command.
* @return #GNUNET_OK on success *
* @return #GNUNET_OK on success.
*/ */
static int static int
track_transaction_traits (void *cls, track_transaction_traits (void *cls,
@ -392,18 +411,19 @@ track_transaction_traits (void *cls,
} }
/** /**
* Create a /track/transaction command. * Create a "track transaction" command.
* *
* @param label the command label. * @param label the command label.
* @param exchange the exchange to connect to. * @param exchange the exchange to connect to.
* @param transaction_reference reference to a deposit operation. * @param transaction_reference reference to a deposit operation,
* @param coin_index index of the coin involved in the transaction * 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 expected_response_code expected HTTP response code.
* @param bank_transfer_reference which #OC_CHECK_BANK_TRANSFER * @param bank_transfer_reference reference to a command that
* wtid should this match? NULL * can offer a WTID so as to check that against what WTID
* for none * the tracked operation has. Set as NULL if not needed.
* *
* @return the command to be executed by the interpreter. * @return the command.
*/ */
struct TALER_TESTING_Command struct TALER_TESTING_Command
TALER_TESTING_cmd_track_transaction TALER_TESTING_cmd_track_transaction
@ -431,11 +451,11 @@ TALER_TESTING_cmd_track_transaction
cmd.traits = &track_transaction_traits; cmd.traits = &track_transaction_traits;
return cmd; return cmd;
} }
/** /**
* Cleanup the state. * Cleanup the state for a "track transfer" CMD, and possibly
* cancel a pending operation thereof.
* *
* @param cls closure. * @param cls closure.
* @param cmd the command which is being cleaned up. * @param cmd the command which is being cleaned up.
@ -461,28 +481,28 @@ track_transfer_cleanup (void *cls,
} }
/** /**
* Function called with detailed wire transfer data, including all * Check whether the HTTP response code from a "track transfer"
* of the coin transactions that were combined into the wire * operation is acceptable, and all other values like total amount,
* transfer. * wire fees and hashed wire details as well.
* *
* @param cls closure * @param cls closure.
* @param http_status HTTP status code we got, 0 on exchange * @param http_status HTTP status code we got.
* protocol violation * @param ec taler-specific error code.
* @param ec taler-specific error code, #TALER_EC_NONE on success
* @param exchange_pub public key the exchange used for signing * @param exchange_pub public key the exchange used for signing
* the response.
* @param json original json reply (may include signatures, those * @param json original json reply (may include signatures, those
* have then been validated already) * have then been validated already).
* @param h_wire hash of the wire transfer address the transfer * @param h_wire hash of the wire transfer address the transfer
* went to, or NULL on error * went to, or NULL on error.
* @param execution_time time when the exchange claims to have * @param execution_time time when the exchange claims to have
* performed the wire transfer * performed the wire transfer.
* @param total_amount total amount of the wire transfer, or NULL * @param total_amount total amount of the wire transfer, or NULL
* if the exchange could not provide any @a wtid (set only * if the exchange could not provide any @a wtid (set only
* if @a http_status is #MHD_HTTP_OK) * if @a http_status is "200 OK").
* @param wire_fee wire fee that was charged by the exchange * @param wire_fee wire fee that was charged by the exchange.
* @param details_length length of the @a details array * @param details_length length of the @a details array.
* @param details array with details about the combined * @param details array with details about the combined
* transactions * transactions.
*/ */
static void static void
track_transfer_cb track_transfer_cb
@ -524,7 +544,6 @@ track_transfer_cb
"Expected amount and fee not specified, " "Expected amount and fee not specified, "
"likely to segfault...\n"); "likely to segfault...\n");
switch (http_status) switch (http_status)
{ {
case MHD_HTTP_OK: case MHD_HTTP_OK:
@ -571,6 +590,7 @@ track_transfer_cb
return; return;
} }
/* FIXME: this block does nothing. Remove? */
wtid_cmd = TALER_TESTING_interpreter_lookup_command wtid_cmd = TALER_TESTING_interpreter_lookup_command
(is, tts->wtid_reference); (is, tts->wtid_reference);
@ -612,8 +632,9 @@ track_transfer_cb
return; return;
} }
GNUNET_assert (GNUNET_OK == GNUNET_assert
TALER_JSON_wire_signature_hash (wire_details, (GNUNET_OK == TALER_JSON_wire_signature_hash
(wire_details,
&h_wire_details)); &h_wire_details));
if (0 != memcmp (&h_wire_details, if (0 != memcmp (&h_wire_details,
@ -674,7 +695,7 @@ track_transfer_cb
* Run the command. * Run the command.
* *
* @param cls closure. * @param cls closure.
* @param cmd the command to execute, a /track/transfer one. * @param cmd the command under execution.
* @param is the interpreter state. * @param is the interpreter state.
*/ */
void void
@ -683,7 +704,6 @@ track_transfer_run (void *cls,
struct TALER_TESTING_Interpreter *is) struct TALER_TESTING_Interpreter *is)
{ {
/* looking for a wtid to track .. */ /* looking for a wtid to track .. */
struct TrackTransferState *tts = cls; struct TrackTransferState *tts = cls;
struct TALER_WireTransferIdentifierRawP wtid; struct TALER_WireTransferIdentifierRawP wtid;
struct TALER_WireTransferIdentifierRawP *wtid_ptr; struct TALER_WireTransferIdentifierRawP *wtid_ptr;
@ -721,23 +741,26 @@ track_transfer_run (void *cls,
wtid_ptr, wtid_ptr,
&track_transfer_cb, &track_transfer_cb,
tts); tts);
GNUNET_assert (NULL != tts->tth); GNUNET_assert (NULL != tts->tth);
} }
/** /**
* Make a /track/transfer command, expecting the transfer * Make a "track transfer" CMD where no "expected"-arguments,
* not being done (yet). * 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 label the command label
* @param exchange connection to the exchange * @param exchange connection to the exchange.
* @param wtid_reference reference to any command which can provide * @param wtid_reference reference to any command which can provide
* a wtid * a wtid. If NULL is given, then a all zeroed WTID is
* @param index in case there are multiple wtid offered, this * used that will at 99.9999% probability NOT match any
* parameter selects a particular one * existing WTID known to the exchange.
* @param expected_response_code expected HTTP response code * @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 * @return the command.
*/ */
struct TALER_TESTING_Command struct TALER_TESTING_Command
TALER_TESTING_cmd_track_transfer_empty TALER_TESTING_cmd_track_transfer_empty
@ -766,18 +789,18 @@ TALER_TESTING_cmd_track_transfer_empty
} }
/** /**
* Make a /track/transfer command, specifying which amount and * Make a "track transfer" command, specifying which amount and
* wire fee are expected. * wire fee are expected.
* *
* @param label the command label * @param label the command label.
* @param exchange connection to the exchange * @param exchange connection to the exchange.
* @param wtid_reference reference to any command which can provide * @param wtid_reference reference to any command which can provide
* a wtid * a wtid. Will be the one tracked.
* @param index in case there are multiple wtid offered, this * @param index in case there are multiple WTID offered, this
* parameter selects a particular one * parameter selects a particular one.
* @param expected_response_code expected HTTP response code * @param expected_response_code expected HTTP response code.
* @param expected_amount how much money we expect being * @param expected_amount how much money we expect being moved
* moved with this wire-transfer. * with this wire-transfer.
* @param expected_wire_fee expected wire fee. * @param expected_wire_fee expected wire fee.
* *
* @return the command * @return the command
@ -811,3 +834,5 @@ TALER_TESTING_cmd_track_transfer
return cmd; return cmd;
} }
/* end of testing_api_cmd_track.c */