config_parser_unittest.cc 179 KB
Newer Older
1
// Copyright (C) 2012-2017 Internet Systems Consortium, Inc. ("ISC")
2
//
3
4
5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7
8
9
10
11

#include <config.h>

#include <arpa/inet.h>
#include <gtest/gtest.h>

12
#include <cc/command_interpreter.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
13
#include <config/module_spec.h>
14
#include <dhcp4/dhcp4_srv.h>
15
#include <dhcp4/json_config_parser.h>
16
#include <dhcp/option4_addrlst.h>
17
18
#include <dhcp/option_custom.h>
#include <dhcp/option_int.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
19
#include <dhcp/docsis3_option_defs.h>
20
#include <dhcp/classify.h>
21
#include <dhcp/tests/iface_mgr_test_config.h>
22
23
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/cfgmgr.h>
24
#include <dhcpsrv/cfg_expiration.h>
25
#include <dhcpsrv/cfg_hosts.h>
26
#include <dhcpsrv/cfg_subnets4.h>
27
#include <dhcpsrv/testutils/config_result_check.h>
28
29
30
31
#include <hooks/hooks_manager.h>

#include "marker_file.h"
#include "test_libraries.h"
32
#include "test_data_files_config.h"
33
#include "dhcp4_test_utils.h"
34
#include "get_config_unittest.h"
35

36
#include <boost/foreach.hpp>
37
38
#include <boost/scoped_ptr.hpp>

Tomek Mrugalski's avatar
Tomek Mrugalski committed
39
40
41
42
#include <iostream>
#include <fstream>
#include <sstream>
#include <limits.h>
43
44
45
46

using namespace isc;
using namespace isc::asiolink;
using namespace isc::config;
47
48
using namespace isc::data;
using namespace isc::dhcp;
49
using namespace isc::dhcp::test;
50
51
using namespace isc::hooks;
using namespace std;
52
53

