use helper in cmd node
[protos/libecoli.git] / lib / ecoli_test.c
index c859d07..b090bd3 100644 (file)
-/*
- * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in the
- *       documentation and/or other materials provided with the distribution.
- *     * Neither the name of the University of California, Berkeley nor the
- *       names of its contributors may be used to endorse or promote products
- *       derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
  */
 
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include <assert.h>
+#include <errno.h>
 
 #include <ecoli_log.h>
 #include <ecoli_malloc.h>
 #include <ecoli_test.h>
-#include <ecoli_tk.h>
+#include <ecoli_strvec.h>
+#include <ecoli_node.h>
+#include <ecoli_parse.h>
+#include <ecoli_complete.h>
+#include <ecoli_parse.h>
 
 static struct ec_test_list test_list = TAILQ_HEAD_INITIALIZER(test_list);
 
-/* register a driver */
-void ec_test_register(struct ec_test *test)
-{
-       TAILQ_INSERT_TAIL(&test_list, test, next);
-}
+EC_LOG_TYPE_REGISTER(test);
 
-int ec_test_check_tk_parse(const struct ec_tk *tk, const char *input,
-       const char *expected)
+static struct ec_test *ec_test_lookup(const char *name)
 {
-       struct ec_parsed_tk *p;
-       const char *s;
-       int ret = -1;
-
-       p = ec_tk_parse(tk, input);
-       s = ec_parsed_tk_to_string(p);
-       if (s == NULL && expected == NULL)
-               ret = 0;
-       else if (s != NULL && expected != NULL &&
-               !strcmp(s, expected))
-               ret = 0;
-
-       if (expected == NULL && ret != 0)
-               ec_log(EC_LOG_ERR, "tk should not match but matches <%s>\n", s);
-       if (expected != NULL && ret != 0)
-               ec_log(EC_LOG_ERR, "tk should match <%s> but matches <%s>\n",
-                       expected, s);
+       struct ec_test *test;
 
-       ec_parsed_tk_free(p);
+       TAILQ_FOREACH(test, &test_list, next) {
+               if (!strcmp(name, test->name))
+                       return test;
+       }
 
-       return ret;
+       errno = EEXIST;
+       return NULL;
 }
 
-int ec_test_check_tk_complete(const struct ec_tk *tk, const char *input,
-       const char *expected)
+int ec_test_register(struct ec_test *test)
 {
-       struct ec_completed_tk *c;
-       const char *s;
-       int ret = -1;
-
-       assert(expected != NULL);
-
-       c = ec_tk_complete(tk, input);
-       s = ec_completed_tk_smallest_start(c);
-       if (!strcmp(s, expected))
-               ret = 0;
-
-       if (ret != 0)
-               ec_log(EC_LOG_ERR,
-                       "should complete with <%s> but completes with <%s>\n",
-                       expected, s);
+       if (ec_test_lookup(test->name) != NULL)
+               return -1;
 
-       ec_completed_tk_free(c);
+       TAILQ_INSERT_TAIL(&test_list, test, next);
 
-       return ret;
+       return 0;
 }
 
