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
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
// Copyright (C) 2016-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Kea Hooks Basic
// Commercial End User License Agreement v2.0. See COPYING file in the premium/
// directory.

/// @file This file contains tests which verify DHCPv4 legal file entry
/// generation as well as tests which exercise v4 callouts: leases4_committed
/// and pkt4_send.  These tests assume the legal log library
/// is linked in, not loaded.  This allows a great deal more flexibility
/// in testing, such as overriding and accessing the BackendStore::instance().
/// The load and unload callouts are exercised in ../libloadtests, which
/// actually uses the HooksManager to load and unload the library.

#include <config.h>

#include <asiolink/asio_wrapper.h>
#include <asiolink/io_address.h>
#include <cc/data.h>
#include <exceptions/exceptions.h>
#include <dhcp/pkt4.h>
#include <dhcpsrv/callout_handle_store.h>
#include <dhcpsrv/cfg_subnets4.h>
#include <dhcpsrv/lease.h>
#include <dhcpsrv/subnet.h>
#include <hooks/callout_manager.h>
#include <hooks/hooks.h>
#include <dhcp/option.h>
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
#include <dhcp/option_int_array.h>
#include <dhcp/option_space.h>
#include <test_utils.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

#include <gtest/gtest.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

using namespace std;
using namespace isc;
using namespace isc::asiolink;
using namespace isc::data;
using namespace isc::dhcp;
using namespace hooks;
using namespace legal_log;

extern std::string genLease4Entry(const Pkt4Ptr& query,
                                  const Pkt4Ptr& response,
                                  const Lease4Ptr& lease,
                                  const Action& action);

extern int legalLog4Handler(CalloutHandle& handle, const Action& action);

extern "C" {
extern int pkt4_receive(CalloutHandle& handle);
extern int leases4_committed(CalloutHandle& handle);
extern int pkt4_send(CalloutHandle& handle);
extern int lease4_release(CalloutHandle& handle);
extern int lease4_decline(CalloutHandle& handle);
}

namespace {

/// @brief Test fixture
struct CalloutTestv4 : CalloutTest {
    /// @brief Constructor. Called at the beginning of the test suite.
    CalloutTestv4() {
        // Get rid of new lines, they are not supported by the expression
        // evaluator.
        boost::replace_all(request_format_, "\n", std::string());
        boost::replace_all(response_format_, "\n", std::string());
        boost::replace_all(request_format_only_, "\n", std::string());
    }

    /// @brief Called before each test.
    virtual void SetUp() final override {
        RotatingFileTest::SetUp();
        // Various entities used in tests.
        client_id_ = boost::make_shared<ClientId>(CLIENTID);
        hwaddr_ = boost::make_shared<HWAddr>(HWADDR, HTYPE_ETHER);
        lease_ = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr());
        discover_ = discover();
        request_ = request();
        response_ = response();
        release_ = release();
        decline_ = decline();
    }

    /// @brief Used to construct a DHCPDISCOVER.
    Pkt4Ptr discover() {
        OptionPtr const requested_address(OptionPtr(boost::make_shared<Option>(
            Option::V4, DHO_DHCP_REQUESTED_ADDRESS, OptionBuffer())));
        requested_address->setUint32(lease_->addr_.toUint32());

        OptionPtr lease_time(
            boost::make_shared<OptionUint32>(Option::V4, DHO_DHCP_LEASE_TIME,
                                             lease_->valid_lft_));

        Pkt4Ptr discover(boost::make_shared<Pkt4>(DHCPDISCOVER, 0x77));
        discover->setHWAddr(hwaddr_);
        discover->addOption(requested_address);
        discover->addOption(lease_time);

        return (discover);
    }

    /// @brief Used to construct a DHCPREQUEST.
    Pkt4Ptr request() {
        OptionPtr const requested_address(OptionPtr(boost::make_shared<Option>(
            Option::V4, DHO_DHCP_REQUESTED_ADDRESS, OptionBuffer())));
        requested_address->setUint32(lease_->addr_.toUint32());

        OptionPtr lease_time(
            boost::make_shared<OptionUint32>(Option::V4, DHO_DHCP_LEASE_TIME,
                                             lease_->valid_lft_));

        Pkt4Ptr request(boost::make_shared<Pkt4>(DHCPREQUEST, 0x77));
        request->setHWAddr(hwaddr_);
        request->addOption(requested_address);
        request->addOption(lease_time);

        return (request);
    }

    /// @brief Used to construct a DHCPACK.
    Pkt4Ptr response() {
        OptionPtr lease_time(
            boost::make_shared<OptionUint32>(Option::V4, DHO_DHCP_LEASE_TIME,
                                             lease_->valid_lft_));

        Pkt4Ptr response(boost::make_shared<Pkt4>(DHCPACK, 0x77));
        response->setHWAddr(hwaddr_);
        response->setYiaddr(lease_->addr_);
        response->addOption(lease_time);

        return (response);
    }

    /// @brief Used to construct a DHCPRELEASE.
    Pkt4Ptr release() {
        Pkt4Ptr release(boost::make_shared<Pkt4>(DHCPRELEASE, 0x77));
        release->setHWAddr(hwaddr_);
        release->setCiaddr(lease_->addr_);

        return (release);
    }

