libamxd  6.4.1
Data Model Manager
test_amxd_issue_107.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 <string.h>
59 #include <setjmp.h>
60 #include <fcntl.h>
61 #include <unistd.h>
62 #include <signal.h>
63 #include <cmocka.h>
64 #include <stdio.h>
65 
66 #include <amxc/amxc.h>
67 #include <amxp/amxp_signal.h>
68 #include <amxp/amxp_slot.h>
69 
70 #include <amxd/amxd_common.h>
71 #include <amxd/amxd_dm.h>
72 #include <amxd/amxd_object.h>
73 #include <amxd/amxd_parameter.h>
74 #include <amxd/amxd_function.h>
75 #include <amxd/amxd_action.h>
76 #include <amxd/amxd_transaction.h>
77 
78 #include "test_amxd_issue_107.h"
79 
80 #include <amxc/amxc_macros.h>
81 
82 static amxd_dm_t dm;
83 
84 int test_amxd_setup(UNUSED void** state) {
85  amxd_object_t* root = NULL;
86  amxd_object_t* singleton = NULL;
87  amxd_object_t* template = NULL;
88  amxd_param_t* param = NULL;
89  amxd_trans_t transaction;
90 
91  assert_int_equal(amxd_dm_init(&dm), 0);
92 
93  assert_int_equal(amxd_object_new(&root, amxd_object_singleton, "MyRoot"), 0);
94  assert_int_equal(amxd_dm_add_root_object(&dm, root), 0);
95 
96  assert_int_equal(amxd_object_new(&singleton, amxd_object_singleton, "MySingleton"), 0);
97  assert_int_equal(amxd_object_add_object(root, singleton), 0);
98 
99  assert_int_equal(amxd_object_new(&template, amxd_object_template, "MultiInstanceObject"), 0);
100  assert_int_equal(amxd_object_add_object(singleton, template), 0);
101  assert_int_equal(amxd_param_new(&param, "TheKey", AMXC_VAR_ID_CSTRING), 0);
102  amxd_param_set_attr(param, amxd_pattr_key, true);
104  assert_int_equal(amxd_object_add_param(template, param), 0);
105 
106  assert_int_equal(amxd_param_new(&param, "OtherParameter", AMXC_VAR_ID_CSTRING), 0);
107  assert_int_equal(amxd_object_add_param(template, param), 0);
108 
109  assert_int_equal(amxd_trans_init(&transaction), 0);
110  assert_int_equal(amxd_trans_select_pathf(&transaction, "MyRoot.MySingleton.MultiInstanceObject"), 0);
111  assert_int_equal(amxd_trans_add_inst(&transaction, 0, NULL), 0);
112  amxd_trans_set_value(cstring_t, &transaction, "TheKey", "aaaaa");
113  amxd_trans_set_value(cstring_t, &transaction, "OtherParameter", "Test");
114  assert_int_equal(amxd_trans_apply(&transaction, &dm), 0);
115  amxd_trans_clean(&transaction);
116 
117  assert_int_equal(amxd_trans_init(&transaction), 0);
118  assert_int_equal(amxd_trans_select_pathf(&transaction, "MyRoot.MySingleton.MultiInstanceObject"), 0);
119  assert_int_equal(amxd_trans_add_inst(&transaction, 0, NULL), 0);
120  amxd_trans_set_value(cstring_t, &transaction, "TheKey", "bbbbb");
121  amxd_trans_set_value(cstring_t, &transaction, "OtherParameter", "Test");
122  assert_int_equal(amxd_trans_apply(&transaction, &dm), 0);
123  amxd_trans_clean(&transaction);
124 
125 
126  return 0;
127 }
128 
129 int test_amxd_teardown(UNUSED void** state) {
130  amxd_dm_clean(&dm);
131  return 0;
132 }
133 
134 static int cb_fn(amxd_object_t* start_object,
135  amxd_object_t* matching_object,
136  UNUSED void* priv) {
137  amxd_object_t* singleton = amxd_dm_findf(&dm, "MyRoot.MySingleton.");
138 
139  check_expected(matching_object);
140  assert_ptr_equal(singleton, start_object);
141 
142  return 0;
143 }
144 
145 void test_amxd_can_use_for_all_on_singleton(UNUSED void** state) {
146  amxd_object_t* singleton = amxd_dm_findf(&dm, "MyRoot.MySingleton.");
147  amxd_object_t* inst1 = amxd_object_findf(singleton, "MultiInstanceObject.1.");
148  amxd_object_t* inst2 = amxd_object_findf(singleton, "MultiInstanceObject.2.");
149 
150  expect_memory(cb_fn, matching_object, inst1, sizeof(amxd_object_t));
151  expect_memory(cb_fn, matching_object, inst2, sizeof(amxd_object_t));
152  amxd_object_for_all(singleton, ".MultiInstanceObject.[OtherParameter == 'Test'].", cb_fn, NULL);
153 }
Ambiorix Data Model Default actions header file.
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 RPC methods 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_unique
Definition: amxd_types.h:363
@ amxd_pattr_key
Definition: amxd_types.h:362
@ 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_object_t * amxd_object_findf(amxd_object_t *object, const char *rel_path,...) __attribute__((format(printf
Find an object in the data model tree, starting from an object.
void amxd_object_for_all(amxd_object_t *object, const char *rel_spath, amxd_mobject_cb_t fn, void *priv)
Executes a task for all matching objects in an object tree.
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.
#define amxd_trans_set_value(type, trans, name, value)
Helper macro for setting a value.
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_trans_select_pathf(amxd_trans_t *const trans, const char *path,...) __attribute__((format(printf
Selects an object using a absolute or relative path.
amxd_status_t amxd_trans_init(amxd_trans_t *const trans)
Initializes a transaction object.
static amxd_dm_t dm
static int cb_fn(amxd_object_t *start_object, amxd_object_t *matching_object, UNUSED void *priv)
void test_amxd_can_use_for_all_on_singleton(UNUSED void **state)
int test_amxd_setup(UNUSED void **state)
int test_amxd_teardown(UNUSED void **state)