sql/mojo/sql_test_base.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef SQL_MOJO_SQL_TEST_BASE_H_
   6 #define SQL_MOJO_SQL_TEST_BASE_H_
   7
   8 #include "base/files/file_path.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "components/filesystem/public/interfaces/file_system.mojom.h"
  11 #include "mojo/application/public/cpp/application_test_base.h"
  12 #include "sql/connection.h"
  13 #include "testing/gtest/include/gtest/gtest.h"
  14
  15 namespace sql {
  16
  17 class Connection;
  18 class ScopedMojoFilesystemVFS;
  19
  20 // Base class for SQL tests.
  21 //
  22 // WARNING: We want to run the same gtest based unit test code both against
  23 // chromium (which uses this implementation here), and the mojo code (which
  24 // uses a different class named SQLTestBase). These two classes need to have
  25 // the same interface because we compile time switch them based on a
  26 // #define. We need to have two different implementations because the mojo
  27 // version derives from mojo::test::ApplicationTestBase instead of
  28 // testing::Test.
  29 class SQLTestBase : public mojo::test::ApplicationTestBase,
  30                     public filesystem::FileSystemClient {
  31  public:
  32   SQLTestBase();
  33   ~SQLTestBase() override;
  34
  35   enum WriteJunkType {
  36     TYPE_OVERWRITE_AND_TRUNCATE,
  37     TYPE_OVERWRITE
  38   };
  39
  40   // Returns the path to the database.
  41   base::FilePath db_path();
  42
  43   // Returns a connection to the database at db_path().
  44   sql::Connection& db();
  45
  46   // Closes the current connection to the database and reopens it.
  47   bool Reopen();
  48
  49   // Proxying method around base::PathExists.
  50   bool GetPathExists(const base::FilePath& path);
  51
  52   // SQLite stores the database size in the header, and if the actual
  53   // OS-derived size is smaller, the database is considered corrupt.
  54   // [This case is actually a common form of corruption in the wild.]
  55   // This helper sets the in-header size to one page larger than the
  56   // actual file size.  The resulting file will return SQLITE_CORRUPT
  57   // for most operations unless PRAGMA writable_schema is turned ON.
  58   //
  59   // Returns false if any error occurs accessing the file.
  60   bool CorruptSizeInHeaderOfDB();
  61
  62   // Writes junk to the start of the file.
  63   void WriteJunkToDatabase(WriteJunkType type);
  64
  65   // Sets the database file size to 0.
  66   void TruncateDatabase();
  67
  68   // Overridden from testing::Test:
  69   void SetUp() override;
  70   void TearDown() override;
  71
  72   // Overridden from FileSystemClient:
  73   void OnFileSystemShutdown() override;
  74
  75  protected:
  76   filesystem::FileSystemPtr& files() { return files_; }
  77
  78  private:
  79   filesystem::FileSystemPtr files_;
  80
  81   scoped_ptr<ScopedMojoFilesystemVFS> vfs_;
  82   mojo::Binding<filesystem::FileSystemClient> binding_;
  83   sql::Connection db_;
  84
  85   DISALLOW_COPY_AND_ASSIGN(SQLTestBase);
  86 };
  87
  88 }  // namespace sql
  89
  90 #endif  // SQL_MOJO_SQL_TEST_BASE_H_