RASCSI/cpp/test/mocks.h

//---------------------------------------------------------------------------
//
// SCSI Target Emulator PiSCSI
// for Raspberry Pi
//
// Copyright (C) 2022-2023 Uwe Seimet
//
//---------------------------------------------------------------------------

#pragma once

#include <gmock/gmock.h>

#include "test_shared.h"
#include "hal/bus.h"
#include "controllers/scsi_controller.h"
#include "devices/scsihd_nec.h"
#include "devices/scsicd.h"
#include "devices/scsimo.h"
#include "devices/host_services.h"
#include "piscsi/piscsi_executor.h"
#include <fcntl.h>

using namespace testing;

class MockBus : public BUS //NOSONAR Having many fields/methods cannot be avoided
{
public:

	MOCK_METHOD(bool, Init, (mode_e), (override));
	MOCK_METHOD(void, Reset, (), (override));
	MOCK_METHOD(void, Cleanup, (), (override));
	MOCK_METHOD(bool, GetBSY, (), (const override));
	MOCK_METHOD(void, SetBSY, (bool), (override));
	MOCK_METHOD(bool, GetSEL, (), (const override));
	MOCK_METHOD(void, SetSEL, (bool), (override));
	MOCK_METHOD(bool, GetATN, (), (const override));
	MOCK_METHOD(void, SetATN, (bool), (override));
	MOCK_METHOD(bool, GetACK, (), (const override));
	MOCK_METHOD(void, SetACK, (bool), (override));
	MOCK_METHOD(bool, GetRST, (), (const override));
	MOCK_METHOD(void, SetRST, (bool), (override));
	MOCK_METHOD(bool, GetMSG, (), (const override));
	MOCK_METHOD(void, SetMSG, (bool), (override));
	MOCK_METHOD(bool, GetCD, (), (const override));
	MOCK_METHOD(void, SetCD, (bool), (override));
	MOCK_METHOD(bool, GetIO, (), (override));
	MOCK_METHOD(void, SetIO, (bool), (override));
	MOCK_METHOD(bool, GetREQ, (), (const override));
	MOCK_METHOD(void, SetREQ, (bool), (override));
	MOCK_METHOD(bool, GetACT, (), (const override));
	MOCK_METHOD(void, SetACT, (bool), (override));
	MOCK_METHOD(void, SetENB, (bool), (override));
	MOCK_METHOD(uint8_t, GetDAT, (), (override));
	MOCK_METHOD(void, SetDAT, (uint8_t), (override));
	MOCK_METHOD(uint32_t, Acquire, (), (override));
	MOCK_METHOD(int, CommandHandShake, (vector<uint8_t>&), (override));
	MOCK_METHOD(int, ReceiveHandShake, (uint8_t *, int), (override));
	MOCK_METHOD(int, SendHandShake, (uint8_t *, int, int), (override));
	MOCK_METHOD(bool, GetSignal, (int), (const override));
	MOCK_METHOD(void, SetSignal, (int, bool), (override));
	MOCK_METHOD(bool, PollSelectEvent, (), (override));
	MOCK_METHOD(unique_ptr<DataSample>, GetSample, (uint64_t), (override));
	MOCK_METHOD(void, PinConfig, (int, int), (override));
    MOCK_METHOD(void, PullConfig, (int , int ), (override));
    MOCK_METHOD(void, SetControl, (int , bool ), (override));
    MOCK_METHOD(void, SetMode, (int , int ), (override));

	MockBus() = default;
	~MockBus() override = default;
};

class MockPhaseHandler : public PhaseHandler
{
	FRIEND_TEST(PhaseHandlerTest, Phases);
	FRIEND_TEST(PhaseHandlerTest, ProcessPhase);

public:

	MOCK_METHOD(bool, Process, (int), (override));
	MOCK_METHOD(void, Status, (), ());
	MOCK_METHOD(void, DataIn, (), ());
	MOCK_METHOD(void, DataOut, (), ());
	MOCK_METHOD(void, BusFree, (), ());
	MOCK_METHOD(void, Selection, (), ());
	MOCK_METHOD(void, Command, (), ());
	MOCK_METHOD(void, MsgIn, (), ());
	MOCK_METHOD(void, MsgOut, (), ());

