root/sync/api/attachments/attachment_service_proxy_unittest.cc

DEFINITIONS

1. weak_ptr_factory_
2. GetOrDownloadAttachments
3. DropAttachments
4. OnSyncDataAdd
5. OnSyncDataDelete
6. OnSyncDataUpdate
7. AsWeakPtr
8. GetCallCount
9. Increment
10. SetUp
11. TearDown
12. IncrementGetOrDownload
13. IncrementDrop
14. WaitForStubThread
15. TEST_F
16. TEST_F
17. TEST_F

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

#include "sync/api/attachments/attachment_service_proxy.h"

#include "base/bind.h"
#include "base/memory/ref_counted_memory.h"
#include "base/memory/scoped_ptr.h"
#include "base/message_loop/message_loop.h"
#include "base/run_loop.h"
#include "base/synchronization/lock.h"
#include "base/synchronization/waitable_event.h"
#include "base/threading/non_thread_safe.h"
#include "base/threading/thread.h"
#include "sync/api/attachments/attachment.h"
#include "sync/api/attachments/attachment_service.h"
#include "sync/api/sync_data.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/protocol/sync.pb.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace syncer {

// A stub implementation of AttachmentService that counts the number of times
// its methods are invoked.
class StubAttachmentService : public AttachmentService,
                              public base::NonThreadSafe {
 public:
  StubAttachmentService() : call_count_(0), weak_ptr_factory_(this) {
    // DetachFromThread because we will be constructed in one thread and
    // used/destroyed in another.
    DetachFromThread();
  }

  virtual ~StubAttachmentService() {}

  virtual void GetOrDownloadAttachments(const AttachmentIdList& attachment_ids,
                                        const GetOrDownloadCallback& callback)
      OVERRIDE {
    CalledOnValidThread();
    Increment();
    base::MessageLoop::current()->PostTask(
        FROM_HERE,
        base::Bind(
            callback, AttachmentService::GET_NOT_FOUND, AttachmentMap()));
  }

  virtual void DropAttachments(const AttachmentIdList& attachment_ids,
                               const DropCallback& callback) OVERRIDE {
    CalledOnValidThread();
    Increment();
    base::MessageLoop::current()->PostTask(
        FROM_HERE, base::Bind(callback, AttachmentService::DROP_SUCCESS));
  }

  virtual void OnSyncDataAdd(const SyncData& sync_data) OVERRIDE {
    CalledOnValidThread();
    Increment();
  }

  virtual void OnSyncDataDelete(const SyncData& sync_data) OVERRIDE {
    CalledOnValidThread();
    Increment();
  }

  virtual void OnSyncDataUpdate(const AttachmentIdList& old_attachment_ids,
                                const SyncData& updated_sync_data) OVERRIDE {
    CalledOnValidThread();
    Increment();
  }

  virtual base::WeakPtr<AttachmentService> AsWeakPtr() {
    return weak_ptr_factory_.GetWeakPtr();
  }

  // Return the number of method invocations.
  int GetCallCount() const {
    base::AutoLock lock(mutex_);
    return call_count_;
  }

 private:
  // Protects call_count_.
  mutable base::Lock mutex_;
  int call_count_;

  // Must be last data member.
  base::WeakPtrFactory<AttachmentService> weak_ptr_factory_;

  void Increment() {
    base::AutoLock lock(mutex_);
    ++call_count_;
  }
};

