tests: net: http_service: verify service and resource macros

Add tests to verify the newly-added HTTP service and resource
macros.

Signed-off-by: Chris Friedt <cfriedt@meta.com>

tests/net/lib/http_server/common/CMakeLists.txt

@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(http_service_defines)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})
+
+zephyr_linker_sources(SECTIONS sections-rom.ld)

tests/net/lib/http_server/common/prj.conf

@@ -0,0 +1,14 @@
+CONFIG_ZTEST=y
+CONFIG_ZTEST_NEW_API=y
+
+CONFIG_NETWORKING=y
+CONFIG_NET_TEST=y
+CONFIG_ENTROPY_GENERATOR=y
+CONFIG_TEST_RANDOM_GENERATOR=y
+CONFIG_ZTEST_STACK_SIZE=1024
+
+CONFIG_HTTP_SERVER=y
+
+CONFIG_NO_OPTIMIZATIONS=y
+CONFIG_DEBUG_INFO=y
+CONFIG_DEBUG=y

tests/net/lib/http_server/common/sections-rom.ld

@@ -0,0 +1,2 @@
+ITERABLE_SECTION_ROM(http_resource_desc_service_A, 4)
+ITERABLE_SECTION_ROM(http_resource_desc_service_B, 4)

tests/net/lib/http_server/common/src/main.c