namespace {
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
const char* PARSER_CONFIGS[] = {
    // CONFIGURATION 0: one subnet with one pool, no user contexts
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0/28\" }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
    "}",

    // Configuration 1: one pool with empty user context
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0/28\","
    "                \"user-context\": {"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
    "}",

    // Configuration 2: one pool with user context containing lw4over6 parameters
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0/28\","
    "                \"user-context\": {"
    "                    \"integer-param\": 42,"
    "                    \"string-param\": \"Sagittarius\","
    "                    \"bool-param\": true"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
    "}",

    // Configuration 3: one min-max pool with user context containing lw4over6 parameters
    "{"
    "    \"interfaces-config\": {"
    "        \"interfaces\": [\"*\" ]"
    "    },"
    "    \"valid-lifetime\": 4000,"
    "    \"rebind-timer\": 2000,"
    "    \"renew-timer\": 1000,"
    "    \"subnet4\": [ {"
    "        \"pools\": [ "
    "            { \"pool\":  \"192.0.2.0 - 192.0.2.15\","
    "                \"user-context\": {"
    "                    \"integer-param\": 42,"
    "                    \"string-param\": \"Sagittarius\","
    "                    \"bool-param\": true"
    "                }"
    "            }"
    "        ],"
    "        \"subnet\": \"192.0.2.0/24\""
    "     } ]"
132
133
    "}"
};
134

135
136
137
138
139
140
141
142
143
144
/// @brief Prepends the given name with the DHCP4 source directory
///
/// @param name file name of the desired file
/// @return string containing the absolute path of the file in the DHCP source
/// directory.
std::string specfile(const std::string& name) {
    return (std::string(DHCP4_SRC_DIR) + "/" + name);
}

/// @brief Tests that the spec file is valid.
145
/// Verifies that the Kea DHCPv4 configuration specification file is valid.
146
TEST(Dhcp4SpecTest, basicSpec) {
147
    (isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
148
149
150
    ASSERT_NO_THROW(isc::config::moduleSpecFromFile(specfile("dhcp4.spec")));
}

151
class Dhcp4ParserTest : public ::testing::Test {
152
153
154
155
156
157
158
159
160
161
protected:
    // Check that no hooks libraries are loaded.  This is a pre-condition for
    // a number of tests, so is checked in one place.  As this uses an
    // ASSERT call - and it is not clear from the documentation that Gtest
    // predicates can be used in a constructor - the check is placed in SetUp.
    virtual void SetUp() {
        std::vector<std::string> libraries = HooksManager::getLibraryNames();
        ASSERT_TRUE(libraries.empty());
    }

162
163
public:
    Dhcp4ParserTest()
164
    : rcode_(-1) {
165
166
167
        // Open port 0 means to not do anything at all. We don't want to
        // deal with sockets here, just check if configuration handling
        // is sane.
168
        srv_.reset(new Dhcpv4Srv(0));
169
        // Create fresh context.
170
        resetConfiguration();
171
172
    }

173
public:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
174

175
    // Checks if the result of DHCP server configuration has
Tomek Mrugalski's avatar
Tomek Mrugalski committed
176
177
178
179
180
181
182
183
    // expected code (0 for success, other for failures).
    // Also stores result in rcode_ and comment_.
    void checkResult(ConstElementPtr status, int expected_code) {
        ASSERT_TRUE(status);
        comment_ = parseAnswer(rcode_, status);
        EXPECT_EQ(expected_code, rcode_);
    }

184
    ~Dhcp4ParserTest() {
185
        resetConfiguration();
186
187

        // ... and delete the hooks library marker files if present
188
189
        static_cast<void>(remove(LOAD_MARKER_FILE));
        static_cast<void>(remove(UNLOAD_MARKER_FILE));
190
191
    };

192
193
194
195
196
197
198
199
    /// @brief Returns an interface configuration used by the most of the
    /// unit tests.
    std::string genIfaceConfig() const {
        return ("\"interfaces-config\": {"
                "  \"interfaces\": [ \"*\" ]"
                "}");
    }

200
201
202
    /// @brief Create the simple configuration with single option.
    ///
    /// This function allows to set one of the parameters that configure
203
204
    /// option value. These parameters are: "name", "code", "data",
    /// "csv-format" and "space".
205
    ///
206
    /// @param param_value string holding option parameter value to be
207
208
209
    /// injected into the configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param value.
210
211
    /// @return configuration string containing custom values of parameters
    /// describing an option.
212
213
214
215
216
    std::string createConfigWithOption(const std::string& param_value,
                                       const std::string& parameter) {
        std::map<std::string, std::string> params;
        if (parameter == "name") {
            params["name"] = param_value;
217
            params["space"] = DHCP4_OPTION_SPACE;
218
            params["code"] = "56";
219
            params["data"] = "ABCDEF0105";
220
            params["csv-format"] = "false";
221
222
223
        } else if (parameter == "space") {
            params["name"] = "dhcp-message";
            params["space"] = param_value;
224
            params["code"] = "56";
225
            params["data"] = "ABCDEF0105";
226
            params["csv-format"] = "false";
227
        } else if (parameter == "code") {
228
            params["name"] = "dhcp-message";
229
            params["space"] = DHCP4_OPTION_SPACE;
230
            params["code"] = param_value;
231
            params["data"] = "ABCDEF0105";
232
            params["csv-format"] = "false";
233
        } else if (parameter == "data") {
234
            params["name"] = "dhcp-message";
235
            params["space"] = DHCP4_OPTION_SPACE;
236
237
            params["code"] = "56";
            params["data"] = param_value;
238
            params["csv-format"] = "false";
239
        } else if (parameter == "csv-format") {
240
            params["name"] = "dhcp-message";
241
            params["space"] = DHCP4_OPTION_SPACE;
242
            params["code"] = "56";
243
            params["data"] = "ABCDEF0105";
244
            params["csv-format"] = param_value;
245
246
247
248
        }
        return (createConfigWithOption(params));
    }

249
250
251
252
253
254
255
256
    /// @brief Create simple configuration with single option.
    ///
    /// This function creates a configuration for a single option with
    /// custom values for all parameters that describe the option.
    ///
    /// @params params map holding parameters and their values.
    /// @return configuration string containing custom values of parameters
    /// describing an option.
257
258
    std::string createConfigWithOption(const std::map<std::string, std::string>& params) {
        std::ostringstream stream;
259
        stream << "{ " << genIfaceConfig() << "," <<
260
261
262
            "\"rebind-timer\": 2000, "
            "\"renew-timer\": 1000, "
            "\"subnet4\": [ { "
263
            "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
264
265
266
267
268
269
270
271
            "    \"subnet\": \"192.0.2.0/24\", "
            "    \"option-data\": [ {";
        bool first = true;
        typedef std::pair<std::string, std::string> ParamPair;
        BOOST_FOREACH(ParamPair param, params) {
            if (!first) {
                stream << ", ";
            } else {
272
                // cppcheck-suppress unreadVariable
273
274
275
276
                first = false;
            }
            if (param.first == "name") {
                stream << "\"name\": \"" << param.second << "\"";
277
278
            } else if (param.first == "space") {
                stream << "\"space\": \"" << param.second << "\"";
279
280
281
282
            } else if (param.first == "code") {
                stream << "\"code\": " << param.second << "";
            } else if (param.first == "data") {
                stream << "\"data\": \"" << param.second << "\"";
283
284
            } else if (param.first == "csv-format") {
                stream << "\"csv-format\": " << param.second;
285
286
287
288
289
290
291
292
293
            }
        }
        stream <<
            "        } ]"
            " } ],"
            "\"valid-lifetime\": 4000 }";
        return (stream.str());
    }

294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
    /// @brief Returns an option from the subnet.
    ///
    /// This function returns an option from a subnet to which the
    /// specified subnet address belongs. The option is identified
    /// by its code.
    ///
    /// @param subnet_address Address which belongs to the subnet from
    /// which the option is to be returned.
    /// @param option_code Code of the option to be returned.
    /// @param expected_options_count Expected number of options in
    /// the particular subnet.
    ///
    /// @return Descriptor of the option. If the descriptor holds a
    /// NULL option pointer, it means that there was no such option
    /// in the subnet.
309
    OptionDescriptor
310
311
312
    getOptionFromSubnet(const IOAddress& subnet_address,
                        const uint16_t option_code,
                        const uint16_t expected_options_count = 1) {
313
        Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
314
            getCfgSubnets4()->selectSubnet(subnet_address);
315
316
317
318
319
320
        if (!subnet) {
            /// @todo replace toText() with the use of operator <<.
            ADD_FAILURE() << "A subnet for the specified address "
                          << subnet_address.toText()
                          << "does not exist in Config Manager";
        }
321
        OptionContainerPtr options =
322
            subnet->getCfgOption()->getAll(DHCP4_OPTION_SPACE);
323
324
325
326
327
328
329
330
        if (expected_options_count != options->size()) {
            ADD_FAILURE() << "The number of options in the subnet '"
                          << subnet_address.toText() << "' is different "
                " than expected number of options '"
                          << expected_options_count << "'";
        }

        // Get the search index. Index #1 is to search using option code.
331
        const OptionContainerTypeIndex& idx = options->get<1>();
332
333
334
335

        // Get the options for specified index. Expecting one option to be
        // returned but in theory we may have multiple options with the same
        // code so we get the range.
336
337
        std::pair<OptionContainerTypeIndex::const_iterator,
                  OptionContainerTypeIndex::const_iterator> range =
338
339
340
341
342
343
344
            idx.equal_range(option_code);
        if (std::distance(range.first, range.second) > 1) {
            ADD_FAILURE() << "There is more than one option having the"
                " option code '" << option_code << "' in a subnet '"
                          << subnet_address.toText() << "'. Expected "
                " at most one option";
        } else if (std::distance(range.first, range.second) == 0) {
345
            return (OptionDescriptor(OptionPtr(), false));
346
347
348
349
350
        }

        return (*range.first);
    }

351
352
353
354
355
356
357
358
359
360
361
362
363
364
    /// @brief Test invalid option parameter value.
    ///
    /// This test function constructs the simple configuration
    /// string and injects invalid option configuration into it.
    /// It expects that parser will fail with provided option code.
    ///
    /// @param param_value string holding invalid option parameter value
    /// to be injected into configuration string.
    /// @param parameter name of the parameter to be configured with
    /// param_value (can be any of "name", "code", "data")
    void testInvalidOptionParam(const std::string& param_value,
                                const std::string& parameter) {
        ConstElementPtr x;
        std::string config = createConfigWithOption(param_value, parameter);
365
        ConstElementPtr json = parseDHCP4(config);
366
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
367
368
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
369
370
    }

Francis Dupont's avatar
Francis Dupont committed
371
    /// @brief Test invalid option parameter value.
372
373
374
375
376
377
378
379
380
381
    ///
    /// This test function constructs the simple configuration
    /// string and injects invalid option configuration into it.
    /// It expects that parser will fail with provided option code.
    ///
    /// @param params Map of parameters defining an option.
    void
    testInvalidOptionParam(const std::map<std::string, std::string>& params) {
        ConstElementPtr x;
        std::string config = createConfigWithOption(params);
382
        ConstElementPtr json = parseDHCP4(config);
383
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
384
385
        checkResult(x, 1);
        EXPECT_TRUE(errorContainsPosition(x, "<string>"));
386
387
    }

388
389
390
391
392
393
394
395
396
    /// @brief Test option against given code and data.
    ///
    /// @param option_desc option descriptor that carries the option to
    /// be tested.
    /// @param expected_code expected code of the option.
    /// @param expected_data expected data in the option.
    /// @param expected_data_len length of the reference data.
    /// @param extra_data if true extra data is allowed in an option
    /// after tested data.
397
    void testOption(const OptionDescriptor& option_desc,
398
399
400
401
                    uint16_t expected_code, const uint8_t* expected_data,
                    size_t expected_data_len,
                    bool extra_data = false) {
        // Check if option descriptor contains valid option pointer.
402
        ASSERT_TRUE(option_desc.option_);
403
        // Verify option type.
404
        EXPECT_EQ(expected_code, option_desc.option_->getType());
405
406
407
408
409
        // We may have many different option types being created. Some of them
        // have dedicated classes derived from Option class. In such case if
        // we want to verify the option contents against expected_data we have
        // to prepare raw buffer with the contents of the option. The easiest
        // way is to call pack() which will prepare on-wire data.
410
411
        util::OutputBuffer buf(option_desc.option_->getData().size());
        option_desc.option_->pack(buf);
412
413
414
415
416
        if (extra_data) {
            // The length of the buffer must be at least equal to size of the
            // reference data but it can sometimes be greater than that. This is
            // because some options carry suboptions that increase the overall
            // length.
417
            ASSERT_GE(buf.getLength() - option_desc.option_->getHeaderLen(),
418
419
                      expected_data_len);
        } else {
420
            ASSERT_EQ(buf.getLength() - option_desc.option_->getHeaderLen(),
421
422
                      expected_data_len);
        }
423
        // Verify that the data is correct. Do not verify suboptions and a header.
424
        const uint8_t* data = static_cast<const uint8_t*>(buf.getData());
425
        EXPECT_EQ(0, memcmp(expected_data, data + option_desc.option_->getHeaderLen(),
426
                            expected_data_len));
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
    /// @brief Test option configuration.
    ///
    /// This function creates a configuration for a specified option using
    /// a map of parameters specified as the argument. The map holds
    /// name/value pairs which identifies option's configuration parameters:
    /// - name
    /// - space
    /// - code
    /// - data
    /// - csv-format.
    /// This function applies a new server configuration and checks that the
    /// option being configured is inserted into CfgMgr. The raw contents of
    /// this option are compared with the binary data specified as expected
    /// data passed to this function.
    ///
    /// @param params Map of parameters defining an option.
    /// @param option_code Option code.
    /// @param expected_data Array containing binary data expected to be stored
    /// in the configured option.
    /// @param expected_data_len Length of the array holding reference data.
    void testConfiguration(const std::map<std::string, std::string>& params,
                           const uint16_t option_code,
                           const uint8_t* expected_data,
                           const size_t expected_data_len) {
        std::string config = createConfigWithOption(params);
        ASSERT_TRUE(executeConfiguration(config, "parse option configuration"));
455
        // The subnet should now hold one option with the specified option code.
456
        OptionDescriptor desc =
457
            getOptionFromSubnet(IOAddress("192.0.2.24"), option_code);
458
        ASSERT_TRUE(desc.option_);
459
460
461
        testOption(desc, option_code, expected_data, expected_data_len);
    }

462
463
464
465
466
467
468
469
470
471
472
473
474
    /// @brief Parse and Execute configuration
    ///
    /// Parses a configuration and executes a configuration of the server.
    /// If the operation fails, the current test will register a failure.
    ///
    /// @param config Configuration to parse
    /// @param operation Operation being performed.  In the case of an error,
    ///        the error text will include the string "unable to <operation>.".
    ///
    /// @return true if the configuration succeeded, false if not.  In the
    ///         latter case, a failure will have been added to the current test.
    bool
    executeConfiguration(const std::string& config, const char* operation) {
475
        CfgMgr::instance().clear();
476
        ConstElementPtr json;
477
478
        ConstElementPtr status;
        try {
479
            json = parseJSON(config);
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
            status = configureDhcp4Server(*srv_, json);
        } catch (const std::exception& ex) {
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The following configuration was used: " << std::endl
                   << config << std::endl
                   << " and the following error message was returned:"
                   << ex.what() << std::endl;
            return (false);
        }

        // The status object must not be NULL
        if (!status) {
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The configuration function returned a null pointer.";
            return (false);
        }

        // Store the answer if we need it.

        // Returned value should be 0 (configuration success)
        comment_ = parseAnswer(rcode_, status);
        if (rcode_ != 0) {
            string reason = "";
            if (comment_) {
                reason = string(" (") + comment_->stringValue() + string(")");
            }
            ADD_FAILURE() << "Unable to " << operation << ". "
                   << "The configuration function returned error code "
                   << rcode_ << reason;
            return (false);
        }

        return (true);
    }

515
516
517
518
519
520
521
522
    /// @brief Reset configuration database.
    ///
    /// This function resets configuration data base by
    /// removing all subnets and option-data. Reset must
    /// be performed after each test to make sure that
    /// contents of the database do not affect result of
    /// subsequent tests.
    void resetConfiguration() {
523
        string config = "{ " + genIfaceConfig() + "," +
524
            "\"hooks-libraries\": [ ], "
525
526
            "\"valid-lifetime\": 4000, "
            "\"subnet4\": [ ], "
527
            "\"dhcp-ddns\": { \"enable-updates\" : false }, "
528
            "\"option-def\": [ ], "
529
            "\"option-data\": [ ] }";
530
531
        static_cast<void>(executeConfiguration(config,
                                               "reset configuration database"));
532
        CfgMgr::instance().clear();
533
    }
534

535
536
    /// @brief Retrieve an option associated with a host.
    ///
537
538
    /// The option is retrieved from the "dhcp4" option space.
    ///
539
540
541
542
    /// @param host Reference to a host for which an option should be retrieved.
    /// @param option_code Option code.
    /// @tparam ReturnType Type of the pointer object returned.
    ///
543
    /// @return Pointer to an option or NULL pointer if not found.
544
545
546
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const uint16_t option_code) const {
547
        return (retrieveOption<ReturnType>(host, DHCP4_OPTION_SPACE, option_code));
548
549
550
551
552
553
554
555
556
    }

    /// @brief Retrieve an option associated with a host.
    ///
    /// @param host Reference to a host for which an option should be retrieved.
    /// @param space Option space from which option should be retrieved.
    /// @param option_code Option code.
    /// @tparam ReturnType Type of the pointer object returned.
    ///
557
    /// @return Pointer to an option or NULL pointer if not found.
558
559
560
561
    template<typename ReturnType>
    ReturnType
    retrieveOption(const Host& host, const std::string& space,
                   const uint16_t option_code) const {
562
563
        ConstCfgOptionPtr cfg_option = host.getCfgOption4();
        if (cfg_option) {
564
            OptionDescriptor opt_desc = cfg_option->get(space, option_code);
565
566
567
568
569
570
571
            if (opt_desc.option_) {
                return (boost::dynamic_pointer_cast<
                        typename ReturnType::element_type>(opt_desc.option_));
            }
        }
        return (ReturnType());
    }
572

573
574
575
576
577
578
579
580
581
582
583

    /// @brief This utility method attempts to configure using specified
    ///        config and then returns requested pool from requested subnet
    ///
    /// @param config configuration to be applied
    /// @param subnet_index index of the subnet to be returned (0 - the first subnet)
    /// @param pool_index index of the pool within a subnet (0 - the first pool)
    /// @param pool [out] Pool pointer will be stored here (if found)
    void getPool(const std::string& config, size_t subnet_index,
                 size_t pool_index, PoolPtr& pool) {
        ConstElementPtr status;
584
        ConstElementPtr json;
585

586
        EXPECT_NO_THROW(json = parseDHCP4(config, true));
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
        EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));
        ASSERT_TRUE(status);
        checkResult(status, 0);

        ConstCfgSubnets4Ptr subnets4 = CfgMgr::instance().getStagingCfg()->getCfgSubnets4();
        ASSERT_TRUE(subnets4);

        const Subnet4Collection* subnets = subnets4->getAll();
        ASSERT_TRUE(subnets);
        ASSERT_GE(subnets->size(), subnet_index + 1);

        const PoolCollection pools = subnets->at(subnet_index)->getPools(Lease::TYPE_V4);
        ASSERT_GE(pools.size(), pool_index + 1);

        pool = pools.at(pool_index);
        EXPECT_TRUE(pool);
    }

605
606
607
608
    boost::scoped_ptr<Dhcpv4Srv> srv_;  ///< DHCP4 server under test
    int rcode_;                         ///< Return code from element parsing
    ConstElementPtr comment_;           ///< Reason for parse fail
    isc::dhcp::ClientClasses classify_; ///< used in client classification
609
610
611
612
};

