blob: a3c5508c534a83d5f1ea8327a11196de173b575f [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_UTIL_H_
#define NET_DISK_CACHE_DISK_CACHE_TEST_UTIL_H_
#pragma once
#include <string>
#include "base/file_path.h"
#include "base/message_loop.h"
#include "base/timer.h"
#include "base/tuple.h"
#include "build/build_config.h"
// Re-creates a given test file inside the cache test folder.
bool CreateCacheTestFile(const FilePath& name);
// Deletes all file son the cache.
bool DeleteCache(const FilePath& path);
// Gets the path to the cache test folder.
FilePath GetCacheFilePath();
// Fills buffer with random values (may contain nulls unless no_nulls is true).
void CacheTestFillBuffer(char* buffer, size_t len, bool no_nulls);
// Generates a random key of up to 200 bytes.
std::string GenerateKey(bool same_length);
// Returns true if the cache is not corrupt.
bool CheckCacheIntegrity(const FilePath& path, bool new_eviction, uint32 mask);
// Helper class which ensures that the cache dir returned by GetCacheFilePath
// exists and is clear in ctor and that the directory gets deleted in dtor.
class ScopedTestCache {
public:
explicit ScopedTestCache(const FilePath& path);
// Use a specific folder name.
explicit ScopedTestCache(const std::string& name);
~ScopedTestCache();
FilePath path() const { return path_; }
private:
const FilePath path_; // Path to the cache test folder.
DISALLOW_COPY_AND_ASSIGN(ScopedTestCache);
};
// -----------------------------------------------------------------------
// Simple helper to deal with the message loop on a test.
class MessageLoopHelper {
public:
MessageLoopHelper();
~MessageLoopHelper();
// Run the message loop and wait for num_callbacks before returning. Returns
// false if we are waiting to long. Each callback that will be waited on is
// required to call CallbackWasCalled() to indicate when it was called.
bool WaitUntilCacheIoFinished(int num_callbacks);
// True if a given callback was called more times than it expected.
bool callback_reused_error() const { return callback_reused_error_; }
void set_callback_reused_error(bool error) {
callback_reused_error_ = error;
}
int callbacks_called() const { return callbacks_called_; }
// Report that a callback was called. Each callback that will be waited on
// via WaitUntilCacheIoFinished() is expected to call this method to
// indicate when it has been executed.
void CallbackWasCalled() { ++callbacks_called_; }
private:
// Sets the number of callbacks that can be received so far.
void ExpectCallbacks(int num_callbacks) {
num_callbacks_ = num_callbacks;
num_iterations_ = last_ = 0;
completed_ = false;
}
// Called periodically to test if WaitUntilCacheIoFinished should return.
void TimerExpired();
base::RepeatingTimer<MessageLoopHelper> timer_;
int num_callbacks_;
int num_iterations_;
int last_;
bool completed_;
// True if a callback was called/reused more than expected.
bool callback_reused_error_;
int callbacks_called_;
DISALLOW_COPY_AND_ASSIGN(MessageLoopHelper);
};
// -----------------------------------------------------------------------
// Simple callback to process IO completions from the cache. It allows tests
// with multiple simultaneous IO operations.
class CallbackTest {
public:
// Creates a new CallbackTest object. When the callback is called, it will
// update |helper| with the result of the call. If |reuse| is false and a
// callback is called more than once, or if |reuse| is true and a callback
// is called more than twice, an error will be reported to |helper|.
CallbackTest(MessageLoopHelper* helper, bool reuse);
~CallbackTest();
void Run(int params);
private:
MessageLoopHelper* helper_;
int reuse_;
DISALLOW_COPY_AND_ASSIGN(CallbackTest);
};
#endif // NET_DISK_CACHE_DISK_CACHE_TEST_UTIL_H_