libamxd  6.4.1
Data Model Manager
test_amxd_action_object_list.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_object_event.h>
72 #include <amxd/amxd_parameter.h>
73 #include <amxd/amxd_function.h>
74 #include <amxd/amxd_action.h>
75 
77 
78 #include <amxc/amxc_macros.h>
79 static amxd_dm_t dm;
80 
82  amxd_object_t* object = NULL;
83  amxd_object_t* template = NULL;
84  amxd_param_t* param = NULL;
85 
86  assert_int_equal(amxd_dm_init(&dm), 0);
87 
88  assert_int_equal(amxd_object_new(&template, amxd_object_template, "parent"), 0);
89  assert_int_equal(amxd_dm_add_root_object(&dm, template), 0);
90  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "child"), 0);
91  assert_int_equal(amxd_object_add_object(template, object), 0);
92 
93  assert_int_equal(amxd_param_new(&param, "templ_param", AMXC_VAR_ID_CSTRING), 0);
95  assert_int_equal(amxd_object_add_param(template, param), 0);
96  assert_int_equal(amxd_param_new(&param, "inst_param", AMXC_VAR_ID_BOOL), 0);
97  assert_int_equal(amxd_object_add_param(template, param), 0);
98  assert_int_equal(amxd_param_new(&param, "param", AMXC_VAR_ID_UINT32), 0);
101  assert_int_equal(amxd_object_add_param(template, param), 0);
102  assert_int_equal(amxd_object_add_event(template, "MyEvent!"), 0);
103 
104  assert_int_equal(amxd_param_new(&param, "child_param", AMXC_VAR_ID_CSTRING), 0);
106  assert_int_equal(amxd_object_add_param(object, param), 0);
107  assert_int_equal(amxd_param_new(&param, "child_param2", AMXC_VAR_ID_BOOL), 0);
108  assert_int_equal(amxd_object_add_param(object, param), 0);
109  assert_int_equal(amxd_param_new(&param, "child_param3", AMXC_VAR_ID_UINT64), 0);
110  assert_int_equal(amxd_object_add_param(object, param), 0);
111 
112  return template;
113 }
114 
115 void test_amxd_object_list_params(UNUSED void** state) {
116  amxd_object_t* object = NULL;
117  amxd_param_t* param = NULL;
118  amxc_var_t var_lists;
119  amxc_var_t* params = NULL;
120  const amxc_llist_t* list = NULL;
121 
122  amxc_var_init(&var_lists);
123  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "test_object"), 0);
124  assert_int_equal(amxd_param_new(&param, "test_param1", AMXC_VAR_ID_CSTRING), 0);
125  assert_int_equal(amxd_param_set_attr(param, amxd_pattr_private, true), 0);
126  assert_int_equal(amxd_object_add_param(object, param), 0);
127  assert_int_equal(amxd_param_new(&param, "test_param2", AMXC_VAR_ID_CSTRING), 0);
128  assert_int_equal(amxd_object_add_param(object, param), 0);
129 
130  assert_int_equal(amxd_object_list_params(object, &var_lists, amxd_dm_access_private), 0);
131 
132  assert_int_equal(amxc_var_type_of(&var_lists), AMXC_VAR_ID_LIST);
133  list = amxc_var_constcast(amxc_llist_t, &var_lists);
134  assert_int_equal(amxc_llist_size(list), 2);
135 
136  params = amxc_var_get_path(&var_lists, "0", AMXC_VAR_FLAG_DEFAULT);
137  assert_ptr_not_equal(params, NULL);
138  assert_int_equal(amxc_var_type_of(params), AMXC_VAR_ID_CSTRING);
139  assert_string_equal(amxc_var_constcast(cstring_t, params), "test_param1");
140 
141  params = amxc_var_get_path(&var_lists, "1", AMXC_VAR_FLAG_DEFAULT);
142  assert_ptr_not_equal(params, NULL);
143  assert_int_equal(amxc_var_type_of(params), AMXC_VAR_ID_CSTRING);
144  assert_string_equal(amxc_var_constcast(cstring_t, params), "test_param2");
145 
146  assert_int_equal(amxd_object_list_params(object, &var_lists, amxd_dm_access_public), 0);
147 
148  assert_int_equal(amxc_var_type_of(&var_lists), AMXC_VAR_ID_LIST);
149  list = amxc_var_constcast(amxc_llist_t, &var_lists);
150  assert_int_equal(amxc_llist_size(list), 1);
151 
152  params = amxc_var_get_path(&var_lists, "0", AMXC_VAR_FLAG_DEFAULT);
153  assert_ptr_not_equal(params, NULL);
154  assert_int_equal(amxc_var_type_of(params), AMXC_VAR_ID_CSTRING);
155  assert_string_equal(amxc_var_constcast(cstring_t, params), "test_param2");
156 
157  amxc_var_clean(&var_lists);
158  amxd_object_delete(&object);
159 }
160 
161 void test_amxd_object_list(UNUSED void** state) {
162  amxd_object_t* template = NULL;
163  amxd_object_t* instance = NULL;
164  amxc_var_t retval;
165  amxc_var_t args;
166 
167  amxc_var_init(&args);
168  amxc_var_init(&retval);
169 
170  template = test_build_dm();
171  assert_int_equal(amxd_object_new_instance(&instance, template, NULL, 0, NULL), 0);
172 
173  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
174  amxc_var_add_key(bool, &args, "parameters", true);
175  amxc_var_add_key(bool, &args, "events", true);
176  assert_int_equal(amxd_action_object_list(template, NULL, action_object_list, &args, &retval, NULL), 0);
177  assert_int_equal(amxd_action_object_list(template, NULL, action_object_list, NULL, &retval, NULL), 0);
178  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
179  amxc_var_add_key(bool, &args, "parameters", true);
180  amxc_var_add_key(bool, &args, "events", true);
181  assert_int_equal(amxd_action_object_list(instance, NULL, action_object_list, &args, &retval, NULL), 0);
182  amxc_var_set_type(&args, AMXC_VAR_ID_BOOL);
183  assert_int_not_equal(amxd_action_object_list(template, NULL, action_object_list, &args, &retval, NULL), 0);
184  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
185  amxc_var_add_key(bool, &args, "parameters", true);
186  assert_int_not_equal(amxd_action_object_list(NULL, NULL, action_object_list, &args, &retval, NULL), 0);
187  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
188  amxc_var_add_key(bool, &args, "parameters", true);
189  assert_int_not_equal(amxd_action_object_list(template, NULL, action_object_read, &args, &retval, NULL), 0);
190  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
191  amxc_var_add_key(bool, &args, "parameters", true);
192  assert_int_not_equal(amxd_action_object_list(template, NULL, action_object_list, &args, NULL, NULL), 0);
193 
194  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
195  amxc_var_add_key(bool, &args, "instances", true);
196  amxc_var_add_key(bool, &args, "include_priv", true);
197  assert_int_equal(amxd_action_object_list(template, NULL, action_object_list, &args, &retval, NULL), 0);
198 
199  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
200  amxc_var_add_key(bool, &args, "instances", true);
201  amxc_var_add_new_key(&args, "include_priv");
202  assert_int_equal(amxd_action_object_list(template, NULL, action_object_list, &args, &retval, NULL), 0);
203 
204  assert_int_equal(amxd_object_list(template, &retval, AMXD_OBJECT_ALL, amxd_dm_access_protected), 0);
205 
206  amxc_var_clean(&args);
207  amxc_var_clean(&retval);
208  amxd_dm_clean(&dm);
209 }
Ambiorix Data Model Default actions header file.
Ambiorix Data Model API header file.
Ambiorix Data Model RPC methods API header file.
Ambiorix Data Model API header file.
amxd_status_t amxd_object_list(amxd_object_t *const object, amxc_var_t *const list, uint32_t flags, amxd_dm_access_t access)
Ambiorix Data Model API header file.
amxd_status_t amxd_object_list_params(amxd_object_t *const object, amxc_var_t *const list, amxd_dm_access_t access)
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_read
Definition: amxd_types.h:117
@ action_object_list
Definition: amxd_types.h:120
#define AMXD_OBJECT_ALL
List and describe flag.
Definition: amxd_object.h:328
@ 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_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_status_t amxd_object_add_event(amxd_object_t *const object, const char *event_name)
Adds an event definition to 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_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_dm_t dm
void test_amxd_object_list_params(UNUSED void **state)
void test_amxd_object_list(UNUSED void **state)
static amxd_object_t * test_build_dm(void)