File: test_template_stmt.py

package info (click to toggle)
syslog-ng 4.8.1-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,456 kB
  • sloc: ansic: 177,631; python: 13,035; cpp: 11,611; makefile: 7,012; sh: 5,147; java: 3,651; xml: 3,344; yacc: 1,377; lex: 599; perl: 193; awk: 190; objc: 162
file content (136 lines) | stat: -rw-r--r-- 7,095 bytes parent folder | download | duplicates (2)
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#!/usr/bin/env python
#############################################################################
# Copyright (c) 2023 Balázs Scheidler <balazs.scheidler@axoflow.com>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 as published
# by the Free Software Foundation, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#
# As an additional exemption you are allowed to compile & link against the
# OpenSSL libraries as published by the OpenSSL project. See the file
# COPYING for details.
#
#############################################################################


def test_template_stmt_with_identifier_reference(config, syslog_ng):
    template = config.create_template("template with $(format-welf test.*)\n")
    config.add_template(template)

    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2")
    file_destination = config.create_file_destination(file_name="output.log", template=template.name)

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["template with test.key1=value1 test.key2=value2\n"]


def test_template_with_non_string_values(config, syslog_ng):

    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2")
    rewrites = [
        config.create_rewrite_set("int(10)", value="values_int_hint"),
        config.create_rewrite_set("float(4.5)", value="values_float_hint"),
        config.create_rewrite_set("10", value="values_int_literal"),
        config.create_rewrite_set("4.5", value="values_float_literal"),
    ]
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify("$(format-json values_*)\n"))

    config.create_logpath(statements=[generator_source, *rewrites, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["""{"values_int_literal":10,"values_int_hint":10,"values_float_literal":4.5,"values_float_hint":4.5}\n"""]


def test_template_stmt_with_indirect_invocation(config, syslog_ng):
    template = config.create_template("template with $(format-welf test.*)\n")
    config.add_template(template)

    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2 template_fn => {}".format(template.name))
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify("$(template {} error resolving template)\n".format(template.name)))

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["template with test.key1=value1 test.key2=value2\n"]


def test_simple_template_stmt_with_identifier_reference(config, syslog_ng):
    template = config.create_template("template with $(format-welf test.*)\n", use_simple_statement=True)
    config.add_template(template)

    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2")
    file_destination = config.create_file_destination(file_name="output.log", template=template.name)

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["template with test.key1=value1 test.key2=value2\n"]


def test_template_stmt_with_string_reference(config, syslog_ng):
    template = config.create_template("template with $(format-welf test.*)\n")
    config.add_template(template)

    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2")
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify(template.name))

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["template with test.key1=value1 test.key2=value2\n"]


def test_inline_template(config, syslog_ng):
    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2")
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify("template with $(format-welf test.*)\n"))

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["template with test.key1=value1 test.key2=value2\n"]


def test_inline_template_hints(config, syslog_ng):
    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => int(5) test.key2 => int(6)")
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify("template with $(format-json test.*)\n"))

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    # NOTE: both key1 and key2 are formatted as integers
    assert log == ['''template with {"test":{"key2":6,"key1":5}}\n''']


def test_value_pair_type_hints(config, syslog_ng):
    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => string(5) test.key2 => string(6)")
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify("template with $(format-json v1=int(${test.key1}))\n"))

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    # NOTE: v1 is formatted as an integer due to the type hint in the format-json option list
    assert log == ['''template with {"v1":5}\n''']


def test_template_function(config, syslog_ng):
    template = config.create_template_function("template with $(format-welf test.*)\n", name="test_template_fn")
    config.add_template(template)

    generator_source = config.create_example_msg_generator_source(num=1, values="test.key1 => value1 test.key2 => value2")
    file_destination = config.create_file_destination(file_name="output.log", template=config.stringify("$(test_template_fn)\n"))

    config.create_logpath(statements=[generator_source, file_destination])
    syslog_ng.start(config)
    log = file_destination.read_logs(1)
    assert log == ["template with test.key1=value1 test.key2=value2\n"]