test/runtest: Move testbench code into runtest

Prior to this commit, the testbench app predefined a set of four tasks
for use by unit tests.  Unit tests that needed to use generic tasks
would assume the presence of tasks called "task1", "task2", etc.  In
addition, the testbench was responsible for logging test results.

This approach had some problems:
    * Introduction of unit tests requires major changes to the app:
        o Define new tasks and stacks and add code to initialize and
          suspend
        o Create a cbmem and register a test log.
        o Write dedicated "driver" code for each test suite.
    * Different test code for SELFTEST vs. real-hardware (the testbench
      app is not present during a self-test).
    * Number of generic tasks limited to four.

This commit adds a generic task-allocation mechanism to the
`test/runtest` library.  When a unit test needs a new task, it requests
one from runtest.  When a test completes, runtest suspends all the
allocated tasks.  In addition, runtest registers a cbmem-backed test log
if configured to do so (`RUNTEST_LOG`).

Author: ccollins476ad

apps/testbench/src/testbench.c

@@ -44,6 +44,8 @@
 #include <id/id.h>
 #include <oic/oc_api.h>
 #include <oic/oc_gatt.h>
+#include "json_test/json_test.h"
+#include "os_test/os_test.h"
 
 #include "testutil/testutil.h"
 
@@ -67,17 +69,11 @@
 #if MYNEWT_VAL(RUNTEST_CLI)
 #include "runtest/runtest.h"
 #endif
-
-#include "testbench.h"
 #include "tbb.h"
 
 struct os_timeval tv;
 struct os_timezone tz;
 
-/* Init all tasks */
-volatile int tasks_initialized;
-int init_tasks(void);
-
 /* Test Task */
 #define TESTTASK_PRIO (1)
 #define TESTTASK_STACK_SIZE    OS_STACK_ALIGN(256)
@@ -86,193 +82,19 @@ static struct os_task testtask;
 /* For LED toggling */
 int g_led_pin;
 
-os_stack_t *stack1;
-os_stack_t *stack2;
-os_stack_t *stack3;
-os_stack_t *stack4;
-
-/*
- * Test log cbmem buf
- */
-#define MAX_CBMEM_BUF 2048
-uint32_t *cbmem_buf;
-struct cbmem cbmem;
-
-struct log testlog;
-int total_tests;
-int total_fails;
 int blinky_blink;
 
-int forcefail; /* to optionally force a fail on a tests */
-
 #define BLINKY_DUTYCYCLE_SUCCESS 1
 #define BLINKY_DUTYCYCLE_FAIL 16
 
-char buildID[TESTBENCH_BUILDID_SZ];
-
-struct runtest_evq_arg test_event_arg;
-char runtest_token[RUNTEST_REQ_SIZE];
-static int testbench_runtests(struct os_event *ev);
-static void testbench_test_complete(void);
-
-extern uint32_t stack1_size;
-extern uint32_t stack2_size;
-extern uint32_t stack3_size;
-extern uint32_t stack4_size;
-
-struct ts_suite *current_ts;
-
-void
-testbench_ts_result(char *msg, void *arg, bool passed)
-{
-    /* Must log valid json with a strlen less than LOG_PRINTF_MAX_ENTRY_LEN */
-    char buf[LOG_PRINTF_MAX_ENTRY_LEN];
-    char *n;
-    int n_len;
-    char *s;
-    int s_len;
-    char *m;
-    int m_len;
-
-    int len = 35; /* str length of {"k":"","n":"","s":"","m":"","r":1} */
-    len += strlen(runtest_token);
-
-    /* How much of the test name can we log? */
-    n_len = strlen(tu_case_name);
-    if (len + n_len >= LOG_PRINTF_MAX_ENTRY_LEN) {
-        n_len = LOG_PRINTF_MAX_ENTRY_LEN - len - 1;
-    }
-    len += n_len;
-    n = buf;
-    strncpy(n, tu_case_name, n_len + 1);
-
-    /* How much of the suite name can we log? */
-    s_len = strlen(current_ts->ts_name);
-    if (len + s_len >= LOG_PRINTF_MAX_ENTRY_LEN) {
-        s_len = LOG_PRINTF_MAX_ENTRY_LEN - len - 1;
-    }
-    len += s_len;
-    s = n + n_len + 2;
-    strncpy(s, current_ts->ts_name, s_len + 1);
-
-    /* How much of the message can we log? */
-    m_len = strlen(msg);
-    if (len + m_len >= LOG_PRINTF_MAX_ENTRY_LEN) {
-        m_len = LOG_PRINTF_MAX_ENTRY_LEN - len - 1;
-    }
-    m = s + s_len + 2;
-    strncpy(m, msg, m_len + 1);
-
-
-    TESTBENCH_UPDATE_TOD;
-
-    total_tests++;
-    if (!passed) {
-        total_fails++;
-    }
-
-    MODLOG_INFO(
-        LOG_MODULE_TEST,
-        "{\"k\":\"%s\",\"n\":\"%s\",\"s\":\"%s\",\"m\":\"%s\",\"r\":%d}",
-        runtest_token, n, s, m, passed);
-}
-
-void
-testbench_ts_pass(char *msg, void *arg)
-{
-    testbench_ts_result(msg, arg, true);
-}
-
-void
-testbench_ts_fail(char *msg, void *arg)
-{
-    testbench_ts_result(msg, arg, false);
-}
+OS_TASK_STACK_DEFINE(teststack, TESTTASK_STACK_SIZE);
 
 void
 testbench_test_init(void)
 {
-    total_tests = 0;
-    total_fails = 0;
-    forcefail = 0;
     blinky_blink = BLINKY_DUTYCYCLE_SUCCESS;
 }
 
