login_manager/mock_policy_service.h

// Copyright 2011 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LOGIN_MANAGER_MOCK_POLICY_SERVICE_H_
#define LOGIN_MANAGER_MOCK_POLICY_SERVICE_H_

#include "login_manager/policy_service.h"

#include <stdint.h>

#include <string>
#include <vector>

#include <base/functional/bind.h>
#include <chromeos/dbus/service_constants.h>
#include <gmock/gmock.h>

namespace login_manager {
MATCHER_P(PolicyErrorEq, error_code, "") {
  return (arg.code() == error_code);
}

class MockPolicyService : public PolicyService {
 public:
  MockPolicyService();
  ~MockPolicyService() override;
  MOCK_METHOD(
      void,
      Store,
      (const PolicyNamespace&, const std::vector<uint8_t>&, int, Completion),
      (override));
  MOCK_METHOD(bool,
              Retrieve,
              (const PolicyNamespace&, std::vector<uint8_t>*),
              (override));

  static Completion CreateDoNothing() {
    return base::BindOnce(&MockPolicyService::DoNothingWithError);
  }

  static Completion CreateExpectSuccessCallback() {
    return base::BindOnce(&ExpectingErrorHandler::HandleError,
                          base::Owned(new ExpectingErrorHandler(true)));
  }

  static Completion CreateExpectFailureCallback() {
    return base::BindOnce(&ExpectingErrorHandler::HandleError,
                          base::Owned(new ExpectingErrorHandler(false)));
  }

 private:
  // One downside of reporting results via a callback is that there's no longer
  // a handy object to mock out and set expectations on. You can provide a
  // callback in tests that checks a value passed in, but if that callback is
  // never run, the check will never happen! By having an actual object with
  // a mocked out method which can be owned by the callback, we can set an
  // expectation that remains unmet if the callback is not run before
  // destruction. This class supports very basic success-or-failure expectations
  // and the helper methods above vend appropriate callbacks.
  class ExpectingErrorHandler {
   public:
    explicit ExpectingErrorHandler(bool expect_match) {
      if (expect_match)
        EXPECT_CALL(*this, HandleErrorInternal(testing::IsNull()));
      else
        EXPECT_CALL(*this, HandleErrorInternal(testing::NotNull()));
    }
    ExpectingErrorHandler(const ExpectingErrorHandler&) = delete;
    ExpectingErrorHandler& operator=(const ExpectingErrorHandler&) = delete;

    virtual ~ExpectingErrorHandler() = default;

    // Proxy to HandleInternal() to support a passed-by-value move-only-type
    // param. See also
    // https://github.com/google/googlemock/blob/HEAD/googlemock/docs/CookBook.md#mocking-methods-that-use-move-only-types
    void HandleError(brillo::ErrorPtr error) {
      HandleErrorInternal(error.get());
    }
    MOCK_METHOD(void, HandleErrorInternal, (brillo::Error*));

   private:
  };

  static void DoNothingWithError(brillo::ErrorPtr error) {}
};

class MockPolicyServiceDelegate : public PolicyService::Delegate {
 public:
  MockPolicyServiceDelegate();
  ~MockPolicyServiceDelegate() override;
  MOCK_METHOD(void, OnPolicyPersisted, (bool), (override));
  MOCK_METHOD(void, OnKeyPersisted, (bool), (override));
};
}  // namespace login_manager

#endif  // LOGIN_MANAGER_MOCK_POLICY_SERVICE_H_