    /// @brief Used to construct a DHCPDECLINE.
    Pkt4Ptr decline() {
        OptionPtr const requested_address(OptionPtr(boost::make_shared<Option>(
            Option::V4, DHO_DHCP_REQUESTED_ADDRESS, OptionBuffer())));
        requested_address->setUint32(lease_->addr_.toUint32());

        Pkt4Ptr decline(boost::make_shared<Pkt4>(DHCPDECLINE, 0x77));
        decline->setHWAddr(hwaddr_);
        decline->addOption(requested_address);

        return (decline);
    }

    /// @brief Convenience function which creates a Lease4 instance
    ///
    /// Factory for creating leases which defaults values that are not of
    /// interest during legal entry formation.
    ///
    /// @param addr_str IPv4 lease address as a string
    /// @param valid_lifetime Lifetime of the lease in seconds
    /// @param hwaddr Pointer to the lease hardware address
    /// @param client_id Pointer to the lease client id (may be null)
    /// @param subnet_id subnet identifier.
    ///
    /// @return Pointer to the newly created Lease4 instance
    Lease4Ptr createLease4(const std::string& addr_str,
                           uint32_t valid_lifetime,
                           const HWAddrPtr& hwaddr,
                           const ClientIdPtr& client_id,
                           const uint32_t subnet_id = 0) {
        Lease4Ptr lease(new Lease4(isc::asiolink::IOAddress(addr_str), hwaddr,
                                   client_id, valid_lifetime, 0, subnet_id,
                                   false, false, std::string()));

        return (lease);
    }

    /// @brief Various entities used in tests
    /// @{

    /// @brief The client id used by requests and replies
    ClientIdPtr client_id_;

    /// @brief The client HWAddr used by requests and replies
    HWAddrPtr hwaddr_;

    /// @brief The lease used by requests and replies
    Lease4Ptr lease_;

    /// @brief The discover packet
    Pkt4Ptr discover_;

    /// @brief The request packet
    Pkt4Ptr request_;

    /// @brief The server response packet
    Pkt4Ptr response_;

    /// @brief The release packet
    Pkt4Ptr release_;

    /// @brief The decline packet
    Pkt4Ptr decline_;
    /// @}

    /// @brief the string to be passed in "request-parser-format"
    std::string request_format_ = R"delimiter(
        ifelse(pkt4.msgtype == 4 or pkt4.msgtype == 7,
            'Address: ' +
            ifelse(option[50].exists,
                addrtotext(option[50].hex),
                addrtotext(pkt4.ciaddr)) +
            ' has been released from a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
            ifelse(option[61].exists,
                ', client-id: ' + hexstring(option[61].hex, ':'),
                '') +
            ifelse(pkt4.giaddr == 0.0.0.0,
                '',
                ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
                ifelse(option[82].option[1].exists,
                    ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'),
                    '') +
                ifelse(option[82].option[2].exists,
                    ', remote-id: ' + hexstring(option[82].option[2].hex, ':'),
                    '') +
                ifelse(option[82].option[6].exists,
                    ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
                    '')),
            '')
        )delimiter";

    /// @brief the string to be passed in "response-parser-format"
    std::string response_format_ = R"delimiter(
        ifelse(pkt4.msgtype == 5,
            'Address: ' + addrtotext(pkt4.yiaddr) + ' has been assigned for ' + uint32totext(option[51].hex) + ' seconds to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
            ifelse(option[61].exists,
                ', client-id: ' + hexstring(option[61].hex, ':'),
                '') +
            ifelse(pkt4.giaddr == 0.0.0.0,
                '',
                ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
                ifelse(option[82].option[1].exists,
                    ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'),
                    '') +
                ifelse(option[82].option[2].exists,
                    ', remote-id: ' + hexstring(option[82].option[2].hex, ':'),
                    '') +
                ifelse(option[82].option[6].exists,
                    ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
                    '')),
            '')
        )delimiter";

    /// @brief the string to be passed in "request-parser-format" with the
    /// equivalent effects of a "response-parser-format" 2-in-1.
    std::string request_format_only_ = R"delimiter(
        ifelse(pkt4.msgtype == 3,
            'Address: ' +
            ifelse(option[50].exists,
                addrtotext(option[50].hex),
                addrtotext(pkt4.ciaddr)) +
            ' has been assigned' +
            ifelse(option[51].exists,
                ' for ' + uint32totext(option[51].hex) + ' seconds',
                '') +
            ' to a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
            ifelse(option[61].exists,
                ', client-id: ' + hexstring(option[61].hex, ':'),
                '') +
            ifelse(pkt4.giaddr == 0.0.0.0,
                '',
                ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
                ifelse(option[82].option[1].exists,
                    ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'),
                    '') +
                ifelse(option[82].option[2].exists,
                    ', remote-id: ' + hexstring(option[82].option[2].hex, ':'),
                    '') +
                ifelse(option[82].option[6].exists,
                    ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
                    '')),
            ifelse(pkt4.msgtype == 4 or pkt4.msgtype == 7,
                'Address: ' +
                ifelse(option[50].exists,
                    addrtotext(option[50].hex),
                    addrtotext(pkt4.ciaddr)) +
                ' has been released from a device with hardware address: hwtype=' + substring(hexstring(pkt4.htype, ''), 7, 1) + ' ' + hexstring(pkt4.mac, ':') +
                ifelse(option[61].exists,
                    ', client-id: ' + hexstring(option[61].hex, ':'),
                    '') +
                ifelse(pkt4.giaddr == 0.0.0.0,
                    '',
                    ' connected via relay at address: ' + addrtotext(pkt4.giaddr) +
                    ifelse(option[82].option[1].exists,
                        ', circuit-id: ' + hexstring(option[82].option[1].hex, ':'),
                        '') +
                    ifelse(option[82].option[2].exists,
                        ', remote-id: ' + hexstring(option[82].option[2].hex, ':'),
                        '') +
                    ifelse(option[82].option[6].exists,
                        ', subscriber-id: ' + hexstring(option[82].option[6].hex, ':'),
                        '')),
                ''))
        )delimiter";

    /// @brief Client id used by different tests.
    std::vector<uint8_t> const CLIENTID = {0x17, 0x34, 0xe2, 0xff, 0x09, 0x92, 0x54};

    /// @brief Hardware address used by different tests.
    std::vector<uint8_t> const HWADDR = {0x08, 0x00, 0x2b, 0x02, 0x3f, 0x4e};
};