/// The goal of this test is to verify that the code accepts only
/// valid commands and malformed or unsupported parameters are rejected.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
613
TEST_F(Dhcp4ParserTest, bogusCommand) {
614
615
616
617

    ConstElementPtr x;

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_,
618
                    parseJSON("{\"bogus\": 5}")));
619
620

    // returned value must be 1 (configuration parse error)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
621
    checkResult(x, 1);
622
623
624

    // it should be refused by syntax too
    EXPECT_THROW(parseDHCP4("{\"bogus\": 5}"), Dhcp4ParseError);
625
626
}

627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
/// The goal of this test is to verify empty interface-config is accepted.
TEST_F(Dhcp4ParserTest, emptyInterfaceConfig) {

    ConstElementPtr json;
    EXPECT_NO_THROW(json = parseDHCP4("{ \"rebind-timer\": 2000, "
                                      "\"renew-timer\": 1000, "
                                      "\"valid-lifetime\": 4000 }"));

    ConstElementPtr status;
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);
}

642
643
644
/// The goal of this test is to verify if wrongly defined subnet will
/// be rejected. Properly defined subnet must include at least one
/// pool definition.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
645
TEST_F(Dhcp4ParserTest, emptySubnet) {
646

647
648
649
650
651
652
    std::string config = "{ " + genIfaceConfig() + "," +
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [  ], "
        "\"valid-lifetime\": 4000 }";

653
    ConstElementPtr json;
654
655
    EXPECT_NO_THROW(json = parseDHCP4(config));
    extractConfig(config);
656
657
658

    ConstElementPtr status;
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));
659
660

    // returned value should be 0 (success)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
