PreferenceTestUtilsTest.java

/*
 * Copyright (C) 2014 SCVNGR, Inc. d/b/a LevelUp
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.scvngr.levelup.core.test;

import android.support.annotation.NonNull;
import android.test.suitebuilder.annotation.SmallTest;

import junit.framework.AssertionFailedError;

/**
 * Tests {@link PreferenceTestUtils}.
 */
public final class PreferenceTestUtilsTest extends SupportAndroidTestCase {

    @NonNull
    private static final String KEY_PREFIX_ONE =
            "com.scvngr.levelup.core.test.storage.preference";

    @NonNull
    private static final String KEY_PREFIX_TWO = "com.example.storage.preference";

    /**
     * Tests {@link PreferenceTestUtils#assertKeysArePrefixed}.
     */
    @SmallTest
    public void testAssertKeysArePrefixed() {
        PreferenceTestUtils.assertKeysArePrefixed(ValidPreferenceClass.class, KEY_PREFIX_ONE);

        try {
            PreferenceTestUtils.assertKeysArePrefixed(ValidPreferenceClass.class, KEY_PREFIX_TWO);
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }

        try {
            PreferenceTestUtils.assertKeysArePrefixed(ValidPreferenceClass.class, "com.example");
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }

        try {
            PreferenceTestUtils.assertKeysArePrefixed(ValidPreferenceClass.class,
                    "com.example.storage.preferences");
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }

        PreferenceTestUtils.assertKeysArePrefixed(DuplicatePreferenceClass.class, KEY_PREFIX_ONE);

        try {
            PreferenceTestUtils.assertKeysArePrefixed(DuplicatePreferenceClass.class,
                    KEY_PREFIX_TWO);
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }

        try {
            PreferenceTestUtils.assertKeysArePrefixed(InconsistentPrefixPreferenceClass.class,
                    KEY_PREFIX_ONE);
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }

        try {
            PreferenceTestUtils.assertKeysArePrefixed(InconsistentPrefixPreferenceClass.class,
                    KEY_PREFIX_TWO);
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }
    }

    /**
     * Tests {@link PreferenceTestUtils#assertKeysAreUnique}.
     */
    @SmallTest
    public void testAssertKeysAreUnique() {
        PreferenceTestUtils.assertKeysAreUnique(ValidPreferenceClass.class);
        PreferenceTestUtils.assertKeysAreUnique(InconsistentPrefixPreferenceClass.class);

        try {
            PreferenceTestUtils.assertKeysAreUnique(DuplicatePreferenceClass.class);
            fail();
        } catch (final AssertionFailedError e) {
            // Expected
        }
    }

    /**
     * Class that defines duplicate preference keys.
     */
    @SuppressWarnings("unused")
    private static final class DuplicatePreferenceClass {

        @NonNull
        public static final String KEY_STRING_TO_DUPE = KEY_PREFIX_ONE + ".string_to_dupe";

        @NonNull
        public static final String KEY_STRING_OR_NOT_TO_DUPE = KEY_PREFIX_ONE + ".string_to_dupe";
    }

    /**
     * Class that defines a preference keys with different prefixes.
     */
    @SuppressWarnings("unused")
    private static final class InconsistentPrefixPreferenceClass {

        @NonNull
        public static final String KEY_STRING_NOT_BAD = KEY_PREFIX_ONE + ".string_not_bad";

        @NonNull
        public static final String KEY_STRING_WRONG_PREFIX = KEY_PREFIX_TWO
                + ".string_wrong_prefix";
    }

    /**
     * Class that defines valid preference keys.
     */
    @SuppressWarnings("unused")
    private static final class ValidPreferenceClass {

        @NonNull
        public static final String KEY_STRING_FAVORITE_DINOSAUR = KEY_PREFIX_ONE
                + ".string_favorite_dinosaur";

        @NonNull
        public static final String KEY_BOOLEAN_IS_EXTINCT = KEY_PREFIX_ONE + ".boolean_is_extinct";
    }
}