Fission FSN
Loading...
Searching...
No Matches
gfCAutoTestAuditComponent.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: gfCAutoTestAuditComponent.h
4*
5* Purpose: Tallies what an auto-test run achieved and emits a
6* pass/fail report. Expectations come from the title's
7* own collectionTypes file and the bonus entities in
8* each level, so no per-title configuration is needed.
9*
10*********************************************************************/
11
12#ifndef gfCAutoTestAuditComponenthdr
13#define gfCAutoTestAuditComponenthdr
14
15#include <map>
16#include <vector>
17
20
21
23{
24 friend class fsCComponentFactory;
25
26public:
27
28 static const fsCUniqueId mTypeId;
29
30 static fsIComponent* create(fsCEntity* pParent);
31
33
34 void failureRecord(const fsStr& pDescription);
35
36 // For a test that collects by tapping: an uncollected bonus is reported, with its
37 // percentage, but does not fail the run. autoTestMinCollectPercent can still fail
38 // it below a chosen overall rate.
39 void collectionIsMetricSet(fsBool pMetric) { mCollectionIsMetric = pMetric; }
40
41 // Must run before the test profile - which it reads - is deleted.
42 void reportEmit();
43
45
46protected:
47
48 void listenersRegisterDo() override;
49 void listenersDeregisterDo() override;
50 fsBool messageProcessDo(const fsCUniqueId& pMessageType,
51 const fsIMessageDispatcher::sMessageParameters& pParam) override;
52
54
55private:
56
57 struct sTagRule
58 {
59 fsStr mTag;
60 fsStr mAchievementKey;
61 fsStr mStat;
62 };
63
64 struct sTally
65 {
66 fsS32 mExpected = 0;
67 fsS32 mCollected = 0;
68 };
69
70 void rulesLoad();
71 void resultFileWrite() const;
72
73 void levelFlush();
74 void levelBegin(const fsStr& pLevelName);
75
76 std::vector<sTagRule> mRules;
77
78 fsStr mLevelName;
79 fsS32 mLevelCount;
80
81 std::map<fsStr, sTally> mLevelTally;
82 std::map<fsStr, sTally> mRunTally;
83
84 std::vector<fsStr> mFailures;
85
86 // Test-complete and teardown both ask; first one wins.
87 fsBool mReported;
88
89 fsBool mCollectionIsMetric = false;
90
91 static gfCAutoTestAuditComponent* mInstance;
92};
93
94#endif
Definition fsCEntity.h:39
Definition fsCUniqueId.h:21
fsIComponent(fsCEntity *pParent)
Definition fsIComponent.cpp:86
fsIMessageListenerComponent(fsCEntity *pParent)
Definition fsIMessageListenerComponent.cpp:9
Definition fsStr.h:23
void collectionIsMetricSet(fsBool pMetric)
Definition gfCAutoTestAuditComponent.h:39
fsBool messageProcessDo(const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
Definition gfCAutoTestAuditComponent.cpp:81
void reportEmit()
Definition gfCAutoTestAuditComponent.cpp:166
static gfCAutoTestAuditComponent * instanceGet()
Definition gfCAutoTestAuditComponent.cpp:43
friend class fsCComponentFactory
Definition gfCAutoTestAuditComponent.h:24
void listenersRegisterDo() override
Definition gfCAutoTestAuditComponent.cpp:67
static fsIComponent * create(fsCEntity *pParent)
Definition gfCAutoTestAuditComponent.cpp:293
virtual ~gfCAutoTestAuditComponent()
Definition gfCAutoTestAuditComponent.cpp:307
gfCAutoTestAuditComponent(fsCEntity *pParent)
Definition gfCAutoTestAuditComponent.cpp:298
void listenersDeregisterDo() override
Definition gfCAutoTestAuditComponent.cpp:74
static const fsCUniqueId mTypeId
Definition gfCAutoTestAuditComponent.h:28
void failureRecord(const fsStr &pDescription)
Definition gfCAutoTestAuditComponent.cpp:160
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
Definition fsIMessageDispatcher.h:32