2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
24 #include <vapi/vapi.hpp>
25 #include <vapi/vpe.api.vapi.hpp>
26 #include <vapi/interface.api.vapi.hpp>
27 #include <vapi/stats.api.vapi.hpp>
28 #include <fake.api.vapi.hpp>
30 DEFINE_VAPI_MSG_IDS_VPE_API_JSON;
31 DEFINE_VAPI_MSG_IDS_INTERFACE_API_JSON;
32 DEFINE_VAPI_MSG_IDS_STATS_API_JSON;
33 DEFINE_VAPI_MSG_IDS_FAKE_API_JSON;
35 static char *app_name = nullptr;
36 static char *api_prefix = nullptr;
37 static const int max_outstanding_requests = 32;
38 static const int response_queue_size = 32;
42 void verify_show_version_reply (const Show_version_reply &r)
44 auto &p = r.get_payload ();
45 printf ("show_version_reply: program: `%s', version: `%s', build directory: "
46 "`%s', build date: `%s'\n",
47 p.program, p.version, p.build_directory, p.build_date);
48 ck_assert_str_eq ("vpe", (char *)p.program);
55 vapi_error_e rv = con.connect (
56 app_name, api_prefix, max_outstanding_requests, response_queue_size);
57 ck_assert_int_eq (VAPI_OK, rv);
65 START_TEST (test_show_version_1)
67 printf ("--- Show version by reading response associated to request ---\n");
68 Show_version sv (con);
69 vapi_error_e rv = sv.execute ();
70 ck_assert_int_eq (VAPI_OK, rv);
71 rv = con.wait_for_response (sv);
72 ck_assert_int_eq (VAPI_OK, rv);
73 auto &r = sv.get_response ();
74 verify_show_version_reply (r);
79 struct Show_version_cb
81 Show_version_cb () : called{0} {};
83 vapi_error_e operator() (Show_version &sv)
85 auto &r = sv.get_response ();
86 verify_show_version_reply (r);
92 START_TEST (test_show_version_2)
94 printf ("--- Show version by getting a callback ---\n");
96 Show_version sv (con, std::ref (cb));
97 vapi_error_e rv = sv.execute ();
98 ck_assert_int_eq (VAPI_OK, rv);
100 ck_assert_int_eq (1, cb.called);
105 START_TEST (test_loopbacks_1)
107 printf ("--- Create/delete loopbacks by waiting for response ---\n");
108 const auto num_ifs = 5;
109 u8 mac_addresses[num_ifs][6];
110 memset (&mac_addresses, 0, sizeof (mac_addresses));
111 u32 sw_if_indexes[num_ifs];
112 memset (&sw_if_indexes, 0xff, sizeof (sw_if_indexes));
113 for (int i = 0; i < num_ifs; ++i)
115 memcpy (&mac_addresses[i], "\1\2\3\4\5\6", 6);
116 mac_addresses[i][5] = i;
118 for (int i = 0; i < num_ifs; ++i)
120 Create_loopback cl (con);
121 auto &p = cl.get_request ().get_payload ();
122 memcpy (p.mac_address, mac_addresses[i], sizeof (p.mac_address));
123 auto e = cl.execute ();
124 ck_assert_int_eq (VAPI_OK, e);
125 vapi_error_e rv = con.wait_for_response (cl);
126 ck_assert_int_eq (VAPI_OK, rv);
127 auto &rp = cl.get_response ().get_payload ();
128 ck_assert_int_eq (0, rp.retval);
129 sw_if_indexes[i] = rp.sw_if_index;
131 for (int i = 0; i < num_ifs; ++i)
133 printf ("Created loopback with MAC %02x:%02x:%02x:%02x:%02x:%02x --> "
135 mac_addresses[i][0], mac_addresses[i][1], mac_addresses[i][2],
136 mac_addresses[i][3], mac_addresses[i][4], mac_addresses[i][5],
141 bool seen[num_ifs] = {0};
142 Sw_interface_dump d (con);
143 auto &p = d.get_request ().get_payload ();
144 p.name_filter_valid = 0;
145 memset (p.name_filter, 0, sizeof (p.name_filter));
146 auto rv = d.execute ();
147 ck_assert_int_eq (VAPI_OK, rv);
148 rv = con.wait_for_response (d);
149 ck_assert_int_eq (VAPI_OK, rv);
150 auto &rs = d.get_result_set ();
153 auto &p = r.get_payload ();
154 for (int i = 0; i < num_ifs; ++i)
156 if (sw_if_indexes[i] == p.sw_if_index)
158 ck_assert_int_eq (0, seen[i]);
163 for (int i = 0; i < num_ifs; ++i)
165 ck_assert_int_eq (1, seen[i]);
169 for (int i = 0; i < num_ifs; ++i)
171 Delete_loopback dl (con);
172 dl.get_request ().get_payload ().sw_if_index = sw_if_indexes[i];
173 auto rv = dl.execute ();
174 ck_assert_int_eq (VAPI_OK, rv);
175 rv = con.wait_for_response (dl);
176 ck_assert_int_eq (VAPI_OK, rv);
177 auto &response = dl.get_response ();
178 auto rp = response.get_payload ();
179 ck_assert_int_eq (0, rp.retval);
180 printf ("Deleted loopback with sw_if_index %u\n", sw_if_indexes[i]);
184 Sw_interface_dump d (con);
185 auto &p = d.get_request ().get_payload ();
186 p.name_filter_valid = 0;
187 memset (p.name_filter, 0, sizeof (p.name_filter));
188 auto rv = d.execute ();
189 ck_assert_int_eq (VAPI_OK, rv);
190 rv = con.wait_for_response (d);
191 ck_assert_int_eq (VAPI_OK, rv);
192 auto &rs = d.get_result_set ();
195 auto &p = r.get_payload ();
196 for (int i = 0; i < num_ifs; ++i)
198 ck_assert_int_ne (sw_if_indexes[i], p.sw_if_index);
206 struct Create_loopback_cb
208 Create_loopback_cb () : called{0}, sw_if_index{0} {};
212 vapi_error_e operator() (Create_loopback &cl)
214 auto &r = cl.get_response ();
215 sw_if_index = r.get_payload ().sw_if_index;
221 struct Delete_loopback_cb
223 Delete_loopback_cb () : called{0}, sw_if_index{0} {};
227 vapi_error_e operator() (Delete_loopback &dl)
229 auto &r = dl.get_response ();
230 ck_assert_int_eq (0, r.get_payload ().retval);
236 template <int num_ifs> struct Sw_interface_dump_cb
238 Sw_interface_dump_cb (std::array<Create_loopback_cb, num_ifs> &cbs)
239 : called{0}, cbs{cbs} {};
241 std::array<Create_loopback_cb, num_ifs> &cbs;
242 vapi_error_e operator() (Sw_interface_dump &d)
248 for (auto &x : d.get_result_set ())
250 auto &p = x.get_payload ();
253 if (p.sw_if_index == y.sw_if_index)
261 ck_assert_int_eq (true, y.seen);
268 START_TEST (test_loopbacks_2)
270 printf ("--- Create/delete loopbacks by getting a callback ---\n");
271 const auto num_ifs = 5;
272 u8 mac_addresses[num_ifs][6];
273 memset (&mac_addresses, 0, sizeof (mac_addresses));
274 for (int i = 0; i < num_ifs; ++i)
276 memcpy (&mac_addresses[i], "\1\2\3\4\5\6", 6);
277 mac_addresses[i][5] = i;
279 std::array<Create_loopback_cb, num_ifs> ccbs;
280 std::array<std::unique_ptr<Create_loopback>, num_ifs> clcs;
281 for (int i = 0; i < num_ifs; ++i)
283 Create_loopback *cl = new Create_loopback (con, std::ref (ccbs[i]));
285 auto &p = cl->get_request ().get_payload ();
286 memcpy (p.mac_address, mac_addresses[i], sizeof (p.mac_address));
287 auto e = cl->execute ();
288 ck_assert_int_eq (VAPI_OK, e);
291 for (int i = 0; i < num_ifs; ++i)
293 ck_assert_int_eq (1, ccbs[i].called);
294 printf ("Created loopback with MAC %02x:%02x:%02x:%02x:%02x:%02x --> "
296 mac_addresses[i][0], mac_addresses[i][1], mac_addresses[i][2],
297 mac_addresses[i][3], mac_addresses[i][4], mac_addresses[i][5],
298 ccbs[i].sw_if_index);
301 Sw_interface_dump_cb<num_ifs> swdcb (ccbs);
302 Sw_interface_dump d (con, std::ref (swdcb));
303 auto &p = d.get_request ().get_payload ();
304 p.name_filter_valid = 0;
305 memset (p.name_filter, 0, sizeof (p.name_filter));
306 auto rv = d.execute ();
307 ck_assert_int_eq (VAPI_OK, rv);
308 rv = con.wait_for_response (d);
309 ck_assert_int_eq (VAPI_OK, rv);
310 ck_assert_int_ne (0, swdcb.called);
311 std::array<Delete_loopback_cb, num_ifs> dcbs;
312 std::array<std::unique_ptr<Delete_loopback>, num_ifs> dlcs;
313 for (int i = 0; i < num_ifs; ++i)
315 Delete_loopback *dl = new Delete_loopback (con, std::ref (dcbs[i]));
317 auto &p = dl->get_request ().get_payload ();
318 p.sw_if_index = ccbs[i].sw_if_index;
319 dcbs[i].sw_if_index = ccbs[i].sw_if_index;
320 auto e = dl->execute ();
321 ck_assert_int_eq (VAPI_OK, e);
326 ck_assert_int_eq (true, x.called);
327 printf ("Deleted loopback with sw_if_index %u\n", x.sw_if_index);
331 Sw_interface_dump d (con);
332 auto &p = d.get_request ().get_payload ();
333 p.name_filter_valid = 0;
334 memset (p.name_filter, 0, sizeof (p.name_filter));
335 auto rv = d.execute ();
336 ck_assert_int_eq (VAPI_OK, rv);
337 rv = con.wait_for_response (d);
338 ck_assert_int_eq (VAPI_OK, rv);
339 auto &rs = d.get_result_set ();
342 auto &p = r.get_payload ();
343 for (int i = 0; i < num_ifs; ++i)
345 ck_assert_int_ne (ccbs[i].sw_if_index, p.sw_if_index);
353 START_TEST (test_stats_1)
355 printf ("--- Receive single stats by waiting for response ---\n");
357 auto &payload = ws.get_request ().get_payload ();
358 payload.enable_disable = 1;
359 payload.pid = getpid ();
360 auto rv = ws.execute ();
361 ck_assert_int_eq (VAPI_OK, rv);
362 Event_registration<Vnet_interface_simple_counters> sc (con);
363 rv = con.wait_for_response (sc);
364 ck_assert_int_eq (VAPI_OK, rv);
365 auto &rs = sc.get_result_set ();
369 printf ("simple counters: first_sw_if_index=%u\n",
370 r.get_payload ().first_sw_if_index);
373 ck_assert_int_ne (0, count);
378 struct Vnet_interface_simple_counters_cb
380 Vnet_interface_simple_counters_cb () : called{0} {};
383 operator() (Event_registration<Vnet_interface_simple_counters> &e)
386 auto &rs = e.get_result_set ();
390 printf ("simple counters: first_sw_if_index=%u\n",
391 r.get_payload ().first_sw_if_index);
394 ck_assert_int_ne (0, count);
399 START_TEST (test_stats_2)
401 printf ("--- Receive single stats by getting a callback ---\n");
403 auto &payload = ws.get_request ().get_payload ();
404 payload.enable_disable = 1;
405 payload.pid = getpid ();
406 auto rv = ws.execute ();
407 ck_assert_int_eq (VAPI_OK, rv);
408 Vnet_interface_simple_counters_cb cb;
409 Event_registration<Vnet_interface_simple_counters> sc (con, std::ref (cb));
410 rv = con.wait_for_response (sc);
411 ck_assert_int_eq (VAPI_OK, rv);
412 ck_assert_int_ne (0, cb.called);
417 struct Vnet_interface_simple_counters_2_cb
419 Vnet_interface_simple_counters_2_cb () : called{0}, total{0} {};
423 operator() (Event_registration<Vnet_interface_simple_counters> &e)
426 auto &rs = e.get_result_set ();
430 printf ("simple counters: first_sw_if_index=%u\n",
431 r.get_payload ().first_sw_if_index);
434 rs.free_all_responses ();
435 ck_assert_int_ne (0, count);
441 START_TEST (test_stats_3)
444 "--- Receive single stats by getting a callback - clear results ---\n");
446 auto &payload = ws.get_request ().get_payload ();
447 payload.enable_disable = 1;
448 payload.pid = getpid ();
449 auto rv = ws.execute ();
450 ck_assert_int_eq (VAPI_OK, rv);
451 Vnet_interface_simple_counters_2_cb cb;
452 Event_registration<Vnet_interface_simple_counters> sc (con, std::ref (cb));
453 for (int i = 0; i < 5; ++i)
455 rv = con.wait_for_response (sc);
457 ck_assert_int_eq (VAPI_OK, rv);
458 ck_assert_int_eq (5, cb.called);
459 ck_assert_int_eq (5, cb.total);
464 START_TEST (test_stats_4)
466 printf ("--- Receive multiple stats by waiting for response ---\n");
468 auto &payload = ws.get_request ().get_payload ();
469 payload.enable_disable = 1;
470 payload.pid = getpid ();
471 auto rv = ws.execute ();
472 ck_assert_int_eq (VAPI_OK, rv);
473 Event_registration<Vnet_interface_simple_counters> sc (con);
474 Event_registration<Vnet_interface_combined_counters> cc (con);
475 rv = con.wait_for_response (sc);
476 ck_assert_int_eq (VAPI_OK, rv);
477 rv = con.wait_for_response (cc);
478 ck_assert_int_eq (VAPI_OK, rv);
480 for (auto &r : sc.get_result_set ())
482 printf ("simple counters: first_sw_if_index=%u\n",
483 r.get_payload ().first_sw_if_index);
486 ck_assert_int_ne (0, count);
488 for (auto &r : cc.get_result_set ())
490 printf ("combined counters: first_sw_if_index=%u\n",
491 r.get_payload ().first_sw_if_index);
494 ck_assert_int_ne (0, count);
499 START_TEST (test_unsupported)
501 printf ("--- Unsupported messages ---\n");
505 Test_fake_msg fake (con);
507 catch (const Msg_not_available_exception &)
510 printf ("Constructing unsupported msg not possible - test pass.\n");
512 ck_assert_int_eq (true, thrown);
516 Test_fake_dump fake (con);
518 catch (const Msg_not_available_exception &)
521 printf ("Constructing unsupported dump not possible - test pass.\n");
523 ck_assert_int_eq (true, thrown);
527 Event_registration<Test_fake_details> fake (con);
529 catch (const Msg_not_available_exception &)
532 printf ("Constructing unsupported event registration not possible - "
535 ck_assert_int_eq (true, thrown);
540 Suite *test_suite (void)
542 Suite *s = suite_create ("VAPI test");
544 TCase *tc_cpp_api = tcase_create ("C++ API");
545 tcase_set_timeout (tc_cpp_api, 25);
546 tcase_add_checked_fixture (tc_cpp_api, setup, teardown);
547 tcase_add_test (tc_cpp_api, test_show_version_1);
548 tcase_add_test (tc_cpp_api, test_show_version_2);
549 tcase_add_test (tc_cpp_api, test_loopbacks_1);
550 tcase_add_test (tc_cpp_api, test_loopbacks_2);
551 tcase_add_test (tc_cpp_api, test_stats_1);
552 tcase_add_test (tc_cpp_api, test_stats_2);
553 tcase_add_test (tc_cpp_api, test_stats_3);
554 tcase_add_test (tc_cpp_api, test_stats_4);
555 tcase_add_test (tc_cpp_api, test_unsupported);
556 suite_add_tcase (s, tc_cpp_api);
561 int main (int argc, char *argv[])
565 printf ("Invalid argc==`%d'\n", argc);
569 api_prefix = argv[2];
570 printf ("App name: `%s', API prefix: `%s'\n", app_name, api_prefix);
577 sr = srunner_create (s);
579 srunner_run_all (sr, CK_NORMAL);
580 number_failed = srunner_ntests_failed (sr);
582 return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
586 * fd.io coding-style-patch-verification: ON
589 * eval: (c-set-style "gnu")