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