661
    checkResult(status, 0);
662
663
}

664
665
666
667
/// Check that the renew-timer doesn't have to be specified, in which case
/// it is marked unspecified in the Subnet.
TEST_F(Dhcp4ParserTest, unspecifiedRenewTimer) {

668
    string config = "{ " + genIfaceConfig() + "," +
669
670
        "\"rebind-timer\": 2000, "
        "\"subnet4\": [ { "
671
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
672
673
674
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

675
676
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
677
    extractConfig(config);
678

679
    ConstElementPtr status;
680
681
682
683
684
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);

685
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
686
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
687
    ASSERT_TRUE(subnet);
688
    EXPECT_FALSE(subnet->getT1().unspecified());
689
    EXPECT_FALSE(subnet->getT2().unspecified());
690
    EXPECT_EQ(900, subnet->getT1()); // that's the default value
691
692
693
694
695
696
697
698
699
700
701
702
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());

    // Check that subnet-id is 1
    EXPECT_EQ(1, subnet->getID());

}

/// Check that the rebind-timer doesn't have to be specified, in which case
/// it is marked unspecified in the Subnet.
TEST_F(Dhcp4ParserTest, unspecifiedRebindTimer) {

703
    string config = "{ " + genIfaceConfig() + "," +
704
705
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
706
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
707
708
709
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

710
711
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
712
    extractConfig(config);
713

714
    ConstElementPtr status;
715
716
717
718
719
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // returned value should be 0 (success)
    checkResult(status, 0);

720
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
721
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
722
723
724
    ASSERT_TRUE(subnet);
    EXPECT_FALSE(subnet->getT1().unspecified());
    EXPECT_EQ(1000, subnet->getT1());
725
726
    EXPECT_FALSE(subnet->getT2().unspecified());
    EXPECT_EQ(1800, subnet->getT2()); // that's the default value
727
728
729
730
731
732
    EXPECT_EQ(4000, subnet->getValid());

    // Check that subnet-id is 1
    EXPECT_EQ(1, subnet->getID());
}

