[#1415] Moved address range to common place

Author: msiodelski

src/lib/dhcpsrv/Makefile.am

@@ -63,6 +63,7 @@ CLEANFILES += *.csv
 
 lib_LTLIBRARIES = libkea-dhcpsrv.la
 libkea_dhcpsrv_la_SOURCES  =
+libkea_dhcpsrv_la_SOURCES += address_range.h address_range.cc
 libkea_dhcpsrv_la_SOURCES += alloc_engine.cc alloc_engine.h
 libkea_dhcpsrv_la_SOURCES += alloc_engine_log.cc alloc_engine_log.h
 libkea_dhcpsrv_la_SOURCES += alloc_engine_messages.h alloc_engine_messages.cc

src/lib/dhcpsrv/address_range.cc

@@ -0,0 +1,31 @@
+// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
+//
+// 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/.
+
+#include <config.h>
+#include <asiolink/io_address.h>
+#include <dhcpsrv/address_range.h>
+#include <exceptions/exceptions.h>
+
+using namespace isc::asiolink;
+
+namespace isc {
+namespace dhcp {
+
+AddressRange::AddressRange(const IOAddress& start, const IOAddress& end)
+    : start_(start), end_(end) {
+    // The start must be lower or equal the end.
+    if (end_ < start_) {
+        isc_throw(BadValue, "invalid address range boundaries " << start_ << ":" << end_);
+    }
+    // Two IPv4 or two IPv6 addresses are expected as range boundaries.
+    if (start_.getFamily() != end_.getFamily()) {
+        isc_throw(BadValue, "address range boundaries must have the same type: " << start_
+                  << ":" << end_);
+    }
+}
+
+} // end of namespace isc::dhcp
+} // end of namespace isc

src/lib/dhcpsrv/address_range.h

@@ -0,0 +1,34 @@
+// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
+//
+// 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/.
+
+#ifndef ADDRESS_RANGE_H
+#define ADDRESS_RANGE_H
+
+#include <asiolink/io_address.h>
+
+namespace isc {
+namespace dhcp {
+
+/// @brief Structure representing IP address range.
+struct AddressRange {
+    /// IP address denoting the start of the address range.
+    asiolink::IOAddress start_;
+    /// IP address denoting the end of the address range.
+    asiolink::IOAddress end_;
+
+    /// @brief Constructor.
+    ///
+    /// @param start beginning of the address range.
+    /// @param end end of the address range.
+    /// @throw BadValue if the @c start is greater than the end or
+    /// specified boundaries do not belong to the same family.
+    AddressRange(const asiolink::IOAddress& start, const asiolink::IOAddress& end);
+};
+
+} // end of namespace isc::dhcp
+} // end of namespace isc
+
+#endif // ADDRESS_RANGE_H

src/lib/dhcpsrv/free_lease_queue.cc

@@ -20,19 +20,6 @@ using namespace isc::asiolink;
 namespace isc {
 namespace dhcp {
 
-FreeLeaseQueue::Range::Range(const IOAddress& start, const IOAddress& end)
-    : start_(start), end_(end) {
-    // The start must be lower or equal the end.
-    if (end_ < start_) {
-        isc_throw(BadValue, "invalid address range boundaries " << start_ << ":" << end_);
-    }
-    // Two IPv4 or two IPv6 addresses are expected as range boundaries.
-    if (start_.getFamily() != end_.getFamily()) {
-        isc_throw(BadValue, "address range boundaries must have the same type: " << start_
-                  << ":" << end_);
-    }
-}
-
 FreeLeaseQueue::FreeLeaseQueue()
     : containers_() {
 }

src/lib/dhcpsrv/free_lease_queue.h

@@ -8,6 +8,7 @@
 #define FREE_LEASE_QUEUE_H
 
 #include <asiolink/io_address.h>
+#include <dhcpsrv/address_range.h>
 
 #include <boost/multi_index_container.hpp>
 #include <boost/multi_index/hashed_index.hpp>
@@ -74,20 +75,7 @@ class FreeLeaseQueue {
 public:
 
     /// @brief Structure representing address range in the @c FreeLeaseQueue.
-    struct Range {
-        /// IP address denoting the start of the address range.
-        asiolink::IOAddress start_;
-        /// IP address denoting the end of the address range.
-        asiolink::IOAddress end_;
-
-        /// @brief Constructor.
-        ///
-        /// @param start beginning of the address range.
-        /// @param end end of the address range.
-        /// @throw BadValue if the @c start is greater than the end or
-        /// specified boundaries do not belong to the same family.
-        Range(const asiolink::IOAddress& start, const asiolink::IOAddress& end);
-    };
+    typedef AddressRange Range;
 
     /// @brief Constructor.
     FreeLeaseQueue();

src/lib/dhcpsrv/tests/Makefile.am

@@ -57,6 +57,7 @@ libco3_la_LDFLAGS = -avoid-version -export-dynamic -module -rpath /nowhere
 TESTS += libdhcpsrv_unittests
 
 libdhcpsrv_unittests_SOURCES  = run_unittests.cc
+libdhcpsrv_unittests_SOURCES += address_range_unittest.cc
 libdhcpsrv_unittests_SOURCES += alloc_engine_utils.cc alloc_engine_utils.h
 libdhcpsrv_unittests_SOURCES += alloc_engine_expiration_unittest.cc
 libdhcpsrv_unittests_SOURCES += alloc_engine_hooks_unittest.cc

src/lib/dhcpsrv/tests/address_range_unittest.cc

@@ -0,0 +1,32 @@
+// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
+//
+// 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/.
+
+#include <config.h>
+#include <dhcpsrv/address_range.h>
+
+#include <gtest/gtest.h>
+
+using namespace isc;
+using namespace isc::asiolink;
+using namespace isc::dhcp;
+
+namespace {
+
+// This test verifies that an exception is thrown upon an attempt to
+// create an address range from invalid values and that no exception
+// is thrown when the values are correct.
+TEST(AddressRangeTest, constructorWithInvalidValues) {
+    // The start address must be lower or equal the end address.
+    EXPECT_THROW(AddressRange(IOAddress("192.0.2.100"), IOAddress("192.0.2.99")),
+                 BadValue);
+    // The start and end address must be of the same family.
+    EXPECT_THROW(AddressRange(IOAddress("192.0.2.100"), IOAddress("2001:db8:1::1")),
+                 BadValue);
+    // It is allowed to create address range with a single IP address.
+    EXPECT_NO_THROW(AddressRange(IOAddress("192.0.2.100"), IOAddress("192.0.2.100")));
+}
+
+} // end of anonymous namespace