sys/net/application_layer/sock_dns: add pseudomodule for mocking

RIOT-OS · Mar 26, 2022 · 5d63635 · 5d63635
1 parent a20d8f6
commit 5d63635
Show file tree

Hide file tree

Showing 7 changed files with 78 additions and 70 deletions.
diff --git a/makefiles/pseudomodules.inc.mk b/makefiles/pseudomodules.inc.mk
@@ -204,6 +204,7 @@ PSEUDOMODULES += sock_async
 PSEUDOMODULES += sock_aux_local
 PSEUDOMODULES += sock_aux_rssi
 PSEUDOMODULES += sock_aux_timestamp
+PSEUDOMODULES += sock_dns_mock
 PSEUDOMODULES += sock_dtls
 PSEUDOMODULES += sock_ip
 PSEUDOMODULES += sock_tcp

diff --git a/sys/Makefile.dep b/sys/Makefile.dep
@@ -570,6 +570,10 @@ ifneq (,$(filter sock_async,$(USEMODULE)))
   endif
 endif
 
+ifneq (,$(filter sock_dns_mock,$(USEMODULE)))
+  USEMODULE += sock_dns
+endif
+
 ifneq (,$(filter sock_dns,$(USEMODULE)))
   USEMODULE += dns_msg
   USEMODULE += sock_udp

diff --git a/sys/include/net/dns.h b/sys/include/net/dns.h
@@ -16,10 +16,13 @@
  * @brief   Generic DNS values
  *
  * @author  Martine Lenders <m.lenders@fu-berlin.de>
+ * @author  Hendrik van Essen <hendrik.ve@fu-berlin.de>
  */
 #ifndef NET_DNS_H
 #define NET_DNS_H
 
+#include "kernel_defines.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -43,6 +46,46 @@ extern "C" {
 #define RR_RDLENGTH_LENGTH  (2U)
 /** @} */
 
+#if IS_USED(MODULE_SOCK_DNS_MOCK) || DOXYGEN
+
+/**
+ * @brief Hostname used to query when using sock_dns_mock
+ */
+#define SOCK_DNS_MOCK_EXAMPLE_COM_HOSTNAME "example.com"
+
+/**
+ * @brief IPv4 string related to the hostname when using sock_dns_mock
+ *
+ * @see @ref SOCK_DNS_MOCK_EXAMPLE_COM_HOSTNAME
+ */
+#define SOCK_DNS_MOCK_EXAMPLE_COM_IPV4_STRING "93.184.216.34"
+
+/**
+ * @brief IPv6 string related to the hostname when using sock_dns_mock
+ *
+ * @see @ref SOCK_DNS_MOCK_EXAMPLE_COM_HOSTNAME
+ */
+#define SOCK_DNS_MOCK_EXAMPLE_COM_IPV6_STRING "2606:2800:220:1:248:1893:25c8:1946"
+
+/**
+ * @brief ipv4_addr_t matching the IPv4 string when using sock_dns_mock
+ *
+ * @see @ref SOCK_DNS_MOCK_EXAMPLE_COM_IPV4_STRING
+ */
+static const ipv4_addr_t sock_dns_mock_example_com_addr_ipv4 = { { 0x5d, 0xb8, 0xd8, 0x22 } };
+
+/**
+ * @brief ipv6_addr_t matching the IPv6 string when using sock_dns_mock
+ *
+ * @see @ref SOCK_DNS_MOCK_EXAMPLE_COM_IPV6_STRING
+ */
+static const ipv6_addr_t sock_dns_mock_example_com_addr_ipv6 = { {
+        0x26, 0x06, 0x28, 0x00, 0x02, 0x20, 0x00, 0x01,
+        0x02, 0x48, 0x18, 0x93, 0x25, 0xc8, 0x19, 0x46
+    }
+};
+#endif /* IS_USED(MODULE_SOCK_DNS_MOCK)|| DOXYGEN */
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/sys/net/application_layer/sock_dns/dns.c b/sys/net/application_layer/sock_dns/dns.c
@@ -13,6 +13,7 @@
  * @brief   sock DNS client implementation
  * @author  Kaspar Schleiser <kaspar@schleiser.de>
  * @author  Hendrik van Essen <hendrik.ve@fu-berlin.de>
+ * @author  Benjamin Valentin <benjamin.valentin@ml-pa.com>
  * @}
  */
 
@@ -21,8 +22,11 @@
 
 #include <arpa/inet.h>
 
