test_xpub_verbose.cpp 15.4 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
/*
    Copyright (c) 2018 Contributors as noted in the AUTHORS file

    This file is part of libzmq, the ZeroMQ core engine in C++.

    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "testutil.hpp"

#include <unity.h>

void setUp ()
{
}
void tearDown ()
{
}

void test_xpub_verbose_one_sub ()
{
    int rc;
    char buffer[2];
    void *ctx = zmq_ctx_new ();
    TEST_ASSERT_NOT_NULL (ctx);

    void *pub = zmq_socket (ctx, ZMQ_XPUB);
    TEST_ASSERT_NOT_NULL (pub);
    rc = zmq_bind (pub, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    void *sub = zmq_socket (ctx, ZMQ_SUB);
    TEST_ASSERT_NOT_NULL (sub);
    rc = zmq_connect (sub, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Subscribe for A
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    // Subscribe socket for B instead
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "B", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'B');

    //  Subscribe again for A again
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  This time it is duplicated, so it will be filtered out
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    int verbose = 1;
    rc = zmq_setsockopt (pub, ZMQ_XPUB_VERBOSE, &verbose, sizeof (int));
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Subscribe socket for A again
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // This time with VERBOSE the duplicated sub will be received
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    // Sending A message and B Message
    rc = zmq_send_const (pub, "A", 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);

    rc = zmq_send_const (pub, "B", 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);

    rc = zmq_recv (sub, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'A');

    rc = zmq_recv (sub, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'B');

    //  Clean up.
    rc = zmq_close (pub);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_close (sub);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_ctx_term (ctx);
    TEST_ASSERT_EQUAL_INT (0, rc);
}

void test_xpub_verbose_two_subs ()
{
    int rc;
    char buffer[2];
    void *ctx = zmq_ctx_new ();
    TEST_ASSERT_NOT_NULL (ctx);

    void *pub = zmq_socket (ctx, ZMQ_XPUB);
    TEST_ASSERT_NOT_NULL (pub);
    rc = zmq_bind (pub, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    void *sub0 = zmq_socket (ctx, ZMQ_SUB);
    TEST_ASSERT_NOT_NULL (sub0);
    rc = zmq_connect (sub0, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    void *sub1 = zmq_socket (ctx, ZMQ_SUB);
    TEST_ASSERT_NOT_NULL (sub1);
    rc = zmq_connect (sub1, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Subscribe for A on the first socket
    rc = zmq_setsockopt (sub0, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    //  Subscribe for A on the second socket
    rc = zmq_setsockopt (sub1, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  This time it is duplicated, so it will be filtered out
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    // Subscribe socket for B instead
    rc = zmq_setsockopt (sub0, ZMQ_SUBSCRIBE, "B", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'B');

    int verbose = 1;
    rc = zmq_setsockopt (pub, ZMQ_XPUB_VERBOSE, &verbose, sizeof (int));
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Subscribe socket for A again
    rc = zmq_setsockopt (sub1, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // This time with VERBOSE the duplicated sub will be received
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    // Sending A message and B Message
    rc = zmq_send_const (pub, "A", 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);

    rc = zmq_send_const (pub, "B", 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);

    rc = zmq_recv (sub0, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'A');

    rc = zmq_recv (sub1, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'A');

    rc = zmq_recv (sub0, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'B');

    //  Clean up.
    rc = zmq_close (pub);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_close (sub0);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_close (sub1);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_ctx_term (ctx);
    TEST_ASSERT_EQUAL_INT (0, rc);
}

void test_xpub_verboser_one_sub ()
{
    int rc;
    char buffer[3];
    void *ctx = zmq_ctx_new ();
    TEST_ASSERT_NOT_NULL (ctx);

    //  Create a publisher
    void *pub = zmq_socket (ctx, ZMQ_XPUB);
    TEST_ASSERT_NOT_NULL (pub);
    rc = zmq_bind (pub, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Create a subscriber
    void *sub = zmq_socket (ctx, ZMQ_SUB);
    TEST_ASSERT_NOT_NULL (sub);
    rc = zmq_connect (sub, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Unsubscribe for A, does not exist yet
    rc = zmq_setsockopt (sub, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Does not exist, so it will be filtered out by XSUB
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Subscribe for A
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    //  Subscribe again for A again, XSUB will increase refcount
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  This time it is duplicated, so it will be filtered out by XPUB
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Unsubscribe for A, this time it exists in XPUB
    rc = zmq_setsockopt (sub, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  XSUB refcounts and will not actually send unsub to PUB until the number
    //  of unsubs match the earlier subs
    rc = zmq_setsockopt (sub, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive unsubscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 0);
    assert (buffer[1] == 'A');

    //  XSUB only sends the last and final unsub, so XPUB will only receive 1
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Unsubscribe for A, does not exist anymore
    rc = zmq_setsockopt (sub, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Does not exist, so it will be filtered out by XSUB
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    int verbose = 1;
    rc = zmq_setsockopt (pub, ZMQ_XPUB_VERBOSER, &verbose, sizeof (int));
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Subscribe socket for A again
    rc = zmq_setsockopt (sub, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber, did not exist anymore
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    // Sending A message to make sure everything still works
    rc = zmq_send_const (pub, "A", 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);

    rc = zmq_recv (sub, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'A');

    //  Unsubscribe for A, this time it exists
    rc = zmq_setsockopt (sub, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive unsubscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 0);
    assert (buffer[1] == 'A');

    //  Unsubscribe for A again, it does not exist anymore so XSUB will filter
    rc = zmq_setsockopt (sub, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  XSUB only sends unsub if it matched it in its trie, IOW: it will only
    //  send it if it existed in the first place even with XPUB_VERBBOSER
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Clean up.
    rc = zmq_close (pub);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_close (sub);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_ctx_term (ctx);
    TEST_ASSERT_EQUAL_INT (0, rc);
}

void test_xpub_verboser_two_subs ()
{
    int rc;
    char buffer[3];
    void *ctx = zmq_ctx_new ();
    TEST_ASSERT_NOT_NULL (ctx);

    void *pub = zmq_socket (ctx, ZMQ_XPUB);
    TEST_ASSERT_NOT_NULL (pub);
    rc = zmq_bind (pub, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    void *sub0 = zmq_socket (ctx, ZMQ_SUB);
    TEST_ASSERT_NOT_NULL (sub0);
    rc = zmq_connect (sub0, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    void *sub1 = zmq_socket (ctx, ZMQ_SUB);
    TEST_ASSERT_NOT_NULL (sub1);
    rc = zmq_connect (sub1, "inproc://soname");
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Subscribe for A
    rc = zmq_setsockopt (sub0, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    //  Subscribe again for A on the other socket
    rc = zmq_setsockopt (sub1, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  This time it is duplicated, so it will be filtered out by XPUB
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Unsubscribe for A, this time it exists in XPUB
    rc = zmq_setsockopt (sub0, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  sub1 is still subscribed, so no notification
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Unsubscribe the second socket to trigger the notification
    rc = zmq_setsockopt (sub1, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive unsubscriptions since all sockets are gone
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 0);
    assert (buffer[1] == 'A');

    //  Make really sure there is only one notification
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    int verbose = 1;
    rc = zmq_setsockopt (pub, ZMQ_XPUB_VERBOSER, &verbose, sizeof (int));
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Subscribe socket for A again
    rc = zmq_setsockopt (sub0, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Subscribe socket for A again
    rc = zmq_setsockopt (sub1, ZMQ_SUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive subscriptions from subscriber, did not exist anymore
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    //  VERBOSER is set, so subs from both sockets are received
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 1);
    assert (buffer[1] == 'A');

    // Sending A message to make sure everything still works
    rc = zmq_send_const (pub, "A", 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);

    rc = zmq_recv (sub0, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'A');

    rc = zmq_recv (sub1, buffer, 1, 0);
    TEST_ASSERT_EQUAL_INT (1, rc);
    assert (buffer[0] == 'A');

    //  Unsubscribe for A
    rc = zmq_setsockopt (sub1, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive unsubscriptions from first subscriber due to VERBOSER
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 0);
    assert (buffer[1] == 'A');

    //  Unsubscribe for A again from the other socket
    rc = zmq_setsockopt (sub0, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    // Receive unsubscriptions from first subscriber due to VERBOSER
    rc = zmq_recv (pub, buffer, 2, 0);
    TEST_ASSERT_EQUAL_INT (2, rc);
    assert (buffer[0] == 0);
    assert (buffer[1] == 'A');

    //  Unsubscribe again to make sure it gets filtered now
    rc = zmq_setsockopt (sub1, ZMQ_UNSUBSCRIBE, "A", 1);
    TEST_ASSERT_EQUAL_INT (0, rc);

    //  Unmatched, so XSUB filters even with VERBOSER
    rc = zmq_recv (pub, buffer, 1, ZMQ_DONTWAIT);
    TEST_ASSERT_EQUAL_INT (-1, rc);
    TEST_ASSERT_EQUAL_INT (EAGAIN, errno);

    //  Clean up.
    rc = zmq_close (pub);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_close (sub0);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_close (sub1);
    TEST_ASSERT_EQUAL_INT (0, rc);
    rc = zmq_ctx_term (ctx);
    TEST_ASSERT_EQUAL_INT (0, rc);
}

int main (void)
{
    setup_test_environment ();

    UNITY_BEGIN ();
    RUN_TEST (test_xpub_verbose_one_sub);
    RUN_TEST (test_xpub_verbose_two_subs);
    RUN_TEST (test_xpub_verboser_one_sub);
    RUN_TEST (test_xpub_verboser_two_subs);

    return 0;
}