// Verifies legal entry content for directly connected clients
TEST_F(CalloutTestv4, directClient4) {<--- syntax error
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    std::string entry;

    // Verify address and duration for an assignment (no client id)
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address and duration for a renewal (no client id)
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a release (no client id). No server response.
    ASSERT_NO_THROW(entry = genLease4Entry(release_, Pkt4Ptr(), lease_, Action::RELEASE));
    EXPECT_EQ("Address: 192.2.1.100 has been released"
              " from a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a decline (no client id). No server response.
    ASSERT_NO_THROW(entry = genLease4Entry(decline_, Pkt4Ptr(), lease_, Action::RELEASE));
    EXPECT_EQ("Address: 192.2.1.100 has been released"
              " from a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify with a client id
    lease_->client_id_ = client_id_;

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54",
              entry);

    // Verify a relayed request (no RAI)
    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Get the option definition for RAI option. This option is represented
    // by OptionCustom which requires a definition to be passed to
    // the constructor.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    uint8_t circuit_id[] = { 0x68, 0x6F, 0x77, 0x64, 0x79 };
    // Create RAI option.
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));

    OptionPtr circuit_id_opt(new Option(Option::V4, RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                        circuit_id + sizeof(circuit_id))));
    rai->addOption(circuit_id_opt);

    request_->addOption(rai);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 68:6f:77:64:79 (howdy)",
              entry);

    uint8_t subscriber_id[] = { 0x1a, 0x2b, 0x3c, 0x4d, 0x5e, 0x6f };
    OptionPtr subscriber_id_opt(new Option(Option::V4, RAI_OPTION_SUBSCRIBER_ID,
                                           OptionBuffer(subscriber_id,
                                           subscriber_id
                                           + sizeof(subscriber_id))));
    rai->addOption(subscriber_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 68:6f:77:64:79 (howdy)"
              " and subscriber-id: 1a:2b:3c:4d:5e:6f",
              entry);

    uint8_t remote_id[] = { 0x87, 0xF6, 0x79, 0x77, 0xEF };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                       remote_id + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 68:6f:77:64:79 (howdy)"
              " and remote-id: 87:f6:79:77:ef"
              " and subscriber-id: 1a:2b:3c:4d:5e:6f",
              entry);

    lease_->setContext(Element::fromJSON("{ \"foo\": true }"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 68:6f:77:64:79 (howdy)"
              " and remote-id: 87:f6:79:77:ef"
              " and subscriber-id: 1a:2b:3c:4d:5e:6f, "
              "context: { \"foo\": true }",
              entry);
}

// Verifies legal entry content for directly connected clients
TEST_F(CalloutTestv4, directClient4CustomLoggingFormatRequestOnly) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    BackendStore::instance()->setRequestFormatExpression(request_format_only_);

    std::string entry;

    // Verify address and duration for an assignment (no client id)
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address and duration for a renewal (no client id)
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a release (no client id). No server response.
    ASSERT_NO_THROW(entry = genLease4Entry(release_, Pkt4Ptr(), lease_, Action::RELEASE));
    EXPECT_EQ("Address: 192.2.1.100 has been released"
              " from a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a decline (no client id). No server response.
    ASSERT_NO_THROW(entry = genLease4Entry(decline_, Pkt4Ptr(), lease_, Action::RELEASE));
    EXPECT_EQ("Address: 192.2.1.100 has been released"
              " from a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a discover
    response_->setType(DHCPOFFER);
    ASSERT_NO_THROW(entry = genLease4Entry(discover_, response_, lease_, Action::ASSIGN));
    EXPECT_TRUE(entry.empty());
    response_->setType(DHCPACK);

    // Verify with a client id
    lease_->client_id_ = client_id_;

    OptionPtr client_id_option(new Option(Option::V4, DHO_DHCP_CLIENT_IDENTIFIER,
                                          client_id_->getClientId()));

    request_->addOption(client_id_option);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54",
              entry);

    // Verify a relayed request (no RAI)
    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Get the option definition for RAI option. This option is represented
    // by OptionCustom which requires a definition to be passed to
    // the constructor.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    uint8_t circuit_id[] = { 0x68, 0x6F, 0x77, 0x64, 0x79 };
    // Create RAI option.
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));

    OptionPtr circuit_id_opt(new Option(Option::V4, RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                        circuit_id + sizeof(circuit_id))));
    rai->addOption(circuit_id_opt);

    request_->addOption(rai);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79",
              entry);

    uint8_t subscriber_id[] = { 0x1a, 0x2b, 0x3c, 0x4d, 0x5e, 0x6f };
    OptionPtr subscriber_id_opt(new Option(Option::V4, RAI_OPTION_SUBSCRIBER_ID,
                                           OptionBuffer(subscriber_id,
                                           subscriber_id
                                           + sizeof(subscriber_id))));
    rai->addOption(subscriber_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79"
              ", subscriber-id: 1a:2b:3c:4d:5e:6f",
              entry);

    uint8_t remote_id[] = { 0x87, 0xF6, 0x79, 0x77, 0xEF };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                       remote_id + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79"
              ", remote-id: 87:f6:79:77:ef"
              ", subscriber-id: 1a:2b:3c:4d:5e:6f",
              entry);
}

