analyzer/store/memory_store.h

// Copyright 2017 The Fuchsia Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef COBALT_ANALYZER_STORE_MEMORY_STORE_H_
#define COBALT_ANALYZER_STORE_MEMORY_STORE_H_

#include <map>
#include <mutex>
#include <string>
#include <utility>
#include <vector>

#include "analyzer/store/data_store.h"

namespace cobalt {
namespace analyzer {
namespace store {

// An in-memory implementation of DataStore.
class MemoryStoreSingleton : public DataStore {
 public:
  static MemoryStoreSingleton& Instance();

  Status WriteRow(Table table, Row row) override;

  Status WriteRows(Table table, std::vector<Row> rows) override;

  Status ReadRow(Table table, const std::vector<std::string>& column_names,
                 Row* row) override;

  ReadResponse ReadRows(Table table, std::string start_row_key, bool inclusive,
                        std::string limit_row_key,
                        const std::vector<std::string>& column_names,
                        size_t max_rows) override;

  Status DeleteRow(Table table, std::string row_key) override;

  Status DeleteRowsWithPrefix(Table table, std::string row_key_prefix) override;

  Status DeleteAllRows(Table table) override;

 private:
  typedef std::map<std::string, std::map<std::string, std::string>> ImplMapType;

  MemoryStoreSingleton() {}

  ImplMapType& GetRows(Table which_table);

  std::map<std::string, std::map<std::string, std::string>> observation_rows_,
      report_metadata_rows_, report_rows_rows_;

  // protects observation_rows_, report_metadata_rows_, report_rows_rows_.
  std::recursive_mutex mutex_;
};

// An in-memory implementation of DataStore. The backing store is a singleton
// shared by all MemoryStore instances.
class MemoryStore : public DataStore {
 public:
  Status WriteRow(Table table, Row row) override {
    return MemoryStoreSingleton::Instance().WriteRow(table, std::move(row));
  }

  Status WriteRows(Table table, std::vector<Row> rows) override {
    return MemoryStoreSingleton::Instance().WriteRows(table, std::move(rows));
  }

  Status ReadRow(Table table, const std::vector<std::string>& column_names,
                 Row* row) override {
    return MemoryStoreSingleton::Instance().ReadRow(table, column_names, row);
  }

  ReadResponse ReadRows(Table table, std::string start_row_key, bool inclusive,
                        std::string limit_row_key,
                        const std::vector<std::string>& column_names,
                        size_t max_rows) override {
    return MemoryStoreSingleton::Instance().ReadRows(
        table, start_row_key, inclusive, limit_row_key, column_names, max_rows);
  }

  Status DeleteRow(Table table, std::string row_key) override {
    return MemoryStoreSingleton::Instance().DeleteRow(table, row_key);
  }

  Status DeleteRowsWithPrefix(Table table,
                              std::string row_key_prefix) override {
    return MemoryStoreSingleton::Instance().DeleteRowsWithPrefix(
        table, row_key_prefix);
  }

  Status DeleteAllRows(Table table) override {
    return MemoryStoreSingleton::Instance().DeleteAllRows(table);
  }
};

namespace test {
// A MemoryStore that can be told to return an error from ReadRows. By default
// it is just a regular MemoryStore. Invoke reset_num_to_succeed() to inject
// a fault into ReadRows().
class FaultInjectableMemoryStore : public MemoryStore {
 public:
  ReadResponse ReadRows(Table table, std::string start_row_key, bool inclusive,
                        std::string limit_row_key,
                        const std::vector<std::string>& column_names,
                        size_t max_rows) override;

  // After invoking this method, ReadRows() will work correctly for |num|
  // additional invocations but upon the next invocation it will return
  // a ReadResponse that contains an error status.
  void reset_num_to_succeed(size_t num) {
    num_to_succeed_ = num;
    num_times_invoked_ = 0;
  }

 private:
  size_t num_to_succeed_ = -1;
  size_t num_times_invoked_ = 0;
};

}  // namespace test

}  // namespace store
}  // namespace analyzer
}  // namespace cobalt

#endif  // COBALT_ANALYZER_STORE_MEMORY_STORE_H_