-
Notifications
You must be signed in to change notification settings - Fork 201
/
evs_UT.c
2125 lines (1800 loc) · 98.2 KB
/
evs_UT.c
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/************************************************************************
* NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
*
* Copyright (c) 2020 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 http: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:
** evs_UT.c
**
** Purpose:
** Event Services unit test
**
** References:
** 1. cFE Application Developers Guide
** 2. unit test standard 092503
** 3. C Coding Standard 102904
**
** Notes:
** 1. This is unit test code only, not for use in flight
**
*/
/*
** Includes
*/
#include "evs_UT.h"
#include "cfe_evs.h"
#include "utstubs.h"
static const char *EVS_SYSLOG_MSGS[] = {
NULL,
"%s: Call to CFE_PSP_GetResetArea failed, RC=0x%08x\n",
"%s: Unexpected size from CFE_PSP_GetResetArea: expected = 0x%08lX, actual = 0x%08lX\n",
"%s: OS_MutSemCreate failed, RC=%ld\n",
"%s: Event Log cleared following power-on reset\n",
"%s: Event Log cleared, n=%d, c=%d, f=%d, m=%d, o=%d\n",
"%s: Event Log restored, n=%d, c=%d, f=%d, m=%d, o=%d\n",
"%s: Application Init Failed,RC=0x%08X\n",
"%s: Error reading cmd pipe,RC=0x%08X\n",
NULL, /* old message removed - placeholder to maintain indices */
"%s: Call to CFE_ES_GetAppID Failed:RC=0x%08X\n",
"%s: Call to CFE_EVS_Register Failed:RC=0x%08X\n",
"%s: Call to CFE_SB_CreatePipe Failed:RC=0x%08X\n",
"%s: Subscribing to Cmds Failed:RC=0x%08X\n",
"%s: Subscribing to HK Request Failed:RC=0x%08X\n"};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_NOOP_CC = {.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID),
.CommandCode = CFE_EVS_NOOP_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_RESET_COUNTERS_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_RESET_COUNTERS_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_ENABLE_EVENT_TYPE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_ENABLE_EVENT_TYPE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_DISABLE_EVENT_TYPE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_DISABLE_EVENT_TYPE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_SET_EVENT_FORMAT_MODE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_SET_EVENT_FORMAT_MODE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_ENABLE_APP_EVENT_TYPE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_ENABLE_APP_EVENT_TYPE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_DISABLE_APP_EVENT_TYPE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_DISABLE_APP_EVENT_TYPE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_ENABLE_APP_EVENTS_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_ENABLE_APP_EVENTS_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_DISABLE_APP_EVENTS_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_DISABLE_APP_EVENTS_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_RESET_APP_COUNTER_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_RESET_APP_COUNTER_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_SET_FILTER_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_SET_FILTER_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_ENABLE_PORTS_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_ENABLE_PORTS_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_DISABLE_PORTS_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_RESET_FILTER_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_RESET_FILTER_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_RESET_ALL_FILTERS_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_RESET_ALL_FILTERS_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_ADD_EVENT_FILTER_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_ADD_EVENT_FILTER_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_DELETE_EVENT_FILTER_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_DELETE_EVENT_FILTER_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_WRITE_APP_DATA_FILE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_WRITE_APP_DATA_FILE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_WRITE_LOG_DATA_FILE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_WRITE_LOG_DATA_FILE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_SET_LOG_MODE_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_SET_LOG_MODE_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_CLEAR_LOG_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = CFE_EVS_CLEAR_LOG_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_INVALID_MID = {.MsgId = CFE_SB_MSGID_RESERVED, .CommandCode = 0};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_CMD_INVALID_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_CMD_MID), .CommandCode = 0x7F};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_EVS_SEND_HK = {.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_SEND_HK_MID)};
static const UT_SoftwareBusSnapshot_Entry_t UT_EVS_LONGFMT_SNAPSHOTDATA = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_LONG_EVENT_MSG_MID),
.SnapshotOffset = offsetof(CFE_EVS_LongEventTlm_t, Payload.PacketID.EventID),
.SnapshotSize = sizeof(uint16)};
static const UT_SoftwareBusSnapshot_Entry_t UT_EVS_SHORTFMT_SNAPSHOTDATA = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_SHORT_EVENT_MSG_MID),
.SnapshotOffset = offsetof(CFE_EVS_ShortEventTlm_t, Payload.PacketID.EventID),
.SnapshotSize = sizeof(uint16)};
typedef struct
{
uint16 EventID;
uint16 Count;
} UT_EVS_EventCapture_t;
static UT_EVS_EventCapture_t UT_EVS_EventBuf;
/* MSG Init hook data */
typedef struct
{
CFE_MSG_Message_t *MsgPtr;
CFE_SB_MsgId_t MsgId;
CFE_MSG_Size_t Size;
} UT_EVS_MSGInitData_t;
typedef CFE_Status_t (*UT_EVS_SendEventFunc_t)(uint32);
/* Message init hook to stora last MsgId passed in */
static int32 UT_EVS_MSGInitHook(void *UserObj, int32 StubRetcode, uint32 CallCount, const UT_StubContext_t *Context)
{
UT_EVS_MSGInitData_t *msgdataptr = UserObj;
msgdataptr->MsgPtr = UT_Hook_GetArgValueByName(Context, "MsgPtr", CFE_MSG_Message_t *);
msgdataptr->MsgId = UT_Hook_GetArgValueByName(Context, "MsgId", CFE_SB_MsgId_t);
msgdataptr->Size = UT_Hook_GetArgValueByName(Context, "Size", CFE_MSG_Size_t);
return StubRetcode;
}
static void UT_EVS_DoDispatchCheckEvents_Impl(void *MsgPtr, uint32 MsgSize, UT_TaskPipeDispatchId_t DispatchId,
const UT_SoftwareBusSnapshot_Entry_t *SnapshotCfg,
UT_EVS_EventCapture_t * EventCapture)
{
UT_SoftwareBusSnapshot_Entry_t SnapshotData = *SnapshotCfg;
EventCapture->EventID = 0xFFFF;
SnapshotData.SnapshotBuffer = &EventCapture->EventID;
UT_SetHookFunction(UT_KEY(CFE_SB_TransmitMsg), UT_SoftwareBusSnapshotHook, &SnapshotData);
UT_CallTaskPipe(CFE_EVS_ProcessCommandPacket, (CFE_MSG_Message_t *)MsgPtr, MsgSize, DispatchId);
EventCapture->Count += SnapshotData.Count;
/* be sure to clear the hook function since the SnapshotData is going out of scope */
UT_SetHookFunction(UT_KEY(CFE_SB_TransmitMsg), NULL, NULL);
}
static void UT_EVS_DoDispatchCheckEvents(void *MsgPtr, uint32 MsgSize, UT_TaskPipeDispatchId_t DispatchId,
UT_EVS_EventCapture_t *EventCapture)
{
UT_EVS_DoDispatchCheckEvents_Impl(MsgPtr, MsgSize, DispatchId, &UT_EVS_LONGFMT_SNAPSHOTDATA, EventCapture);
}
static void UT_EVS_DoDispatchCheckEventsShort(void *MsgPtr, uint32 MsgSize, UT_TaskPipeDispatchId_t DispatchId,
UT_EVS_EventCapture_t *EventCapture)
{
UT_EVS_DoDispatchCheckEvents_Impl(MsgPtr, MsgSize, DispatchId, &UT_EVS_SHORTFMT_SNAPSHOTDATA, EventCapture);
}
static void UT_EVS_DoGenericCheckEvents(void (*Func)(void), UT_EVS_EventCapture_t *EventCapture)
{
UT_SoftwareBusSnapshot_Entry_t SnapshotData = UT_EVS_LONGFMT_SNAPSHOTDATA;
EventCapture->EventID = -1;
SnapshotData.SnapshotBuffer = &EventCapture->EventID;
UT_SetHookFunction(UT_KEY(CFE_SB_TransmitMsg), UT_SoftwareBusSnapshotHook, &SnapshotData);
Func();
EventCapture->Count += SnapshotData.Count;
/* be sure to clear the hook function since the SnapshotData is going out of scope */
UT_SetHookFunction(UT_KEY(CFE_SB_TransmitMsg), NULL, NULL);
}
static CFE_Status_t UT_EVS_SendSquelchedEvent(uint32 EventId)
{
return CFE_EVS_SendEvent(EventId, CFE_EVS_EventType_INFORMATION, "Suppressed Message");
}
static CFE_Status_t UT_EVS_SendSquelchedEventWithAppId(uint32 EventId)
{
CFE_ES_AppId_t AppID;
CFE_ES_GetAppID(&AppID);
return CFE_EVS_SendEventWithAppID(EventId, CFE_EVS_EventType_INFORMATION, AppID, "Suppressed Message");
}
static CFE_Status_t UT_EVS_SendSquelchedTimedEvent(uint32 EventId)
{
CFE_TIME_SysTime_t Time = {0, 0};
return CFE_EVS_SendTimedEvent(Time, EventId, CFE_EVS_EventType_INFORMATION, "Suppressed Message");
}
static void UT_EVS_ResetSquelchCurrentContext(void)
{
EVS_AppData_t *AppDataPtr;
EVS_GetCurrentContext(&AppDataPtr, NULL);
if (AppDataPtr)
{
AppDataPtr->SquelchedCount = 0;
AppDataPtr->SquelchTokens = CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST * 1000;
AppDataPtr->LastSquelchCreditableTime = OS_TimeAssembleFromMilliseconds(0, 0);
}
}
static void UT_EVS_DisableSquelch(void)
{
CFE_EVS_Global.EVS_EventBurstMax = 0;
}
static void UT_EVS_ResetSquelch(void)
{
CFE_EVS_Global.EVS_EventBurstMax = CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST;
}
/*
** Functions
*/
void UtTest_Setup(void)
{
/* Initialize unit test */
UT_Init("evs");
UtPrintf("cFE EVS Unit Test Output File\n\n");
/* Test_Init is a test but also MUST be called first and only once */
UT_ADD_TEST(Test_Init);
UT_ADD_TEST(Test_IllegalAppID);
UT_ADD_TEST(Test_UnregisteredApp);
UT_ADD_TEST(Test_FilterRegistration);
UT_ADD_TEST(Test_FilterReset);
UT_ADD_TEST(Test_Format);
UT_ADD_TEST(Test_Ports);
UT_ADD_TEST(Test_Logging);
UT_ADD_TEST(Test_WriteApp);
UT_ADD_TEST(Test_BadAppCmd);
UT_ADD_TEST(Test_EventCmd);
UT_ADD_TEST(Test_FilterCmd);
UT_ADD_TEST(Test_InvalidCmd);
UT_ADD_TEST(Test_Squelching);
UT_ADD_TEST(Test_Misc);
}
/*
** Initialization test, must be called first
*/
void Test_Init(void)
{
CFE_EVS_BitMaskCmd_t bitmaskcmd;
CFE_EVS_AppNameBitMaskCmd_t appbitcmd;
CFE_SB_MsgId_t msgid = CFE_SB_INVALID_MSG_ID;
UtPrintf("Begin Test Init");
memset(&bitmaskcmd, 0, sizeof(bitmaskcmd));
memset(&appbitcmd, 0, sizeof(appbitcmd));
strncpy(appbitcmd.Payload.AppName, "ut_cfe_evs", sizeof(appbitcmd.Payload.AppName) - 1);
appbitcmd.Payload.AppName[sizeof(appbitcmd.Payload.AppName) - 1] = '\0';
/* Test successful early initialization of the cFE EVS */
UT_InitData();
UT_SetSizeofESResetArea(sizeof(CFE_ES_ResetData_t));
UT_SetDeferredRetcode(UT_KEY(OS_MutSemCreate), 1, OS_SUCCESS);
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, CFE_PSP_RST_TYPE_POWERON);
CFE_EVS_EarlyInit();
CFE_EVS_Global.IncludeTimeInPortSend = false; /* Do generic testing without time in port message */
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[4]);
/* Task main with init failure */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetAppID), 1, -1);
UtAssert_VOIDCALL(CFE_EVS_TaskMain());
/* Test TaskMain with a command pipe read failure due to an
* invalid command packet
*/
UtPrintf("CFE_EVS_TaskMain - Test error reading command pipe, unrecognized msgid");
UT_InitData();
/* Set unexpected message ID */
UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &msgid, sizeof(msgid), false);
UT_EVS_DoGenericCheckEvents(CFE_EVS_TaskMain, &UT_EVS_EventBuf);
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[8]);
UtAssert_INT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_MSGID_EID);
/* Test early initialization with a get reset area failure */
UT_InitData();
UT_SetStatusBSPResetArea(-1, CFE_TIME_RESET_SIGNATURE, CFE_TIME_ToneSignalSelect_PRIMARY);
CFE_EVS_EarlyInit();
UT_SetStatusBSPResetArea(OS_SUCCESS, CFE_TIME_RESET_SIGNATURE, CFE_TIME_ToneSignalSelect_PRIMARY);
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[1]);
/* Test early initialization, restoring the event log */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, -1);
CFE_EVS_EarlyInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[6]);
/* Test early initialization, clearing the event log (log mode path) */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, -1);
CFE_EVS_Global.EVS_LogPtr->LogMode = CFE_EVS_LogMode_OVERWRITE + CFE_EVS_LogMode_DISCARD + 1;
CFE_EVS_Global.EVS_LogPtr->LogFullFlag = false;
CFE_EVS_Global.EVS_LogPtr->Next = CFE_PLATFORM_EVS_LOG_MAX - 1;
CFE_EVS_EarlyInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[5]);
/* Test early initialization, clearing the event log (log full path) */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, -1);
CFE_EVS_Global.EVS_LogPtr->LogMode = CFE_EVS_LogMode_DISCARD;
CFE_EVS_Global.EVS_LogPtr->LogFullFlag = 2;
CFE_EVS_Global.EVS_LogPtr->Next = CFE_PLATFORM_EVS_LOG_MAX - 1;
CFE_EVS_EarlyInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[5]);
/* Test early initialization, clearing the event log (next log path) */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, -1);
CFE_EVS_Global.EVS_LogPtr->LogMode = CFE_EVS_LogMode_OVERWRITE;
CFE_EVS_Global.EVS_LogPtr->LogFullFlag = true;
CFE_EVS_Global.EVS_LogPtr->Next = CFE_PLATFORM_EVS_LOG_MAX;
CFE_EVS_EarlyInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[5]);
/* Test early initialization with a mutex creation failure */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(OS_MutSemCreate), 1, -1);
CFE_EVS_EarlyInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[3]);
/* Test early initialization with an unexpected size returned
* by CFE_PSP_GetResetArea
*/
UT_InitData();
UT_SetSizeofESResetArea(0);
CFE_EVS_EarlyInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[2]);
/* Repeat successful initialization to configure log for later references */
UT_InitData();
UT_SetSizeofESResetArea(sizeof(CFE_ES_ResetData_t));
UT_SetDeferredRetcode(UT_KEY(OS_MutSemCreate), 1, OS_SUCCESS);
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, CFE_PSP_RST_TYPE_POWERON);
CFE_EVS_EarlyInit();
CFE_EVS_Global.IncludeTimeInPortSend = false; /* Do generic testing without time in port message */
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[4]);
/* Test task initialization where event services fails */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetAppID), 2, -1); /* Set Failure in CFE_EVS_Register -> EVS_GetApp_ID */
CFE_EVS_TaskInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[11]);
/* Test task initialization where the pipe creation fails */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_SB_CreatePipe), 1, -1);
CFE_EVS_TaskInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[12]);
/* Test task initialization where command subscription fails */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_SB_Subscribe), 1, -1);
CFE_EVS_TaskInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[13]);
/* Test task initialization where HK request subscription fails */
UT_InitData();
UT_SetDeferredRetcode(UT_KEY(CFE_SB_Subscribe), 2, -1);
CFE_EVS_TaskInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[14]);
/* Test task initialization where getting the application ID fails */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_GetAppID), -1);
CFE_EVS_TaskInit();
CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[10]);
/* Test successful task initialization */
UT_InitData();
CFE_EVS_TaskInit();
UtAssert_STUB_COUNT(CFE_ES_WriteToSysLog, 0);
/* Enable DEBUG message output */
UT_InitData();
appbitcmd.Payload.BitMask = CFE_EVS_DEBUG_BIT | CFE_EVS_INFORMATION_BIT | CFE_EVS_ERROR_BIT | CFE_EVS_CRITICAL_BIT;
UT_EVS_DoDispatchCheckEvents(&appbitcmd, sizeof(appbitcmd), UT_TPID_CFE_EVS_CMD_ENABLE_APP_EVENT_TYPE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ENAAPPEVTTYPE_EID);
/* Disable ports */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT1_BIT | CFE_EVS_PORT2_BIT | CFE_EVS_PORT3_BIT | CFE_EVS_PORT4_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_DISPORT_EID);
UT_EVS_DisableSquelch();
}
/*
** Test functions using an illegal application ID
*/
void Test_IllegalAppID(void)
{
CFE_TIME_SysTime_t time = {0, 0};
CFE_ES_AppId_t AppID;
UtPrintf("Begin Test Illegal App ID");
/* Set test up with illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
/* Test registering an event using an illegal application ID */
UtAssert_INT32_EQ(CFE_EVS_Register(NULL, 0, 0), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test sending events with a NULL spec */
UtAssert_INT32_EQ(CFE_EVS_SendEvent(0, 0, NULL), CFE_EVS_INVALID_PARAMETER);
UtAssert_INT32_EQ(CFE_EVS_SendEventWithAppID(0, 0, CFE_ES_APPID_UNDEFINED, NULL), CFE_EVS_INVALID_PARAMETER);
UtAssert_INT32_EQ(CFE_EVS_SendTimedEvent(time, 0, 0, NULL), CFE_EVS_INVALID_PARAMETER);
/* Test sending an event using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
UtAssert_INT32_EQ(CFE_EVS_SendEvent(0, 0, "NULL"), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test sending an event using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
CFE_UtAssert_SUCCESS(EVS_SendEvent(0, 0, "NULL"));
/* Test sending a timed event using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
UtAssert_INT32_EQ(CFE_EVS_SendTimedEvent(time, 0, 0, "NULL"), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test sending an event with app ID using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
UtAssert_INT32_EQ(CFE_EVS_SendEventWithAppID(0, 0, CFE_ES_APPID_UNDEFINED, "NULL"), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test resetting a filter using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
UtAssert_INT32_EQ(CFE_EVS_ResetFilter(0), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test resetting all filters using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
UtAssert_INT32_EQ(CFE_EVS_ResetAllFilters(), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test application cleanup using an illegal application ID */
UT_InitData();
UT_SetDefaultReturnValue(UT_KEY(CFE_ES_AppID_ToIndex), CFE_ES_ERR_RESOURCEID_NOT_VALID);
UtAssert_INT32_EQ(CFE_EVS_CleanUpApp(CFE_ES_APPID_UNDEFINED), CFE_EVS_APP_ILLEGAL_APP_ID);
/* Test with out of range AppID */
UT_InitData();
AppID = CFE_ES_APPID_C(CFE_ResourceId_FromInteger(CFE_PLATFORM_ES_MAX_APPLICATIONS));
UtAssert_INT32_EQ(CFE_EVS_SendEventWithAppID(0, 0, AppID, "NULL"), CFE_EVS_APP_ILLEGAL_APP_ID);
}
/*
** Test functions using an unregistered application
*/
void Test_UnregisteredApp(void)
{
CFE_TIME_SysTime_t time = {0, 0};
EVS_AppData_t * AppDataPtr;
CFE_ES_AppId_t AppID;
/* Get a local ref to the "current" AppData table entry */
EVS_GetCurrentContext(&AppDataPtr, &AppID);
UtPrintf("Begin Test Unregistered App");
UT_InitData();
/* Unregister the application (it was registered in CFE_EVS_TaskInit) */
CFE_EVS_CleanUpApp(AppID);
/* Test sending an event to an unregistered application */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_SendEvent(0, 0, "NULL"), CFE_EVS_APP_NOT_REGISTERED);
/* Test resetting a filter using an unregistered application */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_ResetFilter(0), CFE_EVS_APP_NOT_REGISTERED);
/* Test resetting all filters using an unregistered application */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_ResetAllFilters(), CFE_EVS_APP_NOT_REGISTERED);
/* Test sending an event with app ID to an unregistered application */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_SendEventWithAppID(0, CFE_EVS_EventType_INFORMATION, AppID, "NULL"),
CFE_EVS_APP_NOT_REGISTERED);
/* Test sending a timed event to an unregistered application */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_SendTimedEvent(time, CFE_EVS_EventType_INFORMATION, 0, "NULL"),
CFE_EVS_APP_NOT_REGISTERED);
/* Test application cleanup using an unregistered application */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_CleanUpApp(AppID));
/* Re-register the application for subsequent tests */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_Register(NULL, 0, CFE_EVS_EventFilter_BINARY));
}
/*
** Test filter registration related calls
*/
void Test_FilterRegistration(void)
{
int i;
CFE_EVS_BinFilter_t filter[CFE_PLATFORM_EVS_MAX_EVENT_FILTERS + 1];
EVS_BinFilter_t * FilterPtr = NULL;
EVS_AppData_t * AppDataPtr;
CFE_ES_AppId_t AppID;
CFE_TIME_SysTime_t time = {0, 0};
/* Get a local ref to the "current" AppData table entry */
EVS_GetCurrentContext(&AppDataPtr, &AppID);
UtPrintf("Begin Test Filter Registration");
CFE_EVS_Global.EVS_AppID = AppID;
CFE_EVS_Global.EVS_TlmPkt.Payload.MessageFormatMode = CFE_EVS_MsgFormat_LONG;
/* Test filter registration using an invalid filter option */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_Register(NULL, 0, CFE_EVS_EventFilter_BINARY + 1), CFE_EVS_UNKNOWN_FILTER);
/* Test successful filter registration with no filters */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_Register(NULL, 0, CFE_EVS_EventFilter_BINARY));
/* Re-register to test valid unregistration */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_Register(NULL, 0, CFE_EVS_EventFilter_BINARY));
/* Test successful app cleanup */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_CleanUpApp(AppID));
/* Test successful filter registration with a valid filter */
UT_InitData();
filter[0].EventID = 0;
filter[0].Mask = 0x0001;
CFE_UtAssert_SUCCESS(CFE_EVS_Register(filter, 1, CFE_EVS_EventFilter_BINARY));
/* Test successful multiple filter registration with valid filters */
UT_InitData();
for (i = 0; i < CFE_PLATFORM_EVS_MAX_EVENT_FILTERS + 1; i++)
{
filter[i].EventID = i;
filter[i].Mask = 1;
}
CFE_UtAssert_SUCCESS(CFE_EVS_Register(filter, CFE_PLATFORM_EVS_MAX_EVENT_FILTERS + 1, CFE_EVS_EventFilter_BINARY));
CFE_EVS_Global.EVS_TlmPkt.Payload.MessageSendCounter = 0;
/* Send 1st information message, should get through */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "OK"));
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_TlmPkt.Payload.MessageSendCounter, 1);
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_SB_TransmitMsg)), 1);
/* Send 2nd information message, should be filtered */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "FAILED"));
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_TlmPkt.Payload.MessageSendCounter, 1);
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_SB_TransmitMsg)), 0);
/* Send last information message, which should cause filtering to lock */
UT_InitData();
FilterPtr = EVS_FindEventID(0, (EVS_BinFilter_t *)AppDataPtr->BinFilters);
FilterPtr->Count = CFE_EVS_MAX_FILTER_COUNT - 1;
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "OK"));
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_TlmPkt.Payload.MessageSendCounter, 3);
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_SB_TransmitMsg)), 2);
UtAssert_UINT32_EQ(FilterPtr->Count, CFE_EVS_MAX_FILTER_COUNT);
/* Test that filter lock is applied */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "FAILED"));
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_TlmPkt.Payload.MessageSendCounter, 3);
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_SB_TransmitMsg)), 0);
UtAssert_UINT32_EQ(FilterPtr->Count, CFE_EVS_MAX_FILTER_COUNT);
/* Test that filter lock is (still) applied */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "FAILED"));
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_TlmPkt.Payload.MessageSendCounter, 3);
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_SB_TransmitMsg)), 0);
UtAssert_UINT32_EQ(FilterPtr->Count, CFE_EVS_MAX_FILTER_COUNT);
/* Return application to original state: re-register application */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_Register(NULL, 0, CFE_EVS_EventFilter_BINARY));
/* Test sending an event with app ID to a registered, filtered
* application
*/
UT_InitData();
AppDataPtr->AppID = AppID;
AppDataPtr->ActiveFlag = false;
CFE_UtAssert_SUCCESS(CFE_EVS_SendEventWithAppID(0, CFE_EVS_EventType_INFORMATION, AppID, "NULL"));
/* Test sending a timed event to a registered, filtered application */
UT_InitData();
AppDataPtr->AppID = AppID;
AppDataPtr->ActiveFlag = false;
CFE_UtAssert_SUCCESS(CFE_EVS_SendTimedEvent(time, CFE_EVS_EventType_INFORMATION, 0, "NULL"));
}
/*
** Test reset filter calls
*/
void Test_FilterReset(void)
{
CFE_EVS_BinFilter_t filter;
UtPrintf("Begin Test Filter Reset");
/* Test successful filter registration */
UT_InitData();
filter.EventID = 1;
filter.Mask = 0x0001;
CFE_UtAssert_SUCCESS(CFE_EVS_Register(&filter, 1, CFE_EVS_EventFilter_BINARY));
/* Test filter reset using an invalid event ID */
UT_InitData();
UtAssert_INT32_EQ(CFE_EVS_ResetFilter(CFE_PLATFORM_EVS_MAX_EVENT_FILTERS + 1), CFE_EVS_EVT_NOT_REGISTERED);
/* Test filter reset using an unregistered event ID */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_ResetFilter(-1));
/* Test successful filter reset */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_ResetFilter(1));
/* Test successful reset of all filters */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_ResetAllFilters());
/* Return application to original state: re-register application */
UT_InitData();
CFE_UtAssert_SUCCESS(CFE_EVS_Register(NULL, 0, CFE_EVS_EventFilter_BINARY));
}
/*
** Test long and short format events, and event strings
** greater than the maximum length allowed
*/
void Test_Format(void)
{
int i;
char long_msg[CFE_MISSION_EVS_MAX_MESSAGE_LENGTH + 2];
uint16 EventID[2];
CFE_TIME_SysTime_t time = {0, 0};
CFE_EVS_SetEventFormatModeCmd_t modecmd;
CFE_EVS_AppNameBitMaskCmd_t appbitcmd;
CFE_EVS_PacketID_t CapturedMsg;
UT_SoftwareBusSnapshot_Entry_t LongFmtSnapshotData = {.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_LONG_EVENT_MSG_MID),
.SnapshotBuffer = &CapturedMsg,
.SnapshotOffset =
offsetof(CFE_EVS_LongEventTlm_t, Payload.PacketID),
.SnapshotSize = sizeof(CapturedMsg)};
UT_SoftwareBusSnapshot_Entry_t ShortFmtSnapshotData = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_SHORT_EVENT_MSG_MID),
.SnapshotBuffer = &CapturedMsg,
.SnapshotOffset = offsetof(CFE_EVS_ShortEventTlm_t, Payload.PacketID),
.SnapshotSize = sizeof(CapturedMsg)};
EVS_AppData_t * AppDataPtr;
CFE_ES_AppId_t AppID;
UT_EVS_MSGInitData_t MsgData;
CFE_MSG_Message_t * MsgSend;
memset(&modecmd, 0, sizeof(modecmd));
/* Get a local ref to the "current" AppData table entry */
EVS_GetCurrentContext(&AppDataPtr, &AppID);
UtPrintf("Begin Test Format");
CFE_EVS_Global.EVS_TlmPkt.Payload.MessageFormatMode = CFE_EVS_MsgFormat_LONG;
/* Enable DEBUG message output */
UT_InitData();
strncpy(appbitcmd.Payload.AppName, "ut_cfe_evs", sizeof(appbitcmd.Payload.AppName) - 1);
appbitcmd.Payload.AppName[sizeof(appbitcmd.Payload.AppName) - 1] = '\0';
modecmd.Payload.MsgFormat = CFE_EVS_MsgFormat_LONG;
appbitcmd.Payload.BitMask = CFE_EVS_DEBUG_BIT | CFE_EVS_INFORMATION_BIT | CFE_EVS_ERROR_BIT | CFE_EVS_CRITICAL_BIT;
UT_EVS_DoDispatchCheckEvents(&appbitcmd, sizeof(appbitcmd), UT_TPID_CFE_EVS_CMD_ENABLE_APP_EVENT_TYPE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ENAAPPEVTTYPE_EID);
/* Test set event format mode command using an invalid mode */
UT_InitData();
modecmd.Payload.MsgFormat = 0xff;
UT_EVS_DoDispatchCheckEvents(&modecmd, sizeof(modecmd), UT_TPID_CFE_EVS_CMD_SET_EVENT_FORMAT_MODE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_ILLEGALFMTMOD_EID);
/* Test set event format mode command using a valid command to set short
* format, reports implicitly via event
*/
UT_InitData();
modecmd.Payload.MsgFormat = CFE_EVS_MsgFormat_SHORT;
UT_EVS_DoDispatchCheckEventsShort(&modecmd, sizeof(modecmd), UT_TPID_CFE_EVS_CMD_SET_EVENT_FORMAT_MODE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_SETEVTFMTMOD_EID);
UtPrintf("Test for short event sent when configured to do so ");
UT_InitData();
UT_SetHookFunction(UT_KEY(CFE_MSG_Init), UT_EVS_MSGInitHook, &MsgData);
UT_SetDataBuffer(UT_KEY(CFE_SB_TransmitMsg), &MsgSend, sizeof(MsgSend), false);
CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "Short format check 1");
/* Note implementation initializes both short and long message */
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_MSG_Init)), 2);
UtAssert_INT32_EQ(UT_GetStubCount(UT_KEY(CFE_SB_TransmitMsg)), 1);
UtAssert_BOOL_TRUE(CFE_SB_MsgId_Equal(MsgData.MsgId, ShortFmtSnapshotData.MsgId));
UtAssert_BOOL_FALSE(CFE_SB_MsgId_Equal(MsgData.MsgId, LongFmtSnapshotData.MsgId));
/* Confirm the right message was sent */
UtAssert_ADDRESS_EQ(MsgSend, MsgData.MsgPtr);
/* Test set event format mode command using a valid command to set long
* format, reports implicitly via event
*/
UT_InitData();
modecmd.Payload.MsgFormat = CFE_EVS_MsgFormat_LONG;
UT_EVS_DoDispatchCheckEvents(&modecmd, sizeof(modecmd), UT_TPID_CFE_EVS_CMD_SET_EVENT_FORMAT_MODE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_SETEVTFMTMOD_EID);
/* Test event long format mode command was successful (the following
* messages are output if long format selection is successful)
*/
UT_InitData();
memset(&CapturedMsg, 0xFF, sizeof(CapturedMsg));
UT_SetHookFunction(UT_KEY(CFE_SB_TransmitMsg), UT_SoftwareBusSnapshotHook, &LongFmtSnapshotData);
CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "Long format check (SendEvent)");
EventID[0] = CapturedMsg.EventID;
memset(&CapturedMsg, 0xFF, sizeof(CapturedMsg));
CFE_EVS_SendTimedEvent(time, 0, CFE_EVS_EventType_INFORMATION, "Long format check (SendTimedEvent)");
EventID[1] = CapturedMsg.EventID;
memset(&CapturedMsg, 0xFF, sizeof(CapturedMsg));
CFE_EVS_SendEventWithAppID(0, CFE_EVS_EventType_INFORMATION, AppID, "Long format check (SendEventWithAppID)");
UtAssert_ZERO(EventID[0]);
UtAssert_ZERO(EventID[1]);
UtAssert_ZERO(CapturedMsg.EventID);
/* Test sending an event using a string length greater than
* the maximum allowed
*/
UT_InitData();
for (i = 0; i <= CFE_MISSION_EVS_MAX_MESSAGE_LENGTH; i++)
{
long_msg[i] = (char)(i % 10 + 48);
}
long_msg[CFE_MISSION_EVS_MAX_MESSAGE_LENGTH + 1] = '\0';
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "%s", long_msg));
/* Test sending an event with application ID using a string length
* greater than the maximum allowed
*/
CFE_UtAssert_SUCCESS(CFE_EVS_SendEventWithAppID(0, CFE_EVS_EventType_INFORMATION, AppID, "%s", long_msg));
/* Test sending a timed event using a string length greater than
* the maximum allowed
*/
CFE_UtAssert_SUCCESS(CFE_EVS_SendTimedEvent(time, 0, CFE_EVS_EventType_INFORMATION, "%s", long_msg));
/* Force an invalid format and send for code coverage */
CFE_EVS_Global.EVS_TlmPkt.Payload.MessageFormatMode = CFE_EVS_MsgFormat_LONG + 1;
CFE_UtAssert_SUCCESS(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "%s", long_msg));
}
/*
** Test enable/disable of port outputs
*/
void Test_Ports(void)
{
CFE_EVS_BitMaskCmd_t bitmaskcmd;
UT_SoftwareBusSnapshot_Entry_t LocalSnapshotData = {.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_EVS_LONG_EVENT_MSG_MID)};
CFE_TIME_SysTime_t PacketTime;
memset(&PacketTime, 0, sizeof(PacketTime));
memset(&bitmaskcmd, 0, sizeof(bitmaskcmd));
UtPrintf("Begin Test Ports");
CFE_EVS_Global.EVS_TlmPkt.Payload.MessageFormatMode = CFE_EVS_MsgFormat_LONG;
/* Test enabling all ports; reports implicitly via port output */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT1_BIT | CFE_EVS_PORT2_BIT | CFE_EVS_PORT3_BIT | CFE_EVS_PORT4_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_ENABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ENAPORT_EID);
/* Test that ports are enabled by sending a message */
UT_InitData();
UT_SetHookFunction(UT_KEY(CFE_SB_TransmitMsg), UT_SoftwareBusSnapshotHook, &LocalSnapshotData);
UtAssert_UINT32_EQ(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "Test ports message"), CFE_SUCCESS);
UtAssert_UINT32_EQ(LocalSnapshotData.Count, 1);
UtAssert_STUB_COUNT(CFE_TIME_Print, 0);
/* Test with time included */
UT_InitData();
CFE_EVS_Global.IncludeTimeInPortSend = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgTime), &PacketTime, sizeof(PacketTime), false);
UtAssert_UINT32_EQ(CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "Test ports message"), CFE_SUCCESS);
UtAssert_STUB_COUNT(CFE_TIME_Print, 1);
CFE_EVS_Global.IncludeTimeInPortSend = false; /* Do generic testing without time in port message */
/* Disable all ports to cut down on unneeded output */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT1_BIT | CFE_EVS_PORT2_BIT | CFE_EVS_PORT3_BIT | CFE_EVS_PORT4_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_DISPORT_EID);
/* Test enabling a port using a bitmask that is out of range (high) */
UT_InitData();
bitmaskcmd.Payload.BitMask = 0xff;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_ENABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_INVALID_BITMASK_EID);
/* Test disabling a port using a bitmask that is out of range */
UT_InitData();
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_INVALID_BITMASK_EID);
/* Test enabling a port using a bitmask that is out of range (low) */
UT_InitData();
bitmaskcmd.Payload.BitMask = 0x0;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_ENABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_INVALID_BITMASK_EID);
/* Test enabling a port 1 and 2, but not 3 and 4 (branch path coverage) */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT1_BIT | CFE_EVS_PORT2_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_ENABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ENAPORT_EID);
/* Test enabling a port 3 and 4, but not 1 and 2 (branch path coverage) */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT3_BIT | CFE_EVS_PORT4_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_ENABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ENAPORT_EID);
/* Test disabling a port using a bitmask that is out of range (low) */
UT_InitData();
bitmaskcmd.Payload.BitMask = 0x0;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_INVALID_BITMASK_EID);
/* Test disabling a port 1 and 2, but not 3 and 4 (branch path coverage) */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT1_BIT | CFE_EVS_PORT2_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_DISPORT_EID);
/* Test disabling a port 3 and 4, but not 1 and 2 (branch path coverage) */
UT_InitData();
bitmaskcmd.Payload.BitMask = CFE_EVS_PORT3_BIT | CFE_EVS_PORT4_BIT;
UT_EVS_DoDispatchCheckEvents(&bitmaskcmd, sizeof(bitmaskcmd), UT_TPID_CFE_EVS_CMD_DISABLE_PORTS_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_DISPORT_EID);
}
/*
** Test event logging
*/
void Test_Logging(void)
{
int i;
uint32 resetAreaSize = 0;
uint16 LogOverflowCounterExpected = 1;
char tmpString[100];
union
{
CFE_EVS_NoopCmd_t noopcmd;
CFE_EVS_ClearLogCmd_t clearlogcmd;
CFE_EVS_SetLogModeCmd_t modecmd;
CFE_EVS_WriteLogDataFileCmd_t logfilecmd;
} CmdBuf;
cpuaddr TempAddr = 0;
CFE_ES_ResetData_t *CFE_EVS_ResetDataPtr;
UtPrintf("Begin Test Logging");
CFE_EVS_Global.EVS_TlmPkt.Payload.MessageFormatMode = CFE_EVS_MsgFormat_LONG;
/* Initialize */
UT_InitData();
memset(&CmdBuf, 0, sizeof(CmdBuf));
/* Enable logging and set conditions to allow complete code coverage */
CFE_EVS_Global.EVS_TlmPkt.Payload.LogEnabled = true;
UT_SetSizeofESResetArea(sizeof(CFE_ES_ResetData_t));
UT_SetDeferredRetcode(UT_KEY(OS_MutSemCreate), 1, OS_SUCCESS);
UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetResetType), 1, CFE_PSP_RST_TYPE_POWERON);
CFE_PSP_GetResetArea(&TempAddr, &resetAreaSize);
CFE_EVS_ResetDataPtr = (CFE_ES_ResetData_t *)TempAddr;
CFE_EVS_Global.EVS_LogPtr = &CFE_EVS_ResetDataPtr->EVS_Log;
/* Test setting the logging mode using an invalid mode */
UT_InitData();
CmdBuf.modecmd.Payload.LogMode = 0xff;
UT_EVS_DoDispatchCheckEvents(&CmdBuf.modecmd, sizeof(CmdBuf.modecmd), UT_TPID_CFE_EVS_CMD_SET_LOG_MODE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_ERR_LOGMODE_EID);
/* Test setting the logging mode to discard */
UT_InitData();
CmdBuf.modecmd.Payload.LogMode = CFE_EVS_LogMode_DISCARD;
UT_EVS_DoDispatchCheckEvents(&CmdBuf.modecmd, sizeof(CmdBuf.modecmd), UT_TPID_CFE_EVS_CMD_SET_LOG_MODE_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_LOGMODE_EID);
/* Test overfilling the log in discard mode */
UT_InitData();
UtAssert_VOIDCALL(EVS_ClearLog());
/* Ensure log is filled, then add one more, implicitly testing
* EVS_AddLog
*/
for (i = 0; i < CFE_PLATFORM_EVS_LOG_MAX; i++)
{
snprintf(tmpString, 100, "Log fill event %d", i);
CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "%s", tmpString);
}
CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "Log overfill event discard");
UtAssert_BOOL_TRUE(CFE_EVS_Global.EVS_LogPtr->LogFullFlag);
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_LogPtr->LogMode, CFE_EVS_LogMode_DISCARD);
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_LogPtr->LogOverflowCounter, LogOverflowCounterExpected);
/* Test setting the logging mode to overwrite */
UT_InitData();
CmdBuf.modecmd.Payload.LogMode = CFE_EVS_LogMode_OVERWRITE;
UT_EVS_DoDispatchCheckEvents(&CmdBuf.modecmd, sizeof(CmdBuf.modecmd), UT_TPID_CFE_EVS_CMD_SET_LOG_MODE_CC,
&UT_EVS_EventBuf);
LogOverflowCounterExpected = CFE_EVS_Global.EVS_LogPtr->LogOverflowCounter + 1;
CFE_EVS_SendEvent(0, CFE_EVS_EventType_INFORMATION, "Log overfill event overwrite");
UtAssert_BOOL_TRUE(CFE_EVS_Global.EVS_LogPtr->LogFullFlag);
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_LogPtr->LogMode, CFE_EVS_LogMode_OVERWRITE);
UtAssert_UINT32_EQ(CFE_EVS_Global.EVS_LogPtr->LogOverflowCounter, LogOverflowCounterExpected);
/* Test sending a no op command */
UT_InitData();
memset(&CmdBuf, 0, sizeof(CmdBuf));
UT_EVS_DoDispatchCheckEvents(&CmdBuf.noopcmd, sizeof(CmdBuf.noopcmd), UT_TPID_CFE_EVS_CMD_NOOP_CC,
&UT_EVS_EventBuf);
UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_NOOP_EID);
/* Clear log for next test */
UT_InitData();
CFE_EVS_Global.EVS_TlmPkt.Payload.LogEnabled = true;
UT_EVS_DoDispatchCheckEvents(&CmdBuf.clearlogcmd, sizeof(CmdBuf.clearlogcmd), UT_TPID_CFE_EVS_CMD_CLEAR_LOG_CC,