-static int
-testbench_runtests(struct os_event *ev)
-{
-    struct runtest_evq_arg *runtest_arg;
-    int run_all = 0;
-
-    /*
-     * testbench_runtests is normally initiated from newtmanager using the cli
-     */
-    testbench_test_init();
-    if (ev != NULL) {
-        runtest_arg = ev->ev_arg;
-
-        ts_config.ts_print_results = 0;
-        ts_config.ts_system_assert = 0;
-
-        /*
-         * The specified "token" is appended to the end of every log message
-         * that is level INFO and above (i.e. not log_debug log messages)
-         */
-        strcpy(runtest_token, runtest_arg->run_token);
-
-        /*
-         * In run_all set, each test suite is executed
-         */
-        run_all = (strcmp(runtest_arg->run_testname, "all") == 0);
-
-        /*
-         * If no testname was provided (e.g., in the case where mgmt protocol
-         * did not use the newtmgr application), make the default to run all
-         * the tests.
-         */
-        if (runtest_arg->run_testname[0] == '\0') {
-            run_all = 1;
-        }
-
-        /*
-         * go through entire list of registered test suites
-         */
-        SLIST_FOREACH(current_ts, &g_ts_suites, ts_next) {
-            if (run_all || !strcmp(runtest_arg->run_testname, current_ts->ts_name)) {
-                current_ts->ts_test();
-            }
-        }
-    } else {
-        /*
-         * run all tests if NULL event is passed as an argument (untested)
-         */
-        SLIST_FOREACH(current_ts, &g_ts_suites, ts_next) {
-            current_ts->ts_test();
-        }
-    }
-    testbench_test_complete();
-
-    return tu_any_failed;
-}
-
-/*
- * Print results - ci gateway is checking this message syntax to
- * determine success or failure
- */
-static void
-testbench_test_complete(void)
-{
-    MODLOG_INFO(LOG_MODULE_TEST, "%s Done", runtest_token);
-    MODLOG_INFO(LOG_MODULE_TEST,
-                "%s TESTBENCH TEST %s - Tests run:%d pass:%d fail:%d %s",
-                buildID,
-                (total_fails ? "FAILED" : "PASSED"),
-                total_tests,
-                (total_tests-total_fails),
-                total_fails,
-                runtest_token);
-}
-
 /*
  * Run the tests
  * If any tests fail, blink the LED BLINKY_DUTYCYCLE_FAIL (16) times a second
@@ -290,79 +112,18 @@ testtask_handler(void *arg)
          * if any test fails, blinky the LED more rapidly to
          * provide visual feedback from physical device.
          */
-        if (total_fails) {
+        if (runtest_total_fails_get() > 0) {
             blinky_blink = BLINKY_DUTYCYCLE_FAIL;
         }
 
-        while (1) {
-            /* Wait one second */
-            os_time_delay(OS_TICKS_PER_SEC / blinky_blink);
+        /* Wait one second */
+        os_time_delay(OS_TICKS_PER_SEC / blinky_blink);
 
-            /* Toggle the LED */
-            hal_gpio_toggle(g_led_pin);
-        }
+        /* Toggle the LED */
+        hal_gpio_toggle(g_led_pin);
     }
 }
 
