Skip to content

Commit

Permalink
tests: fast_pair: storage: Migrate to new ztest API
Browse files Browse the repository at this point in the history
Change migrates test to new ztest API. The old API is deprecated.
Change also removes test from quarantine.

Jira: NCSDK-21698

Signed-off-by: Marek Pieta <Marek.Pieta@nordicsemi.no>
  • Loading branch information
MarekPieta committed Jul 6, 2023
1 parent 90571c9 commit 85f0cf5
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 45 deletions.
6 changes: 0 additions & 6 deletions scripts/quarantine.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,3 @@
platforms:
- all
comment: "Temporary disable till the issue is fixed"

- scenarios:
- fast_pair.storage.factory_reset.*
platforms:
- all
comment: "Excluded due to the old Ztest API - issue: NCSDK-21698"
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
#

CONFIG_ZTEST=y
CONFIG_ZTEST_NEW_API=y
# Do not randomize test order, tests depend on predefined execution order.
CONFIG_ZTEST_SHUFFLE=n

# Enable settings to store data in non-volatile memory
CONFIG_FLASH=y
Expand Down
79 changes: 40 additions & 39 deletions tests/subsys/bluetooth/fast_pair/storage/factory_reset/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ enum reset_test_stage {
};

enum reset_test_finished {
RESET_TEST_FINISHED_SECTION_PLACEMENT_BIT_POS,
RESET_TEST_FINISHED_STORE_BIT_POS,
RESET_TEST_FINISHED_NORMAL_RESET_BIT_POS,
RESET_TEST_FINISHED_INTERRUPTED_RESET_BEGIN_BIT_POS,
Expand Down Expand Up @@ -132,7 +131,7 @@ static void test_fp_storage_reset_prepare(void) {}
FP_STORAGE_MANAGER_MODULE_REGISTER(_0_test_reset, test_fp_storage_reset_perform,
test_fp_storage_reset_prepare);

static void test_section_placement(void)
static void *setup_fn(void)
{
struct fp_storage_manager_module *module;

Expand All @@ -143,7 +142,7 @@ static void test_section_placement(void)
zassert_equal_ptr(test_fp_storage_reset_prepare, module->module_reset_prepare,
"Invalid order of elements in section");

mark_test_as_finished(RESET_TEST_FINISHED_SECTION_PLACEMENT_BIT_POS);
return NULL;
}

static int settings_validate(settings_load_direct_cb cb)
Expand Down Expand Up @@ -204,8 +203,10 @@ static void fp_storage_validate_unloaded(void)
zassert_equal(err, -ENODATA, "Expected error before settings load");
}

static void setup_fn(void)
static void before_fn(void *f)
{
ARG_UNUSED(f);

int err;

err = settings_validate(settings_validate_empty_cb);
Expand Down Expand Up @@ -267,8 +268,10 @@ static int all_settings_delete(void)
return 0;
}

static void teardown_fn(void)
static void after_fn(void *f)
{
ARG_UNUSED(f);

int err;

err = all_settings_delete();
Expand Down Expand Up @@ -344,7 +347,7 @@ static void fp_storage_self_test_run(void)
personalized_name_validate_loaded(name);
}

static void test_store(void)
ZTEST(suite_fast_pair_storage_factory_reset_01, test_01_store)
{
fp_storage_self_test_run();

Expand All @@ -368,7 +371,7 @@ static void store_data_and_factory_reset(void)
zassert_ok(err, "Unexpected error in factory reset");
}

static void test_normal_reset(void)
ZTEST(suite_fast_pair_storage_factory_reset_01, test_02_normal_reset)
{
store_data_and_factory_reset();

Expand All @@ -377,7 +380,7 @@ static void test_normal_reset(void)
mark_test_as_finished(RESET_TEST_FINISHED_NORMAL_RESET_BIT_POS);
}

static void test_interrupted_reset_begin(void)
ZTEST(suite_fast_pair_storage_factory_reset_02, test_interrupted_reset_begin)
{
storage_reset_pass = true;

Expand All @@ -387,21 +390,25 @@ static void test_interrupted_reset_begin(void)
zassert_unreachable();
}

static void test_interrupted_reset_finish_setup_fn(void)
static void before_continue_fn(void *f)
{
ARG_UNUSED(f);

int err;

err = settings_load();
zassert_ok(err, "Unexpected error in settings load");
}

static void test_interrupted_reset_finish(void)
ZTEST(suite_fast_pair_storage_factory_reset_03, test_interrupted_reset_finish)
{
fp_storage_self_test_run();
}

static void normal_test_stage_finalize(void)
static void teardown_fn(void *f)
{
ARG_UNUSED(f);

int err;

for (size_t i = 0; i < RESET_TEST_FINISHED_COUNT; i++) {
Expand All @@ -428,6 +435,27 @@ static void normal_test_stage_finalize(void)
fp_ram_clear();
}

static bool predicate_fn(const void *global_state)
{
ARG_UNUSED(global_state);

return (test_stage == RESET_TEST_STAGE_NORMAL);
}

static bool predicate_continue_fn(const void *global_state)
{
ARG_UNUSED(global_state);

return (test_stage == RESET_TEST_STAGE_INTERRUPTED);
}

ZTEST_SUITE(suite_fast_pair_storage_factory_reset_01,
predicate_fn, setup_fn, before_fn, after_fn, NULL);
ZTEST_SUITE(suite_fast_pair_storage_factory_reset_02,
predicate_fn, setup_fn, before_fn, NULL, teardown_fn);
ZTEST_SUITE(suite_fast_pair_storage_factory_reset_03,
predicate_continue_fn, setup_fn, before_continue_fn, after_fn, NULL);

void test_main(void)
{
int err;
Expand All @@ -442,32 +470,5 @@ void test_main(void)
(test_stage == RESET_TEST_STAGE_INTERRUPTED),
"Invalid test stage");

if (test_stage == RESET_TEST_STAGE_NORMAL) {
/* The test_interrupted_reset_begin test must be placed last in the suite, it
* prepares storage data for the test_interrupted_reset_finish test.
*/
ztest_test_suite(fast_pair_storage_factory_reset_normal_tests,
ztest_unit_test(test_section_placement),
ztest_unit_test_setup_teardown(test_store, setup_fn, teardown_fn),
ztest_unit_test_setup_teardown(test_normal_reset, setup_fn,
teardown_fn),
ztest_unit_test_setup_teardown(test_interrupted_reset_begin,
setup_fn, unit_test_noop)
);

ztest_run_test_suite(fast_pair_storage_factory_reset_normal_tests);

normal_test_stage_finalize();
}

if (test_stage == RESET_TEST_STAGE_INTERRUPTED) {
ztest_test_suite(fast_pair_storage_factory_reset_interrupted_tests_continue,
ztest_unit_test_setup_teardown(
test_interrupted_reset_finish,
test_interrupted_reset_finish_setup_fn,
teardown_fn)
);

ztest_run_test_suite(fast_pair_storage_factory_reset_interrupted_tests_continue);
}
ztest_run_all(NULL);
}

0 comments on commit 85f0cf5

Please sign in to comment.