gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] [taler-twister] branch master updated (4392fab -> 70d25f1)


From: gnunet
Subject: [GNUnet-SVN] [taler-twister] branch master updated (4392fab -> 70d25f1)
Date: Tue, 29 May 2018 17:32:23 +0200

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

marcello pushed a change to branch master
in repository twister.

    from 4392fab  Commenting the CLI utility
     new 1221d7d  Commenting the "API helpers"
     new 3f3f5d8  Commenting the "testing API"
     new ca9ecfd  Commenting the "twister API" header file
     new 70d25f1  Commenting the "testing API" header file

The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 src/include/taler_twister_service.h       |  82 ++++++-----
 src/include/taler_twister_testing_lib.h   |  67 ++++++---
 src/twister/testing_api_cmd_exec_client.c | 233 ++++++++++++++++++++----------
 src/twister/testing_api_helpers.c         |   5 +-
 src/twister/twister_api.c                 |  39 +++--
 5 files changed, 270 insertions(+), 156 deletions(-)

diff --git a/src/include/taler_twister_service.h 
b/src/include/taler_twister_service.h
index 2672865..a2b963c 100644
--- a/src/include/taler_twister_service.h
+++ b/src/include/taler_twister_service.h
@@ -1,22 +1,21 @@
 /*
-      This file is part of Taler
-      Copyright (C) 2018 Taler Systems SA
+  This file is part of Taler
+  Copyright (C) 2018 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 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.
+  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,
-      write to the Free Software Foundation, Inc., 51 Franklin
-      Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
+  You should have received a copy of the GNU General Public
+  License along with Taler; see the file COPYING.  If not,
+  write to the Free Software Foundation, Inc., 51 Franklin
+  Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
 
 #ifndef TALER_TWISTER_SERVICE_H_
 #define TALER_TWISTER_SERVICE_H_
@@ -80,9 +79,8 @@ struct TALER_TWISTER_Operation;
  * @a modify_value.
  *
  * @param h twister instance to control
- * @param modify_path object-like notation path to the object to
- *        modify
- * @param modify_value value to use for @a modify_path
+ * @param path object-like notation path to the object to modify
+ * @param value value to use for @a modify_path
  * @param cb callback to call once twister gets this instruction.
  * @param cb_cls closure for @a cb_callback
  *
@@ -95,6 +93,19 @@ TALER_TWISTER_modify_path_dl (struct TALER_TWISTER_Handle *h,
                               GNUNET_SCHEDULER_TaskCallback cb,
                               void *cb_cls);
 
+
+/**
+ * Change the JSON field pointed by @a path to the new @a value.
+ * It only applies to upload objects.
+ *
+ * @param h twister instance to control
+ * @param path object-like notation path to the object to modify
+ * @param value value to use for @a modify_path
+ * @param cb callback to call once twister gets this instruction.
+ * @param cb_cls closure for @a cb_callback
+ *
+ * @return operation handle.
+ */
 struct TALER_TWISTER_Operation *
 TALER_TWISTER_modify_path_ul (struct TALER_TWISTER_Handle *h,
                               const char *path,
@@ -102,13 +113,15 @@ TALER_TWISTER_modify_path_ul (struct TALER_TWISTER_Handle 
*h,
                               GNUNET_SCHEDULER_TaskCallback cb,
                               void *cb_cls);
 /**
- * Randomly flip a character into the JSON string
- * object pointed to by @a path.
+ * Instruct the twister to flip a character into
+ * the string JSON field that belongs to the object
+ * being returned to the HTTP client.
  *
  * @param h twister instance to control
  * @param path object-like notation to point the string
  *        object where we seek a character to flip.
- * @param cb function to call once twister is ready
+ * @param cb function to call once twister has processed this
+ *        request
  * @param cb_cls closure for @a cb
  * @return operation handle (to possibly abort)
  */
@@ -120,13 +133,15 @@ TALER_TWISTER_flip_download
    void *cb_cls);
 
 /**
- * Randomly flip a character into the JSON string
- * object pointed to by @a path.
+ * Instruct the twister to flip a character into
+ * the string JSON field that belongs to the object
+ * being uploaded to the proxied service.
  *
  * @param h twister instance to control
  * @param path object-like notation to point the string
  *        object where we seek a character to flip.
- * @param cb function to call once twister is ready
+ * @param cb function to call once twister has batched this
+ *        request
  * @param cb_cls closure for @a cb
  * @return operation handle (to possibly abort)
  */
