fprime/Svc/ComLogger/test/ut/ComLoggerTester.cpp

// ----------------------------------------------------------------------
// CommandSequencer/test/ut/Tester.cpp
// ----------------------------------------------------------------------

#include <cstdio>

#include <Fw/Types/SerialBuffer.hpp>
#include <Os/FileSystem.hpp>
#include <Os/ValidateFile.hpp>
#include "ComLoggerTester.hpp"
#include "Fw/Cmd/CmdPacket.hpp"

#define ID_BASE 256

namespace Svc {

ComLoggerTester ::ComLoggerTester(const char* const compName)
    : ComLoggerGTestBase(compName, 30), comLogger("ComLogger", FILE_STR, MAX_BYTES_PER_FILE) {
    this->connectPorts();
    this->initComponents();
}

ComLoggerTester ::ComLoggerTester(const char* const compName, bool standardCLInit)
    : ComLoggerGTestBase(compName, 30), comLogger("ComLogger") {
    this->connectPorts();
    this->initComponents();

    (void)standardCLInit;
}

ComLoggerTester ::~ComLoggerTester() {
    this->comLogger.deinit();
}

void ComLoggerTester ::connectPorts() {
    comLogger.set_cmdRegOut_OutputPort(0, this->get_from_cmdRegOut(0));
    comLogger.set_cmdResponseOut_OutputPort(0, this->get_from_cmdResponseOut(0));
    this->connect_to_cmdIn(0, comLogger.get_cmdIn_InputPort(0));
    this->connect_to_comIn(0, comLogger.get_comIn_InputPort(0));
    comLogger.set_timeCaller_OutputPort(0, this->get_from_timeCaller(0));
    comLogger.set_logOut_OutputPort(0, this->get_from_logOut(0));
}

void ComLoggerTester ::initComponents() {
    this->init();
    this->comLogger.init(QUEUE_DEPTH, 0);
}

void ComLoggerTester ::dispatchOne() {
    this->comLogger.doDispatch();
}

void ComLoggerTester ::dispatchAll() {
    while (this->comLogger.m_queue.getMessagesAvailable() > 0) {
        this->dispatchOne();
    }
}

// ----------------------------------------------------------------------
// Tests
// ----------------------------------------------------------------------
void ComLoggerTester ::testLogging() {
    CHAR fileName[2048];
    CHAR prevFileName[2048];
    CHAR hashFileName[2048];
    CHAR prevHashFileName[2048];
    U8 buf[1024];
    U16 bufferSize = 0;
    Os::File::Status ret;
    Os::File file;

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_SIZE(0);

    U8 data[COM_BUFFER_LENGTH] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(&data[0], sizeof(data));

    Fw::SerializeStatus stat;

    for (int j = 0; j < 3; j++) {
        // Test times for the different iterations:
        Fw::Time testTime(TimeBase::TB_NONE, j, 987654);
        Fw::Time testTimePrev(TimeBase::TB_NONE, j - 1, 987654);
        Fw::Time testTimeNext(TimeBase::TB_NONE, j + 1, 987654);

        // File names for the different iterations:
        memset(fileName, 0, sizeof(fileName));
        snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(),
                 testTime.getUSeconds());
        memset(hashFileName, 0, sizeof(hashFileName));
        snprintf(hashFileName, sizeof(hashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(),
                 testTime.getUSeconds(), Utils::Hash::getFileExtensionString());
        memset(prevFileName, 0, sizeof(prevFileName));
        snprintf(prevFileName, sizeof(prevFileName), "%s_%d_%d_%06d.com", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTimePrev.getSeconds(),
                 testTimePrev.getUSeconds());
        memset(prevHashFileName, 0, sizeof(prevHashFileName));
        snprintf(prevHashFileName, sizeof(prevHashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTimePrev.getSeconds(),
                 testTimePrev.getUSeconds(), Utils::Hash::getFileExtensionString());

        // Set the test time to the current time:
        setTestTime(testTime);

        // Write to file:
        for (int i = 0; i < MAX_ENTRIES_PER_FILE - 1; i++) {
            invoke_to_comIn(0, buffer, 0);
            dispatchAll();
            ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
        }

        // OK a new file should be opened after this final invoke, set a new test time so that a file
        // with a new name gets opened:
        setTestTime(testTimeNext);
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);

        // A new file should have been opened from the previous loop iteration:
        if (j > 0) {
            ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
            ASSERT_TRUE(strcmp(comLogger.m_fileName.toChar(), fileName) == 0);
        }

        // Make sure we got a closed file event:
        ASSERT_EVENTS_SIZE(j);
        ASSERT_EVENTS_FileClosed_SIZE(j);
        if (j > 0) {
            ASSERT_EVENTS_FileClosed(j - 1, prevFileName);
        }

        // Make sure the file size is smaller or equal to the limit:
        Os::FileSystem::Status fsStat;
        FwSizeType fileSize = 0;
        fsStat =
            Os::FileSystem::getFileSize(fileName, fileSize);  //!< gets the size of the file (in bytes) at location path
        ASSERT_EQ(fsStat, Os::FileSystem::OP_OK);
        ASSERT_LE(fileSize, MAX_BYTES_PER_FILE);

        // Open file:
        ret = file.open(fileName, Os::File::OPEN_READ);
        ASSERT_EQ(Os::File::OP_OK, ret);

        // Check data:
        for (int i = 0; i < 5; i++) {
            // Get length of buffer to read
            FwSizeType length = static_cast<FwSizeType>(sizeof(U16));
            ret = file.read(buf, length);
            ASSERT_EQ(Os::File::OP_OK, ret);
            ASSERT_EQ(length, static_cast<FwSizeType>(sizeof(U16)));
            Fw::SerialBuffer comBuffLength(buf, length);
            comBuffLength.fill();
            stat = comBuffLength.deserializeTo(bufferSize);
            ASSERT_EQ(stat, Fw::FW_SERIALIZE_OK);
            ASSERT_EQ(COM_BUFFER_LENGTH, bufferSize);

            // Read and check buffer:
            length = bufferSize;
            ret = file.read(buf, length);
            ASSERT_EQ(Os::File::OP_OK, ret);
            ASSERT_EQ(length, static_cast<FwSizeType>(bufferSize));
            ASSERT_EQ(memcmp(buf, data, COM_BUFFER_LENGTH), 0);

            // for(int k=0; k < 4; k++)
            //   printf("0x%02x ",buf[k]);
            // printf("\n");
        }

        // Make sure we reached the end of the file:
        FwSizeType length = static_cast<FwSizeType>(sizeof(U16));
        ret = file.read(buf, length);
        ASSERT_EQ(Os::File::OP_OK, ret);
        ASSERT_EQ(length, 0);
        file.close();

        // Assert that the hashes match:
        if (j > 0) {
            Os::ValidateFile::Status status;
            status = Os::ValidateFile::validate(prevFileName, prevHashFileName);
            ASSERT_EQ(Os::ValidateFile::VALIDATION_OK, status);
        }
    }
}

void ComLoggerTester ::testLoggingNoLength() {
    CHAR fileName[2048];
    CHAR prevFileName[2048];
    CHAR hashFileName[2048];
    CHAR prevHashFileName[2048];
    U8 buf[1024];
    Os::File::Status ret;
    Os::File file;

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_SIZE(0);

    U8 data[COM_BUFFER_LENGTH] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(&data[0], sizeof(data));

    // Make sure that noLengthMode is enabled:
    comLogger.m_storeBufferLength = false;
    comLogger.m_maxFileSize = MAX_BYTES_PER_FILE_NO_LENGTH;

    for (int j = 0; j < 3; j++) {
        // Test times for the different iterations:
        Fw::Time testTime(TimeBase::TB_NONE, j, 123456);
        Fw::Time testTimePrev(TimeBase::TB_NONE, j - 1, 123456);
        Fw::Time testTimeNext(TimeBase::TB_NONE, j + 1, 123456);

        // File names for the different iterations:
        memset(fileName, 0, sizeof(fileName));
        snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(),
                 testTime.getUSeconds());
        memset(hashFileName, 0, sizeof(hashFileName));
        snprintf(hashFileName, sizeof(hashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(),
                 testTime.getUSeconds(), Utils::Hash::getFileExtensionString());
        memset(prevFileName, 0, sizeof(prevFileName));
        snprintf(prevFileName, sizeof(prevFileName), "%s_%d_%d_%06d.com", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTimePrev.getSeconds(),
                 testTimePrev.getUSeconds());
        memset(prevHashFileName, 0, sizeof(prevHashFileName));
        snprintf(prevHashFileName, sizeof(prevHashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTimePrev.getSeconds(),
                 testTimePrev.getUSeconds(), Utils::Hash::getFileExtensionString());

        // Set the test time to the current time:
        setTestTime(testTime);

        // Write to file:
        for (int i = 0; i < MAX_ENTRIES_PER_FILE - 1; i++) {
            invoke_to_comIn(0, buffer, 0);
            dispatchAll();
            ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
        }

        // OK a new file should be opened after this final invoke, set a new test time so that a file
        // with a new name gets opened:
        setTestTime(testTimeNext);
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);

        // A new file should have been opened from the previous loop iteration:
        if (j > 0) {
            ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
            ASSERT_TRUE(strcmp(comLogger.m_fileName.toChar(), fileName) == 0);
        }

        // Make sure we got a closed file event:
        ASSERT_EVENTS_SIZE(j);
        ASSERT_EVENTS_FileClosed_SIZE(j);
        if (j > 0) {
            ASSERT_EVENTS_FileClosed(j - 1, prevFileName);
        }

        // Make sure the file size is smaller or equal to the limit:
        Os::FileSystem::Status fsStat;
        FwSizeType fileSize = 0;
        fsStat =
            Os::FileSystem::getFileSize(fileName, fileSize);  //!< gets the size of the file (in bytes) at location path
        ASSERT_EQ(fsStat, Os::FileSystem::OP_OK);
        ASSERT_LE(fileSize, MAX_BYTES_PER_FILE);

        // Open file:
        ret = file.open(fileName, Os::File::OPEN_READ);
        ASSERT_EQ(Os::File::OP_OK, ret);

        // Check data:
        for (int i = 0; i < 5; i++) {
            // Get length of buffer to read
            FwSizeType length = COM_BUFFER_LENGTH;
            ret = file.read(buf, length);
            ASSERT_EQ(Os::File::OP_OK, ret);
            ASSERT_EQ(length, COM_BUFFER_LENGTH);
            ASSERT_EQ(memcmp(buf, data, COM_BUFFER_LENGTH), 0);

            // for(int k=0; k < 4; k++)
            //   printf("0x%02x ",buf[k]);
            // printf("\n");
        }

        // Make sure we reached the end of the file:
        FwSizeType length = static_cast<FwSizeType>(sizeof(U16));
        ret = file.read(buf, length);
        ASSERT_EQ(Os::File::OP_OK, ret);
        ASSERT_EQ(length, 0);
        file.close();

        // Assert that the hashes match:
        if (j > 0) {
            Os::ValidateFile::Status status;
            status = Os::ValidateFile::validate(prevFileName, prevHashFileName);
            ASSERT_EQ(Os::ValidateFile::VALIDATION_OK, status);
        }
    }
}

void ComLoggerTester ::openError() {
    // Construct illegal filePrefix, and set it via the friend:
    CHAR filePrefix[2048];
    CHAR fileName[2128];
    memset(fileName, 0, sizeof(fileName));
    memset(filePrefix, 0, sizeof(filePrefix));
    snprintf(filePrefix, sizeof(filePrefix), "illegal/fname?;\\*");

    comLogger.m_filePrefix = filePrefix;

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_SIZE(0);

    const U8 data[COM_BUFFER_LENGTH] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(data, sizeof(data));

    Fw::Time testTime(TimeBase::TB_NONE, 4, 987654);
    setTestTime(testTime);

    snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", filePrefix, static_cast<U32>(testTime.getTimeBase()),
             testTime.getSeconds(), testTime.getUSeconds());

    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    }

    // Check generated events:
    // We only expect 1 because of the throttle
    ASSERT_EVENTS_SIZE(1);
    ASSERT_EVENTS_FileOpenError_SIZE(1);
    ASSERT_EVENTS_FileOpenError(0, Os::File::DOESNT_EXIST, fileName);

    // Try again with valid file name:
    memset(fileName, 0, sizeof(fileName));
    memset(filePrefix, 0, sizeof(filePrefix));
    snprintf(filePrefix, sizeof(filePrefix), "good_");

    comLogger.m_filePrefix = filePrefix;

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);

    snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", filePrefix, static_cast<U32>(testTime.getTimeBase()),
             testTime.getSeconds(), testTime.getUSeconds());

    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    }

    // Check generated events:
    // We only expect 1 because of the throttle
    ASSERT_EVENTS_SIZE(1);
    ASSERT_EVENTS_FileOpenError_SIZE(1);
    comLogger.closeFile();

    // Try again with invalid file name:
    memset(fileName, 0, sizeof(fileName));
    memset(filePrefix, 0, sizeof(filePrefix));
    snprintf(filePrefix, sizeof(filePrefix), "illegal/fname?;\\*");
    comLogger.m_filePrefix = filePrefix;

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);

    snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", filePrefix, static_cast<U32>(testTime.getTimeBase()),
             testTime.getSeconds(), testTime.getUSeconds());

    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    }

    // Check generated events:
    // We only expect 1 extra because of the throttle
    ASSERT_EVENTS_SIZE(3);  // extra event here because of the file close
    ASSERT_EVENTS_FileOpenError_SIZE(2);
}

