-simplify logic
[oweals/gnunet.git] / src / transport / test_plugin_transport.c
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009 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 3, 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  * @file transport/test_plugin_transport.c
22  * @brief testcase for transport_api.c
23  * @author Sailor Siraj
24  * @author Christian Grothoff
25  */
26
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_peerinfo_service.h"
31 #include "gnunet_statistics_service.h"
32 #include "gnunet_protocols.h"
33 #include "gnunet_transport_plugin.h"
34 #include "transport.h"
35
36 /**
37  * How long until we give up on transmitting the message?
38  */
39 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
40 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
41
42 #define HOSTKEY_FILE "test_plugin_hostkey.ecc"
43
44 /**
45  * Our public key.
46  */
47 static struct GNUNET_PeerIdentity my_identity;
48
49 /**
50  * Our private key.
51  */
52 static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
53
54 /**
55  * Our configuration.
56  */
57 const struct GNUNET_CONFIGURATION_Handle *cfg;
58
59 /**
60  * Our configuration.
61  */
62 struct GNUNET_STATISTICS_Handle *stats;
63
64 /**
65  * Our HELLO
66  */
67 struct GNUNET_HELLO_Message *hello;
68
69 /**
70  * Number of neighbours we'd like to have.
71  */
72 static uint32_t max_connect_per_transport;
73
74 /**
75  * Environment for this plugin.
76  */
77 struct GNUNET_TRANSPORT_PluginEnvironment env;
78
79 /**
80  *handle for the api provided by this plugin
81  */
82 struct GNUNET_TRANSPORT_PluginFunctions *api;
83
84 /**
85  * Helper handler
86  */
87 struct GNUNET_HELPER_Handle *suid_helper;
88
89 /**
90  * Timeout task
91  */
92 static struct GNUNET_SCHEDULER_Task * timeout_endbadly;
93
94 /**
95  * Timeout task
96  */
97 static struct GNUNET_SCHEDULER_Task * timeout_wait;
98
99 /**
100  * Library name
101  */
102 static char *libname;
103
104 /**
105  * Plugin addresses head
106  */
107 struct AddressWrapper *head;
108
109 /**
110  * Plugin addresses tail
111  */
112 struct AddressWrapper *tail;
113
114 unsigned int addresses_reported;
115
116 unsigned int pretty_printers_running;
117
118 /**
119  * Did the test pass or fail?
120  */
121 static int ok;
122
123 struct AddressWrapper
124 {
125   struct AddressWrapper *next;
126
127   struct AddressWrapper *prev;
128
129   struct GNUNET_HELLO_Address *address;
130
131   char *addrstring;
132
133   struct GNUNET_SCHEDULER_Task *test_task;
134
135 };
136
137
138 static void
139 end ()
140 {
141   struct AddressWrapper *w;
142   int c = 0;
143   ok = 0;
144
145   if (NULL != timeout_endbadly)
146   {
147     GNUNET_SCHEDULER_cancel (timeout_endbadly);
148     timeout_endbadly = NULL;
149   }
150   if (NULL != api)
151     GNUNET_PLUGIN_unload (libname, api);
152
153   while (NULL != head)
154   {
155     w = head;
156     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
157                 "Plugin did not remove address `%s'\n",
158                 w->addrstring);
159     GNUNET_CONTAINER_DLL_remove(head, tail, w);
160     c++;
161     GNUNET_HELLO_address_free(w->address);
162     GNUNET_free(w->addrstring);
163     GNUNET_free(w);
164   }
165   if (c > 0)
166   {
167     GNUNET_break(0);
168     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses \n",
169         c);
170     ok = 1;
171   }
172
173   GNUNET_free(libname);
174   libname = NULL;
175   GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
176   stats = NULL;
177
178   if (NULL != suid_helper)
179   {
180     GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
181     suid_helper = NULL;
182   }
183 }
184
185
186 static void
187 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
188 {
189   struct AddressWrapper *w;
190   int c = 0;
191
192   timeout_endbadly = NULL;
193   if (NULL != timeout_wait)
194   {
195     GNUNET_SCHEDULER_cancel (timeout_wait);
196     timeout_wait = NULL;
197   }
198
199   if (pretty_printers_running > 0)
200   {
201     timeout_endbadly = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
202         &end_badly, &ok);
203     GNUNET_log(GNUNET_ERROR_TYPE_INFO,
204         "Have pending calls to pretty_printer ... deferring shutdown\n");
205     return;
206   }
207
208   if (NULL != cls)
209   {
210     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
211         "Test took too long to execute, timeout .... \n");
212   }
213
214   if (NULL != libname)
215   {
216     if (NULL != api)
217       GNUNET_PLUGIN_unload (libname, api);
218     GNUNET_free(libname);
219     libname = NULL;
220   }
221
222   while (NULL != head)
223   {
224     w = head;
225     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove address `%s'\n",
226         w->addrstring);
227     GNUNET_CONTAINER_DLL_remove(head, tail, w);
228     c++;
229     GNUNET_HELLO_address_free(w->address);
230     if (NULL != w->test_task)
231       GNUNET_SCHEDULER_cancel (w->test_task);
232     GNUNET_free(w->addrstring);
233     GNUNET_free(w);
234   }
235   if (c > 0)
236   {
237     GNUNET_break(0);
238     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses\n",
239         c);
240   }
241
242   if (NULL != stats)
243   {
244     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
245     stats = NULL;
246   }
247
248   if (NULL != suid_helper)
249   {
250     GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
251     suid_helper = NULL;
252   }
253
254   ok = 1;
255 }
256
257 static void
258 wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
259 {
260   timeout_wait = NULL;
261   if (0 == addresses_reported)
262     GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
263         "Plugin did not report any addresses, could not check address conversion functions\n");
264   end ();
265 }
266
267
268 static void
269 end_badly_now ()
270 {
271   if (NULL != timeout_wait)
272   {
273     GNUNET_SCHEDULER_cancel (timeout_wait);
274     timeout_wait = NULL;
275   }
276   if (NULL != timeout_endbadly)
277   {
278     GNUNET_SCHEDULER_cancel (timeout_endbadly);
279     timeout_endbadly = NULL;
280   }
281   timeout_endbadly = GNUNET_SCHEDULER_add_now (&end_badly, NULL );
282 }
283
284
285 static struct GNUNET_TIME_Relative
286 env_receive (void *cls,
287              const struct GNUNET_HELLO_Address *address,
288              struct Session *session,
289              const struct GNUNET_MessageHeader *message)
290 {
291   /* do nothing */
292   return GNUNET_TIME_relative_get_zero_ ();
293 }
294
295 static int got_reply;
296
297
298 /**
299  * Take the given address and append it to the set of results sent back to
300  * the client.
301  *
302  * @param cls closure
303  * @param address the address to print
304  * @param res result code
305  */
306 static void
307 address_pretty_printer_cb (void *cls, const char *address, int res)
308 {
309   if (NULL != address)
310   {
311     got_reply = GNUNET_YES;
312     GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Pretty address : `%s'\n", address);
313     pretty_printers_running--;
314   }
315   else
316   {
317     if (GNUNET_NO == got_reply)
318     {
319       pretty_printers_running--;
320       GNUNET_break(0);
321       end_badly_now ();
322     }
323   }
324 }
325
326
327 static void
328 test_addr_string (void *cls,
329                   const struct GNUNET_SCHEDULER_TaskContext *tc)
330 {
331   struct AddressWrapper *w = cls;
332   void *s2a;
333   size_t s2a_len;
334
335   w->test_task = NULL;
336
337   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
338               "Testing: address_to_string \n");
339   w->addrstring = GNUNET_strdup (api->address_to_string (api,
340                                                          w->address->address,
341                                                          w->address->address_length));
342   if (NULL == w->addrstring)
343   {
344     GNUNET_break(0);
345     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
346                "Plugin cannot convert address to string!\n");
347     end_badly_now ();
348     return;
349   }
350   GNUNET_log(GNUNET_ERROR_TYPE_INFO,
351              "Plugin added address `%s'\n",
352              w->addrstring);
353   GNUNET_log(GNUNET_ERROR_TYPE_INFO,
354              "Testing address_to_string: OK\n");
355   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
356               "Testing: string_to_address \n");
357   s2a = NULL;
358   s2a_len = 0;
359   if ((GNUNET_OK !=
360        api->string_to_address (api, w->addrstring,
361                                strlen (w->addrstring) + 1,
362                                &s2a, &s2a_len)) ||
363       (NULL == s2a))
364   {
365     GNUNET_break(0);
366     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
367                "Plugin cannot convert string to address!\n");
368     end_badly_now ();
369     return;
370   }
371
372   /*
373     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
374     "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
375
376     int c1;
377     for (c1 = 0; c1 < s2a_len; c1++ )
378     fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
379   */
380   if (s2a_len != w->address->address_length)
381   {
382     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
383                "Plugin creates different address length when converting address->string->address: %u != %u\n",
384                w->address->address_length, s2a_len);
385   }
386   else if (0 != memcmp (s2a, w->address->address, s2a_len))
387   {
388     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
389                "Plugin creates different address length when converting back and forth %i!\n",
390                memcmp (s2a, w->address->address, s2a_len));
391   }
392   else
393   {
394     GNUNET_log(GNUNET_ERROR_TYPE_INFO,
395                "Testing string_to_address: OK\n");
396   }
397   GNUNET_free(s2a);
398
399   pretty_printers_running++;
400   api->address_pretty_printer (api->cls,
401                                w->address->transport_name,
402                                w->address->address,
403                                w->address->address_length,
404                                GNUNET_YES,
405                                GNUNET_TIME_UNIT_MINUTES,
406                                &address_pretty_printer_cb, w);
407
408   if (GNUNET_OK !=
409       api->check_address (api->cls, w->address->address, w->address->address_length))
410   {
411     GNUNET_break(0);
412     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin refuses added address!\n");
413     end_badly_now ();
414     return;
415   }
416   if (NULL != timeout_wait)
417   {
418     GNUNET_SCHEDULER_cancel (timeout_wait);
419     timeout_wait = NULL;
420   }
421   timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
422 }
423
424
425 static void
426 env_notify_address (void *cls,
427                     int add_remove,
428                     const struct GNUNET_HELLO_Address *address)
429 {
430   struct AddressWrapper *w;
431   struct AddressWrapper *wtmp;
432
433   if (GNUNET_YES == add_remove)
434   {
435     addresses_reported++;
436     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
437                "Adding address of length %u\n",
438                 address->address_length);
439
440     for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
441     {
442       if ((address->address_length == wtmp->address->address_length) &&
443           (0 == memcmp (address->address, wtmp->address->address, address->address_length)))
444       {
445         GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
446                    "Duplicate address notification .... \n");
447         return;
448       }
449     }
450
451     w = GNUNET_new (struct AddressWrapper);
452     w->address = GNUNET_HELLO_address_copy (address);
453     GNUNET_CONTAINER_DLL_insert (head, tail, w);
454     got_reply = GNUNET_NO;
455     w->test_task = GNUNET_SCHEDULER_add_now (&test_addr_string,
456                                              w);
457     return;
458   }
459
460   if (GNUNET_NO == add_remove)
461   {
462     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
463                 "Removing address of length %u\n",
464                 address->address_length);
465     w = head;
466     while (NULL != w)
467     {
468       if ((address->address_length == w->address->address_length) &&
469           (0 == memcmp (w->address->address, address->address, address->address_length)))
470       {
471         break;
472       }
473       w = w->next;
474     }
475
476     if (w == NULL)
477     {
478       GNUNET_break(0);
479       GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
480           "Plugin removes address never added!\n");
481       end_badly_now ();
482       return;
483     }
484
485     GNUNET_CONTAINER_DLL_remove(head, tail, w);
486     GNUNET_HELLO_address_free (w->address);
487     GNUNET_free(w->addrstring);
488     GNUNET_free(w);
489     return;
490   }
491   GNUNET_break(0);
492   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
493               "Invalid operation: %u\n",
494               add_remove);
495   end_badly_now ();
496 }
497
498
499 static enum GNUNET_ATS_Network_Type
500 env_get_address_type (void *cls,
501                       const struct sockaddr *addr,
502                       size_t addrlen)
503 {
504   return GNUNET_ATS_NET_LOOPBACK;
505 }
506
507
508 static const struct GNUNET_MessageHeader *
509 env_get_our_hello ()
510 {
511   return (const struct GNUNET_MessageHeader *) hello;
512 }
513
514
515 static void
516 env_session_end (void *cls,
517                  const struct GNUNET_HELLO_Address *address,
518                  struct Session *session)
519 {
520
521 }
522
523
524 static void
525 env_update_distance (void *cls,
526                      const struct GNUNET_HELLO_Address *address,
527                      uint32_t distance)
528 {
529 }
530
531
532 static void
533 setup_plugin_environment ()
534 {
535   env.cfg = cfg;
536   env.cls = &env;
537   env.my_identity = &my_identity;
538   env.max_connections = max_connect_per_transport;
539   env.stats = stats;
540   env.receive = &env_receive;
541   env.notify_address = &env_notify_address;
542   env.get_address_type = &env_get_address_type;
543   env.update_address_distance = &env_update_distance;
544   env.get_our_hello = &env_get_our_hello;
545   env.session_end = &env_session_end;
546 }
547
548
549 static int
550 handle_helper_message (void *cls, void *client,
551                        const struct GNUNET_MessageHeader *hdr)
552 {
553   return GNUNET_OK;
554 }
555
556
557 /**
558  * Runs the test.
559  *
560  * @param cls closure
561  * @param c configuration to use
562  */
563 static void
564 run (void *cls, char * const *args, const char *cfgfile,
565     const struct GNUNET_CONFIGURATION_Handle *c)
566 {
567   char * const *argv = cls;
568   unsigned long long tneigh;
569   char *keyfile;
570   char *plugin;
571   char *sep;
572
573   timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
574
575   cfg = c;
576   /* parse configuration */
577   if ((GNUNET_OK
578       != GNUNET_CONFIGURATION_get_value_number (c, "TRANSPORT",
579           "NEIGHBOUR_LIMIT", &tneigh))
580       || (GNUNET_OK
581           != GNUNET_CONFIGURATION_get_value_filename (c, "PEER", "PRIVATE_KEY",
582               &keyfile)))
583   {
584     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
585         "Transport service is lacking key configuration settings.  Exiting.\n");
586     return;
587   }
588
589   if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
590   {
591     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
592         "Could not create statistics.  Exiting.\n");
593     GNUNET_free(keyfile);
594     end_badly_now ();
595     return;
596   }
597
598   if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
599   {
600     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Hostkey `%s' missing.  Exiting.\n",
601         HOSTKEY_FILE);
602     GNUNET_free(keyfile);
603     end_badly_now ();
604     return;
605   }
606
607   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
608   {
609     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
610         "Could not create a directory for hostkey `%s'.  Exiting.\n", keyfile);
611     GNUNET_free(keyfile);
612     end_badly_now ();
613     return;
614   }
615
616   if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
617   {
618     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
619         "Could not copy hostkey `%s' to destination `%s'.  Exiting.\n",
620         HOSTKEY_FILE, keyfile);
621     GNUNET_free(keyfile);
622     end_badly_now ();
623     return;
624   }
625
626   max_connect_per_transport = (uint32_t) tneigh;
627   my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
628   GNUNET_free(keyfile);
629   if (NULL == my_private_key)
630   {
631     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
632         "Could not access hostkey.  Exiting.\n");
633     end_badly_now ();
634     return;
635   }
636   GNUNET_CRYPTO_eddsa_key_get_public (my_private_key, &my_identity.public_key);
637
638   hello = GNUNET_HELLO_create (&my_identity.public_key, NULL, NULL, GNUNET_NO);
639
640   /* load plugins... */
641   setup_plugin_environment ();
642
643   GNUNET_assert(strlen (argv[0]) > strlen ("test_plugin_"));
644   plugin = strstr (argv[0], "test_plugin_");
645   sep = strrchr (argv[0], '.');
646   if (NULL == plugin)
647   {
648     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
649     end_badly_now ();
650     return;
651   }
652   plugin += strlen ("test_plugin_");
653   if (NULL != sep)
654     sep[0] = '\0';
655
656   /* Hack for WLAN: start a second helper */
657   if (0 == strcmp (plugin, "wlan"))
658   {
659     char * helper_argv[3];
660     helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
661     helper_argv[1] = (char *) "2";
662     helper_argv[2] = NULL;
663     suid_helper = GNUNET_HELPER_start (GNUNET_NO,
664         "gnunet-helper-transport-wlan-dummy", helper_argv,
665         &handle_helper_message, NULL, NULL );
666   }
667
668   /* Loading plugin */
669   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
670   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
671   api = GNUNET_PLUGIN_load (libname, &env);
672   if (NULL == api)
673   {
674     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
675         "Failed to load transport plugin for %s\n", plugin);
676     end_badly_now ();
677     return;
678   }
679
680   timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
681
682   /* Check if all functions are implemented */
683   if (NULL == api->address_pretty_printer)
684   {
685     GNUNET_break(0);
686     end_badly_now ();
687     return;
688   }
689   if (NULL == api->address_to_string)
690   {
691     GNUNET_break(0);
692     end_badly_now ();
693     return;
694   }
695   GNUNET_assert(NULL != api->check_address);
696   if (NULL == api->check_address)
697   {
698     GNUNET_break(0);
699     end_badly_now ();
700     return;
701   }
702   GNUNET_assert(NULL != api->disconnect_peer);
703   if (NULL == api->disconnect_peer)
704   {
705     GNUNET_break(0);
706     end_badly_now ();
707     return;
708   }
709   GNUNET_assert(NULL != api->get_session);
710   if (NULL == api->get_session)
711   {
712     GNUNET_break(0);
713     end_badly_now ();
714     return;
715   }
716   if (NULL == api->address_pretty_printer)
717   {
718     GNUNET_break(0);
719     end_badly_now ();
720     return;
721   }
722   if (NULL == api->string_to_address)
723   {
724     GNUNET_break(0);
725     end_badly_now ();
726     return;
727   }
728
729 }
730
731 /**
732  * The main function for the test
733  *
734  * @param argc number of arguments from the command line
735  * @param argv command line arguments
736  * @return 0 ok, 1 on error
737  */
738 int
739 main (int argc, char * const *argv)
740 {
741   static struct GNUNET_GETOPT_CommandLineOption options[] = {
742       GNUNET_GETOPT_OPTION_END };
743   int ret;
744
745   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
746
747   char * const argv_prog[] = { "test_plugin_transport", "-c",
748       "test_plugin_transport_data.conf", NULL };
749   GNUNET_log_setup ("test-plugin-transport", "WARNING", NULL );
750   ok = 1; /* set to fail */
751   ret =
752       (GNUNET_OK
753           == GNUNET_PROGRAM_run (3, argv_prog, "test-plugin-transport",
754               "testcase", options, &run, (void *) argv)) ? ok : 1;
755   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
756   return ret;
757 }
758
759 /* end of test_plugin_transport.c */