+#include "net/af.h"
 #include "net/dns.h"
 #include "net/dns/msg.h"
+#include "net/ipv4/addr.h"
+#include "net/ipv6/addr.h"
 #include "net/sock/udp.h"
 #include "net/sock/dns.h"
 
@@ -67,6 +71,25 @@ void auto_init_sock_dns(void)
 
 int sock_dns_query(const char *domain_name, void *addr_out, int family)
 {
+#ifdef MODULE_SOCK_DNS_MOCK
+    if (strcmp(domain_name, SOCK_DNS_MOCK_EXAMPLE_COM_HOSTNAME)) {
+        return -ENOTSUP;
+    }
+
+    switch (family) {
+    case AF_INET:
+        memcpy(addr_out, &sock_dns_mock_example_com_addr_ipv4, sizeof(ipv4_addr_t));
+        return sizeof(ipv4_addr_t);
+
+    case AF_UNSPEC:
+        /* fall-through */
+    case AF_INET6:
+        memcpy(addr_out, &sock_dns_mock_example_com_addr_ipv6, sizeof(ipv6_addr_t));
+        return sizeof(ipv6_addr_t);
+    default:
+        return -EAFNOSUPPORT;
+    }
+#else
     static uint8_t dns_buf[CONFIG_DNS_MSG_LEN];
 
     if (sock_dns_server.port == 0) {
@@ -109,4 +132,5 @@ int sock_dns_query(const char *domain_name, void *addr_out, int family)
 out:
     sock_udp_close(&sock_dns);
     return res;
+#endif /* MODULE_SOCK_DNS_MOCK */
 }
diff --git a/tests/netutils/Makefile b/tests/netutils/Makefile
@@ -12,7 +12,6 @@ USEMODULE += gnrc_ipv6
 USEMODULE += ipv4_addr
 USEMODULE += ipv6_addr
 
-# pretend to include sock_dns
-CFLAGS += -DMODULE_SOCK_DNS=1
+USEMODULE += sock_dns_mock
 
 include $(RIOTBASE)/Makefile.include
diff --git a/tests/netutils/main.c b/tests/netutils/main.c
@@ -18,6 +18,7 @@
 
 #include "embUnit.h"
 
+#include "net/dns.h"
 #include "net/gnrc/netif.h"
 #include "net/sock/util.h"
 #include "net/utils.h"
@@ -101,16 +102,11 @@ static void test_ipv6_addr_from_str__invalid_interface(void)
 
 static void test_ipv6_addr_from_str__success4(void)
 {
-    static const ipv6_addr_t a = { {
-            0x26, 0x06, 0x28, 0x00, 0x02, 0x20, 0x00, 0x01,
-            0x02, 0x48, 0x18, 0x93, 0x25, 0xc8, 0x19, 0x46
-        }
-    };
     ipv6_addr_t address;
     netif_t *netif;
 
-    TEST_ASSERT_EQUAL_INT(netutils_get_ipv6(&address, &netif, "example.com"), 0);
-    TEST_ASSERT(ipv6_addr_equal(&a, &address));
+    TEST_ASSERT_EQUAL_INT(netutils_get_ipv6(&address, &netif, SOCK_DNS_MOCK_EXAMPLE_COM_HOSTNAME), 0);
+    TEST_ASSERT(ipv6_addr_equal(&sock_dns_mock_example_com_addr_ipv6, &address));
 }
 
 static void test_ipv6_addr_from_str__success5(void)
@@ -164,11 +160,10 @@ static void test_ipv4_addr_from_str__success(void)
 
 static void test_ipv4_addr_from_str__success2(void)
 {
-    static const ipv4_addr_t a = { { 0x5d, 0xb8, 0xd8, 0x22 } };
     ipv4_addr_t address;
 
-    TEST_ASSERT_EQUAL_INT(netutils_get_ipv4(&address, "example.com"), 0);
-    TEST_ASSERT(ipv4_addr_equal(&a, &address));
+    TEST_ASSERT_EQUAL_INT(netutils_get_ipv4(&address, SOCK_DNS_MOCK_EXAMPLE_COM_HOSTNAME), 0);
+    TEST_ASSERT(ipv4_addr_equal(&sock_dns_mock_example_com_addr_ipv4, &address));
 }
 
 Test *tests_netutils_ipv4_tests(void)

diff --git a/tests/netutils/mock_dns.c b/tests/netutils/mock_dns.c