binarystore: Add ReadOnly Mode
Add Read Only mode to the binary store. In this mode,
all blobs are not writable, no new blobs can be created and
the storage protobuf can't be modified in any way.
Also added simple API for reading/examining blob store
without modifying it.
Signed-off-by: Maksym Sloyko <maxims@google.com>
Change-Id: I12e3473351be98820d8e5df1b71a6d43699aa671
diff --git a/test/binarystore_unittest.cpp b/test/binarystore_unittest.cpp
new file mode 100644
index 0000000..f0e8048
--- /dev/null
+++ b/test/binarystore_unittest.cpp
@@ -0,0 +1,169 @@
+#include "binarystore.hpp"
+#include "binarystore_interface.hpp"
+#include "sys_file.hpp"
+
+#include <google/protobuf/text_format.h>
+
+#include <iostream>
+#include <ipmid/handler.hpp>
+#include <iterator>
+#include <memory>
+#include <sstream>
+
+#include <gmock/gmock.h>
+
+const std::string blobData = "jW7jiID}kD&gm&Azi:^]JT]'Ov4"
+ "Y.Oey]mw}yak9Wf3[S`+$!g]@[0}gikis^";
+const std::string inputProto = "blob_base_id: \"/blob/my-test\""
+ "blobs: [{ "
+ " blob_id: \"/blob/my-test/0\""
+ " data:\"" +
+ blobData +
+ "\""
+ "}, { "
+ " blob_id: \"/blob/my-test/1\""
+ " data:\"" +
+ blobData +
+ "\""
+ "}, { "
+ " blob_id: \"/blob/my-test/2\""
+ " data:\"" +
+ blobData +
+ "\""
+ "}, {"
+ " blob_id: \"/blob/my-test/3\""
+ " data:\"" +
+ blobData +
+ "\""
+ "}] "
+ "max_size_bytes: 64";
+
+class SysFileBuf : public binstore::SysFile
+{
+ public:
+ SysFileBuf(std::string* storage) : data_{storage}
+ {
+ }
+
+ size_t readToBuf(size_t pos, size_t count, char* buf) const override
+ {
+ std::cout << "Read " << count << " bytes at " << pos << std::endl;
+ return data_->copy(buf, count, pos);
+ }
+
+ std::string readAsStr(size_t pos, size_t count) const override
+ {
+ std::cout << "Read as str " << count << " bytes at " << pos
+ << std::endl;
+ return data_->substr(pos, count);
+ }
+
+ std::string readRemainingAsStr(size_t pos) const override
+ {
+ return data_->substr(pos);
+ }
+
+ void writeStr(const std::string& data, size_t pos) override
+ {
+ data_->replace(pos, data.size(), data);
+ }
+
+ std::string* data_;
+};
+
+using binstore::binaryblobproto::BinaryBlobBase;
+using google::protobuf::TextFormat;
+
+using testing::ElementsAreArray;
+using testing::UnorderedElementsAre;
+
+class BinaryStoreTest : public testing::Test
+{
+ public:
+ std::unique_ptr<SysFileBuf> createBlobStorage(const std::string& textProto)
+ {
+ BinaryBlobBase storeProto;
+ TextFormat::ParseFromString(textProto, &storeProto);
+
+ std::stringstream storage;
+ std::string data;
+ storeProto.SerializeToString(&data);
+
+ const uint64_t dataSize = data.size();
+ storage.write(reinterpret_cast<const char*>(&dataSize),
+ sizeof(dataSize));
+ storage << data;
+
+ blobDataStorage = storage.str();
+ return std::make_unique<SysFileBuf>(&blobDataStorage);
+ }
+
+ std::string blobDataStorage;
+};
+
+TEST_F(BinaryStoreTest, SimpleLoad)
+{
+ auto testDataFile = createBlobStorage(inputProto);
+ auto initialData = blobDataStorage;
+ auto store = binstore::BinaryStore::createFromConfig(
+ "/blob/my-test", std::move(testDataFile));
+ EXPECT_THAT(store->getBlobIds(),
+ UnorderedElementsAre("/blob/my-test", "/blob/my-test/0",
+ "/blob/my-test/1", "/blob/my-test/2",
+ "/blob/my-test/3"));
+ EXPECT_EQ(initialData, blobDataStorage);
+}
+
+TEST_F(BinaryStoreTest, TestCreateFromFile)
+{
+ auto testDataFile = createBlobStorage(inputProto);
+ auto initialData = blobDataStorage;
+ auto store =
+ binstore::BinaryStore::createFromFile(std::move(testDataFile), true);
+ ASSERT_TRUE(store);
+ EXPECT_EQ("/blob/my-test", store->getBaseBlobId());
+ EXPECT_THAT(store->getBlobIds(),
+ UnorderedElementsAre("/blob/my-test", "/blob/my-test/0",
+ "/blob/my-test/1", "/blob/my-test/2",
+ "/blob/my-test/3"));
+ // Check that the storage has not changed
+ EXPECT_EQ(initialData, blobDataStorage);
+}
+
+TEST_F(BinaryStoreTest, TestReadBlob)
+{
+ auto testDataFile = createBlobStorage(inputProto);
+ auto store =
+ binstore::BinaryStore::createFromFile(std::move(testDataFile), true);
+ ASSERT_TRUE(store);
+
+ const auto blobStoredData = store->readBlob("/blob/my-test/1");
+ EXPECT_FALSE(blobStoredData.empty());
+
+ decltype(blobStoredData) origData(blobData.begin(), blobData.end());
+
+ EXPECT_THAT(blobStoredData, ElementsAreArray(origData));
+}
+
+TEST_F(BinaryStoreTest, TestReadBlobError)
+{
+ auto testDataFile = createBlobStorage(inputProto);
+ auto store =
+ binstore::BinaryStore::createFromFile(std::move(testDataFile), true);
+ ASSERT_TRUE(store);
+
+ EXPECT_THROW(store->readBlob("/nonexistent/1"), ipmi::HandlerCompletion);
+}
+
+TEST_F(BinaryStoreTest, TestOpenReadOnlyBlob)
+{
+ auto testDataFile = createBlobStorage(inputProto);
+ auto store =
+ binstore::BinaryStore::createFromFile(std::move(testDataFile), true);
+ ASSERT_TRUE(store);
+
+ EXPECT_TRUE(
+ store->openOrCreateBlob("/blob/my-test/2", blobs::OpenFlags::read));
+ EXPECT_FALSE(store->openOrCreateBlob(
+ "/blob/my-test/2", blobs::OpenFlags::read & blobs::OpenFlags::write));
+}