org.robolectric.shadows.ShadowSQLiteConnection Maven / Gradle / Ivy

Go to download
package org.robolectric.shadows;

import android.database.sqlite.SQLiteConnection;
import android.os.SystemProperties;
import java.util.concurrent.atomic.AtomicBoolean;
import org.robolectric.annotation.Implementation;
import org.robolectric.annotation.Implements;
import org.robolectric.annotation.RealObject;
import org.robolectric.annotation.ReflectorObject;
import org.robolectric.annotation.Resetter;
import org.robolectric.annotation.SQLiteMode;
import org.robolectric.annotation.SQLiteMode.Mode;
import org.robolectric.config.ConfigurationRegistry;
import org.robolectric.util.reflector.Direct;
import org.robolectric.util.reflector.ForType;

/**
 * The base shadow class for {@link SQLiteConnection} shadow APIs.
 *
 * The actual shadow class for {@link SQLiteConnection} will be selected during runtime by the
 * Picker.
 */
@Implements(
    className = "android.database.sqlite.SQLiteConnection",
    isInAndroidSdk = false,
    shadowPicker = ShadowSQLiteConnection.Picker.class)
public class ShadowSQLiteConnection {

  Throwable onCreate = new Throwable();

  protected static AtomicBoolean useInMemoryDatabase = new AtomicBoolean();

  /** Shadow {@link Picker} for {@link ShadowSQLiteConnection} */
  public static class Picker extends SQLiteShadowPicker {
    public Picker() {
      super(ShadowLegacySQLiteConnection.class, ShadowNativeSQLiteConnection.class);
    }
  }

  private final AtomicBoolean disposed = new AtomicBoolean();

  @RealObject SQLiteConnection realObject;

  @ReflectorObject SQLiteConnectionReflector sqliteConnectionReflector;

  @Implementation
  protected void dispose(boolean finalized) {
    // On the JVM there may be two concurrent finalizer threads running if 'System.runFinalization'
    // is called. Because CursorWindow.dispose is not thread safe, we can work around it
    // by manually making it thread safe.
    if (disposed.compareAndSet(false, true)) {
      sqliteConnectionReflector.dispose(finalized);
    }
  }

  public static void setUseInMemoryDatabase(boolean value) {
    if (sqliteMode() == Mode.LEGACY) {
      useInMemoryDatabase.set(value);
    } else {
      throw new UnsupportedOperationException(
          "this action is not supported in " + sqliteMode() + " mode.");
    }
  }

  public static SQLiteMode.Mode sqliteMode() {
    return ConfigurationRegistry.get(SQLiteMode.Mode.class);
  }

  /**
   * Sets the default sync mode for SQLite databases. Robolectric uses "OFF" by default in order to
   * improve SQLite performance. The Android default is "FULL" in order to be more resilient to
   * process crashes. However, this is not a requirement for Robolectric processes, where all
   * database files are temporary and get deleted after each test.
   *
   * 
This also updates the default sync mode used when SQLiteDatabase.ENABLE_WRITE_AHEAD_LOGGING
   * (WAL) is used.
   *
   * 
If your test expects SQLite files being synced to disk, such as having multiple processes
   * interact with the database, or deleting SQLite files while connections are open and having this
   * reflected in the open connection, use "FULL" mode.
   */
  public static void setDefaultSyncMode(String value) {
    SystemProperties.set("debug.sqlite.syncmode", value);
    SystemProperties.set("debug.sqlite.wal.syncmode", value);
  }

  /**
   * Sets the default journal mode for SQLite databases. Robolectric uses "MEMORY" by default in
   * order to improve SQLite performance. The Android default is PERSIST in SDKs <= 25
   * and TRUNCATE in SDKs > 25.
   *
   * Similarly to {@link setDefaultSyncMode}, if your test expects SQLite rollback journal to be
   * synced to disk, use PERSIST or TRUNCATE.
   */
  public static void setDefaultJournalMode(String value) {
    SystemProperties.set("debug.sqlite.journalmode", value);
  }

  @Resetter
  public static void reset() {
    useInMemoryDatabase.set(false);
  }

  @ForType(SQLiteConnection.class)
  interface SQLiteConnectionReflector {
    @Direct
    void dispose(boolean finalized);
  }
}