@@ -157,7 +172,8 @@ TALER_TWISTER_change_response_code
  * Randomly truncate the response.
  *
  * @param h twister instance to control
- * @param cb function to call once twister is ready
+ * @param cb function to call once twister has processed this
+ *           request.
  * @param cb_cls closure for @a cb
  * @return operation handle (to possibly abort)
  */
@@ -171,7 +187,8 @@ TALER_TWISTER_malform
  * Randomly truncate the request.
  *
  * @param h twister instance to control
- * @param cb function to call once twister is ready
+ * @param cb function to call once twister is ready; tipically
+ *        a acknowledge function.
  * @param cb_cls closure for @a cb
  * @return operation handle (to possibly abort)
  */
@@ -182,7 +199,8 @@ TALER_TWISTER_malform_upload
    void *cb_cls);
 
 /**
- * Delete the object pointed to by @a path.
+ * Delete the object pointed to by @a path.  Note, this
+ * object belongs to the JSON response object.
  *
  * @param h twister instance to control
  * @param path object-like notation to point the object to be
@@ -204,8 +222,8 @@ TALER_TWISTER_delete_path
  * changes requested by the operation, or not!  Must be called
  * before the operations callback was invoked.
  *
- * @param op operation to cancel, operation's callback will not
- *        be called
+ * @param op operation to cancel,
+ *        operation's callback will not be called
  */
 void
 TALER_TWISTER_cancel (struct TALER_TWISTER_Operation *op);
@@ -221,11 +239,10 @@ TALER_TWISTER_cancel (struct TALER_TWISTER_Operation *op);
 /** @} */ /* end of group nse */
 
 /**
- * Prepare execution of twister service:
- * mainly check if port is available
+ * Prepare twister for execution; mainly checks whether the
+ * HTTP port is available and construct the base URL based on it.
  *
  * @param config_filename configuration file name.
- *
  * @return twister base URL, NULL upon errors.
  */
 char *
@@ -235,7 +252,6 @@ TALER_TESTING_prepare_twister (const char *config_filename);
  * Run the twister service.
  *
  * @param config_filename configuration file name.
- *
  * @return twister process handle, NULL upon errors.
  */
 struct GNUNET_OS_Process *
diff --git a/src/include/taler_twister_testing_lib.h 
b/src/include/taler_twister_testing_lib.h
index 6605eac..f35efe1 100644
--- a/src/include/taler_twister_testing_lib.h
+++ b/src/include/taler_twister_testing_lib.h
@@ -32,46 +32,43 @@
   do {GNUNET_break (0); return NULL; } while (0)
 
 /**
- * Command that replaces the HTTP response code for
- * the next connection that will be made to the twister.
+ * Define a "hack response code" CMD.  This causes the next
+ * response code (from the service proxied by the twister) to
+ * be substituted with @a http_status.
  *
  * @param label command label
- * @param http_status new response code to use
  * @param config_filename configuration filename.
- *
+ * @param http_status new response code to use
  * @return the command
  */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_hack_response_code (const char *label,
                                       const char *config_filename,
                                       unsigned int http_status);
-
-
 /**
- * This command deletes the JSON object contained in the
- * response and pointed by @a path.
+ * Create a "delete object" CMD.  This command deletes
+ * the JSON object pointed by @a path.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
- *        to be made empty.  "f1.0.f2" will empty the object
- *        {"f1": [{"f2": "I'll be deleted"}]}.
- *
+ *        to delete.
  * @return the command
  */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_delete_object (const char *label,
                                  const char *config_filename,
                                  const char *path);
-
-
 /**
- * This command deletes the JSON object pointed by @a path.
+ * Create a "modify object" CMD.  This command instructs
+ * the twister to modify the next object that is downloaded
+ * from the proxied service.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
- *        to delete.
+ *        to modify.
+ * @param value value to put as the object's.
  *
  * @return the command
  */
@@ -80,14 +77,29 @@ TALER_TESTING_cmd_modify_object_dl (const char *label,
                                     const char *config_filename,
                                     const char *path,
                                     const char *value);