// Verifies legal entry content for directly connected clients
TEST_F(CalloutTestv4, directClient4CustomLoggingFormatRequestAndResponse) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    BackendStore::instance()->setRequestFormatExpression(request_format_);
    BackendStore::instance()->setResponseFormatExpression(response_format_);

    std::string entry;

    // Verify address and duration for an assignment (no client id)
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address and duration for a renewal (no client id)
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a release (no client id). No server response.
    ASSERT_NO_THROW(entry = genLease4Entry(release_, Pkt4Ptr(), lease_, Action::RELEASE));
    EXPECT_EQ("Address: 192.2.1.100 has been released"
              " from a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a decline (no client id). No server response.
    ASSERT_NO_THROW(entry = genLease4Entry(decline_, Pkt4Ptr(), lease_, Action::RELEASE));
    EXPECT_EQ("Address: 192.2.1.100 has been released"
              " from a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e",
              entry);

    // Verify address for a discover
    response_->setType(DHCPOFFER);
    ASSERT_NO_THROW(entry = genLease4Entry(discover_, response_, lease_, Action::ASSIGN));
    EXPECT_TRUE(entry.empty());
    response_->setType(DHCPACK);

    // Verify with a client id
    lease_->client_id_ = client_id_;

    OptionPtr client_id_option(new Option(Option::V4, DHO_DHCP_CLIENT_IDENTIFIER,
                                          client_id_->getClientId()));

    request_->addOption(client_id_option);
    response_->addOption(client_id_option);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54",
              entry);

    // Verify a relayed request (no RAI)
    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));
    response_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Get the option definition for RAI option. This option is represented
    // by OptionCustom which requires a definition to be passed to
    // the constructor.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    uint8_t circuit_id[] = { 0x68, 0x6F, 0x77, 0x64, 0x79 };
    // Create RAI option.
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));

    OptionPtr circuit_id_opt(new Option(Option::V4, RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                        circuit_id + sizeof(circuit_id))));
    rai->addOption(circuit_id_opt);

    request_->addOption(rai);
    response_->addOption(rai);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79",
              entry);

    uint8_t subscriber_id[] = { 0x1a, 0x2b, 0x3c, 0x4d, 0x5e, 0x6f };
    OptionPtr subscriber_id_opt(new Option(Option::V4, RAI_OPTION_SUBSCRIBER_ID,
                                           OptionBuffer(subscriber_id,
                                           subscriber_id
                                           + sizeof(subscriber_id))));
    rai->addOption(subscriber_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79"
              ", subscriber-id: 1a:2b:3c:4d:5e:6f",
              entry);

    uint8_t remote_id[] = { 0x87, 0xF6, 0x79, 0x77, 0xEF };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                       remote_id + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79"
              ", remote-id: 87:f6:79:77:ef"
              ", subscriber-id: 1a:2b:3c:4d:5e:6f",
              entry);
}

// Verifies legal entry content for relayed clients
// Checks with and without RAI and its suboptions
TEST_F(CalloutTestv4, relayedClient4) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    std::string entry;

    // Verify a relayed request without client id or RAI
    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Verify a relayed request with client id, but no RAI
    lease_->client_id_ = client_id_;

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Get the option definition for RAI option.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    // Create RAI option.
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));

    request_->addOption(rai);

    // Verify a relayed request with RAI but has neither circuit id or remote id
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Create CIRCUIT ID sub-option
    uint8_t circuit_id[] = { 0x68, 0x6F, 0x77, 0x64, 0x79 };
    OptionPtr circuit_id_opt(new Option(Option::V4, RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                        circuit_id + sizeof(circuit_id))));

    // Verify a relayed request with RAI with only circuit id
    rai->addOption(circuit_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 68:6f:77:64:79 (howdy)",
              entry);

    // Verify a relayed request with RAI with both circuit id and remote id
    uint8_t remote_id[] = { 0x87, 0xF6, 0x79, 0x77, 0xEF };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                                    remote_id
                                                    + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 68:6f:77:64:79 (howdy)"
              " and remote-id: 87:f6:79:77:ef",
              entry);

    // Verify a relayed request with RAI with only remote id
    rai->delOption(RAI_OPTION_AGENT_CIRCUIT_ID);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by remote-id: 87:f6:79:77:ef",
              entry);

    lease_->setContext(Element::fromJSON("{ \"bar\": false }"));
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", identified by remote-id: 87:f6:79:77:ef, "
              "context: { \"bar\": false }",
              entry);
}

