improved testing support
authorRainer Gerhards <rgerhards@adiscon.com>
Thu, 19 Mar 2009 16:50:07 +0000 (17:50 +0100)
committerRainer Gerhards <rgerhards@adiscon.com>
Thu, 19 Mar 2009 16:50:07 +0000 (17:50 +0100)
worked on ways to provide a better test suite:
- added -T rsyslogd command line option, enables to specify a directory
  where to chroot() into on startup. This is NOT a security feature but
  introduced to support testing. Thus, -T does not make sure chroot()
  is used in a secure way. (may be removed later)
- added omstdout module for testing purposes. Spits out all messages to
  stdout - no config option, no other features
- modified $ModLoad statement so that for modules whom's name starts with
  a dot, no path is prepended (this enables relative-pathes and should
  not break any valid current config)

ChangeLog
Makefile.am
configure.ac
plugins/omstdout/Makefile.am [new file with mode: 0644]
plugins/omstdout/omstdout.c [new file with mode: 0644]
runtime/modules.c
tests/Makefile.am
tools/syslogd.c

index 8c8442e..1cfb3c3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -8,6 +8,15 @@ Version 4.1.6  [DEVEL] (rgerhards), 2009-03-??
   issue with the function call VM instruction set design.
 - implemented the strlen() RainerScript function
 - added a template output module
+- added -T rsyslogd command line option, enables to specify a directory
+  where to chroot() into on startup. This is NOT a security feature but
+  introduced to support testing. Thus, -T does not make sure chroot()
+  is used in a secure way. (may be removed later)
+- added omstdout module for testing purposes. Spits out all messages to
+  stdout - no config option, no other features
+- modified $ModLoad statement so that for modules whom's name starts with
+  a dot, no path is prepended (this enables relative-pathes and should
+  not break any valid current config)
 ---------------------------------------------------------------------------
 Version 4.1.5  [DEVEL] (rgerhards), 2009-03-11
 - bugfix: parser did not correctly parse fields in UDP-received messages
index 87e378e..97f4aed 100644 (file)
@@ -1,5 +1,3 @@
-AUTOMAKE_OPTIONS=dejagnu
-
 sbin_PROGRAMS =
 pkglib_LTLIBRARIES = 
 
@@ -90,6 +88,10 @@ if ENABLE_IMTEMPLATE
 SUBDIRS += plugins/imtemplate
 endif
 
+if ENABLE_OMSTDOUT
+SUBDIRS += plugins/omstdout
+endif
+
 if ENABLE_OMTEMPLATE
 SUBDIRS += plugins/omtemplate
 endif
@@ -120,5 +122,5 @@ SUBDIRS += tests
 # temporarily be removed below. The intent behind forcing everthing to compile
 # in a make distcheck is so that we detect code that accidently was not updated
 # when some global update happened.
-DISTCHECK_CONFIGURE_FLAGS=--enable-gssapi_krb5 --enable-imfile --enable-snmp --enable-pgsql --enable-libdbi --enable-mysql --enable-omtemplate --enable-imtemplate --enable-relp --enable-rsyslogd --enable-mail --enable-klog  --enable-diagtools --enable-gnutls
+DISTCHECK_CONFIGURE_FLAGS=--enable-gssapi_krb5 --enable-imfile --enable-snmp --enable-pgsql --enable-libdbi --enable-mysql --enable-omtemplate --enable-imtemplate --enable-relp --enable-rsyslogd --enable-mail --enable-klog  --enable-diagtools --enable-gnutls --enable-omstdout
 ACLOCAL_AMFLAGS = -I m4
index 0c9483c..fcd935e 100644 (file)
@@ -688,6 +688,23 @@ AM_CONDITIONAL(ENABLE_OMTEMPLATE, test x$enable_omtemplate = xyes)
 # end of copy template - be sure to serach for omtemplate to find everything!
 
 