+
+/**
+ * Create a "modify object" CMD.  This command instructs
+ * the twister to modify the next object that will be uploaded
+ * to the proxied service.
+ *
+ * @param label command label
+ * @param config_filename configuration filename.
+ * @param path object-like path notation pointing the object
+ *        to modify.
+ * @param value value to put as the object's.
+ * @return the command
+ */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_modify_object_ul (const char *label,
                                     const char *config_filename,
                                     const char *path,
                                     const char *value);
+
+
 /**
- * This command makes the next response randomly malformed
- * (by truncating it).
+ * Create a "malform response" CMD.  This command makes
+ * the next response randomly malformed (by truncating it).
  *
  * @param label command label
  * @param config_filename configuration filename.
@@ -99,26 +111,23 @@ TALER_TESTING_cmd_malform_response (const char *label,
                                     const char *config_filename);
 
 /**
- * This command makes the next request randomly malformed
- * (by truncating it).
+ * Create a "malform request" CMD.  This command makes the
+ * next request randomly malformed (by truncating it).
  *
  * @param label command label
  * @param config_filename configuration filename.
- *
  * @return the command
  */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_malform_request (const char *label,
                                    const char *config_filename);
-
 /**
- * This command deletes the JSON object pointed by @a path.
+ * Define a "flip object" command, for objects to upload.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
- *        to delete.
- *
+ *        to flip.
  * @return the command
  */
 struct TALER_TESTING_Command
@@ -126,6 +135,16 @@ TALER_TESTING_cmd_flip_upload (const char *label,
                                const char *config_filename,
                                const char *path);
 
