blob: 594d528ebe518b7847458f72e130a0e3a3dbc724 [file] [log] [blame]
Radek Iša56ca9e42020-09-08 18:42:00 +02001/**
2 * @file utests.h
3 * @author Radek Iša <isa@cesnet.cz>
4 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vaskob4750962022-10-06 15:33:35 +02005 * @author Michal Vasko <mvasko@cesnet.cz>
Radek Iša56ca9e42020-09-08 18:42:00 +02006 * @brief this file contains macros for simplification test writing
7 *
Michal Vaskob4750962022-10-06 15:33:35 +02008 * Copyright (c) 2021 - 2022 CESNET, z.s.p.o.
Radek Iša56ca9e42020-09-08 18:42:00 +02009 *
10 * This source code is licensed under BSD 3-Clause License (the "License").
11 * You may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * https://opensource.org/licenses/BSD-3-Clause
15 */
16
17#ifndef _UTESTS_H_
18#define _UTESTS_H_
19
20#define _POSIX_C_SOURCE 200809L /* strdup */
21
Radek Krejcib4ac5a92020-11-23 17:54:33 +010022#include <setjmp.h>
23#include <stdarg.h>
24#include <stddef.h>
Antonio Prcelafe128282022-08-24 11:36:34 +020025#include <stdint.h>
Michal Vasko86421632021-05-04 13:11:25 +020026#include <stdlib.h>
Radek Krejcib4ac5a92020-11-23 17:54:33 +010027
28#include <cmocka.h>
Radek Iša56ca9e42020-09-08 18:42:00 +020029
30#include <string.h>
31
32#include "libyang.h"
Michal Vaskob4750962022-10-06 15:33:35 +020033#include "plugins_exts/metadata.h"
Radek Krejci3e6632f2021-03-22 22:08:21 +010034#include "plugins_internal.h"
Radek Išaa9ff2b82021-01-13 21:44:13 +010035#include "plugins_types.h"
Radek Krejcief5f7672021-04-01 17:04:12 +020036#include "tests_config.h"
Radek Išaa9ff2b82021-01-13 21:44:13 +010037#include "tree_schema_internal.h"
Radek Iša56ca9e42020-09-08 18:42:00 +020038
39/**
40 * TESTS OVERVIEW
41 *
42 * To include utest's environment, just include "utests.h" in the test's source
43 * code. In case it is the main source code for a cmocka test group (there is a
44 * main() function), define _UTEST_MAIN_ before including this header.
45 *
46 * TESTS VARIABLES
47 *
48 * Checking macros use internal storage to store various variables necessary
49 * during the checking. It is possible to access these variables using the
50 * following macros:
51 *
52 * UTEST_LYCTX - libyang context
53 * UTEST_IN - input handler
54 * UTEST_OUT - output handler
55 *
56 * All these variables are cleaned with test's teardown.
57 *
58 * TESTS SETUP
59 *
60 * CMocka's CMUnitTest list definition macros (cmoka_unit_test*()) are replaced
61 * by UTEST macro with possibility to specify own setup and teardown functions:
62 *
63 * UTEST(test_func) - only implicit setup and teardown functions are used
64 * UTEST(test_func, setup) - implicit teardown but own setup
65 * UTEST(test_func, setup, teardown) - both setup and teardown are test-specific
66 *
67 * Note that the tests environment always provide (and need) internal setup and
68 * teardown functions. In case the test-specific setup or teardown are used, they
69 * are supposed to include UTEST_SETUP at the setup beginning and UTEST_TEARDOWN
70 * at the teardown end.
71 *
72 * Libyang context is part of the prepared environment. To add a schema into the
73 * context (despite it is in the test-specific setup or in test function itself),
74 * use UTEST_ADD_MODULE macro.
75 *
76 * LOGGING
77 *
78 * There are 2 macros to check content of the log from the previously called
79 * libyang function. CHECK_LOG macro test only the last error message and path
80 * stored directly via logging callback. CHECK_LOG_CTX gets error message and
81 * path from the libyang context (in case the function does not store the error
82 * information into the libyang context, the message cannot be checked this way).
83 * libyang is set to store multiple error information, so multiple couples of
84 * error message and path can be provided to be checked (the first couple
85 * corresponds to the latest error). The macro also cleanups the errors list, so
86 * it is fine to check that there is no error after succeeding successful
87 * function call.
88 */
89
90/**
91 * @brief Test's context to provide common storage for various variables.
92 */
93struct utest_context {
94 struct ly_ctx *ctx; /**< libyang context */
95
96 char *err_msg; /**< Directly logged error message */
97 char *err_path; /**< Directly logged error path */
98
99 struct ly_in *in; /**< Input handler */
100 struct ly_out *out; /**< Outpu handler */
Michal Vasko86421632021-05-04 13:11:25 +0200101
102 char *orig_tz; /**< Original "TZ" environment variable value */
Radek Iša56ca9e42020-09-08 18:42:00 +0200103};
104
105/**
106 * @brief Shortcut to access utest_context.
107 */
108#define _UC ((struct utest_context *)*state)
109
110/**
111 * @brief libyang context provider.
112 */
113#define UTEST_LYCTX (_UC->ctx)
114
115/**
116 * @brief Context's input handler provider
117 */
118#define UTEST_IN (_UC->in)
119
120/**
121 * @brief Context's input handler provider
122 */
123#define UTEST_OUT (_UC->out)
124
125/**
126 * @brief Parse (and validate) data from the input handler as a YANG data tree.
127 *
128 * @param[in] INPUT The input data in the specified @p format to parse (and validate)
129 * @param[in] INPUT_FORMAT Format of the input data to be parsed. Can be 0 to try to detect format from the input handler.
130 * @param[in] PARSE_OPTIONS Options for parser, see @ref dataparseroptions.
131 * @param[in] VALIDATE_OPTIONS Options for the validation phase, see @ref datavalidationoptions.
Michal Vaskoddd76592022-01-17 13:34:48 +0100132 * @param[in] RET expected return status
133 * @param[out] OUT_NODE Resulting data tree built from the input data. Note that NULL can be a valid result as a
134 * representation of an empty YANG data tree.
Radek Iša56ca9e42020-09-08 18:42:00 +0200135 */
Michal Vaskoddd76592022-01-17 13:34:48 +0100136#define CHECK_PARSE_LYD_PARAM(INPUT, INPUT_FORMAT, PARSE_OPTIONS, VALIDATE_OPTIONS, RET, OUT_NODE) \
137 { \
138 LY_ERR _r = lyd_parse_data_mem(_UC->ctx, INPUT, INPUT_FORMAT, PARSE_OPTIONS, VALIDATE_OPTIONS, &OUT_NODE); \
139 if (_r != RET) { \
140 if (_r) { \
141 fail_msg("%s != 0x%d; MSG: %s", #RET, _r, ly_err_last(_UC->ctx)->msg); \
142 } else { \
143 fail_msg("%s != 0x%d", #RET, _r); \
144 } \
145 } \
Radek Iša56ca9e42020-09-08 18:42:00 +0200146 }
147
148/**
149 * @brief Check if lyd_node and his subnodes have correct values. Print lyd_node and his sunodes int o string in json or xml format.
150 * @param[in] NODE pointer to lyd_node
151 * @param[in] TEXT expected output string in json or xml format.
152 * @param[in] FORMAT format of input text. LYD_JSON, LYD_XML
153 * @param[in] PARAM options [Data printer flags](@ref dataprinterflags).
154 */
155#define CHECK_LYD_STRING_PARAM(NODE, TEXT, FORMAT, PARAM) \
156 { \
Michal Vaskoddd76592022-01-17 13:34:48 +0100157 char *str; \
158 LY_ERR _r = lyd_print_mem(&str, NODE, FORMAT, PARAM); \
159 if (_r) { \
160 fail_msg("Print err 0x%d; MSG: %s", _r, ly_err_last(_UC->ctx)->msg); \
161 } \
162 assert_string_equal(str, TEXT); \
163 free(str); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200164 }
165
166/**
167 * @brief Compare two lyd_node structure. Macro print lyd_node structure into string and then compare string. Print function use these two parameters. LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK;
168 * @param[in] NODE_1 pointer to lyd_node
169 * @param[in] NODE_2 pointer to lyd_node
170 */
171#define CHECK_LYD(NODE_1, NODE_2) \
172 { \
Michal Vaskoddd76592022-01-17 13:34:48 +0100173 char *str1; \
174 char *str2; \
175 assert_int_equal(LY_SUCCESS, lyd_print_mem(&str1, NODE_1, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK)); \
176 assert_int_equal(LY_SUCCESS, lyd_print_mem(&str2, NODE_2, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK)); \
177 assert_non_null(str1); \
178 assert_non_null(str2); \
179 assert_string_equal(str1, str2); \
180 free(str1); \
181 free(str2); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200182 }
183
184/*
185 * SUPPORT MACROS
186 */
187
188/**
189 * @brief Internal macro witch assert that two given string are equal or are both null.
190 *
191 * @param[in] STRING string to check
192 * @param[in] TEXT string to compare
193 */
194#define CHECK_STRING(STRING, TEXT)\
195 if (TEXT == NULL) { \
196 assert_null(STRING); \
197 } else { \
198 assert_non_null(STRING); \
199 assert_string_equal(STRING, TEXT); \
200 }
201
202/**
203 * @brief Internal macro witch assert that pointer is null when flag is 0.
204 *
205 * @param[in] POINTER pointer to check
206 * @param[in] FLAG 0 -> pointer is NULL, 1 -> pointer is not null
207 */
208#define CHECK_POINTER(POINTER, FLAG) \
209 assert_true(FLAG == 0 ? POINTER == NULL : POINTER != NULL)
210
211/**
212 * @brief Internal macro check size of [sized array](@ref sizedarrays)'s
213 *
214 * @param[in] ARRAY pointer to [sized array](@ref sizedarrays)
215 * @param[in] SIZE expected [sized array](@ref sizedarrays) size of array
216 */
217#define CHECK_ARRAY(ARRAY, SIZE) \
218 assert_true((SIZE == 0) ? \
219 (ARRAY == NULL) : \
220 (ARRAY != NULL && SIZE == LY_ARRAY_COUNT(ARRAY)));
221
222/*
223 * LIBYANG NODE CHECKING
224 */
225
226/**
Radek Išaa9ff2b82021-01-13 21:44:13 +0100227 * @brief check compileted type
Michal Vaskoddd76592022-01-17 13:34:48 +0100228 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100229 * @param[in] NODE pointer to lysc_type value
230 * @param[in] TYPE expected type [LY_DATA_TYPE](@ref LY_DATA_TYPE)
231 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
232 */
233#define CHECK_LYSC_TYPE(NODE, TYPE, EXTS) \
234 assert_non_null(NODE); \
235 assert_int_equal((NODE)->basetype, TYPE); \
236 CHECK_ARRAY((NODE)->exts, EXTS); \
Michal Vaskoc0c64ae2022-10-06 10:15:23 +0200237 assert_ptr_equal((NODE)->plugin, lyplg_type_plugin_find("", NULL, ly_data_type2str[TYPE]))
Radek Išaa9ff2b82021-01-13 21:44:13 +0100238
Michal Vaskoddd76592022-01-17 13:34:48 +0100239/**
240 * @brief check compileted numeric type
241 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100242 * @param[in] NODE pointer to lysc_type_num value
243 * @param[in] TYPE expected type [LY_DATA_TYPE](@ref LY_DATA_TYPE)
244 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
245 * @warning only integer types INT, UINT, NUM
246 */
247#define CHECK_LYSC_TYPE_NUM(NODE, TYPE, EXTS, RANGE) \
248 CHECK_LYSC_TYPE(NODE, TYPE, EXTS);\
249 CHECK_POINTER((NODE)->range, RANGE)
250
Michal Vaskoddd76592022-01-17 13:34:48 +0100251/**
252 * @brief check compiled string type
253 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100254 * @param[in] NODE pointer to lysc_type_num value
255 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
256 * @param[in] LENGTH 0 -> node dosnt have length limitation, 1 -> node have length limitation
257 * @param[in] PATTERNS expected number of patterns [sized array](@ref sizedarrays)
258 * @warning only integer types INT, UINT, NUM
259 */
260#define CHECK_LYSC_TYPE_STR(NODE, EXTS, LENGTH, PATTERNS) \
261 CHECK_LYSC_TYPE(NODE, LY_TYPE_STRING, EXTS); \
262 CHECK_POINTER((NODE)->length, LENGTH); \
263 CHECK_ARRAY((NODE)->patterns, PATTERNS)
264
Michal Vaskoddd76592022-01-17 13:34:48 +0100265/**
266 * @brief check compiled bits type
267 *
Radek Išaded31052021-03-10 13:22:53 +0100268 * @param[in] NODE pointer to lysc_type_num value
269 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
270 * @param[in] BITS expected number of bits
271 * @warning only integer types INT, UINT, NUM
272 */
273#define CHECK_LYSC_TYPE_BITS(NODE, EXTS, BITS) \
274 CHECK_LYSC_TYPE(NODE, LY_TYPE_BITS, EXTS); \
275 CHECK_ARRAY((NODE)->bits, BITS)
276
Radek Išaded31052021-03-10 13:22:53 +0100277#define CHECK_LYSC_TYPE_BITENUM_ITEM(NODE, POSITION, DSC, EXTS, FLAGS, NAME, REF)\
278 assert_non_null(NODE); \
279 assert_int_equal((NODE)->position, POSITION); \
280 CHECK_STRING((NODE)->dsc, DSC); \
281 CHECK_ARRAY((NODE)->exts, EXTS); \
282 assert_int_equal((NODE)->flags, FLAGS); \
283 CHECK_STRING((NODE)->name, NAME); \
284 CHECK_STRING((NODE)->ref, REF) \
285
Michal Vaskoddd76592022-01-17 13:34:48 +0100286/**
287 * @brief check range
288 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100289 * @param[in] NODE pointer to lysc_range value
290 * @param[in] DSC expected descriptin (string)
291 * @param[in] EAPPTAG expected string reprezenting error-app-tag value
292 * @param[in] EMSG expected string reprezenting error message
293 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
294 * @param[in] PARTS expected [sized array](@ref sizedarrays) number of rang limitations
295 * @param[in] REF expected reference
296 */
297#define CHECK_LYSC_RANGE(NODE, DSC, EAPPTAG, EMSG, EXTS, PARTS, REF) \
298 assert_non_null(NODE); \
299 CHECK_STRING((NODE)->dsc, DSC); \
300 CHECK_STRING((NODE)->eapptag, EAPPTAG); \
301 CHECK_STRING((NODE)->emsg, EMSG); \
302 CHECK_ARRAY((NODE)->exts, EXTS); \
303 CHECK_ARRAY((NODE)->parts, PARTS); \
304 CHECK_STRING((NODE)->ref, REF)
305
Michal Vaskoddd76592022-01-17 13:34:48 +0100306/**
307 * @brief check pattern
308 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100309 * @param[in] NODE pointer to lysc_pattern value
310 * @param[in] DSC expected descriptin (string)
311 * @param[in] EAPPTAG expected string reprezenting error-app-tag value
312 * @param[in] EMSG expected string reprezenting error message
313 * @param[in] EEXPR expected string reprezenting original, not compiled, regular expression
314 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
315 * @param[in] INVERTED if regular expression is inverted.
316 * @param[in] REF expected reference
317 */
318#define CHECK_LYSC_PATTERN(NODE, DSC, EAPPTAG, EMSG, EXPR, EXTS, INVERTED, REF) \
319 assert_non_null(NODE); \
320 assert_non_null((NODE)->code); \
321 CHECK_STRING((NODE)->dsc, DSC); \
322 CHECK_STRING((NODE)->eapptag, EAPPTAG); \
323 CHECK_STRING((NODE)->emsg, EMSG); \
324 CHECK_STRING((NODE)->expr, EXPR); \
325 CHECK_ARRAY((NODE)->exts, EXTS); \
326 assert_int_equal((NODE)->inverted, INVERTED); \
327 CHECK_STRING((NODE)->ref, REF)
328
329/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200330 * @brief assert that lysp_action_inout structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100331 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200332 * @param[in] NODE pointer to lysp_action_inout variable
333 * @param[in] DATA 0 -> check if pointer to data is NULL, 1 -> check if pointer to data is not null
334 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
335 * @param[in] GROUPINGS expected [sized array](@ref sizedarrays) size of grouping list
336 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of must restriction list
337 * @param[in] NODETYPE node type. LYS_INPUT or LYS_OUTPUT
338 * @param[in] PARENT 0 -> check if node is root, 1 -> check if node is not root
339 * @param[in] TYPEDEFS expected [sized array](@ref sizedarrays) size of typedefs list
340 */
341#define CHECK_LYSP_ACTION_INOUT(NODE, DATA, EXTS, GROUPINGS, MUSTS, NODETYPE, PARENT, TYPEDEFS) \
342 assert_non_null(NODE); \
Radek Krejci01180ac2021-01-27 08:48:22 +0100343 CHECK_POINTER((NODE)->child, DATA); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200344 CHECK_ARRAY((NODE)->exts, EXTS); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100345 CHECK_POINTER((NODE)->groupings, GROUPINGS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200346 CHECK_ARRAY((NODE)->musts, MUSTS); \
347 assert_int_equal((NODE)->nodetype, NODETYPE); \
348 CHECK_POINTER((NODE)->parent, PARENT); \
349 CHECK_ARRAY((NODE)->typedefs, TYPEDEFS);
350
351/**
352 * @brief assert that lysp_action structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100353 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200354 * @param[in] NODE pointer to lysp_action variable
355 * @param[in] DSC expected description
356 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extension list
357 * @param[in] FLAGS expected [schema node flags](@ref snodeflags)
358 * @param[in] GROUPINGS expected [sized array](@ref sizedarrays) size of grouping list
359 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of if-feature expressions list
360 * @param[in] INPUT_* ::LYSP_ACTION_INOUT_CHECK
361 * @param[in] NAME expected name
362 * @param[in] NODETYPE node type. LYS_RPC or LYS_ACTION
363 * @param[in] OUTPUT_* ::LYSP_ACTION_INOUT_CHECK
364 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
365 * @param[in] REF expected reference
366 * @param[in] TYPEDEFS expected [sized array](@ref sizedarrays) size of list of typedefs
367 */
368#define CHECK_LYSP_ACTION(NODE, DSC, EXTS, FLAGS, GROUPINGS, IFFEATURES, \
Michal Vasko2bf4af42023-01-04 12:08:38 +0100369 INPUT_DATA, INPUT_EXTS, INPUT_GROUPINGS, INPUT_MUSTS, \
370 INPUT_PARENT, INPUT_TYPEDEFS, \
371 NAME, NODETYPE, \
372 OUTPUT_DATA, OUTPUT_EXTS, OUTPUT_GROUPINGS, OUTPUT_MUSTS, \
373 OUTPUT_PARENT, OUTPUT_TYPEDEFS, \
374 PARENT, REF, TYPEDEFS) \
Radek Iša56ca9e42020-09-08 18:42:00 +0200375 assert_non_null(NODE); \
376 CHECK_STRING((NODE)->dsc, DSC); \
377 CHECK_ARRAY((NODE)->exts, EXTS); \
378 assert_int_equal((NODE)->flags, FLAGS); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100379 CHECK_POINTER((NODE)->groupings, GROUPINGS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200380 CHECK_ARRAY((NODE)->iffeatures, IFFEATURES); \
381 CHECK_LYSP_ACTION_INOUT(&((NODE)->input), INPUT_DATA, INPUT_EXTS, INPUT_GROUPINGS, \
382 INPUT_MUSTS, LYS_INPUT, INPUT_PARENT, INPUT_TYPEDEFS); \
383 assert_string_equal((NODE)->name, NAME); \
384 assert_int_equal((NODE)->nodetype, NODETYPE); \
385 CHECK_LYSP_ACTION_INOUT(&((NODE)->output), OUTPUT_DATA, OUTPUT_EXTS, OUTPUT_GROUPINGS, \
386 OUTPUT_MUSTS, LYS_OUTPUT, OUTPUT_PARENT, OUTPUT_TYPEDEFS); \
387 CHECK_POINTER((NODE)->parent, PARENT); \
388 CHECK_STRING((NODE)->ref, REF); \
389 CHECK_ARRAY((NODE)->typedefs, TYPEDEFS) \
390
391/**
392 * @brief assert that lysp_when structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100393 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200394 * @param[in] NODE pointer to lysp_when variable
395 * @param[in] COND expected string specifid condition
396 * @param[in] DSC expected string description statement
397 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension array
398 * @param[in] REF expected string reference
399 */
400#define CHECK_LYSP_WHEN(NODE, COND, DSC, EXTS, REF) \
401 assert_non_null(NODE); \
402 assert_string_equal((NODE)->cond, COND); \
403 CHECK_STRING((NODE)->dsc, DSC); \
404 CHECK_ARRAY((NODE)->exts, EXTS); \
405 if (REF == NULL) { \
406 assert_null((NODE)->ref); \
407 } else { \
408 assert_non_null((NODE)->ref); \
409 assert_string_equal((NODE)->ref, REF); \
410 }
411
412/**
413 * @brief assert that lysp_restr structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100414 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200415 * @param[in] NODE pointer to lysp_restr variable
416 * @param[in] ARG_STR expected string. The restriction expression/value
417 * @param[in] DSC expected descrition
418 * @param[in] EAPPTAG expected string reprezenting error-app-tag value
419 * @param[in] EMSG expected string reprezenting error message
420 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension array
421 * @param[in] REF expected reference
422 */
423
424#define CHECK_LYSP_RESTR(NODE, ARG_STR, DSC, EAPPTAG, EMSG, EXTS, REF) \
425 assert_non_null(NODE); \
426 assert_non_null((NODE)->arg.mod); \
427 assert_string_equal((NODE)->arg.str, ARG_STR); \
428 CHECK_STRING((NODE)->dsc, DSC); \
429 CHECK_STRING((NODE)->eapptag, EAPPTAG); \
430 CHECK_STRING((NODE)->emsg, EMSG); \
431 CHECK_ARRAY((NODE)->exts, EXTS); \
432 CHECK_STRING((NODE)->ref, REF);
433
434/**
435 * @brief assert that lysp_import structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100436 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200437 * @param[in] NODE pointer to lysp_import variable
438 * @param[in] DSC expected description or NULL
439 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extensions
440 * @param[in] NAME expected name of imported module
441 * @param[in] PREFIX expected prefix for the data from the imported schema
442 * @param[in] REF expected reference
Michal Vasko2bf4af42023-01-04 12:08:38 +0100443 * @param[in] REV expected reprezenting date in format "11-10-2020"
Radek Iša56ca9e42020-09-08 18:42:00 +0200444 */
445#define CHECK_LYSP_IMPORT(NODE, DSC, EXTS, NAME, PREFIX, REF, REV) \
446 assert_non_null(NODE); \
447 CHECK_STRING((NODE)->dsc, DSC); \
448 CHECK_ARRAY((NODE)->exts, EXTS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200449 assert_string_equal((NODE)->name, NAME); \
450 assert_string_equal((NODE)->prefix, PREFIX); \
451 CHECK_STRING((NODE)->ref, REF); \
452 CHECK_STRING((NODE)->rev, REV); \
453
454/**
455 * @brief assert that lysp_ext structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100456 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200457 * @param[in] NODE pointer to lysp_ext_instance variable
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100458 * @param[in] ARGNAME expected argument name
Radek Iša56ca9e42020-09-08 18:42:00 +0200459 * @param[in] COMPILED 0 -> compiled data dosnt exists, 1 -> compiled data exists
460 * @param[in] DSC expected string reprezent description
461 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension instances
462 * @param[in] FLAGS expected LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags)
463 * @param[in] NAME expected name
464 * @param[in] REF expected ref
465 */
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100466#define CHECK_LYSP_EXT(NODE, ARGNAME, COMPILED, DSC, EXTS, FLAGS, NAME, REF) \
Radek Iša56ca9e42020-09-08 18:42:00 +0200467 assert_non_null(NODE); \
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100468 CHECK_STRING((NODE)->argname, ARGNAME); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200469 CHECK_POINTER((NODE)->compiled, COMPILED); \
470 CHECK_STRING((NODE)->dsc, DSC); \
471 CHECK_ARRAY((NODE)->exts, EXTS); \
472 assert_int_equal((NODE)->flags, FLAGS); \
473 assert_string_equal((NODE)->name, NAME); \
474 CHECK_STRING((NODE)->ref, REF);
475
476/**
477 * @brief assert that lysp_ext_instance structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100478 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200479 * @param[in] NODE pointer to lysp_ext_instance variable
480 * @param[in] ARGUMENT expected optional value of the extension's argument
481 * @param[in] CHILD 0 -> node doesnt have child, 1 -> node have children
Radek Krejciab430862021-03-02 20:13:40 +0100482 * @param[in] PARENT_STMT expected value identifying placement of the extension instance
483 * @param[in] PARENT_STMT_INDEX expected indentifi index
Michal Vaskofc2cd072021-02-24 13:17:17 +0100484 * @param[in] FORMAT expected format
Radek Iša56ca9e42020-09-08 18:42:00 +0200485 */
Radek Krejci85ac8312021-03-03 20:21:33 +0100486#define CHECK_LYSP_EXT_INSTANCE(NODE, ARGUMENT, CHILD, PARENT_STMT, PARENT_STMT_INDEX, NAME, FORMAT) \
Radek Iša56ca9e42020-09-08 18:42:00 +0200487 assert_non_null(NODE); \
488 CHECK_STRING((NODE)->argument, ARGUMENT); \
489 CHECK_POINTER((NODE)->child, CHILD); \
Radek Krejciab430862021-03-02 20:13:40 +0100490 assert_int_equal((NODE)->parent_stmt, PARENT_STMT); \
491 assert_int_equal((NODE)->parent_stmt_index, PARENT_STMT_INDEX); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200492 assert_string_equal((NODE)->name, NAME); \
Michal Vaskofc2cd072021-02-24 13:17:17 +0100493 assert_int_equal((NODE)->format, FORMAT);
Radek Iša56ca9e42020-09-08 18:42:00 +0200494
495/**
496 * @brief assert that lysp_stmt structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100497 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200498 * @param[in] NODE pointer to lysp_stmt variable
499 * @param[in] ARG expected statemet argumet
500 * @param[in] CHILD 0 -> node doesnt have child, 1 -> node have children
501 * @param[in] FLAGS expected statement flags, can be set to LYS_YIN_ATTR
502 * @param[in] KW expected numeric respresentation of the stmt value
503 * @param[in] NEXT 0 -> pointer is NULL, 1 -> pointer is not null
504 * @param[in] STMS expected identifier of the statement
505 */
506#define CHECK_LYSP_STMT(NODE, ARG, CHILD, FLAGS, KW, NEXT, STMT) \
507 assert_non_null(NODE); \
508 CHECK_STRING((NODE)->arg, ARG); \
509 CHECK_POINTER((NODE)->child, CHILD); \
510 assert_int_equal((NODE)->flags, FLAGS); \
511 assert_int_equal((NODE)->kw, KW); \
512 CHECK_POINTER((NODE)->next, NEXT); \
513 assert_string_equal((NODE)->stmt, STMT); \
514
515/**
516 * @brief assert that lysp_type_enum structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100517 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200518 * @param[in] NODE pointer to lysp_type_enum variable
519 * @param[in] DSC expected description
520 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
521 * @param[in] FLAGS only LYS_STATUS_ and LYS_SET_VALUE values are allowed
522 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of list of the extension instances
523 * @param[in] NAME expected name
524 * @param[in] REF expected reference statement
525 * @param[in] VALUE expected enum's value or bit's position
526 */
527#define CHECK_LYSP_TYPE_ENUM(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, REF, VALUE) \
528 assert_non_null(NODE); \
529 CHECK_STRING((NODE)->dsc, DSC); \
530 CHECK_ARRAY((NODE)->exts, EXTS); \
531 assert_int_equal((NODE)->flags, FLAGS); \
532 CHECK_ARRAY((NODE)->iffeatures, IFFEATURES); \
533 CHECK_STRING((NODE)->name, NAME); \
534 CHECK_STRING((NODE)->ref, REF); \
535 assert_int_equal(VALUE, (NODE)->value);
536
537/**
Radek Išaa9ff2b82021-01-13 21:44:13 +0100538 * @brief assert that lysp_type_enum structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100539 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100540 * @param[in] NODE pointer to lysp_type variable
541 * @param[in] BASES expected [sized array](@ref sizedarrays) size of list of indentifiers
542 * @param[in] BITS expected [sized array](@ref sizedarrays) size of list of bits
543 * @param[in] COMPILED 0 -> pointer to compiled type is null, 1 -> pointer to compilet type is valid
544 * @param[in] ENUMS expected [sized array](@ref sizedarrays) size of list of enums-stmts
545 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension instances
546 * @param[in] FLAGS expected flags
547 * @param[in] FRACTION_DIGITS expected number of fraction digits decimal64
548 * @param[in] LENGTH expected 0 -> there isnt any restriction on length, 1 -> type is restricted on length (string, binary)
549 * @param[in] NAME expected name of type
550 * @param[in] PATH 0 -> no pointer to parsed path, 1 -> pointer to parsed path is valid
551 * @param[in] PATTERNS expected [sized array](@ref sizedarrays) size of list of patterns for string
552 * @param[in] PMOD expected submodule where type is defined 0 -> pointer is null, 1 -> pointer is not null
553 * @param[in] RANGE expected [sized array](@ref sizedarrays) size of list of range restriction
554 * @param[in] REQUIRE_INSTANCE expected require instance flag
555 * @param[in] TYPES expected [sized array](@ref sizedarrays) size of list of sub-types
556 */
557#define CHECK_LYSP_TYPE(NODE, BASES, BITS, COMPILED, ENUMS, EXTS, FLAGS, FRACTIONS_DIGITS, \
Michal Vasko2bf4af42023-01-04 12:08:38 +0100558 LENGTH, NAME, PATH, PATTERNS, PMOD, RANGE, REQUIRE_INSTANCE, TYPES) \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100559 assert_non_null(NODE);\
560 CHECK_ARRAY((NODE)->bases, BASES); \
561 CHECK_ARRAY((NODE)->bits, BITS); \
562 CHECK_POINTER((NODE)->compiled, COMPILED); \
563 CHECK_ARRAY((NODE)->enums, ENUMS); \
564 CHECK_ARRAY((NODE)->exts, EXTS); \
565 assert_int_equal((NODE)->flags, FLAGS); \
566 assert_int_equal((NODE)->fraction_digits, FRACTIONS_DIGITS); \
567 CHECK_POINTER((NODE)->length, LENGTH); \
568 CHECK_STRING((NODE)->name, NAME); \
569 CHECK_POINTER((NODE)->path, PATH); \
570 CHECK_ARRAY((NODE)->patterns, PATTERNS); \
571 CHECK_POINTER((NODE)->pmod, PMOD); \
572 CHECK_POINTER((NODE)->range, RANGE); \
573 assert_int_equal((NODE)->require_instance, REQUIRE_INSTANCE); \
574 CHECK_ARRAY((NODE)->types , TYPES)
575
576/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200577 * @brief assert that lysp_node structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100578 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200579 * @param[in] NODE pointer to lysp_node variable
580 * @param[in] DSC expected description statement
581 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
582 * @param[in] FLAGS [schema node flags](@ref snodeflags)
583 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of list of the extension instances
584 * @param[in] NAME expected name
585 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
586 * @param[in] NODETYPE node type LYS_UNKNOWN, LYS_CONTAINER, LYS_CHOICE, LYS_LEAF, LYS_LEAFLIST,
587 * LYS_LIST, LYS_ANYXML, LYS_ANYDATA, LYS_CASE, LYS_RPC, LYS_ACTION, LYS_NOTIF,
588 * LYS_USES, LYS_INPUT, LYS_OUTPUT, LYS_GROUPING, LYS_AUGMENT
589 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
590 * @param[in] REF expected reference statement
591 * @param[in] WHEN 0-> pointer is null, 1 -> pointer is not null
592 */
593#define CHECK_LYSP_NODE(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, NEXT, NODETYPE, PARENT, REF, WHEN) \
594 assert_non_null(NODE); \
595 CHECK_STRING((NODE)->dsc, DSC); \
596 CHECK_ARRAY((NODE)->exts, EXTS); \
597 assert_int_equal((NODE)->flags, FLAGS); \
598 CHECK_ARRAY((NODE)->iffeatures, IFFEATURES); \
599 CHECK_STRING((NODE)->name, NAME); \
600 CHECK_POINTER((NODE)->next, NEXT); \
601 assert_int_equal((NODE)->nodetype, NODETYPE); \
602 CHECK_POINTER((NODE)->parent, PARENT); \
603 CHECK_STRING((NODE)->ref, REF); \
Radek Krejci9a3823e2021-01-27 20:26:46 +0100604 CHECK_POINTER(lysp_node_when((struct lysp_node *)NODE), WHEN);
Radek Iša56ca9e42020-09-08 18:42:00 +0200605
606/**
Radek Išaa9ff2b82021-01-13 21:44:13 +0100607 * @brief assert that lysp_node structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100608 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100609 * @param[in] NODE pointer to lysp_node variable
610 * @param[in] DSC expected description statement
611 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
612 * @param[in] FLAGS [schema node flags](@ref snodeflags)
613 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of list of the extension instances
614 * @param[in] NAME expected name
615 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
616 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
617 * @param[in] REF expected reference statement
618 * @param[in] WHEN 0-> pointer is null, 1 -> pointer is not null
619 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of list of must restriction
620 * @param[in] UNITS expected string reprezenting units
621 * @param[in] DFLT 0-> node dosn't have default value. 1 -> node have default value
622 */
623#define CHECK_LYSP_NODE_LEAF(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, NEXT, \
Michal Vasko2bf4af42023-01-04 12:08:38 +0100624 PARENT, REF, WHEN, MUSTS, UNITS, DFLT) \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100625 CHECK_LYSP_NODE(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, NEXT, LYS_LEAF, PARENT, REF, WHEN); \
626 CHECK_ARRAY((NODE)->musts, MUSTS); \
627 CHECK_STRING((NODE)->units, UNITS); \
628 CHECK_STRING((NODE)->dflt.str, DFLT);
629
630/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200631 * @brief assert that lysc_notif structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100632 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200633 * @param[in] NODE pointer to lysp_notif variable
634 * @param[in] DATA 0 pointer is null, 1 pointer is not null
635 * @param[in] DSC expected description
636 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
637 * @param[in] FLAGS [schema node flags](@ref snodeflags)
638 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
639 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of list of must restriction
640 * @param[in] NAME expected name
641 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
642 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
643 * @param[in] REF expected reference
644 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
645 */
646#define CHECK_LYSC_NOTIF(NODE, DATA, DSC, EXTS, FLAGS, MODULE, MUSTS, NAME, PARENT, PRIV, REF, WHEN) \
647 assert_non_null(NODE); \
Radek Krejci01180ac2021-01-27 08:48:22 +0100648 CHECK_POINTER((NODE)->child, DATA); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200649 CHECK_STRING((NODE)->dsc, DSC); \
650 CHECK_ARRAY((NODE)->exts, EXTS); \
651 assert_int_equal((NODE)->flags, FLAGS); \
652 CHECK_POINTER((NODE)->module, MODULE); \
653 CHECK_ARRAY((NODE)->musts, MUSTS); \
654 assert_string_equal((NODE)->name, NAME); \
655 assert_int_equal((NODE)->nodetype, LYS_NOTIF); \
656 CHECK_POINTER((NODE)->parent, PARENT); \
657 CHECK_POINTER((NODE)->priv, PRIV); \
658 CHECK_STRING((NODE)->ref, REF); \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100659 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN);
Radek Iša56ca9e42020-09-08 18:42:00 +0200660
661/**
662 * @brief assert that lysc_action_inout structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100663 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200664 * @param[in] NODE pointer to lysp_notif variable
665 * @param[in] DATA 0 pointer is null, 1 pointer is not null
666 * @param[in] MUST expected [sized array](@ref sizedarrays) size of list of must restrictions
667 * @param[in] NODETYPE LYS_INPUT or LYS_OUTPUT
668 */
669#define CHECK_LYSC_ACTION_INOUT(NODE, DATA, MUST, NODETYPE) \
670 assert_non_null(NODE); \
Radek Krejci01180ac2021-01-27 08:48:22 +0100671 CHECK_POINTER((NODE)->child, DATA); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200672 CHECK_ARRAY((NODE)->musts, MUST); \
673 assert_int_equal((NODE)->nodetype, NODETYPE);
674
675/**
676 * @brief assert that lysc_action structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100677 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200678 * @param[in] NODE pointer to lysp_action variable
679 * @param[in] DSC string description statement
680 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
681 * @param[in] FLAGS [schema node flags](@ref snodeflags)
682 * @param[in] INPUT_DATA 0 pointer is null, 1 pointer is not null
683 * @param[in] INPUT_MUST expected [sized array](@ref sizedarrays) size of input list of must restrictions
684 * @param[in] INPUT_EXTS expected [sized array](@ref sizedarrays) size of the input extension instances of input
685 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
686 * @param[in] NAME expected name
687 * @param[in] NODETYPE LYS_RPC, LYS_ACTION
688 * @param[in] OUTPUT_DATA 0 pointer is null, 1 pointer is not null
689 * @param[in] OUTPUT_MUST expected [sized array](@ref sizedarrays) size of output list of must restrictions
690 * @param[in] OUTPUT_EXTS expected [sized array](@ref sizedarrays) size of the output extension instances of input
691 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
692 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
693 * @param[in] REF expected reference
694 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
695 */
696#define CHECK_LYSC_ACTION(NODE, DSC, EXTS, FLAGS, INPUT_DATA, INPUT_MUST, INPUT_EXTS, MODULE, NAME, NODETYPE, \
Michal Vasko2bf4af42023-01-04 12:08:38 +0100697 OUTPUT_DATA, OUTPUT_MUST, OUTPUT_EXTS, PARENT, PRIV, REF, WHEN) \
Radek Iša56ca9e42020-09-08 18:42:00 +0200698 assert_non_null(NODE); \
699 CHECK_STRING((NODE)->dsc, DSC); \
700 CHECK_ARRAY((NODE)->exts, EXTS); \
701 assert_int_equal((NODE)->flags, FLAGS); \
702 CHECK_LYSC_ACTION_INOUT(&(NODE)->input, INPUT_DATA, INPUT_MUST, LYS_INPUT); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100703 CHECK_ARRAY((NODE)->input.exts, INPUT_EXTS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200704 CHECK_POINTER((NODE)->module, MODULE); \
705 assert_string_equal((NODE)->name, NAME); \
706 assert_int_equal((NODE)->nodetype, NODETYPE); \
707 CHECK_LYSC_ACTION_INOUT(&(NODE)->output, OUTPUT_DATA, OUTPUT_MUST, LYS_OUTPUT); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100708 CHECK_ARRAY((NODE)->output.exts, OUTPUT_EXTS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200709 CHECK_POINTER((NODE)->parent, PARENT); \
710 CHECK_POINTER((NODE)->priv, PRIV); \
711 CHECK_STRING((NODE)->ref, REF); \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100712 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN);
Radek Iša56ca9e42020-09-08 18:42:00 +0200713
714/**
715 * @brief assert that lysc_node structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100716 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200717 * @param[in] NODE pointer to lysc_node variable
718 * @param[in] DSC expected description
719 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
720 * @param[in] FLAGS [schema node flags](@ref snodeflags)
721 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
722 * @param[in] NAME expected name
723 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
724 * @param[in] NODETYPE type of the node LYS_UNKNOWN, LYS_CONTAINER, LYS_CHOICE, LYS_LEAF,
725 * LYS_LEAFLIST, LYS_LIST, LYS_ANYXML, LYS_ANYDATA, LYS_CASE, LYS_RPC,
726 * LYS_ACTION, LYS_NOTIF, LYS_USES, LYS_INPUT, LYS_OUTPUT, LYS_GROUPING,
727 * LYS_AUGMENT
728 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
729 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
730 * @param[in] REF expected reference
731 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
732 */
733#define CHECK_LYSC_NODE(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, NODETYPE, PARENT, PRIV, REF, WHEN) \
734 assert_non_null(NODE); \
735 CHECK_STRING((NODE)->dsc, DSC); \
736 CHECK_ARRAY((NODE)->exts, EXTS); \
737 assert_int_equal((NODE)->flags, FLAGS); \
738 CHECK_POINTER((NODE)->module, MODULE); \
739 assert_string_equal((NODE)->name, NAME); \
740 CHECK_POINTER((NODE)->next, NEXT); \
741 assert_int_equal((NODE)->nodetype, NODETYPE); \
742 CHECK_POINTER((NODE)->parent, PARENT); \
743 assert_non_null((NODE)->prev); \
744 CHECK_POINTER((NODE)->priv, PRIV); \
745 CHECK_STRING((NODE)->ref, REF); \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100746 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN);
747
748/**
749 * @brief assert that lysc_node_leaf structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100750 *
Radek Išaa9ff2b82021-01-13 21:44:13 +0100751 * @param[in] NODE pointer to lysc_node variable
752 * @param[in] DSC expected description
753 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
754 * @param[in] FLAGS [schema node flags](@ref snodeflags)
755 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
756 * @param[in] NAME expected name
757 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
758 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
759 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
760 * @param[in] REF expected reference
Radek Išaa76902f2021-03-29 08:52:51 +0200761 * @param[in] ACTIONS 1 if is set pointer to structure lysc_node_action other 0
762 * @param[in] CHILD 1 if is set pointer to child other 0
763 * @param[in] MAX possible maximum elements in list
764 * @param[in] MIN possible minimum elements in list
765 * @param[in] MUSTS [sized array](@ref sizedarrays) number of must node elements in array
766 * @param[in] NOTIFS 1 if is set pointer to any notifs node
767 * @param[in] UNIQUES [sized array](@ref sizedarrays) number of unique nodes element in array
768 * @param[in] WHEN [sized array](@ref sizedarrays) size of when node array
769 */
770#define CHECK_LYSC_NODE_LIST(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, \
Michal Vasko2bf4af42023-01-04 12:08:38 +0100771 PARENT, PRIV, REF, ACTIONS, CHILD, MAX, MIN, MUSTS, NOTIFS, UNIQUES, WHEN) \
Radek Išaa76902f2021-03-29 08:52:51 +0200772 CHECK_LYSC_NODE(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, LYS_LIST, PARENT, PRIV, REF, WHEN); \
773 CHECK_POINTER((NODE)->actions, ACTIONS); \
774 CHECK_POINTER((NODE)->child, CHILD); \
775 assert_int_equal((NODE)->max, MAX); \
776 assert_int_equal((NODE)->min, MIN); \
777 CHECK_ARRAY((NODE)->musts, MUSTS); \
778 CHECK_POINTER((NODE)->notifs, NOTIFS); \
779 CHECK_ARRAY((NODE)->uniques, UNIQUES); \
780 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN)
781
782/**
783 * @brief assert that lysc_node_leaf structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100784 *
Radek Išaa76902f2021-03-29 08:52:51 +0200785 * @param[in] NODE pointer to lysc_node variable
786 * @param[in] DSC expected description
787 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
788 * @param[in] FLAGS [schema node flags](@ref snodeflags)
789 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
790 * @param[in] NAME expected name
791 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
792 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
793 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
794 * @param[in] REF expected reference
795 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
Radek Išaa9ff2b82021-01-13 21:44:13 +0100796 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of list of must restriction
797 * @param[in] UNITS expected string reprezenting units
798 * @param[in] DFLT 0-> node dosn't have default value. 1 -> node have default value
799 */
800#define CHECK_LYSC_NODE_LEAF(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, \
Michal Vasko2bf4af42023-01-04 12:08:38 +0100801 PARENT, PRIV, REF, WHEN, MUSTS, UNITS, DFLT) \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100802 CHECK_LYSC_NODE(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, LYS_LEAF, PARENT, PRIV, REF, WHEN); \
803 CHECK_ARRAY((NODE)->musts, MUSTS); \
804 assert_non_null((NODE)->type); \
805 CHECK_STRING((NODE)->units, UNITS); \
806 CHECK_POINTER((NODE)->dflt, DFLT);
Radek Iša56ca9e42020-09-08 18:42:00 +0200807
808/**
809 * @brief assert that lyd_meta structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100810 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200811 * @param[in] NODE pointer to lyd_meta variable
812 * @param[in] ANNOTATION 0 pointer is null, 1 pointer is not null
813 * @param[in] NAME expected name
814 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
815 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
816 * part of text reprezenting LY_DATA_TYPE.
817 * @param[in] ... ::CHECK_LYD_VALUE
818 */
819#define CHECK_LYD_META(NODE, ANNOTATION, NAME, NEXT, PARENT, TYPE_VAL, ...) \
820 assert_non_null(NODE); \
821 CHECK_POINTER((NODE)->annotation, ANNOTATION); \
822 assert_string_equal((NODE)->name, NAME); \
823 CHECK_POINTER((NODE)->next, NEXT); \
824 CHECK_POINTER((NODE)->parent, PARENT); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200825 CHECK_LYD_VALUE((NODE)->value, TYPE_VAL, __VA_ARGS__);
Radek Iša56ca9e42020-09-08 18:42:00 +0200826
827/**
828 * @brief assert that lyd_node_term structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100829 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200830 * @param[in] NODE pointer to lyd_node_term variable
831 * @param[in] FLAGS expected [data node flags](@ref dnodeflags)
832 * @param[in] META 0 -> meta is not prezent, 1 -> meta is prezent
833 * @param[in] NEXT 0 -> next node is not prezent, 1 -> next node is prezent
834 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
835 * part of text reprezenting LY_DATA_TYPE.
836 * @param[in] ... ::CHECK_LYD_VALUE
837 */
838#define CHECK_LYD_NODE_TERM(NODE, FLAGS, META, NEXT, PARENT, SCHEMA, VALUE_TYPE, ...) \
839 assert_non_null(NODE); \
840 assert_int_equal((NODE)->flags, FLAGS); \
841 CHECK_POINTER((NODE)->meta, META); \
842 CHECK_POINTER((NODE)->next, NEXT); \
843 CHECK_POINTER((NODE)->parent, PARENT); \
844 assert_non_null((NODE)->prev); \
845 CHECK_POINTER((NODE)->schema, SCHEMA); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200846 CHECK_LYD_VALUE((NODE)->value, VALUE_TYPE, __VA_ARGS__);
Radek Iša56ca9e42020-09-08 18:42:00 +0200847
848/**
849 * @brief assert that lyd_node_any structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100850 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200851 * @param[in] NODE pointer to lyd_node_term variable
852 * @param[in] FLAGS expected [data node flags](@ref dnodeflags)
853 * @param[in] META 0 meta isnt present , 1 meta is present
854 * @param[in] PARENT 0 it is root node , 1 node have parent
855 * @param[in] VALUE_TYPE value type ::lyd_node_any.value
856 */
857#define CHECK_LYD_NODE_ANY(NODE, FLAGS, META, PARENT, VALUE_TYPE) \
858 assert_non_null(NODE); \
859 assert_int_equal((NODE)->flags, FLAGS); \
860 CHECK_POINTER((NODE)->meta, META); \
861 CHECK_POINTER((NODE)->meta, PARENT); \
862 assert_non_null((NODE)->prev); \
863 assert_non_null((NODE)->schema); \
864 assert_int_equal((NODE)->value_type, VALUE_TYPE);
865
866/**
867 * @brief assert that lyd_node_opaq structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100868 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200869 * @param[in] NODE pointer to lyd_node_opaq variable
870 * @param[in] ATTR 0 if pointer is null ,1 if pointer is not null
871 * @param[in] CHILD 0 if pointer is null ,1 if pointer is not null
872 * @param[in] FORMAT LY_PREF_XML or LY_PREF_JSON
873 * @param[in] VAL_PREFS 0 if pointer is null ,1 if pointer is not null
874 * @param[in] NAME expected name
875 * @param[in] value expected orignal value
876 */
877#define CHECK_LYD_NODE_OPAQ(NODE, ATTR, CHILD, FORMAT, NAME, NEXT, PARENT, PREFIX, VAL_PREFS, VALUE) \
878 assert_non_null(NODE); \
879 CHECK_POINTER((NODE)->attr, ATTR); \
880 CHECK_POINTER((NODE)->child, CHILD); \
881 assert_ptr_equal((NODE)->ctx, UTEST_LYCTX); \
882 assert_int_equal((NODE)->flags, 0); \
883 assert_true((NODE)->format == FORMAT); \
884 assert_int_equal((NODE)->hash, 0); \
885 assert_string_equal((NODE)->name.name, NAME); \
886 assert_non_null((NODE)->prev); \
887 assert_null((NODE)->schema); \
888 CHECK_POINTER((NODE)->val_prefix_data, VAL_PREFS); \
889 assert_string_equal((NODE)->value, VALUE);
890
891/**
Radek Išaa76902f2021-03-29 08:52:51 +0200892 * @brief assert that lyd_node_opaq structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100893 *
Radek Išaa76902f2021-03-29 08:52:51 +0200894 * @param[in] NODE pointer to lyd_node_opaq variable
895 * @param[in] CHILD 1 if node has children other 0
896 * @param[in] HILD_HT 1 if node has children hash table other 0
897 * @param[in] META 1 if node has metadata other 0
898 * @param[in] FLAGS expected flag
899 * @param[in] NEXT 1 if next node is present other 0
900 * @param[in] PARENT 1 if node has parent other 0
901 * @param[in] PRIV 1 if node has private data other 0
902 * @param[in] SCHEMA 1 if node has schema other 0
903*/
904#define CHECK_LYD_NODE_INNER(NODE, CHILD, CHILD_HT, META, FLAGS, NEXT, PARENT, PRIV, SCHEMA) \
905 assert_non_null(NODE); \
906 CHECK_POINTER((NODE)->child, CHILD); \
907 CHECK_POINTER((NODE)->children_ht, CHILD_HT); \
908 CHECK_POINTER((NODE)->meta, META); \
909 assert_int_equal((NODE)->flags, FLAGS); \
910 CHECK_POINTER((NODE)->parent, PARENT); \
911 assert_non_null((NODE)->prev); \
912 CHECK_POINTER((NODE)->next, NEXT); \
913 CHECK_POINTER((NODE)->priv, PRIV); \
914 CHECK_POINTER((NODE)->schema, SCHEMA)
915
916/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200917 * @brief assert that lyd_value structure members are correct
Michal Vaskoddd76592022-01-17 13:34:48 +0100918 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200919 * @param[in] NODE lyd_value
920 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
921 * part of text reprezenting LY_DATA_TYPE.
922 * @param[in] ... Unspecified parameters. Type and numbers of parameters are specified
923 * by type of value. These parameters are passed to macro
924 * CHECK_LYD_VALUE_ ## TYPE_VAL.
925 */
926#define CHECK_LYD_VALUE(NODE, TYPE_VAL, ...) \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200927 CHECK_LYD_VALUE_ ## TYPE_VAL (NODE, __VA_ARGS__);
Radek Iša56ca9e42020-09-08 18:42:00 +0200928
929/*
930 * LYD VALUES CHECKING SPECIALIZATION
931 */
932
933/**
934 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type EMPTY
935 * Example CHECK_LYD_VALUE(node->value, EMPTY, "");
Michal Vaskoddd76592022-01-17 13:34:48 +0100936 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200937 * @param[in] NODE lyd_value variable
938 * @param[in] CANNONICAL_VAL expected cannonical value
939 */
940#define CHECK_LYD_VALUE_EMPTY(NODE, CANNONICAL_VAL) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200941 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200942 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200943 assert_non_null((NODE).realtype); \
944 assert_int_equal((NODE).realtype->basetype, LY_TYPE_EMPTY);
945
946/**
947 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type UNION
948 * Example CHECK_LYD_VALUE(node->value, UNION, "12", INT8, "12", 12);
949 * @warning type of subvalue cannot be UNION. Example of calling
Michal Vaskoddd76592022-01-17 13:34:48 +0100950 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200951 * @param[in] NODE lyd_value variable
952 * @param[in] CANNONICAL_VAL expected cannonical value
953 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
954 * @param[in] ... Unspecified parameters. Type and numbers of parameters are specified
955 * by type of value. These parameters are passed to macro
956 * CHECK_LYD_VALUE_ ## TYPE_VAL.
957 */
958#define CHECK_LYD_VALUE_UNION(NODE, CANNONICAL_VAL, TYPE_VAL, ...) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200959 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200960 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200961 assert_non_null((NODE).realtype); \
962 assert_int_equal(LY_TYPE_UNION, (NODE).realtype->basetype); \
963 assert_non_null((NODE).subvalue); \
964 assert_non_null((NODE).subvalue->prefix_data); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200965 CHECK_LYD_VALUE_ ## TYPE_VAL ((NODE).subvalue->value, __VA_ARGS__)
966
967/**
968 * @brief Internal macro. Get 1st variadic argument.
969 */
970#define _GETARG1(ARG1, ...) ARG1
Radek Iša56ca9e42020-09-08 18:42:00 +0200971
972/**
973 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type BITS
974 * Example arr[] = {"a", "b"}; CHECK_LYD_VALUE(node->value, BITS, "a b", arr);
Michal Vaskoddd76592022-01-17 13:34:48 +0100975 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200976 * @param[in] NODE lyd_value variable
977 * @param[in] CANNONICAL_VAL expected cannonical value
978 * @param[in] VALUE expected array of bits names
979 */
Michal Vasko151ae6c2021-09-23 08:23:51 +0200980#define CHECK_LYD_VALUE_BITS(NODE, ...) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200981 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200982 assert_string_equal((NODE)._canonical, _GETARG1(__VA_ARGS__, DUMMY)); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200983 assert_non_null((NODE).realtype); \
984 assert_int_equal(LY_TYPE_BITS, (NODE).realtype->basetype); \
985 { \
Radek Išaded31052021-03-10 13:22:53 +0100986 const char *arr[] = { __VA_ARGS__ }; \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200987 LY_ARRAY_COUNT_TYPE arr_size = (sizeof(arr) / sizeof(arr[0])) - 1; \
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200988 struct lyd_value_bits *_val; \
989 LYD_VALUE_GET(&(NODE), _val); \
990 assert_int_equal(arr_size, LY_ARRAY_COUNT(_val->items)); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200991 for (LY_ARRAY_COUNT_TYPE it = 0; it < arr_size; it++) { \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200992 assert_string_equal(arr[it + 1], _val->items[it]->name); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200993 } \
994 }
995
996/**
997 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type INST
Michal Vaskoddd76592022-01-17 13:34:48 +0100998 *
Radek Iša56ca9e42020-09-08 18:42:00 +0200999 * @param[in] NODE lyd_value variable
1000 * @param[in] CANNONICAL_VAL expected cannonical value
1001 * @param[in] VALUE expected array of enum ly_path_pred_type
1002 * @brief Example enum arr[] = {0x0, 0x1}; CHECK_LYD_VALUE(node->value, INST, "test/d", arr);
1003 */
1004#define CHECK_LYD_VALUE_INST(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001005 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001006 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001007 assert_non_null((NODE).realtype); \
1008 assert_int_equal(LY_TYPE_INST, (NODE).realtype->basetype); \
1009 { \
Michal Vasko79135ae2020-12-16 10:08:35 +01001010 LY_ARRAY_COUNT_TYPE arr_size = sizeof(VALUE) / sizeof(VALUE[0]); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001011 assert_int_equal(arr_size, LY_ARRAY_COUNT((NODE).target)); \
1012 for (LY_ARRAY_COUNT_TYPE it = 0; it < arr_size; it++) { \
1013 assert_int_equal(VALUE[it], (NODE).target[it].pred_type); \
1014 } \
1015 }
1016
1017/**
1018 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type ENUM.
1019 * Example CHECK_LYD_VALUE(node->value, ENUM, "item_name", "item_name");
Michal Vaskoddd76592022-01-17 13:34:48 +01001020 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001021 * @param[in] NODE lyd_value variable
1022 * @param[in] CANNONICAL_VAL expected cannonical value
1023 * @param[in] VALUE expected enum item name
1024 */
1025#define CHECK_LYD_VALUE_ENUM(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001026 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001027 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001028 assert_non_null((NODE).realtype); \
1029 assert_int_equal(LY_TYPE_ENUM, (NODE).realtype->basetype); \
1030 assert_string_equal(VALUE, (NODE).enum_item->name);
1031
1032/**
1033 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type INT8
1034 * Example CHECK_LYD_VALUE(node->value, INT8, "12", 12);
Michal Vaskoddd76592022-01-17 13:34:48 +01001035 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001036 * @param[in] NODE lyd_value variable
1037 * @param[in] CANNONICAL_VAL expected cannonical value
1038 * @param[in] VALUE expected inteager value (-128 to 127).
1039 */
1040#define CHECK_LYD_VALUE_INT8(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001041 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001042 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001043 assert_non_null((NODE).realtype); \
1044 assert_int_equal(LY_TYPE_INT8, (NODE).realtype->basetype); \
1045 assert_int_equal(VALUE, (NODE).int8);
1046
1047/**
1048 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type INT16
1049 * Example CHECK_LYD_VALUE(node->value, INT8, "12", 12);
Michal Vaskoddd76592022-01-17 13:34:48 +01001050 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001051 * @param[in] NODE lyd_value variable
1052 * @param[in] CANNONICAL_VAL expected cannonical value
1053 * @param[in] VALUE expected inteager value.
1054 */
1055#define CHECK_LYD_VALUE_INT16(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001056 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001057 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001058 assert_non_null((NODE).realtype); \
1059 assert_int_equal(LY_TYPE_INT16, (NODE).realtype->basetype); \
1060 assert_int_equal(VALUE, (NODE).int16);
1061
1062/**
1063 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type UINT8.
1064 * Example CHECK_LYD_VALUE(node->value, UINT8, "12", 12);
Michal Vaskoddd76592022-01-17 13:34:48 +01001065 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001066 * @param[in] NODE lyd_value variable
1067 * @param[in] CANNONICAL_VAL expected cannonical value
1068 * @param[in] VALUE expected inteager (0 to 255).
1069 */
1070#define CHECK_LYD_VALUE_UINT8(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001071 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001072 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001073 assert_non_null((NODE).realtype); \
1074 assert_int_equal(LY_TYPE_UINT8, (NODE).realtype->basetype); \
1075 assert_int_equal(VALUE, (NODE).uint8);
1076
1077/**
Radek Išaa76902f2021-03-29 08:52:51 +02001078 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type UINT32.
1079 * Example CHECK_LYD_VALUE(node->value, UINT32, "12", 12);
Michal Vaskoddd76592022-01-17 13:34:48 +01001080 *
Radek Išaa76902f2021-03-29 08:52:51 +02001081 * @param[in] NODE lyd_value variable
1082 * @param[in] CANNONICAL_VAL expected cannonical value
1083 * @param[in] VALUE expected inteager (0 to MAX_UINT32).
1084 */
1085#define CHECK_LYD_VALUE_UINT32(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001086 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001087 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Išaa76902f2021-03-29 08:52:51 +02001088 assert_non_null((NODE).realtype); \
1089 assert_int_equal(LY_TYPE_UINT32, (NODE).realtype->basetype); \
1090 assert_int_equal(VALUE, (NODE).uint32);
1091
1092/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001093 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type STRING.
1094 * Example CHECK_LYD_VALUE(node->value, STRING, "text");
Michal Vaskoddd76592022-01-17 13:34:48 +01001095 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001096 * @param[in] NODE lyd_value variable
1097 * @param[in] CANNONICAL_VAL expected cannonical value
1098 */
1099#define CHECK_LYD_VALUE_STRING(NODE, CANNONICAL_VAL) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001100 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001101 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001102 assert_non_null((NODE).realtype); \
1103 assert_int_equal(LY_TYPE_STRING, (NODE).realtype->basetype);
1104
1105/**
1106 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type LEAFREF
Michal Vaskoddd76592022-01-17 13:34:48 +01001107 * Example CHECK_LYD_VALUE(node->value, LEAFREF, "");
1108 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001109 * @param[in] NODE lyd_value variable
1110 * @param[in] CANNONICAL_VAL expected cannonical value
1111 */
1112#define CHECK_LYD_VALUE_LEAFREF(NODE, CANNONICAL_VAL) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001113 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001114 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001115 assert_non_null((NODE).realtype); \
1116 assert_int_equal(LY_TYPE_LEAFREF, (NODE).realtype->basetype); \
1117 assert_non_null((NODE).ptr)
1118
1119/**
1120 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type DEC64
1121 * Example CHECK_LYD_VALUE(node->value, DEC64, "125", 125);
Michal Vaskoddd76592022-01-17 13:34:48 +01001122 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001123 * @param[in] NODE lyd_value variable
1124 * @param[in] CANNONICAL_VAL expected cannonical value
1125 * @param[in] VALUE expected value 64bit inteager
1126*/
1127#define CHECK_LYD_VALUE_DEC64(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001128 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001129 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001130 assert_non_null((NODE).realtype); \
1131 assert_int_equal(LY_TYPE_DEC64, (NODE).realtype->basetype); \
1132 assert_int_equal(VALUE, (NODE).dec64);
1133
1134/**
1135 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type BINARY.
1136 * Example CHECK_LYD_VALUE(node->value, BINARY, "aGVs\nbG8=");
Michal Vaskoddd76592022-01-17 13:34:48 +01001137 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001138 * @param[in] NODE lyd_value variable
1139 * @param[in] CANNONICAL_VAL expected cannonical value
Michal Vasko495f4502021-04-27 14:48:05 +02001140 * @param[in] VALUE expected value data
1141 * @param[in] SIZE expected value data size
Radek Iša56ca9e42020-09-08 18:42:00 +02001142*/
Michal Vasko495f4502021-04-27 14:48:05 +02001143#define CHECK_LYD_VALUE_BINARY(NODE, CANNONICAL_VAL, VALUE, SIZE) \
Michal Vaskoaa0ee622021-05-11 09:29:25 +02001144 { \
1145 struct lyd_value_binary *_val; \
1146 LYD_VALUE_GET(&(NODE), _val); \
1147 assert_int_equal(_val->size, SIZE); \
1148 assert_int_equal(0, memcmp(_val->data, VALUE, SIZE)); \
1149 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
1150 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
1151 assert_non_null((NODE).realtype); \
1152 assert_int_equal(LY_TYPE_BINARY, (NODE).realtype->basetype); \
1153 }
Radek Iša56ca9e42020-09-08 18:42:00 +02001154
1155/**
1156 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type BOOL.
1157 * Example CHECK_LYD_VALUE(node->value, BOOL, "true", 1);
Michal Vaskoddd76592022-01-17 13:34:48 +01001158 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001159 * @param[in] NODE lyd_value variable
1160 * @param[in] CANNONICAL_VAL expected cannonical value
1161 * @param[in] VALUE expected boolean value 0,1
1162*/
1163#define CHECK_LYD_VALUE_BOOL(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001164 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001165 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001166 assert_non_null((NODE).realtype); \
1167 assert_int_equal(LY_TYPE_BOOL, (NODE).realtype->basetype); \
1168 assert_int_equal(VALUE, (NODE).boolean);
1169
1170/**
1171 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type IDENT.
1172 * Example CHECK_LYD_VALUE(node->value, IDENT, "types:gigabit-ethernet", "gigabit-ethernet");
Michal Vaskoddd76592022-01-17 13:34:48 +01001173 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001174 * @param[in] NODE lyd_value variable
1175 * @param[in] CANNONICAL_VAL expected cannonical value
1176 * @param[in] VALUE expected ident name
1177*/
1178#define CHECK_LYD_VALUE_IDENT(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001179 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001180 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001181 assert_non_null((NODE).realtype); \
1182 assert_int_equal(LY_TYPE_IDENT, (NODE).realtype->basetype); \
1183 assert_string_equal(VALUE, (NODE).ident->name);
1184
1185/**
Radek Išaa9ff2b82021-01-13 21:44:13 +01001186 * @brief Macro testing parser when parsing incorrect module;
Michal Vaskoddd76592022-01-17 13:34:48 +01001187 *
Radek Išaa9ff2b82021-01-13 21:44:13 +01001188 * @param[in] DATA String storing the schema module representation.
1189 * @param[in] FORMAT Schema format of the @p DATA
1190 * @param[in] FEATURES Array of module's features to enable
1191 * @param[in] RET_VAL ly_in_new_memory return error value
1192 */
1193#define UTEST_INVALID_MODULE(DATA, FORMAT, FEATURES, RET_VAL) \
1194 { \
Michal Vasko4de7d072021-07-09 09:13:18 +02001195 struct lys_module *mod; \
Radek Išaa9ff2b82021-01-13 21:44:13 +01001196 assert_int_equal(LY_SUCCESS, ly_in_new_memory(DATA, &_UC->in)); \
1197 assert_int_equal(RET_VAL, lys_parse(_UC->ctx, _UC->in, FORMAT, FEATURES, &mod)); \
1198 assert_null(mod); \
1199 } \
1200 ly_in_free(_UC->in, 0); \
1201 _UC->in = NULL; \
1202
1203/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001204 * @brief Add module (from a string) into the used libyang context.
Michal Vaskoddd76592022-01-17 13:34:48 +01001205 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001206 * @param[in] DATA String storing the schema module representation.
1207 * @param[in] FORMAT Schema format of the @p DATA
1208 * @param[in] FEATURES Array of module's features to enable
1209 * @param[out] MOD Optional parameter as a pointer to variable to store the resulting module.
1210 */
1211#define UTEST_ADD_MODULE(DATA, FORMAT, FEATURES, MOD) \
1212 assert_int_equal(LY_SUCCESS, ly_in_new_memory(DATA, &_UC->in)); \
Michal Vasko193dacd2022-10-13 08:43:05 +02001213 { \
1214 LY_ERR __r = lys_parse(_UC->ctx, _UC->in, FORMAT, FEATURES, MOD); \
1215 if (__r != LY_SUCCESS) { \
1216 print_message("[ MSG ] Module parsing failed:\n"); \
1217 for (struct ly_err_item *e = ly_err_first(_UC->ctx); e; e = e->next) { \
1218 print_message("[ MSG ] \t%s Path %s\n", e->msg, e->path); \
1219 } \
1220 fail(); \
1221 } \
1222 } \
Radek Iša56ca9e42020-09-08 18:42:00 +02001223 ly_in_free(_UC->in, 0); \
1224 _UC->in = NULL
1225
1226/**
Michal Vasko62af3692023-02-09 14:00:09 +01001227 * @brief Check expected last error in libyang context, which is then cleared. Can be called repeatedly to check
1228 * several errors. If NULL is provided as MSG, no error info record (NULL) is expected.
Michal Vaskoddd76592022-01-17 13:34:48 +01001229 *
Radek Iša56ca9e42020-09-08 18:42:00 +02001230 * @param[in] MSG Expected error message.
1231 * @param[in] PATH Expected error path.
Radek Iša56ca9e42020-09-08 18:42:00 +02001232 */
Michal Vasko62af3692023-02-09 14:00:09 +01001233#define CHECK_LOG_CTX(MSG, PATH) \
1234 { \
1235 struct ly_err_item *_e = ly_err_last(_UC->ctx); \
1236 if (!MSG) { \
1237 assert_null(_e); \
1238 } else { \
1239 assert_non_null(_e); \
1240 CHECK_STRING(_e->msg, MSG); \
1241 CHECK_STRING(_e->path, PATH); \
1242 } \
1243 ly_err_clean(_UC->ctx, _e); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001244 }
1245
Radek Iša56ca9e42020-09-08 18:42:00 +02001246/**
Michal Vaskoe9391c72021-10-05 10:04:56 +02001247 * @brief Check expected error in libyang context including error-app-tag.
1248 *
1249 * @param[in] MSG Expected error message.
1250 * @param[in] PATH Expected error path.
1251 * @param[in] APPTAG Expected error-app-tag.
1252 */
1253#define CHECK_LOG_CTX_APPTAG(MSG, PATH, APPTAG) \
Michal Vasko62af3692023-02-09 14:00:09 +01001254 { \
1255 struct ly_err_item *_e = ly_err_last(_UC->ctx); \
1256 if (!MSG) { \
1257 assert_null(_e); \
1258 } else { \
1259 assert_non_null(_e); \
1260 CHECK_STRING(_e->msg, MSG); \
1261 CHECK_STRING(_e->path, PATH); \
1262 CHECK_STRING(_e->apptag, APPTAG); \
1263 } \
1264 ly_err_clean(_UC->ctx, _e); \
1265 }
1266
1267/**
1268 * @brief Clear all errors stored in the libyang context.
1269 */
1270#define UTEST_LOG_CTX_CLEAN \
Michal Vaskoe9391c72021-10-05 10:04:56 +02001271 ly_err_clean(_UC->ctx, NULL)
1272
1273/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001274 * @brief Clean up the logging callback's storage.
1275 */
1276#define UTEST_LOG_CLEAN \
1277 free(_UC->err_msg); \
1278 free(_UC->err_path); \
1279 _UC->err_msg = NULL; \
1280 _UC->err_path = NULL;
1281
1282/**
1283 * @brief Check expected error directly logged via logging callback.
1284 * Useful mainly for messages logged by functions without access to libyang context.
1285 * @param[in] MSG Expected error message.
1286 * @param[in] PATH Expected error path.
1287 */
1288#define CHECK_LOG(MSG, PATH) \
1289 CHECK_STRING(_UC->err_msg, MSG); \
1290 CHECK_STRING(_UC->err_path, PATH); \
1291 UTEST_LOG_CLEAN
1292
1293#ifdef _UTEST_MAIN_
1294/*
1295 * Functions inlined into each C source file including this header with _UTEST_MAIN_ defined
1296 */
1297
1298/**
1299 * @brief Global variable holding the tests context to simplify access to it.
1300 */
1301struct utest_context *current_utest_context;
1302
1303/* set to 0 to printing error messages to stderr instead of checking them in code */
1304#define ENABLE_LOGGER_CHECKING 1
1305
1306/**
1307 * @brief Logging callback for libyang.
1308 */
1309static void
1310_utest_logger(LY_LOG_LEVEL level, const char *msg, const char *path)
1311{
1312 (void) level; /* unused */
1313
1314 if (ENABLE_LOGGER_CHECKING == 0) {
Radek Išaa9ff2b82021-01-13 21:44:13 +01001315 printf("\tERROR:\n\t\tMESSAGE: %s\n\t\tPATH: %s\n\t\tLEVEL: %i\n", msg, path, level);
Radek Iša56ca9e42020-09-08 18:42:00 +02001316 } else {
1317 free(current_utest_context->err_msg);
1318 current_utest_context->err_msg = msg ? strdup(msg) : NULL;
1319 free(current_utest_context->err_path);
1320 current_utest_context->err_path = path ? strdup(path) : NULL;
1321 }
1322}
1323
1324/**
1325 * @brief Generic utest's setup
1326 */
1327static int
1328utest_setup(void **state)
1329{
Michal Vasko86421632021-05-04 13:11:25 +02001330 char *cur_tz;
1331
Radek Iša56ca9e42020-09-08 18:42:00 +02001332 /* setup the logger */
1333 ly_set_log_clb(_utest_logger, 1);
1334 ly_log_options(LY_LOLOG | LY_LOSTORE);
1335
1336 current_utest_context = calloc(1, sizeof *current_utest_context);
1337 assert_non_null(current_utest_context);
1338 *state = current_utest_context;
1339
1340 /* libyang context */
1341 assert_int_equal(LY_SUCCESS, ly_ctx_new(NULL, 0, &current_utest_context->ctx));
1342
Radek Krejci968d7552021-03-26 20:33:51 +01001343 /* clean all errors from the setup - usually warnings regarding the plugins directories */
1344 UTEST_LOG_CLEAN;
1345
Michal Vasko86421632021-05-04 13:11:25 +02001346 /* backup timezone, if any */
1347 cur_tz = getenv("TZ");
1348 if (cur_tz) {
1349 current_utest_context->orig_tz = strdup(cur_tz);
1350 }
1351
1352 /* set CET */
1353 setenv("TZ", "CET+02:00", 1);
1354
Radek Iša56ca9e42020-09-08 18:42:00 +02001355 return 0;
1356}
1357
1358/**
1359 * @brief macro to include generic utest's setup into the test-specific setup.
1360 *
1361 * Place at the beginning of the test-specific setup
1362 */
1363#define UTEST_SETUP \
1364 assert_int_equal(0, utest_setup(state))
1365
1366/**
1367 * @brief Generic utest's teardown
1368 */
1369static int
1370utest_teardown(void **state)
1371{
1372 *state = NULL;
1373
Michal Vasko62af3692023-02-09 14:00:09 +01001374 /* libyang context, no leftover messages */
1375 assert_null(ly_err_last(current_utest_context->ctx));
Radek Krejci90ed21e2021-04-12 14:47:46 +02001376 ly_ctx_destroy(current_utest_context->ctx);
Radek Iša56ca9e42020-09-08 18:42:00 +02001377
Michal Vasko86421632021-05-04 13:11:25 +02001378 if (current_utest_context->orig_tz) {
1379 /* restore TZ */
1380 setenv("TZ", current_utest_context->orig_tz, 1);
1381 }
1382
Radek Iša56ca9e42020-09-08 18:42:00 +02001383 /* utest context */
1384 ly_in_free(current_utest_context->in, 0);
1385 free(current_utest_context->err_msg);
1386 free(current_utest_context->err_path);
Michal Vasko86421632021-05-04 13:11:25 +02001387 free(current_utest_context->orig_tz);
Radek Iša56ca9e42020-09-08 18:42:00 +02001388 free(current_utest_context);
1389 current_utest_context = NULL;
1390
1391 return 0;
1392}
1393
1394/**
1395 * @brief macro to include generic utest's teardown into the test-specific teardown.
1396 *
1397 * Place at the end of the test-specific teardown
1398 */
1399#define UTEST_TEARDOWN \
1400 assert_int_equal(0, utest_teardown(state))
1401
1402/**
1403 * @brief Internal macro for utest setup with test-specific setup and teardown
1404 */
1405#define _UTEST_SETUP_TEARDOWN(FUNC, SETUP, TEARDOWN) \
1406 cmocka_unit_test_setup_teardown(FUNC, SETUP, TEARDOWN)
1407
1408/**
1409 * @brief Internal macro for utest setup with test-specific setup and generic teardown
1410 */
1411#define _UTEST_SETUP(FUNC, SETUP) \
1412 cmocka_unit_test_setup_teardown(FUNC, SETUP, utest_teardown)
1413
1414/**
1415 * @brief Internal macro for utest setup with generic setup and teardown
1416 */
1417#define _UTEST(FUNC) \
1418 cmocka_unit_test_setup_teardown(FUNC, utest_setup, utest_teardown)
1419
1420/**
1421 * @brief Internal helper macro to select _UTEST* macro according to the provided parameters.
1422 */
1423#define _GET_UTEST_MACRO(_1, _2, _3, NAME, ...) NAME
1424
1425/**
1426 * @brief Macro to specify test function using utest environment. Macro has variadic parameters
1427 * to provide test-specific setup/teardown functions:
1428 *
1429 * UTEST(test_func) - only implicit setup and teardown functions are used
1430 * UTEST(test_func, setup) - implicit teardown but own setup
1431 * UTEST(test_func, setup, teardown) - both setup and teardown are test-specific
1432 */
1433#define UTEST(...) \
Michal Vasko151ae6c2021-09-23 08:23:51 +02001434 _GET_UTEST_MACRO(__VA_ARGS__, _UTEST_SETUP_TEARDOWN, _UTEST_SETUP, _UTEST, DUMMY)(__VA_ARGS__)
Radek Iša56ca9e42020-09-08 18:42:00 +02001435
1436#else /* _UTEST_MAIN_ */
1437
1438extern struct utest_context *current_utest_context;
1439
1440#endif /* _UTEST_MAIN_ */
1441
1442#endif /* _UTESTS_H_ */