add -w option to gnunet-config
[oweals/gnunet.git] / src / transport / test_plugin_transport.c
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18  Boston, MA 02110-1301, 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)
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)
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 GNUNET_ATS_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 {
330   struct AddressWrapper *w = cls;
331   void *s2a;
332   size_t s2a_len;
333
334   w->test_task = NULL;
335
336   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
337               "Testing: address_to_string \n");
338   w->addrstring = GNUNET_strdup (api->address_to_string (api,
339                                                          w->address->address,
340                                                          w->address->address_length));
341   if (NULL == w->addrstring)
342   {
343     GNUNET_break(0);
344     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
345                 "Plugin cannot convert address to string!\n");
346     end_badly_now ();
347     return;
348   }
349   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
350               "Plugin added address `%s'\n",
351               w->addrstring);
352   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
353               "Testing address_to_string: OK\n");
354   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
355               "Testing: string_to_address \n");
356   s2a = NULL;
357   s2a_len = 0;
358   if ((GNUNET_OK !=
359        api->string_to_address (api, w->addrstring,
360                                strlen (w->addrstring) + 1,
361                                &s2a, &s2a_len)) ||
362       (NULL == s2a))
363   {
364     GNUNET_break(0);
365     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
366                "Plugin cannot convert string to address!\n");
367     end_badly_now ();
368     return;
369   }
370
371   /*
372     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
373     "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
374
375     int c1;
376     for (c1 = 0; c1 < s2a_len; c1++ )
377     fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
378   */
379   if (s2a_len != w->address->address_length)
380   {
381     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
382                "Plugin creates different address length when converting address->string->address: %u != %u\n",
383                w->address->address_length, s2a_len);
384   }
385   else if (0 != memcmp (s2a, w->address->address, s2a_len))
386   {
387     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
388                 "Plugin creates different address length when converting back and forth %i!\n",
389                 memcmp (s2a,
390                         w->address->address,
391                         s2a_len));
392   }
393   else
394   {
395     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
396                 "Testing string_to_address: OK\n");
397   }
398   GNUNET_free(s2a);
399
400   pretty_printers_running++;
401   api->address_pretty_printer (api->cls,
402                                w->address->transport_name,
403                                w->address->address,
404                                w->address->address_length,
405                                GNUNET_YES,
406                                GNUNET_TIME_UNIT_MINUTES,
407                                &address_pretty_printer_cb, w);
408
409   if (GNUNET_OK !=
410       api->check_address (api->cls,
411                           w->address->address,
412                           w->address->address_length))
413   {
414     GNUNET_break (0);
415     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
416                 "Plugin refuses added address!\n");
417     end_badly_now ();
418     return;
419   }
420   if (NULL != timeout_wait)
421   {
422     GNUNET_SCHEDULER_cancel (timeout_wait);
423     timeout_wait = NULL;
424   }
425   timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
426 }
427
428
429 static void
430 env_notify_address (void *cls,
431                     int add_remove,
432                     const struct GNUNET_HELLO_Address *address)
433 {
434   struct AddressWrapper *w;
435   struct AddressWrapper *wtmp;
436
437   if (GNUNET_YES == add_remove)
438   {
439     addresses_reported++;
440     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
441                "Adding address of length %u\n",
442                 address->address_length);
443
444     for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
445     {
446       if ((address->address_length == wtmp->address->address_length) &&
447           (0 == memcmp (address->address, wtmp->address->address, address->address_length)))
448       {
449         GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
450                    "Duplicate address notification .... \n");
451         return;
452       }
453     }
454
455     w = GNUNET_new (struct AddressWrapper);
456     w->address = GNUNET_HELLO_address_copy (address);
457     GNUNET_CONTAINER_DLL_insert (head, tail, w);
458     got_reply = GNUNET_NO;
459     w->test_task = GNUNET_SCHEDULER_add_now (&test_addr_string,
460                                              w);
461     return;
462   }
463
464   if (GNUNET_NO == add_remove)
465   {
466     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
467                 "Removing address of length %u\n",
468                 address->address_length);
469     w = head;
470     while (NULL != w)
471     {
472       if ((address->address_length == w->address->address_length) &&
473           (0 == memcmp (w->address->address, address->address, address->address_length)))
474       {
475         break;
476       }
477       w = w->next;
478     }
479
480     if (w == NULL)
481     {
482       GNUNET_break(0);
483       GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
484           "Plugin removes address never added!\n");
485       end_badly_now ();
486       return;
487     }
488
489     GNUNET_CONTAINER_DLL_remove(head, tail, w);
490     GNUNET_HELLO_address_free (w->address);
491     GNUNET_free(w->addrstring);
492     GNUNET_free(w);
493     return;
494   }
495   GNUNET_break(0);
496   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
497               "Invalid operation: %u\n",
498               add_remove);
499   end_badly_now ();
500 }
501
502
503 static enum GNUNET_ATS_Network_Type
504 env_get_address_type (void *cls,
505                       const struct sockaddr *addr,
506                       size_t addrlen)
507 {
508   return GNUNET_ATS_NET_LOOPBACK;
509 }
510
511
512 static const struct GNUNET_MessageHeader *
513 env_get_our_hello ()
514 {
515   return (const struct GNUNET_MessageHeader *) hello;
516 }
517
518
519 static void
520 env_session_end (void *cls,
521                  const struct GNUNET_HELLO_Address *address,
522                  struct GNUNET_ATS_Session *session)
523 {
524
525 }
526
527
528 static void
529 env_update_distance (void *cls,
530                      const struct GNUNET_HELLO_Address *address,
531                      uint32_t distance)
532 {
533 }
534
535
536 static void
537 setup_plugin_environment ()
538 {
539   env.cfg = cfg;
540   env.cls = &env;
541   env.my_identity = &my_identity;
542   env.max_connections = max_connect_per_transport;
543   env.stats = stats;
544   env.receive = &env_receive;
545   env.notify_address = &env_notify_address;
546   env.get_address_type = &env_get_address_type;
547   env.update_address_distance = &env_update_distance;
548   env.get_our_hello = &env_get_our_hello;
549   env.session_end = &env_session_end;
550 }
551
552
553 static int
554 handle_helper_message (void *cls, void *client,
555                        const struct GNUNET_MessageHeader *hdr)
556 {
557   return GNUNET_OK;
558 }
559
560
561 /**
562  * Runs the test.
563  *
564  * @param cls closure
565  * @param c configuration to use
566  */
567 static void
568 run (void *cls, char * const *args, const char *cfgfile,
569     const struct GNUNET_CONFIGURATION_Handle *c)
570 {
571   char * const *argv = cls;
572   unsigned long long tneigh;
573   char *keyfile;
574   char *plugin;
575   char *sep;
576
577   timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
578
579   cfg = c;
580   /* parse configuration */
581   if ((GNUNET_OK
582       != GNUNET_CONFIGURATION_get_value_number (c, "TRANSPORT",
583           "NEIGHBOUR_LIMIT", &tneigh))
584       || (GNUNET_OK
585           != GNUNET_CONFIGURATION_get_value_filename (c, "PEER", "PRIVATE_KEY",
586               &keyfile)))
587   {
588     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
589         "Transport service is lacking key configuration settings.  Exiting.\n");
590     return;
591   }
592
593   if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
594   {
595     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
596         "Could not create statistics.  Exiting.\n");
597     GNUNET_free(keyfile);
598     end_badly_now ();
599     return;
600   }
601
602   if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
603   {
604     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Hostkey `%s' missing.  Exiting.\n",
605         HOSTKEY_FILE);
606     GNUNET_free(keyfile);
607     end_badly_now ();
608     return;
609   }
610
611   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
612   {
613     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
614         "Could not create a directory for hostkey `%s'.  Exiting.\n", keyfile);
615     GNUNET_free(keyfile);
616     end_badly_now ();
617     return;
618   }
619
620   if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
621   {
622     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
623         "Could not copy hostkey `%s' to destination `%s'.  Exiting.\n",
624         HOSTKEY_FILE, keyfile);
625     GNUNET_free(keyfile);
626     end_badly_now ();
627     return;
628   }
629
630   max_connect_per_transport = (uint32_t) tneigh;
631   my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
632   GNUNET_free(keyfile);
633   if (NULL == my_private_key)
634   {
635     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
636         "Could not access hostkey.  Exiting.\n");
637     end_badly_now ();
638     return;
639   }
640   GNUNET_CRYPTO_eddsa_key_get_public (my_private_key, &my_identity.public_key);
641
642   hello = GNUNET_HELLO_create (&my_identity.public_key, NULL, NULL, GNUNET_NO);
643
644   /* load plugins... */
645   setup_plugin_environment ();
646
647   GNUNET_assert(strlen (argv[0]) > strlen ("test_plugin_"));
648   plugin = strstr (argv[0], "test_plugin_");
649   sep = strrchr (argv[0], '.');
650   if (NULL == plugin)
651   {
652     GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
653     end_badly_now ();
654     return;
655   }
656   plugin += strlen ("test_plugin_");
657   if (NULL != sep)
658     sep[0] = '\0';
659
660   /* Hack for WLAN: start a second helper */
661   if (0 == strcmp (plugin, "wlan"))
662   {
663     char * helper_argv[3];
664     helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
665     helper_argv[1] = (char *) "2";
666     helper_argv[2] = NULL;
667     suid_helper = GNUNET_HELPER_start (GNUNET_NO,
668         "gnunet-helper-transport-wlan-dummy", helper_argv,
669         &handle_helper_message, NULL, NULL );
670   }
671
672   /* Loading plugin */
673   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
674   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
675   api = GNUNET_PLUGIN_load (libname, &env);
676   if (NULL == api)
677   {
678     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
679         "Failed to load transport plugin for %s\n", plugin);
680     end_badly_now ();
681     return;
682   }
683
684   timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
685
686   /* Check if all functions are implemented */
687   if (NULL == api->address_pretty_printer)
688   {
689     GNUNET_break(0);
690     end_badly_now ();
691     return;
692   }
693   if (NULL == api->address_to_string)
694   {
695     GNUNET_break(0);
696     end_badly_now ();
697     return;
698   }
699   GNUNET_assert(NULL != api->check_address);
700   if (NULL == api->check_address)
701   {
702     GNUNET_break(0);
703     end_badly_now ();
704     return;
705   }
706   GNUNET_assert(NULL != api->disconnect_peer);
707   if (NULL == api->disconnect_peer)
708   {
709     GNUNET_break(0);
710     end_badly_now ();
711     return;
712   }
713   GNUNET_assert(NULL != api->get_session);
714   if (NULL == api->get_session)
715   {
716     GNUNET_break(0);
717     end_badly_now ();
718     return;
719   }
720   if (NULL == api->address_pretty_printer)
721   {
722     GNUNET_break(0);
723     end_badly_now ();
724     return;
725   }
726   if (NULL == api->string_to_address)
727   {
728     GNUNET_break(0);
729     end_badly_now ();
730     return;
731   }
732
733 }
734
735 /**
736  * The main function for the test
737  *
738  * @param argc number of arguments from the command line
739  * @param argv command line arguments
740  * @return 0 ok, 1 on error
741  */
742 int
743 main (int argc, char * const *argv)
744 {
745   static struct GNUNET_GETOPT_CommandLineOption options[] = {
746       GNUNET_GETOPT_OPTION_END };
747   int ret;
748
749   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
750
751   char * const argv_prog[] = { "test_plugin_transport", "-c",
752       "test_plugin_transport_data.conf", NULL };
753   GNUNET_log_setup ("test-plugin-transport", "WARNING", NULL );
754   ok = 1; /* set to fail */
755   ret =
756       (GNUNET_OK
757           == GNUNET_PROGRAM_run (3, argv_prog, "test-plugin-transport",
758               "testcase", options, &run, (void *) argv)) ? ok : 1;
759   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
760   return ret;
761 }
762
763 /* end of test_plugin_transport.c */