fprime/Svc/FprimeDeframer/test/ut/FprimeDeframerTester.hpp
Thomas Boyer-Chammard c3b2e04880
Use data return pattern on Uplink and standardize port names (#3546)
* First pass at Svc + TcpClient implementation

* Revert FileUplink changes

* Add copy (with allocation/deallocation) to FprimeRouter to simplify buffer management

* Update FprimeRouter UTs

* Update FprimeDeframer UTs

* Update FrameAccumulator UTs

* Update ComStub UTs

* Update missing Drv and UTs

* Update ComInterface to use ComDataWithContext on output

* Update Ref/RPI topology

* Fix spelling

* Fix test typo

* Update Udp component and UTs

* Rename data ports and standardize "Return" naming pattern

* Fix variable name

* Adapt UTs

* Update Communication Adapter Interface docs

* Full SDD updates

* Spelling &  nits and details

* Put formatting back to original

* Update Deframer interface to include bufferReturn

* Address review comments
2025-05-08 10:54:54 -07:00

95 lines
3.0 KiB
C++

// ======================================================================
// \title FprimeDeframerTester.hpp
// \author thomas-bc
// \brief hpp file for FprimeDeframer component test harness implementation class
// ======================================================================
#ifndef Svc_FprimeDeframerTester_HPP
#define Svc_FprimeDeframerTester_HPP
#include "Svc/FprimeDeframer/FprimeDeframer.hpp"
#include "Svc/FprimeDeframer/FprimeDeframerGTestBase.hpp"
namespace Svc {
class FprimeDeframerTester : public FprimeDeframerGTestBase {
public:
// ----------------------------------------------------------------------
// Constants
// ----------------------------------------------------------------------
// Maximum size of histories storing events, telemetry, and port outputs
static const FwSizeType MAX_HISTORY_SIZE = 10;
// Instance ID supplied to the component instance under test
static const FwEnumStoreType TEST_INSTANCE_ID = 0;
public:
// ----------------------------------------------------------------------
// Construction and destruction
// ----------------------------------------------------------------------
//! Construct object FprimeDeframerTester
FprimeDeframerTester();
//! Destroy object FprimeDeframerTester
~FprimeDeframerTester();
public:
// ----------------------------------------------------------------------
// Tests
// ----------------------------------------------------------------------
//! Test receiving a nominal frame
void testNominalFrame();
//! Test receiving a truncated frame
void testTruncatedFrame();
//! Test receiving a zero size frame
void testZeroSizeFrame();
//! Test receiving a frame with an incorrect length token (too long for the data)
void testIncorrectLengthToken();
//! Test receiving a frame with an incorrect start word
void testIncorrectStartWord();
//! Test receiving a frame with an incorrect Crc field
void testIncorrectCrc();
//! Test bufferReturn passthrough
void testDataReturn();
private:
// ----------------------------------------------------------------------
// Helper functions
// ----------------------------------------------------------------------
//! Connect ports
void connectPorts();
//! Initialize components
void initComponents();
//! Takes in a buffer of data and size, and injects a checksum into the buffer
//! If the buffer doesn't have enough room for the checksum (4 bytes), the buffer is left unchanged
void injectChecksum(U8* data, FwSizeType size);
//! Sends a buffer of supplied data and size on the component input port
void mockReceiveData(U8* data, FwSizeType size);
private:
// ----------------------------------------------------------------------
// Member variables
// ----------------------------------------------------------------------
//! The component under test
FprimeDeframer component;
};
} // namespace Svc
#endif