components/persistent_cache/sqlite/test_utils.h

// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PERSISTENT_CACHE_SQLITE_TEST_UTILS_H_
#define COMPONENTS_PERSISTENT_CACHE_SQLITE_TEST_UTILS_H_

#include <vector>

#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "components/persistent_cache/backend_params.h"
#include "components/persistent_cache/sqlite/vfs/sqlite_database_vfs_file_set.h"

namespace persistent_cache::test_utils {

// Use TestHelper from tests to generate valid initialization
// structures for backends and PersistentCache. This class takes care of owning
// the backing files and the directories they live in. They are deleted on
// destruction.
//
// Example:
//    TestHelper provider;
//    BackendParams backend_params =
//      provider.CreateBackendFilesAndBuildParams(BackendType::kSqlite);
//
//    auto PersistentCache persistent_cache =
//      PersistentCache::Open(backend_params);
//
class TestHelper {
 public:
  TestHelper();
  ~TestHelper();

  // Non-copyable and non-moveable since it's a test support class to be used in
  // fixtures.
  TestHelper(const TestHelper&) = delete;
  TestHelper(TestHelper&&) = delete;
  TestHelper& operator=(const TestHelper&) = delete;
  TestHelper& operator=(TestHelper&&) = delete;

  SqliteVfsFileSet CreateFilesAndBuildVfsFileSet();
  BackendParams CreateBackendFilesAndBuildParams(BackendType type);

 private:
  base::File CreateFile(base::FilePath directory, const std::string& file_name);
  base::FilePath CreateTemporaryDir();
  std::vector<base::ScopedTempDir> scoped_temp_dirs_;
};

}  // namespace persistent_cache::test_utils

#endif  // COMPONENTS_PERSISTENT_CACHE_SQLITE_TEST_UTILS_H_