[#4014] Core and UT for v6 option class-tags

Changes to be committed:
modified:   doc/sphinx/arm/hooks-cb-cmds.rst
modified:   src/hooks/dhcp/mysql/mysql_cb_dhcp6.cc
modified:   src/hooks/dhcp/mysql/mysql_cb_dhcp6.h
modified:   src/hooks/dhcp/mysql/mysql_cb_impl.cc
modified:   src/hooks/dhcp/mysql/tests/mysql_cb_dhcp6_unittest.cc
modified:   src/hooks/dhcp/pgsql/pgsql_cb_dhcp6.cc
modified:   src/hooks/dhcp/pgsql/pgsql_cb_dhcp6.h
modified:   src/hooks/dhcp/pgsql/pgsql_cb_impl.cc
modified:   src/hooks/dhcp/pgsql/tests/pgsql_cb_dhcp6_unittest.cc
modified:   src/lib/dhcpsrv/config_backend_dhcp6.h
modified:   src/lib/dhcpsrv/config_backend_pool_dhcp6.cc
modified:   src/lib/dhcpsrv/config_backend_pool_dhcp6.h
modified:   src/lib/dhcpsrv/testutils/generic_cb_dhcp4_unittest.h
modified:   src/lib/dhcpsrv/testutils/generic_cb_dhcp6_unittest.cc
modified:   src/lib/dhcpsrv/testutils/generic_cb_dhcp6_unittest.h
modified:   src/lib/dhcpsrv/testutils/test_config_backend_dhcp4.cc
modified:   src/lib/dhcpsrv/testutils/test_config_backend_dhcp4.h
modified:   src/lib/dhcpsrv/testutils/test_config_backend_dhcp6.cc
modified:   src/lib/dhcpsrv/testutils/test_config_backend_dhcp6.h
modified:   src/share/api/remote-option4-global-del.json
modified:   src/share/api/remote-option4-global-get.json
modified:   src/share/api/remote-option4-global-set.json
modified:   src/share/api/remote-option4-network-del.json
modified:   src/share/api/remote-option4-network-set.json
modified:   src/share/api/remote-option4-pool-del.json
modified:   src/share/api/remote-option4-pool-set.json
modified:   src/share/api/remote-option4-subnet-del.json
modified:   src/share/api/remote-option4-subnet-set.json
modified:   src/share/api/remote-option6-global-del.json
modified:   src/share/api/remote-option6-global-get.json
modified:   src/share/api/remote-option6-global-set.json
modified:   src/share/api/remote-option6-network-del.json
modified:   src/share/api/remote-option6-network-set.json
modified:   src/share/api/remote-option6-pd-pool-del.json
modified:   src/share/api/remote-option6-pd-pool-set.json
modified:   src/share/api/remote-option6-pool-del.json
modified:   src/share/api/remote-option6-pool-set.json
modified:   src/share/api/remote-option6-subnet-del.json

Author: tmarkwalder

doc/sphinx/arm/hooks-cb-cmds.rst

@@ -170,9 +170,9 @@ data content.
 In order to support this construct, Kea uses the option's ``client-classes``
 list in addition to code and space to uniquely identifiy each option. This
 is important to keep in mind when using the Management API to alter your
-configuration. As of Kea 3.1 (applies to DHCPv4 commands only), commands which
-get, set, or delete an individual option now accept an optional ``client-classes``
-parameter in addition to ``code`` and ``space`` parameters.
+configuration. As of Kea 3.1.1 commands which get, set, or delete an
+individual option now accept an optional ``client-classes`` parameter in
+addition to ``code`` and ``space`` parameters.
 
 If the ``client-classes`` parameter is omitted:
 
@@ -1145,7 +1145,7 @@ The ``remote-option4-global-del``, ``remote-option6-global-del`` Commands
 
 These commands are used to delete a global DHCP option from the
 database. The option is identified by an option code and option space.
-As of Kea 3.1, an optional ``client-classes`` parameter may also be
+As of Kea 3.1.1 an optional ``client-classes`` parameter may also be
 specified (see :ref:`cb-cmds-option-class-tags-as-keys`).
 
 For example:
@@ -1191,7 +1191,7 @@ These commands are used to fetch a global DHCP option from the database.
 The option is identified by the code and option space. The top-level
 option spaces where DHCP standard options belong are called "dhcp4" and
 "dhcp6" for the DHCPv4 and DHCPv6 servers, respectively.
-As of Kea 3.1, an optional ``client-classes`` parameter may also be
+As of Kea 3.1.1, an optional ``client-classes`` parameter may also be
 specified (see :ref:`cb-cmds-option-class-tags-as-keys`).
 
 The following command retrieves the IPv6 "DNS Servers" (code 23) option
@@ -1343,7 +1343,7 @@ The ``remote-option4-network-del``, ``remote-option6-network-del`` Commands
 
 These commands are used to delete a shared-network-specific DHCP
 option from the database. The option is identified by an option code
-and option space and as of Kea 3.1, an optional ``client-classes``
+and option space and as of Kea 3.1.1, an optional ``client-classes``
 parameter may also be specified (see :ref:`cb-cmds-option-class-tags-as-keys`).
 These parameters are passed within the ``options`` list.
 Another list, ``shared-networks``, contains a map
@@ -1532,7 +1532,7 @@ The ``remote-option4-pool-del``, ``remote-option6-pool-del`` Commands
 
 These commands are used to delete an address-pool-specific DHCP
 option from the database. The option is identified by an option code
-and option space, and as of Kea 3.1, an optional ``client-classes`` parameter
+and option space, and as of Kea 3.1.1, an optional ``client-classes`` parameter
 may also be specified (see :ref:`cb-cmds-option-class-tags-as-keys`).
 These parameters are passed within the ``options`` list.
 Another list, ``pools``, contains a map with the
@@ -1631,7 +1631,7 @@ The ``remote-option4-subnet-del``, ``remote-option6-subnet-del`` Commands
 
 These commands are used to delete a subnet-specific DHCP option
 from the database. The option is identified by an option code
-and option space, and, as of Kea 3.1, an optional ``client-casses``
+and option space, and, as of Kea 3.1.1, an optional ``client-casses``
 parameter (see :ref:`cb-cmds-option-class-tags-as-keys`).
 These parameters are passed within the ``options`` list.
 Another list, ``subnets``, contains a map with the

src/hooks/dhcp/mysql/mysql_cb_dhcp6.cc

@@ -146,12 +146,17 @@ class MySqlConfigBackendDHCPv6 : public ConfigBackendDHCPv6 {
     /// @brief Retrieves single option by code and space.
     ///
     /// @param server_selector Server selector.
+    /// @param code code of the option to be deleted.
+    /// @param space option space of the option to be deleted.
+    /// @param client_classes Optional client classes list of the option to be deleted.
+    /// Defaults to an empty pointer.
     /// @return Pointer to the retrieved option descriptor or null if
     /// no option was found.
     /// @throw NotImplemented if server selector is "unassigned".
     virtual OptionDescriptorPtr
     getOption6(const db::ServerSelector& server_selector, const uint16_t code,
-               const std::string& space) const;
+               const std::string& space,
+               const ClientClassesPtr client_classes = ClientClassesPtr()) const;
 
     /// @brief Retrieves all global options.
     ///
@@ -479,11 +484,14 @@ class MySqlConfigBackendDHCPv6 : public ConfigBackendDHCPv6 {
     /// @param server_selector Server selector.
     /// @param code Code of the option to be deleted.
     /// @param space Option space of the option to be deleted.
+    /// @param client_classes Optional client classes list of the option to be deleted.
+    /// Defaults to an empty pointer.
     /// @return Number of deleted options.
     /// @throw NotImplemented if server selector is "unassigned".
     virtual uint64_t
     deleteOption6(const db::ServerSelector& server_selector, const uint16_t code,
-                  const std::string& space);
+                  const std::string& space,
+                  const ClientClassesPtr client_classes = ClientClassesPtr());
 
     /// @brief Deletes shared network level option.
     ///
@@ -492,12 +500,16 @@ class MySqlConfigBackendDHCPv6 : public ConfigBackendDHCPv6 {
     /// option belongs to
     /// @param code Code of the deleted option.
     /// @param space Option space of the deleted option.
+    /// @param client_classes Optional client classes list of the option to be deleted.
+    /// Defaults to an empty pointer.
+    /// @return Number of deleted options.
     /// @throw NotImplemented if server selector is "unassigned".
     virtual uint64_t
     deleteOption6(const db::ServerSelector& server_selector,
                   const std::string& shared_network_name,
                   const uint16_t code,
-                  const std::string& space);
+                  const std::string& space,
+                  const ClientClassesPtr client_classes = ClientClassesPtr());
 
     /// @brief Deletes subnet level option.
     ///
@@ -506,11 +518,16 @@ class MySqlConfigBackendDHCPv6 : public ConfigBackendDHCPv6 {
     /// belongs.
     /// @param code Code of the deleted option.
     /// @param space Option space of the deleted option.
+    /// @param client_classes Optional client classes list of the option to be deleted.
+    /// Defaults to an empty pointer.
     /// @return Number of deleted options.
     /// @throw NotImplemented if server selector is "unassigned".
     virtual uint64_t
-    deleteOption6(const db::ServerSelector& server_selector, const SubnetID& subnet_id,
-                  const uint16_t code, const std::string& space);
+    deleteOption6(const db::ServerSelector& server_selector,
+                  const SubnetID& subnet_id,
+                  const uint16_t code,
+                  const std::string& space,
+                  const ClientClassesPtr client_classes = ClientClassesPtr());
 
     /// @brief Deletes pool level option.
     ///
@@ -521,14 +538,17 @@ class MySqlConfigBackendDHCPv6 : public ConfigBackendDHCPv6 {
     /// deleted option belongs.
     /// @param code Code of the deleted option.
     /// @param space Option space of the deleted option.
+    /// @param client_classes Optional client classes list of the option to be deleted.
+    /// Defaults to an empty pointer.
     /// @return Number of deleted options.
     /// @throw NotImplemented if server selector is "unassigned".
     virtual uint64_t
     deleteOption6(const db::ServerSelector& server_selector,
                   const asiolink::IOAddress& pool_start_address,
                   const asiolink::IOAddress& pool_end_address,
                   const uint16_t code,
-                  const std::string& space);
+                  const std::string& space,
+                  const ClientClassesPtr client_classes = ClientClassesPtr());
 
     /// @brief Deletes prefix delegation pool level option.
     ///
@@ -539,14 +559,17 @@ class MySqlConfigBackendDHCPv6 : public ConfigBackendDHCPv6 {
     /// delegation pool to which the deleted option belongs.
     /// @param code Code of the deleted option.
     /// @param space Option space of the deleted option.
+    /// @param client_classes Optional client classes list of the option to be deleted.
+    /// Defaults to an empty pointer.
     /// @return Number of deleted options.
     /// @throw NotImplemented if server selector is "unassigned".
     virtual uint64_t
     deleteOption6(const db::ServerSelector& server_selector,
                   const asiolink::IOAddress& pd_pool_prefix,
                   const uint8_t pd_pool_prefix_length,
                   const uint16_t code,
-                  const std::string& space);
+                  const std::string& space,
+                  const ClientClassesPtr client_classes = ClientClassesPtr());
 
     /// @brief Deletes global parameter.
     ///

src/hooks/dhcp/mysql/mysql_cb_dhcp6.h

@@ -580,11 +580,8 @@ MySqlConfigBackendImpl::getOption(const int index,
         in_bindings.push_back(MySqlBinding::createInteger<uint16_t>(code));
     }
     in_bindings.push_back(MySqlBinding::createString(space));
+    in_bindings.push_back(createClientClassesForWhereClause(client_classes));
 
-    /// @todo TKM Remove the if when v6 is ready.
-    if (universe == Option::V4) {
-        in_bindings.push_back(createClientClassesForWhereClause(client_classes));
-    }
     getOptions(index, in_bindings, universe, options);
     return (options.empty() ? OptionDescriptorPtr() :
             OptionDescriptor::create(*options.begin()));

src/hooks/dhcp/mysql/mysql_cb_impl.cc

@@ -335,6 +335,14 @@ TEST_F(MySqlConfigBackendDHCPv6Test, getModifiedOptionDefs6Test) {
     getModifiedOptionDefs6Test();
 }
 
+TEST_F(MySqlConfigBackendDHCPv6Test, globalOption6WithClientClassesTest) {
+    globalOption6WithClientClassesTest();
+}
+
+TEST_F(MySqlConfigBackendDHCPv6Test, getAllOptions6WithClientClassesTest) {
+    getAllOptions6WithClientClassesTest();
+}
+
 TEST_F(MySqlConfigBackendDHCPv6Test, createUpdateDeleteOption6Test) {
     createUpdateDeleteOption6Test();
 }
@@ -407,6 +415,22 @@ TEST_F(MySqlConfigBackendDHCPv6Test, multipleAuditEntriesTest) {
     multipleAuditEntriesTest();
 }
 
+TEST_F(MySqlConfigBackendDHCPv6Test, sharedNetworkOption6WithClientClassesTest) {
+    sharedNetworkOption6WithClientClassesTest();
+}
+
+TEST_F(MySqlConfigBackendDHCPv6Test, subnetOption6WithClientClassesTest) {
+    subnetOption6WithClientClassesTest();
+}
+
+TEST_F(MySqlConfigBackendDHCPv6Test, poolOption6WithClientClassesTest) {
+    poolOption6WithClientClassesTest();
+}
+
+TEST_F(MySqlConfigBackendDHCPv6Test, pdPoolOption6WithClientClassesTest) {
+    pdPoolOption6WithClientClassesTest();
+}
+
 /// @brief Test fixture for verifying database connection loss-recovery
 /// behavior.
 class MySqlConfigBackendDHCPv6DbLostCallbackTest : public GenericConfigBackendDbLostCallbackTest {