t/unit/frontend/parser_test.c

   1 /*
   2  * SysDB - t/unit/frontend/parser_test.c
   3  * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include "frontend/connection.h"
  29 #include "frontend/parser.h"
  30 #include "core/store-private.h"
  31 #include "core/object.h"
  32 #include "libsysdb_test.h"
  33
  34 #include <check.h>
  35
  36 /*
  37  * tests
  38  */
  39
  40 START_TEST(test_parse)
  41 {
  42         struct {
  43                 const char *query;
  44                 int len;
  45                 int expected;
  46                 sdb_conn_state_t expected_cmd;
  47         } golden_data[] = {
  48                 /* empty commands */
  49                 { NULL,                  -1, -1, 0 },
  50                 { "",                    -1,  0, 0 },
  51                 { ";",                   -1,  0, 0 },
  52                 { ";;",                  -1,  0, 0 },
  53
  54                 /* valid commands */
  55                 { "FETCH 'host'",        -1,  1, CONNECTION_FETCH  },
  56                 { "LIST",                -1,  1, CONNECTION_LIST   },
  57                 { "LIST -- comment",     -1,  1, CONNECTION_LIST   },
  58                 { "LIST;",               -1,  1, CONNECTION_LIST   },
  59                 { "LIST; INVALID",        5,  1, CONNECTION_LIST   },
  60
  61                 { "LOOKUP hosts",        -1,  1, CONNECTION_LOOKUP },
  62                 { "LOOKUP hosts MATCHING "
  63                   "host = 'host'",       -1,  1, CONNECTION_LOOKUP },
  64                 { "LOOKUP hosts MATCHING NOT "
  65                   "host = 'host'",       -1,  1, CONNECTION_LOOKUP },
  66                 { "LOOKUP hosts MATCHING "
  67                   "host =~ 'p' AND "
  68                   "service =~ 'p'",      -1,  1, CONNECTION_LOOKUP },
  69                 { "LOOKUP hosts MATCHING NOT "
  70                   "host =~ 'p' AND "
  71                   "service =~ 'p'",      -1,  1, CONNECTION_LOOKUP },
  72                 { "LOOKUP hosts MATCHING "
  73                   "host =~ 'p' AND "
  74                   "service =~ 'p' OR "
  75                   "service =~ 'r'",      -1,  1, CONNECTION_LOOKUP },
  76                 { "LOOKUP hosts MATCHING NOT "
  77                   "host =~ 'p' AND "
  78                   "service =~ 'p' OR "
  79                   "service =~ 'r'",      -1,  1, CONNECTION_LOOKUP },
  80                 { "LOOKUP hosts MATCHING "
  81                   "host =~ 'p' "
  82                   "FILTER :age > 1D",    -1,  1, CONNECTION_LOOKUP },
  83                 { "LOOKUP hosts MATCHING "
  84                   "host =~ 'p' "
  85                   "FILTER :age > 1D AND "
  86                   ":interval < 240s" ,   -1,  1, CONNECTION_LOOKUP },
  87                 { "LOOKUP hosts MATCHING "
  88                   "host =~ 'p' "
  89                   "FILTER NOT :age>1D",  -1,  1, CONNECTION_LOOKUP },
  90                 { "LOOKUP hosts MATCHING "
  91                   "host =~ 'p' "
  92                   "FILTER :age>"
  93                   ":interval",           -1,  1, CONNECTION_LOOKUP },
  94
  95                 /* numeric constants */
  96                 { "LOOKUP hosts MATCHING "
  97                   "attribute.foo = "
  98                   "1234",                -1,  1, CONNECTION_LOOKUP },
  99                 { "LOOKUP hosts MATCHING "
 100                   "attribute.foo != "
 101                   "+234",                -1,  1, CONNECTION_LOOKUP },
 102                 { "LOOKUP hosts MATCHING "
 103                   "attribute.foo < "
 104                   "-234",                -1,  1, CONNECTION_LOOKUP },
 105                 { "LOOKUP hosts MATCHING "
 106                   "attribute.foo > "
 107                   "12.4",                -1,  1, CONNECTION_LOOKUP },
 108                 { "LOOKUP hosts MATCHING "
 109                   "attribute.foo <= "
 110                   "12. + .3",            -1,  1, CONNECTION_LOOKUP },
 111                 { "LOOKUP hosts MATCHING "
 112                   "attribute.foo >= "
 113                   ".4",                  -1,  1, CONNECTION_LOOKUP },
 114                 { "LOOKUP hosts MATCHING "
 115                   "attribute.foo = "
 116                   "+12e3",               -1,  1, CONNECTION_LOOKUP },
 117                 { "LOOKUP hosts MATCHING "
 118                   "attribute.foo = "
 119                   "+12e-3",              -1,  1, CONNECTION_LOOKUP },
 120                 { "LOOKUP hosts MATCHING "
 121                   "attribute.foo = "
 122                   "-12e+3",              -1,  1, CONNECTION_LOOKUP },
 123
 124                 /* date, time, interval constants */
 125                 { "LOOKUP hosts MATCHING "
 126                   "attribute.foo = "
 127                   "1 Y 42D",             -1,  1, CONNECTION_LOOKUP },
 128                 { "LOOKUP hosts MATCHING "
 129                   "attribute.foo = "
 130                   "1s 42D",              -1,  1, CONNECTION_LOOKUP },
 131                 /*
 132                  * TODO: Something like 1Y42D should work as well but it doesn't since
 133                  * the scanner will tokenize it into {digit}{identifier} :-/
 134                  *
 135                 { "LOOKUP hosts MATCHING "
 136                   "attribute.foo = "
 137                   "1Y42D",               -1,  1, CONNECTION_LOOKUP },
 138                  */
 139
 140                 /* NULL */
 141                 { "LOOKUP hosts MATCHING "
 142                   "attribute.foo "
 143                   "IS NULL",             -1,  1, CONNECTION_LOOKUP },
 144                 { "LOOKUP hosts MATCHING "
 145                   "attribute.foo "
 146                   "IS NOT NULL",         -1,  1, CONNECTION_LOOKUP },
 147                 { "LOOKUP hosts MATCHING "
 148                   "NOT attribute.foo "
 149                   "IS NULL",             -1,  1, CONNECTION_LOOKUP },
 150                 { "LOOKUP hosts MATCHING "
 151                   "host IS NULL",        -1, -1, 0 },
 152                 { "LOOKUP hosts MATCHING "
 153                   "service IS NULL",     -1, -1, 0 },
 154
 155                 /* invalid numeric constants */
 156                 { "LOOKUP hosts MATCHING "
 157                   "attribute.foo = "
 158                   "+-12e+3",             -1, -1, 0 },
 159                 { "LOOKUP hosts MATCHING "
 160                   "attribute.foo = "
 161                   "-12e-+3",             -1, -1, 0 },
 162                 { "LOOKUP hosts MATCHING "
 163                   "attribute.foo = "
 164                   "e+3",                 -1, -1, 0 },
 165                 { "LOOKUP hosts MATCHING "
 166                   "attribute.foo = "
 167                   "3e",                  -1, -1, 0 },
 168                 /* following SQL standard, we don't support hex numbers */
 169                 { "LOOKUP hosts MATCHING "
 170                   "attribute.foo = "
 171                   "0x12",                -1, -1, 0 },
 172
 173                 /* invalid expressions */
 174                 { "LOOKUP hosts MATCHING "
 175                   "attribute.foo = "
 176                   "1.23 + 'foo'",        -1, -1, 0 },
 177
 178                 /* comments */
 179                 { "/* some comment */",  -1,  0, 0 },
 180                 { "-- another comment",  -1,  0, 0 },
 181
 182                 /* syntax errors */
 183                 { "INVALID",             -1, -1, 0 },
 184                 { "FETCH host",          -1, -1, 0 },
 185                 { "LIST; INVALID",        8, -1, 0 },
 186                 { "/* some incomplete",  -1, -1, 0 },
 187
 188                 { "LOOKUP foo",          -1, -1, 0 },
 189                 { "LOOKUP foo MATCHING "
 190                   "host = 'host'",       -1, -1, 0 },
 191                 { "LOOKUP foo FILTER "
 192                   "host = 'host'",       -1, -1, 0 },
 193                 { "LOOKUP foo MATCHING "
 194                   "host = 'host' FILTER "
 195                   "host = 'host'",       -1, -1, 0 },
 196         };
 197
 198         size_t i;
 199         sdb_llist_t *check;
 200
 201         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 202                 sdb_object_t *obj;
 203                 _Bool ok;
 204
 205                 check = sdb_fe_parse(golden_data[i].query, golden_data[i].len);
 206                 if (golden_data[i].expected < 0)
 207                         ok = check == 0;
 208                 else
 209                         ok = sdb_llist_len(check) == (size_t)golden_data[i].expected;
 210
 211                 fail_unless(ok, "sdb_fe_parse(%s) = %p (len: %zu); expected: %d",
 212                                 golden_data[i].query, check, sdb_llist_len(check),
 213                                 golden_data[i].expected);
 214
 215                 if (! check)
 216                         continue;
 217
 218                 if ((! golden_data[i].expected_cmd)
 219                                 || (golden_data[i].expected <= 0)) {
 220                         sdb_llist_destroy(check);
 221                         continue;
 222                 }
 223
 224                 obj = sdb_llist_get(check, 0);
 225                 fail_unless(SDB_CONN_NODE(obj)->cmd == golden_data[i].expected_cmd,
 226                                 "sdb_fe_parse(%s)->cmd = %i; expected: %d",
 227                                 golden_data[i].query, SDB_CONN_NODE(obj)->cmd,
 228                                 golden_data[i].expected_cmd);
 229                 sdb_object_deref(obj);
 230                 sdb_llist_destroy(check);
 231         }
 232 }
 233 END_TEST
 234
 235 START_TEST(test_parse_matcher)
 236 {
 237         struct {
 238                 const char *expr;
 239                 int len;
 240                 int expected;
 241         } golden_data[] = {
 242                 /* empty expressions */
 243                 { NULL,                        -1, -1 },
 244                 { "",                          -1, -1 },
 245
 246                 /* valid expressions */
 247                 { "host = 'localhost'",        -1,  MATCHER_NAME },
 248                 { "host != 'localhost'",       -1,  MATCHER_NOT },
 249                 { "host =~ 'host'",            -1,  MATCHER_NAME },
 250                 { "host !~ 'host'",            -1,  MATCHER_NOT },
 251                 { "host = 'localhost' -- foo", -1,  MATCHER_NAME },
 252                 { "host = 'host' <garbage>",   13,  MATCHER_NAME },
 253                 /* match hosts by service */
 254                 { "service = 'name'",          -1,  MATCHER_NAME },
 255                 { "service != 'name'",         -1,  MATCHER_NOT },
 256                 { "service =~ 'pattern'",      -1,  MATCHER_NAME },
 257                 { "service !~ 'pattern'",      -1,  MATCHER_NOT },
 258                 /* match hosts by attribute */
 259                 { "attribute = 'name'",        -1,  MATCHER_NAME },
 260                 { "attribute != 'name'",       -1,  MATCHER_NOT },
 261                 { "attribute =~ 'pattern'",    -1,  MATCHER_NAME },
 262                 { "attribute !~ 'pattern'",    -1,  MATCHER_NOT },
 263                 /* composite expressions */
 264                 { "host =~ 'pattern' AND "
 265                   "service =~ 'pattern'",      -1,  MATCHER_AND },
 266                 { "host =~ 'pattern' OR "
 267                   "service =~ 'pattern'",      -1,  MATCHER_OR },
 268                 { "NOT host = 'host'",         -1,  MATCHER_NOT },
 269                 /* numeric expressions */
 270                 { "attribute.foo < 123",       -1,  MATCHER_LT },
 271                 { "attribute.foo <= 123",      -1,  MATCHER_LE },
 272                 { "attribute.foo = 123",       -1,  MATCHER_EQ },
 273                 { "attribute.foo >= 123",      -1,  MATCHER_GE },
 274                 { "attribute.foo > 123",       -1,  MATCHER_GT },
 275                 /* NULL; while this is an implementation detail,
 276                  * IS NULL currently maps to an equality matcher */
 277                 { "attribute.foo IS NULL",     -1,  MATCHER_ISNULL },
 278                 { "attribute.foo IS NOT NULL", -1,  MATCHER_NOT },
 279
 280                 /* object field matchers */
 281                 { ":last_update < 10s",        -1,  MATCHER_LT },
 282                 { ":AGE <= 1m",                -1,  MATCHER_LE },
 283                 { ":interval = 10h",           -1,  MATCHER_EQ },
 284                 { ":Last_Update >= 24D",       -1,  MATCHER_GE },
 285                 { ":age > 1M",                 -1,  MATCHER_GT },
 286                 { ":age != 20Y",               -1,  MATCHER_NOT },
 287                 { ":backend != 'be'",          -1,  MATCHER_NOT },
 288                 { ":age <= 2 * :interval",     -1,  MATCHER_LE },
 289
 290                 /* check operator precedence */
 291                 { "host = 'name' OR "
 292                   "service = 'name' AND "
 293                   "attribute = 'name' OR "
 294                   "attribute.foo = 'bar'",     -1,  MATCHER_OR },
 295                 { "host = 'name' AND "
 296                   "service = 'name' AND "
 297                   "attribute = 'name' OR "
 298                   "attribute.foo = 'bar'",     -1,  MATCHER_OR },
 299                 { "host = 'name' AND "
 300                   "service = 'name' OR "
 301                   "attribute = 'name' AND "
 302                   "attribute.foo = 'bar'",     -1,  MATCHER_OR },
 303                 { "(host = 'name' OR "
 304                   "service = 'name') AND "
 305                   "(attribute = 'name' OR "
 306                   "attribute.foo = 'bar')",    -1,  MATCHER_AND },
 307                 { "NOT host = 'name' OR "
 308                   "service = 'name'",          -1,  MATCHER_OR },
 309                 { "NOT host = 'name' OR "
 310                   "NOT service = 'name'",      -1,  MATCHER_OR },
 311                 { "NOT (host = 'name' OR "
 312                   "NOT service = 'name')",     -1,  MATCHER_NOT },
 313
 314                 /* syntax errors */
 315                 { "LIST",                      -1, -1 },
 316                 { "foo &^ bar",                -1, -1 },
 317         };
 318
 319         size_t i;
 320
 321         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 322                 sdb_store_matcher_t *m;
 323                 m = sdb_fe_parse_matcher(golden_data[i].expr, golden_data[i].len);
 324
 325                 if (golden_data[i].expected < 0) {
 326                         fail_unless(m == NULL,
 327                                         "sdb_fe_parse_matcher(%s) = %p; expected: NULL",
 328                                         golden_data[i].expr, m);
 329                         continue;
 330                 }
 331
 332                 fail_unless(m != NULL, "sdb_fe_parse_matcher(%s) = NULL; "
 333                                 "expected: <matcher>", golden_data[i].expr);
 334                 fail_unless(M(m)->type == golden_data[i].expected,
 335                                 "sdb_fe_parse_matcher(%s) returned matcher of type %d; "
 336                                 "expected: %d", golden_data[i].expr, M(m)->type,
 337                                 golden_data[i].expected);
 338
 339                 sdb_object_deref(SDB_OBJ(m));
 340         }
 341 }
 342 END_TEST
 343
 344 Suite *
 345 fe_parser_suite(void)
 346 {
 347         Suite *s = suite_create("frontend::parser");
 348         TCase *tc;
 349
 350         tc = tcase_create("core");
 351         tcase_add_test(tc, test_parse);
 352         tcase_add_test(tc, test_parse_matcher);
 353         suite_add_tcase(s, tc);
 354
 355         return s;
 356 } /* util_parser_suite */
 357
 358 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 359