void ComLoggerTester ::writeError() {
    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_SIZE(0);

    const U8 data[4] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(data, sizeof(data));

    Fw::Time testTime(TimeBase::TB_NONE, 5, 987654);
    setTestTime(testTime);

    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    }

    // Force close the file from underneath the component:
    comLogger.m_file.close();

    // Send 2 packets:
    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    }

    // Construct filename:
    CHAR fileName[2048];
    memset(fileName, 0, sizeof(fileName));
    snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", FILE_STR, static_cast<U32>(testTime.getTimeBase()),
             testTime.getSeconds(), testTime.getUSeconds());

    // Check generated events:
    // We should only see a single event because write
    // errors are throttled.
    ASSERT_EVENTS_SIZE(1);
    ASSERT_EVENTS_FileWriteError_SIZE(1);
    ASSERT_EVENTS_FileWriteError(0, Os::File::NOT_OPENED, 0, 2, fileName);

    // Make comlogger open a new file:
    comLogger.m_fileMode = ComLogger::CLOSED;
    comLogger.openFile();

    // Try to write and make sure it succeeds:
    // Send 2 packets:
    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    }

    // Expect no new errors:
    ASSERT_EVENTS_SIZE(1);
    ASSERT_EVENTS_FileWriteError_SIZE(1);

    // Force close the file from underneath the component:
    comLogger.m_file.close();

    // Send 2 packets:
    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    }

    // Check generated events:
    // We should only see a single event because write
    // errors are throttled.
    ASSERT_EVENTS_SIZE(2);
    ASSERT_EVENTS_FileWriteError_SIZE(2);
    ASSERT_EVENTS_FileWriteError(1, Os::File::NOT_OPENED, 0, 2, fileName);
}

