-lock success callback
[oweals/gnunet.git] / src / lockmanager / test_lockmanager_api.c
1 /*
2      This file is part of GNUnet.
3      (C) 2012 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 2, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file lockmanager/test_lockmanager_api.c
23  * @brief Test cases for lockmanager_api.c
24  * @author Sree Harsha Totakura
25  */
26
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_lockmanager_service.h"
30
31 #define VERBOSE 1
32
33 #define VERBOSE_ARM 1
34
35 #define LOG(kind,...) \
36   GNUNET_log_from (kind, "test-lockmanager-api",__VA_ARGS__)
37
38 #define TIME_REL_SECONDS(min) \
39   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, min)
40
41 /**
42  * The testing result
43  */
44 static int result;
45
46 /**
47  * The process id of the GNUNET ARM process
48  */
49 static struct GNUNET_OS_Process *arm_pid = NULL;
50
51 /**
52  * Configuration Handle
53  */
54 static struct GNUNET_CONFIGURATION_Handle *config;
55
56 /**
57  * The handle to the lockmanager service
58  */
59 static struct GNUNET_LOCKMANAGER_Handle *handle;
60
61 /**
62  * The locking request
63  */
64 static struct GNUNET_LOCKMANAGER_LockingRequest *request;
65
66 /**
67  * Abort task identifier
68  */
69 static GNUNET_SCHEDULER_TaskIdentifier abort_task_id;
70
71 /**
72  * Shutdown nicely
73  *
74  * @param cls
75  * @param tc the task context
76  */
77 static void
78 do_shutdown (void *cls, const const struct GNUNET_SCHEDULER_TaskContext *tc)
79 {
80   if (GNUNET_SCHEDULER_NO_TASK != abort_task_id)
81     {
82       GNUNET_SCHEDULER_cancel (abort_task_id);
83       abort_task_id = GNUNET_SCHEDULER_NO_TASK;
84     }
85   
86   if (NULL != request)
87     {
88       GNUNET_LOCKMANAGER_cancel_request (request);
89       request = NULL;
90     }
91   GNUNET_LOCKMANAGER_disconnect (handle);
92   if (0 != GNUNET_OS_process_kill (arm_pid, SIGTERM))
93     {
94       LOG (GNUNET_ERROR_TYPE_DEBUG,
95            "Kill gnunet-service-arm manually\n");
96     }
97   GNUNET_OS_process_wait (arm_pid);
98   GNUNET_OS_process_close (arm_pid);
99   if (GNUNET_SYSERR != result)
100     result = GNUNET_OK;
101 }
102
103
104 /**
105  * Shutdown nicely
106  *
107  * @param cls
108  * @param tc the task context
109  */
110 static void
111 do_abort (void *cls, const const struct GNUNET_SCHEDULER_TaskContext *tc)
112 {
113   abort_task_id = GNUNET_SCHEDULER_NO_TASK;
114   result = GNUNET_SYSERR;
115   do_shutdown (cls, tc);
116 }
117
118 /**
119  * Callback for lock status changes
120  *
121  * @param cls the closure from GNUNET_LOCKMANAGER_lock call
122  *
123  * @param domain_name the locking domain of the lock 
124  *
125  * @param lock the lock for which this status is relevant
126  *
127  * @param status GNUNET_LOCKMANAGER_SUCCESS if the lock has been successfully
128  *          acquired; GNUNET_LOCKMANAGER_RELEASE when the acquired lock is lost
129  */
130 static void 
131 status_cb (void *cls,
132            const char *domain_name,
133            uint32_t lock,
134            enum GNUNET_LOCKMANAGER_Status status)
135 {
136   GNUNET_SCHEDULER_add_delayed (TIME_REL_SECONDS (1),
137                                 &do_shutdown,
138                                 NULL);
139 }
140
141
142 /**
143  * Testing function
144  *
145  * @param cls NULL
146  * @param tc the task context
147  */
148 static void
149 test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
150 {  
151   handle = GNUNET_LOCKMANAGER_connect (config);
152   GNUNET_assert (NULL != handle);
153   
154   request = GNUNET_LOCKMANAGER_acquire_lock (handle,
155                                              "GNUNET_LOCKMANAGER_TESTING",
156                                              99,
157                                              &status_cb,
158                                              NULL);
159   abort_task_id = GNUNET_SCHEDULER_add_delayed (TIME_REL_SECONDS (10),
160                                                 &do_abort,
161                                                 NULL);
162 }
163
164
165 /**
166  * Main point of test execution
167  */
168 static void
169 run (void *cls, char *const *args, const char *cfgfile,
170      const struct GNUNET_CONFIGURATION_Handle *cfg)
171 {
172   config = GNUNET_CONFIGURATION_dup (cfg);
173   arm_pid = 
174     GNUNET_OS_start_process (GNUNET_YES, NULL, NULL, "gnunet-service-arm",
175                              "gnunet-service-arm",
176 #if VERBOSE_ARM
177                              "-L", "DEBUG",
178 #endif
179                              "-c", "test_lockmanager_api.conf", NULL);
180
181   GNUNET_assert (NULL != arm_pid);
182   GNUNET_SCHEDULER_add_delayed (TIME_REL_SECONDS (1),
183                                 &test,
184                                 NULL);
185 }
186
187
188 /**
189  * Main function
190  */
191 int main (int argc, char **argv)
192 {
193   int ret;
194
195   char *const argv2[] = { "test-lockmanager-api",
196                           "-c", "test_lockmanager_api.conf",
197 #if VERBOSE
198                           "-L", "DEBUG",
199 #endif
200                           NULL
201   };
202   
203   struct GNUNET_GETOPT_CommandLineOption options[] = {
204     GNUNET_GETOPT_OPTION_END
205   };
206
207   ret =
208     GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
209                         "test-lockmanager-api", "nohelp", options, &run, NULL);
210
211   if (GNUNET_OK != ret)
212   {
213     LOG (GNUNET_ERROR_TYPE_WARNING, "run failed with error code %d\n",
214          ret);
215     return 1;
216   }
217   if (GNUNET_SYSERR == result)
218   {
219     LOG (GNUNET_ERROR_TYPE_WARNING, "test failed\n");
220     return 1;
221   }
222   LOG (GNUNET_ERROR_TYPE_INFO, "test ok\n");
223   return 0;
224 }