tests: bluetooth: host: Add UT for bt_pub_key_get()

Unit test project for bt_pub_key_get().
This is part of subsys/bluetooth/host/ecc.c unit testing.

Signed-off-by: Ahmed Moheb <[email protected]>

Author: ahmedmoheb-nordic

tests/bluetooth/host/ecc/bt_pub_key_get/CMakeLists.txt

@@ -0,0 +1,17 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+set(SOURCES
+  src/main.c
+  src/test_suite_invalid_inputs.c
+)
+
+project(bt_pub_key_get)
+
+find_package(Zephyr COMPONENTS unittest HINTS $ENV{ZEPHYR_BASE})
+
+add_subdirectory(${ZEPHYR_BASE}/tests/bluetooth/host host_mocks)
+add_subdirectory(${ZEPHYR_BASE}/tests/bluetooth/host/ecc mocks)
+
+target_link_libraries(testbinary PRIVATE mocks host_mocks)

tests/bluetooth/host/ecc/bt_pub_key_get/prj.conf

@@ -0,0 +1,9 @@
+CONFIG_ZTEST=y
+CONFIG_ZTEST_NEW_API=y
+CONFIG_BT=y
+CONFIG_BT_CENTRAL=y
+CONFIG_BT_MAX_PAIRED=7
+CONFIG_ASSERT=y
+CONFIG_ASSERT_LEVEL=2
+CONFIG_ASSERT_VERBOSE=y
+CONFIG_ASSERT_ON_ERRORS=y

tests/bluetooth/host/ecc/bt_pub_key_get/src/main.c

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "mocks/ecc_help_utils.h"
+
+#include <zephyr/bluetooth/hci.h>
+#include <zephyr/fff.h>
+#include <zephyr/kernel.h>
+
+#include <host/ecc.h>
+#include <host/hci_core.h>
+
+DEFINE_FFF_GLOBALS;
+
+static void fff_reset_rule_before(const struct ztest_unit_test *test, void *fixture)
+{
+	memset(&bt_dev, 0x00, sizeof(struct bt_dev));
+}
+
+ZTEST_RULE(fff_reset_rule, fff_reset_rule_before, NULL);
+
+ZTEST_SUITE(bt_pub_key_get, NULL, NULL, NULL, NULL, NULL);
+
+/*
+ *  Test getting currently used public key if 'BT_DEV_HAS_PUB_KEY' is set and
+ *  'CONFIG_BT_USE_DEBUG_KEYS' isn't enabled
+ *
+ *  Constraints:
+ *   - 'BT_DEV_HAS_PUB_KEY' flag is set
+ *   - 'CONFIG_BT_USE_DEBUG_KEYS' isn't enabled
+ *
+ *  Expected behaviour:
+ *   - A valid reference value is returned
+ */
+ZTEST(bt_pub_key_get, test_bt_dev_has_pub_key_set)
+{
+	const uint8_t *pub_key;
+
+	Z_TEST_SKIP_IFDEF(CONFIG_BT_USE_DEBUG_KEYS);
+
+	atomic_set_bit(bt_dev.flags, BT_DEV_HAS_PUB_KEY);
+
+	pub_key = bt_pub_key_get();
+
+	zassert_equal(pub_key, bt_ecc_get_public_key(), "Incorrect reference was returned");
+}
+
+/*
+ *  Test getting currently used debug public key if 'CONFIG_BT_USE_DEBUG_KEYS' is enabled and
+ *  "ECC Debug Keys" command is supported
+ *
+ *  Constraints:
+ *   - 'CONFIG_BT_USE_DEBUG_KEYS' is enabled
+ *   - "ECC Debug Keys" command is supported
+ *   - 'BT_DEV_HAS_PUB_KEY' flag is set (just for testing and it shouldn't affect the result)
+ *
+ *  Expected behaviour:
+ *   - A valid reference value is returned
+ */
+ZTEST(bt_pub_key_get, test_get_debug_pub_key1)
+{
+	const uint8_t *pub_key;
+
+	Z_TEST_SKIP_IFNDEF(CONFIG_BT_USE_DEBUG_KEYS);
+
+	/* Set "ECC Debug Keys" command support bit */
+	bt_dev.supported_commands[41] |= BIT(2);
+	atomic_set_bit(bt_dev.flags, BT_DEV_HAS_PUB_KEY);
+
+	pub_key = bt_pub_key_get();
+
+	zassert_equal(pub_key, bt_ecc_get_internal_debug_public_key(),
+		      "Incorrect reference was returned");
+}

tests/bluetooth/host/ecc/bt_pub_key_get/src/test_suite_invalid_inputs.c

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/bluetooth/hci.h>
+#include <zephyr/kernel.h>
+
+#include <host/ecc.h>
+#include <host/hci_core.h>
+
+ZTEST_SUITE(bt_pub_key_get_invalid_cases, NULL, NULL, NULL, NULL, NULL);
+
+/*
+ *  Test getting currently used public key if 'BT_DEV_HAS_PUB_KEY' isn't set and
+ *  'CONFIG_BT_USE_DEBUG_KEYS' isn't enabled
+ *
+ *  Constraints:
+ *   - 'BT_DEV_HAS_PUB_KEY' flag isn't set
+ *   - 'CONFIG_BT_USE_DEBUG_KEYS' isn't enabled
+ *
+ *  Expected behaviour:
+ *   - NULL value is returned
+ */
+ZTEST(bt_pub_key_get_invalid_cases, test_bt_dev_has_pub_key_not_set)
+{
+	const uint8_t *pub_key;
+
+	Z_TEST_SKIP_IFDEF(CONFIG_BT_USE_DEBUG_KEYS);
+
+	atomic_clear_bit(bt_dev.flags, BT_DEV_HAS_PUB_KEY);
+
+	pub_key = bt_pub_key_get();
+
+	zassert_is_null(pub_key, "Incorrect reference was returned");
+}
+
+/*
+ *  Test getting currently used debug public key if 'CONFIG_BT_USE_DEBUG_KEYS' is enabled, but
+ *  "ECC Debug Keys" command isn't supported
+ *
+ *  Constraints:
+ *   - 'CONFIG_BT_USE_DEBUG_KEYS' is enabled
+ *   - "ECC Debug Keys" command isn't supported
+ *   - 'BT_DEV_HAS_PUB_KEY' flag isn't set
+ *
+ *  Expected behaviour:
+ *   - NULL value is returned
+ */
+ZTEST(bt_pub_key_get_invalid_cases, test_get_debug_pub_key)
+{
+	const uint8_t *pub_key;
+
+	Z_TEST_SKIP_IFNDEF(CONFIG_BT_USE_DEBUG_KEYS);
+
+	/* Clear "ECC Debug Keys" command support bit */
+	bt_dev.supported_commands[41] &= ~BIT(2);
+	atomic_clear_bit(bt_dev.flags, BT_DEV_HAS_PUB_KEY);
+
+	pub_key = bt_pub_key_get();
+
+	zassert_is_null(pub_key, "Incorrect reference was returned");
+}

tests/bluetooth/host/ecc/bt_pub_key_get/testcase.yaml

@@ -0,0 +1,10 @@
+common:
+  tags: test_framework bluetooth host
+tests:
+  bluetooth.host.bt_pub_key_get.default:
+    type: unit
+  bluetooth.host.bt_pub_key_get.bt_use_debug_keys_enabled:
+    type: unit
+    extra_configs:
+      - CONFIG_BT_SMP=y
+      - CONFIG_BT_USE_DEBUG_KEYS=y