blob: ced13dbe0c55cfcd06122c6c17cc76c6d88505d6 [file] [log] [blame]
// 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 <stdint.h>
#include <memory>
#include "base/files/file_path.h"
#include "base/files/scoped_temp_dir.h"
#include "base/macros.h"
#include "base/threading/thread.h"
#include "net/base/cache_type.h"
#include "net/disk_cache/disk_cache.h"
#include "net/test/test_with_scoped_task_environment.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 Entry;
class MemBackendImpl;
class SimpleBackendImpl;
class SimpleFileTracker;
} // 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,
public net::WithScopedTaskEnvironment {
protected:
DiskCacheTest();
~DiskCacheTest() override;
// 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();
void TearDown() override;
base::FilePath cache_path_;
private:
base::ScopedTempDir temp_dir_;
};
// Provides basic support for cache related tests.
class DiskCacheTestWithCache : public DiskCacheTest {
protected:
class TestIterator {
public:
explicit TestIterator(
std::unique_ptr<disk_cache::Backend::Iterator> iterator);
~TestIterator();
int OpenNextEntry(disk_cache::Entry** next_entry);
private:
std::unique_ptr<disk_cache::Backend::Iterator> iterator_;
};
DiskCacheTestWithCache();
~DiskCacheTestWithCache() override;
void CreateBackend(uint32_t flags);
void InitCache();
void SimulateCrash();
void SetTestMode();
void SetMemoryOnlyMode() {
memory_only_ = true;
}
void SetSimpleCacheMode() {
DCHECK(!use_current_thread_);
simple_cache_mode_ = true;
}
void SetMask(uint32_t mask) { mask_ = mask; }
void SetMaxSize(int size);
// Returns value last given to SetMaxSize (or 0).
int MaxSize() const { return size_; }
// Deletes and re-creates the files on initialization errors.
void SetForceCreation() {
force_creation_ = true;
}
void SetNewEviction() {
new_eviction_ = true;
}
void DisableSimpleCacheWaitForIndex() {
simple_cache_wait_for_index_ = false;
}
void DisableFirstCleanup() {
first_cleanup_ = false;
}
void DisableIntegrityCheck() {
integrity_ = false;
}
// This is only supported for blockfile cache.
void UseCurrentThread() {
DCHECK(!simple_cache_mode_);
use_current_thread_ = true;
}
void SetCacheType(net::CacheType type) {
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 CalculateSizeOfAllEntries();
int CalculateSizeOfEntriesBetween(const base::Time initial_time,
const base::Time end_time);
int DoomEntriesSince(const base::Time initial_time);
std::unique_ptr<TestIterator> CreateIterator();
void FlushQueueForTest();
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_t offset,
net::IOBuffer* buf,
int len);
int WriteSparseData(disk_cache::Entry* entry,
int64_t offset,
net::IOBuffer* buf,
int len);
// 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);
// Makes sure that some time passes before continuing the test. Time::Now()
// before and after this method will not be the same.
void AddDelay();
void TearDown() override;
// cache_ will always have a valid object, regardless of how the cache was
// initialized. The implementation pointers can be NULL.
std::unique_ptr<disk_cache::Backend> cache_;
disk_cache::BackendImpl* cache_impl_;
std::unique_ptr<disk_cache::SimpleFileTracker> simple_file_tracker_;
disk_cache::SimpleBackendImpl* simple_cache_impl_;
disk_cache::MemBackendImpl* mem_cache_;
uint32_t mask_;
int size_;
net::CacheType type_;
bool memory_only_;
bool simple_cache_mode_;
bool simple_cache_wait_for_index_;
bool force_creation_;
bool new_eviction_;
bool first_cleanup_;
bool integrity_;
bool use_current_thread_;
// This is intentionally left uninitialized, to be used by any test.
bool success_;
private:
void InitMemoryCache();
void InitDiskCache();
DISALLOW_COPY_AND_ASSIGN(DiskCacheTestWithCache);
};
#endif // NET_DISK_CACHE_DISK_CACHE_TEST_BASE_H_