libamxd  6.4.1
Data Model Manager
test_amxd_action_object_del.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 
102  assert_int_equal(amxd_param_new(&param, "child_param", AMXC_VAR_ID_CSTRING), 0);
104  assert_int_equal(amxd_object_add_param(object, param), 0);
105  assert_int_equal(amxd_param_new(&param, "child_param2", AMXC_VAR_ID_BOOL), 0);
106  assert_int_equal(amxd_object_add_param(object, param), 0);
107  assert_int_equal(amxd_param_new(&param, "child_param3", AMXC_VAR_ID_UINT64), 0);
108  assert_int_equal(amxd_object_add_param(object, param), 0);
109 
110  return template;
111 }
112 
113 void test_amxd_object_del(UNUSED void** state) {
114  amxd_object_t* template = NULL;
115  amxd_object_t* instance = NULL;
116  amxc_var_t retval;
117  amxc_var_t args;
118 
119  amxc_var_init(&args);
120  amxc_var_init(&retval);
121 
122  template = test_build_dm();
123  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
124  assert_int_equal(amxd_object_new_instance(&instance, template, "TestInst1", 2, NULL), 0);
125  assert_int_equal(amxd_object_new_instance(&instance, template, "TestInst2", 0, NULL), 0);
126  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 10, NULL), 0);
127 
128  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
129  assert_int_not_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, &retval, NULL), 0);
130  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_NULL);
131 
132  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
133  amxc_var_add_key(uint32_t, &args, "index", 1);
134  assert_int_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, &retval, NULL), 0);
135  assert_int_equal(amxc_var_type_of(&retval), AMXC_VAR_ID_NULL);
136  instance = amxd_object_get_instance(template, NULL, 1);
137  assert_ptr_not_equal(instance, NULL);
138  assert_int_equal(amxd_action_object_destroy(instance, NULL, action_object_destroy, &args, &retval, NULL), 0);
139  instance = amxd_object_get_instance(template, NULL, 1);
140  assert_ptr_not_equal(instance, NULL);
141  amxd_object_delete(&instance);
142 
143  amxd_object_set_attr(template, amxd_oattr_read_only, false);
144  amxd_object_set_attr(template, amxd_oattr_private, true);
145  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
146  amxc_var_add_key(cstring_t, &args, "name", "TestInst1");
147  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_protected);
148  amxc_var_add_key(bool, &args, "set_read_only", false);
149  assert_int_not_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, &retval, NULL), 0);
150  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
151  amxc_var_add_key(cstring_t, &args, "name", "TestInst1");
152  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_private);
153  amxc_var_add_key(bool, &args, "set_read_only", false);
154  assert_int_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, &retval, NULL), 0);
155  instance = amxd_object_get_instance(template, "TestInst1", 0);
156  assert_ptr_not_equal(instance, NULL);
157  amxd_object_delete(&instance);
158  assert_ptr_equal(instance, NULL);
159  instance = amxd_object_get_instance(template, "TestInst1", 0);
160  assert_ptr_equal(instance, NULL);
161 
163  amxd_object_set_attr(template, amxd_oattr_private, false);
164  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
165  amxc_var_add_key(uint32_t, &args, "index", 3);
166  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_protected);
167  amxc_var_add_key(bool, &args, "set_read_only", false);
168  assert_int_not_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, &retval, NULL), 0);
169  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
170  amxc_var_add_key(uint32_t, &args, "index", 3);
171  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_protected);
172  amxc_var_add_key(bool, &args, "set_read_only", true);
173  assert_int_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, &retval, NULL), 0);
174  instance = amxd_object_get_instance(template, NULL, 3);
175  assert_ptr_not_equal(instance, NULL);
176  amxd_object_delete(&instance);
177  instance = amxd_object_get_instance(template, NULL, 3);
178  assert_ptr_equal(instance, NULL);
179 
180  amxd_object_set_attr(template, amxd_oattr_read_only, false);
181  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
182  amxc_var_add_key(uint32_t, &args, "index", 10);
183  assert_int_not_equal(amxd_action_object_del_inst(NULL, NULL, action_object_del_inst, &args, &retval, NULL), 0);
184  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
185  amxc_var_add_key(uint32_t, &args, "index", 10);
186  assert_int_not_equal(amxd_action_object_del_inst(template, NULL, action_object_write, &args, &retval, NULL), 0);
187  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
188  amxc_var_add_key(uint32_t, &args, "index", 10);
189  assert_int_not_equal(amxd_action_object_del_inst(template, NULL, action_object_list, &args, &retval, NULL), 0);
190  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
191  amxc_var_add_key(uint32_t, &args, "index", 10);
192  assert_int_equal(amxd_action_object_del_inst(template, NULL, action_object_del_inst, &args, NULL, NULL), 0);
193  instance = amxd_object_get_instance(template, NULL, 10);
194  assert_ptr_not_equal(instance, NULL);
195  amxd_object_delete(&instance);
196  instance = amxd_object_get_instance(template, NULL, 10);
197  assert_ptr_equal(instance, NULL);
198 
199  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
200  assert_int_equal(amxd_action_object_destroy(NULL, NULL, action_object_destroy, &args, &retval, NULL), 0);
201  assert_int_equal(amxd_action_object_destroy(instance, NULL, action_object_destroy, &args, NULL, NULL), 0);
202  assert_int_not_equal(amxd_action_object_destroy(instance, NULL, action_object_read, &args, &retval, NULL), 0);
203 
204  amxc_var_clean(&args);
205  amxc_var_clean(&retval);
206  amxd_dm_clean(&dm);
207 }
208 
209 static amxd_object_t* build_child(amxd_object_t* parent, int* depth) {
210  amxd_object_t* object = NULL;
211  amxd_param_t* param = NULL;
212  amxc_string_t name;
213 
214  amxc_string_init(&name, 0);
215 
216  *depth = (*depth) + 1;
217  amxc_string_setf(&name, "Child_L%d", *depth);
218  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, amxc_string_get(&name, 0)), 0);
219  assert_int_equal(amxd_object_add_object(parent, object), 0);
220 
221  amxc_string_setf(&name, "param_L%d", (*depth) + 1);
222  assert_int_equal(amxd_param_new(&param, amxc_string_get(&name, 0), AMXC_VAR_ID_UINT32), 0);
223  assert_int_equal(amxd_object_add_param(object, param), 0);
224 
225  amxc_string_clean(&name);
226  return object;
227 }
228 
229 static amxd_object_t* test_build_dm_deep(int add_depth) {
230  amxd_object_t* root = NULL;
231  amxd_object_t* parent = NULL;
232  amxd_object_t* template = NULL;
233 
234  int depth = 0;
235  assert_int_equal(amxd_dm_init(&dm), 0);
236 
237  // object MyRoot: depth level 0
238  assert_int_equal(amxd_object_new(&root, amxd_object_singleton, "MyRoot"), 0);
239  assert_int_equal(amxd_dm_add_root_object(&dm, root), 0);
240 
241  // object Main.MyTemplate[] : depth level 1
242  depth++;
243  assert_int_equal(amxd_object_new(&template, amxd_object_template, "MyTemplate"), 0);
244  assert_int_equal(amxd_object_add_object(root, template), 0);
245 
246  // objects hierarchy Main.Template_L1.Instance_L2.Child_L3.Child_Ln+1.Child_Ln+2...
247  int depth_childs = depth + 1;
248  parent = template;
249  for(; depth_childs <= (depth + 1 + add_depth);) {
250  parent = build_child(parent, &depth_childs);
251  }
252 
253  return template;
254 }
255 
256 void test_amxd_object_del_recursive_deep(UNUSED void** state) {
257  amxd_object_t* object = NULL;
258  amxd_object_t* template = NULL;
259  amxd_object_t* instance = NULL;
260 
261  // create 100 levels depth object hierarchy
262  template = test_build_dm_deep(100);
263 
264  //object two instances (Level 2) of Main.Template_L1
265  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
266  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
267 
268  object = amxd_dm_findf(&dm, "MyRoot.MyTemplate.2.Child_L3.Child_L4");
269  assert_non_null(object);
270 
271  object = amxd_dm_findf(&dm, "MyRoot.MyTemplate");
272  assert_non_null(object);
273 
274  amxd_object_delete(&object);
275  assert_null(object);
276 
277  object = amxd_dm_findf(&dm, "MyRoot.MyTemplate.1.Child_L3");
278  assert_null(object);
279 
280  amxd_dm_clean(&dm);
281 }
Ambiorix Data Model Default actions header file.
amxd_status_t amxd_action_object_del_inst(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_object_t * amxd_dm_findf(amxd_dm_t *const dm, const char *abs_path,...) __attribute__((format(printf
Ambiorix Data Model RPC methods API header file.
Ambiorix Data Model API header file.
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
@ action_object_write
Definition: amxd_types.h:118
@ action_object_del_inst
Definition: amxd_types.h:124
@ action_object_read
Definition: amxd_types.h:117
@ action_object_list
Definition: amxd_types.h:120
@ action_object_destroy
Definition: amxd_types.h:125
@ amxd_oattr_read_only
Definition: amxd_types.h:199
@ amxd_oattr_private
Definition: amxd_types.h:202
@ amxd_dm_access_private
Definition: amxd_types.h:141
@ amxd_dm_access_protected
Definition: amxd_types.h:139
@ 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_status_t amxd_action_object_destroy(amxd_object_t *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 destroy action implementation.
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_object_t * amxd_object_get_instance(const amxd_object_t *object, const char *name, uint32_t index)
Get an instance of the template object.
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
void amxd_object_delete(amxd_object_t **object)
Invokes the destroy handler(s) of the object.
static amxd_object_t * build_child(amxd_object_t *parent, int *depth)
static amxd_dm_t dm
void test_amxd_object_del_recursive_deep(UNUSED void **state)
void test_amxd_object_del(UNUSED void **state)
static amxd_object_t * test_build_dm_deep(int add_depth)
static amxd_object_t * test_build_dm(void)