	using PhaseHandler::PhaseHandler;
};

inline static const auto mock_bus = make_shared<MockBus>();

class MockAbstractController : public AbstractController //NOSONAR Having many fields/methods cannot be avoided
{
	friend class TestInquiry;

	friend shared_ptr<PrimaryDevice> CreateDevice(piscsi_interface::PbDeviceType, AbstractController&, int);

	FRIEND_TEST(AbstractControllerTest, AllocateCmd);
	FRIEND_TEST(AbstractControllerTest, Reset);
	FRIEND_TEST(AbstractControllerTest, DeviceLunLifeCycle);
	FRIEND_TEST(AbstractControllerTest, ExtractInitiatorId);
	FRIEND_TEST(AbstractControllerTest, GetOpcode);
	FRIEND_TEST(AbstractControllerTest, GetLun);
	FRIEND_TEST(AbstractControllerTest, Blocks);
	FRIEND_TEST(AbstractControllerTest, Length);
	FRIEND_TEST(AbstractControllerTest, UpdateOffsetAndLength);
	FRIEND_TEST(AbstractControllerTest, Offset);
	FRIEND_TEST(ScsiControllerTest, Selection);
	FRIEND_TEST(PrimaryDeviceTest, Inquiry);
	FRIEND_TEST(PrimaryDeviceTest, TestUnitReady);
	FRIEND_TEST(PrimaryDeviceTest, RequestSense);
	FRIEND_TEST(PrimaryDeviceTest, SendDiagnostic);
	FRIEND_TEST(PrimaryDeviceTest, ReportLuns);
	FRIEND_TEST(PrimaryDeviceTest, UnknownCommand);
	FRIEND_TEST(ModePageDeviceTest, ModeSense6);
	FRIEND_TEST(ModePageDeviceTest, ModeSense10);
	FRIEND_TEST(ModePageDeviceTest, ModeSelect6);
	FRIEND_TEST(ModePageDeviceTest, ModeSelect10);
	FRIEND_TEST(DiskTest, Dispatch);
	FRIEND_TEST(DiskTest, Rezero);
	FRIEND_TEST(DiskTest, FormatUnit);
	FRIEND_TEST(DiskTest, ReassignBlocks);
	FRIEND_TEST(DiskTest, Seek6);
	FRIEND_TEST(DiskTest, Seek10);
	FRIEND_TEST(DiskTest, Read6);
	FRIEND_TEST(DiskTest, Read10);
	FRIEND_TEST(DiskTest, Read16);
	FRIEND_TEST(DiskTest, Write6);
	FRIEND_TEST(DiskTest, Write10);
	FRIEND_TEST(DiskTest, Write16);
	FRIEND_TEST(DiskTest, Verify10);
	FRIEND_TEST(DiskTest, Verify16);
	FRIEND_TEST(DiskTest, ReadCapacity10);
	FRIEND_TEST(DiskTest, ReadCapacity16);
	FRIEND_TEST(DiskTest, ReadLong10);
	FRIEND_TEST(DiskTest, ReadLong16);
	FRIEND_TEST(DiskTest, WriteLong10);
	FRIEND_TEST(DiskTest, WriteLong16);
	FRIEND_TEST(DiskTest, PreventAllowMediumRemoval);
	FRIEND_TEST(DiskTest, SynchronizeCache);
	FRIEND_TEST(DiskTest, ReadDefectData);
	FRIEND_TEST(DiskTest, StartStopUnit);
	FRIEND_TEST(DiskTest, ModeSense6);
	FRIEND_TEST(DiskTest, ModeSense10);
	FRIEND_TEST(ScsiDaynaportTest, Read);
	FRIEND_TEST(ScsiDaynaportTest, Write);
	FRIEND_TEST(ScsiDaynaportTest, Read6);
	FRIEND_TEST(ScsiDaynaportTest, Write6);
	FRIEND_TEST(ScsiDaynaportTest, TestRetrieveStats);
	FRIEND_TEST(ScsiDaynaportTest, SetInterfaceMode);
	FRIEND_TEST(ScsiDaynaportTest, SetMcastAddr);
	FRIEND_TEST(ScsiDaynaportTest, EnableInterface);
	FRIEND_TEST(HostServicesTest, StartStopUnit);
	FRIEND_TEST(HostServicesTest, ModeSense6);
	FRIEND_TEST(HostServicesTest, ModeSense10);
	FRIEND_TEST(HostServicesTest, SetUpModePages);
	FRIEND_TEST(ScsiPrinterTest, Print);

public:

