freebsd-dev/usr.sbin/newsyslog/tests/legacy_test.sh
Mark Johnston 13d1902439 Add regression tests for newsyslog.conf's p flag.
While here do a bit of cleanup:
- declare local variables as such,
- make tmpdir_create() clean up logfile directories, to handle a
  previously interrupt test run more gracefully.

MFC after:	2 weeks
Sponsored by:	The FreeBSD Foundation
2020-03-24 18:16:56 +00:00

642 lines
12 KiB
Bash

#!/bin/sh
# $FreeBSD$
# A regular expression matching the format of an RFC-5424 log line header,
# including the timestamp up through the seconds indicator; it does not include
# the (optional) timezone offset.
RFC5424_FMT='^<[0-9][0-9]*>1 [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}'
# A regular expression matching the format of an RFC-3164 (traditional syslog)
# log line header, including the timestamp.
RFC3164_FMT='^[A-Z][a-z]{2} [ 0-9][0-9] [0-9]{2}:[0-9]{2}:[0-9]{2}'
COUNT=0
TMPDIR=$(pwd)/work
if [ $? -ne 0 ]; then
echo "$0: Can't create temp dir, exiting..."
exit 1
fi
# Begin an individual test
begin()
{
COUNT=`expr $COUNT + 1`
OK=1
NAME="$1"
}
# End an individual test
end()
{
local message
if [ $OK = 1 ]
then
message='ok '
else
message='not ok '
fi
message="$message $COUNT - $NAME"
if [ -n "$TODO" ]
then
message="$message # TODO $TODO"
fi
echo "$message"
}
# Make a file that can later be verified
mkf()
{
CN=`basename $1`
echo "$CN-$CN" >$1
}
# Verify that the file specified is correct
ckf()
{
if [ -f $2 ] && echo "$1-$1" | diff - $2 >/dev/null
then
ok
else
notok
fi
}
# Check that a file exists
ckfe()
{
if [ -f $1 ]
then
ok
else
notok
fi
}
# Verify that the specified file does not exist
# (is not there)
cknt()
{
if [ -r $1 ]
then
notok
else
ok
fi
}
# Check if a file is there, depending of if it's supposed to or not -
# basically how many log files we are supposed to keep vs. how many we
# actually keep.
ckntfe()
{
curcnt=$1
keepcnt=$2
f=$3
if [ $curcnt -le $keepcnt ]
then
#echo Assuming file there
ckfe $f
else
#echo Assuming file NOT there
cknt $f
fi
}
# Verify that the specified file has RFC-5424 rotation messages.
ckrfc5424()
{
local lc=$(wc -l $1 | cut -w -f2)
local rc=$(grep -cE "${RFC5424_FMT}" $1)
if [ "$lc" -eq 0 -o "$rc" -eq 0 -o "$lc" -ne "$rc" ]
then
notok
else
ok
fi
}
# Verify that the specified file has RFC-3164 rotation messages.
ckrfc3164()
{
local lc=$(wc -l $1 | cut -w -f2)
local rc=$(grep -cE "${RFC3164_FMT}" $1)
if [ "$lc" -eq 0 -o "$rc" -eq 0 -o "$lc" -ne "$rc" ]
then
notok
else
ok
fi
}
# A part of a test succeeds
ok()
{
:
}
# A part of a test fails
notok()
{
OK=0
}
# Verify that the exit code passed is for unsuccessful termination
ckfail()
{
if [ $1 -gt 0 ]
then
ok
else
notok
fi
}
# Verify that the exit code passed is for successful termination
ckok()
{
if [ $1 -eq 0 ]
then
ok
else
notok
fi
}
# Check that there are X files which match expr
chkfcnt()
{
cnt=$1; shift
if [ $cnt -eq `echo "$@" | wc -w` ]
then
ok
else
notok
fi
}
# Check that two strings are alike
ckstr()
{
if [ "$1" = "$2" ]
then
ok
else
notok
fi
}
tmpdir_create()
{
rm -rf ${TMPDIR}/log ${TMPDIR}/alog
mkdir ${TMPDIR}/log ${TMPDIR}/alog
cd ${TMPDIR}/log
}
tmpdir_clean()
{
cd ${TMPDIR}
rm -rf "${TMPDIR}/log" "${TMPDIR}/alog" newsyslog.conf
}
run_newsyslog()
{
newsyslog -f ../newsyslog.conf -F -r "$@"
}
tests_normal_rotate() {
local dir ext name_postfix newsyslog_args
ext="$1"
dir="$2"
if [ -n "$dir" ]; then
newsyslog_args=" -a ${dir}"
name_postfix="${ext} archive dir"
else
newsyslog_args=""
name_postfix="${ext}"
fi
tmpdir_create
begin "create file ${name_postfix}" -newdir
run_newsyslog -C
ckfe $LOGFNAME
cknt ${dir}${LOGFNAME}.0${ext}
end
begin "rotate normal 1 ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckfe ${dir}${LOGFNAME}.0${ext}
cknt ${dir}${LOGFNAME}.1${ext}
end
begin "rotate normal 2 ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckfe ${dir}${LOGFNAME}.0${ext}
ckfe ${dir}${LOGFNAME}.1${ext}
cknt ${dir}${LOGFNAME}.2${ext}
end
begin "rotate normal 3 ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckfe ${dir}${LOGFNAME}.0${ext}
ckfe ${dir}${LOGFNAME}.1${ext}
ckfe ${dir}${LOGFNAME}.2${ext}
cknt ${dir}${LOGFNAME}.3${ext}
end
begin "rotate normal 4 ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckfe ${dir}${LOGFNAME}.0${ext}
ckfe ${dir}${LOGFNAME}.1${ext}
ckfe ${dir}${LOGFNAME}.2${ext}
cknt ${dir}${LOGFNAME}.4${ext}
end
begin "rotate normal 5 ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckfe ${dir}${LOGFNAME}.0${ext}
ckfe ${dir}${LOGFNAME}.1${ext}
ckfe ${dir}${LOGFNAME}.2${ext}
cknt ${dir}${LOGFNAME}.4${ext}
end
# Wait a bit so we can see if the noaction test rotates files
sleep 1.1
begin "noaction ${name_postfix}"
ofiles=`ls -Tl ${dir}${LOGFNAME}.*${ext} | tr -d '\n'`
run_newsyslog ${newsyslog_args} -n >/dev/null
ckfe ${LOGFNAME}
ckstr "$ofiles" "`ls -lT ${dir}${LOGFNAME}.*${ext} | tr -d '\n'`"
end
tmpdir_clean
}
tests_normal_rotate_keepn() {
local cnt dir ext name_postfix newsyslog_args
cnt="$1"
ext="$2"
dir="$3"
if [ -n "$dir" ]; then
newsyslog_args=" -a ${dir}"
name_postfix="${ext} archive dir"
else
newsyslog_args=""
name_postfix="${ext}"
fi
tmpdir_create
begin "create file ${name_postfix}" -newdir
run_newsyslog -C
ckfe $LOGFNAME
cknt ${dir}${LOGFNAME}.0${ext}
end
begin "rotate normal 1 cnt=$cnt ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckntfe 1 $cnt ${dir}${LOGFNAME}.0${ext}
cknt ${dir}${LOGFNAME}.1${ext}
end
begin "rotate normal 2 cnt=$cnt ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckntfe 1 $cnt ${dir}${LOGFNAME}.0${ext}
ckntfe 2 $cnt ${dir}${LOGFNAME}.1${ext}
cknt ${dir}${LOGFNAME}.2${ext}
end
begin "rotate normal 3 cnt=$cnt ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckntfe 1 $cnt ${dir}${LOGFNAME}.0${ext}
ckntfe 2 $cnt ${dir}${LOGFNAME}.1${ext}
ckntfe 3 $cnt ${dir}${LOGFNAME}.2${ext}
cknt ${dir}${LOGFNAME}.3${ext}
end
begin "rotate normal 3 cnt=$cnt ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckntfe 1 $cnt ${dir}${LOGFNAME}.0${ext}
ckntfe 2 $cnt ${dir}${LOGFNAME}.1${ext}
ckntfe 3 $cnt ${dir}${LOGFNAME}.2${ext}
ckntfe 4 $cnt ${dir}${LOGFNAME}.3${ext}
cknt ${dir}${LOGFNAME}.4${ext}
end
# Wait a bit so we can see if the noaction test rotates files
sleep 1.1
begin "noaction ${name_postfix}"
osum=`md5 ${dir}${LOGFNAME} | tr -d '\n'`
run_newsyslog ${newsyslog_args} -n >/dev/null
ckfe ${LOGFNAME}
ckstr "$osum" "`md5 ${dir}${LOGFNAME} | tr -d '\n'`"
end
tmpdir_clean
}
tests_time_rotate() {
local dir ext name_postfix newsyslog_args
ext="$1"
dir="$2"
if [ -n "$dir" ]; then
newsyslog_args="-t DEFAULT -a ${dir}"
name_postfix="${ext} archive dir"
else
newsyslog_args="-t DEFAULT"
name_postfix="${ext}"
fi
tmpdir_create
begin "create file ${name_postfix}" -newdir
run_newsyslog -C ${newsyslog_args}
ckfe ${LOGFNAME}
end
begin "rotate time 1 ${name_postfix}"
run_newsyslog ${newsyslog_args}
ckfe ${LOGFNAME}
chkfcnt 1 ${dir}${LOGFNAME}.*${ext}
end
sleep 1.1
begin "rotate time 2 ${name_postfix}"
run_newsyslog ${newsyslog_args}
ckfe ${LOGFNAME}
chkfcnt 2 ${dir}${LOGFNAME}.*${ext}
end
sleep 1.1
begin "rotate time 3 ${name_postfix}"
run_newsyslog ${newsyslog_args}
ckfe ${LOGFNAME}
chkfcnt 3 ${dir}${LOGFNAME}.*${ext}
end
sleep 1.1
begin "rotate time 4 ${name_postfix}"
run_newsyslog ${newsyslog_args}
ckfe ${LOGFNAME}
chkfcnt 3 ${dir}${LOGFNAME}.*${ext}
end
begin "noaction ${name_postfix}"
ofiles=`ls -1 ${dir}${LOGFNAME}.*${ext} | tr -d '\n'`
run_newsyslog ${newsyslog_args} -n >/dev/null
ckfe ${LOGFNAME}
ckstr "$ofiles" "`ls -1 ${dir}${LOGFNAME}.*${ext} | tr -d '\n'`"
end
tmpdir_clean
}
tests_rfc5424() {
local dir ext name_postfix newsyslog_args
ext="$1"
dir="$2"
if [ -n "$dir" ]; then
newsyslog_args=" -a ${dir}"
name_postfix="${ext} archive dir"
else
newsyslog_args=""
name_postfix="${ext}"
fi
tmpdir_create
begin "RFC-5424 - create file ${name_postfix}" -newdir
run_newsyslog -C
ckfe $LOGFNAME
cknt ${dir}${LOGFNAME}.0${ext}
ckfe $LOGFNAME5424
cknt ${dir}${LOGFNAME5424}.0${ext}
ckrfc3164 ${LOGFNAME}
ckrfc5424 ${LOGFNAME5424}
end
begin "RFC-5424 - rotate normal 1 ${name_postfix}"
run_newsyslog $newsyslog_args
ckfe ${LOGFNAME}
ckfe ${dir}${LOGFNAME}.0${ext}
ckfe $LOGFNAME5424
ckfe ${dir}${LOGFNAME5424}.0${ext}
ckrfc3164 ${LOGFNAME}
ckrfc3164 ${dir}${LOGFNAME}.0${ext}
ckrfc5424 ${LOGFNAME5424}
ckrfc5424 ${dir}${LOGFNAME5424}.0${ext}
end
tmpdir_clean
}
tests_p_flag_rotate() {
local ext
ext="$1"
tmpdir_create
begin "create file"
run_newsyslog -C
ckfe $LOGFNAME
cknt ${LOGFNAME}.0
cknt ${LOGFNAME}.0${ext}
end
begin "rotate p flag 1 ${ext}"
run_newsyslog
ckfe $LOGFNAME
ckfe ${LOGFNAME}.0
cknt ${LOGFNAME}.0${ext}
run_newsyslog
ckfe $LOGFNAME
ckfe ${LOGFNAME}.0
cknt ${LOGFNAME}.0${ext}
ckfe ${LOGFNAME}.1${ext}
run_newsyslog
ckfe $LOGFNAME
ckfe ${LOGFNAME}.0
cknt ${LOGFNAME}.0${ext}
ckfe ${LOGFNAME}.1${ext}
ckfe ${LOGFNAME}.2${ext}
end
tmpdir_clean
}
tests_normal_rotate_recompress() {
local ext
ext=".gz"
tmpdir_create
begin "create file recompress"
run_newsyslog -C
ckfe $LOGFNAME
cknt ${LOGFNAME}.0${ext}
end
begin "rotate normal 1"
run_newsyslog
ckfe $LOGFNAME
ckfe ${LOGFNAME}.0${ext}
cknt ${LOGFNAME}.1${ext}
end
begin "rotate recompress 1"
gunzip ${LOGFNAME}.0${ext}
ckfe ${LOGFNAME}.0
cknt ${LOGFNAME}.0${ext}
run_newsyslog
ckfe $LOGFNAME
ckfe ${LOGFNAME}.0${ext}
ckfe ${LOGFNAME}.1${ext}
end
}
echo 1..185
mkdir -p ${TMPDIR}
cd ${TMPDIR}
LOGFNAME=foo.log
LOGFPATH=${TMPDIR}/log/${LOGFNAME}
# Log file for RFC-5424 testing
LOGFNAME5424=foo5424.log
LOGFPATH5424=${TMPDIR}/log/${LOGFNAME5424}
# Normal, no archive dir, keep X files
echo "$LOGFPATH 640 0 * @T00 NC" > newsyslog.conf
tests_normal_rotate_keepn 0
echo "$LOGFPATH 640 1 * @T00 NC" > newsyslog.conf
tests_normal_rotate_keepn 1
echo "$LOGFPATH 640 2 * @T00 NC" > newsyslog.conf
tests_normal_rotate_keepn 2
echo "$LOGFPATH 640 3 * @T00 NC" > newsyslog.conf
tests_normal_rotate_keepn 3
# Normal, no archive dir, keep X files, gz
echo "$LOGFPATH 640 0 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate_keepn 0 ".gz"
echo "$LOGFPATH 640 1 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate_keepn 1 ".gz"
echo "$LOGFPATH 640 2 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate_keepn 2 ".gz"
echo "$LOGFPATH 640 3 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate_keepn 3 ".gz"
# Normal, no archive dir
echo "$LOGFPATH 640 3 * @T00 NC" > newsyslog.conf
tests_normal_rotate
echo "$LOGFPATH 640 3 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate ".gz"
echo "$LOGFPATH 640 3 * @T00 NCJ" > newsyslog.conf
tests_normal_rotate ".bz2"
echo "$LOGFPATH 640 3 * @T00 NCX" > newsyslog.conf
tests_normal_rotate ".xz"
echo "$LOGFPATH 640 3 * @T00 NCY" > newsyslog.conf
tests_normal_rotate ".zst"
# Normal, archive dir
echo "$LOGFPATH 640 3 * @T00 NC" > newsyslog.conf
tests_normal_rotate "" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate ".gz" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCJ" > newsyslog.conf
tests_normal_rotate ".bz2" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCX" > newsyslog.conf
tests_normal_rotate ".xz" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCY" > newsyslog.conf
tests_normal_rotate ".zst" "${TMPDIR}/alog/"
# Time based, no archive dir
echo "$LOGFPATH 640 3 * @T00 NC" > newsyslog.conf
tests_time_rotate
echo "$LOGFPATH 640 3 * @T00 NCZ" > newsyslog.conf
tests_time_rotate "gz" ""
echo "$LOGFPATH 640 3 * @T00 NCJ" > newsyslog.conf
tests_time_rotate "bz2" ""
echo "$LOGFPATH 640 3 * @T00 NCX" > newsyslog.conf
tests_time_rotate "xz" ""
echo "$LOGFPATH 640 3 * @T00 NCY" > newsyslog.conf
tests_time_rotate "zst" ""
# Time based, archive dir
echo "$LOGFPATH 640 3 * @T00 NC" > newsyslog.conf
tests_time_rotate "" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCZ" > newsyslog.conf
tests_time_rotate "gz" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCJ" > newsyslog.conf
tests_time_rotate "bz2" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCX" > newsyslog.conf
tests_time_rotate "xz" "${TMPDIR}/alog/"
echo "$LOGFPATH 640 3 * @T00 NCY" > newsyslog.conf
tests_time_rotate "zst" "${TMPDIR}/alog/"
# RFC-5424; Normal, no archive dir
echo "$LOGFPATH5424 640 3 * @T00 NCT" > newsyslog.conf
echo "$LOGFPATH 640 3 * @T00 NC" >> newsyslog.conf
tests_rfc5424
echo "$LOGFPATH 640 3 * @T00 NCpZ" > newsyslog.conf
tests_p_flag_rotate ".gz"
echo "$LOGFPATH 640 3 * @T00 NCZ" > newsyslog.conf
tests_normal_rotate_recompress
rm -rf "${TMPDIR}"