libamxd  6.4.1
Data Model Manager
Functions | Variables
test_amxd_function_describe.c File Reference
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <stddef.h>
#include <setjmp.h>
#include <fcntl.h>
#include <unistd.h>
#include <signal.h>
#include <cmocka.h>
#include <amxc/amxc.h>
#include <amxp/amxp_signal.h>
#include <amxp/amxp_slot.h>
#include <amxp/amxp_timer.h>
#include <amxd/amxd_dm.h>
#include <amxd/amxd_object.h>
#include <amxd/amxd_object_event.h>
#include <amxd/amxd_transaction.h>
#include "test_amxd_function_describe.h"
#include <amxc/amxc_macros.h>

Go to the source code of this file.

Functions

int test_function_describe_setup (UNUSED void **state)
 
int test_function_describe_teardown (UNUSED void **state)
 
void test_amxd_can_describe_singleton_object (UNUSED void **state)
 
void test_amxd_describe_can_use_rel_path (UNUSED void **state)
 
void test_amxd_describe_fails_with_invalid_rel_path (UNUSED void **state)
 
void test_amxd_describe_can_use_to_high_access (UNUSED void **state)
 

Variables

static amxd_dm_t dm
 

Function Documentation

◆ test_amxd_can_describe_singleton_object()

void test_amxd_can_describe_singleton_object ( UNUSED void **  state)

Definition at line 145 of file test_amxd_function_describe.c.

