summaryrefslogtreecommitdiffstats
path: root/sync/internal_api/public/test/test_user_share.h
diff options
context:
space:
mode:
Diffstat (limited to 'sync/internal_api/public/test/test_user_share.h')
-rw-r--r--sync/internal_api/public/test/test_user_share.h68
1 files changed, 68 insertions, 0 deletions
diff --git a/sync/internal_api/public/test/test_user_share.h b/sync/internal_api/public/test/test_user_share.h
new file mode 100644
index 0000000..7386b18
--- /dev/null
+++ b/sync/internal_api/public/test/test_user_share.h
@@ -0,0 +1,68 @@
+// Copyright (c) 2012 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.
+//
+// A handy class that takes care of setting up and destroying a
+// sync_api::UserShare instance for unit tests that require one.
+//
+// The expected usage is to make this a component of your test fixture:
+//
+// class AwesomenessTest : public testing::Test {
+// public:
+// virtual void SetUp() {
+// test_user_share_.SetUp();
+// }
+// virtual void TearDown() {
+// test_user_share_.TearDown();
+// }
+// protected:
+// TestUserShare test_user_share_;
+// };
+//
+// Then, in your tests:
+//
+// TEST_F(AwesomenessTest, IsMaximal) {
+// sync_api::ReadTransaction trans(test_user_share_.user_share());
+// ...
+// }
+//
+
+#ifndef SYNC_INTERNAL_API_PUBLIC_TEST_TEST_USER_SHARE_H_
+#define SYNC_INTERNAL_API_PUBLIC_TEST_TEST_USER_SHARE_H_
+#pragma once
+
+#include "base/basictypes.h"
+#include "sync/internal_api/public/user_share.h"
+
+namespace browser_sync {
+
+class TestDirectorySetterUpper;
+
+class TestUserShare {
+ public:
+ TestUserShare();
+ ~TestUserShare();
+
+ // Sets up the UserShare instance. Clears any existing database
+ // backing files that might exist on disk.
+ void SetUp();
+
+ // Undo everything done by SetUp(): closes the UserShare and deletes
+ // the backing files. Before closing the directory, this will run
+ // the directory invariant checks and perform the SaveChanges action
+ // on the user share's directory.
+ void TearDown();
+
+ // Non-NULL iff called between a call to SetUp() and TearDown().
+ sync_api::UserShare* user_share();
+
+ private:
+ scoped_ptr<TestDirectorySetterUpper> dir_maker_;
+ scoped_ptr<sync_api::UserShare> user_share_;
+
+ DISALLOW_COPY_AND_ASSIGN(TestUserShare);
+};
+
+} // namespace browser_sync
+
+#endif // SYNC_INTERNAL_API_PUBLIC_TEST_TEST_USER_SHARE_H_