-int ec_test_check_tk_complete_list(const struct ec_tk *tk,
-       const char *input, ...)
+int ec_test_check_parse(struct ec_node *tk, int expected, ...)
 {
-       struct ec_completed_tk *c = NULL;
-       struct ec_completed_tk_elt *elt;
+       struct ec_parse *p;
+       struct ec_strvec *vec = NULL;
        const char *s;
-       int ret = -1;
-       unsigned int count = 0;
+       int ret = -1, match;
        va_list ap;
 
-       va_start(ap, input);
+       va_start(ap, expected);
 
-       c = ec_tk_complete(tk, input);
-       if (c == NULL)
+       /* build a string vector */
+       vec = ec_strvec();
+       if (vec == NULL)
                goto out;
 
        for (s = va_arg(ap, const char *);
-            s != EC_TK_ENDLIST;
+            s != EC_NODE_ENDLIST;
             s = va_arg(ap, const char *)) {
                if (s == NULL)
                        goto out;
 
-               count++;
-               TAILQ_FOREACH(elt, &c->elts, next) {
-                       if (strcmp(elt->add, s) == 0)
-                               break;
-               }
-
-               if (elt == NULL) {
-                       ec_log(EC_LOG_ERR,
-                               "completion <%s> not in list\n", s);
+               if (ec_strvec_add(vec, s) < 0)
                        goto out;
-               }
        }
 
-       if (count != ec_completed_tk_count(c)) {
-               ec_log(EC_LOG_ERR,
-                       "nb_completion (%d) does not match (%d)\n",
-                       count, ec_completed_tk_count(c));
-               ec_completed_tk_dump(stdout, c);
-               goto out;
+       p = ec_node_parse_strvec(tk, vec);
+       if (p == NULL) {
+               EC_LOG(EC_LOG_ERR, "parse is NULL\n");
        }
-
-       ret = 0;
-
-out:
-       ec_completed_tk_free(c);
-       va_end(ap);
-       return ret;
-}
-
-TAILQ_HEAD(debug_alloc_hdr_list, debug_alloc_hdr);
-static struct debug_alloc_hdr_list debug_alloc_hdr_list =
-       TAILQ_HEAD_INITIALIZER(debug_alloc_hdr_list);
-
-struct debug_alloc_hdr {
-       TAILQ_ENTRY(debug_alloc_hdr) next;
-       const char *file;
-       unsigned int line;
-       size_t size;
-       unsigned int cookie;
-};
-
-struct debug_alloc_ftr {
-       unsigned int cookie;
-} __attribute__((packed));
-
-static void *debug_malloc(size_t size, const char *file, unsigned int line)
-{
-       struct debug_alloc_hdr *hdr;
-       struct debug_alloc_ftr *ftr;
-       size_t new_size = size + sizeof(*hdr) + sizeof(*ftr);
-       void *ret;
-
-       hdr = malloc(new_size);
-       if (hdr == NULL) {
-               ret = NULL;
+       if (ec_parse_matches(p))
+               match = ec_parse_len(p);
+       else
+               match = -1;
+       if (expected == match) {
+               ret = 0;
        } else {
-               hdr->file = file;
-               hdr->line = line;
-               hdr->size = size;
-               hdr->cookie = 0x12345678;
-               TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
-               ret = hdr + 1;
-               ftr = (struct debug_alloc_ftr *)(
-                       (char *)hdr + size + sizeof(*hdr));
-               ftr->cookie = 0x12345678;
+               EC_LOG(EC_LOG_ERR,
+                       "parse len (%d) does not match expected (%d)\n",
+                       match, expected);
        }
 
-       ec_log(EC_LOG_INFO, "%s:%d: info: malloc(%zd) -> %p\n",
-               file, line, size, ret);
+       ec_parse_free(p);
 
+out:
+       ec_strvec_free(vec);
+       va_end(ap);
        return ret;
 }
 
-static void debug_free(void *ptr, const char *file, unsigned int line)
+int ec_test_check_complete(struct ec_node *tk, enum ec_comp_type type, ...)
 {
-       struct debug_alloc_hdr *hdr, *h;
-       struct debug_alloc_ftr *ftr;
-
-       (void)file;
-       (void)line;
-
-       ec_log(EC_LOG_INFO, "%s:%d: info: free(%p)\n", file, line, ptr);
+       struct ec_comp *c = NULL;
+       struct ec_strvec *vec = NULL;
+       const char *s;
+       int ret = 0;
+       unsigned int count = 0;
+       va_list ap;
 
-       if (ptr == NULL)
-               return;
+       va_start(ap, type);
 
-       hdr = (ptr - sizeof(*hdr));
-       if (hdr->cookie != 0x12345678) {
-               ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad start cookie\n",
-                       file, line, ptr);
-               abort();
-       }
+       /* build a string vector */
+       vec = ec_strvec();
+       if (vec == NULL)
+               goto out;
 
-       ftr = (ptr + hdr->size);
-       if (ftr->cookie != 0x12345678) {
-               ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad end cookie\n",
-                       file, line, ptr);
-               abort();
-       }
+       for (s = va_arg(ap, const char *);
+            s != EC_NODE_ENDLIST;
+            s = va_arg(ap, const char *)) {
+               if (s == NULL)
+                       goto out;
 
-       TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
-               if (h == hdr)
-                       break;
+               if (ec_strvec_add(vec, s) < 0)
+                       goto out;
        }
 
-       if (h == NULL) {
-               ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad ptr\n",
-                       file, line, ptr);
-               abort();
+       c = ec_node_complete_strvec(tk, vec);
+       if (c == NULL) {
+               ret = -1;
+               goto out;
        }
 
-       TAILQ_REMOVE(&debug_alloc_hdr_list, hdr, next);
-       free(hdr);
-}
+       /* for each expected completion, check it is there */
+       for (s = va_arg(ap, const char *);
+            s != EC_NODE_ENDLIST;
+            s = va_arg(ap, const char *)) {
+               struct ec_comp_iter *iter;
+               const struct ec_comp_item *item;
 
-void *debug_realloc(void *ptr, size_t size, const char *file, unsigned int line)
-{
-       struct debug_alloc_hdr *hdr, *h;
-       struct debug_alloc_ftr *ftr;
-       size_t new_size = size + sizeof(*hdr) + sizeof(unsigned int);
-       void *ret;
-
-       if (ptr != NULL) {
-               hdr =  (ptr - sizeof(*hdr));
-               if (hdr->cookie != 0x12345678) {
-                       ec_log(EC_LOG_ERR,
-                               "%s:%d: error: realloc(%p): bad start cookie\n",
-                               file, line, ptr);
-                       abort();
+               if (s == NULL) {
+                       ret = -1;
+                       goto out;
                }
 
-               ftr = (ptr + hdr->size);
-               if (ftr->cookie != 0x12345678) {
-                       ec_log(EC_LOG_ERR,
-                               "%s:%d: error: realloc(%p): bad end cookie\n",
-                               file, line, ptr);
-                       abort();
-               }
+               count++;
 
-               TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
-                       if (h == hdr)
+               /* only check matching completions */
+               iter = ec_comp_iter(c, type);
+               while ((item = ec_comp_iter_next(iter)) != NULL) {
+                       const char *str = ec_comp_item_get_str(item);
+                       if (str != NULL && strcmp(str, s) == 0)
                                break;
                }
 
-               if (h == NULL) {
-                       ec_log(EC_LOG_ERR, "%s:%d: error: realloc(%p): bad ptr\n",
-                               file, line, ptr);
-                       abort();
-               }
-
-               TAILQ_REMOVE(&debug_alloc_hdr_list, h, next);
-               hdr = realloc(hdr, new_size);
-               if (hdr == NULL) {
-                       TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, h, next);
-                       ret = NULL;
-               } else {
-                       ret = hdr + 1;
+               if (item == NULL) {
+                       EC_LOG(EC_LOG_ERR,
+                               "completion <%s> not in list\n", s);
+                       ret = -1;
                }
-       } else {
-               hdr = realloc(NULL, new_size);
-               if (hdr == NULL)
-                       ret = NULL;
-               else
-                       ret = hdr + 1;
+               ec_comp_iter_free(iter);
        }
 
-       if (hdr != NULL) {
-               hdr->file = file;
-               hdr->line = line;
-               hdr->size = size;
-               hdr->cookie = 0x12345678;
-               TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
-               ftr = (struct debug_alloc_ftr *)(
-                       (char *)hdr + size + sizeof(*hdr));
-               ftr->cookie = 0x12345678;
+       /* check if we have more completions (or less) than expected */
+       if (count != ec_comp_count(c, type)) {
+               EC_LOG(EC_LOG_ERR,
+                       "nb_completion (%d) does not match (%d)\n",
+                       count, ec_comp_count(c, type));
+               ec_comp_dump(stdout, c);
+               ret = -1;
        }
 
-       ec_log(EC_LOG_INFO, "%s:%d: info: realloc(%p, %zd) -> %p\n",
-               file, line, ptr, size, ret);
-
+out:
+       ec_strvec_free(vec);
+       ec_comp_free(c);
+       va_end(ap);
        return ret;
 }
 
-void debug_alloc_dump(void)
-{
-       struct debug_alloc_hdr *hdr;
-
-       TAILQ_FOREACH(hdr, &debug_alloc_hdr_list, next) {
-               ec_log(EC_LOG_ERR, "%s:%d: error: memory leak size=%zd ptr=%p\n",
-                       hdr->file, hdr->line, hdr->size, hdr + 1);
-       }
-}
-
-int ec_test_all(void)
+static int launch_test(const char *name)
 {
        struct ec_test *test;
        int ret = 0;
+       unsigned int count = 0;
 
-       TAILQ_INIT(&debug_alloc_hdr_list);
+       TAILQ_FOREACH(test, &test_list, next) {
+               if (name != NULL && strcmp(name, test->name))
+                       continue;
 
-       /* register a new malloc to trac memleaks */
-       if (ec_malloc_register(debug_malloc, debug_free, debug_realloc) < 0) {
-               ec_log(EC_LOG_ERR, "cannot register new malloc\n");
-               return -1;
-       }
+               EC_LOG(EC_LOG_INFO, "== starting test %-20s\n",
+                       test->name);
 
-       TAILQ_FOREACH(test, &test_list, next) {
+               count++;
                if (test->test() == 0) {
-                       ec_log(EC_LOG_INFO, "== test %-20s success\n",
+                       EC_LOG(EC_LOG_INFO,
+                               "== test %-20s success\n",
                                test->name);
                } else {
-                       ec_log(EC_LOG_INFO, "== test %-20s failed\n",
+                       EC_LOG(EC_LOG_INFO,
+                               "== test %-20s failed\n",
                                test->name);
                        ret = -1;
                }
        }
 
-       ec_malloc_unregister();
-       debug_alloc_dump();
+       if (name != NULL && count == 0) {
+               EC_LOG(EC_LOG_WARNING,
+                       "== test %s not found\n", name);
+               ret = -1;
+       }
 
        return ret;
 }
+
+int ec_test_all(void)
+{
+       return launch_test(NULL);
+}
+
+int ec_test_one(const char *name)
+{
+       return launch_test(name);
+}