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 <fake.api.vapi.hpp>
29 DEFINE_VAPI_MSG_IDS_VPE_API_JSON;
30 DEFINE_VAPI_MSG_IDS_INTERFACE_API_JSON;
31 DEFINE_VAPI_MSG_IDS_FAKE_API_JSON;
33 static char *app_name = nullptr;
34 static char *api_prefix = nullptr;
35 static const int max_outstanding_requests = 32;
36 static const int response_queue_size = 32;
38 #define WAIT_FOR_RESPONSE(param, ret) \
41 ret = con.wait_for_response (param); \
43 while (ret == VAPI_EAGAIN)
47 void verify_show_version_reply (const Show_version_reply &r)
49 auto &p = r.get_payload ();
50 printf ("show_version_reply: program: `%s', version: `%s', build directory: "
51 "`%s', build date: `%s'\n",
52 vl_api_from_api_string (&p.program),
53 vl_api_from_api_string (&p.version),
54 vl_api_from_api_string (&p.build_directory),
55 vl_api_from_api_string (&p.build_date));
56 ck_assert_str_eq ("vpe", (char *)vl_api_from_api_string (&p.program));
63 vapi_error_e rv = con.connect (
64 app_name, api_prefix, max_outstanding_requests, response_queue_size);
65 ck_assert_int_eq (VAPI_OK, rv);
73 START_TEST (test_show_version_1)
75 printf ("--- Show version by reading response associated to request ---\n");
76 Show_version sv (con);
77 vapi_error_e rv = sv.execute ();
78 ck_assert_int_eq (VAPI_OK, rv);
79 WAIT_FOR_RESPONSE (sv, rv);
80 ck_assert_int_eq (VAPI_OK, rv);
81 auto &r = sv.get_response ();
82 verify_show_version_reply (r);
87 struct Show_version_cb
89 Show_version_cb () : called{0} {};
91 vapi_error_e operator() (Show_version &sv)
93 auto &r = sv.get_response ();
94 verify_show_version_reply (r);
100 START_TEST (test_show_version_2)
102 printf ("--- Show version by getting a callback ---\n");
104 Show_version sv (con, std::ref (cb));
105 vapi_error_e rv = sv.execute ();
106 ck_assert_int_eq (VAPI_OK, rv);
108 ck_assert_int_eq (1, cb.called);
113 START_TEST (test_loopbacks_1)
115 printf ("--- Create/delete loopbacks by waiting for response ---\n");
116 const auto num_ifs = 5;
117 u8 mac_addresses[num_ifs][6];
118 memset (&mac_addresses, 0, sizeof (mac_addresses));
119 u32 sw_if_indexes[num_ifs];
120 memset (&sw_if_indexes, 0xff, sizeof (sw_if_indexes));
121 for (int i = 0; i < num_ifs; ++i)
123 memcpy (&mac_addresses[i], "\1\2\3\4\5\6", 6);
124 mac_addresses[i][5] = i;
126 for (int i = 0; i < num_ifs; ++i)
128 Create_loopback cl (con);
129 auto &p = cl.get_request ().get_payload ();
130 memcpy (p.mac_address, mac_addresses[i], sizeof (p.mac_address));
131 auto e = cl.execute ();
132 ck_assert_int_eq (VAPI_OK, e);
134 WAIT_FOR_RESPONSE (cl, rv);
135 ck_assert_int_eq (VAPI_OK, rv);
136 auto &rp = cl.get_response ().get_payload ();
137 ck_assert_int_eq (0, rp.retval);
138 sw_if_indexes[i] = rp.sw_if_index;
140 for (int i = 0; i < num_ifs; ++i)
142 printf ("Created loopback with MAC %02x:%02x:%02x:%02x:%02x:%02x --> "
144 mac_addresses[i][0], mac_addresses[i][1], mac_addresses[i][2],
145 mac_addresses[i][3], mac_addresses[i][4], mac_addresses[i][5],
150 bool seen[num_ifs] = {0};
151 Sw_interface_dump d (con);
152 auto &p = d.get_request ().get_payload ();
153 p.name_filter_valid = 0;
154 memset (p.name_filter, 0, sizeof (p.name_filter));
155 auto rv = d.execute ();
156 ck_assert_int_eq (VAPI_OK, rv);
157 WAIT_FOR_RESPONSE (d, rv);
158 ck_assert_int_eq (VAPI_OK, rv);
159 auto &rs = d.get_result_set ();
162 auto &p = r.get_payload ();
163 for (int i = 0; i < num_ifs; ++i)
165 if (sw_if_indexes[i] == p.sw_if_index)
167 ck_assert_int_eq (0, seen[i]);
172 for (int i = 0; i < num_ifs; ++i)
174 ck_assert_int_eq (1, seen[i]);
178 for (int i = 0; i < num_ifs; ++i)
180 Delete_loopback dl (con);
181 dl.get_request ().get_payload ().sw_if_index = sw_if_indexes[i];
182 auto rv = dl.execute ();
183 ck_assert_int_eq (VAPI_OK, rv);
184 WAIT_FOR_RESPONSE (dl, rv);
185 ck_assert_int_eq (VAPI_OK, rv);
186 auto &response = dl.get_response ();
187 auto rp = response.get_payload ();
188 ck_assert_int_eq (0, rp.retval);
189 printf ("Deleted loopback with sw_if_index %u\n", sw_if_indexes[i]);
193 Sw_interface_dump d (con);
194 auto &p = d.get_request ().get_payload ();
195 p.name_filter_valid = 0;
196 memset (p.name_filter, 0, sizeof (p.name_filter));
197 auto rv = d.execute ();
198 ck_assert_int_eq (VAPI_OK, rv);
199 WAIT_FOR_RESPONSE (d, rv);
200 ck_assert_int_eq (VAPI_OK, rv);
201 auto &rs = d.get_result_set ();
204 auto &p = r.get_payload ();
205 for (int i = 0; i < num_ifs; ++i)
207 ck_assert_int_ne (sw_if_indexes[i], p.sw_if_index);
215 struct Create_loopback_cb
217 Create_loopback_cb () : called{0}, sw_if_index{0} {};
221 vapi_error_e operator() (Create_loopback &cl)
223 auto &r = cl.get_response ();
224 sw_if_index = r.get_payload ().sw_if_index;
230 struct Delete_loopback_cb
232 Delete_loopback_cb () : called{0}, sw_if_index{0} {};
236 vapi_error_e operator() (Delete_loopback &dl)
238 auto &r = dl.get_response ();
239 ck_assert_int_eq (0, r.get_payload ().retval);
245 template <int num_ifs> struct Sw_interface_dump_cb
247 Sw_interface_dump_cb (std::array<Create_loopback_cb, num_ifs> &cbs)
248 : called{0}, cbs{cbs} {};
250 std::array<Create_loopback_cb, num_ifs> &cbs;
251 vapi_error_e operator() (Sw_interface_dump &d)
257 for (auto &x : d.get_result_set ())
259 auto &p = x.get_payload ();
262 if (p.sw_if_index == y.sw_if_index)
270 ck_assert_int_eq (true, y.seen);
277 START_TEST (test_loopbacks_2)
279 printf ("--- Create/delete loopbacks by getting a callback ---\n");
280 const auto num_ifs = 5;
281 u8 mac_addresses[num_ifs][6];
282 memset (&mac_addresses, 0, sizeof (mac_addresses));
283 for (int i = 0; i < num_ifs; ++i)
285 memcpy (&mac_addresses[i], "\1\2\3\4\5\6", 6);
286 mac_addresses[i][5] = i;
288 std::array<Create_loopback_cb, num_ifs> ccbs;
289 std::array<std::unique_ptr<Create_loopback>, num_ifs> clcs;
290 for (int i = 0; i < num_ifs; ++i)
292 Create_loopback *cl = new Create_loopback (con, std::ref (ccbs[i]));
294 auto &p = cl->get_request ().get_payload ();
295 memcpy (p.mac_address, mac_addresses[i], sizeof (p.mac_address));
296 auto e = cl->execute ();
297 ck_assert_int_eq (VAPI_OK, e);
300 for (int i = 0; i < num_ifs; ++i)
302 ck_assert_int_eq (1, ccbs[i].called);
303 printf ("Created loopback with MAC %02x:%02x:%02x:%02x:%02x:%02x --> "
305 mac_addresses[i][0], mac_addresses[i][1], mac_addresses[i][2],
306 mac_addresses[i][3], mac_addresses[i][4], mac_addresses[i][5],
307 ccbs[i].sw_if_index);
310 Sw_interface_dump_cb<num_ifs> swdcb (ccbs);
311 Sw_interface_dump d (con, std::ref (swdcb));
312 auto &p = d.get_request ().get_payload ();
313 p.name_filter_valid = 0;
314 memset (p.name_filter, 0, sizeof (p.name_filter));
315 auto rv = d.execute ();
316 ck_assert_int_eq (VAPI_OK, rv);
317 WAIT_FOR_RESPONSE (d, rv);
318 ck_assert_int_eq (VAPI_OK, rv);
319 ck_assert_int_ne (0, swdcb.called);
320 std::array<Delete_loopback_cb, num_ifs> dcbs;
321 std::array<std::unique_ptr<Delete_loopback>, num_ifs> dlcs;
322 for (int i = 0; i < num_ifs; ++i)
324 Delete_loopback *dl = new Delete_loopback (con, std::ref (dcbs[i]));
326 auto &p = dl->get_request ().get_payload ();
327 p.sw_if_index = ccbs[i].sw_if_index;
328 dcbs[i].sw_if_index = ccbs[i].sw_if_index;
329 auto e = dl->execute ();
330 ck_assert_int_eq (VAPI_OK, e);
335 ck_assert_int_eq (true, x.called);
336 printf ("Deleted loopback with sw_if_index %u\n", x.sw_if_index);
340 Sw_interface_dump d (con);
341 auto &p = d.get_request ().get_payload ();
342 p.name_filter_valid = 0;
343 memset (p.name_filter, 0, sizeof (p.name_filter));
344 auto rv = d.execute ();
345 ck_assert_int_eq (VAPI_OK, rv);
346 WAIT_FOR_RESPONSE (d, rv);
347 ck_assert_int_eq (VAPI_OK, rv);
348 auto &rs = d.get_result_set ();
351 auto &p = r.get_payload ();
352 for (int i = 0; i < num_ifs; ++i)
354 ck_assert_int_ne (ccbs[i].sw_if_index, p.sw_if_index);
362 START_TEST (test_unsupported)
364 printf ("--- Unsupported messages ---\n");
368 Test_fake_msg fake (con);
370 catch (const Msg_not_available_exception &)
373 printf ("Constructing unsupported msg not possible - test pass.\n");
375 ck_assert_int_eq (true, thrown);
379 Test_fake_dump fake (con);
381 catch (const Msg_not_available_exception &)
384 printf ("Constructing unsupported dump not possible - test pass.\n");
386 ck_assert_int_eq (true, thrown);
390 Event_registration<Test_fake_details> fake (con);
392 catch (const Msg_not_available_exception &)
395 printf ("Constructing unsupported event registration not possible - "
398 ck_assert_int_eq (true, thrown);
403 Suite *test_suite (void)
405 Suite *s = suite_create ("VAPI test");
407 TCase *tc_cpp_api = tcase_create ("C++ API");
408 tcase_set_timeout (tc_cpp_api, 25);
409 tcase_add_checked_fixture (tc_cpp_api, setup, teardown);
410 tcase_add_test (tc_cpp_api, test_show_version_1);
411 tcase_add_test (tc_cpp_api, test_show_version_2);
412 tcase_add_test (tc_cpp_api, test_loopbacks_1);
413 tcase_add_test (tc_cpp_api, test_loopbacks_2);
414 tcase_add_test (tc_cpp_api, test_unsupported);
415 suite_add_tcase (s, tc_cpp_api);
420 int main (int argc, char *argv[])
424 printf ("Invalid argc==`%d'\n", argc);
428 api_prefix = argv[2];
429 printf ("App name: `%s', API prefix: `%s'\n", app_name, api_prefix);
436 sr = srunner_create (s);
438 srunner_run_all (sr, CK_NORMAL);
439 number_failed = srunner_ntests_failed (sr);
441 return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
445 * fd.io coding-style-patch-verification: ON
448 * eval: (c-set-style "gnu")