Add github actions CI.

.gitignore

@@ -39,6 +39,7 @@ autoscan.log
 configure.scan
 tprobe
 hprobe
+bertprobe
 crashprobe
 journalprobe
 telem-record-gen
@@ -56,6 +57,7 @@ tests/check_config
 tests/check_daemon
 tests/check_journal
 tests/check_libtelemetry
+tests/check_ncb64
 tests/check_postd
 tests/check_probd
 tests/check_probes

configure.ac

@@ -2,7 +2,7 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.69])
-AC_INIT([telemetrics-client], [2.3.2], [https://clearlinux.org/])
+AC_INIT([telemetrics-client], [2.2.3], [https://clearlinux.org/])
 AC_CONFIG_AUX_DIR([build-aux])
 AM_INIT_AUTOMAKE([1.14 -Wall -Werror -Wno-extra-portability foreign subdir-objects])
 AM_SILENT_RULES([yes])

src/data/bert-probe.service.in

@@ -0,0 +1,13 @@
+[Unit]
+Description=Telemetrics BERT Probe
+Requires=telemprobd.socket
+After=telemprobd.socket
+ConditionPathExists=/etc/telemetrics/opt-in
+ConditionPathExists=/sys/firmware/acpi/tables/data/BERT
+
+[Service]
+ExecStart=@bindir@/bertprobe
+User=telemetry
+
+[Install]
+WantedBy=multi-user.target

src/data/local.mk

@@ -16,6 +16,7 @@ EXTRA_DIST += \
 	%D%/example.2.conf \
 	%D%/hprobe.service.in \
 	%D%/hprobe.timer \
+	%D%/bert-probe.service.in \
 	%D%/journal-probe.service.in \
 	%D%/journal-probe-tail.service.in \
 	%D%/pstore-probe.service.in \
@@ -52,6 +53,7 @@ systemdunitdir = @SYSTEMD_UNITDIR@
 systemdunit_DATA = \
 	%D%/hprobe.service \
 	%D%/hprobe.timer \
+	%D%/bert-probe.service \
 	%D%/journal-probe.service \
 	%D%/journal-probe-tail.service \
 	%D%/pstore-probe.service \
@@ -66,6 +68,9 @@ systemdunit_DATA = \
 %D%/hprobe.service: %D%/hprobe.service.in
 	$(pathfix) < $< > $@
 
+%D%/bert-probe.service: %D%/bert-probe.service.in
+	$(pathfix) < $< > $@
+
 %D%/journal-probe.service: %D%/journal-probe.service.in
 	$(pathfix) < $< > $@
 
@@ -121,4 +126,5 @@ clean-local:
 		%D%/klogscanner.service \
 		%D%/pstore-clean.service \
 		%D%/hprobe.service \
+		%D%/bert-probe.service \
 		%D%/.dirstamp

src/local.mk

@@ -101,6 +101,7 @@ noinst_LTLIBRARIES = %D%/libtelem-shared.la
 	%D%/configuration.c \
 	%D%/nica/inifile.c \
 	%D%/nica/hashmap.c \
+	%D%/nica/b64enc.c \
 	%D%/configuration.h \
 	%D%/common.c \
 	%D%/common.h

src/nica/b64enc.c

@@ -0,0 +1,154 @@
+/*
+ * This file is part of libnica.
+ *
+ * Copyright © 2017 Intel Corporation
+ *
+ * libnica is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
+ */
+
+#define _GNU_SOURCE
+
+#include <stdio.h>
+#include <stdint.h>
+#include "b64enc.h"
+
+#define B64_LINE_LEN 76
+
+static int padding[] = {0, 2, 1, 0};
+static char table[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+
+/*
+ * base 64 encoding of 3 bytes to 4 printable characters
+ * (https://tools.ietf.org/html/rfc4648).
+ *
+ * i.e. (Reference: https://en.wikipedia.org/wiki/Base64)
+ *
+ *      [   M  ] [   a  ] [  n  ]
+ * bin  01001101 01100001 01101110
+ *
+ * b64  01001101 01100001 01101110  >> 18 & 0x3F -> 010011 -> ( 19 dec) T
+ *      ------
+ *
+ * b64  01001101 01100001 01101110  >> 12 & 0x3F -> 010110 -> ( 22 dec) W
+ *            -------
+ *
+ * b64  01001101 01100001 01101110  >>  6 & 0x3F -> 000101 -> (  5 dec) F
+ *                   -------
+ *
+ * b64  01001101 01100001 01101110  >>  0 & 0x3F -> 101110 -> (117 dec) u
+ *                          ------
+ *
+ */
+static void b64_3b(char bin[3], char *out) {
+
+    uint32_t x = (((uint32_t) bin[0] << 16) & 0xFF0000) |
+                 (((uint32_t) bin[1] <<  8) & 0xFF00)   |
+                 (((uint32_t) bin[2])       & 0xFF);
+
+    out[3] = table[x       & 0x3F];
+    out[2] = table[x >> 6  & 0x3F];
+    out[1] = table[x >> 12 & 0x3F];
+    out[0] = table[x >> 18 & 0x3F];
+
+}
+
+
+/*
+ * Provide padding to already initialized b64 output
+ */
+static void b64_padding(char *out, int pad_size) {
+
+    if (pad_size > 0) {
+        *out++ = '=';
+    }
+
+    if (pad_size > 1) {
+        *out++ = '=';
+    }
+
+    *out = '\0';
+}
+
+
+/*
+ * Encode file contents as b64 string
+ */
+int nc_b64enc_file(FILE *fh, char *buff, size_t buff_size) {
+
+    int ret_val = 1;
+    int out_count = 0;
+    int pad_size = 0;
+    char *buff_ptr = buff;
+    char bin[3] = {0, 0, 0};
+    size_t len = 0;
+
+    while ((len = fread(bin, 1, 3, fh)) > 0) {
+        b64_3b(bin, buff_ptr);
+        /*
+         Reset 2nd and 3rd bytes in case only one byte was read. If these
+         bytes are not clean b64 output will be corrupted with old bits.
+         */
+        bin[1] = bin[2] = 0;
+        /*
+         Advance pointer to the next free position of the b64 encoded
+         buffer. This happens to be len + 1 (as longs as len >= 1 and len <= 3)
+
+            len = 1 byte  -> b64 -> 2 bytes (or len + 1)
+            len = 2 bytes -> b64 -> 3 bytes (or len + 1)
+            len = 3 bytes -> b64 -> 4 bytes (or len + 1)
+        */
+        buff_ptr += (len + 1);
+        /*
+         Line break every 76 characters
+        */
+        out_count += (int) (len + 1);
+        if (out_count % B64_LINE_LEN == 0) {
+            *buff_ptr++ = '\n';
+        }
+        pad_size = padding[len];
+        /*
+         Check not to overflow buffer
+
+            buffer size <= b64 characters + padding length + null termination
+        */
+        if (buff_size <= (size_t) (buff_ptr - buff) + (size_t) pad_size + 1) {
+           ret_val = 0;
+           goto end_b64_enc;
+        }
+    }
+
+    b64_padding(buff_ptr, pad_size);
+
+end_b64_enc:
+
+    return ret_val;
+}
+
+
+int nc_b64enc_filename(const char *filename, char *buff, size_t buff_size) {
+
+    int ret = 0;
+    FILE *fh = NULL;
+
+    fh = fopen(filename, "rb");
+
+    if (fh == NULL) {
+        goto nc_b64_clean;
+    }
+
+    ret = nc_b64enc_file(fh, buff, buff_size);
+
+nc_b64_clean:
+
+    if (fh) {
+        fclose(fh);
+    }
+
+    return ret;
+}
+
+/* vi: set ts=8 sw=8 sts=4 et tw=80 cino=(0: */

src/nica/b64enc.h

@@ -0,0 +1,42 @@
+/*
+ * This file is part of libnica.
+ *
+ * Copyright © 2017 Intel Corporation
+ *
+ * libnica is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
+ *
+ * This is a chained base64 encode implementation.
+ */
+
+#pragma once
+
+#define _GNU_SOURCE
+
+#include "macros.h"
+
+/*
+ * Encodes contents of file handler in base64
+ *
+ * @param fh File handler to encode as base64
+ * @param buff Output buffer where the base64 output should be written
+ * @param buff_size Size of the output buffer
+ *
+ * @returns 1 in success and 0 in failure
+ */
+_nica_public_ int nc_b64enc_file(FILE *fh, char *buff, size_t buff_size);
+
+
+/*
+ * Encodes contents of file (filename) in base64
+ *
+ * @param filename File to encode as base64
+ * @param buff Output buffer where the base64 output should be written
+ * @param buff_size Size of the output buffer
+ *
+ * @returns 1 in success and 0 in failure
+ */
+_nica_public_ int nc_b64enc_filename(const char *filename, char *buff, size_t buff_size);
+

src/probes/README.md

@@ -2,6 +2,9 @@
 
 The default probes provided along the telemetry client code are:
 
+* bertprobe: this probe reports on the Boot Error Region Table if such
+  entry is found in ```/sys/firmware/acpi/tables/BERT```.
+
 * crashprobe: This probe processes core dump files. It can be registered as
   the kernel core file handler in /proc/sys/kernel/core_pattern.
 
@@ -12,7 +15,7 @@ The default probes provided along the telemetry client code are:
   from failed services.
 
 * klogscanner: a probe to collect 'oops messages' when the kernel detects a
-  problem. Also reports errors in the Boot Error Region Table if detected.
+  problem.
 
 * pstoreprobe: probe to collect messages left on pstore filesystem.
 

src/probes/bert_probe.c

@@ -0,0 +1,117 @@
+/*
+ * This program is part of the Clear Linux Project
+ *
+ * Copyright 2018 Intel Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms and conditions of the GNU Lesser General Public License, as
+ * published by the Free Software Foundation; either version 2.1 of the License,
+ * or (at your option) any later version.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+
+#define _GNU_SOURCE
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <getopt.h>
+#include "common.h"
+#include "telemetry.h"
+#include "nica/b64enc.h"
+
+#include "config.h"
+#include "log.h"
+
+static const char bert_record_file[] = "/sys/firmware/acpi/tables/data/BERT";
+static const char telem_record_class[] = "org.clearlinux/bert/debug";
+static uint32_t severity = 2;
+static uint32_t payload_version = 1;
+
+void print_usage(char *prog)
+{
+        printf("%s: Usage\n", prog);
+        printf("  -f,  --config_file    Specify a configuration file other than default\n");
+        printf("  -h,  --help           Display this help message\n");
+        printf("  -V,  --version        Print the program version\n");
+}
+
+int main(int argc, char **argv)
+{
+        struct telem_ref *tm_handle = NULL;
+        char *classification = (char *)telem_record_class;
+        char *payload;
+        int ret;
+
+        // Following vars are for arg parsing.
+        int c;
+        int opt_index = 0;
+        struct option opts[] = {
+                { "config_file", 1, NULL, 'f' },
+                { "help", 0, NULL, 'h' },
+                { "version", 0, NULL, 'V' },
+                { NULL, 0, NULL, 0 }
+        };
+
+        while ((c = getopt_long(argc, argv, "f:hV", opts, &opt_index)) != -1) {
+                switch (c) {
+                        case 'f':
+                                if (tm_set_config_file(optarg) != 0) {
+                                    telem_log(LOG_ERR, "Configuration file"
+                                                  " path not valid\n");
+                                    exit(EXIT_FAILURE);
+                                }
+                                break;
+                        case 'h':
+                                print_usage(argv[0]);
+                                exit(EXIT_SUCCESS);
+                        case 'V':
+                                printf(PACKAGE_VERSION "\n");
+                                exit(EXIT_SUCCESS);
+                        case '?':
+                                exit(EXIT_FAILURE);
+                }
+        }
+
+        payload = calloc(sizeof(char), MAX_PAYLOAD_LENGTH);
+        if (!payload) {
+                printf("Unable to allocate more memory.\n");
+                return -ENOMEM;
+        }
+
+        if (!(ret = nc_b64enc_filename(bert_record_file, payload, MAX_PAYLOAD_LENGTH))) {
+                printf("Failed to read payload from: %s\n", bert_record_file);
+                ret = EXIT_FAILURE;
+                goto done;
+        }
+
+        if ((ret = tm_create_record(&tm_handle, severity, classification,
+                                    payload_version)) < 0) {
+                printf("Failed to create record: %s\n", strerror(-ret));
+                goto done;
+        }
+
+        if ((ret = tm_set_payload(tm_handle, payload)) < 0) {
+                printf("Failed to set record payload: %s\n", strerror(-ret));
+                goto done;
+        }
+
+        if ((ret = tm_send_record(tm_handle)) < 0) {
+                printf("Failed to send record to daemon: %s\n", strerror(-ret));
+                goto done;
+        }
+
+        ret = EXIT_SUCCESS;
+done:
+        free(payload);
+        tm_free_record(tm_handle);
+        tm_handle = NULL;
+
+        return ret;
+}
+
+/* vi: set ts=8 sw=8 sts=4 et tw=80 cino=(0: */

src/probes/klog_scanner.c

@@ -23,7 +23,6 @@
 #include <unistd.h>
 #include <sys/stat.h>
 
-#include "common.h"
 #include "log.h"
 #include "oops_parser.h"
 #include "klog_scanner.h"
@@ -45,11 +44,6 @@ static bool send_data(char *backtrace, char *class, uint32_t severity)
                 return false;
         }
 
-        /* Truncate payload if necessary, otherwise nothing will be sent */
-        if (strlen(backtrace) > MAX_PAYLOAD_LENGTH) {
-                backtrace[MAX_PAYLOAD_LENGTH-1] = 0;
-        }
-
         if ((ret = tm_set_payload(handle, backtrace)) < 0) {
                 telem_log(LOG_ERR, "Failed to set payload: %s", strerror(-ret));
                 tm_free_record(handle);

src/probes/local.mk

@@ -4,7 +4,8 @@ bin_PROGRAMS += \
 	%D%/telem-record-gen \
 	%D%/klogscanner \
 	%D%/pstoreprobe \
-	%D%/pstoreclean
+	%D%/pstoreclean \
+	%D%/bertprobe
 
 %C%_hprobe_SOURCES = %D%/hello.c
 %C%_hprobe_LDADD = $(top_builddir)/src/libtelemetry.la
@@ -20,6 +21,21 @@ if HAVE_SYSTEMD_JOURNAL
 endif
 endif
 
+%C%_bertprobe_SOURCES = %D%/bert_probe.c \
+	src/nica/b64enc.c
+%C%_bertprobe_CFLAGS = $(AM_CFLAGS)
+%C%_bertprobe_LDADD = $(top_builddir)/src/libtelemetry.la
+%C%_bertprobe_LDFLAGS = \
+        $(AM_LDFLAGS) \
+        -pie
+
+if LOG_SYSTEMD
+if HAVE_SYSTEMD_JOURNAL
+%C%_bertprobe_CFLAGS += $(SYSTEMD_JOURNAL_CFLAGS)
+%C%_bertprobe_LDADD += $(SYSTEMD_JOURNAL_LIBS)
+endif
+endif
+
 %C%_telem_record_gen_SOURCES = %D%/telem_record_gen.c
 %C%_telem_record_gen_CFLAGS = \
 	$(AM_CFLAGS)

src/probes/oops_parser.c

@@ -162,12 +162,6 @@ struct oops_pattern oops_patterns_arr[] = {
                 TM_CRITICAL,
                 false,
         },
-        {
-                "BERT: Error records from previous boot:",
-                "org.clearlinux/bert/debug",
-                TM_MEDIUM,
-                false,
-        },
 };
 
 static int oops_patterns_cnt = sizeof(oops_patterns_arr) / sizeof(struct oops_pattern);
@@ -340,7 +334,6 @@ void oops_msg_cleanup(struct oops_log_msg *msg)
 static struct oops_log_msg oops_msg;
 
 static bool in_stack_dump = false;
-static bool in_bert_dump = false;
 
 static oops_handler_t oops_handler;
 
@@ -364,19 +357,6 @@ void oops_parser_cleanup()
         free_pattern_regex();
 }
 
-/*
- *
-[    1.609112] BERT: Error records from previous boot:
-[    1.609113] [Hardware Error]: event severity: fatal
-[    1.609115] [Hardware Error]:  Error 0, type: fatal
-[    1.609116] [Hardware Error]:   section type: unknown, 81212a96-09ed-4996-9471-8d729c8e69ed
-[    1.609117] [Hardware Error]:   section length: 0xc10
-[    1.609119] [Hardware Error]:   00000000: 00000001 00000000 00000000 01001002  ................
-[    1.609120] [Hardware Error]:   00000010: 01001002 00000001 c71f0d2f 00000003  ......../.......
-[    1.609122] [Hardware Error]:   00000020: 00000001 0000004f 0c070048 800001ff  ....O...H.......
-[    1.609123] [Hardware Error]:   00000030: 02002080 7e15fe03 00000001 00000000  . .....~......
- ...
- */
 void parse_single_line(char *line, size_t size)
 {
         char *start;
@@ -396,30 +376,28 @@ void parse_single_line(char *line, size_t size)
                                 continue;
                         }
                         telem_log(LOG_DEBUG, "Oops start has been  detected\n");
+
                         oops_msg.pattern = pattern;
                         oops_msg.lines[oops_msg.length] = strndup(start, (size_t)(line_end - start));
                         if (oops_msg.lines[oops_msg.length] == NULL) {
                                 //telem_perror("Failed to copy string");
                                 exit(EXIT_FAILURE);
                                 return;
+                        } else {
+                                oops_msg.length++;
                         }
-
-                        oops_msg.length++;
                         in_stack_dump = false;
-                        in_bert_dump = false;
-                        if (strstr(oops_msg.pattern->begin_line, "BERT:")) {
-                                in_bert_dump = true;
-                        }
-                        return;
+                        break;
                 }
         } else {
                 // If in the middle of oops
                 if (oops_msg.length >= MAX_LINES) {
-                        fprintf(stderr,"*** MAX_LINES!!\n");
                         end_found = true;
+                        // } else if (oops_msg.end_line && strstr(start, oops_msg.end_line)) {
+                        //        end_found = false;
                 } else if (strstr(start, "[ end trace")) {
                         end_found = true;
-                } else if (!in_stack_dump && !in_bert_dump) {
+                } else if (!in_stack_dump) {
                         // This line indicates the beginning of a stack trace;
                         // the next line is most likely the topmost frame.
                         if (starts_with(start, line_end, "Call Trace:")) {
@@ -436,10 +414,6 @@ void parse_single_line(char *line, size_t size)
                                 in_stack_dump = false;
                                 end_found = true;
                         }
-                } else if (in_bert_dump) {
-                        if (!strstr(start, "[Hardware Error]:")) {
-                                end_found = true;
-                        }
                 }
 
                 /* if a new oops starts, this one has ended */
@@ -873,28 +847,15 @@ static nc_string *parse_backtrace(struct oops_log_msg *msg)
         return backtrace;
 }
 
-static void append_payload(nc_string *payload, struct oops_log_msg *msg)
-{
-        for (int i = 1; i < msg->length; i++) {
-                nc_string_cat(payload,msg->lines[i]);
-                nc_string_cat(payload,"\n");
-        }
-}
-
 nc_string *parse_payload(struct oops_log_msg *msg)
 {
         nc_string *payload, *backtrace;
 
         payload = nc_string_dup("Crash Report:\n");
         nc_string_append_printf(payload, "Reason: %s\n", msg->lines[0]);
-        if (strstr(msg->lines[0], "BERT:")) {
-                append_payload(payload, msg);
-        } else {
-                backtrace = parse_backtrace(msg);
-                nc_string_cat(payload, backtrace->str);
-                nc_string_free(backtrace);
-        }
-
+        backtrace = parse_backtrace(msg);
+        nc_string_cat(payload, backtrace->str);
+        nc_string_free(backtrace);
         return payload;
 
 }

src/telemctl.c

@@ -69,7 +69,6 @@ static int telemctl_opt_in(void);
 static int telemctl_journal(char *);
 
 struct telemcmd {
-        bool root;
         char *cmd;
         union {
         int  (*f1)(void);
@@ -79,13 +78,13 @@ struct telemcmd {
 };
 
 static struct telemcmd commands[] = {
-        {true,  "stop",      {.f1=telemctl_stop},     "Stops all running telemetry services" },
-        {true,  "start",     {.f1=telemctl_start},    "Starts all telemetry services" },
-        {true,  "restart",   {.f1=telemctl_restart},  "Restarts all telemetry services" },
-        {false, "is-active", {.f1=telemctl_is_active},"Checks if telemprobd and telempostd are active" },
-        {true,  "opt-in",    {.f1=telemctl_opt_in},   "Opts in to telemetry, and starts telemetry services" },
-        {true,  "opt-out",   {.f1=telemctl_opt_out},  "Opts out of telemetry, and stops telemetry services" },
-        {true,  "journal",   {.f2=telemctl_journal},  "Prints telemetry journal contents. Use -h argument with\n            command for more options"}
+        {"stop",      {.f1=telemctl_stop},     "Stops all running telemetry services" },
+        {"start",     {.f1=telemctl_start},    "Starts all telemetry services" },
+        {"restart",   {.f1=telemctl_restart},  "Restarts all telemetry services" },
+        {"is-active", {.f1=telemctl_is_active},"Checks if telemprobd and telempostd are active" },
+        {"opt-in",    {.f1=telemctl_opt_in},   "Opts in to telemetry, and starts telemetry services" },
+        {"opt-out",   {.f1=telemctl_opt_out},  "Opts out of telemetry, and stops telemetry services" },
+        {"journal",   {.f2=telemctl_journal},  "Prints telemetry journal contents. Use -h argument with\n            command for more options"}
 };
 
 static int syscmd(char *cmd, char *buff, int bufflen)
@@ -397,9 +396,9 @@ static int telemctl_opt_out(void)
                         fprintf(stderr, "Already opted out. Nothing to do.\n");
                         return 0;
                 }
-                fprintf(stderr, "Failed to remove %s.\n", TM_OPT_IN);
+		fprintf(stderr, "Failed to remove %s.\n", TM_OPT_IN);
                 return 1;
-        }
+	}
 
         ret = telemctl_stop();
         ret |= telemctl_remove_work_dirs();
