gfCAutoTestAuditComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCAutoTestAuditComponent.h
*
*       Purpose:        Tallies what an auto-test run achieved and emits a
*                               pass/fail report. Expectations come from the title's
*                               own collectionTypes file and the bonus entities in
*                               each level, so no per-title configuration is needed.
*
*********************************************************************/
 
#ifndef gfCAutoTestAuditComponenthdr
#define gfCAutoTestAuditComponenthdr
 
#include <map>
#include <vector>
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
 
class gfCAutoTestAuditComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        static gfCAutoTestAuditComponent* instanceGet();
 
        void failureRecord(const fsStr& pDescription);
 
        // Must run before the test profile - which it reads - is deleted.
        void reportEmit();
 
        virtual ~gfCAutoTestAuditComponent();
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        gfCAutoTestAuditComponent(fsCEntity* pParent);
 
private:
 
        struct sTagRule
        {
                fsStr mTag;
                fsStr mAchievementKey;
                fsStr mStat;
        };
 
        struct sTally
        {
                fsS32 mExpected = 0;
                fsS32 mCollected = 0;
        };
 
        void rulesLoad();
 
        void levelFlush();
        void levelBegin(const fsStr& pLevelName);
 
        std::vector<sTagRule> mRules;
 
        fsStr mLevelName;
        fsS32 mLevelCount;
 
        std::map<fsStr, sTally> mLevelTally;
        std::map<fsStr, sTally> mRunTally;
 
        std::vector<fsStr> mFailures;
 
        // Test-complete and teardown both ask; first one wins.
        fsBool mReported;
 
        static gfCAutoTestAuditComponent* mInstance;
};
 
#endif