src/test/erase/pattern_test.cpp

#include "estoraged_conf.hpp"
#include "pattern.hpp"

#include <fcntl.h>
#include <unistd.h>

#include <stdplus/fd/create.hpp>
#include <stdplus/fd/gmock.hpp>
#include <stdplus/fd/managed.hpp>
#include <xyz/openbmc_project/Common/error.hpp>

#include <fstream>
#include <span>
#include <system_error>

#include <gmock/gmock-matchers.h>
#include <gmock/gmock.h>
#include <gtest/gtest.h>

namespace estoraged_test
{

using estoraged::Pattern;
using sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
using testing::_;
using testing::Invoke;
using testing::Return;

TEST(pattern, patternPass)
{
    std::string testFileName = "patternPass";
    uint64_t size = 4096;
    std::ofstream testFile;
    testFile.open(testFileName,
                  std::ios::out | std::ios::binary | std::ios::trunc);
    testFile.close();

    stdplus::fd::Fd&& writeFd =
        stdplus::fd::open(testFileName, stdplus::fd::OpenAccess::WriteOnly);

    Pattern pass(testFileName);
    EXPECT_NO_THROW(pass.writePattern(size, writeFd));

    stdplus::fd::Fd&& readFd =
        stdplus::fd::open(testFileName, stdplus::fd::OpenAccess::ReadOnly);

    EXPECT_NO_THROW(pass.verifyPattern(size, readFd));
}

/* This test that pattern writes the correct number of bytes even if
 * size of the drive is not divisible by the block size
 */

TEST(pattern, patternNotDivisible)
{
    std::string testFileName = "notDivisible";
    uint64_t size = 4097;
    // 4097 is not divisible by the block size, and we expect no errors
    std::ofstream testFile;
    testFile.open(testFileName,
                  std::ios::out | std::ios::binary | std::ios::trunc);
    testFile.close();

    stdplus::fd::Fd&& writeFd =
        stdplus::fd::open(testFileName, stdplus::fd::OpenAccess::WriteOnly);
    Pattern pass(testFileName);
    EXPECT_NO_THROW(pass.writePattern(size, writeFd));

    stdplus::fd::Fd&& readFd =
        stdplus::fd::open(testFileName, stdplus::fd::OpenAccess::ReadOnly);
    EXPECT_NO_THROW(pass.verifyPattern(size, readFd));
}

TEST(pattern, patternsDontMatch)
{
    std::string testFileName = "patternsDontMatch";
    uint64_t size = 4096;
    std::ofstream testFile;

    Pattern pass(testFileName);

    int dummyValue = 88;
    testFile.open(testFileName, std::ios::binary | std::ios::out);
    testFile.write((reinterpret_cast<const char*>(&dummyValue)),
                   sizeof(dummyValue));
    testFile.close();

    stdplus::fd::Fd&& writeFd =
        stdplus::fd::open(testFileName, stdplus::fd::OpenAccess::WriteOnly);

    EXPECT_NO_THROW(pass.writePattern(size - sizeof(dummyValue), writeFd));

    stdplus::fd::Fd&& readFd =
        stdplus::fd::open(testFileName, stdplus::fd::OpenAccess::ReadOnly);

    EXPECT_THROW(pass.verifyPattern(size, readFd), InternalFailure);
}

TEST(pattern, shortReadWritePass)
{
    std::string testFileName = "testfile_shortRead";
    uint64_t size = 4096;
    size_t shortSize = 128;
    static auto shortData1 = std::vector<std::byte>(shortSize);
    static auto shortData2 = std::vector<std::byte>(shortSize);
    static auto restOfData = std::vector<std::byte>(size - shortSize * 2);
    Pattern pass(testFileName);
    stdplus::fd::FdMock mock;

    testing::Sequence s;

    // test write pattern with short blocks
    EXPECT_CALL(mock, write(_))
        .WillOnce(Invoke([](std::span<const std::byte> x) {
            std::copy_n(x.begin(), shortData1.size(), shortData1.begin());
            return shortData1;
        }))
        .RetiresOnSaturation();
    EXPECT_CALL(mock, write(_))
        .WillOnce(Invoke([](std::span<const std::byte> x) {
            std::copy_n(x.begin(), restOfData.size(), restOfData.begin());
            return restOfData;
        }))
        .RetiresOnSaturation();
    EXPECT_CALL(mock, write(_))
        .WillOnce(Invoke([](std::span<const std::byte> x) {
            std::copy_n(x.begin(), shortData2.size(), shortData2.begin());
            return shortData2;
        }))
        .RetiresOnSaturation();

    // test read pattern
    EXPECT_CALL(mock, read(_))
        .WillOnce(Invoke([](std::span<std::byte> x) {
            std::copy_n(shortData1.begin(), shortData1.size(), x.data());
            std::span ret(shortData1);
            return ret;
        }))
        .RetiresOnSaturation();

    EXPECT_CALL(mock, read(_))
        .WillOnce(Invoke([](std::span<std::byte> x) {
            std::copy_n(restOfData.begin(), restOfData.size(), x.data());
            std::span ret(restOfData);
            return ret;
        }))
        .RetiresOnSaturation();

    EXPECT_CALL(mock, read(_))
        .WillOnce(Invoke([](std::span<std::byte> x) {
            std::copy_n(shortData2.begin(), shortData2.size(), x.data());
            std::span ret(shortData2);
            return ret;
        }))
        .RetiresOnSaturation();

    EXPECT_NO_THROW(pass.writePattern(size, mock));
    EXPECT_NO_THROW(pass.verifyPattern(size, mock));
}

TEST(Zeros, shortReadWriteFail)
{
    std::string testFileName = "testfile_shortRead";

    uint64_t size = 4096;
    size_t shortSize = 128;
    Pattern tryPattern(testFileName);
    auto shortData = std::vector<std::byte>(shortSize, std::byte{0});
    auto restOfData =
        std::vector<std::byte>(size - shortSize * 3, std::byte{0});
    std::span shortDataSpan{shortData};
    std::span restOfDataSpan{restOfData};
    // open the file and write none to it

    stdplus::fd::FdMock mock;

    // test writes
    EXPECT_CALL(mock, write(_))
        .WillOnce(Return(shortDataSpan))
        .WillOnce(Return(shortDataSpan))
        .WillOnce(Return(restOfDataSpan))
        .WillOnce(Return(restOfDataSpan)); // return too much data!

    EXPECT_THROW(tryPattern.writePattern(size, mock), InternalFailure);

    // test reads
    EXPECT_CALL(mock, read(_))
        .WillOnce(Return(shortDataSpan))
        .WillOnce(Return(shortDataSpan))
        .WillOnce(Return(restOfDataSpan))
        .WillOnce(Return(restOfDataSpan)); // return too much data!

    EXPECT_THROW(tryPattern.verifyPattern(size, mock), InternalFailure);
}

TEST(pattern, driveIsSmaller)
{
    std::string testFileName = "testfile_driveIsSmaller";

    uint64_t size = 4096;
    Pattern tryPattern(testFileName);

    stdplus::fd::FdMock mocks;
    testing::InSequence s;

    // test writes
    EXPECT_CALL(mocks, write(_))
        .Times(33)
        .WillRepeatedly(Return(std::span<std::byte>{}))
        .RetiresOnSaturation();

    EXPECT_THROW(tryPattern.writePattern(size, mocks), InternalFailure);

    // test reads
    EXPECT_CALL(mocks, read(_))
        .Times(33)
        .WillRepeatedly(Return(std::span<std::byte>{}))
        .RetiresOnSaturation();

    EXPECT_THROW(tryPattern.verifyPattern(size, mocks), InternalFailure);
}

} // namespace estoraged_test