AutotestRegister.c

Go to the documentation of this file.

// Script File
 
 
enum MeasurementType
{
    HeatMap,
    GraphLine,
    GraphBar,
    HTML,
    File,
    Gallery
}

class MeasurementFile
{   
    // VARIABLES
    private AutotestRegister m_parent;  //< Register this file is made from
    private string m_filePath;          //< Path to physical file of this measurement
    private ref FileHandle m_handle;        //< Handle to physical file
    private MeasurementType m_type;     //< What type of measurement visualization this file will generate
    private string m_graphHeader;       //< Table header for graph type measurements
    private bool m_containsNoData;      //< Does this file contain any data or is it plain autotest header only (first line only)
    
    
    
    // PUBLIC FUNCTIONS
    //      contains anything more than only autotest header (sets m_containsNoData)
    void MeasurementFile(AutotestRegister parent, string path, FileMode mode, MeasurementType type)
    {
        m_type      = type;
        m_parent    = parent;
        m_filePath  = path;
        
        if(mode == FileMode.APPEND && FileIO.FileExists(path))
        {
            m_handle = FileIO.OpenFile(path, FileMode.READ);
            
            int lineCount = 0;
            
            string line;
            while(m_handle.ReadLine(line) > 0)
            {
                lineCount++;
                if(lineCount > 1)
                    break;
            }
            m_containsNoData = lineCount < 2;
            m_handle.Close();
        }
        else
            m_containsNoData = true;
        
        m_handle = FileIO.OpenFile(m_filePath, mode);
        
    }
    void ~MeasurementFile()
    {
        if (!m_handle)
            return;
        if(IsChart() && m_containsNoData && m_graphHeader.Length() > 0)
            m_handle.WriteLine(m_graphHeader);  
        m_handle.Close();
        m_handle = null;
    }
    
    bool IsValid()
    {
        return m_handle;
    }
    
    string GetFilePath() { return m_filePath; }
    
    //      This muse be called before first AddData or generic header gets generated
    void SetGraphHeader(string header)
    {
        if(!m_handle)
            return;
        m_graphHeader = header;
    }
    
    //      With first data we append into file containing graph it automatically appends
    //      either set in SetGraphHeader or ig gets autogenerated
    void AddData(string line)
    {
        if(!m_handle)
            return;
        if(IsChart() && m_containsNoData)
        {
            if(m_graphHeader.Length() > 0)
                m_handle.WriteLine(m_graphHeader);  
            else
            {
                array<string> arr = new array<string>();
                line.Split(",", arr, true);
                
                string artificialHeader;
                for(int i = 0; i < arr.Count(); ++i)
                {
                    if(i != 0)
                        artificialHeader = string.Format("%1,%2", artificialHeader, i);
                    else
                        artificialHeader = string.Format("%1", i);
                }
                m_handle.WriteLine(artificialHeader);
            }
        }
        
        m_containsNoData = false;
        m_handle.WriteLine(line);
    }
    
    //      It is used internally to find out if we should append graph header in this file.
    bool IsChart()
    {
        return m_type == MeasurementType.GraphLine || m_type == MeasurementType.GraphBar;
    }
    
    
    // UNUSUAL
    
    //      Ignore it or you may breake the system
    void AddHeader(string measurementTitle)
    {
        if(!m_handle || !m_containsNoData)
            return;
        
        if(m_type == MeasurementType.HeatMap)
        {
            m_handle.WriteLine(string.Format("%1;%2;heatmap", m_parent.GetAutotestPageName(), measurementTitle));
            m_handle.WriteLine("x,y,FPS");
        }
        else if(m_type == MeasurementType.GraphLine)
            m_handle.WriteLine(string.Format("%1;%2;chart;line", m_parent.GetAutotestPageName(), measurementTitle));
        else if(m_type == MeasurementType.GraphBar)
            m_handle.WriteLine(string.Format("%1;%2+chart;bar", m_parent.GetAutotestPageName(), measurementTitle));
        else if(m_type == MeasurementType.HTML)
            m_handle.WriteLine(string.Format("%1;%2;html", m_parent.GetAutotestPageName(), measurementTitle));
        else if(m_type == MeasurementType.File)
            m_handle.WriteLine(string.Format("%1;%2;file", m_parent.GetAutotestPageName(), measurementTitle));
        else if(m_type == MeasurementType.Gallery)
            m_handle.WriteLine(string.Format("%1;%2;gallery", m_parent.GetAutotestPageName(), measurementTitle));
    }
}
 