@@ -0,0 +1,258 @@
+/*
+ * Copyright (c) 2023 Meta
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <string.h>
+
+#include <zephyr/ztest.h>
+#include <zephyr/net/http/service.h>
+
+#define DETAIL(n) (void *)((0xde7a11 * 10) + (n))
+#define RES(n)	  (void *)((0x2e5 * 10) + (n))
+
+/*
+ * Two separate HTTP server instances (A and B), each with different static
+ * resources, listening on different ports. Static resources could be, for
+ * example, gzip compressed html, javascript, css, or image files which
+ * have fixed paths known at build time.
+ *
+ * REST endpoints could be considered as another static resource, as long as
+ * the path and handler files are known at compile time.
+ */
+static const uint16_t service_A_port = 4242;
+HTTP_SERVICE_DEFINE(service_A, "a.service.com", &service_A_port, 4, 2, DETAIL(0));
+HTTP_RESOURCE_DEFINE(resource_0, service_A, "/", RES(0));
+HTTP_RESOURCE_DEFINE(resource_1, service_A, "/index.html", RES(1));
+
+/* ephemeral port of 0 */
+static uint16_t service_B_port;
+HTTP_SERVICE_DEFINE(service_B, "b.service.com", &service_B_port, 7, 3, DETAIL(1));
+HTTP_RESOURCE_DEFINE(resource_2, service_B, "/foo.htm", RES(2));
+HTTP_RESOURCE_DEFINE(resource_3, service_B, "/bar/baz.php", RES(3));
+
+/*
+ * An "empty" HTTP service is one without static resources. For example, a
+ * service which loads a configuration file from the filesystem and loads
+ * resources that from a filesystem that are determined at runtime.
+ */
+static const uint16_t service_C_port = 5959;
+HTTP_SERVICE_DEFINE_EMPTY(service_C, "192.168.1.1", &service_C_port, 5, 9, DETAIL(2));
+
+ZTEST(http_service, test_HTTP_SERVICE_DEFINE)
+{
+	zassert_ok(strcmp(service_A.host, "a.service.com"));
+	zassert_equal(service_A.port, &service_A_port);
+	zassert_equal(*service_A.port, 4242);
+	zassert_equal(service_A.detail, DETAIL(0));
+	zassert_equal(service_A.concurrent, 4);
+	zassert_equal(service_A.backlog, 2);
+
+	zassert_ok(strcmp(service_B.host, "b.service.com"));
+	zassert_equal(service_B.port, &service_B_port);
+	zassert_equal(*service_B.port, 0);
+	zassert_equal(service_B.detail, DETAIL(1));
+	zassert_equal(service_B.concurrent, 7);
+	zassert_equal(service_B.backlog, 3);
+
+	zassert_ok(strcmp(service_C.host, "192.168.1.1"));
+	zassert_equal(service_C.port, &service_C_port);
+	zassert_equal(*service_C.port, 5959);
+	zassert_equal(service_C.detail, DETAIL(2));
+	zassert_equal(service_C.concurrent, 5);
+	zassert_equal(service_C.backlog, 9);
+	zassert_equal(service_C.res_begin, NULL);
+	zassert_equal(service_C.res_end, NULL);
+}
+
+ZTEST(http_service, test_HTTP_SERVICE_COUNT)
+{
+	size_t n_svc;
+
+	n_svc = 4273;
+	HTTP_SERVICE_COUNT(&n_svc);
+	zassert_equal(n_svc, 3);
+}
+
+ZTEST(http_service, test_HTTP_SERVICE_RESOURCE_COUNT)
+{
+	zassert_equal(HTTP_SERVICE_RESOURCE_COUNT(&service_A), 2);
+	zassert_equal(HTTP_SERVICE_RESOURCE_COUNT(&service_B), 2);
+	zassert_equal(HTTP_SERVICE_RESOURCE_COUNT(&service_C), 0);
+}
+
+ZTEST(http_service, test_HTTP_SERVICE_FOREACH)
+{
+	size_t n_svc = 0;
+	size_t have_service_A = 0;
+	size_t have_service_B = 0;
+	size_t have_service_C = 0;
+
+	HTTP_SERVICE_FOREACH(svc)
+	{
+		if (svc == &service_A) {
+			have_service_A = 1;
+		} else if (svc == &service_B) {
+			have_service_B = 1;
+		} else if (svc == &service_C) {
+			have_service_C = 1;
+		} else {
+			zassert_unreachable("svc (%p) not equal to &service_A (%p), &service_B "
+					    "(%p), or &service_C (%p)",
+					    svc, &service_A, &service_B, &service_C);
+		}
+
+		n_svc++;
+	}
+
+	zassert_equal(n_svc, 3);
+	zassert_equal(have_service_A + have_service_B + have_service_C, n_svc);
+}
+
+ZTEST(http_service, test_HTTP_RESOURCE_FOREACH)
+{
+	size_t first_res, second_res, n_res;
+
+	n_res = 0;
+	first_res = 0;
+	second_res = 0;
+	HTTP_RESOURCE_FOREACH(service_A, res)
+	{
+		if (res == &resource_0) {
+			first_res++;
+		} else if (res == &resource_1) {
+			second_res++;
+		} else {
+			zassert_unreachable(
+				"res (%p) not equal to &resource_0 (%p) or &resource_1 (%p)", res,
+				&resource_0, &resource_1);
+		}
+
+		n_res++;
+	}
+
+	zassert_equal(n_res, 2);
+	zassert_equal(first_res + second_res, n_res);
+
+	n_res = 0;
+	first_res = 0;
+	second_res = 0;
+	HTTP_RESOURCE_FOREACH(service_B, res)
+	{
+		if (res == &resource_2) {
+			first_res++;
+		} else if (res == &resource_3) {
+			second_res++;
+		} else {
+			zassert_unreachable(
+				"res (%p) not equal to &resource_2 (%p) or &resource_3 (%p)", res,
+				&resource_2, &resource_3);
+		}
+
+		n_res++;
+	}
+
+	zassert_equal(n_res, 2);
+	zassert_equal(first_res + second_res, n_res);
+
+	n_res = 0;
+	HTTP_SERVICE_FOREACH_RESOURCE(&service_C, res)
+	{
+		zassert_unreachable("service_C does not have any resources");
+		n_res++;
+	}
+
+	zassert_equal(n_res, 0);
+}
+
+ZTEST(http_service, test_HTTP_SERVICE_FOREACH_RESOURCE)
+{
+	size_t first_res, second_res, n_res;
+
+	n_res = 0;
+	first_res = 0;
+	second_res = 0;
+	HTTP_SERVICE_FOREACH_RESOURCE(&service_A, res)
+	{
+		if (res == &resource_0) {
+			first_res++;
+		} else if (res == &resource_1) {
+			second_res++;
+		} else {
+			zassert_unreachable(
+				"res (%p) not equal to &resource_0 (%p) or &resource_1 (%p)", res,
+				&resource_0, &resource_1);
+		}
+
+		n_res++;
+	}
+
+	zassert_equal(n_res, 2);
+	zassert_equal(first_res + second_res, n_res);
+
+	n_res = 0;
+	first_res = 0;
+	second_res = 0;
+	HTTP_SERVICE_FOREACH_RESOURCE(&service_B, res)
+	{
+		if (res == &resource_2) {
+			first_res++;
+		} else if (res == &resource_3) {
+			second_res++;
+		} else {
+			zassert_unreachable(
+				"res (%p) not equal to &resource_2 (%p) or &resource_3 (%p)", res,
+				&resource_2, &resource_3);
+		}
+
+		n_res++;
+	}
+
+	zassert_equal(n_res, 2);
+	zassert_equal(first_res + second_res, n_res);
+
+	n_res = 0;
+	HTTP_SERVICE_FOREACH_RESOURCE(&service_C, res)
+	{
+		zassert_unreachable("service_C does not have any resources");
+		n_res++;
+	}
+
+	zassert_equal(n_res, 0);
+}
+
+ZTEST(http_service, test_HTTP_RESOURCE_DEFINE)
+{
+	HTTP_SERVICE_FOREACH_RESOURCE(&service_A, res)
+	{
+		if (res == &resource_0) {
+			zassert_ok(strcmp(res->resource, "/"));
+			zassert_equal(res->detail, RES(0));
+		} else if (res == &resource_1) {
+			zassert_ok(strcmp(res->resource, "/index.html"));
+			zassert_equal(res->detail, RES(1));
+		} else {
+			zassert_unreachable(
+				"res (%p) not equal to &resource_0 (%p) or &resource_1 (%p)", res,
+				&resource_0, &resource_1);
+		}
+	}
+
+	HTTP_SERVICE_FOREACH_RESOURCE(&service_B, res)
+	{
+		if (res == &resource_2) {
+			zassert_ok(strcmp(res->resource, "/foo.htm"));
+			zassert_equal(res->detail, RES(2));
+		} else if (res == &resource_3) {
+			zassert_ok(strcmp(res->resource, "/bar/baz.php"));
+			zassert_equal(res->detail, RES(3));
+		} else {
+			zassert_unreachable(
+				"res (%p) not equal to &resource_0 (%p) or &resource_1 (%p)", res,
+				&resource_0, &resource_1);
+		}
+	}
+}
+
+ZTEST_SUITE(http_service, NULL, NULL, NULL, NULL, NULL);

tests/net/lib/http_server/common/testcase.yaml

@@ -0,0 +1,8 @@
+common:
+  min_ram: 16
+  tags: net http server
+  integration_platforms:
+    - native_posix
+
+tests:
+  net.http.server.common: {}