libamxd  6.4.1
Data Model Manager
test_amxd_recursive_action.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 
75 #include "amxd_priv.h"
76 #include "amxd_object_priv.h"
78 
79 #include <amxc/amxc_macros.h>
80 static amxd_dm_t dm;
81 static amxd_object_t* test_parent = NULL;
82 
84  UNUSED amxd_param_t* const param,
85  UNUSED amxd_action_t reason,
86  UNUSED const amxc_var_t* const args,
87  UNUSED amxc_var_t* const retval,
88  UNUSED void* priv) {
89  amxd_object_t* child = amxd_object_get_child(object, "child");
90  assert_ptr_not_equal(child, NULL);
91  amxd_status_t status = amxd_object_set_value(cstring_t, child, "param", "Hello world");
92  assert_int_not_equal(status, 0);
93 
94  return status;
95 }
96 
98  UNUSED amxd_param_t* const param,
99  amxd_action_t reason,
100  const amxc_var_t* const args,
101  UNUSED amxc_var_t* const retval,
102  UNUSED void* priv) {
103  amxd_object_t* child = amxd_object_findf(object, "1.subtempl");
104  assert_ptr_not_equal(child, NULL);
105  amxd_status_t status = amxd_dm_invoke_action(child, NULL, reason, args, NULL);
106  assert_int_equal(status, 0);
107 
108  return status;
109 }
110 
112  UNUSED amxd_param_t* const param,
113  amxd_action_t reason,
114  const amxc_var_t* const args,
115  UNUSED amxc_var_t* const retval,
116  UNUSED void* priv) {
118  if(parent == NULL) {
119  parent = test_parent;
120  }
121  assert_ptr_not_equal(parent, NULL);
122  amxd_status_t status = amxd_dm_invoke_action(parent, NULL, reason, args, NULL);
123  assert_int_not_equal(status, 0);
124 
125  return status;
126 }
127 
128 void test_amxd_object_recursive_set(UNUSED void** state) {
129  amxd_object_t* object = NULL;
130  amxd_object_t* child = NULL;
131  amxd_param_t* param = NULL;
132 
133  assert_int_equal(amxd_dm_init(&dm), 0);
134 
135  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "parent"), 0);
136  assert_int_equal(amxd_dm_add_root_object(&dm, object), 0);
137  assert_int_equal(amxd_object_new(&child, amxd_object_singleton, "child"), 0);
138  assert_int_equal(amxd_object_add_object(object, child), 0);
139  assert_int_equal(amxd_param_new(&param, "param", AMXC_VAR_ID_CSTRING), 0);
140  assert_int_equal(amxd_object_add_param(child, param), 0);
141  assert_int_equal(amxd_object_add_action_cb(object, action_object_write, amxd_action_dummy_write_cb, NULL), 0);
142 
143  assert_int_not_equal(amxd_object_set_value(cstring_t, object, "dummy", "dummy value"), 0);
144 
145  amxd_dm_clean(&dm);
146 }
147 
148 void test_amxd_object_recursive_del_inst_valid(UNUSED void** state) {
149  amxd_object_t* child = NULL;
150  amxd_object_t* template = NULL;
151  amxd_object_t* instance = NULL;
152  amxc_var_t args;
153 
154  amxc_var_init(&args);
155 
156  assert_int_equal(amxd_dm_init(&dm), 0);
157 
158  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
159  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
160  assert_int_equal(amxd_object_new(&child, amxd_object_template, "subtempl"), 0);
161  assert_int_equal(amxd_object_add_object(template, child), 0);
162  assert_int_equal(amxd_object_add_action_cb(template, action_object_del_inst, amxd_action_dummy_cb, NULL), 0);
163 
164  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
165  template = amxd_object_get_child(instance, "subtempl");
166  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
167 
168  template = amxd_dm_findf(&dm, "parent");
169  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
170  amxc_var_add_key(uint32_t, &args, "index", 1);
171  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_del_inst, &args, NULL), 0);
172  instance = amxd_object_findf(template, "1");
173  assert_non_null(instance);
174  assert_int_equal(amxd_dm_invoke_action(instance, NULL, action_object_destroy, NULL, NULL), 0);
175  assert_null(amxd_object_findf(template, "1"));
176 
177  amxc_var_clean(&args);
178  amxd_dm_clean(&dm);
179 }
180 
182  amxd_object_t* child = NULL;
183  amxd_object_t* template = NULL;
184  amxd_object_t* instance = NULL;
185  amxc_var_t args;
186 
187  amxc_var_init(&args);
188 
189  assert_int_equal(amxd_dm_init(&dm), 0);
190 
191  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
192  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
193  assert_int_equal(amxd_object_new(&child, amxd_object_template, "subtempl"), 0);
194  assert_int_equal(amxd_object_add_object(template, child), 0);
195  assert_int_equal(amxd_object_add_action_cb(child, action_object_del_inst, amxd_action_invalid_cb, NULL), 0);
196 
197  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
198  template = amxd_object_get_child(instance, "subtempl");
199  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
200 
201  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
202  amxc_var_add_key(uint32_t, &args, "index", 1);
203  assert_int_not_equal(amxd_dm_invoke_action(template, NULL, action_object_del_inst, &args, NULL), 0);
204  assert_non_null(amxd_object_findf(template, "1."));
205 
206  amxc_var_clean(&args);
207  amxd_dm_clean(&dm);
208 }
209 
210 void test_amxd_object_recursive_destroy_valid(UNUSED void** state) {
211  amxd_object_t* child = NULL;
212  amxd_object_t* template = NULL;
213  amxd_object_t* instance = NULL;
214  amxc_var_t args;
215 
216  amxc_var_init(&args);
217 
218  assert_int_equal(amxd_dm_init(&dm), 0);
219 
220  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
221  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
222  assert_int_equal(amxd_object_new(&child, amxd_object_template, "subtempl"), 0);
223  assert_int_equal(amxd_object_add_object(template, child), 0);
224  assert_int_equal(amxd_object_add_action_cb(template, action_object_del_inst, amxd_action_dummy_cb, NULL), 0);
225 
226  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
227  template = amxd_object_get_child(instance, "subtempl");
228  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
229 
230  template = amxd_dm_findf(&dm, "parent");
231  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
232  amxc_var_add_key(uint32_t, &args, "index", 1);
233  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_destroy, &args, NULL), 0);
234  assert_null(amxd_dm_findf(&dm, "parent"));
235 
236  amxc_var_clean(&args);
237  amxd_dm_clean(&dm);
238 }
239 
241  amxd_object_t* child = NULL;
242  amxd_object_t* template = NULL;
243  amxd_object_t* instance = NULL;
244  amxc_var_t args;
245 
246  amxc_var_init(&args);
247 
248  assert_int_equal(amxd_dm_init(&dm), 0);
249 
250  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
251  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
252  assert_int_equal(amxd_object_new(&child, amxd_object_template, "subtempl"), 0);
253  assert_int_equal(amxd_object_add_object(template, child), 0);
254  assert_int_equal(amxd_object_add_action_cb(child, action_object_destroy, amxd_action_invalid_cb, NULL), 0);
255  assert_int_equal(amxd_object_new(&test_parent, amxd_object_singleton, "test_parent"), 0);
256  assert_int_equal(amxd_dm_add_root_object(&dm, test_parent), 0);
257 
258  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
259  template = amxd_object_get_child(instance, "subtempl");
260  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 1, NULL), 0);
261 
262  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
263  amxc_var_add_key(uint32_t, &args, "index", 1);
264  assert_int_equal(amxd_dm_invoke_action(template, NULL, action_object_destroy, &args, NULL), 0);
265  assert_null(amxd_dm_findf(&dm, "parent.1.subtempl."));
266 
267  amxc_var_clean(&args);
268  amxd_dm_clean(&dm);
269 }
Ambiorix Data Model Default actions header file.
Ambiorix Data Model API header file.
amxd_object_t * amxd_dm_findf(amxd_dm_t *const dm, const char *abs_path,...) __attribute__((format(printf
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)
@ action_object_write
Definition: amxd_types.h:118
@ action_object_del_inst
Definition: amxd_types.h:124
@ action_object_destroy
Definition: amxd_types.h:125
enum _amxd_action amxd_action_t
enum _amxd_status amxd_status_t
@ 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_parent(const amxd_object_t *const object)
Get the parent object.
amxd_object_t * amxd_object_get_child(const amxd_object_t *object, const char *name)
Get a child of the object.
amxd_object_t * amxd_object_findf(amxd_object_t *object, const char *rel_path,...) __attribute__((format(printf
Find an object in the data model tree, starting from an 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
#define amxd_object_set_value(type, object, name, value)
Helper macro for setting a value.
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_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_status_t status
void test_amxd_object_recursive_del_inst_valid(UNUSED void **state)
void test_amxd_object_recursive_set(UNUSED void **state)
static amxd_dm_t dm
void test_amxd_object_recursive_del_inst_invalid(UNUSED void **state)
void test_amxd_object_recursive_destroy_invalid(UNUSED void **state)
static amxd_status_t amxd_action_dummy_write_cb(amxd_object_t *const object, UNUSED amxd_param_t *const param, UNUSED amxd_action_t reason, UNUSED const amxc_var_t *const args, UNUSED amxc_var_t *const retval, UNUSED void *priv)
static amxd_status_t amxd_action_invalid_cb(amxd_object_t *object, UNUSED amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, UNUSED amxc_var_t *const retval, UNUSED void *priv)
void test_amxd_object_recursive_destroy_valid(UNUSED void **state)
static amxd_status_t amxd_action_dummy_cb(amxd_object_t *object, UNUSED amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, UNUSED amxc_var_t *const retval, UNUSED void *priv)
static amxd_object_t * test_parent