tests: test source4 cmdline/smb.conf log level

The 'log level' line in smb.conf allows messages from different log
classes to be sent to different places, but we have not tested that
this works. Now we do, somewhat.

The test involves running a special binary based on a stripped down
source4/samba/server.c that just starts up, parses the command line
and a given smb.conf, then logs messages from multiple classes and
exits.

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>

2 files changed, 205 insertions, 0 deletions

diff --git a/lib/util/tests/test_s4_logging.c b/lib/util/tests/test_s4_logging.c
new file mode 100644
index 00000000000..8e2b09deba8
--- /dev/null
+++ b/lib/util/tests/test_s4_logging.c
@@ -0,0 +1,197 @@
+/*
+   Unix SMB/CIFS implementation.
+
+   A test server that only does logging.
+
+   Copyright (C) Andrew Tridgell		1992-2005
+   Copyright (C) Martin Pool			2002
+   Copyright (C) Jelmer Vernooij		2002
+   Copyright (C) James J Myers 			2003 <myersjj@samba.org>
+   Copyright (C) Douglas Bagnall		2022
+
+   This program 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.
+
+   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, see <http://www.gnu.org/licenses/>.
+*/
+
+#include "includes.h"
+#include "lib/cmdline/cmdline.h"
+
+#define BINARY_NAME "test_s4_logging"
+
+static int log_level = 1;
+
+
+struct debug_class {
+	int dclass;
+	const char *name;
+};
+
+struct debug_class classes_table[] = {
+	{DBGC_ALL, "all"},
+	{DBGC_TDB, "tdb"},
+	{DBGC_PRINTDRIVERS, "printdrivers"},
+	{DBGC_LANMAN, "lanman"},
+	{DBGC_SMB, "smb"},
+	{DBGC_RPC_PARSE, "rpc_parse"},
+	{DBGC_RPC_SRV, "rpc_srv"},
+	{DBGC_RPC_CLI, "rpc_cli"},
+	{DBGC_PASSDB, "passdb"},
+	{DBGC_SAM, "sam"},
+	{DBGC_AUTH, "auth"},
+	{DBGC_WINBIND, "winbind"},
+	{DBGC_VFS, "vfs"},
+	{DBGC_IDMAP, "idmap"},
+	{DBGC_QUOTA, "quota"},
+	{DBGC_ACLS, "acls"},
+	{DBGC_LOCKING, "locking"},
+	{DBGC_MSDFS, "msdfs"},
+	{DBGC_DMAPI, "dmapi"},
+	{DBGC_REGISTRY, "registry"},
+	{DBGC_SCAVENGER, "scavenger"},
+	{DBGC_DNS, "dns"},
+	{DBGC_LDB, "ldb"},
+	{DBGC_TEVENT, "tevent"},
+	{DBGC_AUTH_AUDIT, "auth_audit"},
+	{DBGC_AUTH_AUDIT_JSON, "auth_json_audit"},
+	{DBGC_KERBEROS, "kerberos"},
+	{DBGC_DRS_REPL, "drs_repl"},
+	{DBGC_SMB2, "smb2"},
+	{DBGC_SMB2_CREDITS, "smb2_credits"},
+	{DBGC_DSDB_AUDIT, "dsdb_audit"},
+	{DBGC_DSDB_AUDIT_JSON, "dsdb_json_audit"},
+	{DBGC_DSDB_PWD_AUDIT, "dsdb_password_audit"},
+	{DBGC_DSDB_PWD_AUDIT_JSON, "dsdb_password_json_audit"},
+	{DBGC_DSDB_TXN_AUDIT, "dsdb_transaction_audit"},
+	{DBGC_DSDB_TXN_AUDIT_JSON, "dsdb_transaction_json_audit"},
+	{DBGC_DSDB_GROUP_AUDIT, "dsdb_group_audit"},
+	{DBGC_DSDB_GROUP_AUDIT_JSON, "dsdb_group_json_audit"},
+};
+
+
+static int log_all_classes(int level)
+{
+	size_t i;
+	struct debug_class c;
+	for (i = 0; i < ARRAY_SIZE(classes_table); i++) {
+		c = classes_table[i];
+		if (i != c.dclass) {
+			/*
+			 * we implicitly rely on these values staying in the
+			 * right order.
+			 */
+			fprintf(stderr,
+				"expected '%s' class to have value %zu\n",
+				c.name, i);
+			return 1;
+		}
+
+		DEBUGC(c.dclass, level,
+		       ("logging for '%s' [%d], at level %d\n",
+			c.name, c.dclass, level));
+
+		/*
+		 * That's it for the tests *here*. The invoker of this
+		 * process will have set up an smb.conf that directs the
+		 * output in particular ways, and will be looking to see that
+		 * happens correctly.
+		 */
+	}
+	return 0;
+}
+
+
+static int init_daemon(TALLOC_CTX *mem_ctx,
+		       int argc,
+		       const char *argv[],
+		       const char **error)
+{
+	poptContext pc;
+	int opt;
+	bool ok;
+	struct poptOption long_options[] = {
+		POPT_AUTOHELP
+		{
+			.longName   = "level",
+			.shortName  = 'L',
+			.argInfo    = POPT_ARG_INT,
+			.arg        = &log_level,
+			.descrip    = "log at this level",
+			.argDescrip = "LEVEL",
+		},
+		POPT_COMMON_SAMBA
+		POPT_COMMON_DAEMON
+		POPT_COMMON_VERSION
+		POPT_TABLEEND
+	};
+
+	setproctitle(BINARY_NAME);
+
+	ok = samba_cmdline_init(mem_ctx,
+				SAMBA_CMDLINE_CONFIG_SERVER,
+				true /* require_smbconf */);
+	if (!ok) {
+		*error = "Failed to init cmdline parser!\n";
+		return EINVAL;
+	}
+
+	pc = samba_popt_get_context(BINARY_NAME,
+				    argc,
+				    argv,
+				    long_options,
+				    0);
+	if (pc == NULL) {
+		*error = "Failed to setup popt context!\n";
+		return ENOTRECOVERABLE;
+	}
+
+	while((opt = poptGetNextOpt(pc)) != -1) {
+		fprintf(stderr, "\nInvalid option %s: %s\n\n",
+			poptBadOption(pc, 0), poptStrerror(opt));
+		poptPrintUsage(pc, stderr, 0);
+		return 1;
+	}
+
+	poptFreeContext(pc);
+
+	return 0;
+}
+
+
+int main(int argc, const char *argv[])
+{
+	TALLOC_CTX *mem_ctx = NULL;
+	int rc;
+	const char *error = NULL;
+
+	mem_ctx = talloc_init("crazy-logging-test-server.c#main");
+	if (mem_ctx == NULL) {
+		exit(ENOMEM);
+	}
+
+	setproctitle_init(argc, discard_const(argv), environ);
+
+	rc = init_daemon(mem_ctx, argc, argv, &error);
+	if (rc != 0) {
+		fprintf(stderr, "error [%d]: %s\n", rc, error);
+		exit_daemon(error, rc);
+	}
+
+	rc = log_all_classes(log_level);
+	if (rc != 0) {
+		fprintf(stderr, "error in log_all_classes [%d]\n", rc);
+		exit_daemon("logging error", rc);
+	}
+
+	TALLOC_FREE(mem_ctx);
+	return rc;
+}
diff --git a/lib/util/wscript_build b/lib/util/wscript_build
index e3fa3295b46..334057c98a7 100644
--- a/lib/util/wscript_build
+++ b/lib/util/wscript_build
@@ -367,3 +367,11 @@ else:
                      deps='cmocka replace samba-util',
                      local_include=False,
                      for_selftest=True)
+
+    bld.SAMBA_BINARY('test_s4_logging',
+                     source='tests/test_s4_logging.c',
+                     deps=' '.join(['CMDLINE_S4',
+                                    'samba-util',
+                                    'popt']),
+                     local_include=False,
+                     for_selftest=True)