src/test/java/org/robolectric/tester/android/content/TestSharedPreferencesTest.java

package org.robolectric.tester.android.content;

import android.content.SharedPreferences;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.TestRunners;
import org.robolectric.util.Transcript;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import static org.fest.assertions.api.Assertions.assertThat;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

/**
 * TestSharedPreferencesTest
 */
@RunWith(TestRunners.WithDefaults.class)
public class TestSharedPreferencesTest {
  protected final static String FILENAME = "filename";
  private HashMap<String, Map<String, Object>> content;
  private SharedPreferences.Editor editor;
  private TestSharedPreferences sharedPreferences;

  private static final Set<String> stringSet;

  static {
    stringSet = new HashSet<String>();
    stringSet.add( "string1" );
    stringSet.add( "string2" );
    stringSet.add( "string3" );
  }

  @Before
  public void setUp() {
    content = new HashMap<String, Map<String, Object>>();

    sharedPreferences = new TestSharedPreferences(content, FILENAME, 3);
    editor = sharedPreferences.edit();
    editor.putBoolean("boolean", true);
    editor.putFloat("float", 1.1f);
    editor.putInt("int", 2);
    editor.putLong("long", 3l);
    editor.putString("string", "foobar");
    editor.putStringSet( "stringSet", stringSet );
  }

  @Test
  public void commit_shouldStoreValues() throws Exception {
    editor.commit();

    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, FILENAME, 3);
    assertTrue(anotherSharedPreferences.getBoolean("boolean", false));
    assertThat(anotherSharedPreferences.getFloat("float", 666f)).isEqualTo(1.1f);
    assertThat(anotherSharedPreferences.getInt("int", 666)).isEqualTo(2);
    assertThat(anotherSharedPreferences.getLong("long", 666l)).isEqualTo(3l);
    assertThat(anotherSharedPreferences.getString("string", "wacka wa")).isEqualTo("foobar");
    assertThat(anotherSharedPreferences.getStringSet("stringSet", null)).isEqualTo(stringSet);
  }

  @Test
  public void getAll_shouldReturnAllValues() throws Exception {
    editor.commit();
    Map<String, ?> all = sharedPreferences.getAll();
    assertThat(all.size()).isEqualTo(6);
    assertThat((Integer) all.get("int")).isEqualTo(2);
  }

  @Test
  public void commit_shouldRemoveValuesThenSetValues() throws Exception {
    content.put(FILENAME, new HashMap<String, Object>());
    content.get(FILENAME).put("deleteMe", "foo");

    editor.remove("deleteMe");

    editor.putString("dontDeleteMe", "baz");
    editor.remove("dontDeleteMe");

    editor.commit();

    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, FILENAME, 3);
    assertTrue(anotherSharedPreferences.getBoolean("boolean", false));
    assertThat(anotherSharedPreferences.getFloat("float", 666f)).isEqualTo(1.1f);
    assertThat(anotherSharedPreferences.getInt("int", 666)).isEqualTo(2);
    assertThat(anotherSharedPreferences.getLong("long", 666l)).isEqualTo(3l);
    assertThat(anotherSharedPreferences.getString("string", "wacka wa")).isEqualTo("foobar");

    assertThat(anotherSharedPreferences.getString("deleteMe", "awol")).isEqualTo("awol");
    assertThat(anotherSharedPreferences.getString("dontDeleteMe", "oops")).isEqualTo("baz");
  }

  @Test
  public void commit_shouldClearThenSetValues() throws Exception {
    content.put(FILENAME, new HashMap<String, Object>());
    content.get(FILENAME).put("deleteMe", "foo");

    editor.clear();
    editor.putString("dontDeleteMe", "baz");

    editor.commit();

    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, FILENAME, 3);
    assertTrue(anotherSharedPreferences.getBoolean("boolean", false));
    assertThat(anotherSharedPreferences.getFloat("float", 666f)).isEqualTo(1.1f);
    assertThat(anotherSharedPreferences.getInt("int", 666)).isEqualTo(2);
    assertThat(anotherSharedPreferences.getLong("long", 666l)).isEqualTo(3l);
    assertThat(anotherSharedPreferences.getString("string", "wacka wa")).isEqualTo("foobar");

    assertThat(anotherSharedPreferences.getString("deleteMe", "awol")).isEqualTo("awol");
    assertThat(anotherSharedPreferences.getString("dontDeleteMe", "oops")).isEqualTo("baz");
  }

  @Test
  public void apply_shouldStoreValues() throws Exception {
    editor.apply();

    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, FILENAME, 3);
    assertThat(anotherSharedPreferences.getString("string", "wacka wa")).isEqualTo("foobar");
  }

  @Test
  public void shouldReturnDefaultValues() throws Exception {
    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, "bazBang", 3);

    assertFalse(anotherSharedPreferences.getBoolean("boolean", false));
    assertThat(anotherSharedPreferences.getFloat("float", 666f)).isEqualTo(666f);
    assertThat(anotherSharedPreferences.getInt("int", 666)).isEqualTo(666);
    assertThat(anotherSharedPreferences.getLong("long", 666l)).isEqualTo(666l);
    assertThat(anotherSharedPreferences.getString("string", "wacka wa")).isEqualTo("wacka wa");
  }

  @Test
  public void shouldStoreRegisteredListeners() {
    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, "bazBang", 3);
    anotherSharedPreferences.registerOnSharedPreferenceChangeListener(testListener);
    assertTrue(anotherSharedPreferences.hasListener(testListener));
  }

  @Test
  public void shouldRemoveRegisteredListenersOnUnresgister() {
    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, "bazBang", 3);
    anotherSharedPreferences.registerOnSharedPreferenceChangeListener(testListener);

    anotherSharedPreferences.unregisterOnSharedPreferenceChangeListener(testListener);
    assertFalse(anotherSharedPreferences.hasListener(testListener));
  }

  @Test
  public void shouldTriggerRegisteredListeners() {
    TestSharedPreferences anotherSharedPreferences = new TestSharedPreferences(content, "bazBang", 3);

    final String testKey = "foo";

    final Transcript transcript = new Transcript();

    SharedPreferences.OnSharedPreferenceChangeListener listener = new SharedPreferences.OnSharedPreferenceChangeListener() {
      @Override
      public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
        transcript.add(key + " called");
      }
    };
    anotherSharedPreferences.registerOnSharedPreferenceChangeListener(listener);
    anotherSharedPreferences.edit().putString(testKey, "bar").commit();

    transcript.assertEventsSoFar(testKey+ " called");
  }

  private SharedPreferences.OnSharedPreferenceChangeListener testListener = new SharedPreferences.OnSharedPreferenceChangeListener() {
    @Override
    public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
    }
  };
}