+
+/**
+ * Define a "flip object" command, for objects to download.
+ *
+ * @param label command label
+ * @param config_filename configuration filename.
+ * @param path object-like path notation to point the object
+ *        to flip.
+ * @return the command
+ */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_flip_download (const char *label,
                                  const char *config_filename,
diff --git a/src/twister/testing_api_cmd_exec_client.c 
b/src/twister/testing_api_cmd_exec_client.c
index 60973b2..b62b501 100644
--- a/src/twister/testing_api_cmd_exec_client.c
+++ b/src/twister/testing_api_cmd_exec_client.c
@@ -29,6 +29,10 @@
 #include <taler/taler_testing_lib.h>
 #include "taler_twister_testing_lib.h"
 
+
+/**
+ * State for a "modify object" CMD.
+ */
 struct ModifyObjectState
 {
   /**
@@ -41,16 +45,22 @@ struct ModifyObjectState
    */
   const char *path;
 
+
+  /**
+   * Value to substitute to the original one.
+   */
   const char *value;
 
   /**
    * Config file name to pass to the CLI client.
    */
   const char *config_filename;
-
 };
 
 
+/**
+ * State for a "flip object" CMD.
+ */
 struct FlipObjectState
 {
   /**
@@ -59,7 +69,7 @@ struct FlipObjectState
   struct GNUNET_OS_Process *proc;
 
   /**
-   * Object-like notation to the object to delete.
+   * Object-like notation to the string-object to flip.
    */
   const char *path;
 
@@ -69,6 +79,10 @@ struct FlipObjectState
   const char *config_filename;
 };
 
+
+/**
+ * State for a "delete object" CMD.
+ */
 struct DeleteObjectState
 {
   /**
@@ -87,6 +101,10 @@ struct DeleteObjectState
   const char *config_filename;
 };
 
+
+/**
+ * State for a "malform request" CMD.
+ */
 struct MalformRequestState
 {
   /**
@@ -100,6 +118,10 @@ struct MalformRequestState
   const char *config_filename;
 };
 
+
+/**
+ * State for a "malform response" CMD.
+ */
 struct MalformResponseState
 {
   /**
@@ -113,6 +135,10 @@ struct MalformResponseState
   const char *config_filename;
 };
 
+
+/**
+ * State for a "hack response code" CMD.
+ */
 struct HackResponseCodeState
 {
   /**
@@ -121,8 +147,7 @@ struct HackResponseCodeState
   struct GNUNET_OS_Process *proc;
 
   /**
-   * HTTP status code the twister will return upon its next
-   * connection.
+   * HTTP status code to substitute to the original one.
    */
   unsigned int http_status;
 
@@ -134,10 +159,11 @@ struct HackResponseCodeState
 
 
 /**
- * Clean up after the command.  Run during forced termination
- * (CTRL-C) or test failure or test success.
+ * Free the state from a "hack response code" CMD, and
+ * possibly kill its process if it did not terminate yet.
  *
- * @param cls closure
+ * @param cls closure.
+ * @param cmd the command being cleaned up.
  */
 static void
 hack_response_code_cleanup
@@ -158,15 +184,13 @@ hack_response_code_cleanup
 }
 
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer data internal to a "hack response code" CMD,
+ * to other commands.
  *
  * @param cls closure
  * @param ret[out] result (could be anything)
  * @param trait name of the trait
- * @param selector more detailed information about which object
- *                 to return in case there were multiple generated
- *                 by the command
+ * @param index index number of the object to offer.
  * @return #GNUNET_OK on success
  */
 static int
@@ -188,6 +212,14 @@ hack_response_code_traits (void *cls,
                                   index);
 }
 
+
+/**
+ * Run a "hack response code" CMD.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
+ */
 static void
 hack_response_code_run (void *cls,
                         const struct TALER_TESTING_Command *cmd,
@@ -220,13 +252,13 @@ hack_response_code_run (void *cls,
 
 
 /**
- * Command that replaces the HTTP response code for
- * the next connection that will be made to the twister.
+ * Define a "hack response code" CMD.  This causes the next
+ * response code (from the service proxied by the twister) to
+ * be substituted with @a http_status.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param http_status new response code to use
- *
  * @return the command
  */
 struct TALER_TESTING_Command
@@ -251,10 +283,11 @@ TALER_TESTING_cmd_hack_response_code (const char *label,
 }
 
 /**
- * Clean up after the command.  Run during forced termination
- * (CTRL-C) or test failure or test success.
+ * Free the state from a "delete object" CMD, and
+ * possibly kill its process if it did not terminate yet.
  *
- * @param cls closure
+ * @param cls closure.
+ * @param cmd the command being cleaned up.
  */
 static void
 delete_object_cleanup
@@ -275,15 +308,13 @@ delete_object_cleanup
 }
 
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer data internal to a "delete object" CMD,
+ * to other commands.
  *
  * @param cls closure
  * @param ret[out] result (could be anything)
  * @param trait name of the trait
- * @param selector more detailed information about which object
- *                 to return in case there were multiple generated
- *                 by the command
+ * @param index index number of the object to offer.
  * @return #GNUNET_OK on success
  */
 static int
@@ -306,7 +337,11 @@ delete_object_traits (void *cls,
 }
 
 /**
- * FIXME: document.
+ * Run a "delete object" CMD.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
  */
 static void
 delete_object_run (void *cls,
@@ -333,7 +368,11 @@ delete_object_run (void *cls,
 }
 
 /**
- * TODO.
+ * Free the state from a "modify object" CMD, and
+ * possibly kill its process if it did not terminate yet.
+ *
+ * @param cls closure.
+ * @param cmd the command being cleaned up.
  */
 static void
 modify_object_cleanup
@@ -353,17 +392,14 @@ modify_object_cleanup
   GNUNET_free (mos);
 }
 
-
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer data internal to a "modify object" CMD,
+ * to other commands.
  *
  * @param cls closure
  * @param ret[out] result (could be anything)
  * @param trait name of the trait
- * @param selector more detailed information about which object
- *                 to return in case there were multiple generated
- *                 by the command
+ * @param index index number of the object to offer.
  * @return #GNUNET_OK on success
  */
 static int
@@ -385,9 +421,12 @@ modify_object_traits (void *cls,
                                   index);
 }
 
-
 /**
- * FIXME: document.
+ * Run a "modify object" CMD.  The "download fashion" of it.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
  */
 static void
 modify_object_dl_run (void *cls,
@@ -414,6 +453,14 @@ modify_object_dl_run (void *cls,
   TALER_TESTING_wait_for_sigchld (is);
 }
 
+
+/**
+ * Run a "modify object" CMD, the "upload fashion" of it.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
+ */
 static void
 modify_object_ul_run (void *cls,
                       const struct TALER_TESTING_Command *cmd,
@@ -440,13 +487,13 @@ modify_object_ul_run (void *cls,
 }
 
 /**
- * This command deletes the JSON object pointed by @a path.
+ * Create a "delete object" CMD.  This command deletes
+ * the JSON object pointed by @a path.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
  *        to delete.
- *
  * @return the command
  */
 struct TALER_TESTING_Command
@@ -471,13 +518,12 @@ TALER_TESTING_cmd_delete_object (const char *label,
 }
 
 
-//////
-
 /**
- * Clean up after the command.  Run during forced termination
- * (CTRL-C) or test failure or test success.
+ * Free the state from a "flip object" CMD, and
+ * possibly kill its process if it did not terminate yet.
  *
- * @param cls closure
+ * @param cls closure.
+ * @param cmd the command being cleaned up.
  */
 static void
 flip_object_cleanup
@@ -498,15 +544,13 @@ flip_object_cleanup
 }
 
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer data internal to a "flip object" CMD,
+ * to other commands.
  *
  * @param cls closure
  * @param ret[out] result (could be anything)
  * @param trait name of the trait
- * @param selector more detailed information about which object
- *                 to return in case there were multiple generated
- *                 by the command
+ * @param index index number of the object to offer.
  * @return #GNUNET_OK on success
  */
 static int
@@ -529,7 +573,11 @@ flip_object_traits (void *cls,
 }
 
 /**
- * FIXME: document.
+ * Run a "flip object" CMD, the upload fashion of it.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
  */
 static void
 flip_upload_run (void *cls,
@@ -556,9 +604,12 @@ flip_upload_run (void *cls,
 }
 
 
-
 /**
- * FIXME: document.
+ * Run a "flip object" CMD, the download fashion of it.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
  */
 static void
 flip_download_run (void *cls,
@@ -584,14 +635,14 @@ flip_download_run (void *cls,
   TALER_TESTING_wait_for_sigchld (is);
 }
 
+
 /**
- * This command deletes the JSON object pointed by @a path.
+ * Define a "flip object" command, for objects to upload.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
- *        to delete.
- *
+ *        to flip.
  * @return the command
  */
 struct TALER_TESTING_Command
@@ -617,13 +668,12 @@ TALER_TESTING_cmd_flip_upload (const char *label,
 
 
 /**
- * This command deletes the JSON object pointed by @a path.
+ * Define a "flip object" command, for objects to download.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
- *        to delete.
- *
+ *        to flip.
  * @return the command
  */
 struct TALER_TESTING_Command
@@ -649,8 +699,13 @@ TALER_TESTING_cmd_flip_download (const char *label,
 
 
 /**
- * TODO.
+ * Free the state from a "malform request" CMD, and
+ * possibly kill its process if it did not terminate yet.
+ *
+ * @param cls closure.
+ * @param cmd the command being cleaned up.
  */
+
 static void
 malform_request_cleanup
   (void *cls,
@@ -671,15 +726,13 @@ malform_request_cleanup
 
 
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer data internal to a "malform request" CMD,
+ * to other commands.
  *
  * @param cls closure
  * @param ret[out] result (could be anything)
  * @param trait name of the trait
- * @param selector more detailed information about which object
- *                 to return in case there were multiple generated
- *                 by the command
+ * @param index index number of the object to offer.
  * @return #GNUNET_OK on success
  */
 static int
@@ -701,9 +754,12 @@ malform_request_traits (void *cls,
                                   index);
 }
 
-
 /**
- * FIXME: document.
+ * Run a "malform request" CMD.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
  */
 static void
 malform_request_run (void *cls,
@@ -729,9 +785,12 @@ malform_request_run (void *cls,
   TALER_TESTING_wait_for_sigchld (is);
 }
 
-
 /**
- * TODO.
+ * Free the state from a "malform response" CMD, and
+ * possibly kill its process if it did not terminate yet.
+ *
+ * @param cls closure.
+ * @param cmd the command being cleaned up.
  */
 static void
 malform_response_cleanup
@@ -752,16 +811,15 @@ malform_response_cleanup
 }
 
 
+
 /**
- * Extract information from a command that is useful for other
- * commands.
+ * Offer data internal to a "malform response" CMD,
+ * to other commands.
  *
  * @param cls closure
  * @param ret[out] result (could be anything)
  * @param trait name of the trait
- * @param selector more detailed information about which object
- *                 to return in case there were multiple generated
- *                 by the command
+ * @param index index number of the object to offer.
  * @return #GNUNET_OK on success
  */
 static int
@@ -785,7 +843,11 @@ malform_response_traits (void *cls,
 
 
 /**
- * FIXME: document.
+ * Run a "malform response" CMD.
+ *
+ * @param cls closure.
+ * @param cmd the command being run.
+ * @param is the interpreter state.
  */
 static void
 malform_response_run (void *cls,
@@ -812,12 +874,11 @@ malform_response_run (void *cls,
 }
 
 /**
- * This command makes the next request randomly malformed
- * (by truncating it).
+ * Create a "malform request" CMD.  This command makes the
+ * next request randomly malformed (by truncating it).
  *
  * @param label command label
  * @param config_filename configuration filename.
- *
  * @return the command
  */
 struct TALER_TESTING_Command
@@ -840,8 +901,8 @@ TALER_TESTING_cmd_malform_request (const char *label,
 }
 
 /**
- * This command makes the next response randomly malformed
- * (by truncating it).
+ * Create a "malform response" CMD.  This command makes
+ * the next response randomly malformed (by truncating it).
  *
  * @param label command label
  * @param config_filename configuration filename.
@@ -869,12 +930,15 @@ TALER_TESTING_cmd_malform_response (const char *label,
 }
 
 /**
- * This command deletes the JSON object pointed by @a path.
+ * Create a "modify object" CMD.  This command instructs
+ * the twister to modify the next object that is downloaded
+ * from the proxied service.
  *
  * @param label command label
  * @param config_filename configuration filename.
  * @param path object-like path notation to point the object
- *        to delete.
+ *        to modify.
+ * @param value value to put as the object's.
  *
  * @return the command
  */
@@ -901,6 +965,19 @@ TALER_TESTING_cmd_modify_object_dl (const char *label,
   return cmd;
 }
 
+
+/**
+ * Create a "modify object" CMD.  This command instructs
+ * the twister to modify the next object that will be uploaded
+ * to the proxied service.
+ *
+ * @param label command label
+ * @param config_filename configuration filename.
+ * @param path object-like path notation pointing the object
+ *        to modify.
+ * @param value value to put as the object's.
+ * @return the command
+ */
 struct TALER_TESTING_Command
 TALER_TESTING_cmd_modify_object_ul (const char *label,
                                     const char *config_filename,
@@ -924,3 +1001,5 @@ TALER_TESTING_cmd_modify_object_ul (const char *label,
   return cmd;
 }
 
+
+/* end of testing_api_cmd_exec_client.c */
diff --git a/src/twister/testing_api_helpers.c 
b/src/twister/testing_api_helpers.c
index aa5976f..48a56c9 100644
--- a/src/twister/testing_api_helpers.c
+++ b/src/twister/testing_api_helpers.c
@@ -29,8 +29,10 @@
 #include "taler_twister_testing_lib.h"
 
 /**
- * @param config_filename configuration filename.
+ * Prepare twister for execution; mainly checks whether the
+ * HTTP port is available and construct the base URL based on it.
  *
+ * @param config_filename configuration file name.
  * @return twister base URL, NULL upon errors.
  */
 char *
@@ -80,7 +82,6 @@ TALER_TESTING_prepare_twister (const char *config_filename)
  * Run the twister service.
  *
  * @param config_filename configuration file name.
- *
  * @return twister process handle, NULL upon errors.
  */
 struct GNUNET_OS_Process *
diff --git a/src/twister/twister_api.c b/src/twister/twister_api.c
index b5e332e..182ee7f 100644
--- a/src/twister/twister_api.c
+++ b/src/twister/twister_api.c
@@ -1,23 +1,22 @@
 /*
-     This file is part of Taler.
-     Copyright (C) 2009, 2010, 2011, 2016 GNUnet e.V.
-     Copyright (C) 2018 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,
-     write to the Free Software Foundation, Inc., 51 Franklin
-     Street, Fifth Floor, Boston, MA 02110-1301, USA.
-*/
+  This file is part of Taler.
+  Copyright (C) 2009, 2010, 2011, 2016 GNUnet e.V.
+  Copyright (C) 2018 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,
+  write to the Free Software Foundation, Inc., 51 Franklin
+  Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
 
 /**
  * @file twister_api.c
@@ -146,7 +145,7 @@ handle_acknowledgement (void *cls,
  * Connect to the twister service.
  *
  * @param cfg the configuration to use
- * @return handle to use
+ * @return handle to use in #TALER_TWISTER_disconnect to disconnect
  */
 struct TALER_TWISTER_Handle *
 TALER_TWISTER_connect

-- 
To stop receiving notification emails like this one, please contact
address@hidden



reply via email to

[Prev in Thread] Current Thread [Next in Thread]