libamxd  6.4.1
Data Model Manager
test_amxd_list_function.c
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 
55 #include <stdlib.h>
56 #include <stdarg.h>
57 #include <stddef.h>
58 #include <setjmp.h>
59 #include <fcntl.h>
60 #include <unistd.h>
61 #include <signal.h>
62 #include <cmocka.h>
63 
64 #include <amxc/amxc.h>
65 #include <amxp/amxp_signal.h>
66 #include <amxp/amxp_slot.h>
67 
68 #include <amxd/amxd_common.h>
69 #include <amxd/amxd_dm.h>
70 #include <amxd/amxd_action.h>
71 #include <amxd/amxd_object.h>
72 #include <amxd/amxd_parameter.h>
73 #include <amxd/amxd_function.h>
74 
75 #include "test_amxd_default_functions.h"
76 
77 void test_amxd_list_function_all(UNUSED void** state) {
78  amxd_object_t* object = NULL;
79  amxd_object_t* template = NULL;
80  amxd_object_t* instance = NULL;
81  amxc_var_t retval;
82  amxc_var_t args;
83  amxc_var_t* part = NULL;
84 
85  amxc_var_init(&args);
86  amxc_var_init(&retval);
87 
88  template = test_build_dm();
89  object = amxd_object_get_child(template, "child");
90  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
91 
92  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
93  assert_int_equal(amxd_object_invoke_function(template, "_list", &args, &retval), 0);
94  amxc_var_dump(&retval, STDOUT_FILENO);
95  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
96  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 4);
97  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
98  assert_ptr_not_equal(part, NULL);
99  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
100  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 4);
101  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
102  assert_ptr_not_equal(part, NULL);
103  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
104  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), TEMPLATE_DEFAULT_FUNCS + 1);
105  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
106  assert_ptr_not_equal(part, NULL);
107  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
108  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
109  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
110  assert_ptr_not_equal(part, NULL);
111  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
112  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
113 
114  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
115  assert_int_equal(amxd_object_invoke_function(instance, "_list", &args, &retval), 0);
116  amxc_var_dump(&retval, STDOUT_FILENO);
117  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
118  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 3);
119  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
120  assert_ptr_not_equal(part, NULL);
121  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
122  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 3);
123  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
124  assert_ptr_not_equal(part, NULL);
125  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
126  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), INSTANCE_DEFAULT_FUNCS + 1);
127  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
128  assert_ptr_not_equal(part, NULL);
129  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
130  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
131  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
132  assert_ptr_equal(part, NULL);
133 
134  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
135  assert_int_equal(amxd_object_invoke_function(object, "_list", &args, &retval), 0);
136  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
137  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 3);
138  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
139  assert_ptr_not_equal(part, NULL);
140  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
141  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 2);
142  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
143  assert_ptr_not_equal(part, NULL);
144  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
145  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), SINGLETON_DEFAULT_FUNCS + 1);
146  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
147  assert_ptr_not_equal(part, NULL);
148  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
149  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 0);
150  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
151  assert_ptr_equal(part, NULL);
152 
153  object = amxd_object_get_child(instance, "child");
154  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
155  assert_int_equal(amxd_object_invoke_function(object, "_list", &args, &retval), 0);
156 
157  amxc_var_clean(&args);
158  amxc_var_clean(&retval);
159  test_clean_dm();
160 }
161 
162 void test_amxd_list_function_all_with_cb(UNUSED void** state) {
163  amxd_object_t* object = NULL;
164  amxd_object_t* template = NULL;
165  amxd_object_t* instance = NULL;
166  amxc_var_t retval;
167  amxc_var_t args;
168  amxc_var_t* part = NULL;
169 
170  amxc_var_init(&args);
171  amxc_var_init(&retval);
172 
173  template = test_build_dm();
174  object = amxd_object_get_child(template, "child");
175  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
176  assert_int_equal(amxd_object_add_action_cb(template, action_object_list, amxd_action_object_list, NULL), 0);
177  assert_int_equal(amxd_object_add_action_cb(object, action_object_list, amxd_action_object_list, NULL), 0);
178 
179  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
180  assert_int_equal(amxd_object_invoke_function(template, "_list", &args, &retval), 0);
181  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
182  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 4);
183  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
184  assert_ptr_not_equal(part, NULL);
185  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
186  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 4);
187  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
188  assert_ptr_not_equal(part, NULL);
189  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
190  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), TEMPLATE_DEFAULT_FUNCS + 1);
191  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
192  assert_ptr_not_equal(part, NULL);
193  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
194  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
195  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
196  assert_ptr_not_equal(part, NULL);
197  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
198  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
199 
200  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
201  assert_int_equal(amxd_object_invoke_function(instance, "_list", &args, &retval), 0);
202  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
203  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 3);
204  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
205  assert_ptr_not_equal(part, NULL);
206  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
207  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 3);
208  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
209  assert_ptr_not_equal(part, NULL);
210  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
211  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), INSTANCE_DEFAULT_FUNCS + 1);
212  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
213  assert_ptr_not_equal(part, NULL);
214  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
215  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
216  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
217  assert_ptr_equal(part, NULL);
218 
219  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
220  assert_int_equal(amxd_object_invoke_function(object, "_list", &args, &retval), 0);
221  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
222  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 3);
223  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
224  assert_ptr_not_equal(part, NULL);
225  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
226  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 2);
227  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
228  assert_ptr_not_equal(part, NULL);
229  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
230  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), SINGLETON_DEFAULT_FUNCS + 1);
231  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
232  assert_ptr_not_equal(part, NULL);
233  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
234  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 0);
235  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
236  assert_ptr_equal(part, NULL);
237 
238  object = amxd_object_get_child(instance, "child");
239  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
240  assert_int_equal(amxd_object_invoke_function(object, "_list", &args, &retval), 0);
241 
242  amxc_var_clean(&args);
243  amxc_var_clean(&retval);
244  test_clean_dm();
245 }
246 
247 void test_amxd_list_function_parts(UNUSED void** state) {
248  amxd_object_t* template = NULL;
249  amxd_object_t* instance = NULL;
250  amxc_var_t retval;
251  amxc_var_t args;
252  amxc_var_t* part = NULL;
253 
254  amxc_var_init(&args);
255  amxc_var_init(&retval);
256 
257  template = test_build_dm();
258  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
259 
260  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
261  amxc_var_add_key(bool, &args, "parameters", true);
262  amxc_var_add_key(bool, &args, "functions", false);
263  amxc_var_add_key(bool, &args, "objects", false);
264  amxc_var_add_key(bool, &args, "instances", false);
265  assert_int_equal(amxd_object_invoke_function(template, "_list", &args, &retval), 0);
266  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
267  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 1);
268  part = amxc_var_get_path(&retval, "parameters", AMXC_VAR_FLAG_DEFAULT);
269  assert_ptr_not_equal(part, NULL);
270  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
271  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 4);
272 
273  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
274  amxc_var_add_key(bool, &args, "parameters", false);
275  amxc_var_add_key(bool, &args, "functions", true);
276  amxc_var_add_key(bool, &args, "objects", false);
277  amxc_var_add_key(bool, &args, "instances", false);
278  assert_int_equal(amxd_object_invoke_function(template, "_list", &args, &retval), 0);
279  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
280  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 1);
281  part = amxc_var_get_path(&retval, "functions", AMXC_VAR_FLAG_DEFAULT);
282  assert_ptr_not_equal(part, NULL);
283  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
284  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), TEMPLATE_DEFAULT_FUNCS + 1);
285 
286  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
287  amxc_var_add_key(bool, &args, "parameters", false);
288  amxc_var_add_key(bool, &args, "functions", false);
289  amxc_var_add_key(bool, &args, "objects", true);
290  amxc_var_add_key(bool, &args, "instances", false);
291  assert_int_equal(amxd_object_invoke_function(template, "_list", &args, &retval), 0);
292  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
293  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 1);
294  part = amxc_var_get_path(&retval, "objects", AMXC_VAR_FLAG_DEFAULT);
295  assert_ptr_not_equal(part, NULL);
296  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
297  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
298 
299  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
300  amxc_var_add_key(bool, &args, "parameters", false);
301  amxc_var_add_key(bool, &args, "functions", false);
302  amxc_var_add_key(bool, &args, "objects", false);
303  amxc_var_add_key(bool, &args, "instances", true);
304  assert_int_equal(amxd_object_invoke_function(template, "_list", &args, &retval), 0);
305  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_HTABLE);
306  assert_int_equal(amxc_htable_size(amxc_var_constcast(amxc_htable_t, &retval)), 1);
307  part = amxc_var_get_path(&retval, "instances", AMXC_VAR_FLAG_DEFAULT);
308  assert_ptr_not_equal(part, NULL);
309  assert_int_equal(amxc_var_type_of(part), AMXC_VAR_ID_LIST);
310  assert_int_equal(amxc_llist_size(amxc_var_constcast(amxc_llist_t, part)), 1);
311 
312  amxc_var_clean(&args);
313  amxc_var_clean(&retval);
314  test_clean_dm();
315 }
amxd_action.h
Ambiorix Data Model Default actions header file.
amxd_common.h
amxd_dm.h
Ambiorix Data Model API header file.
amxd_function.h
Ambiorix Data Model RPC methods API header file.
amxd_object.h
Ambiorix Data Model API header file.
amxd_object_add_action_cb
amxd_status_t amxd_object_add_action_cb(amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn, void *priv)
Definition: amxd_object_action.c:73
amxd_parameter.h
action_object_list
@ action_object_list
Definition: amxd_types.h:120
amxd_action_object_list
amxd_status_t amxd_action_object_list(amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
Default object list action implementation.
amxd_object_get_child
amxd_object_t * amxd_object_get_child(const amxd_object_t *object, const char *name)
Get a child of the object.
Definition: amxd_object_hierarchy.c:299
amxd_object_invoke_function
amxd_status_t amxd_object_invoke_function(amxd_object_t *const object, const char *func_name, amxc_var_t *const args, amxc_var_t *const ret)
Calls an object RPC method.
Definition: amxd_object_function.c:245
amxd_object_new_instance
amxd_status_t amxd_object_new_instance(amxd_object_t **object, amxd_object_t *templ, const char *name, uint32_t index, amxc_var_t *values)
Data model object constructor function.
Definition: amxd_object_instance.c:350
_amxd_object
Definition: amxd_types.h:229
test_build_dm
static amxd_object_t * test_build_dm(void)
Definition: test_amxd_action_object_add.c:116
test_clean_dm
void test_clean_dm(void)
Definition: test_amxd_default_functions.c:204
test_amxd_default_functions.h
SINGLETON_DEFAULT_FUNCS
#define SINGLETON_DEFAULT_FUNCS
Definition: test_amxd_default_functions.h:60
TEMPLATE_DEFAULT_FUNCS
#define TEMPLATE_DEFAULT_FUNCS
Definition: test_amxd_default_functions.h:58
INSTANCE_DEFAULT_FUNCS
#define INSTANCE_DEFAULT_FUNCS
Definition: test_amxd_default_functions.h:59
test_amxd_list_function_parts
void test_amxd_list_function_parts(UNUSED void **state)
Definition: test_amxd_list_function.c:247
test_amxd_list_function_all
void test_amxd_list_function_all(UNUSED void **state)
Definition: test_amxd_list_function.c:77
test_amxd_list_function_all_with_cb
void test_amxd_list_function_all_with_cb(UNUSED void **state)
Definition: test_amxd_list_function.c:162