LatinIME/tests/src/com/android/inputmethod/latin/personalization/UserHistoryDictionaryTests.java

/*
 * Copyright (C) 2012 The Android Open Source Project
 *
 * 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.android.inputmethod.latin.personalization;

import android.content.SharedPreferences;
import android.preference.PreferenceManager;
import android.test.AndroidTestCase;
import android.test.suitebuilder.annotation.LargeTest;
import android.util.Log;

import com.android.inputmethod.latin.ExpandableBinaryDictionary;
import com.android.inputmethod.latin.NgramContext;
import com.android.inputmethod.latin.NgramContext.WordInfo;
import com.android.inputmethod.latin.settings.LocalSettingsConstants;
import com.android.inputmethod.latin.utils.BinaryDictionaryUtils;
import com.android.inputmethod.latin.utils.DistracterFilter;

import java.io.File;
import java.util.List;
import java.util.Locale;
import java.util.Random;
import java.util.concurrent.TimeUnit;

import javax.annotation.Nullable;

/**
 * Unit tests for UserHistoryDictionary
 */
@LargeTest
public class UserHistoryDictionaryTests extends AndroidTestCase {
    private static final String TAG = UserHistoryDictionaryTests.class.getSimpleName();
    private static final int WAIT_FOR_WRITING_FILE_IN_MILLISECONDS = 3000;
    private static final String TEST_ACCOUNT = "account@example.com";

    private int mCurrentTime = 0;

    private SharedPreferences mPrefs;
    private String mLastKnownAccount = null;

    private static void printAllFiles(final File dir) {
        Log.d(TAG, dir.getAbsolutePath());
        for (final File file : dir.listFiles()) {
            Log.d(TAG, "  " + file.getName());
        }
    }

    private static void assertDictionaryExists(final UserHistoryDictionary dict,
            final File dictFile) {
        Log.d(TAG, "waiting for writing ...");
        dict.waitAllTasksForTests();
        if (!dictFile.exists()) {
            try {
                Log.d(TAG, dictFile + " is not existing. Wait "
                        + WAIT_FOR_WRITING_FILE_IN_MILLISECONDS + " ms for writing.");
                printAllFiles(dictFile.getParentFile());
                Thread.sleep(WAIT_FOR_WRITING_FILE_IN_MILLISECONDS);
            } catch (final InterruptedException e) {
                Log.e(TAG, "Interrupted during waiting for writing the dict file.");
            }
        }
        assertTrue("Following dictionary file doesn't exist: " + dictFile, dictFile.exists());
    }

    @Override
    protected void setUp() throws Exception {
        super.setUp();

        mPrefs = PreferenceManager.getDefaultSharedPreferences(getContext());
        // Keep track of the current account so that we restore it when the test finishes.
        mLastKnownAccount = mPrefs.getString(LocalSettingsConstants.PREF_ACCOUNT_NAME, null);
        updateAccountName(TEST_ACCOUNT);

        resetCurrentTimeForTestMode();
        UserHistoryDictionaryTestsHelper.removeAllTestDictFiles(
                UserHistoryDictionaryTestsHelper.TEST_LOCALE_PREFIX, mContext);
    }

    @Override
    protected void tearDown() throws Exception {
        UserHistoryDictionaryTestsHelper.removeAllTestDictFiles(
                UserHistoryDictionaryTestsHelper.TEST_LOCALE_PREFIX, mContext);
        stopTestModeInNativeCode();

        // Restore the account that was present before running the test.
        updateAccountName(mLastKnownAccount);

        super.tearDown();
    }

    private void resetCurrentTimeForTestMode() {
        mCurrentTime = 0;
        setCurrentTimeForTestMode(mCurrentTime);
    }

    private void updateAccountName(@Nullable final String accountName) {
        if (accountName == null) {
            mPrefs.edit().remove(LocalSettingsConstants.PREF_ACCOUNT_NAME).apply();
        } else {
            mPrefs.edit().putString(LocalSettingsConstants.PREF_ACCOUNT_NAME, accountName).apply();
        }
    }

    private void forcePassingShortTime() {
        // 3 days.
        final int timeToElapse = (int)TimeUnit.DAYS.toSeconds(3);
        mCurrentTime += timeToElapse;
        setCurrentTimeForTestMode(mCurrentTime);
    }

    private void forcePassingLongTime() {
        // 365 days.
        final int timeToElapse = (int)TimeUnit.DAYS.toSeconds(365);
        mCurrentTime += timeToElapse;
        setCurrentTimeForTestMode(mCurrentTime);
    }

    private static int setCurrentTimeForTestMode(final int currentTime) {
        return BinaryDictionaryUtils.setCurrentTimeForTest(currentTime);
    }

    private static int stopTestModeInNativeCode() {
        return BinaryDictionaryUtils.setCurrentTimeForTest(-1);
    }

    /**
     * Clear all entries in the user history dictionary.
     * @param dict the user history dictionary.
     */
    private static void clearHistory(final UserHistoryDictionary dict) {
        dict.waitAllTasksForTests();
        dict.clear();
        dict.close();
        dict.waitAllTasksForTests();
    }