733
734
/// The goal of this test is to verify if defined subnet uses global
/// parameter timer definitions.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
735
TEST_F(Dhcp4ParserTest, subnetGlobalDefaults) {
736

737
    string config = "{ " + genIfaceConfig() + "," +
738
739
740
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
741
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
742
743
744
        "    \"subnet\": \"192.0.2.0/24\" } ],"
        "\"valid-lifetime\": 4000 }";

745
746
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
747
    extractConfig(config);
748

749
    ConstElementPtr status;
750
751
752
    EXPECT_NO_THROW(status = configureDhcp4Server(*srv_, json));

    // check if returned status is OK
Tomek Mrugalski's avatar
Tomek Mrugalski committed
753
    checkResult(status, 0);
754
755
756

    // Now check if the configuration was indeed handled and we have
    // expected pool configured.
757
    Subnet4Ptr subnet = CfgMgr::instance().getStagingCfg()->
758
        getCfgSubnets4()->selectSubnet(IOAddress("192.0.2.200"));
759
760
761
762
    ASSERT_TRUE(subnet);
    EXPECT_EQ(1000, subnet->getT1());
    EXPECT_EQ(2000, subnet->getT2());
    EXPECT_EQ(4000, subnet->getValid());
763
764
765

    // Check that subnet-id is 1
    EXPECT_EQ(1, subnet->getID());
766
767
}

