libamxd  6.4.1
Data Model Manager
test_amxd_virtual_root.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 
76 
77 void test_amxd_root_has_get_function(UNUSED void** state) {
78  amxd_dm_t dm;
79  amxd_object_t* root = NULL;
80  amxd_object_t* object = NULL;
81  amxd_function_t* func = NULL;
82  amxc_var_t args;
83  amxc_var_t ret;
84 
85  amxc_var_init(&args);
86  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
87  amxc_var_init(&ret);
88 
89  amxd_dm_init(&dm);
90  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "MyRoot"), 0);
91  assert_int_equal(amxd_dm_add_root_object(&dm, object), 0);
92 
93  root = amxd_dm_get_root(&dm);
94  assert_non_null(root);
95 
96  func = amxd_object_get_function(root, "_get");
97  assert_non_null(func);
98 
99  amxc_var_add_key(cstring_t, &args, "rel_path", "MyRoot.");
100  assert_int_equal(amxd_object_invoke_function(root, "_get", &args, &ret), amxd_status_ok);
101 
102  amxc_var_dump(&ret, STDOUT_FILENO);
103 
104  amxc_var_clean(&args);
105  amxc_var_clean(&ret);
106  amxd_dm_clean(&dm);
107 }
108 
109 void test_amxd_root_has_exec_function(UNUSED void** state) {
110  amxd_dm_t dm;
111  amxd_object_t* root = NULL;
112  amxd_object_t* object = NULL;
113  amxd_function_t* func = NULL;
114  amxc_var_t args;
115  amxc_var_t ret;
116 
117  amxc_var_init(&args);
118  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
119  amxc_var_init(&ret);
120 
121  amxd_dm_init(&dm);
122  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "MyRoot"), 0);
123  assert_int_equal(amxd_dm_add_root_object(&dm, object), 0);
124 
125  root = amxd_dm_get_root(&dm);
126  assert_non_null(root);
127 
128  func = amxd_object_get_function(root, "_get");
129  assert_non_null(func);
130 
131  amxc_var_add_key(cstring_t, &args, "rel_path", "MyRoot.");
132  amxc_var_add_key(cstring_t, &args, "method", "_get");
133  assert_int_equal(amxd_object_invoke_function(root, "_exec", &args, &ret), amxd_status_ok);
134 
135  amxc_var_dump(&ret, STDOUT_FILENO);
136 
137  amxc_var_clean(&args);
138  amxc_var_clean(&ret);
139  amxd_dm_clean(&dm);
140 }
141 
143  amxd_dm_t dm;
144  amxd_object_t* root = NULL;
145  amxd_object_t* object = NULL;
146  amxd_function_t* func = NULL;
147  amxc_var_t args;
148  amxc_var_t* method_args = NULL;
149  amxc_var_t ret;
150 
151  amxc_var_init(&args);
152  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
153  amxc_var_init(&ret);
154 
155  amxd_dm_init(&dm);
156  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "MyRoot"), 0);
157  assert_int_equal(amxd_dm_add_root_object(&dm, object), 0);
158 
159  root = amxd_dm_get_root(&dm);
160  assert_non_null(root);
161 
162  func = amxd_object_get_function(root, "_get");
163  assert_non_null(func);
164 
165  amxc_var_add_key(cstring_t, &args, "rel_path", "Does.Not.Exists.");
166  amxc_var_add_key(cstring_t, &args, "method", "_get");
167  assert_int_not_equal(amxd_object_invoke_function(root, "_exec", &args, &ret), amxd_status_ok);
168 
169  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
170  amxc_var_add_key(cstring_t, &args, "rel_path", "MyRoot.");
171  amxc_var_add_key(cstring_t, &args, "method", "_get");
172  method_args = amxc_var_add_key(amxc_htable_t, &args, "args", NULL);
173  amxc_var_add_key(uint32_t, method_args, "depth", 0);
174  assert_int_equal(amxd_object_invoke_function(root, "_exec", &args, &ret), amxd_status_ok);
175  amxc_var_dump(&ret, STDOUT_FILENO);
176 
177  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
178  amxc_var_add_key(cstring_t, &args, "method", "_get");
179  method_args = amxc_var_add_key(amxc_htable_t, &args, "args", NULL);
180  amxc_var_add_key(uint32_t, method_args, "depth", 0);
181  assert_int_not_equal(amxd_object_invoke_function(root, "_exec", &args, &ret), amxd_status_ok);
182 
183  amxc_var_clean(&args);
184  amxc_var_clean(&ret);
185  amxd_dm_clean(&dm);
186 }
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_ok
Definition: amxd_types.h:78
@ amxd_object_singleton
Definition: amxd_types.h:181
amxd_object_t * amxd_dm_get_root(amxd_dm_t *const dm)
Fetches the root object of the data model.
Definition: amxd_dm.c:456
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_function_t * amxd_object_get_function(const amxd_object_t *const object, const char *name)
Get the definition of a RPC method from 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_new(amxd_object_t **object, const amxd_object_type_t type, const char *name)
Data model object constructor function.
Definition: amxd_object.c:185
RPC method structure.
Definition: amxd_types.h:341
static amxd_dm_t dm
void test_amxd_root_has_get_function(UNUSED void **state)
void test_amxd_root_has_exec_function(UNUSED void **state)
void test_amxd_exec_function_fails_when_rel_path_does_not_exists(UNUSED void **state)