libamxd  6.4.1
Data Model Manager
test_amxd_default_functions.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 #include <amxd/amxd_transaction.h>
75 
77 
78 #include <amxc/amxc_macros.h>
79 static amxd_dm_t dm;
80 
81 static amxd_status_t test_func(UNUSED amxd_object_t* object,
82  UNUSED amxd_function_t* func,
83  UNUSED amxc_var_t* args,
84  UNUSED amxc_var_t* ret) {
85 
86  return amxd_status_ok;
87 }
88 
90  amxd_object_t* object = NULL;
91  amxd_object_t* template = NULL;
92  amxd_param_t* param = NULL;
93  amxd_function_t* func = NULL;
94 
95  assert_int_equal(amxd_dm_init(&dm), 0);
96 
97  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
98  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
99  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "child"), 0);
100  assert_int_equal(amxd_object_add_object(template, object), 0);
101 
102  assert_int_equal(amxd_param_new(&param, "templ_param", AMXC_VAR_ID_CSTRING), 0);
104  assert_int_equal(amxd_object_add_param(template, param), 0);
105  assert_int_equal(amxd_param_new(&param, "inst_param", AMXC_VAR_ID_BOOL), 0);
106  assert_int_equal(amxd_object_add_param(template, param), 0);
107  assert_int_equal(amxd_param_new(&param, "param", AMXC_VAR_ID_UINT32), 0);
110  assert_int_equal(amxd_object_add_param(template, param), 0);
111  assert_int_equal(amxd_param_new(&param, "Alias", AMXC_VAR_ID_CSTRING), 0);
112  amxd_param_set_attr(param, amxd_pattr_key, true);
114  assert_int_equal(amxd_object_add_param(template, param), 0);
115 
116  assert_int_equal(amxd_function_new(&func, "test_func", AMXC_VAR_ID_HTABLE, test_func), 0);
117  assert_int_equal(amxd_function_set_attr(func, amxd_fattr_template, true), 0);
118  assert_int_equal(amxd_function_set_attr(func, amxd_fattr_instance, true), 0);
119  assert_int_equal(amxd_function_new_arg(func, "arg1", AMXC_VAR_ID_BOOL, NULL), 0);
120  assert_int_equal(amxd_function_new_arg(func, "arg2", AMXC_VAR_ID_BOOL, NULL), 0);
121  assert_int_equal(amxd_object_add_function(template, func), 0);
122 
123  assert_int_equal(amxd_param_new(&param, "child_param", AMXC_VAR_ID_CSTRING), 0);
125  assert_int_equal(amxd_object_add_param(object, param), 0);
126  assert_int_equal(amxd_param_new(&param, "child_param2", AMXC_VAR_ID_BOOL), 0);
127  assert_int_equal(amxd_object_add_param(object, param), 0);
128  assert_int_equal(amxd_param_new(&param, "child_param3", AMXC_VAR_ID_UINT64), 0);
129  assert_int_equal(amxd_object_add_param(object, param), 0);
130 
131  assert_int_equal(amxd_function_new(&func, "test_func", AMXC_VAR_ID_HTABLE, test_func), 0);
132  assert_int_equal(amxd_function_set_attr(func, amxd_fattr_template, true), 0);
133  assert_int_equal(amxd_function_set_attr(func, amxd_fattr_instance, true), 0);
134  assert_int_equal(amxd_function_new_arg(func, "arg1", AMXC_VAR_ID_BOOL, NULL), 0);
135  assert_int_equal(amxd_function_new_arg(func, "arg2", AMXC_VAR_ID_BOOL, NULL), 0);
136  assert_int_equal(amxd_object_add_function(object, func), 0);
137 
138  return template;
139 }
140 
142  amxd_object_t* object = NULL;
143  amxd_object_t* template = NULL;
144  amxd_param_t* param = NULL;
145  amxd_trans_t trans;
146 
147  assert_int_equal(amxd_trans_init(&trans), 0);
148  assert_int_equal(amxd_dm_init(&dm), 0);
149 
150  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "MyRoot"), 0);
151  assert_int_equal(amxd_dm_add_root_object(&dm, object), 0);
152 
153  assert_int_equal(amxd_param_new(&param, "MyParam1", AMXC_VAR_ID_CSTRING), 0);
154  assert_int_equal(amxd_object_add_param(object, param), 0);
155  assert_int_equal(amxd_param_new(&param, "MyParam2", AMXC_VAR_ID_BOOL), 0);
156  assert_int_equal(amxd_object_add_param(object, param), 0);
157  assert_int_equal(amxd_param_new(&param, "MyParam3", AMXC_VAR_ID_UINT32), 0);
158  assert_int_equal(amxd_object_add_param(object, param), 0);
159 
160  assert_int_equal(amxd_object_new(&template, amxd_object_template, "MyChild"), 0);
161  assert_int_equal(amxd_object_add_object(object, template), 0);
162 
163  assert_int_equal(amxd_param_new(&param, "MyParam1", AMXC_VAR_ID_CSTRING), 0);
164  assert_int_equal(amxd_object_add_param(template, param), 0);
165  assert_int_equal(amxd_param_new(&param, "MyParam2", AMXC_VAR_ID_BOOL), 0);
166  assert_int_equal(amxd_object_add_param(template, param), 0);
167  assert_int_equal(amxd_param_new(&param, "MyParam3", AMXC_VAR_ID_UINT32), 0);
168  assert_int_equal(amxd_object_add_param(template, param), 0);
169  assert_int_equal(amxd_param_new(&param, "Alias", AMXC_VAR_ID_CSTRING), 0);
170  amxd_param_set_attr(param, amxd_pattr_key, true);
172  assert_int_equal(amxd_object_add_param(template, param), 0);
173 
174  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "SubChild"), 0);
175  assert_int_equal(amxd_object_add_object(template, object), 0);
176 
177  assert_int_equal(amxd_param_new(&param, "MyParam1", AMXC_VAR_ID_CSTRING), 0);
178  assert_int_equal(amxd_object_add_param(object, param), 0);
179  assert_int_equal(amxd_param_new(&param, "MyParam2", AMXC_VAR_ID_BOOL), 0);
180  assert_int_equal(amxd_object_add_param(object, param), 0);
181  assert_int_equal(amxd_param_new(&param, "MyParam3", AMXC_VAR_ID_UINT32), 0);
182  assert_int_equal(amxd_object_add_param(object, param), 0);
183 
184  assert_int_equal(amxd_object_new(&template, amxd_object_template, "SubTemplate"), 0);
185  assert_int_equal(amxd_object_add_object(object, template), 0);
186 
187  assert_int_equal(amxd_param_new(&param, "MyParam1", AMXC_VAR_ID_CSTRING), 0);
188  assert_int_equal(amxd_object_add_param(template, param), 0);
189  assert_int_equal(amxd_param_new(&param, "MyParam2", AMXC_VAR_ID_BOOL), 0);
190  assert_int_equal(amxd_object_add_param(template, param), 0);
191  assert_int_equal(amxd_param_new(&param, "MyParam3", AMXC_VAR_ID_UINT32), 0);
192  assert_int_equal(amxd_object_add_param(template, param), 0);
193 
194  amxd_trans_select_pathf(&trans, "MyRoot.MyChild");
195  amxd_trans_add_inst(&trans, 0, NULL);
196  amxd_trans_select_pathf(&trans, ".SubChild.SubTemplate");
197  amxd_trans_add_inst(&trans, 0, NULL);
198  assert_int_equal(amxd_trans_apply(&trans, &dm), 0);
199  amxd_trans_clean(&trans);
200 
201  return amxd_dm_findf(&dm, "MyRoot");
202 }
203 
204 void test_clean_dm(void) {
205  amxd_dm_clean(&dm);
206 }
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
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)
Ambiorix Data Model API header file.
@ 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_unique
Definition: amxd_types.h:363
@ amxd_pattr_key
Definition: amxd_types.h:362
enum _amxd_status amxd_status_t
@ amxd_status_ok
Definition: amxd_types.h:78
@ amxd_fattr_template
Definition: amxd_types.h:311
@ amxd_fattr_instance
Definition: amxd_types.h:312
@ 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_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_add_function(amxd_object_t *const object, amxd_function_t *const func)
Adds an RPC method definition to the object definition.
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
amxd_status_t amxd_function_set_attr(amxd_function_t *func, const amxd_fattr_id_t attr, const bool enable)
Sets or unsets a method attribute.
amxd_status_t amxd_function_new(amxd_function_t **func, const char *name, const uint32_t ret_type, amxd_object_fn_t impl)
Data model RPC method constructor function.
amxd_status_t amxd_function_new_arg(amxd_function_t *func, const char *name, const uint32_t type, amxc_var_t *default_value)
Adds an argument definition to a RPC method definition.
void amxd_trans_clean(amxd_trans_t *const trans)
Cleans the transaction object.
amxd_status_t amxd_trans_apply(amxd_trans_t *const trans, amxd_dm_t *const dm)
Applies all previously added actions.
amxd_status_t amxd_trans_add_inst(amxd_trans_t *const trans, const uint32_t index, const char *name)
Adds an instance add action to a transaction.
amxd_status_t amxd_trans_select_pathf(amxd_trans_t *const trans, const char *path,...) __attribute__((format(printf
Selects an object using a absolute or relative path.
amxd_status_t amxd_trans_init(amxd_trans_t *const trans)
Initializes a transaction object.
RPC method structure.
Definition: amxd_types.h:341
static amxd_dm_t dm
amxd_object_t * test_build_dm(void)
static amxd_status_t test_func(UNUSED amxd_object_t *object, UNUSED amxd_function_t *func, UNUSED amxc_var_t *args, UNUSED amxc_var_t *ret)
void test_clean_dm(void)
amxd_object_t * test_build_dm2(void)