    public void testRandomWords() {
        Log.d(TAG, "This test can be used for profiling.");
        Log.d(TAG, "Usage: please set UserHistoryDictionary.PROFILE_SAVE_RESTORE to true.");
        final Locale dummyLocale = UserHistoryDictionaryTestsHelper.getDummyLocale("random_words");
        final String dictName = UserHistoryDictionary.getUserHistoryDictName(
                UserHistoryDictionary.NAME, dummyLocale, null /* dictFile */, getContext());
        final File dictFile = ExpandableBinaryDictionary.getDictFile(
                mContext, dictName, null /* dictFile */);
        final UserHistoryDictionary dict = PersonalizationHelper.getUserHistoryDictionary(
                getContext(), dummyLocale, TEST_ACCOUNT);
        clearHistory(dict);
        final int numberOfWords = 1000;
        final Random random = new Random(123456);
        assertTrue(UserHistoryDictionaryTestsHelper.addAndWriteRandomWords(
                dict, numberOfWords, random, true /* checksContents */, mCurrentTime));
        assertDictionaryExists(dict, dictFile);
    }

    public void testStressTestForSwitchingLanguagesAndAddingWords() {
        final int numberOfLanguages = 2;
        final int numberOfLanguageSwitching = 80;
        final int numberOfWordsInsertedForEachLanguageSwitch = 100;

        final File dictFiles[] = new File[numberOfLanguages];
        final UserHistoryDictionary dicts[] = new UserHistoryDictionary[numberOfLanguages];

        try {
            final Random random = new Random(123456);

            // Create filename suffixes for this test.
            for (int i = 0; i < numberOfLanguages; i++) {
                final Locale dummyLocale =
                        UserHistoryDictionaryTestsHelper.getDummyLocale("switching_languages" + i);
                final String dictName = UserHistoryDictionary.getUserHistoryDictName(
                        UserHistoryDictionary.NAME, dummyLocale, null /* dictFile */, getContext());
                dictFiles[i] = ExpandableBinaryDictionary.getDictFile(
                        mContext, dictName, null /* dictFile */);
                dicts[i] = PersonalizationHelper.getUserHistoryDictionary(getContext(),
                        dummyLocale, TEST_ACCOUNT);
                clearHistory(dicts[i]);
            }

            final long start = System.currentTimeMillis();

            for (int i = 0; i < numberOfLanguageSwitching; i++) {
                final int index = i % numberOfLanguages;
                // Switch to dicts[index].
                assertTrue(UserHistoryDictionaryTestsHelper.addAndWriteRandomWords(dicts[index],
                        numberOfWordsInsertedForEachLanguageSwitch,
                        random,
                        false /* checksContents */,
                        mCurrentTime));
            }

            final long end = System.currentTimeMillis();
            Log.d(TAG, "testStressTestForSwitchingLanguageAndAddingWords took "
                    + (end - start) + " ms");
        } finally {
            for (int i = 0; i < numberOfLanguages; i++) {
                assertDictionaryExists(dicts[i], dictFiles[i]);
            }
        }
    }

    public void testAddManyWords() {
        final Locale dummyLocale =
                UserHistoryDictionaryTestsHelper.getDummyLocale("many_random_words");
        final String dictName = UserHistoryDictionary.getUserHistoryDictName(
                UserHistoryDictionary.NAME, dummyLocale, null /* dictFile */, getContext());
        final File dictFile = ExpandableBinaryDictionary.getDictFile(
                mContext, dictName, null /* dictFile */);
        final int numberOfWords = 10000;
        final Random random = new Random(123456);
        final UserHistoryDictionary dict = PersonalizationHelper.getUserHistoryDictionary(
                getContext(), dummyLocale, TEST_ACCOUNT);
        clearHistory(dict);
        assertTrue(UserHistoryDictionaryTestsHelper.addAndWriteRandomWords(dict,
                numberOfWords, random, true /* checksContents */, mCurrentTime));
        assertDictionaryExists(dict, dictFile);
    }

    public void testDecaying() {
        final Locale dummyLocale = UserHistoryDictionaryTestsHelper.getDummyLocale("decaying");
        final UserHistoryDictionary dict = PersonalizationHelper.getUserHistoryDictionary(
                getContext(), dummyLocale, TEST_ACCOUNT);
        resetCurrentTimeForTestMode();
        clearHistory(dict);
        dict.waitAllTasksForTests();

        final int numberOfWords = 5000;
        final Random random = new Random(123456);
        final List<String> words = UserHistoryDictionaryTestsHelper.generateWords(numberOfWords,
                random);
        NgramContext ngramContext = NgramContext.EMPTY_PREV_WORDS_INFO;
        for (final String word : words) {
            UserHistoryDictionary.addToDictionary(dict, ngramContext, word, true, mCurrentTime,
                    DistracterFilter.EMPTY_DISTRACTER_FILTER);
            ngramContext = ngramContext.getNextNgramContext(new WordInfo(word));
            dict.waitAllTasksForTests();
            assertTrue(dict.isInDictionary(word));
        }
        forcePassingShortTime();
        dict.runGCIfRequired();
        dict.waitAllTasksForTests();
        for (final String word : words) {
            assertTrue(dict.isInDictionary(word));
        }
        // Long term decay results in words removed from the dictionary.
        forcePassingLongTime();
        dict.runGCIfRequired();
        dict.waitAllTasksForTests();
        for (final String word : words) {
            assertFalse(dict.isInDictionary(word));
        }
    }

    public void testRandomWords_NullAccount() {
        updateAccountName(null);
        testRandomWords();
    }
}