768
769
770
771
772
// Goal of this test is to verify that multiple subnets get unique
// subnet-ids. Also, test checks that it's possible to do reconfiguration
// multiple times.
TEST_F(Dhcp4ParserTest, multipleSubnets) {
    ConstElementPtr x;
773
774
    // Collection of four subnets for which subnet ids should be
    // autogenerated - ids are unspecified or set to 0.
775
    string config = "{ " + genIfaceConfig() + "," +
776
777
778
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
779
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
780
781
782
        "    \"subnet\": \"192.0.2.0/24\" "
        " },"
        " {"
783
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
784
785
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 0 "
786
787
        " },"
        " {"
788
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
789
790
791
        "    \"subnet\": \"192.0.4.0/24\" "
        " },"
        " {"
792
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
793
794
795
796
        "    \"subnet\": \"192.0.5.0/24\" "
        " } ],"
        "\"valid-lifetime\": 4000 }";

797
798
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
799
    extractConfig(config);
800
801
802
803
804

    int cnt = 0; // Number of reconfigurations

    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
805
        checkResult(x, 0);
806

807
808
809
810
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
        ASSERT_TRUE(subnets);
        ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

        // Check subnet-ids of each subnet (it should be monotonously increasing)
        EXPECT_EQ(1, subnets->at(0)->getID());
        EXPECT_EQ(2, subnets->at(1)->getID());
        EXPECT_EQ(3, subnets->at(2)->getID());
        EXPECT_EQ(4, subnets->at(3)->getID());

        // Repeat reconfiguration process 10 times and check that the subnet-id
        // is set to the same value. Technically, just two iterations would be
        // sufficient, but it's nice to have a test that exercises reconfiguration
        // a bit.
    } while (++cnt < 10);
}

