Disk cache: Reference CL for the implementation of file format version 3.

net/disk_cache/disk_cache_test_base.h

 // 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.
 
 #ifndef NET_DISK_CACHE_DISK_CACHE_TEST_BASE_H_
 #define NET_DISK_CACHE_DISK_CACHE_TEST_BASE_H_
 
 #include "base/basictypes.h"
 #include "base/files/file_path.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/threading/thread.h"
+#include "base/time.h"
 #include "net/base/cache_type.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/platform_test.h"
 
 namespace net {
 
 class IOBuffer;
 
 }  // namespace net
 
 namespace disk_cache {
 
 class Backend;
 class BackendImpl;
+class BackendImplV3;
 class Entry;
 class MemBackendImpl;
 class SimpleBackendImpl;
 
 }  // namespace disk_cache
 
 // These tests can use the path service, which uses autoreleased objects on the
 // Mac, so this needs to be a PlatformTest.  Even tests that do not require a
 // cache (and that do not need to be a DiskCacheTestWithCache) are susceptible
 // to this problem; all such tests should use TEST_F(DiskCacheTest, ...).
 class DiskCacheTest : public PlatformTest {
  protected:
   DiskCacheTest();
   virtual ~DiskCacheTest();
 
   // Copies a set of cache files from the data folder to the test folder.
   bool CopyTestCache(const std::string& name);
 
   // Deletes the contents of |cache_path_|.
   bool CleanupCacheDir();
 
+  // Forces the use of a random cache directory.
+  bool ForceRandomCacheDir();
+
   virtual void TearDown() OVERRIDE;
 
   base::FilePath cache_path_;
 
  private:
   base::ScopedTempDir temp_dir_;
   scoped_ptr<MessageLoop> message_loop_;
 };
 
 // Provides basic support for cache related tests.
 class DiskCacheTestWithCache : public DiskCacheTest {
  protected:
   DiskCacheTestWithCache();
   virtual ~DiskCacheTestWithCache();
 
-  void CreateBackend(uint32 flags, base::Thread* thread);
+  void CreateBackend(base::Thread* thread);
 
   void InitCache();
   void SimulateCrash();
   void SetTestMode();
 
+  // Same as SetTestMode except that sets the flag on construction.
+  void PresetTestMode() {
+    EXPECT_FALSE(cache_);
+    unit_test_mode_ = true;
+  }
+
   void SetMemoryOnlyMode() {
+    EXPECT_FALSE(cache_);
     memory_only_ = true;
   }
 
   void SetSimpleCacheMode() {
+    EXPECT_FALSE(cache_);
     simple_cache_mode_ = true;
   }
 
   void SetMask(uint32 mask) {
+    EXPECT_FALSE(cache_);
     mask_ = mask;
   }
 
   void SetMaxSize(int size);
 
   // Deletes and re-creates the files on initialization errors.
   void SetForceCreation() {
+    EXPECT_FALSE(cache_);
     force_creation_ = true;
   }
 
   void SetNewEviction() {
+    EXPECT_FALSE(cache_);
     new_eviction_ = true;
   }
 
+  void UseVersion3() {
+    EXPECT_FALSE(cache_);
+    v3_ = true;
+  }
+
   void DisableFirstCleanup() {
+    EXPECT_FALSE(cache_);
     first_cleanup_ = false;
   }
 
   void DisableIntegrityCheck() {
     integrity_ = false;
   }
 
   void UseCurrentThread() {
+    EXPECT_FALSE(cache_);
     use_current_thread_ = true;
   }
 
+  void AvoidTestFlag() {
+    EXPECT_FALSE(cache_);
+    EXPECT_FALSE(v3_);
+    avoid_test_flag_ = true;
+  }
+
   void SetCacheType(net::CacheType type) {
+    EXPECT_FALSE(cache_);
     type_ = type;
   }
 
   // Utility methods to access the cache and wait for each operation to finish.
   int OpenEntry(const std::string& key, disk_cache::Entry** entry);
   int CreateEntry(const std::string& key, disk_cache::Entry** entry);
   int DoomEntry(const std::string& key);
   int DoomAllEntries();
   int DoomEntriesBetween(const base::Time initial_time,
                          const base::Time end_time);
   int DoomEntriesSince(const base::Time initial_time);
   int OpenNextEntry(void** iter, disk_cache::Entry** next_entry);
   void FlushQueueForTest();
+  void CleanupForTest();
   void RunTaskForTest(const base::Closure& closure);
+
   int ReadData(disk_cache::Entry* entry, int index, int offset,
                net::IOBuffer* buf, int len);
   int WriteData(disk_cache::Entry* entry, int index, int offset,
                 net::IOBuffer* buf, int len, bool truncate);
   int ReadSparseData(disk_cache::Entry* entry, int64 offset, net::IOBuffer* buf,
                      int len);
   int WriteSparseData(disk_cache::Entry* entry, int64 offset,
                       net::IOBuffer* buf, int len);
+  int GetAvailableRange(disk_cache::Entry* entry, int64 offset, int len,
+                        int64* start);
+
+  bool IsAllocAllowed(int current_size, int new_size);
+  void BufferDeleted(int size);
+  int GetTotalBuffersSize();
+  void SetNoBuffering();
+  void WaitForEntryToClose(const std::string& key);
 
   // Asks the cache to trim an entry. If |empty| is true, the whole cache is
   // deleted.
   void TrimForTest(bool empty);
 
   // Asks the cache to trim an entry from the deleted list. If |empty| is
   // true, the whole list is deleted.
   void TrimDeletedListForTest(bool empty);
 
+  // Returns the current time as seen by the backend.
+  base::Time GetTime();
+
+  // Simulates that some |seconds| have passed before proceeding with a test.
+  void AddDelayForTest(int seconds);
+
   // Makes sure that some time passes before continuing the test. Time::Now()
   // before and after this method will not be the same.
   void AddDelay();
 
   // DiskCacheTest:
   virtual void TearDown() OVERRIDE;
 
   // cache_ will always have a valid object, regardless of how the cache was
   // initialized. The implementation pointers can be NULL.
   disk_cache::Backend* cache_;
   disk_cache::BackendImpl* cache_impl_;
   disk_cache::SimpleBackendImpl* simple_cache_impl_;
   disk_cache::MemBackendImpl* mem_cache_;
+  disk_cache::BackendImplV3* cache_impl_v3_;
 
   uint32 mask_;
   int size_;
   net::CacheType type_;
   bool memory_only_;
   bool simple_cache_mode_;
   bool force_creation_;
   bool new_eviction_;
+  bool v3_;
   bool first_cleanup_;
   bool integrity_;
   bool use_current_thread_;
+  bool avoid_test_flag_;
+  bool unit_test_mode_;
   // This is intentionally left uninitialized, to be used by any test.
   bool success_;
 
  private:
   void InitMemoryCache();
   void InitDiskCache();
 
   base::Thread cache_thread_;
   DISALLOW_COPY_AND_ASSIGN(DiskCacheTestWithCache);
 };
 
 #endif  // NET_DISK_CACHE_DISK_CACHE_TEST_BASE_H_