12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745 |
- /* SPDX-License-Identifier: GPL-2.0 */
- /*
- * Base unit test (KUnit) API.
- *
- * Copyright (C) 2019, Google LLC.
- * Author: Brendan Higgins <brendanhiggins@google.com>
- */
- #ifndef _KUNIT_TEST_H
- #define _KUNIT_TEST_H
- #include <kunit/assert.h>
- #include <kunit/try-catch.h>
- #include <linux/kernel.h>
- #include <linux/module.h>
- #include <linux/slab.h>
- #include <linux/types.h>
- #include <linux/kref.h>
- struct kunit_resource;
- typedef int (*kunit_resource_init_t)(struct kunit_resource *, void *);
- typedef void (*kunit_resource_free_t)(struct kunit_resource *);
- /**
- * struct kunit_resource - represents a *test managed resource*
- * @data: for the user to store arbitrary data.
- * @name: optional name
- * @free: a user supplied function to free the resource. Populated by
- * kunit_resource_alloc().
- *
- * Represents a *test managed resource*, a resource which will automatically be
- * cleaned up at the end of a test case.
- *
- * Resources are reference counted so if a resource is retrieved via
- * kunit_alloc_and_get_resource() or kunit_find_resource(), we need
- * to call kunit_put_resource() to reduce the resource reference count
- * when finished with it. Note that kunit_alloc_resource() does not require a
- * kunit_resource_put() because it does not retrieve the resource itself.
- *
- * Example:
- *
- * .. code-block:: c
- *
- * struct kunit_kmalloc_params {
- * size_t size;
- * gfp_t gfp;
- * };
- *
- * static int kunit_kmalloc_init(struct kunit_resource *res, void *context)
- * {
- * struct kunit_kmalloc_params *params = context;
- * res->data = kmalloc(params->size, params->gfp);
- *
- * if (!res->data)
- * return -ENOMEM;
- *
- * return 0;
- * }
- *
- * static void kunit_kmalloc_free(struct kunit_resource *res)
- * {
- * kfree(res->data);
- * }
- *
- * void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp)
- * {
- * struct kunit_kmalloc_params params;
- *
- * params.size = size;
- * params.gfp = gfp;
- *
- * return kunit_alloc_resource(test, kunit_kmalloc_init,
- * kunit_kmalloc_free, ¶ms);
- * }
- *
- * Resources can also be named, with lookup/removal done on a name
- * basis also. kunit_add_named_resource(), kunit_find_named_resource()
- * and kunit_destroy_named_resource(). Resource names must be
- * unique within the test instance.
- */
- struct kunit_resource {
- void *data;
- const char *name;
- kunit_resource_free_t free;
- /* private: internal use only. */
- struct kref refcount;
- struct list_head node;
- };
- struct kunit;
- /* Size of log associated with test. */
- #define KUNIT_LOG_SIZE 512
- /*
- * TAP specifies subtest stream indentation of 4 spaces, 8 spaces for a
- * sub-subtest. See the "Subtests" section in
- * https://node-tap.org/tap-protocol/
- */
- #define KUNIT_SUBTEST_INDENT " "
- #define KUNIT_SUBSUBTEST_INDENT " "
- /**
- * struct kunit_case - represents an individual test case.
- *
- * @run_case: the function representing the actual test case.
- * @name: the name of the test case.
- *
- * A test case is a function with the signature,
- * ``void (*)(struct kunit *)``
- * that makes expectations and assertions (see KUNIT_EXPECT_TRUE() and
- * KUNIT_ASSERT_TRUE()) about code under test. Each test case is associated
- * with a &struct kunit_suite and will be run after the suite's init
- * function and followed by the suite's exit function.
- *
- * A test case should be static and should only be created with the
- * KUNIT_CASE() macro; additionally, every array of test cases should be
- * terminated with an empty test case.
- *
- * Example:
- *
- * .. code-block:: c
- *
- * void add_test_basic(struct kunit *test)
- * {
- * KUNIT_EXPECT_EQ(test, 1, add(1, 0));
- * KUNIT_EXPECT_EQ(test, 2, add(1, 1));
- * KUNIT_EXPECT_EQ(test, 0, add(-1, 1));
- * KUNIT_EXPECT_EQ(test, INT_MAX, add(0, INT_MAX));
- * KUNIT_EXPECT_EQ(test, -1, add(INT_MAX, INT_MIN));
- * }
- *
- * static struct kunit_case example_test_cases[] = {
- * KUNIT_CASE(add_test_basic),
- * {}
- * };
- *
- */
- struct kunit_case {
- void (*run_case)(struct kunit *test);
- const char *name;
- /* private: internal use only. */
- bool success;
- char *log;
- };
- static inline char *kunit_status_to_string(bool status)
- {
- return status ? "ok" : "not ok";
- }
- /**
- * KUNIT_CASE - A helper for creating a &struct kunit_case
- *
- * @test_name: a reference to a test case function.
- *
- * Takes a symbol for a function representing a test case and creates a
- * &struct kunit_case object from it. See the documentation for
- * &struct kunit_case for an example on how to use it.
- */
- #define KUNIT_CASE(test_name) { .run_case = test_name, .name = #test_name }
- /**
- * struct kunit_suite - describes a related collection of &struct kunit_case
- *
- * @name: the name of the test. Purely informational.
- * @init: called before every test case.
- * @exit: called after every test case.
- * @test_cases: a null terminated array of test cases.
- *
- * A kunit_suite is a collection of related &struct kunit_case s, such that
- * @init is called before every test case and @exit is called after every
- * test case, similar to the notion of a *test fixture* or a *test class*
- * in other unit testing frameworks like JUnit or Googletest.
- *
- * Every &struct kunit_case must be associated with a kunit_suite for KUnit
- * to run it.
- */
- struct kunit_suite {
- const char name[256];
- int (*init)(struct kunit *test);
- void (*exit)(struct kunit *test);
- struct kunit_case *test_cases;
- /* private: internal use only */
- struct dentry *debugfs;
- char *log;
- };
- /**
- * struct kunit - represents a running instance of a test.
- *
- * @priv: for user to store arbitrary data. Commonly used to pass data
- * created in the init function (see &struct kunit_suite).
- *
- * Used to store information about the current context under which the test
- * is running. Most of this data is private and should only be accessed
- * indirectly via public functions; the one exception is @priv which can be
- * used by the test writer to store arbitrary data.
- */
- struct kunit {
- void *priv;
- /* private: internal use only. */
- const char *name; /* Read only after initialization! */
- char *log; /* Points at case log after initialization */
- struct kunit_try_catch try_catch;
- /*
- * success starts as true, and may only be set to false during a
- * test case; thus, it is safe to update this across multiple
- * threads using WRITE_ONCE; however, as a consequence, it may only
- * be read after the test case finishes once all threads associated
- * with the test case have terminated.
- */
- bool success; /* Read only after test_case finishes! */
- spinlock_t lock; /* Guards all mutable test state. */
- /*
- * Because resources is a list that may be updated multiple times (with
- * new resources) from any thread associated with a test case, we must
- * protect it with some type of lock.
- */
- struct list_head resources; /* Protected by lock. */
- };
- static inline void kunit_set_failure(struct kunit *test)
- {
- WRITE_ONCE(test->success, false);
- }
- void kunit_init_test(struct kunit *test, const char *name, char *log);
- int kunit_run_tests(struct kunit_suite *suite);
- size_t kunit_suite_num_test_cases(struct kunit_suite *suite);
- unsigned int kunit_test_case_num(struct kunit_suite *suite,
- struct kunit_case *test_case);
- int __kunit_test_suites_init(struct kunit_suite * const * const suites);
- void __kunit_test_suites_exit(struct kunit_suite **suites);
- #if IS_BUILTIN(CONFIG_KUNIT)
- int kunit_run_all_tests(void);
- #else
- static inline int kunit_run_all_tests(void)
- {
- return 0;
- }
- #endif /* IS_BUILTIN(CONFIG_KUNIT) */
- #ifdef MODULE
- /**
- * kunit_test_suites_for_module() - used to register one or more
- * &struct kunit_suite with KUnit.
- *
- * @__suites: a statically allocated list of &struct kunit_suite.
- *
- * Registers @__suites with the test framework. See &struct kunit_suite for
- * more information.
- *
- * If a test suite is built-in, module_init() gets translated into
- * an initcall which we don't want as the idea is that for builtins
- * the executor will manage execution. So ensure we do not define
- * module_{init|exit} functions for the builtin case when registering
- * suites via kunit_test_suites() below.
- */
- #define kunit_test_suites_for_module(__suites) \
- static int __init kunit_test_suites_init(void) \
- { \
- return __kunit_test_suites_init(__suites); \
- } \
- module_init(kunit_test_suites_init); \
- \
- static void __exit kunit_test_suites_exit(void) \
- { \
- return __kunit_test_suites_exit(__suites); \
- } \
- module_exit(kunit_test_suites_exit)
- #else
- #define kunit_test_suites_for_module(__suites)
- #endif /* MODULE */
- #define __kunit_test_suites(unique_array, unique_suites, ...) \
- static struct kunit_suite *unique_array[] = { __VA_ARGS__, NULL }; \
- kunit_test_suites_for_module(unique_array); \
- static struct kunit_suite **unique_suites \
- __used __section(".kunit_test_suites") = unique_array
- /**
- * kunit_test_suites() - used to register one or more &struct kunit_suite
- * with KUnit.
- *
- * @__suites: a statically allocated list of &struct kunit_suite.
- *
- * Registers @suites with the test framework. See &struct kunit_suite for
- * more information.
- *
- * When builtin, KUnit tests are all run via executor; this is done
- * by placing the array of struct kunit_suite * in the .kunit_test_suites
- * ELF section.
- *
- * An alternative is to build the tests as a module. Because modules do not
- * support multiple initcall()s, we need to initialize an array of suites for a
- * module.
- *
- */
- #define kunit_test_suites(__suites...) \
- __kunit_test_suites(__UNIQUE_ID(array), \
- __UNIQUE_ID(suites), \
- ##__suites)
- #define kunit_test_suite(suite) kunit_test_suites(&suite)
- #define kunit_suite_for_each_test_case(suite, test_case) \
- for (test_case = suite->test_cases; test_case->run_case; test_case++)
- bool kunit_suite_has_succeeded(struct kunit_suite *suite);
- /*
- * Like kunit_alloc_resource() below, but returns the struct kunit_resource
- * object that contains the allocation. This is mostly for testing purposes.
- */
- struct kunit_resource *kunit_alloc_and_get_resource(struct kunit *test,
- kunit_resource_init_t init,
- kunit_resource_free_t free,
- gfp_t internal_gfp,
- void *context);
- /**
- * kunit_get_resource() - Hold resource for use. Should not need to be used
- * by most users as we automatically get resources
- * retrieved by kunit_find_resource*().
- * @res: resource
- */
- static inline void kunit_get_resource(struct kunit_resource *res)
- {
- kref_get(&res->refcount);
- }
- /*
- * Called when refcount reaches zero via kunit_put_resources();
- * should not be called directly.
- */
- static inline void kunit_release_resource(struct kref *kref)
- {
- struct kunit_resource *res = container_of(kref, struct kunit_resource,
- refcount);
- /* If free function is defined, resource was dynamically allocated. */
- if (res->free) {
- res->free(res);
- kfree(res);
- }
- }
- /**
- * kunit_put_resource() - When caller is done with retrieved resource,
- * kunit_put_resource() should be called to drop
- * reference count. The resource list maintains
- * a reference count on resources, so if no users
- * are utilizing a resource and it is removed from
- * the resource list, it will be freed via the
- * associated free function (if any). Only
- * needs to be used if we alloc_and_get() or
- * find() resource.
- * @res: resource
- */
- static inline void kunit_put_resource(struct kunit_resource *res)
- {
- kref_put(&res->refcount, kunit_release_resource);
- }
- /**
- * kunit_add_resource() - Add a *test managed resource*.
- * @test: The test context object.
- * @init: a user-supplied function to initialize the result (if needed). If
- * none is supplied, the resource data value is simply set to @data.
- * If an init function is supplied, @data is passed to it instead.
- * @free: a user-supplied function to free the resource (if needed).
- * @res: The resource.
- * @data: value to pass to init function or set in resource data field.
- */
- int kunit_add_resource(struct kunit *test,
- kunit_resource_init_t init,
- kunit_resource_free_t free,
- struct kunit_resource *res,
- void *data);
- /**
- * kunit_add_named_resource() - Add a named *test managed resource*.
- * @test: The test context object.
- * @init: a user-supplied function to initialize the resource data, if needed.
- * @free: a user-supplied function to free the resource data, if needed.
- * @res: The resource.
- * @name: name to be set for resource.
- * @data: value to pass to init function or set in resource data field.
- */
- int kunit_add_named_resource(struct kunit *test,
- kunit_resource_init_t init,
- kunit_resource_free_t free,
- struct kunit_resource *res,
- const char *name,
- void *data);
- /**
- * kunit_alloc_resource() - Allocates a *test managed resource*.
- * @test: The test context object.
- * @init: a user supplied function to initialize the resource.
- * @free: a user supplied function to free the resource.
- * @internal_gfp: gfp to use for internal allocations, if unsure, use GFP_KERNEL
- * @context: for the user to pass in arbitrary data to the init function.
- *
- * Allocates a *test managed resource*, a resource which will automatically be
- * cleaned up at the end of a test case. See &struct kunit_resource for an
- * example.
- *
- * Note: KUnit needs to allocate memory for a kunit_resource object. You must
- * specify an @internal_gfp that is compatible with the use context of your
- * resource.
- */
- static inline void *kunit_alloc_resource(struct kunit *test,
- kunit_resource_init_t init,
- kunit_resource_free_t free,
- gfp_t internal_gfp,
- void *context)
- {
- struct kunit_resource *res;
- res = kzalloc(sizeof(*res), internal_gfp);
- if (!res)
- return NULL;
- if (!kunit_add_resource(test, init, free, res, context))
- return res->data;
- return NULL;
- }
- typedef bool (*kunit_resource_match_t)(struct kunit *test,
- struct kunit_resource *res,
- void *match_data);
- /**
- * kunit_resource_instance_match() - Match a resource with the same instance.
- * @test: Test case to which the resource belongs.
- * @res: The resource.
- * @match_data: The resource pointer to match against.
- *
- * An instance of kunit_resource_match_t that matches a resource whose
- * allocation matches @match_data.
- */
- static inline bool kunit_resource_instance_match(struct kunit *test,
- struct kunit_resource *res,
- void *match_data)
- {
- return res->data == match_data;
- }
- /**
- * kunit_resource_name_match() - Match a resource with the same name.
- * @test: Test case to which the resource belongs.
- * @res: The resource.
- * @match_name: The name to match against.
- */
- static inline bool kunit_resource_name_match(struct kunit *test,
- struct kunit_resource *res,
- void *match_name)
- {
- return res->name && strcmp(res->name, match_name) == 0;
- }
- /**
- * kunit_find_resource() - Find a resource using match function/data.
- * @test: Test case to which the resource belongs.
- * @match: match function to be applied to resources/match data.
- * @match_data: data to be used in matching.
- */
- static inline struct kunit_resource *
- kunit_find_resource(struct kunit *test,
- kunit_resource_match_t match,
- void *match_data)
- {
- struct kunit_resource *res, *found = NULL;
- spin_lock(&test->lock);
- list_for_each_entry_reverse(res, &test->resources, node) {
- if (match(test, res, (void *)match_data)) {
- found = res;
- kunit_get_resource(found);
- break;
- }
- }
- spin_unlock(&test->lock);
- return found;
- }
- /**
- * kunit_find_named_resource() - Find a resource using match name.
- * @test: Test case to which the resource belongs.
- * @name: match name.
- */
- static inline struct kunit_resource *
- kunit_find_named_resource(struct kunit *test,
- const char *name)
- {
- return kunit_find_resource(test, kunit_resource_name_match,
- (void *)name);
- }
- /**
- * kunit_destroy_resource() - Find a kunit_resource and destroy it.
- * @test: Test case to which the resource belongs.
- * @match: Match function. Returns whether a given resource matches @match_data.
- * @match_data: Data passed into @match.
- *
- * RETURNS:
- * 0 if kunit_resource is found and freed, -ENOENT if not found.
- */
- int kunit_destroy_resource(struct kunit *test,
- kunit_resource_match_t match,
- void *match_data);
- static inline int kunit_destroy_named_resource(struct kunit *test,
- const char *name)
- {
- return kunit_destroy_resource(test, kunit_resource_name_match,
- (void *)name);
- }
- /**
- * kunit_remove_resource() - remove resource from resource list associated with
- * test.
- * @test: The test context object.
- * @res: The resource to be removed.
- *
- * Note that the resource will not be immediately freed since it is likely
- * the caller has a reference to it via alloc_and_get() or find();
- * in this case a final call to kunit_put_resource() is required.
- */
- void kunit_remove_resource(struct kunit *test, struct kunit_resource *res);
- /**
- * kunit_kmalloc() - Like kmalloc() except the allocation is *test managed*.
- * @test: The test context object.
- * @size: The size in bytes of the desired memory.
- * @gfp: flags passed to underlying kmalloc().
- *
- * Just like `kmalloc(...)`, except the allocation is managed by the test case
- * and is automatically cleaned up after the test case concludes. See &struct
- * kunit_resource for more information.
- */
- void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp);
- /**
- * kunit_kfree() - Like kfree except for allocations managed by KUnit.
- * @test: The test case to which the resource belongs.
- * @ptr: The memory allocation to free.
- */
- void kunit_kfree(struct kunit *test, const void *ptr);
- /**
- * kunit_kzalloc() - Just like kunit_kmalloc(), but zeroes the allocation.
- * @test: The test context object.
- * @size: The size in bytes of the desired memory.
- * @gfp: flags passed to underlying kmalloc().
- *
- * See kzalloc() and kunit_kmalloc() for more information.
- */
- static inline void *kunit_kzalloc(struct kunit *test, size_t size, gfp_t gfp)
- {
- return kunit_kmalloc(test, size, gfp | __GFP_ZERO);
- }
- void kunit_cleanup(struct kunit *test);
- void kunit_log_append(char *log, const char *fmt, ...);
- /*
- * printk and log to per-test or per-suite log buffer. Logging only done
- * if CONFIG_KUNIT_DEBUGFS is 'y'; if it is 'n', no log is allocated/used.
- */
- #define kunit_log(lvl, test_or_suite, fmt, ...) \
- do { \
- printk(lvl fmt, ##__VA_ARGS__); \
- kunit_log_append((test_or_suite)->log, fmt "\n", \
- ##__VA_ARGS__); \
- } while (0)
- #define kunit_printk(lvl, test, fmt, ...) \
- kunit_log(lvl, test, KUNIT_SUBTEST_INDENT "# %s: " fmt, \
- (test)->name, ##__VA_ARGS__)
- /**
- * kunit_info() - Prints an INFO level message associated with @test.
- *
- * @test: The test context object.
- * @fmt: A printk() style format string.
- *
- * Prints an info level message associated with the test suite being run.
- * Takes a variable number of format parameters just like printk().
- */
- #define kunit_info(test, fmt, ...) \
- kunit_printk(KERN_INFO, test, fmt, ##__VA_ARGS__)
- /**
- * kunit_warn() - Prints a WARN level message associated with @test.
- *
- * @test: The test context object.
- * @fmt: A printk() style format string.
- *
- * Prints a warning level message.
- */
- #define kunit_warn(test, fmt, ...) \
- kunit_printk(KERN_WARNING, test, fmt, ##__VA_ARGS__)
- /**
- * kunit_err() - Prints an ERROR level message associated with @test.
- *
- * @test: The test context object.
- * @fmt: A printk() style format string.
- *
- * Prints an error level message.
- */
- #define kunit_err(test, fmt, ...) \
- kunit_printk(KERN_ERR, test, fmt, ##__VA_ARGS__)
- /**
- * KUNIT_SUCCEED() - A no-op expectation. Only exists for code clarity.
- * @test: The test context object.
- *
- * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
- * words, it does nothing and only exists for code clarity. See
- * KUNIT_EXPECT_TRUE() for more information.
- */
- #define KUNIT_SUCCEED(test) do {} while (0)
- void kunit_do_assertion(struct kunit *test,
- struct kunit_assert *assert,
- bool pass,
- const char *fmt, ...);
- #define KUNIT_ASSERTION(test, pass, assert_class, INITIALIZER, fmt, ...) do { \
- struct assert_class __assertion = INITIALIZER; \
- kunit_do_assertion(test, \
- &__assertion.assert, \
- pass, \
- fmt, \
- ##__VA_ARGS__); \
- } while (0)
- #define KUNIT_FAIL_ASSERTION(test, assert_type, fmt, ...) \
- KUNIT_ASSERTION(test, \
- false, \
- kunit_fail_assert, \
- KUNIT_INIT_FAIL_ASSERT_STRUCT(test, assert_type), \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_FAIL() - Always causes a test to fail when evaluated.
- * @test: The test context object.
- * @fmt: an informational message to be printed when the assertion is made.
- * @...: string format arguments.
- *
- * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
- * other words, it always results in a failed expectation, and consequently
- * always causes the test case to fail when evaluated. See KUNIT_EXPECT_TRUE()
- * for more information.
- */
- #define KUNIT_FAIL(test, fmt, ...) \
- KUNIT_FAIL_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_UNARY_ASSERTION(test, \
- assert_type, \
- condition, \
- expected_true, \
- fmt, \
- ...) \
- KUNIT_ASSERTION(test, \
- !!(condition) == !!expected_true, \
- kunit_unary_assert, \
- KUNIT_INIT_UNARY_ASSERT_STRUCT(test, \
- assert_type, \
- #condition, \
- expected_true), \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_TRUE_MSG_ASSERTION(test, assert_type, condition, fmt, ...) \
- KUNIT_UNARY_ASSERTION(test, \
- assert_type, \
- condition, \
- true, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_TRUE_ASSERTION(test, assert_type, condition) \
- KUNIT_TRUE_MSG_ASSERTION(test, assert_type, condition, NULL)
- #define KUNIT_FALSE_MSG_ASSERTION(test, assert_type, condition, fmt, ...) \
- KUNIT_UNARY_ASSERTION(test, \
- assert_type, \
- condition, \
- false, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_FALSE_ASSERTION(test, assert_type, condition) \
- KUNIT_FALSE_MSG_ASSERTION(test, assert_type, condition, NULL)
- /*
- * A factory macro for defining the assertions and expectations for the basic
- * comparisons defined for the built in types.
- *
- * Unfortunately, there is no common type that all types can be promoted to for
- * which all the binary operators behave the same way as for the actual types
- * (for example, there is no type that long long and unsigned long long can
- * both be cast to where the comparison result is preserved for all values). So
- * the best we can do is do the comparison in the original types and then coerce
- * everything to long long for printing; this way, the comparison behaves
- * correctly and the printed out value usually makes sense without
- * interpretation, but can always be interpreted to figure out the actual
- * value.
- */
- #define KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- op, \
- right, \
- fmt, \
- ...) \
- do { \
- typeof(left) __left = (left); \
- typeof(right) __right = (right); \
- ((void)__typecheck(__left, __right)); \
- \
- KUNIT_ASSERTION(test, \
- __left op __right, \
- assert_class, \
- ASSERT_CLASS_INIT(test, \
- assert_type, \
- #op, \
- #left, \
- __left, \
- #right, \
- __right), \
- fmt, \
- ##__VA_ARGS__); \
- } while (0)
- #define KUNIT_BASE_EQ_MSG_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, ==, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BASE_NE_MSG_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, !=, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BASE_LT_MSG_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, <, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BASE_LE_MSG_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, <=, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BASE_GT_MSG_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, >, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BASE_GE_MSG_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_BINARY_ASSERTION(test, \
- assert_class, \
- ASSERT_CLASS_INIT, \
- assert_type, \
- left, >=, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_EQ_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
- KUNIT_BASE_EQ_MSG_ASSERTION(test, \
- kunit_binary_assert, \
- KUNIT_INIT_BINARY_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_EQ_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_EQ_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_EQ_MSG_ASSERTION(test, \
- kunit_binary_ptr_assert, \
- KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_PTR_EQ_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_NE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
- KUNIT_BASE_NE_MSG_ASSERTION(test, \
- kunit_binary_assert, \
- KUNIT_INIT_BINARY_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_NE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_NE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_NE_MSG_ASSERTION(test, \
- kunit_binary_ptr_assert, \
- KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_PTR_NE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_LT_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
- KUNIT_BASE_LT_MSG_ASSERTION(test, \
- kunit_binary_assert, \
- KUNIT_INIT_BINARY_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_LT_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_LT_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_PTR_LT_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_LT_MSG_ASSERTION(test, \
- kunit_binary_ptr_assert, \
- KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_PTR_LT_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_PTR_LT_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_LE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
- KUNIT_BASE_LE_MSG_ASSERTION(test, \
- kunit_binary_assert, \
- KUNIT_INIT_BINARY_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_LE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_LE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_PTR_LE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_LE_MSG_ASSERTION(test, \
- kunit_binary_ptr_assert, \
- KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_PTR_LE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_PTR_LE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_GT_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
- KUNIT_BASE_GT_MSG_ASSERTION(test, \
- kunit_binary_assert, \
- KUNIT_INIT_BINARY_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_GT_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_GT_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_PTR_GT_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_GT_MSG_ASSERTION(test, \
- kunit_binary_ptr_assert, \
- KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_PTR_GT_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_PTR_GT_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_GE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
- KUNIT_BASE_GE_MSG_ASSERTION(test, \
- kunit_binary_assert, \
- KUNIT_INIT_BINARY_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_GE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_GE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_PTR_GE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BASE_GE_MSG_ASSERTION(test, \
- kunit_binary_ptr_assert, \
- KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_PTR_GE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_PTR_GE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_STR_ASSERTION(test, \
- assert_type, \
- left, \
- op, \
- right, \
- fmt, \
- ...) \
- do { \
- typeof(left) __left = (left); \
- typeof(right) __right = (right); \
- \
- KUNIT_ASSERTION(test, \
- strcmp(__left, __right) op 0, \
- kunit_binary_str_assert, \
- KUNIT_INIT_BINARY_STR_ASSERT_STRUCT(test, \
- assert_type, \
- #op, \
- #left, \
- __left, \
- #right, \
- __right), \
- fmt, \
- ##__VA_ARGS__); \
- } while (0)
- #define KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BINARY_STR_ASSERTION(test, \
- assert_type, \
- left, ==, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_STR_EQ_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- fmt, \
- ...) \
- KUNIT_BINARY_STR_ASSERTION(test, \
- assert_type, \
- left, !=, right, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_BINARY_STR_NE_ASSERTION(test, assert_type, left, right) \
- KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \
- assert_type, \
- left, \
- right, \
- NULL)
- #define KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
- assert_type, \
- ptr, \
- fmt, \
- ...) \
- do { \
- typeof(ptr) __ptr = (ptr); \
- \
- KUNIT_ASSERTION(test, \
- !IS_ERR_OR_NULL(__ptr), \
- kunit_ptr_not_err_assert, \
- KUNIT_INIT_PTR_NOT_ERR_STRUCT(test, \
- assert_type, \
- #ptr, \
- __ptr), \
- fmt, \
- ##__VA_ARGS__); \
- } while (0)
- #define KUNIT_PTR_NOT_ERR_OR_NULL_ASSERTION(test, assert_type, ptr) \
- KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
- assert_type, \
- ptr, \
- NULL)
- /**
- * KUNIT_EXPECT_TRUE() - Causes a test failure when the expression is not true.
- * @test: The test context object.
- * @condition: an arbitrary boolean expression. The test fails when this does
- * not evaluate to true.
- *
- * This and expectations of the form `KUNIT_EXPECT_*` will cause the test case
- * to fail when the specified condition is not met; however, it will not prevent
- * the test case from continuing to run; this is otherwise known as an
- * *expectation failure*.
- */
- #define KUNIT_EXPECT_TRUE(test, condition) \
- KUNIT_TRUE_ASSERTION(test, KUNIT_EXPECTATION, condition)
- #define KUNIT_EXPECT_TRUE_MSG(test, condition, fmt, ...) \
- KUNIT_TRUE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- condition, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_FALSE() - Makes a test failure when the expression is not false.
- * @test: The test context object.
- * @condition: an arbitrary boolean expression. The test fails when this does
- * not evaluate to false.
- *
- * Sets an expectation that @condition evaluates to false. See
- * KUNIT_EXPECT_TRUE() for more information.
- */
- #define KUNIT_EXPECT_FALSE(test, condition) \
- KUNIT_FALSE_ASSERTION(test, KUNIT_EXPECTATION, condition)
- #define KUNIT_EXPECT_FALSE_MSG(test, condition, fmt, ...) \
- KUNIT_FALSE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- condition, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_EQ() - Sets an expectation that @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an expectation that the values that @left and @right evaluate to are
- * equal. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) == (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_EQ(test, left, right) \
- KUNIT_BINARY_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_EQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_EQ_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_PTR_EQ() - Expects that pointers @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a pointer.
- * @right: an arbitrary expression that evaluates to a pointer.
- *
- * Sets an expectation that the values that @left and @right evaluate to are
- * equal. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) == (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_PTR_EQ(test, left, right) \
- KUNIT_BINARY_PTR_EQ_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right)
- #define KUNIT_EXPECT_PTR_EQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_NE() - An expectation that @left and @right are not equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an expectation that the values that @left and @right evaluate to are not
- * equal. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) != (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_NE(test, left, right) \
- KUNIT_BINARY_NE_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_NE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_NE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_PTR_NE() - Expects that pointers @left and @right are not equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a pointer.
- * @right: an arbitrary expression that evaluates to a pointer.
- *
- * Sets an expectation that the values that @left and @right evaluate to are not
- * equal. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) != (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_PTR_NE(test, left, right) \
- KUNIT_BINARY_PTR_NE_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right)
- #define KUNIT_EXPECT_PTR_NE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_LT() - An expectation that @left is less than @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an expectation that the value that @left evaluates to is less than the
- * value that @right evaluates to. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) < (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_LT(test, left, right) \
- KUNIT_BINARY_LT_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_LT_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_LT_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_LE() - Expects that @left is less than or equal to @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an expectation that the value that @left evaluates to is less than or
- * equal to the value that @right evaluates to. Semantically this is equivalent
- * to KUNIT_EXPECT_TRUE(@test, (@left) <= (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_LE(test, left, right) \
- KUNIT_BINARY_LE_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_LE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_LE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_GT() - An expectation that @left is greater than @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an expectation that the value that @left evaluates to is greater than
- * the value that @right evaluates to. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) > (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_GT(test, left, right) \
- KUNIT_BINARY_GT_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_GT_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_GT_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_GE() - Expects that @left is greater than or equal to @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an expectation that the value that @left evaluates to is greater than
- * the value that @right evaluates to. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, (@left) >= (@right)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_GE(test, left, right) \
- KUNIT_BINARY_GE_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_GE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_GE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_STREQ() - Expects that strings @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a null terminated string.
- * @right: an arbitrary expression that evaluates to a null terminated string.
- *
- * Sets an expectation that the values that @left and @right evaluate to are
- * equal. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, !strcmp((@left), (@right))). See KUNIT_EXPECT_TRUE()
- * for more information.
- */
- #define KUNIT_EXPECT_STREQ(test, left, right) \
- KUNIT_BINARY_STR_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_STREQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_STRNEQ() - Expects that strings @left and @right are not equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a null terminated string.
- * @right: an arbitrary expression that evaluates to a null terminated string.
- *
- * Sets an expectation that the values that @left and @right evaluate to are
- * not equal. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_EXPECT_TRUE()
- * for more information.
- */
- #define KUNIT_EXPECT_STRNEQ(test, left, right) \
- KUNIT_BINARY_STR_NE_ASSERTION(test, KUNIT_EXPECTATION, left, right)
- #define KUNIT_EXPECT_STRNEQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_EXPECT_NOT_ERR_OR_NULL() - Expects that @ptr is not null and not err.
- * @test: The test context object.
- * @ptr: an arbitrary pointer.
- *
- * Sets an expectation that the value that @ptr evaluates to is not null and not
- * an errno stored in a pointer. This is semantically equivalent to
- * KUNIT_EXPECT_TRUE(@test, !IS_ERR_OR_NULL(@ptr)). See KUNIT_EXPECT_TRUE() for
- * more information.
- */
- #define KUNIT_EXPECT_NOT_ERR_OR_NULL(test, ptr) \
- KUNIT_PTR_NOT_ERR_OR_NULL_ASSERTION(test, KUNIT_EXPECTATION, ptr)
- #define KUNIT_EXPECT_NOT_ERR_OR_NULL_MSG(test, ptr, fmt, ...) \
- KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
- KUNIT_EXPECTATION, \
- ptr, \
- fmt, \
- ##__VA_ARGS__)
- #define KUNIT_ASSERT_FAILURE(test, fmt, ...) \
- KUNIT_FAIL_ASSERTION(test, KUNIT_ASSERTION, fmt, ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true.
- * @test: The test context object.
- * @condition: an arbitrary boolean expression. The test fails and aborts when
- * this does not evaluate to true.
- *
- * This and assertions of the form `KUNIT_ASSERT_*` will cause the test case to
- * fail *and immediately abort* when the specified condition is not met. Unlike
- * an expectation failure, it will prevent the test case from continuing to run;
- * this is otherwise known as an *assertion failure*.
- */
- #define KUNIT_ASSERT_TRUE(test, condition) \
- KUNIT_TRUE_ASSERTION(test, KUNIT_ASSERTION, condition)
- #define KUNIT_ASSERT_TRUE_MSG(test, condition, fmt, ...) \
- KUNIT_TRUE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- condition, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
- * @test: The test context object.
- * @condition: an arbitrary boolean expression.
- *
- * Sets an assertion that the value that @condition evaluates to is false. This
- * is the same as KUNIT_EXPECT_FALSE(), except it causes an assertion failure
- * (see KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_FALSE(test, condition) \
- KUNIT_FALSE_ASSERTION(test, KUNIT_ASSERTION, condition)
- #define KUNIT_ASSERT_FALSE_MSG(test, condition, fmt, ...) \
- KUNIT_FALSE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- condition, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_EQ() - Sets an assertion that @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an assertion that the values that @left and @right evaluate to are
- * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
- * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_EQ(test, left, right) \
- KUNIT_BINARY_EQ_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_EQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_EQ_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a pointer.
- * @right: an arbitrary expression that evaluates to a pointer.
- *
- * Sets an assertion that the values that @left and @right evaluate to are
- * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
- * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_PTR_EQ(test, left, right) \
- KUNIT_BINARY_PTR_EQ_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_PTR_EQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_NE() - An assertion that @left and @right are not equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an assertion that the values that @left and @right evaluate to are not
- * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
- * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_NE(test, left, right) \
- KUNIT_BINARY_NE_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_NE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_NE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_PTR_NE() - Asserts that pointers @left and @right are not equal.
- * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a pointer.
- * @right: an arbitrary expression that evaluates to a pointer.
- *
- * Sets an assertion that the values that @left and @right evaluate to are not
- * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
- * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_PTR_NE(test, left, right) \
- KUNIT_BINARY_PTR_NE_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_PTR_NE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_LT() - An assertion that @left is less than @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an assertion that the value that @left evaluates to is less than the
- * value that @right evaluates to. This is the same as KUNIT_EXPECT_LT(), except
- * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
- * is not met.
- */
- #define KUNIT_ASSERT_LT(test, left, right) \
- KUNIT_BINARY_LT_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_LT_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_LT_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_LE() - An assertion that @left is less than or equal to @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an assertion that the value that @left evaluates to is less than or
- * equal to the value that @right evaluates to. This is the same as
- * KUNIT_EXPECT_LE(), except it causes an assertion failure (see
- * KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_LE(test, left, right) \
- KUNIT_BINARY_LE_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_LE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_LE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_GT() - An assertion that @left is greater than @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an assertion that the value that @left evaluates to is greater than the
- * value that @right evaluates to. This is the same as KUNIT_EXPECT_GT(), except
- * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
- * is not met.
- */
- #define KUNIT_ASSERT_GT(test, left, right) \
- KUNIT_BINARY_GT_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_GT_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_GT_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_GE() - Assertion that @left is greater than or equal to @right.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a primitive C type.
- * @right: an arbitrary expression that evaluates to a primitive C type.
- *
- * Sets an assertion that the value that @left evaluates to is greater than the
- * value that @right evaluates to. This is the same as KUNIT_EXPECT_GE(), except
- * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
- * is not met.
- */
- #define KUNIT_ASSERT_GE(test, left, right) \
- KUNIT_BINARY_GE_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_GE_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_GE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_STREQ() - An assertion that strings @left and @right are equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a null terminated string.
- * @right: an arbitrary expression that evaluates to a null terminated string.
- *
- * Sets an assertion that the values that @left and @right evaluate to are
- * equal. This is the same as KUNIT_EXPECT_STREQ(), except it causes an
- * assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_STREQ(test, left, right) \
- KUNIT_BINARY_STR_EQ_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_STREQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal.
- * @test: The test context object.
- * @left: an arbitrary expression that evaluates to a null terminated string.
- * @right: an arbitrary expression that evaluates to a null terminated string.
- *
- * Sets an expectation that the values that @left and @right evaluate to are
- * not equal. This is semantically equivalent to
- * KUNIT_ASSERT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_ASSERT_TRUE()
- * for more information.
- */
- #define KUNIT_ASSERT_STRNEQ(test, left, right) \
- KUNIT_BINARY_STR_NE_ASSERTION(test, KUNIT_ASSERTION, left, right)
- #define KUNIT_ASSERT_STRNEQ_MSG(test, left, right, fmt, ...) \
- KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- left, \
- right, \
- fmt, \
- ##__VA_ARGS__)
- /**
- * KUNIT_ASSERT_NOT_ERR_OR_NULL() - Assertion that @ptr is not null and not err.
- * @test: The test context object.
- * @ptr: an arbitrary pointer.
- *
- * Sets an assertion that the value that @ptr evaluates to is not null and not
- * an errno stored in a pointer. This is the same as
- * KUNIT_EXPECT_NOT_ERR_OR_NULL(), except it causes an assertion failure (see
- * KUNIT_ASSERT_TRUE()) when the assertion is not met.
- */
- #define KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr) \
- KUNIT_PTR_NOT_ERR_OR_NULL_ASSERTION(test, KUNIT_ASSERTION, ptr)
- #define KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, fmt, ...) \
- KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
- KUNIT_ASSERTION, \
- ptr, \
- fmt, \
- ##__VA_ARGS__)
- #endif /* _KUNIT_TEST_H */
|