827
828
829
// This test checks that it is possible to assign arbitrary ids for subnets.
TEST_F(Dhcp4ParserTest, multipleSubnetsExplicitIDs) {
    ConstElementPtr x;
830
    // Four subnets with arbitrary subnet ids.
831
    string config = "{ " + genIfaceConfig() + "," +
832
833
834
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
835
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
836
837
838
839
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
840
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
841
842
843
844
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
845
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
846
847
848
849
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1 "
        " },"
        " {"
850
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
851
852
853
854
855
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

856
857
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
858
    extractConfig(config);
859
860
861
862

    int cnt = 0; // Number of reconfigurations
    do {
        EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
863
        checkResult(x, 0);
864

865
866
867
868
        CfgMgr::instance().commit();

        const Subnet4Collection* subnets =
            CfgMgr::instance().getCurrentCfg()->getCfgSubnets4()->getAll();
869
870
871
872
873
874
875
876
877
878
879
        ASSERT_TRUE(subnets);
        ASSERT_EQ(4, subnets->size()); // We expect 4 subnets

        // Verify that subnet ids are as expected.
        EXPECT_EQ(1024, subnets->at(0)->getID());
        EXPECT_EQ(100, subnets->at(1)->getID());
        EXPECT_EQ(1, subnets->at(2)->getID());
        EXPECT_EQ(34, subnets->at(3)->getID());

        // Repeat reconfiguration process 10 times and check that the subnet-id
        // is set to the same value.
880
    } while (++cnt < 3);
881
882
883
}

