exchange/src/lib/testing_api_cmd_exec_keyup.c

/*
  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 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_exec_keyup.c
 * @brief run the taler-exchange-keyup command
 * @author Marcello Stanisci
 * @author Christian Grothoff
 */
#include "platform.h"
#include "taler_json_lib.h"
#include <gnunet/gnunet_curl_lib.h>
#include "exchange_api_handle.h"
#include "taler_signatures.h"
#include "taler_testing_lib.h"


/**
 * State for a "keyup" CMD.
 */
struct KeyupState
{

  /**
   * Process for the "keyup" command.
   */
  struct GNUNET_OS_Process *keyup_proc;

  /**
   * Configuration file used by the command.
   */
  const char *config_filename;

  /**
   * If GNUNET_YES, then the fake @e now value will be
   * passed to taler-exchange-keyup via the --time
   * option.
   */
  unsigned int with_now;

  /**
   * User-provided fake now.
   */
  struct GNUNET_TIME_Absolute now;
};


/**
 * Run the command; calls the `taler-exchange-keyup' program.
 *
 * @param cls closure.
 * @param cmd the commaind being run.
 * @param is interpreter state.
 */
static void
keyup_run (void *cls,
           const struct TALER_TESTING_Command *cmd,
           struct TALER_TESTING_Interpreter *is)
{
  struct KeyupState *ks = cls;

  if (GNUNET_YES == ks->with_now)
  {
    ks->keyup_proc = GNUNET_OS_start_process
                       (GNUNET_NO,
                       GNUNET_OS_INHERIT_STD_ALL,
                       NULL, NULL, NULL,
                       "taler-exchange-keyup",
                       "taler-exchange-keyup",
                       "-c", ks->config_filename,
                       "-o", "auditor.in",
                       "--time",
                       GNUNET_STRINGS_absolute_time_to_string (ks->now),
                       NULL);
  }
  else
    ks->keyup_proc = GNUNET_OS_start_process
                       (GNUNET_NO,
                       GNUNET_OS_INHERIT_STD_ALL,
                       NULL, NULL, NULL,
                       "taler-exchange-keyup",
                       "taler-exchange-keyup",
                       "-c", ks->config_filename,
                       "-o", "auditor.in",
                       NULL);

  if (NULL == ks->keyup_proc)
  {
    GNUNET_break (0);
    TALER_TESTING_interpreter_fail (is);
    return;
  }

  /* This function does not tell whether the command
   * succeeded or not!  */
  TALER_TESTING_wait_for_sigchld (is);
}


/**
 * Free the state of a "keyup" CMD, and possibly kills its
 * process if it did not terminate correctly.
 *
 * @param cls closure.
 * @param cmd the command being freed.
 */
static void
keyup_cleanup (void *cls,
               const struct TALER_TESTING_Command *cmd)
{
  struct KeyupState *ks = cls;

  if (NULL != ks->keyup_proc)
  {
    GNUNET_break (0 ==
                  GNUNET_OS_process_kill (ks->keyup_proc,
                                          SIGKILL));
    GNUNET_OS_process_wait (ks->keyup_proc);
    GNUNET_OS_process_destroy (ks->keyup_proc);
    ks->keyup_proc = NULL;
  }
  GNUNET_free (ks);
}


/**
 * Offer "keyup" CMD internal data to other commands.
 *
 * @param cls closure.
 * @param ret[out] result
 * @param trait name of the trait.
 * @param index index number of the object to offer.
 *
 * @return #GNUNET_OK on success.
 */
static int
keyup_traits (void *cls,
              const void **ret,
              const char *trait,
              unsigned int index)
{
  struct KeyupState *ks = cls;
  struct TALER_TESTING_Trait traits[] = {
    TALER_TESTING_make_trait_process (0, &ks->keyup_proc),
    TALER_TESTING_trait_end ()
  };

  return TALER_TESTING_get_trait (traits,
                                  ret,
                                  trait,
                                  index);
}


/**
 * Make the "keyup" CMD, with "--timestamp" option.
 *
 * @param label command label.
 * @param config_filename configuration filename.
 * @param now Unix timestamp representing the fake "now".
 *
 * @return the command.
 */
struct TALER_TESTING_Command
TALER_TESTING_cmd_exec_keyup_with_now
  (const char *label,
  const char *config_filename,
  struct GNUNET_TIME_Absolute now)
{
  struct KeyupState *ks;

  ks = GNUNET_new (struct KeyupState);
  ks->config_filename = config_filename;
  ks->now = now;
  ks->with_now = GNUNET_YES;

  struct TALER_TESTING_Command cmd = {
    .cls = ks,
    .label = label,
    .run = &keyup_run,
    .cleanup = &keyup_cleanup,
    .traits = &keyup_traits
  };

  return cmd;
}


/**
 * Make the "keyup" CMD.
 *
 * @param label command label.
 * @param config_filename configuration filename.
 *
 * @return the command.
 */
struct TALER_TESTING_Command
TALER_TESTING_cmd_exec_keyup (const char *label,
                              const char *config_filename)
{
  struct KeyupState *ks;

  ks = GNUNET_new (struct KeyupState);
  ks->config_filename = config_filename;

  struct TALER_TESTING_Command cmd = {
    .cls = ks,
    .label = label,
    .run = &keyup_run,
    .cleanup = &keyup_cleanup,
    .traits = &keyup_traits
  };

  return cmd;
}


/* end of testing_api_cmd_exec_keyup.c */