1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
|
//===- VirtualOutputBackendTest.cpp - Tests for vfs::OutputBackend --------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/Support/VirtualOutputBackend.h"
#include "llvm/Testing/Support/Error.h"
#include "gtest/gtest.h"
using namespace llvm;
using namespace llvm::vfs;
namespace {
struct MockOutputBackendData {
int Cloned = 0;
int FilesCreated = 0;
std::optional<OutputConfig> LastConfig;
unique_function<Error()> FileCreator;
};
struct MockOutputBackend final : public OutputBackend {
struct MockFile final : public OutputFileImpl {
Error keep() override { return Error::success(); }
Error discard() override { return Error::success(); }
raw_pwrite_stream &getOS() override { return OS; }
raw_null_ostream OS;
};
IntrusiveRefCntPtr<OutputBackend> cloneImpl() const override {
++Data.Cloned;
return const_cast<MockOutputBackend *>(this);
}
Expected<std::unique_ptr<OutputFileImpl>>
createFileImpl(StringRef, std::optional<OutputConfig> Config) override {
++Data.FilesCreated;
Data.LastConfig = Config;
if (Data.FileCreator)
return Data.FileCreator();
return std::make_unique<MockFile>();
}
Expected<OutputFile>
createAutoDiscardFile(const Twine &OutputPath,
std::optional<OutputConfig> Config = std::nullopt) {
return consumeDiscardOnDestroy(createFile(OutputPath, Config));
}
MockOutputBackend(MockOutputBackendData &Data) : Data(Data) {}
MockOutputBackendData &Data;
};
static IntrusiveRefCntPtr<MockOutputBackend>
createMockBackend(MockOutputBackendData &Data) {
return makeIntrusiveRefCnt<MockOutputBackend>(Data);
}
static Error createCustomError() {
return createStringError(inconvertibleErrorCode(), "custom error");
}
TEST(VirtualOutputBackendTest, construct) {
MockOutputBackendData Data;
auto B = createMockBackend(Data);
EXPECT_EQ(0, Data.Cloned);
EXPECT_EQ(0, Data.FilesCreated);
}
TEST(VirtualOutputBackendTest, clone) {
MockOutputBackendData Data;
auto Backend = createMockBackend(Data);
auto Clone = Backend->clone();
EXPECT_EQ(1, Data.Cloned);
// Confirm the clone matches what the mock's cloneImpl() does.
EXPECT_EQ(Backend.get(), Clone.get());
// Make another clone.
Backend->clone();
EXPECT_EQ(2, Data.Cloned);
}
TEST(VirtualOutputBackendTest, createFile) {
MockOutputBackendData Data;
auto Backend = createMockBackend(Data);
StringRef FilePath = "dir/file";
OutputFile F;
EXPECT_THAT_ERROR(Backend->createFile(Twine(FilePath)).moveInto(F),
Succeeded());
EXPECT_EQ(1, Data.FilesCreated);
EXPECT_EQ(FilePath, F.getPath());
EXPECT_EQ(std::nullopt, Data.LastConfig);
// Confirm OutputBackend has not installed a discard handler.
#if GTEST_HAS_DEATH_TEST
EXPECT_DEATH(F = OutputFile(), "output not closed");
#endif
consumeError(F.discard());
// Create more files and specify configs.
for (OutputConfig Config : {
OutputConfig(),
OutputConfig().setNoAtomicWrite().setDiscardOnSignal(),
OutputConfig().setAtomicWrite().setNoDiscardOnSignal(),
OutputConfig().setText(),
OutputConfig().setTextWithCRLF(),
}) {
int CreatedAlready = Data.FilesCreated;
EXPECT_THAT_ERROR(
Backend->createAutoDiscardFile(Twine(FilePath), Config).takeError(),
Succeeded());
EXPECT_EQ(Config, Data.LastConfig);
EXPECT_EQ(1 + CreatedAlready, Data.FilesCreated);
}
}
TEST(VirtualOutputBackendTest, createFileInvalidConfigCRLF) {
MockOutputBackendData Data;
auto Backend = createMockBackend(Data);
// Check that invalid configs don't make it to the backend.
EXPECT_THAT_ERROR(
Backend
->createAutoDiscardFile(Twine("dir/file"), OutputConfig().setCRLF())
.takeError(),
FailedWithMessage("dir/file: invalid config: {CRLF}"));
EXPECT_EQ(0, Data.FilesCreated);
}
TEST(VirtualOutputBackendTest, createFileError) {
MockOutputBackendData Data;
Data.FileCreator = createCustomError;
auto Backend = createMockBackend(Data);
// Check that invalid configs don't make it to the backend.
EXPECT_THAT_ERROR(
Backend->createAutoDiscardFile(Twine("dir/file")).takeError(),
FailedWithMessage("custom error"));
EXPECT_EQ(1, Data.FilesCreated);
}
} // end namespace
|