	MOCK_METHOD(bool, Process, (int), (override));
	MOCK_METHOD(int, GetEffectiveLun, (), (const override));
	MOCK_METHOD(void, Error, (scsi_defs::sense_key, scsi_defs::asc, scsi_defs::status), (override));
	MOCK_METHOD(int, GetInitiatorId, (), (const override));
	MOCK_METHOD(void, Status, (), ());
	MOCK_METHOD(void, DataIn, (), ());
	MOCK_METHOD(void, DataOut, (), ());
	MOCK_METHOD(void, BusFree, (), ());
	MOCK_METHOD(void, Selection, (), ());
	MOCK_METHOD(void, Command, (), ());
	MOCK_METHOD(void, MsgIn, (), ());
	MOCK_METHOD(void, MsgOut, (), ());

	MockAbstractController() : AbstractController(*mock_bus, 0, 32) {}
	explicit MockAbstractController(int target_id) : AbstractController(*mock_bus, target_id, 32) {
		AllocateBuffer(512);
	}
	MockAbstractController(shared_ptr<BUS> bus, int target_id) : AbstractController(*bus, target_id, 32) {
		AllocateBuffer(512);
	}
	~MockAbstractController() override = default;
};

class MockScsiController : public ScsiController
{
	FRIEND_TEST(ScsiControllerTest, Process);
	FRIEND_TEST(ScsiControllerTest, BusFree);
	FRIEND_TEST(ScsiControllerTest, Selection);
	FRIEND_TEST(ScsiControllerTest, Command);
	FRIEND_TEST(ScsiControllerTest, MsgIn);
	FRIEND_TEST(ScsiControllerTest, MsgOut);
	FRIEND_TEST(ScsiControllerTest, DataIn);
	FRIEND_TEST(ScsiControllerTest, DataOut);
	FRIEND_TEST(ScsiControllerTest, Error);
	FRIEND_TEST(ScsiControllerTest, RequestSense);
	FRIEND_TEST(PrimaryDeviceTest, RequestSense);

public:

	MOCK_METHOD(void, Reset, (), ());
	MOCK_METHOD(void, Status, (), ());
	MOCK_METHOD(void, Execute, (), ());

	using ScsiController::ScsiController;
	MockScsiController(shared_ptr<BUS> bus, int target_id) : ScsiController(*bus, target_id) {}
	explicit MockScsiController(shared_ptr<BUS> bus) : ScsiController(*bus, 0) {}
	~MockScsiController() override = default;

};

class MockDevice : public Device
{
	FRIEND_TEST(DeviceTest, Properties);
	FRIEND_TEST(DeviceTest, Params);
	FRIEND_TEST(DeviceTest, StatusCode);
	FRIEND_TEST(DeviceTest, Reset);
	FRIEND_TEST(DeviceTest, Start);
	FRIEND_TEST(DeviceTest, Stop);
	FRIEND_TEST(DeviceTest, Eject);

public:

	MOCK_METHOD(int, GetId, (), (const));

	explicit MockDevice(int lun) : Device(UNDEFINED, lun) {}
	explicit MockDevice(PbDeviceType type) : Device(type, 0) {}
	~MockDevice() override = default;
};

class MockPrimaryDevice : public PrimaryDevice
{
	FRIEND_TEST(PrimaryDeviceTest, PhaseChange);
	FRIEND_TEST(PrimaryDeviceTest, TestUnitReady);
	FRIEND_TEST(PrimaryDeviceTest, RequestSense);
	FRIEND_TEST(PrimaryDeviceTest, Inquiry);
	FRIEND_TEST(PrimaryDeviceTest, GetSetSendDelay);
	FRIEND_TEST(ScsiControllerTest, RequestSense);
	FRIEND_TEST(PiscsiExecutorTest, ValidateOperationAgainstDevice);

public:

	MOCK_METHOD(vector<uint8_t>, InquiryInternal, (), (const));
	MOCK_METHOD(void, FlushCache, (), ());

	explicit MockPrimaryDevice(int lun) : PrimaryDevice(UNDEFINED, lun) {}
	~MockPrimaryDevice() override = default;
};

class MockModePageDevice : public ModePageDevice
{
	FRIEND_TEST(ModePageDeviceTest, SupportsSaveParameters);
	FRIEND_TEST(ModePageDeviceTest, AddModePages);
	FRIEND_TEST(ModePageDeviceTest, AddVendorPage);

public:

	MOCK_METHOD(vector<uint8_t>, InquiryInternal, (), (const));
	MOCK_METHOD(int, ModeSense6, (span<const int>, vector<uint8_t>&), (const override));
	MOCK_METHOD(int, ModeSense10, (span<const int>, vector<uint8_t>&), (const override));

	MockModePageDevice() : ModePageDevice(UNDEFINED, 0) {}
	~MockModePageDevice() override = default;

	void SetUpModePages(map<int, vector<byte>>& pages, int page, bool) const override {
		// Return dummy data for other pages than page 0
		if (page) {
			vector<byte> buf(32);
			pages[page] = buf;
		}
	}
};

class MockPage0ModePageDevice : public MockModePageDevice
{
	FRIEND_TEST(ModePageDeviceTest, Page0);

public:

	using MockModePageDevice::MockModePageDevice;

	void SetUpModePages(map<int, vector<byte>>& pages, int, bool) const override {
		// Return dummy data for pages 0 and 1
		vector<byte> buf(32);
		pages[0] = buf;
		pages[1] = buf;
	}
};

class MockStorageDevice : public StorageDevice
{
	FRIEND_TEST(StorageDeviceTest, ValidateFile);
	FRIEND_TEST(StorageDeviceTest, MediumChanged);
	FRIEND_TEST(StorageDeviceTest, GetIdsForReservedFile);
	FRIEND_TEST(StorageDeviceTest, FileExists);
	FRIEND_TEST(StorageDeviceTest, GetFileSize);

public:

	MOCK_METHOD(vector<uint8_t>, InquiryInternal, (), (const));
	MOCK_METHOD(void, Open, (), (override));
	MOCK_METHOD(int, ModeSense6, (span<const int>, vector<uint8_t>&), (const override));
	MOCK_METHOD(int, ModeSense10, (span<const int>, vector<uint8_t>&), (const override));
	MOCK_METHOD(void, SetUpModePages, ((map<int, vector<byte>>&), int, bool), (const override));

	MockStorageDevice() : StorageDevice(UNDEFINED, 0) {}
	~MockStorageDevice() override = default;
};

class MockDisk : public Disk
{
	FRIEND_TEST(DiskTest, Dispatch);
	FRIEND_TEST(DiskTest, Rezero);
	FRIEND_TEST(DiskTest, FormatUnit);
	FRIEND_TEST(DiskTest, ReassignBlocks);
	FRIEND_TEST(DiskTest, Seek6);
	FRIEND_TEST(DiskTest, Seek10);
	FRIEND_TEST(DiskTest, Read6);
	FRIEND_TEST(DiskTest, Read10);
	FRIEND_TEST(DiskTest, Read16);
	FRIEND_TEST(DiskTest, Write6);
	FRIEND_TEST(DiskTest, Write10);
	FRIEND_TEST(DiskTest, Write16);
	FRIEND_TEST(DiskTest, Verify10);
	FRIEND_TEST(DiskTest, Verify16);
	FRIEND_TEST(DiskTest, ReadCapacity10);
	FRIEND_TEST(DiskTest, ReadCapacity16);
	FRIEND_TEST(DiskTest, ReadLong10);
	FRIEND_TEST(DiskTest, ReadLong16);
	FRIEND_TEST(DiskTest, WriteLong10);
	FRIEND_TEST(DiskTest, WriteLong16);
	FRIEND_TEST(DiskTest, ReserveRelease);
	FRIEND_TEST(DiskTest, SendDiagnostic);
	FRIEND_TEST(DiskTest, StartStopUnit);
	FRIEND_TEST(DiskTest, PreventAllowMediumRemoval);
	FRIEND_TEST(DiskTest, Eject);
	FRIEND_TEST(DiskTest, ModeSense6);
	FRIEND_TEST(DiskTest, ModeSense10);
	FRIEND_TEST(DiskTest, SynchronizeCache);
	FRIEND_TEST(DiskTest, ReadDefectData);
	FRIEND_TEST(DiskTest, SectorSize);
	FRIEND_TEST(DiskTest, BlockCount);

public:

	MOCK_METHOD(vector<uint8_t>, InquiryInternal, (), (const));
	MOCK_METHOD(void, FlushCache, (), (override));
	MOCK_METHOD(void, Open, (), (override));

	MockDisk() : Disk(SCHD, 0, { 512, 1024, 2048, 4096 }) {}
	~MockDisk() override = default;
};

class MockSCSIHD : public SCSIHD //NOSONAR Ignore inheritance hierarchy depth in unit tests
{
	FRIEND_TEST(DiskTest, ConfiguredSectorSize);
	FRIEND_TEST(ScsiHdTest, SupportsSaveParameters);
	FRIEND_TEST(ScsiHdTest, FinalizeSetup);
	FRIEND_TEST(ScsiHdTest, GetProductData);
	FRIEND_TEST(ScsiHdTest, SetUpModePages);
	FRIEND_TEST(ScsiHdTest, DECSpecialFunctionControlPage);
	FRIEND_TEST(ScsiHdTest, GetSectorSizes);
	FRIEND_TEST(ScsiHdTest, ModeSelect);
	FRIEND_TEST(PiscsiExecutorTest, SetSectorSize);

public:

	MockSCSIHD(int lun, bool removable) : SCSIHD(lun, removable, scsi_level::scsi_2) {}
	explicit MockSCSIHD(const unordered_set<uint32_t>& sector_sizes) : SCSIHD(0, false, scsi_level::scsi_2, sector_sizes) {}
	~MockSCSIHD() override = default;
};

class MockSCSIHD_NEC : public SCSIHD_NEC //NOSONAR Ignore inheritance hierarchy depth in unit tests
{
	FRIEND_TEST(ScsiHdNecTest, SetUpModePages);
	FRIEND_TEST(ScsiHdNecTest, TestAddErrorPage);
	FRIEND_TEST(ScsiHdNecTest, TestAddFormatPage);
	FRIEND_TEST(ScsiHdNecTest, TestAddDrivePage);
	FRIEND_TEST(PiscsiExecutorTest, ProcessDeviceCmd);

	using SCSIHD_NEC::SCSIHD_NEC;
};

class MockSCSICD : public SCSICD //NOSONAR Ignore inheritance hierarchy depth in unit tests
{
	FRIEND_TEST(ScsiCdTest, GetSectorSizes);
	FRIEND_TEST(ScsiCdTest, SetUpModePages);
	FRIEND_TEST(ScsiCdTest, ReadToc);
	FRIEND_TEST(ScsiCdTest, ModeSelect);

	using SCSICD::SCSICD;
};

class MockSCSIMO : public SCSIMO //NOSONAR Ignore inheritance hierarchy depth in unit tests
{
	FRIEND_TEST(ScsiMoTest, SupportsSaveParameters);
	FRIEND_TEST(ScsiMoTest, SetUpModePages);
	FRIEND_TEST(ScsiMoTest, TestAddVendorPage);
	FRIEND_TEST(ScsiMoTest, ModeSelect);

	using SCSIMO::SCSIMO;
};

class MockHostServices : public HostServices
{
	FRIEND_TEST(HostServicesTest, SetUpModePages);

	using HostServices::HostServices;
};

class MockPiscsiExecutor : public PiscsiExecutor
{
public:

	MOCK_METHOD(bool, Start, (shared_ptr<PrimaryDevice>, bool), (const));
	MOCK_METHOD(bool, Stop, (shared_ptr<PrimaryDevice>, bool), (const));

	using PiscsiExecutor::PiscsiExecutor;
};