class AutotestRegister
{
    // VARIABLES
    protected string m_worldFileFolder;
    protected string m_autotestPageName;
    protected int m_testIndex = 0;
 
    
        
    // PUBLIC FUNCTIONS
    
    //      This also handles persistent autotest indexing m_testIndex
    void Init(string pageName)
    {
        m_autotestPageName = pageName;
        
        m_worldFileFolder = "$logs:"; 
        
        string mutliTestFile = string.Format("%1/%2", m_worldFileFolder, "last_test_index.log");
        FileHandle tmp;
        if(FileIO.FileExists(mutliTestFile))
        {
            tmp = FileIO.OpenFile(mutliTestFile, FileMode.READ);
            string line;
            tmp.ReadLine(line);
            m_testIndex = line.ToInt() + 1;
            tmp.Close();
        }
        
        tmp = FileIO.OpenFile(mutliTestFile, FileMode.WRITE);
        if (tmp)
        {
            tmp.WriteLine(string.Format("%1", m_testIndex));
            tmp.Close();
        }
    }
    
    string GetAutotestPageName() { return m_autotestPageName; }
    
    string GetWorldFileFolderPath() { return m_worldFileFolder; }
    
    //      if it is first time (first world) when autotest runs or we are in the middle of multistage/multiworld autotest
    //      in such case this will return >0 if it is first it will return 0. This is usefull when you want to for example
    //      delete some temporary files before running autotest measurements
    int GetTestIndex() 
    {
        return m_testIndex;
    }
    
    bool DoesMeasurementExist(string name)
    {
        return FileIO.FileExists(CreateMeasurementFilePath(name));
    }
        
    //      If you set false into overwriteExisting it will try to open existing measurement file and append to PSVrTrackingQualityEnum
    //      In case there is none it will simply create new one and prepare autotest header into it so we can always AddData right away
    //  
    //      !!! Dont forget to store into ref !!!
    MeasurementFile OpenMeasurementFile(string name, string measurementTitle, MeasurementType type, bool overwriteExisting = true)
    {
        MeasurementFile ret;
        
        string measurementFilePath = CreateMeasurementFilePath(name);
        if(overwriteExisting || !FileIO.FileExists(measurementFilePath))
        {
            ret = new MeasurementFile(this, measurementFilePath, FileMode.WRITE, type);
            ret.AddHeader(measurementTitle);
        }
        else
        {
            ret = new MeasurementFile(this, measurementFilePath, FileMode.APPEND, type);
        }
        
        return ret;
    }
    
    //      result page (under name "console.log" - link to it is also put at the end of results)
    void UploadLogFileWithResults()
    {
        string logFilePath = string.Format("%1/console.log", m_worldFileFolder);
        if(!FileIO.FileExists(logFilePath))
        {
            FileHandle logFileHandle = FileIO.OpenFile(logFilePath, FileMode.WRITE);
            logFileHandle.WriteLine("Missing log file");
            logFileHandle.Close();
        }
        
        ref MeasurementFile logFileUploader = OpenMeasurementFile("zzz_console_log_upload", "Console log", MeasurementType.File);
        logFileUploader.AddData(logFilePath);
    }
    
    void SavePersistentData(string name, string data)
    {
        FileHandle tmp = FileIO.OpenFile(CreatePersistentFilePath(name), FileMode.WRITE);
        tmp.WriteLine(data);
        tmp.Close();
    }
    string LoadPersistentData(string name)
    {
        FileHandle tmp = FileIO.OpenFile(CreatePersistentFilePath(name), FileMode.READ);
        
        string data;
        tmp.ReadLine(data);
        
        tmp.Close();
        return data;
    }
    
    //      dont forget that charts has +1 than you would probably expect because of chart header)
    int GetNumberOfDataLines(string measurementName)
    {
        FileHandle tmp = FileIO.OpenFile(CreateMeasurementFilePath(measurementName), FileMode.READ);
        
        int count = -1;
        
        string lineContent;
        while(tmp.ReadLine(lineContent) > 0)
            count++;
        
        tmp.Close();
        return count;
    }
    
    int GetNumberOfWorldFiles()
    {
        array<string> files = {};
        FileIO.FindFiles(files.Insert, m_worldFileFolder, ".ent");
        return files.Count();
    }
    
    // PRIVATE FUNCTIONS
    private string CreatePersistentFilePath(string name)
    {
        return string.Format("%1/%2", m_worldFileFolder, name);
    }
    private string CreateMeasurementFilePath(string name)
    {
        return string.Format("%1/%2.txt", m_worldFileFolder, name);
    }
}