^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * KUnit test for core test infrastructure.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2019, Google LLC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Author: Brendan Higgins <brendanhiggins@google.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #include <kunit/test.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include "try-catch-impl.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) struct kunit_try_catch_test_context {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) struct kunit_try_catch *try_catch;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) bool function_called;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) static void kunit_test_successful_try(void *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) struct kunit *test = data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) struct kunit_try_catch_test_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) ctx->function_called = true;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) static void kunit_test_no_catch(void *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) struct kunit *test = data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) KUNIT_FAIL(test, "Catch should not be called\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) static void kunit_test_try_catch_successful_try_no_catch(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) struct kunit_try_catch_test_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) struct kunit_try_catch *try_catch = ctx->try_catch;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) kunit_try_catch_init(try_catch,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) kunit_test_successful_try,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) kunit_test_no_catch);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) kunit_try_catch_run(try_catch, test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) KUNIT_EXPECT_TRUE(test, ctx->function_called);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) static void kunit_test_unsuccessful_try(void *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) struct kunit *test = data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) struct kunit_try_catch_test_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) struct kunit_try_catch *try_catch = ctx->try_catch;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) kunit_try_catch_throw(try_catch);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) KUNIT_FAIL(test, "This line should never be reached\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) static void kunit_test_catch(void *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) struct kunit *test = data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) struct kunit_try_catch_test_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) ctx->function_called = true;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) static void kunit_test_try_catch_unsuccessful_try_does_catch(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) struct kunit_try_catch_test_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) struct kunit_try_catch *try_catch = ctx->try_catch;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) kunit_try_catch_init(try_catch,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) kunit_test_unsuccessful_try,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) kunit_test_catch);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) kunit_try_catch_run(try_catch, test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) KUNIT_EXPECT_TRUE(test, ctx->function_called);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) static int kunit_try_catch_test_init(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) struct kunit_try_catch_test_context *ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) ctx = kunit_kzalloc(test, sizeof(*ctx), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) test->priv = ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) ctx->try_catch = kunit_kmalloc(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) sizeof(*ctx->try_catch),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ctx->try_catch);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) static struct kunit_case kunit_try_catch_test_cases[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) KUNIT_CASE(kunit_test_try_catch_successful_try_no_catch),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) KUNIT_CASE(kunit_test_try_catch_unsuccessful_try_does_catch),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) {}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) static struct kunit_suite kunit_try_catch_test_suite = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) .name = "kunit-try-catch-test",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) .init = kunit_try_catch_test_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) .test_cases = kunit_try_catch_test_cases,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) * Context for testing test managed resources
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) * is_resource_initialized is used to test arbitrary resources
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) struct kunit_test_resource_context {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) struct kunit test;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) bool is_resource_initialized;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) int allocate_order[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) int free_order[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) static int fake_resource_init(struct kunit_resource *res, void *context)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) struct kunit_test_resource_context *ctx = context;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) res->data = &ctx->is_resource_initialized;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) ctx->is_resource_initialized = true;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) static void fake_resource_free(struct kunit_resource *res)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) bool *is_resource_initialized = res->data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) *is_resource_initialized = false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) static void kunit_resource_test_init_resources(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) struct kunit_test_resource_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) kunit_init_test(&ctx->test, "testing_test_init_test", NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) KUNIT_EXPECT_TRUE(test, list_empty(&ctx->test.resources));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) static void kunit_resource_test_alloc_resource(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) struct kunit_test_resource_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) struct kunit_resource *res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) kunit_resource_free_t free = fake_resource_free;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) res = kunit_alloc_and_get_resource(&ctx->test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) fake_resource_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) fake_resource_free,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) GFP_KERNEL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) KUNIT_ASSERT_NOT_ERR_OR_NULL(test, res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) KUNIT_EXPECT_PTR_EQ(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) &ctx->is_resource_initialized,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) (bool *)res->data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) KUNIT_EXPECT_TRUE(test, list_is_last(&res->node, &ctx->test.resources));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) KUNIT_EXPECT_PTR_EQ(test, free, res->free);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) kunit_put_resource(res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) * Note: tests below use kunit_alloc_and_get_resource(), so as a consequence
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) * they have a reference to the associated resource that they must release
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) * via kunit_put_resource(). In normal operation, users will only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) * have to do this for cases where they use kunit_find_resource(), and the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) * kunit_alloc_resource() function will be used (which does not take a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) * resource reference).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) static void kunit_resource_test_destroy_resource(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) struct kunit_test_resource_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) struct kunit_resource *res = kunit_alloc_and_get_resource(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) &ctx->test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) fake_resource_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) fake_resource_free,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) GFP_KERNEL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) kunit_put_resource(res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) KUNIT_ASSERT_FALSE(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) kunit_destroy_resource(&ctx->test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) kunit_resource_instance_match,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) res->data));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) KUNIT_EXPECT_FALSE(test, ctx->is_resource_initialized);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) KUNIT_EXPECT_TRUE(test, list_empty(&ctx->test.resources));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) static void kunit_resource_test_cleanup_resources(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) struct kunit_test_resource_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) struct kunit_resource *resources[5];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) for (i = 0; i < ARRAY_SIZE(resources); i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) resources[i] = kunit_alloc_and_get_resource(&ctx->test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) fake_resource_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) fake_resource_free,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) GFP_KERNEL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) kunit_put_resource(resources[i]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) kunit_cleanup(&ctx->test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) KUNIT_EXPECT_TRUE(test, list_empty(&ctx->test.resources));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) static void kunit_resource_test_mark_order(int order_array[],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) size_t order_size,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) int key)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) for (i = 0; i < order_size && order_array[i]; i++)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) ;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) order_array[i] = key;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) #define KUNIT_RESOURCE_TEST_MARK_ORDER(ctx, order_field, key) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) kunit_resource_test_mark_order(ctx->order_field, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) ARRAY_SIZE(ctx->order_field), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) key)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) static int fake_resource_2_init(struct kunit_resource *res, void *context)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) struct kunit_test_resource_context *ctx = context;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) KUNIT_RESOURCE_TEST_MARK_ORDER(ctx, allocate_order, 2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) res->data = ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) static void fake_resource_2_free(struct kunit_resource *res)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) struct kunit_test_resource_context *ctx = res->data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) KUNIT_RESOURCE_TEST_MARK_ORDER(ctx, free_order, 2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) static int fake_resource_1_init(struct kunit_resource *res, void *context)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) struct kunit_test_resource_context *ctx = context;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) struct kunit_resource *res2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) res2 = kunit_alloc_and_get_resource(&ctx->test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) fake_resource_2_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) fake_resource_2_free,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) GFP_KERNEL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) KUNIT_RESOURCE_TEST_MARK_ORDER(ctx, allocate_order, 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) res->data = ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) kunit_put_resource(res2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) static void fake_resource_1_free(struct kunit_resource *res)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) struct kunit_test_resource_context *ctx = res->data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) KUNIT_RESOURCE_TEST_MARK_ORDER(ctx, free_order, 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) * TODO(brendanhiggins@google.com): replace the arrays that keep track of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) * order of allocation and freeing with strict mocks using the IN_SEQUENCE macro
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) * to assert allocation and freeing order when the feature becomes available.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) static void kunit_resource_test_proper_free_ordering(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) struct kunit_test_resource_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) struct kunit_resource *res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) /* fake_resource_1 allocates a fake_resource_2 in its init. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) res = kunit_alloc_and_get_resource(&ctx->test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) fake_resource_1_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) fake_resource_1_free,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) GFP_KERNEL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) * Since fake_resource_2_init calls KUNIT_RESOURCE_TEST_MARK_ORDER
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) * before returning to fake_resource_1_init, it should be the first to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) * put its key in the allocate_order array.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) KUNIT_EXPECT_EQ(test, ctx->allocate_order[0], 2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) KUNIT_EXPECT_EQ(test, ctx->allocate_order[1], 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) kunit_put_resource(res);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) kunit_cleanup(&ctx->test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) * Because fake_resource_2 finishes allocation before fake_resource_1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) * fake_resource_1 should be freed first since it could depend on
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) * fake_resource_2.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) KUNIT_EXPECT_EQ(test, ctx->free_order[0], 1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) KUNIT_EXPECT_EQ(test, ctx->free_order[1], 2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) static void kunit_resource_test_static(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) struct kunit_test_resource_context ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) struct kunit_resource res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) KUNIT_EXPECT_EQ(test, kunit_add_resource(test, NULL, NULL, &res, &ctx),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) KUNIT_EXPECT_PTR_EQ(test, res.data, (void *)&ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) kunit_cleanup(test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) KUNIT_EXPECT_TRUE(test, list_empty(&test->resources));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) static void kunit_resource_test_named(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) struct kunit_resource res1, res2, *found = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) struct kunit_test_resource_context ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) KUNIT_EXPECT_EQ(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) kunit_add_named_resource(test, NULL, NULL, &res1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) "resource_1", &ctx),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) KUNIT_EXPECT_PTR_EQ(test, res1.data, (void *)&ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) KUNIT_EXPECT_EQ(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) kunit_add_named_resource(test, NULL, NULL, &res1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) "resource_1", &ctx),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) -EEXIST);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) KUNIT_EXPECT_EQ(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) kunit_add_named_resource(test, NULL, NULL, &res2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) "resource_2", &ctx),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) found = kunit_find_named_resource(test, "resource_1");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) KUNIT_EXPECT_PTR_EQ(test, found, &res1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) if (found)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) kunit_put_resource(&res1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) KUNIT_EXPECT_EQ(test, kunit_destroy_named_resource(test, "resource_2"),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) kunit_cleanup(test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) KUNIT_EXPECT_TRUE(test, list_empty(&test->resources));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) static int kunit_resource_test_init(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) struct kunit_test_resource_context *ctx =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) kzalloc(sizeof(*ctx), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371) test->priv = ctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) kunit_init_test(&ctx->test, "test_test_context", NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) static void kunit_resource_test_exit(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) struct kunit_test_resource_context *ctx = test->priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382) kunit_cleanup(&ctx->test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) kfree(ctx);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) static struct kunit_case kunit_resource_test_cases[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) KUNIT_CASE(kunit_resource_test_init_resources),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) KUNIT_CASE(kunit_resource_test_alloc_resource),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389) KUNIT_CASE(kunit_resource_test_destroy_resource),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) KUNIT_CASE(kunit_resource_test_cleanup_resources),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391) KUNIT_CASE(kunit_resource_test_proper_free_ordering),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) KUNIT_CASE(kunit_resource_test_static),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) KUNIT_CASE(kunit_resource_test_named),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394) {}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397) static struct kunit_suite kunit_resource_test_suite = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) .name = "kunit-resource-test",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) .init = kunit_resource_test_init,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400) .exit = kunit_resource_test_exit,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401) .test_cases = kunit_resource_test_cases,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 402) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 403)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 404) static void kunit_log_test(struct kunit *test);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 405)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 406) static struct kunit_case kunit_log_test_cases[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 407) KUNIT_CASE(kunit_log_test),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 408) {}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 409) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 410)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 411) static struct kunit_suite kunit_log_test_suite = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 412) .name = "kunit-log-test",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 413) .test_cases = kunit_log_test_cases,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 414) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 415)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 416) static void kunit_log_test(struct kunit *test)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 417) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 418) struct kunit_suite *suite = &kunit_log_test_suite;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 419)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 420) kunit_log(KERN_INFO, test, "put this in log.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 421) kunit_log(KERN_INFO, test, "this too.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 422) kunit_log(KERN_INFO, suite, "add to suite log.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 423) kunit_log(KERN_INFO, suite, "along with this.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 424)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 425) #ifdef CONFIG_KUNIT_DEBUGFS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 426) KUNIT_EXPECT_NOT_ERR_OR_NULL(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 427) strstr(test->log, "put this in log."));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 428) KUNIT_EXPECT_NOT_ERR_OR_NULL(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 429) strstr(test->log, "this too."));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 430) KUNIT_EXPECT_NOT_ERR_OR_NULL(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 431) strstr(suite->log, "add to suite log."));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 432) KUNIT_EXPECT_NOT_ERR_OR_NULL(test,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 433) strstr(suite->log, "along with this."));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 434) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 435) KUNIT_EXPECT_PTR_EQ(test, test->log, (char *)NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 436) KUNIT_EXPECT_PTR_EQ(test, suite->log, (char *)NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 437) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 438) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 439)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 440) kunit_test_suites(&kunit_try_catch_test_suite, &kunit_resource_test_suite,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 441) &kunit_log_test_suite);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 442)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 443) MODULE_LICENSE("GPL v2");