summaryrefslogtreecommitdiff
path: root/src/include/taler_testing_bank_lib.h
diff options
context:
space:
mode:
authorMarcello Stanisci <stanisci.m@gmail.com>2018-05-29 10:34:41 +0200
committerMarcello Stanisci <stanisci.m@gmail.com>2018-05-29 10:34:41 +0200
commit11b3616355e4a0fb4a5dff1f5aee4de5e1884ca5 (patch)
tree6e8d3827dc7241e9b8255d903005929b8a02f01e /src/include/taler_testing_bank_lib.h
parent5faa541d270fa6664a6b61b67c36dce48b368356 (diff)
downloadexchange-11b3616355e4a0fb4a5dff1f5aee4de5e1884ca5.tar.gz
exchange-11b3616355e4a0fb4a5dff1f5aee4de5e1884ca5.tar.bz2
exchange-11b3616355e4a0fb4a5dff1f5aee4de5e1884ca5.zip
Commenting the bank-lib "testing" header file.
Diffstat (limited to 'src/include/taler_testing_bank_lib.h')
-rw-r--r--src/include/taler_testing_bank_lib.h41
1 files changed, 29 insertions, 12 deletions
diff --git a/src/include/taler_testing_bank_lib.h b/src/include/taler_testing_bank_lib.h
index 1461d7ac..5bdf004e 100644
--- a/src/include/taler_testing_bank_lib.h
+++ b/src/include/taler_testing_bank_lib.h
@@ -19,7 +19,7 @@
/**
* @file include/taler_testing_bank_lib.h
- * @brief API for writing an interpreter to test Taler components
+ * @brief API for writing test cases to test banks.
* @author Marcello Stanisci
*/
#ifndef TALER_TESTING_BANK_LIB_H
@@ -57,6 +57,8 @@
* bank" function to do such tasks.
*
* @param config_filename configuration filename.
+ * @param bank_url base URL of the bank, used by `wget' to check
+ * that the bank was started right.
*
* @return the process, or NULL if the process could not
* be started.
@@ -67,9 +69,9 @@ TALER_TESTING_run_bank (const char *config_filename,
/**
* Prepare the bank execution. Check if the port is available
- * (and reset database?).
+ * and reset database.
*
- * @param config_filename configuration filename.
+ * @param config_filename configuration file name.
*
* @return the base url, or NULL upon errors. Must be freed
* by the caller.
@@ -78,12 +80,23 @@ char *
TALER_TESTING_prepare_bank (const char *config_filename);
-/* ******************* Generic interpreter logic ************ */
-
/* ************** Specific interpreter commands ************ */
/**
- * Test /history API from the bank.
+ * Make a "history" CMD.
+ *
+ * @param label command label.
+ * @param bank_url base URL of the bank offering the "history"
+ * operation.
+ * @param account_no bank account number to ask the history for.
+ * @param direction which direction this operation is interested
+ * in.
+ * @param start_row_reference reference to a command that can
+ * offer a row identifier, to be used as the starting row
+ * to accept in the result.
+ * @param num_result how many rows we want in the result.
+ *
+ * @return the command.
*/
struct TALER_TESTING_Command
TALER_TESTING_cmd_bank_history
@@ -95,15 +108,19 @@ TALER_TESTING_cmd_bank_history
unsigned int num_results);
/**
- * FIXME.
+ * Create a "reject" CMD.
+ *
+ * @param label command label.
+ * @param bank_url base URL of the bank implementing the
+ * "reject" operation.
+ * @param deposit_reference reference to a command that will
+ * provide a "row id" and credit (bank) account to craft
+ * the "reject" request.
+ *
+ * @return the command.
*/
struct TALER_TESTING_Command
TALER_TESTING_cmd_bank_reject (const char *label,
const char *bank_url,
const char *deposit_reference);
-
-/* *** Generic trait logic for implementing traits ********* */
-
-/* ****** Specific traits supported by this component ******* */
-
#endif