-/*
- * init_tasks include test workers 
- */
-int
-init_tasks(void)
-{
-    os_stack_t *teststack;
-
-    /*
-     * malloc the stacks for the testworker tasks
-     */
-    stack1 = malloc(sizeof(os_stack_t) * TASK1_STACK_SIZE);
-    assert(stack1);
-    stack1_size = TASK1_STACK_SIZE;
-
-    stack2 = malloc(sizeof(os_stack_t) * TASK2_STACK_SIZE);
-    assert(stack2);
-    stack2_size = TASK2_STACK_SIZE;
-
-    stack3 = malloc(sizeof(os_stack_t) * TASK3_STACK_SIZE);
-    assert(stack3);
-    stack3_size = TASK3_STACK_SIZE;
-
-    stack4 = malloc(sizeof(os_stack_t) * TASK4_STACK_SIZE);
-    assert(stack4);
-    stack4_size = TASK4_STACK_SIZE;
-
-    teststack = malloc(sizeof(os_stack_t) * TESTTASK_STACK_SIZE);
-    assert(teststack);
-    os_task_init(&testtask, "testtask", testtask_handler, NULL,
-                 TESTTASK_PRIO, OS_WAIT_FOREVER, teststack,
-                 TESTTASK_STACK_SIZE);
-
-    tasks_initialized = 1;
-    return 0;
-}
-
-/*
- * buildID string is prepended to each log message.
- * BUILD_TARGET and BUILD_ID are assume to be initialized by
- * build infrastructure. testbench.h sets default values if not.
- */
-void
-getBuildID(void)
-{
-    sprintf(buildID, "%s Build %s:", BUILD_TARGET, BUILD_ID);
-}
-
-/*
- * Test suites must be declared before being referenced.
- * Note that we're not actually declaring the test suites themselves,
- * but rather their helper functions which initialize the appropriate
- * callbacks before executing on target HW.
- */
-TEST_SUITE_DECL(testbench_mempool);
-TEST_SUITE_DECL(testbench_mutex);
-TEST_SUITE_DECL(testbench_sem);
-TEST_SUITE_DECL(testbench_json);
-
 static void
 omgr_app_init(void)
 { }
@@ -383,15 +144,6 @@ main(int argc, char **argv)
 
     sysinit();
 
-    getBuildID();
-
-    cbmem_buf = malloc(sizeof(uint32_t) * MAX_CBMEM_BUF);
-    cbmem_init(&cbmem, cbmem_buf, MAX_CBMEM_BUF);
-    log_register("testlog", &testlog, &log_cbmem_handler, &cbmem, LOG_SYSLEVEL);
-
-    rc = modlog_register(LOG_MODULE_TEST, &testlog, LOG_LEVEL_DEBUG, NULL);
-    assert(rc == 0);
-
     /* Initialize the OIC  */
     oc_main_init((oc_handler_t *)&omgr_oc_handler);
 
@@ -406,20 +158,16 @@ main(int argc, char **argv)
      * Register the tests that can be run by lookup
      * - each test is added to the ts_suites slist
      */
-    TEST_SUITE_REGISTER(testbench_mempool);
-    TEST_SUITE_REGISTER(testbench_mutex);
-    TEST_SUITE_REGISTER(testbench_sem);
-    TEST_SUITE_REGISTER(testbench_json);
+    TEST_SUITE_REGISTER(os_mempool_test_suite);
+    TEST_SUITE_REGISTER(os_mutex_test_suite);
+    TEST_SUITE_REGISTER(os_sem_test_suite);
+    TEST_SUITE_REGISTER(test_json_suite);
 
     testbench_test_init(); /* initialize globals include blink duty cycle */
 
-    rc = init_tasks();
-
-    /*
-     * This sets the callback function for the events that are
-     * generated from newtmanager.
-     */
-    run_evcb_set((os_event_fn*) testbench_runtests);
+    os_task_init(&testtask, "testtask", testtask_handler, NULL,
+                 TESTTASK_PRIO, OS_WAIT_FOREVER, teststack,
+                 TESTTASK_STACK_SIZE);
 
     MODLOG_INFO(LOG_MODULE_TEST, "testbench app initialized");