// Check that the configuration with two subnets having the same id is rejected.
Josh Soref's avatar
Josh Soref committed
884
TEST_F(Dhcp4ParserTest, multipleSubnetsOverlappingIDs) {
885
    ConstElementPtr x;
886
    // Four subnets, two of them having the same id.
887
    string config = "{ " + genIfaceConfig() + "," +
888
889
890
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
891
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
892
893
894
895
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
896
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
897
898
899
900
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 100 "
        " },"
        " {"
901
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
902
903
904
905
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 1024 "
        " },"
        " {"
906
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
907
908
909
910
911
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 34 "
        " } ],"
        "\"valid-lifetime\": 4000 }";

912
913
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config));
914
915

    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
916
    checkResult(x, 1);
917
    EXPECT_TRUE(errorContainsPosition(x, "<string>"));
918
919
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
920
921
922
923
924
925
// Goal of this test is to verify that a previously configured subnet can be
// deleted in subsequent reconfiguration.
TEST_F(Dhcp4ParserTest, reconfigureRemoveSubnet) {
    ConstElementPtr x;

    // All four subnets
926
    string config4 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
927
928
929
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
930
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
931
932
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
933
934
        " },"
        " {"
935
        "    \"pools\": [ { \"pool\": \"192.0.3.101 - 192.0.3.150\" } ],"
936
937
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
938
939
        " },"
        " {"
940
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
941
942
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
943
944
        " },"
        " {"
945
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
946
947
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
948
949
950
951
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Three subnets (the last one removed)
952
    string config_first3 = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
953
954
955
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
956
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
957
958
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
959
960
        " },"
        " {"
961
        "    \"pools\": [ { \"pool\":  \"192.0.3.101 - 192.0.3.150\" } ],"
962
963
        "    \"subnet\": \"192.0.3.0/24\", "
        "    \"id\": 2 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
964
965
        " },"
        " {"
966
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
967
968
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
969
970
971
972
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // Second subnet removed
973
    string config_second_removed = "{ " + genIfaceConfig() + "," +
Tomek Mrugalski's avatar
Tomek Mrugalski committed
974
975
976
        "\"rebind-timer\": 2000, "
        "\"renew-timer\": 1000, "
        "\"subnet4\": [ { "
977
        "    \"pools\": [ { \"pool\": \"192.0.2.1 - 192.0.2.100\" } ],"
978
979
        "    \"subnet\": \"192.0.2.0/24\", "
        "    \"id\": 1 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
980
981
        " },"
        " {"
982
        "    \"pools\": [ { \"pool\": \"192.0.4.101 - 192.0.4.150\" } ],"
983
984
        "    \"subnet\": \"192.0.4.0/24\", "
        "    \"id\": 3 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
985
986
        " },"
        " {"
987
        "    \"pools\": [ { \"pool\": \"192.0.5.101 - 192.0.5.150\" } ],"
988
989
        "    \"subnet\": \"192.0.5.0/24\", "
        "    \"id\": 4 "
Tomek Mrugalski's avatar
Tomek Mrugalski committed
990
991
992
993
994
995
        " } ],"
        "\"valid-lifetime\": 4000 }";

    // CASE 1: Configure 4 subnets, then reconfigure and remove the
    // last one.

996
997
    ConstElementPtr json;
    ASSERT_NO_THROW(json = parseDHCP4(config4));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
998
    EXPECT_NO_THROW(x = configureDhcp4Server(*srv_, json));
999
    checkResult(x, 0);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1000