libamxd  6.4.1
Data Model Manager
test_amxd_action_object_add_86.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_parameter.h>
72 #include <amxd/amxd_function.h>
73 #include <amxd/amxd_action.h>
74 #include <amxd/amxd_transaction.h>
75 
77 
78 #include <amxc/amxc_macros.h>
79 static amxd_dm_t dm;
80 
82  amxd_param_t* const param,
83  amxd_action_t reason,
84  UNUSED const amxc_var_t* const args,
85  UNUSED amxc_var_t* const retval,
86  void* priv) {
88  amxc_var_t* data = (amxc_var_t*) priv;
89 
90  if((reason != action_object_destroy) &&
91  ( reason != action_param_destroy)) {
93  goto exit;
94  }
95 
96  // action private data must not be removed when the action is used
97  // on derived objects.
98  // only remove action data when the action is owned by the object or
99  // parameter on which the action is called.
100  if(reason == action_object_destroy) {
101  if(amxd_object_has_action_cb(object, reason, test_cleanup_data)) {
102  amxc_var_delete(&data);
103  amxd_object_set_action_cb_data(object, reason, test_cleanup_data, NULL);
104  }
105  } else {
106  if(amxd_param_has_action_cb(param, reason, test_cleanup_data)) {
107  amxc_var_delete(&data);
108  amxd_param_set_action_cb_data(param, reason, test_cleanup_data, NULL);
109  }
110  }
111 
112 exit:
113  return status;
114 }
115 
117  amxd_param_t* const param,
118  amxd_action_t reason,
119  const amxc_var_t* const args,
120  amxc_var_t* const retval,
121  void* priv) {
122  return amxd_action_object_add_inst(object, param, reason, args, retval, priv);
123 }
124 
126  amxd_param_t* const param,
127  amxd_action_t reason,
128  const amxc_var_t* const args,
129  amxc_var_t* const retval,
130  void* priv) {
131  return amxd_action_object_add_inst(object, param, reason, args, retval, priv);
132 }
133 
135  amxd_object_t* object = NULL;
136  amxd_object_t* template = NULL;
137  amxd_param_t* param = NULL;
138  amxc_var_t* max = NULL;
139 
140  amxc_var_new(&max);
141  amxc_var_set(int32_t, max, 3);
142 
143  assert_int_equal(amxd_dm_init(&dm), 0);
144 
145  assert_int_equal(amxd_object_new(&object, amxd_object_singleton, "MyRoot"), 0);
146  assert_int_equal(amxd_param_new(&param, "Max", AMXC_VAR_ID_UINT32), 0);
147  assert_int_equal(amxd_object_add_param(object, param), 0);
148  amxc_var_set(uint32_t, &param->value, 2);
149  assert_int_equal(amxd_dm_add_root_object(&dm, object), 0);
150 
151  assert_int_equal(amxd_object_new(&template, amxd_object_template, "MyTemplate"), 0);
155  assert_int_equal(amxd_object_add_object(object, template), 0);
156  assert_int_equal(amxd_param_new(&param, "param", AMXC_VAR_ID_UINT32), 0);
157  assert_int_equal(amxd_object_add_param(template, param), 0);
158 
159  return template;
160 }
161 
163  amxd_object_t* template = NULL;
164  amxd_trans_t transaction;
165 
166  template = test_build_dm();
167 
168  assert_int_equal(amxd_object_get_instance_count(template), 0);
169 
170  amxd_trans_init(&transaction);
171  amxd_trans_select_object(&transaction, template);
172  amxd_trans_add_inst(&transaction, 0, NULL);
173  assert_int_equal(amxd_trans_apply(&transaction, &dm), 0);
174 
175  assert_int_equal(amxd_object_get_instance_count(template), 1);
176 
177  amxd_trans_clean(&transaction);
178  amxd_dm_clean(&dm);
179 }
180 
181 void test_amxd_object_add_inst_max_check(UNUSED void** state) {
182  amxd_object_t* template = NULL;
183  amxd_trans_t transaction;
184 
185  template = test_build_dm();
186 
187  assert_int_equal(amxd_object_get_instance_count(template), 0);
188 
189  amxd_trans_init(&transaction);
190  amxd_trans_select_object(&transaction, template);
191  amxd_trans_add_inst(&transaction, 0, NULL);
192  amxd_trans_select_object(&transaction, template);
193  amxd_trans_add_inst(&transaction, 0, NULL);
194  amxd_trans_select_object(&transaction, template);
195  amxd_trans_add_inst(&transaction, 0, NULL);
196  assert_int_equal(amxd_trans_apply(&transaction, &dm), 0);
197  amxd_trans_clean(&transaction);
198 
199  assert_int_equal(amxd_object_get_instance_count(template), 3);
200 
201  amxd_trans_init(&transaction);
202  amxd_trans_select_object(&transaction, template);
203  amxd_trans_add_inst(&transaction, 0, NULL);
204  assert_int_not_equal(amxd_trans_apply(&transaction, &dm), 0);
205  amxd_trans_clean(&transaction);
206 
207  amxd_dm_clean(&dm);
208 }
Ambiorix Data Model Default actions header file.
amxd_status_t amxd_action_object_add_inst(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)
Ambiorix Data Model API header file.
Ambiorix Data Model RPC methods API header file.
Ambiorix Data Model API header file.
bool amxd_object_has_action_cb(amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn)
amxd_status_t amxd_object_add_action_cb(amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn, void *priv)
void amxd_object_set_action_cb_data(amxd_object_t *const object, const amxd_action_t reason, amxd_action_fn_t fn, void *data)
static uint32_t amxd_object_get_instance_count(const amxd_object_t *object)
amxd_status_t amxd_param_new(amxd_param_t **param, const char *name, const uint32_t type)
bool amxd_param_has_action_cb(amxd_param_t *const param, const amxd_action_t reason, amxd_action_fn_t fn)
void amxd_param_set_action_cb_data(amxd_param_t *const param, const amxd_action_t reason, amxd_action_fn_t fn, void *data)
Ambiorix Data Model API header file.
@ action_object_add_inst
Definition: amxd_types.h:123
@ action_param_destroy
Definition: amxd_types.h:116
@ action_object_destroy
Definition: amxd_types.h:125
enum _amxd_action amxd_action_t
enum _amxd_status amxd_status_t
@ amxd_status_function_not_implemented
Definition: amxd_types.h:83
@ amxd_status_ok
Definition: amxd_types.h:78
@ 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_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_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_status_t amxd_trans_select_object(amxd_trans_t *trans, const amxd_object_t *const object)
Selects an object using an object pointer.
amxd_status_t amxd_trans_init(amxd_trans_t *const trans)
Initializes a transaction object.
amxc_var_t value
Definition: amxd_types.h:390
static amxd_status_t test_add_inst1(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)
static amxd_dm_t dm
void test_amxd_object_add_inst_only_adds_one_instance(UNUSED void **state)
static amxd_status_t test_cleanup_data(amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, UNUSED const amxc_var_t *const args, UNUSED amxc_var_t *const retval, void *priv)
static amxd_status_t test_add_inst2(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)
void test_amxd_object_add_inst_max_check(UNUSED void **state)
static amxd_object_t * test_build_dm(void)
static amxd_status_t status