property_store_unittest.h

// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SHILL_PROPERTY_STORE_UNITTEST_H_
#define SHILL_PROPERTY_STORE_UNITTEST_H_

#include <map>
#include <string>
#include <vector>

#include <base/memory/scoped_ptr.h>
#include <base/files/scoped_temp_dir.h>
#include <dbus-c++/dbus.h>
#include <gmock/gmock.h>
#include <gtest/gtest.h>

#include "shill/dbus_adaptor.h"
#include "shill/error.h"
#include "shill/event_dispatcher.h"
#include "shill/manager.h"
#include "shill/mock_control.h"
#include "shill/mock_glib.h"
#include "shill/mock_metrics.h"
#include "shill/property_store.h"

namespace shill {

class PropertyStoreTest : public testing::TestWithParam< ::DBus::Variant > {
 public:
  typedef ::testing::Types<bool, int16, int32, std::string, Stringmap,
                           Stringmaps, Strings, uint8, uint16, Uint16s, uint32>
      PropertyTypes;

  // In real code, it's frowned upon to have non-POD static members, as there
  // can be ordering issues if your constructors have side effects.
  // These constructors don't, and declaring these as static lets me
  // autogenerate a bunch of unit test code that I would otherwise need to
  // copypaste.  So I think it's safe and worth it.
  static const ::DBus::Variant kBoolV;
  static const ::DBus::Variant kByteV;
  static const ::DBus::Variant kInt16V;
  static const ::DBus::Variant kInt32V;
  static const ::DBus::Variant kKeyValueStoreV;
  static const ::DBus::Variant kStringV;
  static const ::DBus::Variant kStringmapV;
  static const ::DBus::Variant kStringmapsV;
  static const ::DBus::Variant kStringsV;
  static const ::DBus::Variant kUint16V;
  static const ::DBus::Variant kUint16sV;
  static const ::DBus::Variant kUint32V;
  static const ::DBus::Variant kUint64V;

  PropertyStoreTest();
  virtual ~PropertyStoreTest();

  virtual void SetUp();
  MOCK_METHOD1(TestCallback, void(const std::string &property_name));

  // Convenience overloads for GetProperty. Normally, we don't overload
  // functions. But this is extremely useful for type-parameterized tests.
  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          bool *storage, Error *error) {
    return store.GetBoolProperty(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          int16 *storage, Error *error) {
    return store.GetInt16Property(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          int32 *storage, Error *error) {
    return store.GetInt32Property(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          std::string *storage, Error *error) {
    return store.GetStringProperty(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          Stringmap *storage, Error *error) {
    return store.GetStringmapProperty(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          Stringmaps *storage, Error *error) {
    return store.GetStringmapsProperty(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          Strings *storage, Error *error) {
    return store.GetStringsProperty(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          uint8 *storage, Error *error) {
    return store.GetUint8Property(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          uint16 *storage, Error *error) {
    return store.GetUint16Property(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          Uint16s *storage, Error *error) {
    return store.GetUint16sProperty(name, storage, error);
  }

  static bool GetProperty(const PropertyStore &store, const std::string &name,
                          uint32 *storage, Error *error) {
    return store.GetUint32Property(name, storage, error);
  }

  // Convenience overloads for RegisterProperty. Normally, we don't overload
  // functions. But this is extremely useful for type-parameterized tests.
  static void RegisterProperty(
      PropertyStore *store, const std::string &name, bool *storage) {
    store->RegisterBool(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, int16 *storage) {
    store->RegisterInt16(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, int32 *storage) {
    store->RegisterInt32(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, std::string *storage) {
    store->RegisterString(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, Stringmap *storage) {
    store->RegisterStringmap(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, Stringmaps *storage) {
    store->RegisterStringmaps(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, Strings *storage) {
    store->RegisterStrings(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, uint8 *storage) {
    store->RegisterUint8(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, uint16 *storage) {
    store->RegisterUint16(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, Uint16s *storage) {
    store->RegisterUint16s(name, storage);
  }

  static void RegisterProperty(
      PropertyStore *store, const std::string &name, uint32 *storage) {
    store->RegisterUint32(name, storage);
  }

 protected:
  Manager *manager() { return &manager_; }
  MockControl *control_interface() { return &control_interface_; }
  EventDispatcher *dispatcher() { return &dispatcher_; }
  MockGLib *glib() { return &glib_; }
  MockMetrics *metrics() { return &metrics_; }

  const std::string &run_path() const { return path_; }
  const std::string &storage_path() const { return path_; }

  const std::string &internal_error() const { return internal_error_; }
  const std::string &invalid_args() const { return invalid_args_; }
  const std::string &invalid_prop() const { return invalid_prop_; }

 private:
  const std::string internal_error_;
  const std::string invalid_args_;
  const std::string invalid_prop_;
  base::ScopedTempDir dir_;
  const std::string path_;
  MockControl control_interface_;
  EventDispatcher dispatcher_;
  testing::NiceMock<MockMetrics> metrics_;
  MockGLib glib_;
  Manager manager_;
};

}  // namespace shill
#endif  // SHILL_PROPERTY_STORE_UNITTEST_H_