Merge pull request networkupstools#2896 from jimklimov/issue-2890

Update `upssched` and call it from NIT

Author: jimklimov

NEWS.adoc

@@ -389,6 +389,15 @@ This requirement compromises usability of `make distcheck` on platforms without
    (UPS overloaded), `TRIM` and `BOOST` (adjusting for bad input voltage)
    states. [#1074]
 
+ - Revised `upssched` timer handler that can be called from `upsmon` as its
+   `NOTIFYCMD` to not report confusing environment variable values of
+   `NOTIFYTYPE` and `UPSNAME` from the original call when a timer eventually
+   fires -- these values are irrelevant at that distant future. The NIT (NUT
+   Integration Tests) suite was extended to configure and call this tool,
+   facilitating its development and troubleshooting. Also the `upssched`
+   timer daemon part can now save its PID file (so that NIT can terminate
+   it after tests). [#2890]
+
  - New `libupsclient` API methods added:
    * `upscli_str_add_unique_token()` and `upscli_str_contains_token()`,
      to help C NUT clients process `ups.status` and similarly structured

clients/upssched-cmd

@@ -14,9 +14,13 @@
 
 # Feel free to remove or comment away these lines when you actually
 # customize the script for your deployment:
-echo "THIS IS A SAMPLE SCRIPT, PLEASE TAILOR IT FOR YOUR DEPLOYMENT OF NUT!" >&2
+echo "`date -u`: $0: THIS IS A SAMPLE SCRIPT, PLEASE TAILOR IT FOR YOUR DEPLOYMENT OF NUT!" >&2
 logger -t upssched-cmd "THIS IS A SAMPLE SCRIPT, PLEASE TAILOR IT FOR YOUR DEPLOYMENT OF NUT!"
-printf "NOTIFYTYPE='%s' args=%s\n" "$NOTIFYTYPE" "$@" | logger -t upssched-cmd-received-NOTIFYTYPE
+
+printf "`date -u`: UPSNAME='%s'\tNOTIFYTYPE='%s'\targs=%s\n" "$UPSNAME" "$NOTIFYTYPE" "$@" >&2
+printf "UPSNAME='%s' NOTIFYTYPE='%s' args=%s\n" "$UPSNAME" "$NOTIFYTYPE" "$@" | logger -t upssched-cmd-received-NOTIFYTYPE
+
+#set
 
 # Handle received timer names, as defined in your upssched.conf (example):
 case "$1" in

clients/upssched.c

@@ -71,7 +71,7 @@ static conn_t	*connhead = NULL;
 static char	*cmdscript = NULL, *pipefn = NULL, *lockfn = NULL;
 
 /* ups name and notify type (string) as received from upsmon */
-static const	char	*upsname, *notify_type;
+static const	char	*upsname, *notify_type, *prog = NULL;
 
 #ifdef WIN32
 static OVERLAPPED connect_overlapped;
@@ -873,6 +873,7 @@ static void start_daemon(TYPE_FD lockfd)
 #  endif /* not HAVE_DUP */
 # endif /* not HAVE_DUP2 */
 
+	/* Still in child, non-WIN32 - work as timer daemon (infinite loop) */
 	pipefd = open_sock();
 
 	if (nut_debug_level)
@@ -884,6 +885,13 @@ static void start_daemon(TYPE_FD lockfd)
 	/* drop the lock now that the background is running */
 	unlink(lockfn);
 	close(lockfd);
+	writepid(prog);
+
+	/* Whatever upsmon envvars were set when this daemon started, would be
+	 * irrelevant and only confusing at the moment a particular timer causes
+	 * CMDSCRIPT to run */
+	unsetenv("NOTIFYTYPE");
+	unsetenv("UPSNAME");
 
 	/* now watch for activity */
 	upsdebugx(2, "Timer daemon waiting for connections on pipefd %d",
@@ -988,6 +996,13 @@ static void start_daemon(TYPE_FD lockfd)
 	/* drop the lock now that the background is running */
 	CloseHandle(lockfd);
 	DeleteFile(lockfn);
+	writepid(prog);
+
+	/* Whatever upsmon envvars were set when this daemon started, would be
+	 * irrelevant and only confusing at the moment a particular timer causes
+	 * CMDSCRIPT to run */
+	unsetenv("NOTIFYTYPE");
+	unsetenv("UPSNAME");
 
 	/* now watch for activity */
 
@@ -1513,9 +1528,13 @@ static void help(const char *arg_progname)
 
 int main(int argc, char **argv)
 {
-	const char	*prog = xbasename(argv[0]);
 	int i;
 
+	if (argc > 0)
+		prog = xbasename(argv[0]);
+	if (!prog)
+		prog = "upssched";
+
 	while ((i = getopt(argc, argv, "+DVh")) != -1) {
 		switch (i) {
 			case 'D':

common/unsetenv.c

@@ -0,0 +1,14 @@
+/* unsetenv.c Jim Klimov <[email protected]> */
+#include "config.h" /* must be first */
+
+#ifndef HAVE_UNSETENV
+#include <stdlib.h>
+#include <string.h>
+#include "common.h"
+#include "proto.h"
+
+int nut_unsetenv(const char *name)
+{
+	return setenv(name, "", 1);
+}
+#endif	/* !HAVE_UNSETENV */

configure.ac

@@ -1465,7 +1465,7 @@ AC_CHECK_FUNCS(vsnprintf snprintf, [], [
 	AC_TYPE_LONG_LONG_INT
 ])
 
-AC_REPLACE_FUNCS(setenv strerror atexit)
+AC_REPLACE_FUNCS(setenv unsetenv strerror atexit)
 
 case ${target_os} in
    solaris2* )

include/proto.h

@@ -94,6 +94,13 @@ static inline int setenv(const char *name, const char *value, int overwrite) {
 }
 #endif
 
+#ifndef HAVE_UNSETENV
+int nut_unsetenv(const char *name);
+static inline int unsetenv(const char *name) {
+	return nut_unsetenv(name);
+}
+#endif
+
 #ifdef __hpux
 #ifdef HAVE_SYS_MODEM_H
 #include <sys/modem.h>

scripts/misc/notifyme-debug

@@ -8,10 +8,21 @@
 #   Sat Apr  6 17:23:06 UTC 2024    [uid=77(nut) gid=77(nut) groups=77(nut)]        COMMBAD [eco650]:        Communications with UPS eco650 lost     (1 tokens)
 #   Sat Apr  6 17:28:01 UTC 2024    [uid=77(nut) gid=77(nut) groups=77(nut)]        NOCOMM  [eco650]:        UPS eco650 is unavailable       (1 tokens)
 #
-# Copyright (C) 2023-2024 by Jim Klimov <[email protected]>
+# Copyright (C) 2023-2025 by Jim Klimov <[email protected]>
 # Licensed under the terms of the Network UPS Tools source license (GPLv2+)
 
 [ -n "${TEMPDIR-}" ] || TEMPDIR="${TMPDIR-}"
 [ -n "${TEMPDIR-}" ] || { [ -d "/dev/shm" && TEMPDIR="/dev/shm" || TEMPDIR="/tmp" ; }
 
 printf '%s\t[%s]\t%s\t[%s]:\t%s\t(%s tokens)\n' "`date -u`" "`id`" "${NOTIFYTYPE-}" "${UPSNAME-}" "$*" "$#" >> "${TEMPDIR}/notifyme-`id -u`.log"
+
+if [ -n "${TOP_BUILDDIR}" -a -x "${TOP_BUILDDIR}/clients/upssched" ] ; then
+	if [ -n "${NUT_DEBUG_LEVEL_UPSSCHED}" ] ; then
+		NUT_DEBUG_LEVEL="${NUT_DEBUG_LEVEL_UPSSCHED}"
+		export NUT_DEBUG_LEVEL
+	fi
+	if [ "${NUT_DEBUG_LEVEL-}" -gt 0 ] 2>/dev/null ; then
+		printf '%s: %s\t%s\t[%s]:\targs: %s\t(%s arg tokens)\n' "`date -u`" "$0" "${NOTIFYTYPE-}" "${UPSNAME-}" "$*" "$#" >&2
+	fi
+	"${TOP_BUILDDIR}/clients/upssched"
+fi