145  {
146  amxd_object_t* singleton = NULL;
147  amxc_var_t retval;
148  amxc_var_t args;
149 
150  amxc_var_init(&args);
151  amxc_var_init(&retval);
152 
153  singleton = amxd_dm_findf(&dm, "Main.Singleton");
154  assert_non_null(singleton);
155 
156  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
157  amxc_var_add_key(uint32_t, &args, "access", amxd_dm_access_public);
158  amxc_var_add_key(bool, &args, "functions", true);
159  assert_int_equal(amxd_object_invoke_function(singleton, "_describe", &args, &retval), 0);
160 
161  assert_non_null(GET_ARG(&retval, "attributes"));
162  assert_non_null(GETP_ARG(&retval, "attributes.private"));
163  assert_false(GETP_BOOL(&retval, "attributes.private"));
164  assert_non_null(GETP_ARG(&retval, "attributes.read-only"));
165  assert_false(GETP_BOOL(&retval, "attributes.read-only"));
166  assert_non_null(GETP_ARG(&retval, "attributes.locked"));
167  assert_false(GETP_BOOL(&retval, "attributes.locked"));
168  assert_non_null(GETP_ARG(&retval, "attributes.protected"));
169  assert_false(GETP_BOOL(&retval, "attributes.protected"));
170  assert_non_null(GETP_ARG(&retval, "attributes.persistent"));
171  assert_true(GETP_BOOL(&retval, "attributes.persistent"));
172 
173  assert_non_null(GET_ARG(&retval, "object"));
174  assert_string_equal(GET_CHAR(&retval, "object"), "Main.Singleton.");
175 
176  assert_non_null(GET_ARG(&retval, "path"));
177  assert_string_equal(GET_CHAR(&retval, "path"), "Main.Singleton.");
178 
179  assert_non_null(GET_ARG(&retval, "name"));
180  assert_string_equal(GET_CHAR(&retval, "name"), "Singleton");
181 
182  assert_non_null(GET_ARG(&retval, "type_name"));
183  assert_string_equal(GET_CHAR(&retval, "type_name"), "singleton");
184 
185  assert_non_null(GET_ARG(&retval, "type_id"));
186  assert_int_equal(GET_UINT32(&retval, "type_id"), 1);
187 
188  amxc_var_clean(&retval);
189  amxc_var_clean(&args);
190 }
amxd_dm_findf
amxd_object_t * amxd_dm_findf(amxd_dm_t *const dm, const char *abs_path,...) __attribute__((format(printf
amxd_dm_access_public
@ amxd_dm_access_public
Definition: amxd_types.h:136
amxd_object_invoke_function
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.
Definition: amxd_object_function.c:245
_amxd_object
Definition: amxd_types.h:229
dm
static amxd_dm_t dm
Definition: test_amxd_function_describe.c:78

◆ test_amxd_describe_can_use_rel_path()

void test_amxd_describe_can_use_rel_path ( UNUSED void **  state)

Definition at line 192 of file test_amxd_function_describe.c.

192  {
193  amxd_object_t* root = NULL;
194  amxc_var_t retval;
195  amxc_var_t args;
196 
197  amxc_var_init(&args);
198  amxc_var_init(&retval);
199 
200  root = amxd_dm_findf(&dm, "Main.");
201  assert_non_null(root);
202 
203  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
204  amxc_var_add_key(cstring_t, &args, "rel_path", "Singleton.");
205  assert_int_equal(amxd_object_invoke_function(root, "_describe", &args, &retval), 0);
206 
207  amxc_var_clean(&retval);
208  amxc_var_clean(&args);
209 }

◆ test_amxd_describe_can_use_to_high_access()

void test_amxd_describe_can_use_to_high_access ( UNUSED void **  state)

Definition at line 231 of file test_amxd_function_describe.c.

231  {
232  amxd_object_t* singleton = NULL;
233  amxc_var_t retval;
234  amxc_var_t args;
235 
236  amxc_var_init(&args);
237  amxc_var_init(&retval);
238 
239  singleton = amxd_dm_findf(&dm, "Main.Singleton.");
240  assert_non_null(singleton);
241 
242  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
243  amxc_var_add_key(uint32_t, &args, "access", 100);
244  assert_int_equal(amxd_object_invoke_function(singleton, "_describe", &args, &retval), 0);
245 
246  amxc_var_clean(&retval);
247  amxc_var_clean(&args);
248 }

◆ test_amxd_describe_fails_with_invalid_rel_path()

void test_amxd_describe_fails_with_invalid_rel_path ( UNUSED void **  state)

Definition at line 211 of file test_amxd_function_describe.c.

211  {
212  amxd_object_t* root = NULL;
213  amxc_var_t retval;
214  amxc_var_t args;
215 
216  amxc_var_init(&args);
217  amxc_var_init(&retval);
218 
219  root = amxd_dm_findf(&dm, "Main.");
220  assert_non_null(root);
221 
222  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
223  amxc_var_add_key(cstring_t, &args, "rel_path", "NotExisting.Object.");
224  assert_int_not_equal(amxd_object_invoke_function(root, "_describe", &args, &retval), 0);
225 
226  amxc_var_clean(&retval);
227  amxc_var_clean(&args);
228 }

◆ test_function_describe_setup()

int test_function_describe_setup ( UNUSED void **  state)

Definition at line 80 of file test_amxd_function_describe.c.

80  {
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  amxd_function_t* func = NULL;
87  amxc_var_t def_val;
88 
89  assert_int_equal(amxd_dm_init(&dm), 0);
90  amxc_var_init(&def_val);
91 
92  // object Main
93  assert_int_equal(amxd_object_new(&root, amxd_object_singleton, "Main"), 0);
94  assert_int_equal(amxd_dm_add_root_object(&dm, root), 0);
95 
96  // %read-only object Main.Template[]
97  assert_int_equal(amxd_object_new(&template, amxd_object_template, "Template"), 0);
98  amxd_object_set_attr(template, amxd_oattr_read_only, true);
99  assert_int_equal(amxd_object_add_object(root, template), 0);
100  // string param1
101  assert_int_equal(amxd_param_new(&param, "param1", AMXC_VAR_ID_CSTRING), 0);
102  assert_int_equal(amxd_object_add_param(template, param), 0);
103  // %read-only uint32 param2
104  assert_int_equal(amxd_param_new(&param, "param2", AMXC_VAR_ID_UINT32), 0);
105  amxd_param_set_attr(param, amxd_pattr_read_only, true);
106  assert_int_equal(amxd_object_add_param(template, param), 0);
107  // htable func1(%mandatory %in string arg1, %in uint32 arg2 = 10)
108  assert_int_equal(amxd_function_new(&func, "func1", AMXC_VAR_ID_HTABLE, NULL), 0);
109  assert_int_equal(amxd_function_new_arg(func, "arg1", AMXC_VAR_ID_CSTRING, NULL), 0);
110  amxc_var_set(uint32_t, &def_val, 10);
111  assert_int_equal(amxd_function_new_arg(func, "arg2", AMXC_VAR_ID_UINT32, &def_val), 0);
112  assert_int_equal(amxd_object_add_function(template, func), 0);
113 
114  // %persistent object Main.Singleton
115  assert_int_equal(amxd_object_new(&singleton, amxd_object_singleton, "Singleton"), 0);
116  amxd_object_set_attr(singleton, amxd_oattr_persistent, true);
117  assert_int_equal(amxd_object_add_object(root, singleton), 0);
118  // string param1
119  assert_int_equal(amxd_param_new(&param, "param1", AMXC_VAR_ID_CSTRING), 0);
120  assert_int_equal(amxd_object_add_param(singleton, param), 0);
121  // %read-only uint32 param2
122  assert_int_equal(amxd_param_new(&param, "param2", AMXC_VAR_ID_UINT32), 0);
123  amxd_param_set_attr(param, amxd_pattr_read_only, true);
124  assert_int_equal(amxd_object_add_param(singleton, param), 0);
125  // htable func1(%mandatory %in string arg1, %in uint32 arg2 = 10)
126  assert_int_equal(amxd_function_new(&func, "func1", AMXC_VAR_ID_HTABLE, NULL), 0);
127  assert_int_equal(amxd_function_new_arg(func, "arg1", AMXC_VAR_ID_CSTRING, NULL), 0);
128  amxc_var_set(uint32_t, &def_val, 10);
129  assert_int_equal(amxd_function_new_arg(func, "arg2", AMXC_VAR_ID_UINT32, &def_val), 0);
130  assert_int_equal(amxd_object_add_function(singleton, func), 0);
131 
132  assert_int_equal(amxd_object_add_instance(&instance, template, "Instance1", 0, NULL), 0);
133  assert_int_equal(amxd_object_add_instance(&instance, template, "Instance2", 0, NULL), 0);
134 
135  amxc_var_clean(&def_val);
136  return 0;
137 }
amxd_param_new
amxd_status_t amxd_param_new(amxd_param_t **param, const char *name, const uint32_t type)
Definition: amxd_parameter.c:239
amxd_param_set_attr
amxd_status_t amxd_param_set_attr(amxd_param_t *param, const amxd_pattr_id_t attr, const bool enable)
Definition: amxd_parameter.c:326
amxd_pattr_read_only
@ amxd_pattr_read_only
Definition: amxd_types.h:358
amxd_oattr_read_only
@ amxd_oattr_read_only
Definition: amxd_types.h:199
amxd_oattr_persistent
@ amxd_oattr_persistent
Definition: amxd_types.h:200
amxd_object_template
@ amxd_object_template
Definition: amxd_types.h:183
amxd_object_singleton
@ amxd_object_singleton
Definition: amxd_types.h:181
amxd_dm_add_root_object
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_dm_init
amxd_status_t amxd_dm_init(amxd_dm_t *dm)
Initializes a data model structure.
Definition: amxd_dm.c:334
amxd_object_add_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_object_add_param
amxd_status_t amxd_object_add_param(amxd_object_t *const object, amxd_param_t *const param)
Adds a parameter definition to an object.
Definition: amxd_object_parameter.c:96
amxd_object_add_function
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.
Definition: amxd_object_function.c:140
amxd_object_set_attr
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_object_new
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_object_add_instance
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.
Definition: amxd_action_object_add_inst.c:301
amxd_function_new
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.
Definition: amxd_function.c:146
amxd_function_new_arg
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.
Definition: amxd_function_args.c:140
_amxd_function
RPC method structure.
Definition: amxd_types.h:341
_amxd_parameter
Definition: amxd_types.h:386

◆ test_function_describe_teardown()

int test_function_describe_teardown ( UNUSED void **  state)

Definition at line 139 of file test_amxd_function_describe.c.

139  {
140  amxd_dm_clean(&dm);
141 
142  return 0;
143 }
amxd_dm_clean
void amxd_dm_clean(amxd_dm_t *dm)
Cleans a data model structure.
Definition: amxd_dm.c:365

Variable Documentation

◆ dm

amxd_dm_t dm
static

Definition at line 78 of file test_amxd_function_describe.c.