sync/internal_api/attachments/attachment_service_proxy_unittest.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "sync/internal_api/public/attachments/attachment_service_proxy.h"
   6
   7 #include "base/bind.h"
   8 #include "base/memory/ref_counted_memory.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/message_loop/message_loop.h"
  11 #include "base/run_loop.h"
  12 #include "base/synchronization/lock.h"
  13 #include "base/synchronization/waitable_event.h"
  14 #include "base/threading/non_thread_safe.h"
  15 #include "base/threading/thread.h"
  16 #include "sync/api/attachments/attachment.h"
  17 #include "sync/internal_api/public/attachments/attachment_service.h"
  18 #include "sync/internal_api/public/base/model_type.h"
  19 #include "sync/protocol/sync.pb.h"
  20 #include "testing/gtest/include/gtest/gtest.h"
  21
  22 namespace syncer {
  23
  24 // A stub implementation of AttachmentService that counts the number of times
  25 // its methods are invoked.
  26 class StubAttachmentService : public AttachmentService,
  27                               public base::NonThreadSafe {
  28  public:
  29   StubAttachmentService() : call_count_(0), weak_ptr_factory_(this) {
  30     // DetachFromThread because we will be constructed in one thread and
  31     // used/destroyed in another.
  32     DetachFromThread();
  33   }
  34
  35   ~StubAttachmentService() override {}
  36
  37   AttachmentStore* GetStore() override { return NULL; }
  38
  39   void GetOrDownloadAttachments(
  40       const AttachmentIdList& attachment_ids,
  41       const GetOrDownloadCallback& callback) override {
  42     CalledOnValidThread();
  43     Increment();
  44     scoped_ptr<AttachmentMap> attachments(new AttachmentMap());
  45     base::MessageLoop::current()->PostTask(
  46         FROM_HERE,
  47         base::Bind(callback,
  48                    AttachmentService::GET_UNSPECIFIED_ERROR,
  49                    base::Passed(&attachments)));
  50   }
  51
  52   void DropAttachments(const AttachmentIdList& attachment_ids,
  53                        const DropCallback& callback) override {
  54     CalledOnValidThread();
  55     Increment();
  56     base::MessageLoop::current()->PostTask(
  57         FROM_HERE, base::Bind(callback, AttachmentService::DROP_SUCCESS));
  58   }
  59
  60   void UploadAttachments(const AttachmentIdSet& attachments_ids) override {
  61     CalledOnValidThread();
  62     Increment();
  63   }
  64
  65   virtual base::WeakPtr<AttachmentService> AsWeakPtr() {
  66     return weak_ptr_factory_.GetWeakPtr();
  67   }
  68
  69   // Return the number of method invocations.
  70   int GetCallCount() const {
  71     base::AutoLock lock(mutex_);
  72     return call_count_;
  73   }
  74
  75  private:
  76   // Protects call_count_.
  77   mutable base::Lock mutex_;
  78   int call_count_;
  79
  80   // Must be last data member.
  81   base::WeakPtrFactory<AttachmentService> weak_ptr_factory_;
  82
  83   void Increment() {
  84     base::AutoLock lock(mutex_);
  85     ++call_count_;
  86   }
  87 };
  88
  89 class AttachmentServiceProxyTest : public testing::Test,
  90                                    public base::NonThreadSafe {
  91  protected:
  92   AttachmentServiceProxyTest() {}
  93
  94   void SetUp() override {
  95     CalledOnValidThread();
  96     stub_thread.reset(new base::Thread("attachment service stub thread"));
  97     stub_thread->Start();
  98     stub.reset(new StubAttachmentService);
  99     proxy.reset(new AttachmentServiceProxy(stub_thread->message_loop_proxy(),
 100                                            stub->AsWeakPtr()));
 101
 102     callback_get_or_download =
 103         base::Bind(&AttachmentServiceProxyTest::IncrementGetOrDownload,
 104                    base::Unretained(this));
 105     callback_drop = base::Bind(&AttachmentServiceProxyTest::IncrementDrop,
 106                                base::Unretained(this));
 107     count_callback_get_or_download = 0;
 108     count_callback_drop = 0;
 109   }
 110
 111   void TearDown() override {
 112     // We must take care to call the stub's destructor on the stub_thread
 113     // because that's the thread to which its WeakPtrs are bound.
 114     if (stub) {
 115       stub_thread->message_loop()->DeleteSoon(FROM_HERE, stub.release());
 116       WaitForStubThread();
 117     }
 118     stub_thread->Stop();
 119   }
 120
 121   // a GetOrDownloadCallback
 122   void IncrementGetOrDownload(const AttachmentService::GetOrDownloadResult&,
 123                               scoped_ptr<AttachmentMap>) {
 124     CalledOnValidThread();
 125     ++count_callback_get_or_download;
 126   }
 127
 128   // a DropCallback
 129   void IncrementDrop(const AttachmentService::DropResult&) {
 130     CalledOnValidThread();
 131     ++count_callback_drop;
 132   }
 133
 134   void WaitForStubThread() {
 135     base::WaitableEvent done(false, false);
 136     stub_thread->message_loop()->PostTask(
 137         FROM_HERE,
 138         base::Bind(&base::WaitableEvent::Signal, base::Unretained(&done)));
 139     done.Wait();
 140   }
 141
 142   base::MessageLoop loop;
 143   scoped_ptr<base::Thread> stub_thread;
 144   scoped_ptr<StubAttachmentService> stub;
 145   scoped_ptr<AttachmentServiceProxy> proxy;
 146
 147   AttachmentService::GetOrDownloadCallback callback_get_or_download;
 148   AttachmentService::DropCallback callback_drop;
 149
 150   // number of times callback_get_or_download was invoked
 151   int count_callback_get_or_download;
 152   // number of times callback_drop was invoked
 153   int count_callback_drop;
 154 };
 155
 156 TEST_F(AttachmentServiceProxyTest, GetStore) {
 157   EXPECT_EQ(NULL, proxy->GetStore());
 158 }
 159
 160 // Verify that each of AttachmentServiceProxy's methods are invoked on the stub.
 161 // Verify that the methods that take callbacks invoke passed callbacks on this
 162 // thread.
 163 TEST_F(AttachmentServiceProxyTest, MethodsAreProxied) {
 164   proxy->GetOrDownloadAttachments(AttachmentIdList(), callback_get_or_download);
 165   proxy->DropAttachments(AttachmentIdList(), callback_drop);
 166   proxy->UploadAttachments(AttachmentIdSet());
 167   // Wait for the posted calls to execute in the stub thread.
 168   WaitForStubThread();
 169   EXPECT_EQ(3, stub->GetCallCount());
 170   // At this point the stub thread has finished executed the calls. However, the
 171   // result callbacks it has posted may not have executed yet. Wait a second
 172   // time to ensure the stub thread has executed the posted result callbacks.
 173   WaitForStubThread();
 174
 175   loop.RunUntilIdle();
 176   EXPECT_EQ(1, count_callback_get_or_download);
 177   EXPECT_EQ(1, count_callback_drop);
 178 }
 179
 180 // Verify that it's safe to use an AttachmentServiceProxy even after its wrapped
 181 // AttachmentService has been destroyed.
 182 TEST_F(AttachmentServiceProxyTest, WrappedIsDestroyed) {
 183   proxy->GetOrDownloadAttachments(AttachmentIdList(), callback_get_or_download);
 184   // Wait for the posted calls to execute in the stub thread.
 185   WaitForStubThread();
 186   EXPECT_EQ(1, stub->GetCallCount());
 187   // Wait a second time ensure the stub thread has executed the posted result
 188   // callbacks.
 189   WaitForStubThread();
 190
 191   loop.RunUntilIdle();
 192   EXPECT_EQ(1, count_callback_get_or_download);
 193
 194   // Destroy the stub and call GetOrDownloadAttachments again.
 195   stub_thread->message_loop()->DeleteSoon(FROM_HERE, stub.release());
 196   WaitForStubThread();
 197
 198   // Now that the wrapped object has been destroyed, call again and see that we
 199   // don't crash and the count remains the same.
 200   proxy->GetOrDownloadAttachments(AttachmentIdList(), callback_get_or_download);
 201   WaitForStubThread();
 202   WaitForStubThread();
 203   loop.RunUntilIdle();
 204   EXPECT_EQ(1, count_callback_get_or_download);
 205 }
 206
 207 }  // namespace syncer