Skip to content

Commit 9c49ea3

Browse files
committed
Add some documentation to the testing shell scripts
1 parent c84c00e commit 9c49ea3

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

test_config_syntax.sh

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
#!/bin/sh
22

3+
#
4+
# This script is used to test the config syntax of the 50-filter-postfix.conf file.
5+
#
6+
# The configuration file is validated using the logstash --config.test_and_exit command in a docker container.
7+
#
8+
39
set -eux
410

511
docker run --rm -it \

test_grok_patterns.sh

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
#!/bin/sh
22

3+
#
4+
# This script is used to test the grok patterns in the postfix.grok file.
5+
#
6+
# The patterns are tested by running the test suite (in test/test.rb and test/*.yaml)
7+
# against the patterns in the postfix.grok file in a docker container.
8+
#
39
set -eux
410

511
DOCKERIMAGE="postfix-grok-patterns-runtests"

test_pipeline.sh

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
#!/bin/sh
22

3+
#
4+
# This script is used to test the logstash pipeline configuration.
5+
#
6+
# It sets up a logstash pipeline with the postfix configuration,
7+
# sends a test logline through the pipeline and checks the results.
8+
#
9+
310
set -eux
411

512
INPUT=$(mktemp tmp.logstash.in.XXXXX)

0 commit comments

Comments
 (0)