libamxd  6.4.1
Data Model Manager
test_amxd_action_object_write.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_object.h>
71 #include <amxd/amxd_parameter.h>
72 #include <amxd/amxd_function.h>
73 #include <amxd/amxd_action.h>
74 
76 
77 #include <amxc/amxc_macros.h>
78 static amxd_dm_t dm;
79 
81  amxd_object_t* object = NULL;
82  amxd_object_t* template = NULL;
83  amxd_param_t* param = NULL;
84 
85  assert_int_equal(amxd_dm_init(&dm), 0);
86 
87  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
88  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
89  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "child"), 0);
90  assert_int_equal(amxd_object_add_object(template, object), 0);
91 
92  assert_int_equal(amxd_param_new(&param, "templ_param", AMXC_VAR_ID_CSTRING), 0);
94  assert_int_equal(amxd_object_add_param(template, param), 0);
95  assert_int_equal(amxd_param_new(&param, "inst_param", AMXC_VAR_ID_BOOL), 0);
96  assert_int_equal(amxd_object_add_param(template, param), 0);
97  assert_int_equal(amxd_param_new(&param, "param", AMXC_VAR_ID_UINT32), 0);
100  assert_int_equal(amxd_object_add_param(template, param), 0);
101  assert_int_equal(amxd_param_new(&param, "ro_param", AMXC_VAR_ID_UINT32), 0);
105  assert_int_equal(amxd_object_add_param(template, param), 0);
106 
107  assert_int_equal(amxd_param_new(&param, "child_param", AMXC_VAR_ID_CSTRING), 0);
109  assert_int_equal(amxd_object_add_param(object, param), 0);
110  assert_int_equal(amxd_param_new(&param, "child_param2", AMXC_VAR_ID_BOOL), 0);
111  assert_int_equal(amxd_object_add_param(object, param), 0);
112  assert_int_equal(amxd_param_new(&param, "child_param3", AMXC_VAR_ID_UINT64), 0);
113  assert_int_equal(amxd_object_add_param(object, param), 0);
114 
115  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "PChild"), 0);
116  assert_int_equal(amxd_object_set_attr(object, amxd_oattr_protected, true), 0);
117  assert_int_equal(amxd_object_add_object(template, object), 0);
118 
119  assert_int_equal(amxd_param_new(&param, "child_param", AMXC_VAR_ID_CSTRING), 0);
120  assert_int_equal(amxd_object_add_param(object, param), 0);
121 
122  return template;
123 }
124 
125 void test_amxd_object_write(UNUSED void** state) {
126  amxd_object_t* template = NULL;
127  amxd_object_t* instance = NULL;
128  amxd_object_t* object = NULL;
129  amxc_var_t retval;
130  amxc_var_t args;
131  amxc_var_t* params = NULL;
132 
133  amxc_var_init(&args);
134  amxc_var_init(&retval);
135 
136  template = test_build_dm();
137  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
138  object = amxd_object_get_child(instance, "child");
139 
140  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
141  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
142  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
143  amxc_var_add_key(cstring_t, params, "param", "1234");
144  assert_int_equal(amxd_action_object_write(template, NULL, action_object_write, &args, &retval, NULL), 0);
145  assert_int_not_equal(amxd_action_object_write(template, NULL, action_object_write, NULL, &retval, NULL), 0);
146 
147  amxc_var_set_type(&args, AMXC_VAR_ID_BOOL);
148  assert_int_not_equal(amxd_action_object_write(template, NULL, action_object_write, &args, &retval, NULL), 0);
149 
150  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
151  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
152  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
153  amxc_var_add_key(cstring_t, params, "param", "1234");
154  assert_int_not_equal(amxd_action_object_write(NULL, NULL, action_object_write, &args, &retval, NULL), 0);
155 
156  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
157  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
158  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
159  amxc_var_add_key(cstring_t, params, "param", "1234");
160  assert_int_not_equal(amxd_action_object_write(template, NULL, action_object_list, &args, &retval, NULL), 0);
161 
162  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
163  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
164  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
165  amxc_var_add_key(cstring_t, params, "param", "1234");
166  assert_int_equal(amxd_action_object_write(template, NULL, action_object_write, &args, NULL, NULL), 0);
167 
168  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
169  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
170  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
171  amxc_var_add_key(cstring_t, params, "param", "1234");
172  assert_int_equal(amxd_action_object_write(template, NULL, action_object_write, &args, &retval, NULL), 0);
173 
174  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
175  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
176  params = amxc_var_add_key(amxc_htable_t, params, "1", NULL);
177  amxc_var_add_key(cstring_t, params, "inst_param", "True");
178  amxc_var_add_key(cstring_t, params, "param", "1234");
179  assert_int_equal(amxd_action_object_write(template, NULL, action_object_write, &args, &retval, NULL), 0);
180 
181  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
182  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
183  params = amxc_var_add_key(amxc_htable_t, params, "1", NULL);
184  amxc_var_add_key(cstring_t, params, "inst_param", "TEST DATA");
185  amxc_var_add_key(cstring_t, params, "param", "1234");
186  assert_int_not_equal(amxd_action_object_write(template, NULL, action_object_write, &args, &retval, NULL), 0);
187 
188  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
189  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
190  params = amxc_var_add_key(amxc_htable_t, params, "303", NULL);
191  amxc_var_add_key(bool, params, "inst_param", true);
192  amxc_var_add_key(cstring_t, params, "param", "1234");
193  assert_int_not_equal(amxd_action_object_write(template, NULL, action_object_write, &args, &retval, NULL), 0);
194 
195  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
196  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
197  params = amxc_var_add_key(amxc_htable_t, params, "303", NULL);
198  amxc_var_add_key(bool, params, "inst_param", true);
199  amxc_var_add_key(cstring_t, params, "param", "1234");
200  assert_int_not_equal(amxd_action_object_write(instance, NULL, action_object_write, &args, &retval, NULL), 0);
201 
202  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
203  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
204  amxc_var_add_key(uint32_t, params, "ro_param", 99);
205  assert_int_not_equal(amxd_action_object_write(instance, NULL, action_object_write, &args, &retval, NULL), 0);
206 
207  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
208  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
209  amxc_var_add_key(uint32_t, params, "ro_param", 99);
210  amxc_var_add_key(bool, &args, "set_read_only", true);
211  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_private);
212  assert_int_equal(amxd_action_object_write(instance, NULL, action_object_write, &args, &retval, NULL), 0);
213 
214  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
215  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
216  amxc_var_add_key(uint32_t, params, "child_param", 99);
217  amxc_var_add_key(bool, &args, "set_read_only", true);
218  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_private);
219  assert_int_equal(amxd_action_object_write(object, NULL, action_object_write, &args, &retval, NULL), 0);
220 
221  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
222  params = amxc_var_add_key(amxc_htable_t, &args, "oparameters", NULL);
223  amxc_var_add_key(uint32_t, params, "child_param", 19);
224  amxc_var_add_key(bool, &args, "set_read_only", true);
225  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_private);
226  assert_int_equal(amxd_action_object_write(object, NULL, action_object_write, &args, &retval, NULL), 0);
227 
228  object = amxd_object_get_child(instance, "PChild");
229  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
230  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
231  amxc_var_add_key(uint32_t, params, "child_param", 99);
232  amxc_var_add_key(bool, &args, "set_read_only", true);
233  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_public);
234  assert_int_not_equal(amxd_action_object_write(object, NULL, action_object_write, &args, &retval, NULL), 0);
235 
236  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
237  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
238  amxc_var_add_key(uint32_t, params, "child_param", 99);
239  amxc_var_add_key(bool, &args, "set_read_only", true);
240  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_protected);
241  assert_int_equal(amxd_action_object_write(object, NULL, action_object_write, &args, &retval, NULL), 0);
242 
243  amxc_var_clean(&args);
244  amxc_var_clean(&retval);
245  amxd_dm_clean(&dm);
246 }
247 
248 void test_amxd_object_write_with_cb(UNUSED void** state) {
249  amxd_object_t* template = NULL;
250  amxd_object_t* instance = NULL;
251  amxc_var_t retval;
252  amxc_var_t args;
253  amxc_var_t* params = NULL;
254 
255  amxc_var_init(&args);
256  amxc_var_init(&retval);
257 
258  template = test_build_dm();
259  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
260  assert_int_equal(amxd_object_add_action_cb(template, action_object_write, amxd_action_object_write, NULL), 0);
261 
262  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
263  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
264  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
265  amxc_var_add_key(cstring_t, params, "param", "1234");
266  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, &retval), 0);
267  assert_int_not_equal(amxd_dm_invoke_action(template, NULL, action_object_write, NULL, &retval), 0);
268 
269  amxc_var_set_type(&args, AMXC_VAR_ID_BOOL);
270  assert_int_not_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, &retval), 0);
271 
272  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
273  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
274  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
275  amxc_var_add_key(cstring_t, params, "param", "1234");
276  assert_int_not_equal(amxd_dm_invoke_action(NULL, NULL, action_object_write, &args, &retval), 0);
277 
278  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
279  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
280  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
281  amxc_var_add_key(cstring_t, params, "param", "1234");
282  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, NULL), 0);
283 
284  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
285  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
286  amxc_var_add_key(cstring_t, params, "templ_param", "Test Data");
287  amxc_var_add_key(cstring_t, params, "param", "1234");
288  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, &retval), 0);
289 
290  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
291  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
292  params = amxc_var_add_key(amxc_htable_t, params, "1", NULL);
293  amxc_var_add_key(cstring_t, params, "inst_param", "True");
294  amxc_var_add_key(cstring_t, params, "param", "1234");
295  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, &retval), 0);
296 
297  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
298  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
299  params = amxc_var_add_key(amxc_htable_t, params, "1", NULL);
300  amxc_var_add_key(cstring_t, params, "inst_param", "TEST DATA");
301  amxc_var_add_key(cstring_t, params, "param", "1234");
302  assert_int_not_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, &retval), 0);
303 
304  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
305  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
306  params = amxc_var_add_key(amxc_htable_t, params, "303", NULL);
307  amxc_var_add_key(bool, params, "inst_param", true);
308  amxc_var_add_key(cstring_t, params, "param", "1234");
309  assert_int_not_equal(amxd_dm_invoke_action(template, NULL, action_object_write, &args, &retval), 0);
310 
311  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
312  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
313  params = amxc_var_add_key(amxc_htable_t, params, "303", NULL);
314  amxc_var_add_key(bool, params, "inst_param", true);
315  amxc_var_add_key(cstring_t, params, "param", "1234");
316  assert_int_not_equal(amxd_dm_invoke_action(instance, NULL, action_object_write, &args, &retval), 0);
317 
318  amxc_var_clean(&args);
319  amxc_var_clean(&retval);
320  amxd_dm_clean(&dm);
321 }
Ambiorix Data Model Default actions header file.
amxd_status_t amxd_action_object_write(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)
Ambiorix Data Model API header file.
amxd_status_t amxd_dm_invoke_action(amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval)
Definition: amxd_dm.c:591
Ambiorix Data Model RPC methods API header file.
Ambiorix Data Model API header file.
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)
amxd_status_t amxd_param_new(amxd_param_t **param, const char *name, const uint32_t type)
amxd_status_t amxd_param_set_attr(amxd_param_t *param, const amxd_pattr_id_t attr, const bool enable)
@ amxd_pattr_template
Definition: amxd_types.h:355
@ amxd_pattr_private
Definition: amxd_types.h:357
@ amxd_pattr_instance
Definition: amxd_types.h:356
@ amxd_pattr_read_only
Definition: amxd_types.h:358
@ action_object_write
Definition: amxd_types.h:118
@ action_object_list
Definition: amxd_types.h:120
@ amxd_oattr_protected
Definition: amxd_types.h:210
@ amxd_dm_access_private
Definition: amxd_types.h:141
@ amxd_dm_access_protected
Definition: amxd_types.h:139
@ amxd_dm_access_public
Definition: amxd_types.h:136
@ amxd_object_template
Definition: amxd_types.h:183
@ amxd_object_singleton
Definition: amxd_types.h:181
amxd_status_t amxd_dm_add_root_object(amxd_dm_t *const dm, amxd_object_t *const object)
Adds an object to the root of the data model.
Definition: amxd_dm.c:418
amxd_status_t amxd_dm_init(amxd_dm_t *dm)
Initializes a data model structure.
Definition: amxd_dm.c:334
void amxd_dm_clean(amxd_dm_t *dm)
Cleans a data model structure.
Definition: amxd_dm.c:365
amxd_object_t * amxd_object_get_child(const amxd_object_t *object, const char *name)
Get a child of the object.
amxd_status_t amxd_object_add_object(amxd_object_t *const parent, amxd_object_t *const child)
Adds an object in the data model tree.
Definition: amxd_object.c:207
amxd_status_t amxd_object_add_param(amxd_object_t *const object, amxd_param_t *const param)
Adds a parameter definition to an object.
amxd_status_t amxd_object_set_attr(amxd_object_t *const object, const amxd_oattr_id_t attr, const bool enable)
Sets or unsets an object attribute.
Definition: amxd_object.c:269
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.
amxd_status_t amxd_object_new(amxd_object_t **object, const amxd_object_type_t type, const char *name)
Data model object constructor function.
Definition: amxd_object.c:185
static amxd_dm_t dm
void test_amxd_object_write_with_cb(UNUSED void **state)
void test_amxd_object_write(UNUSED void **state)
static amxd_object_t * test_build_dm(void)