class AttachmentServiceProxyTest : public testing::Test,
                                   public base::NonThreadSafe {
 protected:
  AttachmentServiceProxyTest() {}

  virtual void SetUp() {
    CalledOnValidThread();
    stub_thread.reset(new base::Thread("attachment service stub thread"));
    stub_thread->Start();
    stub.reset(new StubAttachmentService);
    proxy.reset(new AttachmentServiceProxy(stub_thread->message_loop_proxy(),
                                           stub->AsWeakPtr()));

    sync_data =
        SyncData::CreateLocalData("tag", "title", sync_pb::EntitySpecifics());
    sync_data_delete =
        SyncData::CreateLocalDelete("tag", syncer::PREFERENCES);

    callback_get_or_download =
        base::Bind(&AttachmentServiceProxyTest::IncrementGetOrDownload,
                   base::Unretained(this));
    callback_drop = base::Bind(&AttachmentServiceProxyTest::IncrementDrop,
                               base::Unretained(this));
    count_callback_get_or_download = 0;
    count_callback_drop = 0;
  }

  virtual void TearDown()
      OVERRIDE {
    // We must take care to call the stub's destructor on the stub_thread
    // because that's the thread to which its WeakPtrs are bound.
    if (stub) {
      stub_thread->message_loop()->DeleteSoon(FROM_HERE, stub.release());
      WaitForStubThread();
    }
    stub_thread->Stop();
  }

  // a GetOrDownloadCallback
  void IncrementGetOrDownload(const AttachmentService::GetOrDownloadResult&,
                              const AttachmentMap&) {
    CalledOnValidThread();
    ++count_callback_get_or_download;
  }

  // a DropCallback
  void IncrementDrop(const AttachmentService::DropResult&) {
    CalledOnValidThread();
    ++count_callback_drop;
  }

  void WaitForStubThread() {
    base::WaitableEvent done(false, false);
    stub_thread->message_loop()->PostTask(
        FROM_HERE,
        base::Bind(&base::WaitableEvent::Signal, base::Unretained(&done)));
    done.Wait();
  }

  base::MessageLoop loop;
  scoped_ptr<base::Thread> stub_thread;
  scoped_ptr<StubAttachmentService> stub;
  scoped_ptr<AttachmentServiceProxy> proxy;

  SyncData sync_data;
  SyncData sync_data_delete;

  AttachmentService::GetOrDownloadCallback callback_get_or_download;
  AttachmentService::DropCallback callback_drop;

  // number of times callback_get_or_download was invoked
  int count_callback_get_or_download;
  // number of times callback_drop was invoked
  int count_callback_drop;
};

// Verify that each of AttachmentServiceProxy's regular methods (those that
// don't take callbacks) are invoked on the stub.
TEST_F(AttachmentServiceProxyTest, MethodsAreProxied) {
  proxy->OnSyncDataAdd(sync_data);
  proxy->OnSyncDataDelete(sync_data_delete);
  proxy->OnSyncDataUpdate(AttachmentIdList(), sync_data);
  WaitForStubThread();
  EXPECT_EQ(3, stub->GetCallCount());
}

// Verify that each of AttachmentServiceProxy's callback methods (those that
// take callbacks) are invoked on the stub and that the passed callbacks are
// invoked in this thread.
TEST_F(AttachmentServiceProxyTest, MethodsWithCallbacksAreProxied) {
  proxy->GetOrDownloadAttachments(AttachmentIdList(), callback_get_or_download);
  proxy->DropAttachments(AttachmentIdList(), callback_drop);
  // Wait for the posted calls to execute in the stub thread.
  WaitForStubThread();
  EXPECT_EQ(2, stub->GetCallCount());
  // At this point the stub thread has finished executed the calls. However, the
  // result callbacks it has posted may not have executed yet. Wait a second
  // time to ensure the stub thread has executed the posted result callbacks.
  WaitForStubThread();

  loop.RunUntilIdle();
  EXPECT_EQ(1, count_callback_get_or_download);
  EXPECT_EQ(1, count_callback_drop);
}

// Verify that it's safe to use an AttachmentServiceProxy even after its wrapped
// AttachmentService has been destroyed.
TEST_F(AttachmentServiceProxyTest, WrappedIsDestroyed) {
  proxy->GetOrDownloadAttachments(AttachmentIdList(), callback_get_or_download);
  // Wait for the posted calls to execute in the stub thread.
  WaitForStubThread();
  EXPECT_EQ(1, stub->GetCallCount());
  // Wait a second time ensure the stub thread has executed the posted result
  // callbacks.
  WaitForStubThread();

  loop.RunUntilIdle();
  EXPECT_EQ(1, count_callback_get_or_download);

  // Destroy the stub and call GetOrDownloadAttachments again.
  stub_thread->message_loop()->DeleteSoon(FROM_HERE, stub.release());
  WaitForStubThread();

  // Now that the wrapped object has been destroyed, call again and see that we
  // don't crash and the count remains the same.
  proxy->GetOrDownloadAttachments(AttachmentIdList(), callback_get_or_download);
  WaitForStubThread();
  WaitForStubThread();
  loop.RunUntilIdle();
  EXPECT_EQ(1, count_callback_get_or_download);
}

}  // namespace syncer