-
Notifications
You must be signed in to change notification settings - Fork 215
/
utbsp.h
115 lines (103 loc) · 3.98 KB
/
utbsp.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
* NASA Docket No. GSC-18,370-1, and identified as "Operating System Abstraction Layer"
*
* Copyright (c) 2019 United States Government as represented by
* the Administrator of the National Aeronautics and Space Administration.
* All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* \file
*
* Types and definitions for the generic Unit Test BSP interface implemented
* as part of OSAL.
*
* When the OSAL BSP is used to start the tests, the same BSP can also be used to output
* test status, this way alternate output resources can be used whenever needed.
*
* Provides a means to abstract the test start/stop and pass/fail reporting
* to a board-specific function. This allows tests to be better utilized on
* embedded targets that may not have a visible printf() function.
*
* (We should not assume a working "printf" anywhere in UT-assert)
*
* It also provides for BSP customizations to the way tests are launched
* and the way pass/fail determinations are made.
*/
#ifndef UTBSP_H
#define UTBSP_H
#include "common_types.h"
#include "utassert.h"
/**************************************************************
* Functions implemented by the UT-specific BSP
**************************************************************/
/*
* Note - functions here are not typically directly called by UT code, they
* are used by the framework to implement the common functions.
*
* In general, these should all be stateless in order to keep the implementation
* on the BSP side as simple as possible.
*/
/**
* Initialize the BSP for unit test.
*
* This is just a hook for the BSP to be informed of the start-of-test event and may be a no-op.
*/
void UT_BSP_Setup(void);
/**
* Initialize the unit test at the BSP layer.
*
* This is just a hook for the BSP to be informed of the start-of-test event and may be a no-op.
*
* \param[in] SegmentNumber Number of current test segment
* \param[in] SegmentName Name of current test segment
*/
void UT_BSP_StartTestSegment(uint32 SegmentNumber, const char *SegmentName);
/**
* The BSP text-output function for unit test messages.
*
* This is used by the unit test code, typically for progress messages. The destination is BSP-dependent
* and may or may not go to the same place that OS_printf() does. The BSP may choose to send this
* to a special/separate log file to separate the test progress messages from the OS_printf() messages
* produced by the application/function under test.
*
* \param MessageType The nature (verbosity) of the message. The BSP may allow the operator to select
* the maximum message verbosity at runtime to select what should go into the log file.
*
* \param OutputMessage The message text.
*/
void UT_BSP_DoText(uint8 MessageType, const char *OutputMessage);
/**
* The BSP overall test end function.
*
* Invokes the BSP-specific global pass/fail reporting mechanism based on the global overall pass/fail counters.
*
* This function ends the current test process and returns to the controlling process.
*
* \param TestCounters Counter object for the completed test
*/
void UT_BSP_EndTest(const UtAssert_TestCounter_t *TestCounters);
/**
* UT mutex lock for multi-threaded test support
*
* Lock that should be acquired before modifying any global test state variables
*/
void UT_BSP_Lock(void);
/**
* UT mutex unlock for multi-threaded test support
*
* Must be called after UT_BSP_Lock to allow other threads access to the global
*/
void UT_BSP_Unlock(void);
#endif /* UTBSP_H */