UEFIStarter
a simple UEFI framework
asserts.h
Go to the documentation of this file.
1 
11 #ifndef __TEST_ASSERTS_H
12 #define __TEST_ASSERTS_H
13 
14 #include <Uefi.h>
15 #include <Library/UefiLib.h>
16 
17 
18 //invert next assertion check - there probably won't be a use case for this other than testing assertions themselves
19 extern BOOLEAN invert_next_assert;
20 
21 //boolean
22 
23 BOOLEAN assert_true(BOOLEAN actual, CHAR16 *message);
24 BOOLEAN assert_false(BOOLEAN actual, CHAR16 *message);
25 
26 
27 //numbers
28 
29 BOOLEAN assert_intn_equals(INTN expected, INTN actual, CHAR16 *message);
30 BOOLEAN assert_intn_greater_than_or_equal_to(INTN expected, INTN actual, CHAR16 *message);
31 BOOLEAN assert_intn_less_than_or_equal_to(INTN expected, INTN actual, CHAR16 *message);
32 BOOLEAN assert_intn_in_closed_interval(INTN min, INTN max, INTN actual, CHAR16 *message);
33 
34 BOOLEAN assert_uint64_equals(UINT64 expected, UINT64 actual, CHAR16 *message);
35 
36 BOOLEAN assert_double_near(double expected, double epsilon, double actual, CHAR16 *message);
37 BOOLEAN assert_double_greater_than(double threshold, double actual, CHAR16 *message);
38 BOOLEAN assert_double_greater_than_or_equal_to(double threshold, double actual, CHAR16 *message);
39 BOOLEAN assert_double_less_than(double threshold, double actual, CHAR16 *message);
40 BOOLEAN assert_double_less_than_or_equal_to(double threshold, double actual, CHAR16 *message);
41 
42 
43 //pointers and compounds
44 
45 BOOLEAN assert_null(void *actual, CHAR16 *message);
46 BOOLEAN assert_not_null(void *actual, CHAR16 *message);
47 
48 BOOLEAN assert_uint8_array(UINTN size, UINT8 *expected, UINT8 *actual, CHAR16 *message);
49 BOOLEAN assert_wcstr_equals(CHAR16 *expected, CHAR16 *actual, CHAR16 *message);
50 
51 BOOLEAN assert_pixel(EFI_GRAPHICS_OUTPUT_BLT_PIXEL expected, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message);
52 BOOLEAN assert_pixel_values(UINT8 red, UINT8 green, UINT8 blue, UINT8 reserved, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message);
53 BOOLEAN assert_pixel_near(EFI_GRAPHICS_OUTPUT_BLT_PIXEL expected, INTN epsilon, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message);
54 BOOLEAN assert_pixel_values_near(UINT8 red, UINT8 green, UINT8 blue, UINT8 reserved, INTN epsilon, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message);
55 
56 
57 #endif
BOOLEAN assert_pixel(EFI_GRAPHICS_OUTPUT_BLT_PIXEL expected, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message)
Asserts an EFI_GRAPHICS_OUTPUT_BLT_PIXEL equals an expected pixel.
Definition: asserts.c:342
BOOLEAN assert_double_greater_than(double threshold, double actual, CHAR16 *message)
Asserts a double value is >expectation.
Definition: asserts.c:200
BOOLEAN assert_double_greater_than_or_equal_to(double threshold, double actual, CHAR16 *message)
Asserts a double value is >=expectation.
Definition: asserts.c:213
BOOLEAN assert_uint8_array(UINTN size, UINT8 *expected, UINT8 *actual, CHAR16 *message)
Asserts an array of UINT8 values matches an expected array&#39;s values.
Definition: asserts.c:282
BOOLEAN assert_pixel_near(EFI_GRAPHICS_OUTPUT_BLT_PIXEL expected, INTN epsilon, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message)
Asserts an EFI_GRAPHICS_OUTPUT_BLT_PIXEL equals an expected pixel or the difference is within a given...
Definition: asserts.c:400
BOOLEAN assert_intn_less_than_or_equal_to(INTN expected, INTN actual, CHAR16 *message)
Asserts an integer value is <=expectation.
Definition: asserts.c:142
BOOLEAN assert_intn_greater_than_or_equal_to(INTN expected, INTN actual, CHAR16 *message)
Asserts an integer value is >=expectation.
Definition: asserts.c:129
BOOLEAN assert_double_less_than(double threshold, double actual, CHAR16 *message)
Asserts a double value is <expectation.
Definition: asserts.c:226
BOOLEAN assert_intn_equals(INTN expected, INTN actual, CHAR16 *message)
Asserts an integer value equals an expected value.
Definition: asserts.c:116
BOOLEAN assert_null(void *actual, CHAR16 *message)
Asserts a pointer is NULL.
Definition: asserts.c:256
BOOLEAN assert_double_less_than_or_equal_to(double threshold, double actual, CHAR16 *message)
Asserts a double value is <=expectation.
Definition: asserts.c:239
BOOLEAN assert_true(BOOLEAN actual, CHAR16 *message)
Asserts a boolean value is true.
Definition: asserts.c:86
BOOLEAN assert_double_near(double expected, double epsilon, double actual, CHAR16 *message)
Asserts a double value is within an epsilon radius around an expected value.
Definition: asserts.c:186
BOOLEAN assert_pixel_values(UINT8 red, UINT8 green, UINT8 blue, UINT8 reserved, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message)
Asserts an EFI_GRAPHICS_OUTPUT_BLT_PIXEL has expected channel values.
Definition: asserts.c:326
BOOLEAN assert_wcstr_equals(CHAR16 *expected, CHAR16 *actual, CHAR16 *message)
Asserts a string equals an expected string.
Definition: asserts.c:309
BOOLEAN invert_next_assert
Inverts the next executed assertion: failure becomes success and vice versa.
Definition: asserts.c:25
BOOLEAN assert_intn_in_closed_interval(INTN min, INTN max, INTN actual, CHAR16 *message)
Asserts an integer value is within an interval: min <= input <= max.
Definition: asserts.c:156
BOOLEAN assert_pixel_values_near(UINT8 red, UINT8 green, UINT8 blue, UINT8 reserved, INTN epsilon, EFI_GRAPHICS_OUTPUT_BLT_PIXEL actual, CHAR16 *message)
Asserts an EFI_GRAPHICS_OUTPUT_BLT_PIXEL has expected channel values or the difference is within a gi...
Definition: asserts.c:373
BOOLEAN assert_uint64_equals(UINT64 expected, UINT64 actual, CHAR16 *message)
Asserts a UINT64 equals an expected value.
Definition: asserts.c:170
BOOLEAN assert_not_null(void *actual, CHAR16 *message)
Asserts a pointer is anything but NULL.
Definition: asserts.c:268
BOOLEAN assert_false(BOOLEAN actual, CHAR16 *message)
Asserts a boolean value is false.
Definition: asserts.c:98