// Verifies legal entry content for relayed clients
// Checks with and without RAI and its suboptions
TEST_F(CalloutTestv4, relayedClient4CustomLoggingFormatRequestOnly) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    BackendStore::instance()->setRequestFormatExpression(request_format_only_);

    std::string entry;

    // Verify a relayed request without client id or RAI
    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Verify a relayed request with client id, but no RAI
    lease_->client_id_ = client_id_;

    OptionPtr client_id_option(new Option(Option::V4, DHO_DHCP_CLIENT_IDENTIFIER,
                                          client_id_->getClientId()));

    request_->addOption(client_id_option);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Get the option definition for RAI option.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    // Create RAI option.
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));

    request_->addOption(rai);

    // Verify a relayed request with RAI but has neither circuit id or remote id
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Create CIRCUIT ID sub-option
    uint8_t circuit_id[] = { 0x68, 0x6F, 0x77, 0x64, 0x79 };
    OptionPtr circuit_id_opt(new Option(Option::V4, RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                        circuit_id + sizeof(circuit_id))));

    // Verify a relayed request with RAI with only circuit id
    rai->addOption(circuit_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79",
              entry);

    // Verify a relayed request with RAI with both circuit id and remote id
    uint8_t remote_id[] = { 0x87, 0xF6, 0x79, 0x77, 0xEF };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                                    remote_id
                                                    + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79"
              ", remote-id: 87:f6:79:77:ef",
              entry);

    // Verify a relayed request with RAI with only remote id
    rai->delOption(RAI_OPTION_AGENT_CIRCUIT_ID);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", remote-id: 87:f6:79:77:ef",
              entry);
}

// Verifies legal entry content for relayed clients
// Checks with and without RAI and its suboptions
TEST_F(CalloutTestv4, relayedClient4CustomLoggingFormatRequestAndResponse) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    BackendStore::instance()->setRequestFormatExpression(request_format_);
    BackendStore::instance()->setResponseFormatExpression(response_format_);

    std::string entry;

    // Verify a relayed request without client id or RAI
    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));
    response_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Verify a relayed request with client id, but no RAI
    lease_->client_id_ = client_id_;

    OptionPtr client_id_option(new Option(Option::V4, DHO_DHCP_CLIENT_IDENTIFIER,
                                          client_id_->getClientId()));

    request_->addOption(client_id_option);
    response_->addOption(client_id_option);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Get the option definition for RAI option.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    // Create RAI option.
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));

    request_->addOption(rai);
    response_->addOption(rai);

    // Verify a relayed request with RAI but has neither circuit id or remote id
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33",
              entry);

    // Create CIRCUIT ID sub-option
    uint8_t circuit_id[] = { 0x68, 0x6F, 0x77, 0x64, 0x79 };
    OptionPtr circuit_id_opt(new Option(Option::V4, RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                        circuit_id + sizeof(circuit_id))));

    // Verify a relayed request with RAI with only circuit id
    rai->addOption(circuit_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79",
              entry);

    // Verify a relayed request with RAI with both circuit id and remote id
    uint8_t remote_id[] = { 0x87, 0xF6, 0x79, 0x77, 0xEF };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                                    remote_id
                                                    + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", circuit-id: 68:6f:77:64:79"
              ", remote-id: 87:f6:79:77:ef",
              entry);

    // Verify a relayed request with RAI with only remote id
    rai->delOption(RAI_OPTION_AGENT_CIRCUIT_ID);

    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 6735 seconds"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54"
              " connected via relay at address: 192.2.16.33"
              ", remote-id: 87:f6:79:77:ef",
              entry);
}

// Verifies printable items
TEST_F(CalloutTestv4, printable4) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    request_->setGiaddr(isc::asiolink::IOAddress("192.2.16.33"));
    const uint8_t clientid[] = { 0x66, 0x6f, 0x6f, 0x62, 0x61, 0x72 };
    lease_->client_id_.reset(new ClientId(clientid, sizeof(clientid)));

    // Add a RAI option.
    const OptionDefinition& rai_def = LibDHCP::DHO_DHCP_AGENT_OPTIONS_DEF();
    OptionCustomPtr rai(new OptionCustom(rai_def, Option::V4));
    request_->addOption(rai);

    // Add a printable CIRCUIT ID sub-option.
    uint8_t circuit_id[] = { 0x46, 0x6f, 0x6f };
    OptionPtr circuit_id_opt(new Option(Option::V4,
                                        RAI_OPTION_AGENT_CIRCUIT_ID,
                                        OptionBuffer(circuit_id,
                                                     circuit_id
                                                     + sizeof(circuit_id))));
    rai->addOption(circuit_id_opt);

    // Add a printable REMOTE ID sub-option.
    uint8_t remote_id[] = { 0x42, 0x61, 0x72 };
    OptionPtr remote_id_opt(new Option(Option::V4, RAI_OPTION_REMOTE_ID,
                                       OptionBuffer(remote_id,
                                                    remote_id
                                                    + sizeof(remote_id))));
    rai->addOption(remote_id_opt);

    // Add a printable SUBSCRIBER ID sub-option.
    uint8_t subscriber_id[] = { 0x6f, 0x63, 0x65, 0x61, 0x6e };
    OptionPtr subscriber_id_opt(new Option(Option::V4, RAI_OPTION_SUBSCRIBER_ID,
                                           OptionBuffer(subscriber_id,
                                                        subscriber_id
                                                        + sizeof(subscriber_id))));
    rai->addOption(subscriber_id_opt);

    std::string entry;

    // Verify a relayed request with RAI.
    ASSERT_NO_THROW(entry = genLease4Entry(request_, response_, lease_, Action::ASSIGN));
    EXPECT_EQ("Address: 192.2.1.100 has been assigned for 1 hrs 52 mins 15 secs"
              " to a device with hardware address:"
              " hwtype=1 08:00:2b:02:3f:4e, client-id: "
              "66:6f:6f:62:61:72 (foobar)"
              " connected via relay at address: 192.2.16.33"
              ", identified by circuit-id: 46:6f:6f (Foo)"
              " and remote-id: 42:61:72 (Bar)"
              " and subscriber-id: 6f:63:65:61:6e (ocean)",
              entry);
}