void ComLoggerTester ::closeFileCommand() {
    Os::File file;
    CHAR fileName[2048];
    CHAR hashFileName[2048];
    Os::File::Status ret;

    // Form filenames:
    Fw::Time testTime(TimeBase::TB_NONE, 6, 987654);
    setTestTime(testTime);
    memset(fileName, 0, sizeof(fileName));
    snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", FILE_STR,
             static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(), testTime.getUSeconds());
    memset(hashFileName, 0, sizeof(hashFileName));
    snprintf(hashFileName, sizeof(hashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
             static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(), testTime.getUSeconds(),
             Utils::Hash::getFileExtensionString());

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_SIZE(0);

    // Send close file commands:
    for (int i = 0; i < 3; i++) {
        sendCmd_CloseFile(0, i + 1);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    }

    ASSERT_CMD_RESPONSE_SIZE(3);

    for (int i = 0; i < 3; i++) {
        ASSERT_CMD_RESPONSE(i, ComLogger::OPCODE_CLOSEFILE, i + 1, Fw::CmdResponse::OK);
    }

    const U8 data[COM_BUFFER_LENGTH] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(data, sizeof(data));

    for (int i = 0; i < 3; i++) {
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    }

    // Send close file commands:
    for (int i = 0; i < 3; i++) {
        sendCmd_CloseFile(0, i + 1);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    }

    ASSERT_CMD_RESPONSE_SIZE(6);

    for (int i = 0; i < 3; i++) {
        ASSERT_CMD_RESPONSE(i, ComLogger::OPCODE_CLOSEFILE, i + 1, Fw::CmdResponse::OK);
    }

    // Make sure we got a closed file event:
    ASSERT_EVENTS_SIZE(1);
    ASSERT_EVENTS_FileClosed_SIZE(1);
    ASSERT_EVENTS_FileClosed(0, fileName);

    // Open files to make sure they exist:
    ret = file.open(fileName, Os::File::OPEN_READ);
    ASSERT_EQ(Os::File::OP_OK, ret);
    file.close();
    ret = file.open(hashFileName, Os::File::OPEN_READ);
    ASSERT_EQ(Os::File::OP_OK, ret);
    file.close();
}

