blob: 46b3d0441e9ab352648f70aa48d2edd4d3e65291 [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>
5 * @brief this file contains macros for simplification test writing
6 *
Radek Išaa9ff2b82021-01-13 21:44:13 +01007 * Copyright (c) 2021 CESNET, z.s.p.o.
Radek Iša56ca9e42020-09-08 18:42:00 +02008 *
9 * This source code is licensed under BSD 3-Clause License (the "License").
10 * You may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * https://opensource.org/licenses/BSD-3-Clause
14 */
15
16#ifndef _UTESTS_H_
17#define _UTESTS_H_
18
19#define _POSIX_C_SOURCE 200809L /* strdup */
20
Radek Krejcib4ac5a92020-11-23 17:54:33 +010021#include <setjmp.h>
22#include <stdarg.h>
23#include <stddef.h>
Michal Vasko86421632021-05-04 13:11:25 +020024#include <stdlib.h>
Radek Krejcib4ac5a92020-11-23 17:54:33 +010025
26#include <cmocka.h>
Radek Iša56ca9e42020-09-08 18:42:00 +020027
28#include <string.h>
29
30#include "libyang.h"
Radek Krejci3e6632f2021-03-22 22:08:21 +010031#include "plugins_internal.h"
Radek Išaa9ff2b82021-01-13 21:44:13 +010032#include "plugins_types.h"
Radek Krejcief5f7672021-04-01 17:04:12 +020033#include "tests_config.h"
Radek Išaa9ff2b82021-01-13 21:44:13 +010034#include "tree_schema_internal.h"
Radek Iša56ca9e42020-09-08 18:42:00 +020035
36/**
37 * TESTS OVERVIEW
38 *
39 * To include utest's environment, just include "utests.h" in the test's source
40 * code. In case it is the main source code for a cmocka test group (there is a
41 * main() function), define _UTEST_MAIN_ before including this header.
42 *
43 * TESTS VARIABLES
44 *
45 * Checking macros use internal storage to store various variables necessary
46 * during the checking. It is possible to access these variables using the
47 * following macros:
48 *
49 * UTEST_LYCTX - libyang context
50 * UTEST_IN - input handler
51 * UTEST_OUT - output handler
52 *
53 * All these variables are cleaned with test's teardown.
54 *
55 * TESTS SETUP
56 *
57 * CMocka's CMUnitTest list definition macros (cmoka_unit_test*()) are replaced
58 * by UTEST macro with possibility to specify own setup and teardown functions:
59 *
60 * UTEST(test_func) - only implicit setup and teardown functions are used
61 * UTEST(test_func, setup) - implicit teardown but own setup
62 * UTEST(test_func, setup, teardown) - both setup and teardown are test-specific
63 *
64 * Note that the tests environment always provide (and need) internal setup and
65 * teardown functions. In case the test-specific setup or teardown are used, they
66 * are supposed to include UTEST_SETUP at the setup beginning and UTEST_TEARDOWN
67 * at the teardown end.
68 *
69 * Libyang context is part of the prepared environment. To add a schema into the
70 * context (despite it is in the test-specific setup or in test function itself),
71 * use UTEST_ADD_MODULE macro.
72 *
73 * LOGGING
74 *
75 * There are 2 macros to check content of the log from the previously called
76 * libyang function. CHECK_LOG macro test only the last error message and path
77 * stored directly via logging callback. CHECK_LOG_CTX gets error message and
78 * path from the libyang context (in case the function does not store the error
79 * information into the libyang context, the message cannot be checked this way).
80 * libyang is set to store multiple error information, so multiple couples of
81 * error message and path can be provided to be checked (the first couple
82 * corresponds to the latest error). The macro also cleanups the errors list, so
83 * it is fine to check that there is no error after succeeding successful
84 * function call.
85 */
86
87/**
88 * @brief Test's context to provide common storage for various variables.
89 */
90struct utest_context {
91 struct ly_ctx *ctx; /**< libyang context */
92
93 char *err_msg; /**< Directly logged error message */
94 char *err_path; /**< Directly logged error path */
95
96 struct ly_in *in; /**< Input handler */
97 struct ly_out *out; /**< Outpu handler */
Michal Vasko86421632021-05-04 13:11:25 +020098
99 char *orig_tz; /**< Original "TZ" environment variable value */
Radek Iša56ca9e42020-09-08 18:42:00 +0200100};
101
102/**
103 * @brief Shortcut to access utest_context.
104 */
105#define _UC ((struct utest_context *)*state)
106
107/**
108 * @brief libyang context provider.
109 */
110#define UTEST_LYCTX (_UC->ctx)
111
112/**
113 * @brief Context's input handler provider
114 */
115#define UTEST_IN (_UC->in)
116
117/**
118 * @brief Context's input handler provider
119 */
120#define UTEST_OUT (_UC->out)
121
122/**
123 * @brief Parse (and validate) data from the input handler as a YANG data tree.
124 *
125 * @param[in] INPUT The input data in the specified @p format to parse (and validate)
126 * @param[in] INPUT_FORMAT Format of the input data to be parsed. Can be 0 to try to detect format from the input handler.
127 * @param[in] PARSE_OPTIONS Options for parser, see @ref dataparseroptions.
128 * @param[in] VALIDATE_OPTIONS Options for the validation phase, see @ref datavalidationoptions.
129 * @param[in] OUT_STATUS expected return status
130 * @param[out] OUT_NODE Resulting data tree built from the input data. Note that NULL can be a valid result as a representation of an empty YANG data tree.
131 * The returned data are expected to be freed using LYD_TREE_DESTROY().
132 */
133#define CHECK_PARSE_LYD_PARAM(INPUT, INPUT_FORMAT, PARSE_OPTIONS, VALIDATE_OPTIONS, OUT_STATUS, OUT_NODE) \
134 assert_int_equal(OUT_STATUS, lyd_parse_data_mem(_UC->ctx, INPUT, INPUT_FORMAT, PARSE_OPTIONS, VALIDATE_OPTIONS, &OUT_NODE)); \
135 if (OUT_STATUS == LY_SUCCESS) { \
136 assert_non_null(OUT_NODE); \
137 } else { \
138 assert_null(OUT_NODE); \
139 }
140
141/**
142 * @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.
143 * @param[in] NODE pointer to lyd_node
144 * @param[in] TEXT expected output string in json or xml format.
145 * @param[in] FORMAT format of input text. LYD_JSON, LYD_XML
146 * @param[in] PARAM options [Data printer flags](@ref dataprinterflags).
147 */
148#define CHECK_LYD_STRING_PARAM(NODE, TEXT, FORMAT, PARAM) \
149 { \
150 char *test; \
151 lyd_print_mem(&test, NODE, FORMAT, PARAM); \
152 assert_string_equal(test, TEXT); \
153 free(test); \
154 }
155
156/**
157 * @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;
158 * @param[in] NODE_1 pointer to lyd_node
159 * @param[in] NODE_2 pointer to lyd_node
160 */
161#define CHECK_LYD(NODE_1, NODE_2) \
162 { \
163 char *test_1; \
164 char *test_2; \
aPiecek848e5802021-09-21 14:13:26 +0200165 assert_int_equal(LY_SUCCESS, lyd_print_mem(&test_1, NODE_1, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK)); \
166 assert_int_equal(LY_SUCCESS, lyd_print_mem(&test_2, NODE_2, LYD_XML, LYD_PRINT_WITHSIBLINGS | LYD_PRINT_SHRINK)); \
167 assert_non_null(test_1); \
168 assert_non_null(test_2); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200169 assert_string_equal(test_1, test_2); \
170 free(test_1); \
171 free(test_2); \
172 }
173
174/*
175 * SUPPORT MACROS
176 */
177
178/**
179 * @brief Internal macro witch assert that two given string are equal or are both null.
180 *
181 * @param[in] STRING string to check
182 * @param[in] TEXT string to compare
183 */
184#define CHECK_STRING(STRING, TEXT)\
185 if (TEXT == NULL) { \
186 assert_null(STRING); \
187 } else { \
188 assert_non_null(STRING); \
189 assert_string_equal(STRING, TEXT); \
190 }
191
192/**
193 * @brief Internal macro witch assert that pointer is null when flag is 0.
194 *
195 * @param[in] POINTER pointer to check
196 * @param[in] FLAG 0 -> pointer is NULL, 1 -> pointer is not null
197 */
198#define CHECK_POINTER(POINTER, FLAG) \
199 assert_true(FLAG == 0 ? POINTER == NULL : POINTER != NULL)
200
201/**
202 * @brief Internal macro check size of [sized array](@ref sizedarrays)'s
203 *
204 * @param[in] ARRAY pointer to [sized array](@ref sizedarrays)
205 * @param[in] SIZE expected [sized array](@ref sizedarrays) size of array
206 */
207#define CHECK_ARRAY(ARRAY, SIZE) \
208 assert_true((SIZE == 0) ? \
209 (ARRAY == NULL) : \
210 (ARRAY != NULL && SIZE == LY_ARRAY_COUNT(ARRAY)));
211
212/*
213 * LIBYANG NODE CHECKING
214 */
215
216/**
Radek Išaa9ff2b82021-01-13 21:44:13 +0100217 * @brief check compileted type
218 * @param[in] NODE pointer to lysc_type value
219 * @param[in] TYPE expected type [LY_DATA_TYPE](@ref LY_DATA_TYPE)
220 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
221 */
222#define CHECK_LYSC_TYPE(NODE, TYPE, EXTS) \
223 assert_non_null(NODE); \
224 assert_int_equal((NODE)->basetype, TYPE); \
225 CHECK_ARRAY((NODE)->exts, EXTS); \
Radek Krejci3e6632f2021-03-22 22:08:21 +0100226 assert_ptr_equal((NODE)->plugin, lyplg_find(LYPLG_TYPE, "", NULL, ly_data_type2str[TYPE]))
Radek Išaa9ff2b82021-01-13 21:44:13 +0100227
228/* @brief check compileted numeric type
229 * @param[in] NODE pointer to lysc_type_num 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 * @warning only integer types INT, UINT, NUM
233 */
234#define CHECK_LYSC_TYPE_NUM(NODE, TYPE, EXTS, RANGE) \
235 CHECK_LYSC_TYPE(NODE, TYPE, EXTS);\
236 CHECK_POINTER((NODE)->range, RANGE)
237
238/* @brief check compiled string type
239 * @param[in] NODE pointer to lysc_type_num value
240 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
241 * @param[in] LENGTH 0 -> node dosnt have length limitation, 1 -> node have length limitation
242 * @param[in] PATTERNS expected number of patterns [sized array](@ref sizedarrays)
243 * @warning only integer types INT, UINT, NUM
244 */
245#define CHECK_LYSC_TYPE_STR(NODE, EXTS, LENGTH, PATTERNS) \
246 CHECK_LYSC_TYPE(NODE, LY_TYPE_STRING, EXTS); \
247 CHECK_POINTER((NODE)->length, LENGTH); \
248 CHECK_ARRAY((NODE)->patterns, PATTERNS)
249
Radek Išaded31052021-03-10 13:22:53 +0100250/* @brief check compiled bits type
251 * @param[in] NODE pointer to lysc_type_num value
252 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
253 * @param[in] BITS expected number of bits
254 * @warning only integer types INT, UINT, NUM
255 */
256#define CHECK_LYSC_TYPE_BITS(NODE, EXTS, BITS) \
257 CHECK_LYSC_TYPE(NODE, LY_TYPE_BITS, EXTS); \
258 CHECK_ARRAY((NODE)->bits, BITS)
259
Radek Išaded31052021-03-10 13:22:53 +0100260#define CHECK_LYSC_TYPE_BITENUM_ITEM(NODE, POSITION, DSC, EXTS, FLAGS, NAME, REF)\
261 assert_non_null(NODE); \
262 assert_int_equal((NODE)->position, POSITION); \
263 CHECK_STRING((NODE)->dsc, DSC); \
264 CHECK_ARRAY((NODE)->exts, EXTS); \
265 assert_int_equal((NODE)->flags, FLAGS); \
266 CHECK_STRING((NODE)->name, NAME); \
267 CHECK_STRING((NODE)->ref, REF) \
268
Radek Išaa9ff2b82021-01-13 21:44:13 +0100269/* @brief check range
270 * @param[in] NODE pointer to lysc_range value
271 * @param[in] DSC expected descriptin (string)
272 * @param[in] EAPPTAG expected string reprezenting error-app-tag value
273 * @param[in] EMSG expected string reprezenting error message
274 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
275 * @param[in] PARTS expected [sized array](@ref sizedarrays) number of rang limitations
276 * @param[in] REF expected reference
277 */
278#define CHECK_LYSC_RANGE(NODE, DSC, EAPPTAG, EMSG, EXTS, PARTS, REF) \
279 assert_non_null(NODE); \
280 CHECK_STRING((NODE)->dsc, DSC); \
281 CHECK_STRING((NODE)->eapptag, EAPPTAG); \
282 CHECK_STRING((NODE)->emsg, EMSG); \
283 CHECK_ARRAY((NODE)->exts, EXTS); \
284 CHECK_ARRAY((NODE)->parts, PARTS); \
285 CHECK_STRING((NODE)->ref, REF)
286
287/* @brief check pattern
288 * @param[in] NODE pointer to lysc_pattern value
289 * @param[in] DSC expected descriptin (string)
290 * @param[in] EAPPTAG expected string reprezenting error-app-tag value
291 * @param[in] EMSG expected string reprezenting error message
292 * @param[in] EEXPR expected string reprezenting original, not compiled, regular expression
293 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
294 * @param[in] INVERTED if regular expression is inverted.
295 * @param[in] REF expected reference
296 */
297#define CHECK_LYSC_PATTERN(NODE, DSC, EAPPTAG, EMSG, EXPR, EXTS, INVERTED, REF) \
298 assert_non_null(NODE); \
299 assert_non_null((NODE)->code); \
300 CHECK_STRING((NODE)->dsc, DSC); \
301 CHECK_STRING((NODE)->eapptag, EAPPTAG); \
302 CHECK_STRING((NODE)->emsg, EMSG); \
303 CHECK_STRING((NODE)->expr, EXPR); \
304 CHECK_ARRAY((NODE)->exts, EXTS); \
305 assert_int_equal((NODE)->inverted, INVERTED); \
306 CHECK_STRING((NODE)->ref, REF)
307
308/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200309 * @brief assert that lysp_action_inout structure members are correct
310 * @param[in] NODE pointer to lysp_action_inout variable
311 * @param[in] DATA 0 -> check if pointer to data is NULL, 1 -> check if pointer to data is not null
312 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extens list
313 * @param[in] GROUPINGS expected [sized array](@ref sizedarrays) size of grouping list
314 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of must restriction list
315 * @param[in] NODETYPE node type. LYS_INPUT or LYS_OUTPUT
316 * @param[in] PARENT 0 -> check if node is root, 1 -> check if node is not root
317 * @param[in] TYPEDEFS expected [sized array](@ref sizedarrays) size of typedefs list
318 */
319#define CHECK_LYSP_ACTION_INOUT(NODE, DATA, EXTS, GROUPINGS, MUSTS, NODETYPE, PARENT, TYPEDEFS) \
320 assert_non_null(NODE); \
Radek Krejci01180ac2021-01-27 08:48:22 +0100321 CHECK_POINTER((NODE)->child, DATA); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200322 CHECK_ARRAY((NODE)->exts, EXTS); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100323 CHECK_POINTER((NODE)->groupings, GROUPINGS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200324 CHECK_ARRAY((NODE)->musts, MUSTS); \
325 assert_int_equal((NODE)->nodetype, NODETYPE); \
326 CHECK_POINTER((NODE)->parent, PARENT); \
327 CHECK_ARRAY((NODE)->typedefs, TYPEDEFS);
328
329/**
330 * @brief assert that lysp_action structure members are correct
331 * @param[in] NODE pointer to lysp_action variable
332 * @param[in] DSC expected description
333 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of extension list
334 * @param[in] FLAGS expected [schema node flags](@ref snodeflags)
335 * @param[in] GROUPINGS expected [sized array](@ref sizedarrays) size of grouping list
336 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of if-feature expressions list
337 * @param[in] INPUT_* ::LYSP_ACTION_INOUT_CHECK
338 * @param[in] NAME expected name
339 * @param[in] NODETYPE node type. LYS_RPC or LYS_ACTION
340 * @param[in] OUTPUT_* ::LYSP_ACTION_INOUT_CHECK
341 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
342 * @param[in] REF expected reference
343 * @param[in] TYPEDEFS expected [sized array](@ref sizedarrays) size of list of typedefs
344 */
345#define CHECK_LYSP_ACTION(NODE, DSC, EXTS, FLAGS, GROUPINGS, IFFEATURES, \
346 INPUT_DATA, INPUT_EXTS, INPUT_GROUPINGS, INPUT_MUSTS, \
347 INPUT_PARENT, INPUT_TYPEDEFS, \
348 NAME, NODETYPE, \
349 OUTPUT_DATA, OUTPUT_EXTS, OUTPUT_GROUPINGS, OUTPUT_MUSTS, \
350 OUTPUT_PARENT, OUTPUT_TYPEDEFS, \
351 PARENT, REF, TYPEDEFS) \
352 assert_non_null(NODE); \
353 CHECK_STRING((NODE)->dsc, DSC); \
354 CHECK_ARRAY((NODE)->exts, EXTS); \
355 assert_int_equal((NODE)->flags, FLAGS); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100356 CHECK_POINTER((NODE)->groupings, GROUPINGS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200357 CHECK_ARRAY((NODE)->iffeatures, IFFEATURES); \
358 CHECK_LYSP_ACTION_INOUT(&((NODE)->input), INPUT_DATA, INPUT_EXTS, INPUT_GROUPINGS, \
359 INPUT_MUSTS, LYS_INPUT, INPUT_PARENT, INPUT_TYPEDEFS); \
360 assert_string_equal((NODE)->name, NAME); \
361 assert_int_equal((NODE)->nodetype, NODETYPE); \
362 CHECK_LYSP_ACTION_INOUT(&((NODE)->output), OUTPUT_DATA, OUTPUT_EXTS, OUTPUT_GROUPINGS, \
363 OUTPUT_MUSTS, LYS_OUTPUT, OUTPUT_PARENT, OUTPUT_TYPEDEFS); \
364 CHECK_POINTER((NODE)->parent, PARENT); \
365 CHECK_STRING((NODE)->ref, REF); \
366 CHECK_ARRAY((NODE)->typedefs, TYPEDEFS) \
367
368/**
369 * @brief assert that lysp_when structure members are correct
370 * @param[in] NODE pointer to lysp_when variable
371 * @param[in] COND expected string specifid condition
372 * @param[in] DSC expected string description statement
373 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension array
374 * @param[in] REF expected string reference
375 */
376#define CHECK_LYSP_WHEN(NODE, COND, DSC, EXTS, REF) \
377 assert_non_null(NODE); \
378 assert_string_equal((NODE)->cond, COND); \
379 CHECK_STRING((NODE)->dsc, DSC); \
380 CHECK_ARRAY((NODE)->exts, EXTS); \
381 if (REF == NULL) { \
382 assert_null((NODE)->ref); \
383 } else { \
384 assert_non_null((NODE)->ref); \
385 assert_string_equal((NODE)->ref, REF); \
386 }
387
388/**
389 * @brief assert that lysp_restr structure members are correct
390 * @param[in] NODE pointer to lysp_restr variable
391 * @param[in] ARG_STR expected string. The restriction expression/value
392 * @param[in] DSC expected descrition
393 * @param[in] EAPPTAG expected string reprezenting error-app-tag value
394 * @param[in] EMSG expected string reprezenting error message
395 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension array
396 * @param[in] REF expected reference
397 */
398
399#define CHECK_LYSP_RESTR(NODE, ARG_STR, DSC, EAPPTAG, EMSG, EXTS, REF) \
400 assert_non_null(NODE); \
401 assert_non_null((NODE)->arg.mod); \
402 assert_string_equal((NODE)->arg.str, ARG_STR); \
403 CHECK_STRING((NODE)->dsc, DSC); \
404 CHECK_STRING((NODE)->eapptag, EAPPTAG); \
405 CHECK_STRING((NODE)->emsg, EMSG); \
406 CHECK_ARRAY((NODE)->exts, EXTS); \
407 CHECK_STRING((NODE)->ref, REF);
408
409/**
410 * @brief assert that lysp_import structure members are correct
411 * @param[in] NODE pointer to lysp_import variable
412 * @param[in] DSC expected description or NULL
413 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extensions
414 * @param[in] NAME expected name of imported module
415 * @param[in] PREFIX expected prefix for the data from the imported schema
416 * @param[in] REF expected reference
417 * @prame[in] REV expected reprezenting date in format "11-10-2020"
418 */
419#define CHECK_LYSP_IMPORT(NODE, DSC, EXTS, NAME, PREFIX, REF, REV) \
420 assert_non_null(NODE); \
421 CHECK_STRING((NODE)->dsc, DSC); \
422 CHECK_ARRAY((NODE)->exts, EXTS); \
423 /*assert_non_null((NODE)->module); // ?? it is mandatory but in some test it doesnt work */ \
424 assert_string_equal((NODE)->name, NAME); \
425 assert_string_equal((NODE)->prefix, PREFIX); \
426 CHECK_STRING((NODE)->ref, REF); \
427 CHECK_STRING((NODE)->rev, REV); \
428
429/**
430 * @brief assert that lysp_ext structure members are correct
431 * @param[in] NODE pointer to lysp_ext_instance variable
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100432 * @param[in] ARGNAME expected argument name
Radek Iša56ca9e42020-09-08 18:42:00 +0200433 * @param[in] COMPILED 0 -> compiled data dosnt exists, 1 -> compiled data exists
434 * @param[in] DSC expected string reprezent description
435 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension instances
436 * @param[in] FLAGS expected LYS_STATUS_* and LYS_YINELEM_* values (@ref snodeflags)
437 * @param[in] NAME expected name
438 * @param[in] REF expected ref
439 */
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100440#define CHECK_LYSP_EXT(NODE, ARGNAME, COMPILED, DSC, EXTS, FLAGS, NAME, REF) \
Radek Iša56ca9e42020-09-08 18:42:00 +0200441 assert_non_null(NODE); \
Radek Krejci9f87b0c2021-03-05 14:45:26 +0100442 CHECK_STRING((NODE)->argname, ARGNAME); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200443 CHECK_POINTER((NODE)->compiled, COMPILED); \
444 CHECK_STRING((NODE)->dsc, DSC); \
445 CHECK_ARRAY((NODE)->exts, EXTS); \
446 assert_int_equal((NODE)->flags, FLAGS); \
447 assert_string_equal((NODE)->name, NAME); \
448 CHECK_STRING((NODE)->ref, REF);
449
450/**
451 * @brief assert that lysp_ext_instance structure members are correct
452 * @param[in] NODE pointer to lysp_ext_instance variable
453 * @param[in] ARGUMENT expected optional value of the extension's argument
454 * @param[in] CHILD 0 -> node doesnt have child, 1 -> node have children
Radek Krejciab430862021-03-02 20:13:40 +0100455 * @param[in] PARENT_STMT expected value identifying placement of the extension instance
456 * @param[in] PARENT_STMT_INDEX expected indentifi index
Michal Vaskofc2cd072021-02-24 13:17:17 +0100457 * @param[in] FORMAT expected format
Radek Iša56ca9e42020-09-08 18:42:00 +0200458 */
Radek Krejci85ac8312021-03-03 20:21:33 +0100459#define CHECK_LYSP_EXT_INSTANCE(NODE, ARGUMENT, CHILD, PARENT_STMT, PARENT_STMT_INDEX, NAME, FORMAT) \
Radek Iša56ca9e42020-09-08 18:42:00 +0200460 assert_non_null(NODE); \
461 CHECK_STRING((NODE)->argument, ARGUMENT); \
462 CHECK_POINTER((NODE)->child, CHILD); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200463 /*assert_int_equal((NODE)->flags, LYS_INTERNAL);*/ \
Radek Krejciab430862021-03-02 20:13:40 +0100464 assert_int_equal((NODE)->parent_stmt, PARENT_STMT); \
465 assert_int_equal((NODE)->parent_stmt_index, PARENT_STMT_INDEX); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200466 assert_string_equal((NODE)->name, NAME); \
Michal Vaskofc2cd072021-02-24 13:17:17 +0100467 assert_int_equal((NODE)->format, FORMAT);
Radek Iša56ca9e42020-09-08 18:42:00 +0200468
469/**
470 * @brief assert that lysp_stmt structure members are correct
471 * @param[in] NODE pointer to lysp_stmt variable
472 * @param[in] ARG expected statemet argumet
473 * @param[in] CHILD 0 -> node doesnt have child, 1 -> node have children
474 * @param[in] FLAGS expected statement flags, can be set to LYS_YIN_ATTR
475 * @param[in] KW expected numeric respresentation of the stmt value
476 * @param[in] NEXT 0 -> pointer is NULL, 1 -> pointer is not null
477 * @param[in] STMS expected identifier of the statement
478 */
479#define CHECK_LYSP_STMT(NODE, ARG, CHILD, FLAGS, KW, NEXT, STMT) \
480 assert_non_null(NODE); \
481 CHECK_STRING((NODE)->arg, ARG); \
482 CHECK_POINTER((NODE)->child, CHILD); \
483 assert_int_equal((NODE)->flags, FLAGS); \
484 assert_int_equal((NODE)->kw, KW); \
485 CHECK_POINTER((NODE)->next, NEXT); \
486 assert_string_equal((NODE)->stmt, STMT); \
487
488/**
489 * @brief assert that lysp_type_enum structure members are correct
490 * @param[in] NODE pointer to lysp_type_enum variable
491 * @param[in] DSC expected description
492 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
493 * @param[in] FLAGS only LYS_STATUS_ and LYS_SET_VALUE values are allowed
494 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of list of the extension instances
495 * @param[in] NAME expected name
496 * @param[in] REF expected reference statement
497 * @param[in] VALUE expected enum's value or bit's position
498 */
499#define CHECK_LYSP_TYPE_ENUM(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, REF, VALUE) \
500 assert_non_null(NODE); \
501 CHECK_STRING((NODE)->dsc, DSC); \
502 CHECK_ARRAY((NODE)->exts, EXTS); \
503 assert_int_equal((NODE)->flags, FLAGS); \
504 CHECK_ARRAY((NODE)->iffeatures, IFFEATURES); \
505 CHECK_STRING((NODE)->name, NAME); \
506 CHECK_STRING((NODE)->ref, REF); \
507 assert_int_equal(VALUE, (NODE)->value);
508
509/**
Radek Išaa9ff2b82021-01-13 21:44:13 +0100510 * @brief assert that lysp_type_enum structure members are correct
511 * @param[in] NODE pointer to lysp_type variable
512 * @param[in] BASES expected [sized array](@ref sizedarrays) size of list of indentifiers
513 * @param[in] BITS expected [sized array](@ref sizedarrays) size of list of bits
514 * @param[in] COMPILED 0 -> pointer to compiled type is null, 1 -> pointer to compilet type is valid
515 * @param[in] ENUMS expected [sized array](@ref sizedarrays) size of list of enums-stmts
516 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of extension instances
517 * @param[in] FLAGS expected flags
518 * @param[in] FRACTION_DIGITS expected number of fraction digits decimal64
519 * @param[in] LENGTH expected 0 -> there isnt any restriction on length, 1 -> type is restricted on length (string, binary)
520 * @param[in] NAME expected name of type
521 * @param[in] PATH 0 -> no pointer to parsed path, 1 -> pointer to parsed path is valid
522 * @param[in] PATTERNS expected [sized array](@ref sizedarrays) size of list of patterns for string
523 * @param[in] PMOD expected submodule where type is defined 0 -> pointer is null, 1 -> pointer is not null
524 * @param[in] RANGE expected [sized array](@ref sizedarrays) size of list of range restriction
525 * @param[in] REQUIRE_INSTANCE expected require instance flag
526 * @param[in] TYPES expected [sized array](@ref sizedarrays) size of list of sub-types
527 */
528#define CHECK_LYSP_TYPE(NODE, BASES, BITS, COMPILED, ENUMS, EXTS, FLAGS, FRACTIONS_DIGITS, \
529 LENGTH, NAME, PATH, PATTERNS, PMOD, RANGE, REQUIRE_INSTANCE, TYPES) \
530 assert_non_null(NODE);\
531 CHECK_ARRAY((NODE)->bases, BASES); \
532 CHECK_ARRAY((NODE)->bits, BITS); \
533 CHECK_POINTER((NODE)->compiled, COMPILED); \
534 CHECK_ARRAY((NODE)->enums, ENUMS); \
535 CHECK_ARRAY((NODE)->exts, EXTS); \
536 assert_int_equal((NODE)->flags, FLAGS); \
537 assert_int_equal((NODE)->fraction_digits, FRACTIONS_DIGITS); \
538 CHECK_POINTER((NODE)->length, LENGTH); \
539 CHECK_STRING((NODE)->name, NAME); \
540 CHECK_POINTER((NODE)->path, PATH); \
541 CHECK_ARRAY((NODE)->patterns, PATTERNS); \
542 CHECK_POINTER((NODE)->pmod, PMOD); \
543 CHECK_POINTER((NODE)->range, RANGE); \
544 assert_int_equal((NODE)->require_instance, REQUIRE_INSTANCE); \
545 CHECK_ARRAY((NODE)->types , TYPES)
546
547/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200548 * @brief assert that lysp_node structure members are correct
549 * @param[in] NODE pointer to lysp_node variable
550 * @param[in] DSC expected description statement
551 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
552 * @param[in] FLAGS [schema node flags](@ref snodeflags)
553 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of list of the extension instances
554 * @param[in] NAME expected name
555 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
556 * @param[in] NODETYPE node type LYS_UNKNOWN, LYS_CONTAINER, LYS_CHOICE, LYS_LEAF, LYS_LEAFLIST,
557 * LYS_LIST, LYS_ANYXML, LYS_ANYDATA, LYS_CASE, LYS_RPC, LYS_ACTION, LYS_NOTIF,
558 * LYS_USES, LYS_INPUT, LYS_OUTPUT, LYS_GROUPING, LYS_AUGMENT
559 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
560 * @param[in] REF expected reference statement
561 * @param[in] WHEN 0-> pointer is null, 1 -> pointer is not null
562 */
563#define CHECK_LYSP_NODE(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, NEXT, NODETYPE, PARENT, REF, WHEN) \
564 assert_non_null(NODE); \
565 CHECK_STRING((NODE)->dsc, DSC); \
566 CHECK_ARRAY((NODE)->exts, EXTS); \
567 assert_int_equal((NODE)->flags, FLAGS); \
568 CHECK_ARRAY((NODE)->iffeatures, IFFEATURES); \
569 CHECK_STRING((NODE)->name, NAME); \
570 CHECK_POINTER((NODE)->next, NEXT); \
571 assert_int_equal((NODE)->nodetype, NODETYPE); \
572 CHECK_POINTER((NODE)->parent, PARENT); \
573 CHECK_STRING((NODE)->ref, REF); \
Radek Krejci9a3823e2021-01-27 20:26:46 +0100574 CHECK_POINTER(lysp_node_when((struct lysp_node *)NODE), WHEN);
Radek Iša56ca9e42020-09-08 18:42:00 +0200575
576/**
Radek Išaa9ff2b82021-01-13 21:44:13 +0100577 * @brief assert that lysp_node structure members are correct
578 * @param[in] NODE pointer to lysp_node variable
579 * @param[in] DSC expected description statement
580 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
581 * @param[in] FLAGS [schema node flags](@ref snodeflags)
582 * @param[in] IFFEATURES expected [sized array](@ref sizedarrays) size of list of the extension instances
583 * @param[in] NAME expected name
584 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
585 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
586 * @param[in] REF expected reference statement
587 * @param[in] WHEN 0-> pointer is null, 1 -> pointer is not null
588 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of list of must restriction
589 * @param[in] UNITS expected string reprezenting units
590 * @param[in] DFLT 0-> node dosn't have default value. 1 -> node have default value
591 */
592#define CHECK_LYSP_NODE_LEAF(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, NEXT, \
593 PARENT, REF, WHEN, MUSTS, UNITS, DFLT) \
594 CHECK_LYSP_NODE(NODE, DSC, EXTS, FLAGS, IFFEATURES, NAME, NEXT, LYS_LEAF, PARENT, REF, WHEN); \
595 CHECK_ARRAY((NODE)->musts, MUSTS); \
596 CHECK_STRING((NODE)->units, UNITS); \
597 CHECK_STRING((NODE)->dflt.str, DFLT);
598
599/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200600 * @brief assert that lysc_notif structure members are correct
601 * @param[in] NODE pointer to lysp_notif variable
602 * @param[in] DATA 0 pointer is null, 1 pointer is not null
603 * @param[in] DSC expected description
604 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
605 * @param[in] FLAGS [schema node flags](@ref snodeflags)
606 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
607 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of list of must restriction
608 * @param[in] NAME expected name
609 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
610 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
611 * @param[in] REF expected reference
612 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
613 */
614#define CHECK_LYSC_NOTIF(NODE, DATA, DSC, EXTS, FLAGS, MODULE, MUSTS, NAME, PARENT, PRIV, REF, WHEN) \
615 assert_non_null(NODE); \
Radek Krejci01180ac2021-01-27 08:48:22 +0100616 CHECK_POINTER((NODE)->child, DATA); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200617 CHECK_STRING((NODE)->dsc, DSC); \
618 CHECK_ARRAY((NODE)->exts, EXTS); \
619 assert_int_equal((NODE)->flags, FLAGS); \
620 CHECK_POINTER((NODE)->module, MODULE); \
621 CHECK_ARRAY((NODE)->musts, MUSTS); \
622 assert_string_equal((NODE)->name, NAME); \
623 assert_int_equal((NODE)->nodetype, LYS_NOTIF); \
624 CHECK_POINTER((NODE)->parent, PARENT); \
625 CHECK_POINTER((NODE)->priv, PRIV); \
626 CHECK_STRING((NODE)->ref, REF); \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100627 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN);
Radek Iša56ca9e42020-09-08 18:42:00 +0200628
629/**
630 * @brief assert that lysc_action_inout structure members are correct
631 * @param[in] NODE pointer to lysp_notif variable
632 * @param[in] DATA 0 pointer is null, 1 pointer is not null
633 * @param[in] MUST expected [sized array](@ref sizedarrays) size of list of must restrictions
634 * @param[in] NODETYPE LYS_INPUT or LYS_OUTPUT
635 */
636#define CHECK_LYSC_ACTION_INOUT(NODE, DATA, MUST, NODETYPE) \
637 assert_non_null(NODE); \
Radek Krejci01180ac2021-01-27 08:48:22 +0100638 CHECK_POINTER((NODE)->child, DATA); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200639 CHECK_ARRAY((NODE)->musts, MUST); \
640 assert_int_equal((NODE)->nodetype, NODETYPE);
641
642/**
643 * @brief assert that lysc_action structure members are correct
644 * @param[in] NODE pointer to lysp_action variable
645 * @param[in] DSC string description statement
646 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
647 * @param[in] FLAGS [schema node flags](@ref snodeflags)
648 * @param[in] INPUT_DATA 0 pointer is null, 1 pointer is not null
649 * @param[in] INPUT_MUST expected [sized array](@ref sizedarrays) size of input list of must restrictions
650 * @param[in] INPUT_EXTS expected [sized array](@ref sizedarrays) size of the input extension instances of input
651 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
652 * @param[in] NAME expected name
653 * @param[in] NODETYPE LYS_RPC, LYS_ACTION
654 * @param[in] OUTPUT_DATA 0 pointer is null, 1 pointer is not null
655 * @param[in] OUTPUT_MUST expected [sized array](@ref sizedarrays) size of output list of must restrictions
656 * @param[in] OUTPUT_EXTS expected [sized array](@ref sizedarrays) size of the output extension instances of input
657 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
658 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
659 * @param[in] REF expected reference
660 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
661 */
662#define CHECK_LYSC_ACTION(NODE, DSC, EXTS, FLAGS, INPUT_DATA, INPUT_MUST, INPUT_EXTS, MODULE, NAME, NODETYPE, \
663 OUTPUT_DATA, OUTPUT_MUST, OUTPUT_EXTS, PARENT, PRIV, REF, WHEN) \
664 assert_non_null(NODE); \
665 CHECK_STRING((NODE)->dsc, DSC); \
666 CHECK_ARRAY((NODE)->exts, EXTS); \
667 assert_int_equal((NODE)->flags, FLAGS); \
668 CHECK_LYSC_ACTION_INOUT(&(NODE)->input, INPUT_DATA, INPUT_MUST, LYS_INPUT); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100669 CHECK_ARRAY((NODE)->input.exts, INPUT_EXTS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200670 CHECK_POINTER((NODE)->module, MODULE); \
671 assert_string_equal((NODE)->name, NAME); \
672 assert_int_equal((NODE)->nodetype, NODETYPE); \
673 CHECK_LYSC_ACTION_INOUT(&(NODE)->output, OUTPUT_DATA, OUTPUT_MUST, LYS_OUTPUT); \
Radek Krejci2a9fc652021-01-22 17:44:34 +0100674 CHECK_ARRAY((NODE)->output.exts, OUTPUT_EXTS); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200675 CHECK_POINTER((NODE)->parent, PARENT); \
676 CHECK_POINTER((NODE)->priv, PRIV); \
677 CHECK_STRING((NODE)->ref, REF); \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100678 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN);
Radek Iša56ca9e42020-09-08 18:42:00 +0200679
680/**
681 * @brief assert that lysc_node structure members are correct
682 * @param[in] NODE pointer to lysc_node variable
683 * @param[in] DSC expected description
684 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
685 * @param[in] FLAGS [schema node flags](@ref snodeflags)
686 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
687 * @param[in] NAME expected name
688 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
689 * @param[in] NODETYPE type of the node LYS_UNKNOWN, LYS_CONTAINER, LYS_CHOICE, LYS_LEAF,
690 * LYS_LEAFLIST, LYS_LIST, LYS_ANYXML, LYS_ANYDATA, LYS_CASE, LYS_RPC,
691 * LYS_ACTION, LYS_NOTIF, LYS_USES, LYS_INPUT, LYS_OUTPUT, LYS_GROUPING,
692 * LYS_AUGMENT
693 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
694 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
695 * @param[in] REF expected reference
696 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
697 */
698#define CHECK_LYSC_NODE(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, NODETYPE, PARENT, PRIV, REF, WHEN) \
699 assert_non_null(NODE); \
700 CHECK_STRING((NODE)->dsc, DSC); \
701 CHECK_ARRAY((NODE)->exts, EXTS); \
702 assert_int_equal((NODE)->flags, FLAGS); \
703 CHECK_POINTER((NODE)->module, MODULE); \
704 assert_string_equal((NODE)->name, NAME); \
705 CHECK_POINTER((NODE)->next, NEXT); \
706 assert_int_equal((NODE)->nodetype, NODETYPE); \
707 CHECK_POINTER((NODE)->parent, PARENT); \
708 assert_non_null((NODE)->prev); \
709 CHECK_POINTER((NODE)->priv, PRIV); \
710 CHECK_STRING((NODE)->ref, REF); \
Radek Išaa9ff2b82021-01-13 21:44:13 +0100711 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN);
712
713/**
714 * @brief assert that lysc_node_leaf structure members are correct
715 * @param[in] NODE pointer to lysc_node variable
716 * @param[in] DSC expected description
717 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
718 * @param[in] FLAGS [schema node flags](@ref snodeflags)
719 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
720 * @param[in] NAME expected name
721 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
722 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
723 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
724 * @param[in] REF expected reference
Radek Išaa76902f2021-03-29 08:52:51 +0200725 * @param[in] ACTIONS 1 if is set pointer to structure lysc_node_action other 0
726 * @param[in] CHILD 1 if is set pointer to child other 0
727 * @param[in] MAX possible maximum elements in list
728 * @param[in] MIN possible minimum elements in list
729 * @param[in] MUSTS [sized array](@ref sizedarrays) number of must node elements in array
730 * @param[in] NOTIFS 1 if is set pointer to any notifs node
731 * @param[in] UNIQUES [sized array](@ref sizedarrays) number of unique nodes element in array
732 * @param[in] WHEN [sized array](@ref sizedarrays) size of when node array
733 */
734#define CHECK_LYSC_NODE_LIST(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, \
735 PARENT, PRIV, REF, ACTIONS, CHILD, MAX, MIN, MUSTS, NOTIFS, UNIQUES, WHEN) \
736 CHECK_LYSC_NODE(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, LYS_LIST, PARENT, PRIV, REF, WHEN); \
737 CHECK_POINTER((NODE)->actions, ACTIONS); \
738 CHECK_POINTER((NODE)->child, CHILD); \
739 assert_int_equal((NODE)->max, MAX); \
740 assert_int_equal((NODE)->min, MIN); \
741 CHECK_ARRAY((NODE)->musts, MUSTS); \
742 CHECK_POINTER((NODE)->notifs, NOTIFS); \
743 CHECK_ARRAY((NODE)->uniques, UNIQUES); \
744 CHECK_ARRAY(lysc_node_when((const struct lysc_node *)NODE), WHEN)
745
746/**
747 * @brief assert that lysc_node_leaf structure members are correct
748 * @param[in] NODE pointer to lysc_node variable
749 * @param[in] DSC expected description
750 * @param[in] EXTS expected [sized array](@ref sizedarrays) size of list of the extension instances
751 * @param[in] FLAGS [schema node flags](@ref snodeflags)
752 * @param[in] MODULE 0 pointer is null, 1 pointer is not null
753 * @param[in] NAME expected name
754 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
755 * @param[in] PARENT 0-> check if node is root, 1-> check if node is not root
756 * @param[in] PRIV 0-> pointer is null, 1-> pointer is not null
757 * @param[in] REF expected reference
758 * @param[in] WHEN expected [sized array](@ref sizedarrays) size of list of pointers to when statements
Radek Išaa9ff2b82021-01-13 21:44:13 +0100759 * @param[in] MUSTS expected [sized array](@ref sizedarrays) size of list of must restriction
760 * @param[in] UNITS expected string reprezenting units
761 * @param[in] DFLT 0-> node dosn't have default value. 1 -> node have default value
762 */
763#define CHECK_LYSC_NODE_LEAF(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, \
764 PARENT, PRIV, REF, WHEN, MUSTS, UNITS, DFLT) \
765 CHECK_LYSC_NODE(NODE, DSC, EXTS, FLAGS, MODULE, NAME, NEXT, LYS_LEAF, PARENT, PRIV, REF, WHEN); \
766 CHECK_ARRAY((NODE)->musts, MUSTS); \
767 assert_non_null((NODE)->type); \
768 CHECK_STRING((NODE)->units, UNITS); \
769 CHECK_POINTER((NODE)->dflt, DFLT);
Radek Iša56ca9e42020-09-08 18:42:00 +0200770
771/**
772 * @brief assert that lyd_meta structure members are correct
773 * @param[in] NODE pointer to lyd_meta variable
774 * @param[in] ANNOTATION 0 pointer is null, 1 pointer is not null
775 * @param[in] NAME expected name
776 * @param[in] NEXT 0 pointer is null, 1 pointer is not null
777 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
778 * part of text reprezenting LY_DATA_TYPE.
779 * @param[in] ... ::CHECK_LYD_VALUE
780 */
781#define CHECK_LYD_META(NODE, ANNOTATION, NAME, NEXT, PARENT, TYPE_VAL, ...) \
782 assert_non_null(NODE); \
783 CHECK_POINTER((NODE)->annotation, ANNOTATION); \
784 assert_string_equal((NODE)->name, NAME); \
785 CHECK_POINTER((NODE)->next, NEXT); \
786 CHECK_POINTER((NODE)->parent, PARENT); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200787 CHECK_LYD_VALUE((NODE)->value, TYPE_VAL, __VA_ARGS__);
Radek Iša56ca9e42020-09-08 18:42:00 +0200788
789/**
790 * @brief assert that lyd_node_term structure members are correct
791 * @param[in] NODE pointer to lyd_node_term variable
792 * @param[in] FLAGS expected [data node flags](@ref dnodeflags)
793 * @param[in] META 0 -> meta is not prezent, 1 -> meta is prezent
794 * @param[in] NEXT 0 -> next node is not prezent, 1 -> next node is prezent
795 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
796 * part of text reprezenting LY_DATA_TYPE.
797 * @param[in] ... ::CHECK_LYD_VALUE
798 */
799#define CHECK_LYD_NODE_TERM(NODE, FLAGS, META, NEXT, PARENT, SCHEMA, VALUE_TYPE, ...) \
800 assert_non_null(NODE); \
801 assert_int_equal((NODE)->flags, FLAGS); \
802 CHECK_POINTER((NODE)->meta, META); \
803 CHECK_POINTER((NODE)->next, NEXT); \
804 CHECK_POINTER((NODE)->parent, PARENT); \
805 assert_non_null((NODE)->prev); \
806 CHECK_POINTER((NODE)->schema, SCHEMA); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200807 CHECK_LYD_VALUE((NODE)->value, VALUE_TYPE, __VA_ARGS__);
Radek Iša56ca9e42020-09-08 18:42:00 +0200808
809/**
810 * @brief assert that lyd_node_any structure members are correct
811 * @param[in] NODE pointer to lyd_node_term variable
812 * @param[in] FLAGS expected [data node flags](@ref dnodeflags)
813 * @param[in] META 0 meta isnt present , 1 meta is present
814 * @param[in] PARENT 0 it is root node , 1 node have parent
815 * @param[in] VALUE_TYPE value type ::lyd_node_any.value
816 */
817#define CHECK_LYD_NODE_ANY(NODE, FLAGS, META, PARENT, VALUE_TYPE) \
818 assert_non_null(NODE); \
819 assert_int_equal((NODE)->flags, FLAGS); \
820 CHECK_POINTER((NODE)->meta, META); \
821 CHECK_POINTER((NODE)->meta, PARENT); \
822 assert_non_null((NODE)->prev); \
823 assert_non_null((NODE)->schema); \
824 assert_int_equal((NODE)->value_type, VALUE_TYPE);
825
826/**
827 * @brief assert that lyd_node_opaq structure members are correct
828 * @param[in] NODE pointer to lyd_node_opaq variable
829 * @param[in] ATTR 0 if pointer is null ,1 if pointer is not null
830 * @param[in] CHILD 0 if pointer is null ,1 if pointer is not null
831 * @param[in] FORMAT LY_PREF_XML or LY_PREF_JSON
832 * @param[in] VAL_PREFS 0 if pointer is null ,1 if pointer is not null
833 * @param[in] NAME expected name
834 * @param[in] value expected orignal value
835 */
836#define CHECK_LYD_NODE_OPAQ(NODE, ATTR, CHILD, FORMAT, NAME, NEXT, PARENT, PREFIX, VAL_PREFS, VALUE) \
837 assert_non_null(NODE); \
838 CHECK_POINTER((NODE)->attr, ATTR); \
839 CHECK_POINTER((NODE)->child, CHILD); \
840 assert_ptr_equal((NODE)->ctx, UTEST_LYCTX); \
841 assert_int_equal((NODE)->flags, 0); \
842 assert_true((NODE)->format == FORMAT); \
843 assert_int_equal((NODE)->hash, 0); \
844 assert_string_equal((NODE)->name.name, NAME); \
845 assert_non_null((NODE)->prev); \
846 assert_null((NODE)->schema); \
847 CHECK_POINTER((NODE)->val_prefix_data, VAL_PREFS); \
848 assert_string_equal((NODE)->value, VALUE);
849
850/**
Radek Išaa76902f2021-03-29 08:52:51 +0200851 * @brief assert that lyd_node_opaq structure members are correct
852 * @param[in] NODE pointer to lyd_node_opaq variable
853 * @param[in] CHILD 1 if node has children other 0
854 * @param[in] HILD_HT 1 if node has children hash table other 0
855 * @param[in] META 1 if node has metadata other 0
856 * @param[in] FLAGS expected flag
857 * @param[in] NEXT 1 if next node is present other 0
858 * @param[in] PARENT 1 if node has parent other 0
859 * @param[in] PRIV 1 if node has private data other 0
860 * @param[in] SCHEMA 1 if node has schema other 0
861*/
862#define CHECK_LYD_NODE_INNER(NODE, CHILD, CHILD_HT, META, FLAGS, NEXT, PARENT, PRIV, SCHEMA) \
863 assert_non_null(NODE); \
864 CHECK_POINTER((NODE)->child, CHILD); \
865 CHECK_POINTER((NODE)->children_ht, CHILD_HT); \
866 CHECK_POINTER((NODE)->meta, META); \
867 assert_int_equal((NODE)->flags, FLAGS); \
868 CHECK_POINTER((NODE)->parent, PARENT); \
869 assert_non_null((NODE)->prev); \
870 CHECK_POINTER((NODE)->next, NEXT); \
871 CHECK_POINTER((NODE)->priv, PRIV); \
872 CHECK_POINTER((NODE)->schema, SCHEMA)
873
874/**
Radek Iša56ca9e42020-09-08 18:42:00 +0200875 * @brief assert that lyd_value structure members are correct
876 * @param[in] NODE lyd_value
877 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
878 * part of text reprezenting LY_DATA_TYPE.
879 * @param[in] ... Unspecified parameters. Type and numbers of parameters are specified
880 * by type of value. These parameters are passed to macro
881 * CHECK_LYD_VALUE_ ## TYPE_VAL.
882 */
883#define CHECK_LYD_VALUE(NODE, TYPE_VAL, ...) \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200884 CHECK_LYD_VALUE_ ## TYPE_VAL (NODE, __VA_ARGS__);
Radek Iša56ca9e42020-09-08 18:42:00 +0200885
886/*
887 * LYD VALUES CHECKING SPECIALIZATION
888 */
889
890/**
891 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type EMPTY
892 * Example CHECK_LYD_VALUE(node->value, EMPTY, "");
893 * @param[in] NODE lyd_value variable
894 * @param[in] CANNONICAL_VAL expected cannonical value
895 */
896#define CHECK_LYD_VALUE_EMPTY(NODE, CANNONICAL_VAL) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200897 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200898 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200899 assert_non_null((NODE).realtype); \
900 assert_int_equal((NODE).realtype->basetype, LY_TYPE_EMPTY);
901
902/**
903 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type UNION
904 * Example CHECK_LYD_VALUE(node->value, UNION, "12", INT8, "12", 12);
905 * @warning type of subvalue cannot be UNION. Example of calling
906 * @param[in] NODE lyd_value variable
907 * @param[in] CANNONICAL_VAL expected cannonical value
908 * @param[in] TYPE_VAL value type. EMPTY, UNION, BITS, INST, ENUM, INT8, INT16, UINT8, STRING, LEAFREF, DEC64, BINARY, BOOL, IDENT
909 * @param[in] ... Unspecified parameters. Type and numbers of parameters are specified
910 * by type of value. These parameters are passed to macro
911 * CHECK_LYD_VALUE_ ## TYPE_VAL.
912 */
913#define CHECK_LYD_VALUE_UNION(NODE, CANNONICAL_VAL, TYPE_VAL, ...) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200914 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200915 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200916 assert_non_null((NODE).realtype); \
917 assert_int_equal(LY_TYPE_UNION, (NODE).realtype->basetype); \
918 assert_non_null((NODE).subvalue); \
919 assert_non_null((NODE).subvalue->prefix_data); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200920 CHECK_LYD_VALUE_ ## TYPE_VAL ((NODE).subvalue->value, __VA_ARGS__)
921
922/**
923 * @brief Internal macro. Get 1st variadic argument.
924 */
925#define _GETARG1(ARG1, ...) ARG1
Radek Iša56ca9e42020-09-08 18:42:00 +0200926
927/**
928 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type BITS
929 * Example arr[] = {"a", "b"}; CHECK_LYD_VALUE(node->value, BITS, "a b", arr);
930 * @param[in] NODE lyd_value variable
931 * @param[in] CANNONICAL_VAL expected cannonical value
932 * @param[in] VALUE expected array of bits names
933 */
Michal Vasko151ae6c2021-09-23 08:23:51 +0200934#define CHECK_LYD_VALUE_BITS(NODE, ...) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200935 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200936 assert_string_equal((NODE)._canonical, _GETARG1(__VA_ARGS__, DUMMY)); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200937 assert_non_null((NODE).realtype); \
938 assert_int_equal(LY_TYPE_BITS, (NODE).realtype->basetype); \
939 { \
Radek Išaded31052021-03-10 13:22:53 +0100940 const char *arr[] = { __VA_ARGS__ }; \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200941 LY_ARRAY_COUNT_TYPE arr_size = (sizeof(arr) / sizeof(arr[0])) - 1; \
Michal Vaskoaa0ee622021-05-11 09:29:25 +0200942 struct lyd_value_bits *_val; \
943 LYD_VALUE_GET(&(NODE), _val); \
944 assert_int_equal(arr_size, LY_ARRAY_COUNT(_val->items)); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200945 for (LY_ARRAY_COUNT_TYPE it = 0; it < arr_size; it++) { \
Michal Vasko151ae6c2021-09-23 08:23:51 +0200946 assert_string_equal(arr[it + 1], _val->items[it]->name); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200947 } \
948 }
949
950/**
951 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type INST
952 * @param[in] NODE lyd_value variable
953 * @param[in] CANNONICAL_VAL expected cannonical value
954 * @param[in] VALUE expected array of enum ly_path_pred_type
955 * @brief Example enum arr[] = {0x0, 0x1}; CHECK_LYD_VALUE(node->value, INST, "test/d", arr);
956 */
957#define CHECK_LYD_VALUE_INST(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200958 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200959 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200960 assert_non_null((NODE).realtype); \
961 assert_int_equal(LY_TYPE_INST, (NODE).realtype->basetype); \
962 { \
Michal Vasko79135ae2020-12-16 10:08:35 +0100963 LY_ARRAY_COUNT_TYPE arr_size = sizeof(VALUE) / sizeof(VALUE[0]); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200964 assert_int_equal(arr_size, LY_ARRAY_COUNT((NODE).target)); \
965 for (LY_ARRAY_COUNT_TYPE it = 0; it < arr_size; it++) { \
966 assert_int_equal(VALUE[it], (NODE).target[it].pred_type); \
967 } \
968 }
969
970/**
971 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type ENUM.
972 * Example CHECK_LYD_VALUE(node->value, ENUM, "item_name", "item_name");
973 * @param[in] NODE lyd_value variable
974 * @param[in] CANNONICAL_VAL expected cannonical value
975 * @param[in] VALUE expected enum item name
976 */
977#define CHECK_LYD_VALUE_ENUM(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200978 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200979 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200980 assert_non_null((NODE).realtype); \
981 assert_int_equal(LY_TYPE_ENUM, (NODE).realtype->basetype); \
982 assert_string_equal(VALUE, (NODE).enum_item->name);
983
984/**
985 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type INT8
986 * Example CHECK_LYD_VALUE(node->value, INT8, "12", 12);
987 * @param[in] NODE lyd_value variable
988 * @param[in] CANNONICAL_VAL expected cannonical value
989 * @param[in] VALUE expected inteager value (-128 to 127).
990 */
991#define CHECK_LYD_VALUE_INT8(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +0200992 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +0200993 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +0200994 assert_non_null((NODE).realtype); \
995 assert_int_equal(LY_TYPE_INT8, (NODE).realtype->basetype); \
996 assert_int_equal(VALUE, (NODE).int8);
997
998/**
999 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type INT16
1000 * Example CHECK_LYD_VALUE(node->value, INT8, "12", 12);
1001 * @param[in] NODE lyd_value variable
1002 * @param[in] CANNONICAL_VAL expected cannonical value
1003 * @param[in] VALUE expected inteager value.
1004 */
1005#define CHECK_LYD_VALUE_INT16(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001006 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001007 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001008 assert_non_null((NODE).realtype); \
1009 assert_int_equal(LY_TYPE_INT16, (NODE).realtype->basetype); \
1010 assert_int_equal(VALUE, (NODE).int16);
1011
1012/**
1013 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type UINT8.
1014 * Example CHECK_LYD_VALUE(node->value, UINT8, "12", 12);
1015 * @param[in] NODE lyd_value variable
1016 * @param[in] CANNONICAL_VAL expected cannonical value
1017 * @param[in] VALUE expected inteager (0 to 255).
1018 */
1019#define CHECK_LYD_VALUE_UINT8(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001020 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001021 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001022 assert_non_null((NODE).realtype); \
1023 assert_int_equal(LY_TYPE_UINT8, (NODE).realtype->basetype); \
1024 assert_int_equal(VALUE, (NODE).uint8);
1025
1026/**
Radek Išaa76902f2021-03-29 08:52:51 +02001027 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type UINT32.
1028 * Example CHECK_LYD_VALUE(node->value, UINT32, "12", 12);
1029 * @param[in] NODE lyd_value variable
1030 * @param[in] CANNONICAL_VAL expected cannonical value
1031 * @param[in] VALUE expected inteager (0 to MAX_UINT32).
1032 */
1033#define CHECK_LYD_VALUE_UINT32(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001034 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001035 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Išaa76902f2021-03-29 08:52:51 +02001036 assert_non_null((NODE).realtype); \
1037 assert_int_equal(LY_TYPE_UINT32, (NODE).realtype->basetype); \
1038 assert_int_equal(VALUE, (NODE).uint32);
1039
1040/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001041 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type STRING.
1042 * Example CHECK_LYD_VALUE(node->value, STRING, "text");
1043 * @param[in] NODE lyd_value variable
1044 * @param[in] CANNONICAL_VAL expected cannonical value
1045 */
1046#define CHECK_LYD_VALUE_STRING(NODE, CANNONICAL_VAL) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001047 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001048 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001049 assert_non_null((NODE).realtype); \
1050 assert_int_equal(LY_TYPE_STRING, (NODE).realtype->basetype);
1051
1052/**
1053 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type LEAFREF
1054 * @brief Example CHECK_LYD_VALUE(node->value, LEAFREF, "");
1055 * @param[in] NODE lyd_value variable
1056 * @param[in] CANNONICAL_VAL expected cannonical value
1057 */
1058#define CHECK_LYD_VALUE_LEAFREF(NODE, CANNONICAL_VAL) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001059 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001060 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001061 assert_non_null((NODE).realtype); \
1062 assert_int_equal(LY_TYPE_LEAFREF, (NODE).realtype->basetype); \
1063 assert_non_null((NODE).ptr)
1064
1065/**
1066 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type DEC64
1067 * Example CHECK_LYD_VALUE(node->value, DEC64, "125", 125);
1068 * @param[in] NODE lyd_value variable
1069 * @param[in] CANNONICAL_VAL expected cannonical value
1070 * @param[in] VALUE expected value 64bit inteager
1071*/
1072#define CHECK_LYD_VALUE_DEC64(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001073 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001074 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001075 assert_non_null((NODE).realtype); \
1076 assert_int_equal(LY_TYPE_DEC64, (NODE).realtype->basetype); \
1077 assert_int_equal(VALUE, (NODE).dec64);
1078
1079/**
1080 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type BINARY.
1081 * Example CHECK_LYD_VALUE(node->value, BINARY, "aGVs\nbG8=");
1082 * @param[in] NODE lyd_value variable
1083 * @param[in] CANNONICAL_VAL expected cannonical value
Michal Vasko495f4502021-04-27 14:48:05 +02001084 * @param[in] VALUE expected value data
1085 * @param[in] SIZE expected value data size
Radek Iša56ca9e42020-09-08 18:42:00 +02001086*/
Michal Vasko495f4502021-04-27 14:48:05 +02001087#define CHECK_LYD_VALUE_BINARY(NODE, CANNONICAL_VAL, VALUE, SIZE) \
Michal Vaskoaa0ee622021-05-11 09:29:25 +02001088 { \
1089 struct lyd_value_binary *_val; \
1090 LYD_VALUE_GET(&(NODE), _val); \
1091 assert_int_equal(_val->size, SIZE); \
1092 assert_int_equal(0, memcmp(_val->data, VALUE, SIZE)); \
1093 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
1094 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
1095 assert_non_null((NODE).realtype); \
1096 assert_int_equal(LY_TYPE_BINARY, (NODE).realtype->basetype); \
1097 }
Radek Iša56ca9e42020-09-08 18:42:00 +02001098
1099/**
1100 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type BOOL.
1101 * Example CHECK_LYD_VALUE(node->value, BOOL, "true", 1);
1102 * @param[in] NODE lyd_value variable
1103 * @param[in] CANNONICAL_VAL expected cannonical value
1104 * @param[in] VALUE expected boolean value 0,1
1105*/
1106#define CHECK_LYD_VALUE_BOOL(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001107 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001108 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001109 assert_non_null((NODE).realtype); \
1110 assert_int_equal(LY_TYPE_BOOL, (NODE).realtype->basetype); \
1111 assert_int_equal(VALUE, (NODE).boolean);
1112
1113/**
1114 * @brief Internal macro. Assert that lyd_value structure members are correct. Lyd value is type IDENT.
1115 * Example CHECK_LYD_VALUE(node->value, IDENT, "types:gigabit-ethernet", "gigabit-ethernet");
1116 * @param[in] NODE lyd_value variable
1117 * @param[in] CANNONICAL_VAL expected cannonical value
1118 * @param[in] VALUE expected ident name
1119*/
1120#define CHECK_LYD_VALUE_IDENT(NODE, CANNONICAL_VAL, VALUE) \
Radek Krejci6d5ba0c2021-04-26 07:49:59 +02001121 assert_non_null((NODE).realtype->plugin->print(UTEST_LYCTX, &(NODE), LY_VALUE_CANON, NULL, NULL, NULL)); \
Radek Krejci995784f2021-04-26 08:02:13 +02001122 assert_string_equal((NODE)._canonical, CANNONICAL_VAL); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001123 assert_non_null((NODE).realtype); \
1124 assert_int_equal(LY_TYPE_IDENT, (NODE).realtype->basetype); \
1125 assert_string_equal(VALUE, (NODE).ident->name);
1126
1127/**
Radek Išaa9ff2b82021-01-13 21:44:13 +01001128 * @brief Macro testing parser when parsing incorrect module;
1129 * @param[in] DATA String storing the schema module representation.
1130 * @param[in] FORMAT Schema format of the @p DATA
1131 * @param[in] FEATURES Array of module's features to enable
1132 * @param[in] RET_VAL ly_in_new_memory return error value
1133 */
1134#define UTEST_INVALID_MODULE(DATA, FORMAT, FEATURES, RET_VAL) \
1135 { \
Michal Vasko4de7d072021-07-09 09:13:18 +02001136 struct lys_module *mod; \
Radek Išaa9ff2b82021-01-13 21:44:13 +01001137 assert_int_equal(LY_SUCCESS, ly_in_new_memory(DATA, &_UC->in)); \
1138 assert_int_equal(RET_VAL, lys_parse(_UC->ctx, _UC->in, FORMAT, FEATURES, &mod)); \
1139 assert_null(mod); \
1140 } \
1141 ly_in_free(_UC->in, 0); \
1142 _UC->in = NULL; \
1143
1144/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001145 * @brief Add module (from a string) into the used libyang context.
1146 * @param[in] DATA String storing the schema module representation.
1147 * @param[in] FORMAT Schema format of the @p DATA
1148 * @param[in] FEATURES Array of module's features to enable
1149 * @param[out] MOD Optional parameter as a pointer to variable to store the resulting module.
1150 */
1151#define UTEST_ADD_MODULE(DATA, FORMAT, FEATURES, MOD) \
1152 assert_int_equal(LY_SUCCESS, ly_in_new_memory(DATA, &_UC->in)); \
1153 assert_int_equal(LY_SUCCESS, lys_parse(_UC->ctx, _UC->in, FORMAT, FEATURES, MOD)); \
1154 ly_in_free(_UC->in, 0); \
1155 _UC->in = NULL
1156
1157/**
1158 * @brief Internal macro to compare error info record with the expected error message and path.
1159 * If NULL is provided as MSG, no error info record (NULL) is expected.
1160 * @param[in] ERR Error information record from libyang context.
1161 * @param[in] MSG Expected error message.
1162 * @param[in] PATH Expected error path.
1163 *
1164 */
1165#define _CHECK_LOG_CTX(ERR, MSG, PATH) \
1166 if (!MSG) { \
1167 assert_null(ERR); \
1168 } else { \
1169 assert_non_null(ERR); \
1170 CHECK_STRING((ERR)->msg, MSG); \
1171 CHECK_STRING((ERR)->path, PATH); \
1172 }
1173
1174/**`
1175 * @brief Internal macro to check the last libyang's context error.
1176 */
1177#define _CHECK_LOG_CTX1(MSG, PATH) \
1178 _CHECK_LOG_CTX(ly_err_last(_UC->ctx), MSG, PATH)
1179
1180/**
1181 * @brief Internal macro to check the last two libyang's context error.
1182 */
1183#define _CHECK_LOG_CTX2(MSG1, PATH1, MSG2, PATH2) \
1184 _CHECK_LOG_CTX(ly_err_last(_UC->ctx), MSG1, PATH1); \
1185 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev, MSG2, PATH2)
1186
1187/**
1188 * @brief Internal macro to check the last three libyang's context error.
1189 */
1190#define _CHECK_LOG_CTX3(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3) \
1191 _CHECK_LOG_CTX2(MSG1, PATH1, MSG2, PATH2); \
1192 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev->prev, MSG3, PATH3)
1193
1194/**
Radek Krejcife6ec262021-01-20 10:28:28 +01001195 * @brief Internal macro to check the last three libyang's context error.
1196 */
1197#define _CHECK_LOG_CTX4(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4) \
1198 _CHECK_LOG_CTX3(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3); \
1199 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev->prev->prev, MSG4, PATH4)
1200
1201/**
1202 * @brief Internal macro to check the last three libyang's context error.
1203 */
1204#define _CHECK_LOG_CTX5(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5) \
1205 _CHECK_LOG_CTX4(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4); \
1206 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev->prev->prev->prev, MSG5, PATH5)
1207
1208/**
Radek Krejci8297b792020-08-16 14:49:05 +02001209 * @brief Internal macro to check the last three libyang's context error.
1210 */
1211#define _CHECK_LOG_CTX6(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5, MSG6, PATH6) \
1212 _CHECK_LOG_CTX5(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5); \
1213 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev->prev->prev->prev->prev, MSG6, PATH6)
1214
1215/**
1216 * @brief Internal macro to check the last three libyang's context error.
1217 */
1218#define _CHECK_LOG_CTX7(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5, MSG6, PATH6, MSG7, PATH7) \
1219 _CHECK_LOG_CTX6(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5, MSG6, PATH6); \
1220 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev->prev->prev->prev->prev->prev, MSG7, PATH7)
1221
1222/**
1223 * @brief Internal macro to check the last three libyang's context error.
1224 */
1225#define _CHECK_LOG_CTX8(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5, MSG6, PATH6, MSG7, PATH7, MSG8, PATH8) \
1226 _CHECK_LOG_CTX7(MSG1, PATH1, MSG2, PATH2, MSG3, PATH3, MSG4, PATH4, MSG5, PATH5, MSG6, PATH6, MSG7, PATH7); \
1227 _CHECK_LOG_CTX(ly_err_last(_UC->ctx)->prev->prev->prev->prev->prev->prev->prev, MSG8, PATH8)
1228
1229/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001230 * @brief Internal helper macro to select _CHECK_LOG_CTX* macro according to the provided parameters.
1231 */
Radek Krejci8297b792020-08-16 14:49:05 +02001232#define _GET_CHECK_LOG_MACRO(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, NAME, ...) NAME
Radek Iša56ca9e42020-09-08 18:42:00 +02001233
1234/**
1235 * @brief Check expected error(s) in libyang context.
1236 *
1237 * Macro has variadic parameters expected to be provided in pairs of error message and error path starting
1238 * from the latest error. Current limit is checking at most 3 last errors. After checking, macro cleans up
1239 * all the errors from the libyang context.
1240 *
1241 * @param[in] MSG Expected error message.
1242 * @param[in] PATH Expected error path.
1243 */
1244#define CHECK_LOG_CTX(...) \
Radek Krejci8297b792020-08-16 14:49:05 +02001245 _GET_CHECK_LOG_MACRO(__VA_ARGS__, _CHECK_LOG_CTX8, _INVAL, _CHECK_LOG_CTX7, _INVAL, \
1246 _CHECK_LOG_CTX6, _INVAL, _CHECK_LOG_CTX5, _INVAL, _CHECK_LOG_CTX4, _INVAL, \
Michal Vasko151ae6c2021-09-23 08:23:51 +02001247 _CHECK_LOG_CTX3, _INVAL, _CHECK_LOG_CTX2, _INVAL, _CHECK_LOG_CTX1, DUMMY)(__VA_ARGS__); \
Radek Iša56ca9e42020-09-08 18:42:00 +02001248 ly_err_clean(_UC->ctx, NULL)
1249
1250/**
Michal Vaskoe9391c72021-10-05 10:04:56 +02001251 * @brief Check expected error in libyang context including error-app-tag.
1252 *
1253 * @param[in] MSG Expected error message.
1254 * @param[in] PATH Expected error path.
1255 * @param[in] APPTAG Expected error-app-tag.
1256 */
1257#define CHECK_LOG_CTX_APPTAG(MSG, PATH, APPTAG) \
1258 if (!MSG) { \
1259 assert_null(ly_err_last(_UC->ctx)); \
1260 } else { \
1261 assert_non_null(ly_err_last(_UC->ctx)); \
1262 CHECK_STRING(ly_err_last(_UC->ctx)->msg, MSG); \
1263 CHECK_STRING(ly_err_last(_UC->ctx)->path, PATH); \
1264 CHECK_STRING(ly_err_last(_UC->ctx)->apptag, APPTAG); \
1265 } \
1266 ly_err_clean(_UC->ctx, NULL)
1267
1268/**
Radek Iša56ca9e42020-09-08 18:42:00 +02001269 * @brief Clean up the logging callback's storage.
1270 */
1271#define UTEST_LOG_CLEAN \
1272 free(_UC->err_msg); \
1273 free(_UC->err_path); \
1274 _UC->err_msg = NULL; \
1275 _UC->err_path = NULL;
1276
1277/**
1278 * @brief Check expected error directly logged via logging callback.
1279 * Useful mainly for messages logged by functions without access to libyang context.
1280 * @param[in] MSG Expected error message.
1281 * @param[in] PATH Expected error path.
1282 */
1283#define CHECK_LOG(MSG, PATH) \
1284 CHECK_STRING(_UC->err_msg, MSG); \
1285 CHECK_STRING(_UC->err_path, PATH); \
1286 UTEST_LOG_CLEAN
1287
1288#ifdef _UTEST_MAIN_
1289/*
1290 * Functions inlined into each C source file including this header with _UTEST_MAIN_ defined
1291 */
1292
1293/**
1294 * @brief Global variable holding the tests context to simplify access to it.
1295 */
1296struct utest_context *current_utest_context;
1297
1298/* set to 0 to printing error messages to stderr instead of checking them in code */
1299#define ENABLE_LOGGER_CHECKING 1
1300
1301/**
1302 * @brief Logging callback for libyang.
1303 */
1304static void
1305_utest_logger(LY_LOG_LEVEL level, const char *msg, const char *path)
1306{
1307 (void) level; /* unused */
1308
1309 if (ENABLE_LOGGER_CHECKING == 0) {
Radek Išaa9ff2b82021-01-13 21:44:13 +01001310 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 +02001311 } else {
1312 free(current_utest_context->err_msg);
1313 current_utest_context->err_msg = msg ? strdup(msg) : NULL;
1314 free(current_utest_context->err_path);
1315 current_utest_context->err_path = path ? strdup(path) : NULL;
1316 }
1317}
1318
1319/**
1320 * @brief Generic utest's setup
1321 */
1322static int
1323utest_setup(void **state)
1324{
Michal Vasko86421632021-05-04 13:11:25 +02001325 char *cur_tz;
1326
Radek Iša56ca9e42020-09-08 18:42:00 +02001327 /* setup the logger */
1328 ly_set_log_clb(_utest_logger, 1);
1329 ly_log_options(LY_LOLOG | LY_LOSTORE);
1330
1331 current_utest_context = calloc(1, sizeof *current_utest_context);
1332 assert_non_null(current_utest_context);
1333 *state = current_utest_context;
1334
1335 /* libyang context */
1336 assert_int_equal(LY_SUCCESS, ly_ctx_new(NULL, 0, &current_utest_context->ctx));
1337
Radek Krejci968d7552021-03-26 20:33:51 +01001338 /* clean all errors from the setup - usually warnings regarding the plugins directories */
1339 UTEST_LOG_CLEAN;
1340
Michal Vasko86421632021-05-04 13:11:25 +02001341 /* backup timezone, if any */
1342 cur_tz = getenv("TZ");
1343 if (cur_tz) {
1344 current_utest_context->orig_tz = strdup(cur_tz);
1345 }
1346
1347 /* set CET */
1348 setenv("TZ", "CET+02:00", 1);
1349
Radek Iša56ca9e42020-09-08 18:42:00 +02001350 return 0;
1351}
1352
1353/**
1354 * @brief macro to include generic utest's setup into the test-specific setup.
1355 *
1356 * Place at the beginning of the test-specific setup
1357 */
1358#define UTEST_SETUP \
1359 assert_int_equal(0, utest_setup(state))
1360
1361/**
1362 * @brief Generic utest's teardown
1363 */
1364static int
1365utest_teardown(void **state)
1366{
1367 *state = NULL;
1368
1369 /* libyang context */
Radek Krejci90ed21e2021-04-12 14:47:46 +02001370 ly_ctx_destroy(current_utest_context->ctx);
Radek Iša56ca9e42020-09-08 18:42:00 +02001371
Michal Vasko86421632021-05-04 13:11:25 +02001372 if (current_utest_context->orig_tz) {
1373 /* restore TZ */
1374 setenv("TZ", current_utest_context->orig_tz, 1);
1375 }
1376
Radek Iša56ca9e42020-09-08 18:42:00 +02001377 /* utest context */
1378 ly_in_free(current_utest_context->in, 0);
1379 free(current_utest_context->err_msg);
1380 free(current_utest_context->err_path);
Michal Vasko86421632021-05-04 13:11:25 +02001381 free(current_utest_context->orig_tz);
Radek Iša56ca9e42020-09-08 18:42:00 +02001382 free(current_utest_context);
1383 current_utest_context = NULL;
1384
1385 return 0;
1386}
1387
1388/**
1389 * @brief macro to include generic utest's teardown into the test-specific teardown.
1390 *
1391 * Place at the end of the test-specific teardown
1392 */
1393#define UTEST_TEARDOWN \
1394 assert_int_equal(0, utest_teardown(state))
1395
1396/**
1397 * @brief Internal macro for utest setup with test-specific setup and teardown
1398 */
1399#define _UTEST_SETUP_TEARDOWN(FUNC, SETUP, TEARDOWN) \
1400 cmocka_unit_test_setup_teardown(FUNC, SETUP, TEARDOWN)
1401
1402/**
1403 * @brief Internal macro for utest setup with test-specific setup and generic teardown
1404 */
1405#define _UTEST_SETUP(FUNC, SETUP) \
1406 cmocka_unit_test_setup_teardown(FUNC, SETUP, utest_teardown)
1407
1408/**
1409 * @brief Internal macro for utest setup with generic setup and teardown
1410 */
1411#define _UTEST(FUNC) \
1412 cmocka_unit_test_setup_teardown(FUNC, utest_setup, utest_teardown)
1413
1414/**
1415 * @brief Internal helper macro to select _UTEST* macro according to the provided parameters.
1416 */
1417#define _GET_UTEST_MACRO(_1, _2, _3, NAME, ...) NAME
1418
1419/**
1420 * @brief Macro to specify test function using utest environment. Macro has variadic parameters
1421 * to provide test-specific setup/teardown functions:
1422 *
1423 * UTEST(test_func) - only implicit setup and teardown functions are used
1424 * UTEST(test_func, setup) - implicit teardown but own setup
1425 * UTEST(test_func, setup, teardown) - both setup and teardown are test-specific
1426 */
1427#define UTEST(...) \
Michal Vasko151ae6c2021-09-23 08:23:51 +02001428 _GET_UTEST_MACRO(__VA_ARGS__, _UTEST_SETUP_TEARDOWN, _UTEST_SETUP, _UTEST, DUMMY)(__VA_ARGS__)
Radek Iša56ca9e42020-09-08 18:42:00 +02001429
1430#else /* _UTEST_MAIN_ */
1431
1432extern struct utest_context *current_utest_context;
1433
1434#endif /* _UTEST_MAIN_ */
1435
1436#endif /* _UTESTS_H_ */