File: test-utils.h

package info (click to toggle)
libmodulemd 2.15.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 5,152 kB
  • sloc: ansic: 37,845; python: 3,236; xml: 1,739; sh: 377; makefile: 42
file content (77 lines) | stat: -rw-r--r-- 1,944 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * This file is part of libmodulemd
 * Copyright (C) 2017-2018 Stephen Gallagher
 *
 * Fedora-License-Identifier: MIT
 * SPDX-2.0-License-Identifier: MIT
 * SPDX-3.0-License-Identifier: MIT
 *
 * This program is free software.
 * For more information on the license, see COPYING.
 * For more information on free software, see <https://www.gnu.org/philosophy/free-sw.en.html>.
 */

#pragma once

#include <glib.h>
#include <locale.h>
#include <yaml.h>

G_BEGIN_DECLS

/**
 * SECTION: test-utils
 * @title: Internal Unit Test Utilities
 * @stability: private
 * @short_description: Utility functions for use with unit tests.
 */


extern int modulemd_test_signal;


/**
 * modulemd_test_signal_handler:
 * @sig_num: The signal received.
 *
 * Sets the global variable #modulemd_test_signal with the value of the signal
 * that was received.
 *
 * Since: 2.0
 */
void
modulemd_test_signal_handler (int sig_num);

/**
 * parser_skip_headers:
 * @parser: (inout): A libyaml parser object that has been initialized with an
 * input source.
 *
 * This function will advance the parser object past the initial STREAM_START,
 * DOCUMENT_START and MAPPING_START events to the first real entry in the first
 * document of the YAML stream. This is intended for unit tests to move the
 * parser location to the start of the object representation to be tested.
 *
 * Since: 2.0
 */
void
parser_skip_headers (yaml_parser_t *parser);


/**
 * parser_skip_document_start:
 * @parser: (inout): A libyaml parser object that has been initialized with an
 * input source.
 *
 * This function will advance the parser object past the initial STREAM_START,
 * and DOCUMENT_START events to the first real entry in the first mapping
 * of the YAML stream. This is intended for unit tests to move the parser
 * location to the start of the object representation to be tested.
 *
 * Since: 2.0
 */
void
parser_skip_document_start (yaml_parser_t *parser);


G_END_DECLS