// Verifies that legalLog4Handler() detects a null BackendStore::instance()
TEST_F(CalloutTestv4, noRotatingFileTest4) {
    // Make a callout handle
    CalloutHandle handle(getCalloutManager());
    handle.setArgument("lease4", lease_);
    handle.setArgument("query4", request_);

    // The function should fail when there's no BackendStore::instance().
    int ret;
    ASSERT_NO_THROW(ret = legalLog4Handler(handle, Action::ASSIGN));
    EXPECT_EQ(1, ret);
}

// Verifies that the pkt4_receive callout creates an empty context which can be
// used in all other hook points.
TEST_F(CalloutTestv4, pkt4_receive) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(discover_);

    // Create a subnet with user context disabling legal logging.
    Subnet4Ptr subnet2345(new Subnet4(IOAddress("192.2.2.0"), 24, 30, 40, 50, SubnetID(2345)));
    ElementPtr ctx2345 = Element::createMap();
    ctx2345->set("legal-logging", Element::create(false));
    subnet2345->setContext(ctx2345);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet2345);

    // Create a subnet with user context explicitly enabling legal logging.
    Subnet4Ptr subnet3456(new Subnet4(IOAddress("192.2.3.0"), 24, 30, 40, 50, SubnetID(3456)));
    ElementPtr ctx3456 = Element::createMap();
    ctx3456->set("legal-logging", Element::create(true));
    subnet3456->setContext(ctx3456);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet3456);
    CfgMgr::instance().commit();

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    Lease4CollectionPtr new_leases(new Lease4Collection());
    Lease4CollectionPtr deleted_leases(new Lease4Collection());

    new_leases->push_back(lease4);

    // The callout should succeed and generate no entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        ASSERT_NO_THROW(ret = pkt4_receive(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", discover_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Try to log the lease for address 192.2.2.123 and subnet identifier 2345. The log
    // entry should not be generated because legal-logging is disabled for this subnet.
    lease4 = createLease4("192.2.2.123", 6735, hwaddr_, ClientIdPtr(), 2345);

    new_leases->clear();
    new_leases->push_back(lease4);
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        ASSERT_NO_THROW(ret = pkt4_receive(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", discover_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Do not log the lease for address 192.2.3.122 and subnet identifier 3456.
    // This should not be logged even though legal logging is explicitly enabled for this subnet.
    lease4 = createLease4("192.2.3.122", 6735, hwaddr_, ClientIdPtr(), 3456);

    new_leases->clear();
    new_leases->push_back(lease4);
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        ASSERT_NO_THROW(ret = pkt4_receive(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", discover_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct. We should have no entry.
    std::vector<std::string>lines;

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileNotCreated(genName(today()));
}

// Verifies that the leases4_committed callout
// -# Generates the correct entry in the legal file given a Pkt4 and Lease4
// -# Generates an entry when legal logging is explicitly enabled for a subnet
// -# Does not generate an entry when legal logging is explicitly disabled for
//    a subnet.
// Note we don't bother testing multiple entries or rotation as this is done
// during RotatingFile testing.
TEST_F(CalloutTestv4, leases4_committed) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(request_);

    // Create a subnet with user context disabling legal logging.
    Subnet4Ptr subnet2345(new Subnet4(IOAddress("192.2.2.0"), 24, 30, 40, 50, SubnetID(2345)));
    ElementPtr ctx2345 = Element::createMap();
    ctx2345->set("legal-logging", Element::create(false));
    subnet2345->setContext(ctx2345);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet2345);

    // Create a subnet with user context explicitly enabling legal logging.
    Subnet4Ptr subnet3456(new Subnet4(IOAddress("192.2.3.0"), 24, 30, 40, 50, SubnetID(3456)));
    ElementPtr ctx3456 = Element::createMap();
    ctx3456->set("legal-logging", Element::create(true));
    subnet3456->setContext(ctx3456);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet3456);
    CfgMgr::instance().commit();

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    Lease4CollectionPtr new_leases(new Lease4Collection());
    Lease4CollectionPtr deleted_leases(new Lease4Collection());

    new_leases->push_back(lease4);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Try to log the lease for address 192.2.2.123 and subnet identifier 2345. The log
    // entry should not be generated because legal-logging is disabled for this subnet.
    lease4 = createLease4("192.2.2.123", 6735, hwaddr_, ClientIdPtr(), 2345);

    new_leases->clear();
    new_leases->push_back(lease4);
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Log the lease for address 192.2.3.122 and subnet identifier 3456. This should be
    // logged because legal logging is explicitly enabled for this subnet.
    lease4 = createLease4("192.2.3.122", 6735, hwaddr_, ClientIdPtr(), 3456);

    new_leases->clear();
    new_leases->push_back(lease4);
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct. We should have two entries:
    // 192.2.1.111 and 192.2.3.122.
    std::vector<std::string>lines;
    lines.push_back("Address: 192.2.1.100 has been assigned"
                    " for 1 hrs 52 mins 15 secs"
                    " to a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    lines.push_back("Address: 192.2.3.122 has been assigned"
                    " for 1 hrs 52 mins 15 secs"
                    " to a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the lease4_renew callout generates the correct entry
// in the legal file given a Pkt4 and Lease4
TEST_F(CalloutTestv4, lease4_renew) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(request_);

    // Create a subnet with user context disabling legal logging.
    Subnet4Ptr subnet2345(new Subnet4(IOAddress("192.2.2.0"), 24, 30, 40, 50, SubnetID(2345)));
    ElementPtr ctx2345 = Element::createMap();
    ctx2345->set("legal-logging", Element::create(false));
    subnet2345->setContext(ctx2345);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet2345);

    // Create a subnet with user context explicitly enabling legal logging.
    Subnet4Ptr subnet3456(new Subnet4(IOAddress("192.2.3.0"), 24, 30, 40, 50, SubnetID(3456)));
    ElementPtr ctx3456 = Element::createMap();
    ctx3456->set("legal-logging", Element::create(true));
    subnet3456->setContext(ctx3456);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet3456);
    CfgMgr::instance().commit();

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr());

    Lease4CollectionPtr new_leases(new Lease4Collection());
    Lease4CollectionPtr deleted_leases(new Lease4Collection());

    new_leases->push_back(lease4);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Try to log the lease for address 192.2.2.123 and subnet identifier 2345. The log
    // entry should not be generated because legal-logging is disabled for this subnet.
    lease4 = createLease4("192.2.2.123", 6735, hwaddr_, ClientIdPtr(), 2345);

    new_leases->clear();
    new_leases->push_back(lease4);
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Log the lease for address 192.2.3.122 and subnet identifier 3456. This should be
    // logged because legal logging is explicitly enabled for this subnet.
    lease4 = createLease4("192.2.3.122", 6735, hwaddr_, ClientIdPtr(), 3456);

    new_leases->clear();
    new_leases->push_back(lease4);
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("Address: 192.2.1.100 has been assigned"
                    " for 1 hrs 52 mins 15 secs"
                    " to a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    lines.push_back("Address: 192.2.3.122 has been assigned"
                    " for 1 hrs 52 mins 15 secs"
                    " to a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the lease4_renew callout generates the correct entry
// in the legal file given a Pkt4 and Lease4
TEST_F(CalloutTestv4, customRequestLoggingFormat_lease4_renew) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(request_);

    std::string format = "ifelse(pkt4.msgtype == 5, concat('Assigned address: ', addrtotext(pkt4.yiaddr)), '')";

    BackendStore::instance()->setResponseFormatExpression(format);

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.101", 6735, hwaddr_, ClientIdPtr());

    Lease4CollectionPtr new_leases(new Lease4Collection());
    Lease4CollectionPtr deleted_leases(new Lease4Collection());

    new_leases->push_back(lease4);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("leases4", new_leases);
        handle->setArgument("deleted_leases4", deleted_leases);
        ASSERT_NO_THROW(ret = leases4_committed(*handle));
        EXPECT_EQ(0, ret);
    }

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("query4", request_);
        handle->setArgument("response4", response_);
        ASSERT_NO_THROW(ret = pkt4_send(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("Assigned address: 192.2.1.100");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the lease4_release callout generates the correct entry
// in the legal file given a Pkt4 and Lease4
TEST_F(CalloutTestv4, lease4_release) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(release_);

    // Create a subnet with user context disabling legal logging.
    Subnet4Ptr subnet2345(new Subnet4(IOAddress("192.2.2.0"), 24, 30, 40, 50, SubnetID(2345)));
    ElementPtr ctx2345 = Element::createMap();
    ctx2345->set("legal-logging", Element::create(false));
    subnet2345->setContext(ctx2345);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet2345);

    // Create a subnet with user context explicitly enabling legal logging.
    Subnet4Ptr subnet3456(new Subnet4(IOAddress("192.2.3.0"), 24, 30, 40, 50, SubnetID(3456)));
    ElementPtr ctx3456 = Element::createMap();
    ctx3456->set("legal-logging", Element::create(true));
    subnet3456->setContext(ctx3456);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet3456);
    CfgMgr::instance().commit();

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", release_);
        ASSERT_NO_THROW(ret = lease4_release(*handle));
        EXPECT_EQ(0, ret);
    }

    // Try to log the lease for address 192.2.2.123 and subnet identifier 2345. The log
    // entry should not be generated because legal-logging is disabled for this subnet.
    lease4 = createLease4("192.2.2.123", 6735, hwaddr_, ClientIdPtr(), 2345);

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", release_);
        ASSERT_NO_THROW(ret = lease4_release(*handle));
        EXPECT_EQ(0, ret);
    }

    // Log the lease for address 192.2.3.122 and subnet identifier 3456. This should be
    // logged because legal logging is explicitly enabled for this subnet.
    lease4 = createLease4("192.2.3.122", 6735, hwaddr_, ClientIdPtr(), 3456);

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", release_);
        ASSERT_NO_THROW(ret = lease4_release(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("Address: 192.2.1.100 has been released"
                    " from a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    lines.push_back("Address: 192.2.3.122 has been released"
                    " from a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the lease4_release callout generates the correct entry
// in the legal file given a Pkt4 and Lease4
TEST_F(CalloutTestv4, customRequestLoggingFormat_lease4_release) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(release_);

    std::string format = "ifelse(pkt4.msgtype == 7, concat('Released address: ', addrtotext(pkt4.ciaddr)), '')";

    BackendStore::instance()->setRequestFormatExpression(format);

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease_);
        handle->setArgument("query4", release_);
        ASSERT_NO_THROW(ret = lease4_release(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("Released address: 192.2.1.100");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the lease4_decline callout generates the correct entry
// in the legal file given a Pkt4 and Lease4
TEST_F(CalloutTestv4, lease4_decline) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(decline_);

    // Create a subnet with user context disabling legal logging.
    Subnet4Ptr subnet2345(new Subnet4(IOAddress("192.2.2.0"), 24, 30, 40, 50, SubnetID(2345)));
    ElementPtr ctx2345 = Element::createMap();
    ctx2345->set("legal-logging", Element::create(false));
    subnet2345->setContext(ctx2345);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet2345);

    // Create a subnet with user context explicitly enabling legal logging.
    Subnet4Ptr subnet3456(new Subnet4(IOAddress("192.2.3.0"), 24, 30, 40, 50, SubnetID(3456)));
    ElementPtr ctx3456 = Element::createMap();
    ctx3456->set("legal-logging", Element::create(true));
    subnet3456->setContext(ctx3456);
    CfgMgr::instance().getStagingCfg()->getCfgSubnets4()->add(subnet3456);
    CfgMgr::instance().commit();

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", decline_);
        ASSERT_NO_THROW(ret = lease4_decline(*handle));
        EXPECT_EQ(0, ret);
    }

    // Try to log the lease for address 192.2.2.123 and subnet identifier 2345. The log
    // entry should not be generated because legal-logging is disabled for this subnet.
    lease4 = createLease4("192.2.2.123", 6735, hwaddr_, ClientIdPtr(), 2345);

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", decline_);
        ASSERT_NO_THROW(ret = lease4_decline(*handle));
        EXPECT_EQ(0, ret);
    }

    // Log the lease for address 192.2.3.122 and subnet identifier 3456. This should be
    // logged because legal logging is explicitly enabled for this subnet.
    lease4 = createLease4("192.2.3.122", 6735, hwaddr_, ClientIdPtr(), 3456);

    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", decline_);
        ASSERT_NO_THROW(ret = lease4_decline(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("Address: 192.2.1.100 has been released"
                    " from a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    lines.push_back("Address: 192.2.3.122 has been released"
                    " from a device with hardware address:"
                    " hwtype=1 08:00:2b:02:3f:4e");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the lease4_decline callout generates the correct entry
// in the legal file given a Pkt4 and Lease4
TEST_F(CalloutTestv4, customRequestLoggingFormat_lease4_decline) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(decline_);

    std::string format = "ifelse(pkt4.msgtype == 4, concat('Declined address: ', addrtotext(option[50].hex)), '')";

    BackendStore::instance()->setRequestFormatExpression(format);

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", decline_);
        ASSERT_NO_THROW(ret = lease4_decline(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("Declined address: 192.2.1.100");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

// Verifies that the custom format logs on multiple lines.
TEST_F(CalloutTestv4, customRequestLoggingFormatMultipleLines) {
    ASSERT_NO_THROW(BackendStore::instance().reset(new TestableRotatingFile(time_)));

    // Make a callout handle
    CalloutHandlePtr handle = getCalloutHandle(decline_);

    std::string format = "ifelse(pkt4.msgtype == 4, 'first line' + 0x0a + 'second line', '')";

    BackendStore::instance()->setRequestFormatExpression(format);

    int ret;

    // Make a lease and add it to the callout arguments.
    Lease4Ptr lease4 = createLease4("192.2.1.100", 6735, hwaddr_, ClientIdPtr(), 1234);

    // The callout should succeed and generate an entry for 192.2.1.100.
    {
        ScopedCalloutHandleState callout_handle_state(handle);
        handle->setArgument("lease4", lease4);
        handle->setArgument("query4", decline_);
        ASSERT_NO_THROW(ret = lease4_decline(*handle));
        EXPECT_EQ(0, ret);
    }

    // Close it to flush any unwritten data
    BackendStore::instance()->close();

    // Verify that the file content is correct.
    std::vector<std::string>lines;
    lines.push_back("first line");
    lines.push_back("second line");

    std::string today_now_string = BackendStore::instance()->getNowString();
    checkFileLines(genName(today()), today_now_string, lines);
}

} // end of anonymous namespace