void ComLoggerTester ::testLoggingWithInit() {
    CHAR fileName[2048];
    CHAR prevFileName[2048];
    CHAR hashFileName[2048];
    CHAR prevHashFileName[2048];
    U8 buf[1024];
    U16 bufferSize = 0;
    Os::File::Status ret;
    Os::File file;

    this->comLogger.init_log_file(FILE_STR, MAX_BYTES_PER_FILE);

    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_SIZE(0);

    U8 data[COM_BUFFER_LENGTH] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(&data[0], sizeof(data));

    Fw::SerializeStatus stat;

    for (int j = 0; j < 3; j++) {
        // Test times for the different iterations:
        Fw::Time testTime(TimeBase::TB_NONE, j, 987654);
        Fw::Time testTimePrev(TimeBase::TB_NONE, j - 1, 987654);
        Fw::Time testTimeNext(TimeBase::TB_NONE, j + 1, 987654);

        // File names for the different iterations:
        memset(fileName, 0, sizeof(fileName));
        snprintf(fileName, sizeof(fileName), "%s_%d_%d_%06d.com", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(),
                 testTime.getUSeconds());
        memset(hashFileName, 0, sizeof(hashFileName));
        snprintf(hashFileName, sizeof(hashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTime.getSeconds(),
                 testTime.getUSeconds(), Utils::Hash::getFileExtensionString());
        memset(prevFileName, 0, sizeof(prevFileName));
        snprintf(prevFileName, sizeof(prevFileName), "%s_%d_%d_%06d.com", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTimePrev.getSeconds(),
                 testTimePrev.getUSeconds());
        memset(prevHashFileName, 0, sizeof(prevHashFileName));
        snprintf(prevHashFileName, sizeof(prevHashFileName), "%s_%d_%d_%06d.com%s", FILE_STR,
                 static_cast<FwTimeBaseStoreType>(testTime.getTimeBase()), testTimePrev.getSeconds(),
                 testTimePrev.getUSeconds(), Utils::Hash::getFileExtensionString());

        // Set the test time to the current time:
        setTestTime(testTime);

        // Write to file:
        for (int i = 0; i < MAX_ENTRIES_PER_FILE - 1; i++) {
            invoke_to_comIn(0, buffer, 0);
            dispatchAll();
            ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
        }

        // OK a new file should be opened after this final invoke, set a new test time so that a file
        // with a new name gets opened:
        setTestTime(testTimeNext);
        invoke_to_comIn(0, buffer, 0);
        dispatchAll();
        ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);

        // A new file should have been opened from the previous loop iteration:
        if (j > 0) {
            ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
            ASSERT_TRUE(strcmp(comLogger.m_fileName.toChar(), fileName) == 0);
        }

        // Make sure we got a closed file event:
        ASSERT_EVENTS_SIZE(j);
        ASSERT_EVENTS_FileClosed_SIZE(j);
        if (j > 0) {
            ASSERT_EVENTS_FileClosed(j - 1, prevFileName);
        }

        // Make sure the file size is smaller or equal to the limit:
        Os::FileSystem::Status fsStat;
        FwSizeType fileSize = 0;
        fsStat =
            Os::FileSystem::getFileSize(fileName, fileSize);  //!< gets the size of the file (in bytes) at location path
        ASSERT_EQ(fsStat, Os::FileSystem::OP_OK);
        ASSERT_LE(fileSize, MAX_BYTES_PER_FILE);

        // Open file:
        ret = file.open(fileName, Os::File::OPEN_READ);
        ASSERT_EQ(Os::File::OP_OK, ret);

        // Check data:
        for (int i = 0; i < 5; i++) {
            // Get length of buffer to read
            FwSizeType length = sizeof(U16);
            ret = file.read(buf, length);
            ASSERT_EQ(Os::File::OP_OK, ret);
            ASSERT_EQ(length, static_cast<FwSizeType>(sizeof(U16)));
            Fw::SerialBuffer comBuffLength(buf, length);
            comBuffLength.fill();
            stat = comBuffLength.deserializeTo(bufferSize);
            ASSERT_EQ(stat, Fw::FW_SERIALIZE_OK);
            ASSERT_EQ(COM_BUFFER_LENGTH, bufferSize);

            // Read and check buffer:
            length = bufferSize;
            ret = file.read(buf, length);
            ASSERT_EQ(Os::File::OP_OK, ret);
            ASSERT_EQ(length, static_cast<FwSizeType>(bufferSize));
            ASSERT_EQ(memcmp(buf, data, COM_BUFFER_LENGTH), 0);
        }

        // Make sure we reached the end of the file:
        FwSizeType length = sizeof(FwSizeType);
        ret = file.read(buf, length);
        ASSERT_EQ(Os::File::OP_OK, ret);
        ASSERT_EQ(length, 0);
        file.close();

        // Assert that the hashes match:
        if (j > 0) {
            Os::ValidateFile::Status status;
            status = Os::ValidateFile::validate(prevFileName, prevHashFileName);
            ASSERT_EQ(Os::ValidateFile::VALIDATION_OK, status);
        }
    }
}

void ComLoggerTester ::noInitError() {
    U8 data[COM_BUFFER_LENGTH] = {0xde, 0xad, 0xbe, 0xef};
    Fw::ComBuffer buffer(&data[0], sizeof(data));

    this->invoke_to_comIn(0, buffer, 0);
    dispatchAll();
    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::CLOSED);
    ASSERT_EVENTS_FileNotInitialized_SIZE(1);

    this->comLogger.init_log_file(FILE_STR, MAX_BYTES_PER_FILE);

    this->clearHistory();
    this->invoke_to_comIn(0, buffer, 0);
    dispatchAll();
    ASSERT_TRUE(comLogger.m_fileMode == ComLogger::OPEN);
    ASSERT_EVENTS_FileNotInitialized_SIZE(0);
}

void ComLoggerTester ::from_pingOut_handler(const FwIndexType portNum, U32 key) {
    this->pushFromPortEntry_pingOut(key);
}
}  // namespace Svc