Merging upstream version 2.0.3+dfsg (Closes: #923993, #1042533, #1045145).

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 493 insertions, 0 deletions

diff --git a/src/libnetdata/spawn_server/spawn-tester.c b/src/libnetdata/spawn_server/spawn-tester.c
new file mode 100644
index 000000000..fbd9431ac
--- /dev/null
+++ b/src/libnetdata/spawn_server/spawn-tester.c
@@ -0,0 +1,493 @@
+#include "libnetdata/libnetdata.h"
+#include "libnetdata/required_dummies.h"
+
+#define ENV_VAR_KEY "SPAWN_TESTER"
+#define ENV_VAR_VALUE "1234567890"
+
+size_t warnings = 0;
+
+void child_check_environment(void) {
+    const char *s = getenv(ENV_VAR_KEY);
+    if(!s || !*s || strcmp(s, ENV_VAR_VALUE) != 0) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR,
+               "Wrong environment. Variable '%s' should have value '%s' but it has '%s'",
+               ENV_VAR_KEY, ENV_VAR_VALUE, s ? s : "(unset)");
+
+        exit(1);
+    }
+}
+
+static bool is_valid_fd(int fd) {
+    errno_clear();
+    return fcntl(fd, F_GETFD) != -1 || errno != EBADF;
+}
+
+void child_check_fds(void) {
+    for(int fd = 0; fd < 3; fd++) {
+        if(!is_valid_fd(fd)) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "fd No %d should be a valid file descriptor - but it isn't.", fd);
+
+            exit(1);
+        }
+    }
+
+    for(int fd = 3; fd < /* os_get_fd_open_max() */ 1024; fd++) {
+        if(is_valid_fd(fd)) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "fd No %d is a valid file descriptor - it shouldn't.", fd);
+
+            exit(1);
+        }
+    }
+
+    errno_clear();
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+// kill to stop
+
+int plugin_kill_to_stop() {
+    child_check_fds();
+    child_check_environment();
+
+    char buffer[1024];
+    while (fgets(buffer, sizeof(buffer), stdin) != NULL) {
+        fprintf(stderr, "+");
+        printf("%s", buffer);
+        fflush(stdout);
+    }
+
+    return 0;
+}
+
+void test_int_fds_plugin_kill_to_stop(SPAWN_SERVER *server, const char *argv0) {
+    const char *params[] = {
+        argv0,
+        "plugin-kill-to-stop",
+        NULL,
+    };
+
+    SPAWN_INSTANCE *si = spawn_server_exec(server, STDERR_FILENO, 0, params, NULL, 0, SPAWN_INSTANCE_TYPE_EXEC);
+    if(!si) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot run myself as plugin (spawn)");
+        exit(1);
+    }
+
+    const char *msg = "Hello World!\n";
+    ssize_t len = strlen(msg);
+    char buffer[len * 2];
+
+    for(size_t j = 0; j < 30 ;j++) {
+        fprintf(stderr, "-");
+        memset(buffer, 0, sizeof(buffer));
+
+        ssize_t rc = write(spawn_server_instance_write_fd(si), msg, len);
+
+        if (rc != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot write to plugin. Expected to write %zd bytes, wrote %zd bytes",
+                   len, rc);
+            exit(1);
+        }
+
+        rc = read(spawn_server_instance_read_fd(si), buffer, sizeof(buffer));
+        if (rc != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot read from plugin. Expected to read %zd bytes, read %zd bytes",
+                   len, rc);
+            exit(1);
+        }
+
+        if (memcmp(msg, buffer, len) != 0) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Read corrupted data. Expected '%s', Read '%s'",
+                   msg, buffer);
+            exit(1);
+        }
+    }
+    fprintf(stderr, "\n");
+
+    int code = spawn_server_exec_kill(server, si);
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR,
+           "child exited with code %d",
+           code);
+
+    if(code != 15 && code != 0) {
+        nd_log(NDLS_COLLECTORS, NDLP_WARNING, "child should exit with code 0 or 15, but exited with code %d", code);
+        warnings++;
+    }
+}
+
+void test_popen_plugin_kill_to_stop(const char *argv0) {
+    char cmd[FILENAME_MAX + 100];
+    snprintfz(cmd, sizeof(cmd), "exec %s plugin-kill-to-stop", argv0);
+    POPEN_INSTANCE *pi = spawn_popen_run(cmd);
+    if(!pi) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot run myself as plugin (popen)");
+        exit(1);
+    }
+
+    const char *msg = "Hello World!\n";
+    size_t len = strlen(msg);
+    char buffer[len * 2];
+
+    for(size_t j = 0; j < 30 ;j++) {
+        fprintf(stderr, "-");
+        memset(buffer, 0, sizeof(buffer));
+
+        size_t rc = fwrite(msg, 1, len, spawn_popen_stdin(pi));
+        if (rc != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot write to plugin. Expected to write %zu bytes, wrote %zu bytes",
+                   len, rc);
+            exit(1);
+        }
+        fflush(spawn_popen_stdin(pi));
+
+        char *s = fgets(buffer, sizeof(buffer), spawn_popen_stdout(pi));
+        if (!s || strlen(s) != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot read from plugin. Expected to read %zu bytes, read %zu bytes",
+                   len, (size_t)(s ? strlen(s) : 0));
+            exit(1);
+        }
+        if (memcmp(msg, buffer, len) != 0) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Read corrupted data. Expected '%s', Read '%s'",
+                   msg, buffer);
+            exit(1);
+        }
+    }
+    fprintf(stderr, "\n");
+
+    int code = spawn_popen_kill(pi);
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR,
+           "child exited with code %d",
+           code);
+
+    if(code != 0) {
+        nd_log(NDLS_COLLECTORS, NDLP_WARNING, "child should exit with code 0, but exited with code %d", code);
+        warnings++;
+    }
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+// close to stop
+
+int plugin_close_to_stop() {
+    child_check_fds();
+    child_check_environment();
+
+    char buffer[1024];
+    while (fgets(buffer, sizeof(buffer), stdin) != NULL) {
+        fprintf(stderr, "+");
+        printf("%s", buffer);
+        fflush(stdout);
+    }
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR, "child detected a closed pipe.");
+    exit(1);
+}
+
+void test_int_fds_plugin_close_to_stop(SPAWN_SERVER *server, const char *argv0) {
+    const char *params[] = {
+        argv0,
+        "plugin-close-to-stop",
+        NULL,
+    };
+
+    SPAWN_INSTANCE *si = spawn_server_exec(server, STDERR_FILENO, 0, params, NULL, 0, SPAWN_INSTANCE_TYPE_EXEC);
+    if(!si) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot run myself as plugin (spawn)");
+        exit(1);
+    }
+
+    const char *msg = "Hello World!\n";
+    ssize_t len = strlen(msg);
+    char buffer[len * 2];
+
+    for(size_t j = 0; j < 30 ;j++) {
+        fprintf(stderr, "-");
+        memset(buffer, 0, sizeof(buffer));
+
+        ssize_t rc = write(spawn_server_instance_write_fd(si), msg, len);
+        if (rc != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot write to plugin. Expected to write %zd bytes, wrote %zd bytes",
+                   len, rc);
+            exit(1);
+        }
+
+        rc = read(spawn_server_instance_read_fd(si), buffer, sizeof(buffer));
+        if (rc != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot read from plugin. Expected to read %zd bytes, read %zd bytes",
+                   len, rc);
+            exit(1);
+        }
+        if (memcmp(msg, buffer, len) != 0) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Read corrupted data. Expected '%s', Read '%s'",
+                   msg, buffer);
+            exit(1);
+        }
+
+        break;
+    }
+    fprintf(stderr, "\n");
+
+    int code = spawn_server_exec_wait(server, si);
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR,
+           "child exited with code %d",
+           code);
+
+    if(!WIFEXITED(code) || WEXITSTATUS(code) != 1) {
+        nd_log(NDLS_COLLECTORS, NDLP_WARNING, "child should exit with code 1, but exited with code %d", code);
+        warnings++;
+    }
+}
+
+void test_popen_plugin_close_to_stop(const char *argv0) {
+    char cmd[FILENAME_MAX + 100];
+    snprintfz(cmd, sizeof(cmd), "exec %s plugin-close-to-stop", argv0);
+    POPEN_INSTANCE *pi = spawn_popen_run(cmd);
+    if(!pi) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot run myself as plugin (popen)");
+        exit(1);
+    }
+
+    const char *msg = "Hello World!\n";
+    size_t len = strlen(msg);
+    char buffer[len * 2];
+
+    for(size_t j = 0; j < 30 ;j++) {
+        fprintf(stderr, "-");
+        memset(buffer, 0, sizeof(buffer));
+
+        size_t rc = fwrite(msg, 1, len, spawn_popen_stdin(pi));
+        if (rc != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot write to plugin. Expected to write %zu bytes, wrote %zu bytes",
+                   len, rc);
+            exit(1);
+        }
+        fflush(spawn_popen_stdin(pi));
+
+        char *s = fgets(buffer, sizeof(buffer), spawn_popen_stdout(pi));
+        if (!s || strlen(s) != len) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot read from plugin. Expected to read %zu bytes, read %zu bytes",
+                   len, (size_t)(s ? strlen(s) : 0));
+            exit(1);
+        }
+        if (memcmp(msg, buffer, len) != 0) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Read corrupted data. Expected '%s', Read '%s'",
+                   msg, buffer);
+            exit(1);
+        }
+
+        break;
+    }
+    fprintf(stderr, "\n");
+
+    int code = spawn_popen_wait(pi);
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR,
+           "child exited with code %d",
+           code);
+
+    if(code != 1) {
+        nd_log(NDLS_COLLECTORS, NDLP_WARNING, "child should exit with code 1, but exited with code %d", code);
+        warnings++;
+    }
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+// echo and exit
+
+#define ECHO_AND_EXIT_MSG "GOODBYE\n"
+
+int plugin_echo_and_exit() {
+    child_check_fds();
+    child_check_environment();
+
+    printf(ECHO_AND_EXIT_MSG);
+    exit(0);
+}
+
+void test_int_fds_plugin_echo_and_exit(SPAWN_SERVER *server, const char *argv0) {
+    const char *params[] = {
+        argv0,
+        "plugin-echo-and-exit",
+        NULL,
+    };
+
+    SPAWN_INSTANCE *si = spawn_server_exec(server, STDERR_FILENO, 0, params, NULL, 0, SPAWN_INSTANCE_TYPE_EXEC);
+    if(!si) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot run myself as plugin (spawn)");
+        exit(1);
+    }
+
+    char buffer[1024];
+    size_t reads = 0;
+
+    for(size_t j = 0; j < 30 ;j++) {
+        fprintf(stderr, "-");
+        memset(buffer, 0, sizeof(buffer));
+
+        ssize_t rc = read(spawn_server_instance_read_fd(si), buffer, sizeof(buffer));
+        if(rc <= 0)
+            break;
+
+        reads++;
+
+        if (rc != strlen(ECHO_AND_EXIT_MSG)) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot read from plugin. Expected to read %zu bytes, read %zd bytes",
+                   strlen(ECHO_AND_EXIT_MSG), rc);
+            exit(1);
+        }
+        if (memcmp(ECHO_AND_EXIT_MSG, buffer, strlen(ECHO_AND_EXIT_MSG)) != 0) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Read corrupted data. Expected '%s', Read '%s'",
+                   ECHO_AND_EXIT_MSG, buffer);
+            exit(1);
+        }
+    }
+    fprintf(stderr, "\n");
+
+    if(reads != 1) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR,
+               "Cannot read from plugin. Expected to read %d times, but read %zu",
+               1, reads);
+        exit(1);
+    }
+
+    int code = spawn_server_exec_wait(server, si);
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR,
+           "child exited with code %d",
+           code);
+
+    if(code != 0) {
+        nd_log(NDLS_COLLECTORS, NDLP_WARNING, "child should exit with code 0, but exited with code %d", code);
+        warnings++;
+    }
+}
+
+void test_popen_plugin_echo_and_exit(const char *argv0) {
+    char cmd[FILENAME_MAX + 100];
+    snprintfz(cmd, sizeof(cmd), "exec %s plugin-echo-and-exit", argv0);
+    POPEN_INSTANCE *pi = spawn_popen_run(cmd);
+    if(!pi) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot run myself as plugin (popen)");
+        exit(1);
+    }
+
+    char buffer[1024];
+    size_t reads = 0;
+    for(size_t j = 0; j < 30 ;j++) {
+        fprintf(stderr, "-");
+        memset(buffer, 0, sizeof(buffer));
+
+        char *s = fgets(buffer, sizeof(buffer), spawn_popen_stdout(pi));
+        if(!s) break;
+        reads++;
+        if (strlen(s) != strlen(ECHO_AND_EXIT_MSG)) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Cannot read from plugin. Expected to read %zu bytes, read %zu bytes",
+                   strlen(ECHO_AND_EXIT_MSG), (size_t)(s ? strlen(s) : 0));
+            exit(1);
+        }
+        if (memcmp(ECHO_AND_EXIT_MSG, buffer, strlen(ECHO_AND_EXIT_MSG)) != 0) {
+            nd_log(NDLS_COLLECTORS, NDLP_ERR,
+                   "Read corrupted data. Expected '%s', Read '%s'",
+                   ECHO_AND_EXIT_MSG, buffer);
+            exit(1);
+        }
+    }
+    fprintf(stderr, "\n");
+
+    if(reads != 1) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR,
+               "Cannot read from plugin. Expected to read %d times, but read %zu",
+               1, reads);
+        exit(1);
+    }
+
+    int code = spawn_popen_wait(pi);
+
+    nd_log(NDLS_COLLECTORS, NDLP_ERR,
+           "child exited with code %d",
+           code);
+
+    if(code != 0) {
+        nd_log(NDLS_COLLECTORS, NDLP_WARNING, "child should exit with code 0, but exited with code %d", code);
+        warnings++;
+    }
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+
+int main(int argc, const char **argv) {
+    if(argc > 1 && strcmp(argv[1], "plugin-kill-to-stop") == 0)
+        return plugin_kill_to_stop();
+
+    if(argc > 1 && strcmp(argv[1], "plugin-echo-and-exit") == 0)
+        return plugin_echo_and_exit();
+
+    if(argc > 1 && strcmp(argv[1], "plugin-close-to-stop") == 0)
+        return plugin_close_to_stop();
+
+    if(argc <= 1 || strcmp(argv[1], "test") != 0) {
+        fprintf(stderr, "Run me with 'test' parameter!\n");
+        exit(1);
+    }
+
+    nd_setenv(ENV_VAR_KEY, ENV_VAR_VALUE, 1);
+
+    fprintf(stderr, "\n\nTESTING fds\n\n");
+    SPAWN_SERVER *server = spawn_server_create(SPAWN_SERVER_OPTION_EXEC, "test", NULL, argc, argv);
+    if(!server) {
+        nd_log(NDLS_COLLECTORS, NDLP_ERR, "Cannot create spawn server");
+        exit(1);
+    }
+    for(size_t i = 0; i < 5; i++) {
+        fprintf(stderr, "\n\nTESTING fds No %zu (kill to stop)\n\n", i + 1);
+        test_int_fds_plugin_kill_to_stop(server, argv[0]);
+    }
+    for(size_t i = 0; i < 5; i++) {
+        fprintf(stderr, "\n\nTESTING fds No %zu (echo and exit)\n\n", i + 1);
+        test_int_fds_plugin_echo_and_exit(server, argv[0]);
+    }
+    for(size_t i = 0; i < 5; i++) {
+        fprintf(stderr, "\n\nTESTING fds No %zu (close to stop)\n\n", i + 1);
+        test_int_fds_plugin_close_to_stop(server, argv[0]);
+    }
+    spawn_server_destroy(server);
+
+    fprintf(stderr, "\n\nTESTING popen\n\n");
+    netdata_main_spawn_server_init("test", argc, argv);
+    for(size_t i = 0; i < 5; i++) {
+        fprintf(stderr, "\n\nTESTING popen No %zu (kill to stop)\n\n", i + 1);
+        test_popen_plugin_kill_to_stop(argv[0]);
+    }
+    for(size_t i = 0; i < 5; i++) {
+        fprintf(stderr, "\n\nTESTING popen No %zu (echo and exit)\n\n", i + 1);
+        test_popen_plugin_echo_and_exit(argv[0]);
+    }
+    for(size_t i = 0; i < 5; i++) {
+        fprintf(stderr, "\n\nTESTING popen No %zu (close to stop)\n\n", i + 1);
+        test_popen_plugin_close_to_stop(argv[0]);
+    }
+    netdata_main_spawn_server_cleanup();
+
+    fprintf(stderr, "\n\nTests passed! (%zu warnings)\n\n", warnings);
+
+    exit(0);
+}