+# settings for omstdout
+AC_ARG_ENABLE(omstdout,
+        [AS_HELP_STRING([--enable-omstdout],[Compiles stdout template module @<:@default=no@:>@])],
+        [case "${enableval}" in
+         yes) enable_omstdout="yes" ;;
+          no) enable_omstdout="no" ;;
+           *) AC_MSG_ERROR(bad value ${enableval} for --enable-omstdout) ;;
+         esac],
+        [enable_omstdout=no]
+)
+#
+# you may want to do some library checks here - see snmp, mysql, pgsql modules
+# for samples
+#
+AM_CONDITIONAL(ENABLE_OMSTDOUT, test x$enable_omstdout = xyes)
+
+
 AC_CONFIG_FILES([Makefile \
                runtime/Makefile \
                tools/Makefile \
@@ -701,6 +718,7 @@ AC_CONFIG_FILES([Makefile \
                plugins/imklog/Makefile \
                plugins/imtemplate/Makefile \
                plugins/omtemplate/Makefile \
+               plugins/omstdout/Makefile \
                plugins/imfile/Makefile \
                plugins/imrelp/Makefile \
                plugins/imdiag/Makefile \
@@ -731,7 +749,8 @@ echo "RELP support enabled:                     $enable_relp"
 echo "imdiag enabled:                           $enable_imdiag"
 echo "file input module enabled:                $enable_imfile"
 echo "input template module will be compiled:   $enable_imtemplate"
-echo "output template module will be compiled:   $enable_omtemplate"
+echo "output template module will be compiled:  $enable_omtemplate"
+echo "omstdout module will be compiled:         $enable_omstdout"
 echo "Large file support enabled:               $enable_largefile"
 echo "Networking support enabled:               $enable_inet"
 echo "GnuTLS network stream driver enabled:     $enable_gnutls"
diff --git a/plugins/omstdout/Makefile.am b/plugins/omstdout/Makefile.am
new file mode 100644 (file)
index 0000000..9f5d497
--- /dev/null
@@ -0,0 +1,8 @@
+pkglib_LTLIBRARIES = omstdout.la
+
+omstdout_la_SOURCES = omstdout.c
+omstdout_la_CPPFLAGS =  $(RSRT_CFLAGS) $(PTHREADS_CFLAGS)
+omstdout_la_LDFLAGS = -module -avoid-version
+omstdout_la_LIBADD = 
+
+EXTRA_DIST = 
diff --git a/plugins/omstdout/omstdout.c b/plugins/omstdout/omstdout.c
new file mode 100644 (file)
index 0000000..6e227ba
--- /dev/null
@@ -0,0 +1,125 @@
+/* omstdout.c
+ * send all output to stdout - this is primarily a test driver (but may
+ * be used for weired use cases). Not tested for robustness!
+ *
+ * NOTE: read comments in module-template.h for more specifics!
+ *
+ * File begun on 2009-03-19 by RGerhards
+ *
+ * Copyright 2009 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog 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 Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+#include "config.h"
+#include "rsyslog.h"
+#include <stdio.h>
+#include <stdarg.h>
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
+#include <signal.h>
+#include <errno.h>
+#include <unistd.h>
+#include "dirty.h"
+#include "syslogd-types.h"
+#include "srUtils.h"
+#include "template.h"
+#include "module-template.h"
+#include "errmsg.h"
+#include "cfsysline.h"
+
+MODULE_TYPE_OUTPUT
+
+/* internal structures
+ */
+DEF_OMOD_STATIC_DATA
+
+typedef struct _instanceData {
+} instanceData;
+
+BEGINcreateInstance
+CODESTARTcreateInstance
+ENDcreateInstance
+
+
+BEGINisCompatibleWithFeature
+CODESTARTisCompatibleWithFeature
+       if(eFeat == sFEATURERepeatedMsgReduction)
+               iRet = RS_RET_OK;
+ENDisCompatibleWithFeature
+
+
+BEGINfreeInstance
+CODESTARTfreeInstance
+ENDfreeInstance
+
+
+BEGINdbgPrintInstInfo
+CODESTARTdbgPrintInstInfo
+ENDdbgPrintInstInfo
+
+
+BEGINtryResume
+CODESTARTtryResume
+ENDtryResume
+
+BEGINdoAction
+CODESTARTdoAction
+       write(1, (char*)ppString[0], strlen((char*)ppString[0]));
+ENDdoAction
+
+
+BEGINparseSelectorAct
+CODESTARTparseSelectorAct
+CODE_STD_STRING_REQUESTparseSelectorAct(1)
+       /* first check if this config line is actually for us */
+       if(strncmp((char*) p, ":omstdout:", sizeof(":omstdout:") - 1)) {
+               ABORT_FINALIZE(RS_RET_CONFLINE_UNPROCESSED);
+       }
+
+       /* ok, if we reach this point, we have something for us */
+       p += sizeof(":omstdout:") - 1; /* eat indicator sequence  (-1 because of '\0'!) */
+       CHKiRet(createInstance(&pData));
+
+       /* check if a non-standard template is to be applied */
+       if(*(p-1) == ';')
+               --p;
+       CHKiRet(cflineParseTemplateName(&p, *ppOMSR, 0, 0, (uchar*) "RSYSLOG_FileFormat"));
+CODE_STD_FINALIZERparseSelectorAct
+ENDparseSelectorAct
+
+
+BEGINmodExit
+CODESTARTmodExit
+ENDmodExit
+
+
+BEGINqueryEtryPt
+CODESTARTqueryEtryPt
+CODEqueryEtryPt_STD_OMOD_QUERIES
+ENDqueryEtryPt
+
+
+BEGINmodInit()
+CODESTARTmodInit
+       *ipIFVersProvided = CURR_MOD_IF_VERSION; /* we only support the current interface specification */
+CODEmodInit_QueryRegCFSLineHdlr
+ENDmodInit
+
+/* vi:set ai:
+ */
index d548a94..cef4eac 100644 (file)
@@ -608,7 +608,7 @@ Load(uchar *pModName)
        iLoadCnt    = 0;
        do {
                /* now build our load module name */
-               if(*pModName == '/') {
+               if(*pModName == '/' || *pModName == '.') {
                        *szPath = '\0'; /* we do not need to append the path - its already in the module name */
                        iPathLen = 0;
                } else {
index 7a31be4..384afd4 100644 (file)
@@ -1,3 +1,6 @@
+#AUTOMAKE_OPTIONS=dejagnu
+#DEJATOOL=Rainer
+
 check_PROGRAMS = rt_init rscript
 TESTS = $(check_PROGRAMS) cfg.sh
 TESTS_ENVIRONMENT = RSYSLOG_MODDIR='$(abs_top_builddir)'/runtime/.libs/
index 235bc52..9f96289 100644 (file)
@@ -3324,7 +3324,7 @@ int realMain(int argc, char **argv)
         * only when actually neeeded. 
         * rgerhards, 2008-04-04
         */
-       while((ch = getopt(argc, argv, "46a:Ac:def:g:hi:l:m:M:nN:op:qQr::s:t:u:vwx")) != EOF) {
+       while((ch = getopt(argc, argv, "46a:Ac:def:g:hi:l:m:M:nN:op:qQr::s:t:T:u:vwx")) != EOF) {
                switch((char)ch) {
                 case '4':
                 case '6':
@@ -3342,6 +3342,7 @@ int realMain(int argc, char **argv)
                case 'q': /* add hostname if DNS resolving has failed */
                case 'Q': /* dont resolve hostnames in ACL to IPs */
                case 's':
+               case 'T': /* chroot on startup (primarily for testing) */
                case 'u': /* misc user settings */
                case 'w': /* disable disallowed host warnings */
                case 'x': /* disable dns for remote messages */
@@ -3586,6 +3587,20 @@ int realMain(int argc, char **argv)
                        } else
                                fprintf(stderr, "-t option only supported in compatibility modes 0 to 2 - ignored\n");
                        break;
+               case 'T':/* chroot() immediately at program startup, but only for testing, NOT security yet */
+{
+char buf[1024];
+getcwd(buf, 1024);
+printf("pwd: '%s'\n", buf);
+printf("chroot to '%s'\n", arg);
+                       if(chroot(arg) != 0) {
+                               perror("chroot");
+                               exit(1);
+                       }
+getcwd(buf, 1024);
+printf("pwd: '%s'\n", buf);
+}
+                       break;
                case 'u':               /* misc user settings */
                        iHelperUOpt = atoi(arg);
                        if(iHelperUOpt & 0x01)