more code cleanup
[oweals/gnunet.git] / src / transport / test_plugin_transport.c
1 /*
2      This file is part of GNUnet.
3      (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_transport_api.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_constants.h"
29 #include "gnunet_getopt_lib.h"
30 #include "gnunet_hello_lib.h"
31 #include "gnunet_os_lib.h"
32 #include "gnunet_peerinfo_service.h"
33 #include "gnunet_plugin_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_program_lib.h"
36 #include "gnunet_signatures.h"
37 #include "plugin_transport.h"
38 #include "transport.h"
39
40 #define VERBOSE GNUNET_NO
41
42 /**
43  * How long until we give up on transmitting the message?
44  */
45 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
46
47 /**
48  * Our public key.
49  */
50 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
51
52 /**
53  * Our identity.
54  */
55 static struct GNUNET_PeerIdentity my_identity;
56
57 /**
58  * Our private key.
59  */
60 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
61
62 /**
63  * Our scheduler.
64  */
65 struct GNUNET_SCHEDULER_Handle *sched;
66
67 /**
68  * Our configuration.
69  */
70 const struct GNUNET_CONFIGURATION_Handle *cfg;
71
72 /**
73  * Number of neighbours we'd like to have.
74  */
75 static uint32_t max_connect_per_transport;
76
77 /**
78  * Environment for this plugin.
79  */
80 struct GNUNET_TRANSPORT_PluginEnvironment env;
81
82 /**
83  *handle for the api provided by this plugin
84  */
85 struct GNUNET_TRANSPORT_PluginFunctions *api;
86
87 /**
88  * Did the test pass or fail?
89  */
90 static int ok;
91
92 /**
93  */
94 static void
95 receive (void *cls,
96          const struct GNUNET_PeerIdentity
97          *peer, const struct GNUNET_MessageHeader *message,
98          uint32_t distance,
99          const char *sender_address,
100          size_t sender_address_len)
101 {
102   /* do nothing */
103 }
104
105 void
106 notify_address (void *cls,
107                 const char *name,
108                 const void *addr,
109                 size_t addrlen, struct GNUNET_TIME_Relative expires)
110 {
111 }
112
113 /**
114  * Function called when the service shuts
115  * down.  Unloads our plugins.
116  *
117  * @param cls closure
118  * @param cfg configuration to use
119  */
120 static void
121 unload_plugins (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
122 {
123   GNUNET_assert (NULL ==
124                  GNUNET_PLUGIN_unload ("libgnunet_plugin_transport_tcp",
125                                        api));
126   if (my_private_key != NULL)
127     GNUNET_CRYPTO_rsa_key_free (my_private_key);
128
129 }
130
131
132 static void
133 unload_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
134 {
135   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
136   unload_plugins (NULL, cfg);
137 }
138
139
140 /**
141  * Simple example test that invokes
142  * the "validate" function of the plugin
143  * and tries to see if the plugin would
144  * succeed to validate its own address.
145  * (This test is not well-written since
146  *  we hand-compile the address which
147  *  kind-of works for TCP but would not
148  *  work for other plugins; we should ask
149  *  the plugin about its address instead...).
150  */
151 /* FIXME: this is TCP/UDP-specific and won't work
152    for HTTP/SMTP/DV; we should instead use an
153    address that we get from the plugin itself
154    (if it is willing/able to give us one...) */
155 static void
156 test_validation ()
157 {
158   struct sockaddr_in soaddr;
159
160   memset (&soaddr, 0, sizeof (soaddr));
161 #if HAVE_SOCKADDR_IN_SIN_LEN
162   soaddr.sin_len = sizeof (soaddr);
163 #endif
164   soaddr.sin_family = AF_INET;
165   soaddr.sin_port = htons (2368 /* FIXME: get from config! */ );
166   soaddr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
167   GNUNET_assert (GNUNET_OK ==
168                  api->check_address (api->cls,
169                                      &soaddr, sizeof (soaddr)));
170   ok = 0;
171   GNUNET_SCHEDULER_add_continuation (sched,
172                                      &unload_task,
173                                      (void *) cfg,
174                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
175 }
176
177
178 static void
179 setup_plugin_environment ()
180 {
181   env.cfg = cfg;
182   env.sched = sched;
183   env.my_identity = &my_identity;
184   env.cls = &env;
185   env.receive = &receive;
186   env.notify_address = &notify_address;
187   env.max_connections = max_connect_per_transport;
188 }
189
190
191 /**
192  * Runs the test.
193  *
194  * @param cls closure
195  * @param s scheduler to use
196  * @param c configuration to use
197  */
198 static void
199 run (void *cls,
200      struct GNUNET_SCHEDULER_Handle *s,
201      char *const *args,
202      const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
203 {
204   unsigned long long tneigh;
205   char *keyfile;
206   char *libname;
207
208   sched = s;
209   cfg = c;
210   /* parse configuration */
211   if ((GNUNET_OK !=
212        GNUNET_CONFIGURATION_get_value_number (c,
213                                               "TRANSPORT",
214                                               "NEIGHBOUR_LIMIT",
215                                               &tneigh)) ||
216       (GNUNET_OK !=
217        GNUNET_CONFIGURATION_get_value_filename (c,
218                                                 "GNUNETD",
219                                                 "HOSTKEY", &keyfile)))
220     {
221       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
222                   _
223                   ("Transport service is lacking key configuration settings.  Exiting.\n"));
224       GNUNET_SCHEDULER_shutdown (s);
225       return;
226     }
227   max_connect_per_transport = (uint32_t) tneigh;
228   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
229   GNUNET_free (keyfile);
230   if (my_private_key == NULL)
231     {
232       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
233                   _
234                   ("Transport service could not access hostkey.  Exiting.\n"));
235       GNUNET_SCHEDULER_shutdown (s);
236       return;
237     }
238   GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
239   GNUNET_CRYPTO_hash (&my_public_key,
240                       sizeof (my_public_key), &my_identity.hashPubKey);
241
242
243
244   /* load plugins... */
245   setup_plugin_environment ();
246   GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading tcp transport plugin\n"));
247   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_tcp");
248
249   api = GNUNET_PLUGIN_load (libname, &env);
250   GNUNET_free (libname);
251   if (api == NULL)
252     {
253       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
254                   _("Failed to load transport plugin for tcp\n"));
255       /* FIXME: set some error code for main */
256       return;
257     }
258   test_validation ();
259 }
260
261
262 /**
263  * The main function for the transport service.
264  *
265  * @param argc number of arguments from the command line
266  * @param argv command line arguments
267  * @return 0 ok, 1 on error
268  */
269 int
270 main (int argc, char *const *argv)
271 {
272   static struct GNUNET_GETOPT_CommandLineOption options[] = {
273     GNUNET_GETOPT_OPTION_END
274   };
275   int ret;
276   char *const argv_prog[] = {
277     "test_plugin_transport",
278     "-c",
279     "test_plugin_transport_data.conf",
280     "-L",
281 #if VERBOSE
282     "DEBUG",
283 #else
284     "WARNING",
285 #endif
286     NULL
287   };
288   GNUNET_log_setup ("test-plugin-transport",
289 #if VERBOSE
290                     "DEBUG",
291 #else
292                     "WARNING",
293 #endif
294                     NULL);
295   ok = 1;                       /* set to fail */
296   ret = (GNUNET_OK ==
297          GNUNET_PROGRAM_run (5,
298                              argv_prog,
299                              "test-plugin-transport",
300                              "testcase", options, &run, NULL)) ? ok : 1;
301   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
302   return ret;
303 }
304
305 /* end of test_plugin_transport.c */