@@ -426,7 +425,7 @@ static int telemctl_opt_in(void)
                 return 1;
         }
 
-        /* Create a brand new file TM_OPT_IN, we may fail because the file exists already.
+	/* Create a brand new file TM_OPT_IN, we maight fail because the file exists already.
          * In that case we are already opted in and we are done here. */
         int fd = open(TM_OPT_IN, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
         if (fd == -1) {
@@ -522,7 +521,7 @@ int main(int argc, char **argv)
 
         for (i = 0; i < sizeof(commands)/sizeof(commands[0]); i++) {
                 if (strcmp(commands[i].cmd, argv[1]) == 0) {
-                        if (commands[i].root == true && is_root == false) {
+                        if (!is_root) {
                                 fprintf(stderr, "Must be root to run this command. Exiting...\n");
                                 exit(1);
                         }

tests/check_ncb64.c

@@ -0,0 +1,192 @@
+/*
+ * This program is part of the Clear Linux Project
+ *
+ * Copyright 2017 Intel Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms and conditions of the GNU Lesser General Public License, as
+ * published by the Free Software Foundation; either version 2.1 of the License,
+ * or (at your option) any later version.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+
+#define OUT_MAX_LEN 100
+
+#include <stdio.h>
+#include <check.h>
+#include "nica/b64enc.h"
+
+START_TEST(check_nc_b64_no_overflow)
+{
+        size_t n = 2;
+        char out[OUT_MAX_LEN];
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/foobar";
+
+        ck_assert_msg(!nc_b64enc_filename(filename, &out[0], n), "Should quit since buffer smaller than content");
+}
+END_TEST
+
+START_TEST(check_nc_b64_enc_n_file_empty)
+{
+        size_t n = OUT_MAX_LEN;
+        char out[OUT_MAX_LEN];
+        char *result = "\0";
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/empty";
+
+        ck_assert_msg(nc_b64enc_filename(filename, &out[0], n), "Error opening file");
+        ck_assert_str_eq(out, result);
+}
+END_TEST
+
+START_TEST(check_nc_b64_enc_n_file_fo)
+{
+        size_t n = OUT_MAX_LEN;
+        char out[OUT_MAX_LEN];
+        char *result = "Zm8=";
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/fo";
+
+        ck_assert_msg(nc_b64enc_filename(filename, &out[0], n), "Error opening file");
+        ck_assert_str_eq(out, result);
+}
+END_TEST
+
+START_TEST(check_nc_b64_enc_n_file_foob)
+{
+        size_t n = OUT_MAX_LEN;
+        char out[OUT_MAX_LEN];
+        char *result = "Zm9vYg==";
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/foob";
+
+        ck_assert_msg(nc_b64enc_filename(filename, &out[0], n), "Error opening file");
+        ck_assert_str_eq(out, result);
+}
+END_TEST
+
+START_TEST(check_nc_b64_enc_n_file_foobar)
+{
+        size_t n = OUT_MAX_LEN;
+        char out[OUT_MAX_LEN];
+        char *result = "Zm9vYmFyZm9vYmFy";
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/foobar";
+
+        ck_assert_msg(nc_b64enc_filename(filename, &out[0], n), "Error opening file");
+        ck_assert_str_eq(out, result);
+}
+END_TEST
+
+START_TEST(check_nc_b64_enc_n_file_long_text)
+{
+        size_t out_len = 8000;
+        char out[out_len];
+        const char *expected_out = \
+                "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIG5vbnVtbXkgdml0YWUsIGluIHZpdmFtdXMgc3Vz\n"
+                "cGVuZGlzc2UgYWMuIFNlbXBlciBzZWQgcGhhcmV0cmEgc2NlbGVyaXNxdWUuIEVnZXQgZWxlaWZl\n"
+                "bmQgYW1ldCB2ZWwgbnVuYyB2b2x1dHBhdCBjdXJzdXMsIGF1Y3RvciBwbGF0ZWEgcHJldGl1bSwg\n"
+                "bWF0dGlzIHJpc3VzIGZhY2lsaXNpcyBmYXVjaWJ1cywgc3VzcGVuZGlzc2UgZGlhbSwgbGVjdHVz\n"
+                "IG1ldHVzIG51bGxhLiBOdW5jIGp1c3RvIGZhY2lsaXNpIG5hbSBmZWxpcyB2ZWwgbGFvcmVldCwg\n"
+                "bmliaCBsZW8gbWFzc2Egc3VzcGVuZGlzc2UgYWNjdW1zYW4gY29udmFsbGlzLCBzZWQgcXVpcyBw\n"
+                "ZWxsZW50ZXNxdWUgZWdlc3RhcywgbG9yZW0gYW50ZSBtb3JiaSBtYXR0aXMgdml0YWUuIFByYWVz\n"
+                "ZW50IGluIHJ1dHJ1bSBlZ2V0IGFjLCB2aXZhbXVzIHBlZGUgc3VzcGVuZGlzc2UgbGVjdHVzIG51\n"
+                "bGxhbSwgZXQgcGVkZSBldSBvZGlvIHBlZGUsIGV0aWFtIGxlbyBlZ2VzdGFzIGluLCBub251bW15\n"
+                "IHNlbXBlci4gQSBhY2N1bXNhbiBkdWksIHZlc3RpYnVsdW0gcmlkaWN1bHVzIGV0IGluLCBqdXN0\n"
+                "byBldCBwbGFjZXJhdCBkdWlzIHV0IHZpdmFtdXMgbGliZXJvLiBWZXN0aWJ1bHVtIGVnZXQgdXQg\n"
+                "bW9sbGlzLCBudW5jIGEgc29sbGljaXR1ZGluLCBmcmluZ2lsbGEgZXJvcyBwb3N1ZXJlIG1vbGxp\n"
+                "cyBhYyBuYXRvcXVlIHBlZGUsIHJpc3VzIG51bGxhIHJ1dHJ1bSB0dXJwaXMgYSB2aXRhZSBpZC4g\n"
+                "SW5jZXB0b3MgdGluY2lkdW50IHF1aWRlbSBhcmN1IHR1cnBpcyBudW5jIHNvbGxpY2l0dWRpbi4g\n"
+                "UGhhc2VsbHVzIG1ldHVzIGVyYXQgcGxhY2VyYXQsIGluIGVyYXQgbG9yZW0gbWF1cmlzIG51bGxh\n"
+                "LCBhdCBsaWJlcm8gZXJhdCBzdXNwZW5kaXNzZSBzYXBpZW4gbW9udGVzIHJob25jdXMsIG1hZ25h\n"
+                "IHF1YW0uIEp1c3RvIHByYWVzZW50IGxhY3VzIG1hc3NhLCByZXByZWhlbmRlcml0IG51bmMsIHJp\n"
+                "c3VzIGRpZ25pc3NpbSBmZWxpcyBub24sIGRpZ25pc3NpbSBvZGlvIHRlbGx1cyBhbGlxdWFtLCBl\n"
+                "bmltIHNvZGFsZXMgdGVtcG9yIHF1aXNxdWUgc29kYWxlcyBtYWduaXMgcG9ydHRpdG9yLiBMaWd1\n"
+                "bGEgc2VkIHJpc3VzLCBldSBlc3QgcXVpc3F1ZSwgY2xhc3Mgbm9uIGF1dGUgZXUsIHBsYXRlYSBz\n"
+                "Y2VsZXJpc3F1ZSBpZCBpbnRlZ2VyIGRpZ25pc3NpbW9zIGludGVnZXIgc3VzY2lwaXQuClZlaGlj\n"
+                "dWxhIGVpdXMgbmVjLCBjb252YWxsaXMgbWFlY2VuYXMgbGVjdHVzIHB1cnVzIHF1aXNxdWUgYWxp\n"
+                "cXVhbSwgZXQgZXQsIGxhY2luaWEgZGlzIGRpZ25pc3NpbSBsb3JlbS4gVm9sdXB0YXRlbSB1dCwg\n"
+                "dml2ZXJyYSBhZW5lYW4gcGhhc2VsbHVzIGZlbGlzLCBmZXJtZW50dW0gbGlndWxhIGVnZXQgdWxs\n"
+                "YW1jb3JwZXIgYW1ldCwgbWF1cmlzIGxlbyBsdWN0dXMuIEV0IGV0aWFtIHNlbXBlciBwaGFyZXRy\n"
+                "YSBuaWJoIG1pIG1hdXJpcy4gSGVuZHJlcml0IHNlZCBhbGlxdWFtLCBlZ2V0IGlkIHRlbGx1cyBt\n"
+                "YWduYSwgc2VkIGxhb3JlZXQgdWx0cmljZXMgZW5pbSwgbW9sbGlzIHN1c3BlbmRpc3NlIGluLiBF\n"
+                "dSBudWxsYW0gbG9yZW0gc2l0IGV0aWFtLCBvcmNpIGluIGxpYmVyby4gTnVuYyBpcHN1bSBtYXVy\n"
+                "aXMgZXQgc2VtIGhhYy4gRGljdHVtIGZhdWNpYnVzIGRpcyB2aXRhZSBpbiB2b2x1dHBhdCBtb3Ji\n"
+                "aSwgYSBkaWN0dW0sIHF1aXNxdWUgbWF1cmlzLCBhdWN0b3IgbmVjIHZlbCBwZWxsZW50ZXNxdWUg\n"
+                "dWxsYW1jb3JwZXIgZXRpYW0uIEN1bSBsaWJlcm8gd2lzaSBhY2N1bXNhbiBhbGlxdWFtIGNvbnNl\n"
+                "Y3RldHVlciB0ZWxsdXMsIHBoYXNlbGx1cyBjdXJhZSwgYXQgaWxsdW0gYW50ZSBwcmV0aXVtIG5p\n"
+                "YmggbW9yYmkuIFNlZCBibGFuZGl0IHB1bHZpbmFyIHB1bHZpbmFyLiBEaWN0dW0gZXN0IG51bmMg\n"
+                "ZWxlaWZlbmQsIHZlbGl0IHZlbGl0IHRlbXBvciBhY2N1bXNhbiBsb2JvcnRpcyBsYW9yZWV0IGNv\n"
+                "bmd1ZS4gU2l0IGFtZXQsIHNlZCBuaWJoIHBvcnJvIG5lcXVlIGF1Y3RvciBoeW1lbmFlb3MgcG9z\n"
+                "dWVyZSwgb2RpbyBudWxsYSBibGFuZGl0IGNvbmd1ZSBlbGl0LiBJZCBmYXVjaWJ1cyBldCB0ZW1w\n"
+                "dXMgbWFsZXN1YWRhIHBsYXRlYS4=";
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/long_text";
+
+        ck_assert_msg(nc_b64enc_filename(filename, &out[0], out_len), "Error opening file");
+        ck_assert_str_eq(out, expected_out);
+}
+END_TEST
+
+START_TEST(check_nc_b64_enc_n_filehandler_foobar)
+{
+        size_t n = OUT_MAX_LEN;
+        char out[OUT_MAX_LEN];
+        char *result = "Zm9vYmFyZm9vYmFy";
+        const char *filename = TOPSRCDIR "/tests/nc_b64enc_test_files/foobar";
+        FILE *fh = NULL;
+
+        fh = fopen(filename, "rb");
+
+        if (fh == NULL) {
+                ck_abort_msg("Unable to open foobar file");
+        }
+
+        ck_assert_msg(nc_b64enc_file(fh, &out[0], n), "Result does not match");
+        ck_assert_str_eq(out, result);
+}
+END_TEST
+
+Suite *config_suite(void)
+{
+        // A suite is comprised of test cases, defined below
+        Suite *s = suite_create("nc_b64enc");
+
+        // Individual unit tests are added to "test cases"
+        TCase *t = tcase_create("nc_b64enc");
+        tcase_add_test(t, check_nc_b64_no_overflow);
+        tcase_add_test(t, check_nc_b64_enc_n_file_empty);
+        tcase_add_test(t, check_nc_b64_enc_n_file_fo);
+        tcase_add_test(t, check_nc_b64_enc_n_file_foob);
+        tcase_add_test(t, check_nc_b64_enc_n_file_foobar);
+        tcase_add_test(t, check_nc_b64_enc_n_file_long_text);
+        tcase_add_test(t, check_nc_b64_enc_n_filehandler_foobar);
+
+        suite_add_tcase(s, t);
+
+        return s;
+}
+
+int main(void)
+{
+        Suite *s;
+        SRunner *sr;
+
+        s = config_suite();
+        sr = srunner_create(s);
+
+        // Use the TAP driver for now, so that each
+        // unit test will PASS/FAIL in the log output.
+        srunner_set_log(sr, NULL);
+        srunner_set_tap(sr, "-");
+
+        srunner_run_all(sr, CK_SILENT);
+        // failed = srunner_ntests_failed(sr);
+        srunner_free(sr);
+
+        // if you want the TAP driver to report a hard error based
+        // on certain conditions (e.g. number of failed tests, etc.),
+        // return non-zero here instead.
+        return 0;
+}
+
+/* vi: set ts=8 sw=8 sts=4 et tw=80 cino=(0: */

tests/local.mk

@@ -15,6 +15,7 @@ check_PROGRAMS = \
 	%D%/check_probd \
 	%D%/check_postd \
 	%D%/check_probes \
+	%D%/check_ncb64  \
 	%D%/check_journal \
 	%D%/check_libtelemetry
 
@@ -154,6 +155,25 @@ if HAVE_SYSTEMD_JOURNAL
 endif
 endif
 
+%C%_check_ncb64_SOURCES = \
+	%D%/check_ncb64.c \
+	src/nica/b64enc.h \
+	src/nica/b64enc.c
+
+%C%_check_ncb64_CFLAGS = \
+	$(AM_CFLAGS) \
+	@CHECK_CFLAGS@
+
+%C%_check_ncb64_LDADD = \
+	@CHECK_LIBS@
+
+EXTRA_DIST += \
+	%D%/nc_b64enc_test_files/empty \
+	%D%/nc_b64enc_test_files/fo \
+	%D%/nc_b64enc_test_files/foob \
+	%D%/nc_b64enc_test_files/foobar \
+	%D%/nc_b64enc_test_files/long_text
+
 %C%_check_journal_SOURCES = \
 	%D%/check_journal.c \
 	src/journal/journal.c \