libamxd  6.4.1
Data Model Manager
test_amxd_function_get_insances.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 <stdio.h>
57 #include <stdarg.h>
58 #include <stddef.h>
59 #include <setjmp.h>
60 #include <fcntl.h>
61 #include <unistd.h>
62 #include <signal.h>
63 #include <cmocka.h>
64 
65 #include <amxc/amxc.h>
66 #include <amxp/amxp_signal.h>
67 #include <amxp/amxp_slot.h>
68 #include <amxp/amxp_timer.h>
69 
70 #include <amxd/amxd_dm.h>
71 #include <amxd/amxd_object.h>
72 #include <amxd/amxd_object_event.h>
73 #include <amxd/amxd_transaction.h>
74 
76 
77 #include <amxc/amxc_macros.h>
78 static amxd_dm_t dm;
79 
80 int test_function_get_instances_setup(UNUSED void** state) {
81  amxd_object_t* root = NULL;
82  amxd_object_t* singleton = NULL;
83  amxd_object_t* template = NULL;
84  amxd_object_t* instance = NULL;
85  amxd_param_t* param = NULL;
86  amxc_var_t keys;
87 
88  assert_int_equal(amxd_dm_init(&dm), 0);
89  amxc_var_init(&keys);
90 
91  // object Main
92  assert_int_equal(amxd_object_new(&root, amxd_object_singleton, "Main"), 0);
93  assert_int_equal(amxd_dm_add_root_object(&dm, root), 0);
94 
95  // %read-only object Main.Template[]
96  assert_int_equal(amxd_object_new(&template, amxd_object_template, "Template"), 0);
98  assert_int_equal(amxd_object_add_object(root, template), 0);
99  // string param1
100  assert_int_equal(amxd_param_new(&param, "param1", AMXC_VAR_ID_CSTRING), 0);
101  assert_int_equal(amxd_param_set_attr(param, amxd_pattr_key, true), 0);
102  assert_int_equal(amxd_object_add_param(template, param), 0);
103  // %key uint32 param2
104  assert_int_equal(amxd_param_new(&param, "param2", AMXC_VAR_ID_UINT32), 0);
105  assert_int_equal(amxd_param_set_attr(param, amxd_pattr_key, true), 0);
106  assert_int_equal(amxd_object_add_param(template, param), 0);
107  // uint32 param3
108  assert_int_equal(amxd_param_new(&param, "param3", AMXC_VAR_ID_UINT32), 0);
109  assert_int_equal(amxd_object_add_param(template, param), 0);
110 
111  assert_int_equal(amxd_object_new(&singleton, amxd_object_singleton, "SubObject"), 0);
113  assert_int_equal(amxd_object_add_object(template, singleton), 0);
114  assert_int_equal(amxd_param_new(&param, "param1", AMXC_VAR_ID_CSTRING), 0);
115  assert_int_equal(amxd_object_add_param(singleton, param), 0);
116 
117  // %persistent object Main.Singleton
118  assert_int_equal(amxd_object_new(&singleton, amxd_object_singleton, "Singleton"), 0);
120  assert_int_equal(amxd_object_add_object(root, singleton), 0);
121  // string param1
122  assert_int_equal(amxd_param_new(&param, "param1", AMXC_VAR_ID_CSTRING), 0);
123  assert_int_equal(amxd_object_add_param(singleton, param), 0);
124  // %read-only uint32 param2
125  assert_int_equal(amxd_param_new(&param, "param2", AMXC_VAR_ID_UINT32), 0);
127  assert_int_equal(amxd_object_add_param(singleton, param), 0);
128 
129  amxc_var_set_type(&keys, AMXC_VAR_ID_HTABLE);
130  amxc_var_add_key(cstring_t, &keys, "param1", "test1");
131  amxc_var_add_key(uint32_t, &keys, "param2", 1);
132  amxc_var_add_key(uint32_t, &keys, "param3", 1);
133  assert_int_equal(amxd_object_add_instance(&instance, template, "Instance1", 0, &keys), 0);
134  amxc_var_set_type(&keys, AMXC_VAR_ID_HTABLE);
135  amxc_var_add_key(cstring_t, &keys, "param1", "test2");
136  amxc_var_add_key(uint32_t, &keys, "param2", 2);
137  amxc_var_add_key(uint32_t, &keys, "param3", 1);
138  assert_int_equal(amxd_object_add_instance(&instance, template, "Instance2", 0, &keys), 0);
139 
140  amxc_var_clean(&keys);
141  return 0;
142 }
143 
144 int test_function_get_instances_teardown(UNUSED void** state) {
145  amxd_dm_clean(&dm);
146 
147  return 0;
148 }
149 
150 void test_amxd_can_get_instances(UNUSED void** state) {
151  amxd_object_t* template = NULL;
152  amxc_var_t retval;
153  amxc_var_t args;
154 
155  amxc_var_init(&args);
156  amxc_var_init(&retval);
157 
158  template = amxd_dm_findf(&dm, "Main.Template");
159  assert_non_null(template);
160 
161  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
162  assert_int_equal(amxd_object_invoke_function(template, "_get_instances", &args, &retval), 0);
163  amxc_var_dump(&retval, STDOUT_FILENO);
164 
165  assert_non_null(GET_ARG(&retval, "Main.Template.1."));
166  assert_non_null(GET_ARG(&retval, "Main.Template.2."));
167 
168  amxc_var_clean(&retval);
169  amxc_var_clean(&args);
170 }
171 
173  amxd_object_t* template = NULL;
174  amxc_var_t retval;
175  amxc_var_t args;
176 
177  amxc_var_init(&args);
178  amxc_var_init(&retval);
179 
180  template = amxd_dm_findf(&dm, "Main.");
181  assert_non_null(template);
182 
183  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
184  assert_int_not_equal(amxd_object_invoke_function(template, "_get_instances", &args, &retval), 0);
185  amxc_var_dump(&retval, STDOUT_FILENO);
186 
187  template = amxd_dm_findf(&dm, "Main.Singleton.");
188  assert_non_null(template);
189  assert_int_not_equal(amxd_object_invoke_function(template, "_get_instances", &args, &retval), 0);
190  amxc_var_dump(&retval, STDOUT_FILENO);
191 
192  amxc_var_clean(&retval);
193  amxc_var_clean(&args);
194 }
195 
197  amxd_object_t* template = NULL;
198  amxc_var_t retval;
199  amxc_var_t args;
200 
201  amxc_var_init(&args);
202  amxc_var_init(&retval);
203 
204  template = amxd_dm_findf(&dm, "Main.Template.");
205  assert_non_null(template);
206 
207  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
208  amxc_var_add_key(cstring_t, &args, "rel_path", "param3");
209  assert_int_not_equal(amxd_object_invoke_function(template, "_get_instances", &args, &retval), 0);
210  amxc_var_dump(&retval, STDOUT_FILENO);
211 
212  amxc_var_clean(&retval);
213  amxc_var_clean(&args);
214 }
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 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_key
Definition: amxd_types.h:362
@ amxd_pattr_read_only
Definition: amxd_types.h:358
@ amxd_oattr_read_only
Definition: amxd_types.h:199
@ amxd_oattr_persistent
Definition: amxd_types.h:200
@ 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_invoke_function(amxd_object_t *const object, const char *func_name, amxc_var_t *const args, amxc_var_t *const ret)
Calls an object RPC method.
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(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_object_add_instance(amxd_object_t **object, amxd_object_t *templ, const char *name, uint32_t index, amxc_var_t *values)
Data model object constructor function.
void test_amxd_get_instances_fails_with_parameter_path(UNUSED void **state)
int test_function_get_instances_setup(UNUSED void **state)
static amxd_dm_t dm
void test_amxd_get_instances_fails_on_none_template(UNUSED void **state)
void test_amxd_can_get_instances(UNUSED void **state)
int test_function_get_instances_teardown(UNUSED void **state)