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 'host'",   -1,  1, CONNECTION_FETCH  },
  56                 { "FETCH host 'host' FILTER "
  57                   "host = 'host'",       -1,  1, CONNECTION_FETCH  },
  58
  59                 { "LIST hosts",          -1,  1, CONNECTION_LIST   },
  60                 { "LIST hosts -- foo",   -1,  1, CONNECTION_LIST   },
  61                 { "LIST hosts;",         -1,  1, CONNECTION_LIST   },
  62                 { "LIST hosts; INVALID", 11,  1, CONNECTION_LIST   },
  63                 { "LIST hosts FILTER "
  64                   "host = 'host'",       -1,  1, CONNECTION_LIST   },
  65
  66                 { "LOOKUP hosts",        -1,  1, CONNECTION_LOOKUP },
  67                 { "LOOKUP hosts MATCHING "
  68                   "host = 'host'",       -1,  1, CONNECTION_LOOKUP },
  69                 { "LOOKUP hosts MATCHING NOT "
  70                   "host = 'host'",       -1,  1, CONNECTION_LOOKUP },
  71                 { "LOOKUP hosts MATCHING "
  72                   "host =~ 'p' AND "
  73                   "service =~ 'p'",      -1,  1, CONNECTION_LOOKUP },
  74                 { "LOOKUP hosts MATCHING NOT "
  75                   "host =~ 'p' AND "
  76                   "service =~ 'p'",      -1,  1, CONNECTION_LOOKUP },
  77                 { "LOOKUP hosts MATCHING "
  78                   "host =~ 'p' AND "
  79                   "service =~ 'p' OR "
  80                   "service =~ 'r'",      -1,  1, CONNECTION_LOOKUP },
  81                 { "LOOKUP hosts MATCHING NOT "
  82                   "host =~ 'p' AND "
  83                   "service =~ 'p' OR "
  84                   "service =~ 'r'",      -1,  1, CONNECTION_LOOKUP },
  85                 { "LOOKUP hosts MATCHING "
  86                   "host =~ 'p' "
  87                   "FILTER :age > 1D",    -1,  1, CONNECTION_LOOKUP },
  88                 { "LOOKUP hosts MATCHING "
  89                   "host =~ 'p' "
  90                   "FILTER :age > 1D AND "
  91                   ":interval < 240s" ,   -1,  1, CONNECTION_LOOKUP },
  92                 { "LOOKUP hosts MATCHING "
  93                   "host =~ 'p' "
  94                   "FILTER NOT :age>1D",  -1,  1, CONNECTION_LOOKUP },
  95                 { "LOOKUP hosts MATCHING "
  96                   "host =~ 'p' "
  97                   "FILTER :age>"
  98                   ":interval",           -1,  1, CONNECTION_LOOKUP },
  99
 100                 { "TIMESERIES 'host'.'metric' "
 101                   "START 2014-01-01 "
 102                   "END 2014-12-31 "
 103                   "23:59:59",            -1,  1, CONNECTION_TIMESERIES },
 104                 { "TIMESERIES 'host'.'metric' "
 105                   "START 2014-02-02 "
 106                   "14:02",               -1,  1, CONNECTION_TIMESERIES },
 107                 { "TIMESERIES 'host'.'metric' "
 108                   "END 2014-02-02",      -1,  1, CONNECTION_TIMESERIES },
 109                 { "TIMESERIES "
 110                   "'host'.'metric'",     -1,  1, CONNECTION_TIMESERIES },
 111
 112                 /* numeric constants */
 113                 { "LOOKUP hosts MATCHING "
 114                   "attribute.foo = "
 115                   "1234",                -1,  1, CONNECTION_LOOKUP },
 116                 { "LOOKUP hosts MATCHING "
 117                   "attribute.foo != "
 118                   "+234",                -1,  1, CONNECTION_LOOKUP },
 119                 { "LOOKUP hosts MATCHING "
 120                   "attribute.foo < "
 121                   "-234",                -1,  1, CONNECTION_LOOKUP },
 122                 { "LOOKUP hosts MATCHING "
 123                   "attribute.foo > "
 124                   "12.4",                -1,  1, CONNECTION_LOOKUP },
 125                 { "LOOKUP hosts MATCHING "
 126                   "attribute.foo <= "
 127                   "12. + .3",            -1,  1, CONNECTION_LOOKUP },
 128                 { "LOOKUP hosts MATCHING "
 129                   "attribute.foo >= "
 130                   ".4",                  -1,  1, CONNECTION_LOOKUP },
 131                 { "LOOKUP hosts MATCHING "
 132                   "attribute.foo = "
 133                   "+12e3",               -1,  1, CONNECTION_LOOKUP },
 134                 { "LOOKUP hosts MATCHING "
 135                   "attribute.foo = "
 136                   "+12e-3",              -1,  1, CONNECTION_LOOKUP },
 137                 { "LOOKUP hosts MATCHING "
 138                   "attribute.foo = "
 139                   "-12e+3",              -1,  1, CONNECTION_LOOKUP },
 140
 141                 /* date, time, interval constants */
 142                 { "LOOKUP hosts MATCHING "
 143                   "attribute.foo = "
 144                   "1 Y 42D",             -1,  1, CONNECTION_LOOKUP },
 145                 { "LOOKUP hosts MATCHING "
 146                   "attribute.foo = "
 147                   "1s 42D",              -1,  1, CONNECTION_LOOKUP },
 148                 /*
 149                  * TODO: Something like 1Y42D should work as well but it doesn't since
 150                  * the scanner will tokenize it into {digit}{identifier} :-/
 151                  *
 152                 { "LOOKUP hosts MATCHING "
 153                   "attribute.foo = "
 154                   "1Y42D",               -1,  1, CONNECTION_LOOKUP },
 155                  */
 156
 157                 /* NULL */
 158                 { "LOOKUP hosts MATCHING "
 159                   "attribute.foo "
 160                   "IS NULL",             -1,  1, CONNECTION_LOOKUP },
 161                 { "LOOKUP hosts MATCHING "
 162                   "attribute.foo "
 163                   "IS NOT NULL",         -1,  1, CONNECTION_LOOKUP },
 164                 { "LOOKUP hosts MATCHING "
 165                   "NOT attribute.foo "
 166                   "IS NULL",             -1,  1, CONNECTION_LOOKUP },
 167                 { "LOOKUP hosts MATCHING "
 168                   "host IS NULL",        -1, -1, 0 },
 169                 { "LOOKUP hosts MATCHING "
 170                   "service IS NULL",     -1, -1, 0 },
 171
 172                 /* invalid numeric constants */
 173                 { "LOOKUP hosts MATCHING "
 174                   "attribute.foo = "
 175                   "+-12e+3",             -1, -1, 0 },
 176                 { "LOOKUP hosts MATCHING "
 177                   "attribute.foo = "
 178                   "-12e-+3",             -1, -1, 0 },
 179                 { "LOOKUP hosts MATCHING "
 180                   "attribute.foo = "
 181                   "e+3",                 -1, -1, 0 },
 182                 { "LOOKUP hosts MATCHING "
 183                   "attribute.foo = "
 184                   "3e",                  -1, -1, 0 },
 185                 /* following SQL standard, we don't support hex numbers */
 186                 { "LOOKUP hosts MATCHING "
 187                   "attribute.foo = "
 188                   "0x12",                -1, -1, 0 },
 189
 190                 /* invalid expressions */
 191                 { "LOOKUP hosts MATCHING "
 192                   "attribute.foo = "
 193                   "1.23 + 'foo'",        -1, -1, 0 },
 194
 195                 /* comments */
 196                 { "/* some comment */",  -1,  0, 0 },
 197                 { "-- another comment",  -1,  0, 0 },
 198
 199                 /* syntax errors */
 200                 { "INVALID",             -1, -1, 0 },
 201                 { "FETCH host",          -1, -1, 0 },
 202                 { "FETCH 'host'",        -1, -1, 0 },
 203                 { "LIST hosts; INVALID", -1, -1, 0 },
 204                 { "/* some incomplete",  -1, -1, 0 },
 205
 206                 { "LIST",                -1, -1, 0 },
 207                 { "LIST foo",            -1, -1, 0 },
 208                 { "LIST hosts MATCHING "
 209                   "host = 'host'",       -1, -1, 0 },
 210                 { "LIST foo FILTER "
 211                   "host = 'host'",       -1, -1, 0 },
 212                 { "FETCH host 'host' MATCHING "
 213                   "host = 'host'",       -1, -1, 0 },
 214                 { "FETCH foo 'host'",    -1, -1, 0 },
 215                 { "FETCH foo 'host' FILTER "
 216                   "host = 'host'",       -1, -1, 0 },
 217
 218                 { "LOOKUP foo",          -1, -1, 0 },
 219                 { "LOOKUP foo MATCHING "
 220                   "host = 'host'",       -1, -1, 0 },
 221                 { "LOOKUP foo FILTER "
 222                   "host = 'host'",       -1, -1, 0 },
 223                 { "LOOKUP foo MATCHING "
 224                   "host = 'host' FILTER "
 225                   "host = 'host'",       -1, -1, 0 },
 226         };
 227
 228         size_t i;
 229         sdb_llist_t *check;
 230
 231         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 232                 sdb_object_t *obj;
 233                 _Bool ok;
 234
 235                 check = sdb_fe_parse(golden_data[i].query, golden_data[i].len);
 236                 if (golden_data[i].expected < 0)
 237                         ok = check == 0;
 238                 else
 239                         ok = sdb_llist_len(check) == (size_t)golden_data[i].expected;
 240
 241                 fail_unless(ok, "sdb_fe_parse(%s) = %p (len: %zu); expected: %d",
 242                                 golden_data[i].query, check, sdb_llist_len(check),
 243                                 golden_data[i].expected);
 244
 245                 if (! check)
 246                         continue;
 247
 248                 if ((! golden_data[i].expected_cmd)
 249                                 || (golden_data[i].expected <= 0)) {
 250                         sdb_llist_destroy(check);
 251                         continue;
 252                 }
 253
 254                 obj = sdb_llist_get(check, 0);
 255                 fail_unless(SDB_CONN_NODE(obj)->cmd == golden_data[i].expected_cmd,
 256                                 "sdb_fe_parse(%s)->cmd = %i; expected: %d",
 257                                 golden_data[i].query, SDB_CONN_NODE(obj)->cmd,
 258                                 golden_data[i].expected_cmd);
 259                 sdb_object_deref(obj);
 260                 sdb_llist_destroy(check);
 261         }
 262 }
 263 END_TEST
 264
 265 START_TEST(test_parse_matcher)
 266 {
 267         struct {
 268                 const char *expr;
 269                 int len;
 270                 int expected;
 271         } golden_data[] = {
 272                 /* empty expressions */
 273                 { NULL,                        -1, -1 },
 274                 { "",                          -1, -1 },
 275
 276                 /* valid expressions */
 277                 { "host = 'localhost'",        -1,  MATCHER_NAME },
 278                 { "host != 'localhost'",       -1,  MATCHER_NOT },
 279                 { "host =~ 'host'",            -1,  MATCHER_NAME },
 280                 { "host !~ 'host'",            -1,  MATCHER_NOT },
 281                 { "host = 'localhost' -- foo", -1,  MATCHER_NAME },
 282                 { "host = 'host' <garbage>",   13,  MATCHER_NAME },
 283                 /* match hosts by service */
 284                 { "service = 'name'",          -1,  MATCHER_NAME },
 285                 { "service != 'name'",         -1,  MATCHER_NOT },
 286                 { "service =~ 'pattern'",      -1,  MATCHER_NAME },
 287                 { "service !~ 'pattern'",      -1,  MATCHER_NOT },
 288                 /* match hosts by attribute */
 289                 { "attribute = 'name'",        -1,  MATCHER_NAME },
 290                 { "attribute != 'name'",       -1,  MATCHER_NOT },
 291                 { "attribute =~ 'pattern'",    -1,  MATCHER_NAME },
 292                 { "attribute !~ 'pattern'",    -1,  MATCHER_NOT },
 293                 /* composite expressions */
 294                 { "host =~ 'pattern' AND "
 295                   "service =~ 'pattern'",      -1,  MATCHER_AND },
 296                 { "host =~ 'pattern' OR "
 297                   "service =~ 'pattern'",      -1,  MATCHER_OR },
 298                 { "NOT host = 'host'",         -1,  MATCHER_NOT },
 299                 /* numeric expressions */
 300                 { "attribute.foo < 123",       -1,  MATCHER_LT },
 301                 { "attribute.foo <= 123",      -1,  MATCHER_LE },
 302                 { "attribute.foo = 123",       -1,  MATCHER_EQ },
 303                 { "attribute.foo >= 123",      -1,  MATCHER_GE },
 304                 { "attribute.foo > 123",       -1,  MATCHER_GT },
 305                 /* datetime expressions */
 306                 { "attribute.foo = "
 307                   "2014-08-16",                -1,  MATCHER_EQ },
 308                 { "attribute.foo = "
 309                   "17:23",                     -1,  MATCHER_EQ },
 310                 { "attribute.foo = "
 311                   "17:23:53",                  -1,  MATCHER_EQ },
 312                 { "attribute.foo = "
 313                   "17:23:53.123",              -1,  MATCHER_EQ },
 314                 { "attribute.foo = "
 315                   "17:23:53.123456789",        -1,  MATCHER_EQ },
 316                 { "attribute.foo = "
 317                   "2014-08-16 17:23",          -1,  MATCHER_EQ },
 318                 { "attribute.foo = "
 319                   "2014-08-16 17:23:53",       -1,  MATCHER_EQ },
 320                 /* NULL; while this is an implementation detail,
 321                  * IS NULL currently maps to an equality matcher */
 322                 { "attribute.foo IS NULL",     -1,  MATCHER_ISNULL },
 323                 { "attribute.foo IS NOT NULL", -1,  MATCHER_NOT },
 324
 325                 /* object field matchers */
 326                 { ":last_update < 10s",        -1,  MATCHER_LT },
 327                 { ":AGE <= 1m",                -1,  MATCHER_LE },
 328                 { ":interval = 10h",           -1,  MATCHER_EQ },
 329                 { ":Last_Update >= 24D",       -1,  MATCHER_GE },
 330                 { ":age > 1M",                 -1,  MATCHER_GT },
 331                 { ":age != 20Y",               -1,  MATCHER_NOT },
 332                 { ":backend != 'be'",          -1,  MATCHER_NOT },
 333                 { ":age <= 2 * :interval",     -1,  MATCHER_LE },
 334
 335                 /* check operator precedence */
 336                 { "host = 'name' OR "
 337                   "service = 'name' AND "
 338                   "attribute = 'name' OR "
 339                   "attribute.foo = 'bar'",     -1,  MATCHER_OR },
 340                 { "host = 'name' AND "
 341                   "service = 'name' AND "
 342                   "attribute = 'name' OR "
 343                   "attribute.foo = 'bar'",     -1,  MATCHER_OR },
 344                 { "host = 'name' AND "
 345                   "service = 'name' OR "
 346                   "attribute = 'name' AND "
 347                   "attribute.foo = 'bar'",     -1,  MATCHER_OR },
 348                 { "(host = 'name' OR "
 349                   "service = 'name') AND "
 350                   "(attribute = 'name' OR "
 351                   "attribute.foo = 'bar')",    -1,  MATCHER_AND },
 352                 { "NOT host = 'name' OR "
 353                   "service = 'name'",          -1,  MATCHER_OR },
 354                 { "NOT host = 'name' OR "
 355                   "NOT service = 'name'",      -1,  MATCHER_OR },
 356                 { "NOT (host = 'name' OR "
 357                   "NOT service = 'name')",     -1,  MATCHER_NOT },
 358
 359                 /* syntax errors */
 360                 { "LIST",                      -1, -1 },
 361                 { "foo &^ bar",                -1, -1 },
 362         };
 363
 364         size_t i;
 365
 366         for (i = 0; i < SDB_STATIC_ARRAY_LEN(golden_data); ++i) {
 367                 sdb_store_matcher_t *m;
 368                 m = sdb_fe_parse_matcher(golden_data[i].expr, golden_data[i].len);
 369
 370                 if (golden_data[i].expected < 0) {
 371                         fail_unless(m == NULL,
 372                                         "sdb_fe_parse_matcher(%s) = %p; expected: NULL",
 373                                         golden_data[i].expr, m);
 374                         continue;
 375                 }
 376
 377                 fail_unless(m != NULL, "sdb_fe_parse_matcher(%s) = NULL; "
 378                                 "expected: <matcher>", golden_data[i].expr);
 379                 fail_unless(M(m)->type == golden_data[i].expected,
 380                                 "sdb_fe_parse_matcher(%s) returned matcher of type %d; "
 381                                 "expected: %d", golden_data[i].expr, M(m)->type,
 382                                 golden_data[i].expected);
 383
 384                 sdb_object_deref(SDB_OBJ(m));
 385         }
 386 }
 387 END_TEST
 388
 389 Suite *
 390 fe_parser_suite(void)
 391 {
 392         Suite *s = suite_create("frontend::parser");
 393         TCase *tc;
 394
 395         tc = tcase_create("core");
 396         tcase_add_test(tc, test_parse);
 397         tcase_add_test(tc, test_parse_matcher);
 398         suite_add_tcase(s, tc);
 399
 400         return s;
 401 } /* util_parser_suite */
 402
 403 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 404