/*
     This file is part of GNUnet.
     (C) 2008--2013 Christian Grothoff (and other contributing authors)

     GNUnet 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 2, or (at your
     option) any later version.

     GNUnet 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 GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file lockmanager/test_lockmanager_api_acquireretry.c
 * @brief Test cases for lockmanager_api where the server crashes and comes
 *          back; the api should try to acqurie the lock again
 * @author Sree Harsha Totakura
 */

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_lockmanager_service.h"
#include "gnunet_testing_lib.h"

/**
 * Generic logging shorthand
 */
#define LOG(kind,...)                           \
  GNUNET_log (kind, __VA_ARGS__)

/**
 * Relative seconds shorthand
 */
#define TIME_REL_SECS(sec)                                   \
  GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)

/**
 * Various stages in test
 */
enum Test
{
    /**
     * Signal test failure
     */
  TEST_FAIL,

    /**
     * Testing just began
     */
  TEST_INIT,

    /**
     * Client has successfully acquired the lock
     */
  TEST_CLIENT_LOCK_SUCCESS,

    /**
     * Client has lost the lock
     */
  TEST_CLIENT_LOCK_RELEASE,

    /**
     * Client has again acquired the lock
     */
  TEST_CLIENT_LOCK_AGAIN_SUCCESS
};

/**
 * Configuration Handle
 */
static const struct GNUNET_CONFIGURATION_Handle *config;

/**
 * The handle to the lockmanager service
 */
static struct GNUNET_LOCKMANAGER_Handle *handle;

/**
 * The locking request
 */
static struct GNUNET_LOCKMANAGER_LockingRequest *request;

/**
 * Abort task identifier
 */
static GNUNET_SCHEDULER_TaskIdentifier abort_task_id;

/**
 * The test result
 */
enum Test result;

/**
 * Our peer
 */
static struct GNUNET_TESTING_Peer *self;


/**
 * Shutdown nicely
 *
 * @param cls
 * @param tc the task context
 */
static void
do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  if (GNUNET_SCHEDULER_NO_TASK != abort_task_id)
  {
    GNUNET_SCHEDULER_cancel (abort_task_id);
    abort_task_id = GNUNET_SCHEDULER_NO_TASK;
  }
  if (NULL != handle)
    GNUNET_LOCKMANAGER_disconnect (handle);
}

/**
 * Abort
 *
 * @param cls
 * @param tc the task context
 */
static void
do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  LOG (GNUNET_ERROR_TYPE_DEBUG, "Aborting test...\n");
  abort_task_id = GNUNET_SCHEDULER_NO_TASK;
  result = TEST_FAIL;
  do_shutdown (cls, tc);
}


/**
 * Callback for lock status changes
 *
 * @param cls the handle
 *
 * @param domain_name the locking domain of the lock
 *
 * @param lock the lock for which this status is relevant
 *
 * @param status GNUNET_LOCKMANAGER_SUCCESS if the lock has been successfully
 *          acquired; GNUNET_LOCKMANAGER_RELEASE when the acquired lock is lost
 */
static void
status_cb (void *cls, const char *domain_name, uint32_t lock,
           enum GNUNET_LOCKMANAGER_Status status)
{
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Status change callback called on lock: %d of domain: %s\n", lock,
       domain_name);
  switch (result)
  {
  case TEST_INIT:
    GNUNET_assert (handle == cls);
    GNUNET_assert (GNUNET_LOCKMANAGER_SUCCESS == status);
    result = TEST_CLIENT_LOCK_SUCCESS;
    /* We should kill the lockmanager process */
    GNUNET_TESTING_peer_stop (self);
    break;
  case TEST_CLIENT_LOCK_SUCCESS:
    GNUNET_assert (handle == cls);
    GNUNET_assert (GNUNET_LOCKMANAGER_RELEASE == status);
    result = TEST_CLIENT_LOCK_RELEASE;
    /* Now we should start again the lockmanager process */
    GNUNET_TESTING_peer_start (self);
    break;
  case TEST_CLIENT_LOCK_RELEASE:
    GNUNET_assert (handle == cls);
    GNUNET_assert (GNUNET_LOCKMANAGER_SUCCESS == status);
    result = TEST_CLIENT_LOCK_AGAIN_SUCCESS;
    GNUNET_LOCKMANAGER_cancel_request (request);
    request = NULL;
    GNUNET_SCHEDULER_add_delayed (TIME_REL_SECS (1), &do_shutdown, NULL);
    break;
  default:
    GNUNET_assert (0);          /* We should never reach here */
  }
}


/**
 * Main point of test execution
 */
static void
run (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg,
     struct GNUNET_TESTING_Peer *peer)
{
  config = cfg;
  self = peer;
  result = TEST_INIT;
  handle = GNUNET_LOCKMANAGER_connect (config);
  GNUNET_assert (NULL != handle);
  request =
      GNUNET_LOCKMANAGER_acquire_lock (handle, "GNUNET_LOCKMANAGER_TESTING", 99,
                                       &status_cb, handle);
  GNUNET_assert (NULL != request);
  abort_task_id =
      GNUNET_SCHEDULER_add_delayed (TIME_REL_SECS (30), &do_abort, NULL);
}


/**
 * Main function
 */
int
main (int argc, char **argv)
{
  if (0 !=
      GNUNET_TESTING_peer_run ("test_lockmanager_api_acquireretry",
                               "test_lockmanager_api.conf", &run, NULL))
    return 1;
  return (TEST_CLIENT_LOCK_AGAIN_SUCCESS != result) ? 1 : 0;
}

/* end of test_lockmanager_api_acquireretry.c */