/* * Copyright (C) 2009 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.globalsearch; import com.google.android.collect.Lists; import android.app.SearchManager; import android.app.SearchManager.DialogCursorProtocol; import android.content.ComponentName; import android.content.Intent; import android.database.Cursor; import android.os.Bundle; import android.test.MoreAsserts; import android.test.suitebuilder.annotation.SmallTest; import java.util.ArrayList; import java.util.Iterator; import java.util.LinkedHashMap; import java.util.LinkedList; import java.util.List; import java.util.concurrent.Executor; import java.util.concurrent.FutureTask; import junit.framework.TestCase; /** * Tests for {@link SuggestionSession}, its interaction with {@link SuggestionCursor}, and how and * when the session fires queries off to the suggestion sources. */ @SmallTest public class SuggestionSessionTest extends TestCase implements SuggestionFactory { private TestSuggestionSession mSession; private QueryEngine mEngine; private ComponentName mComponentA; private SuggestionSource mSourceA; private ComponentName mWebComponent; private SuggestionSource mWebSource; private SuggestionData mWebSuggestion; private SuggestionData mSearchTheWebSuggestion; private SuggestionData mSuggestionFromA; @Override protected void setUp() throws Exception { mWebComponent = new ComponentName("com.android.web", "com.android.web.GOOG"); mWebSuggestion = makeSimple(mWebComponent, "a web a"); mSearchTheWebSuggestion = createSearchTheWebSuggestion("a"); mWebSource = new TestSuggestionSource.Builder() .setComponent(mWebComponent) .setLabel("web") .addCannedResponse("a", mWebSuggestion) .addCannedResponse("b", mWebSuggestion) .create(); mComponentA = new ComponentName("com.android.test", "com.android.test.A"); mSuggestionFromA = makeSimple(mComponentA, "a 1"); mSourceA = new TestSuggestionSource.Builder() .setComponent(mComponentA) .setLabel("A") .addCannedResponse("a", mSuggestionFromA) .addCannedResponse("b", mSuggestionFromA) .create(); ArrayList promotableSources = Lists.newArrayList(mWebSource, mSourceA); ArrayList unpromotableSources = Lists.newArrayList(); mSession = initSession(promotableSources, unpromotableSources, mWebSource, 4); } private TestSuggestionSession initSession( ArrayList promotableSources, ArrayList unpromotableSources, SuggestionSource webSource, int numPromotedSources) { ArrayList allSources = new ArrayList(); allSources.addAll(promotableSources); allSources.addAll(unpromotableSources); final SimpleSourceLookup sourceLookup = new SimpleSourceLookup(allSources, webSource); Config config = Config.getDefaultConfig(); mEngine = new QueryEngine(); return new TestSuggestionSession( config, sourceLookup, promotableSources, unpromotableSources, this, mEngine, numPromotedSources); } SuggestionData makeSimple(ComponentName component, String title) { return new SuggestionData.Builder(component) .title(title) .intentAction("view") .intentData(title) .build(); } // --------------------- Interface SuggestionFactory --------------------- private static ComponentName BUILT_IN = new ComponentName("com.builtin", "class"); private static SuggestionData MORE = new SuggestionData.Builder(BUILT_IN) .title("more") .shortcutId(SearchManager.SUGGEST_NEVER_MAKE_SHORTCUT) .build(); public ComponentName getSource() { return BUILT_IN; } public SuggestionData createSearchTheWebSuggestion(String query) { return new SuggestionData.Builder(BUILT_IN) .title("search the web for " + query) .intentAction(Intent.ACTION_WEB_SEARCH) .build(); } public SuggestionData createWebSearchShortcut(String query) { return new SuggestionData.Builder(BUILT_IN) .title("web search shortcut for " + query) .intentAction(Intent.ACTION_WEB_SEARCH) .build(); } public SuggestionData createGoToWebsiteSuggestion(String query) { return null; } public SuggestionData getMoreEntry( boolean expanded, List sourceStats) { return MORE; } public SuggestionData getCorpusEntry( String query, SourceSuggestionBacker.SourceStat sourceStat) { final ComponentName name = sourceStat.getName(); return makeCorpusEntry(name); } private SuggestionData makeCorpusEntry(ComponentName name) { return new SuggestionData.Builder(BUILT_IN) .intentAction(SearchManager.INTENT_ACTION_CHANGE_SEARCH_SOURCE) .intentData(name.flattenToShortString()) .title("corpus " + name).build(); } // --------------------- Tests --------------------- public void testBasicQuery() { final Cursor cursor = mSession.query("a"); { final Snapshot snapshot = getSnapshot(cursor); assertTrue("isPending.", snapshot.isPending); assertEquals("displayNotify", NONE, snapshot.displayNotify); MoreAsserts.assertEmpty("suggestions", snapshot.suggestionTitles); MoreAsserts.assertContentsInOrder("sources in progress", mEngine.getPendingSources(), mWebComponent, mComponentA); } mEngine.onSourceRespond(mWebComponent); cursor.requery(); { final Snapshot snapshot = getSnapshot(cursor); assertTrue(snapshot.isPending); assertEquals(NONE, snapshot.displayNotify); MoreAsserts.assertContentsInOrder("suggestions", snapshot.suggestionTitles, mWebSuggestion.getTitle()); MoreAsserts.assertContentsInOrder("sources in progress", mEngine.getPendingSources(), mComponentA); } mEngine.onSourceRespond(mComponentA); cursor.requery(); { final Snapshot snapshot = getSnapshot(cursor); assertFalse(snapshot.isPending); // assertEquals(NONE, snapshot.displayNotify); // <--- failing MoreAsserts.assertContentsInOrder("suggestions", snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSuggestionFromA.getTitle(), mSearchTheWebSuggestion.getTitle()); MoreAsserts.assertEmpty("sources in progress", mEngine.getPendingSources()); } } public void testCaching() { // results for query final Cursor cursor1 = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); mEngine.onSourceRespond(mComponentA); // same query again final Cursor cursor2 = mSession.query("a"); cursor2.requery(); final Snapshot snapshot = getSnapshot(cursor2); assertFalse("should not be pending when results are cached.", snapshot.isPending); // assertEquals(NONE, snapshot.displayNotify); MoreAsserts.assertContentsInOrder("suggestions", snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSuggestionFromA.getTitle(), mSearchTheWebSuggestion.getTitle()); MoreAsserts.assertEmpty("should be no sources in progress when results are cached.", mEngine.getPendingSources()); } public void testErrorResultNotCached() { final TestSuggestionSource aWithError = new TestSuggestionSource.Builder() .addErrorResponse("a") .setLabel("A") .setComponent(mComponentA) .create(); mSession = initSession(Lists.newArrayList(mWebSource, aWithError), Lists.newArrayList(), mWebSource, 4); { final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); mEngine.onSourceRespond(mComponentA); cursor.requery(); final Snapshot snapshot = getSnapshot(cursor); MoreAsserts.assertContentsInOrder( snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSearchTheWebSuggestion.getTitle()); } { final Cursor cursor = mSession.query("a"); cursor.requery(); final Snapshot snapshot = getSnapshot(cursor); MoreAsserts.assertContentsInOrder( snapshot.suggestionTitles, mWebSuggestion.getTitle()); MoreAsserts.assertContentsInOrder("expecting source a to be pending (not cached) " + "since it returned an error the first time.", mEngine.getPendingSources(), mComponentA); } } public void testSessionClosing_single() { final Cursor cursor = mSession.query("a"); cursor.close(); assertTrue("Session should have closed.", mEngine.isClosed()); } public void testSessionClosing_multiple() { // first query fired off final Cursor cursor1 = mSession.query("a"); assertFalse("session shouldn't be closed right after opening.", mEngine.isClosed()); // second query starts final Cursor cursor2 = mSession.query("b"); // first cursor closes (which is how it works from search dialog) cursor1.close(); assertFalse("session shouldn't be closed after first cursor close.", mEngine.isClosed()); cursor2.close(); assertTrue("session should be closed after both cursors closed.", mEngine.isClosed()); } public void testSessionStats_noClick() { final Cursor cursor = mSession.query("a"); cursor.close(); final List stats = mEngine.getSessionStats(); MoreAsserts.assertEmpty("session stats reported without click.", stats); } public void testSessionStats_click_oneSourceViewed() { final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); mEngine.onSourceRespond(mComponentA); cursor.requery(); final Snapshot snapshot = getSnapshot(cursor); MoreAsserts.assertContentsInOrder("suggestions.", snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSuggestionFromA.getTitle(), mSearchTheWebSuggestion.getTitle()); sendClick(cursor, 0, 0); cursor.close(); final List stats = mEngine.getSessionStats(); assertEquals("session stats.", 1, stats.size()); assertEquals("clicked.", mWebSuggestion, stats.get(0).getClicked()); MoreAsserts.assertContentsInAnyOrder("suggestions.", stats.get(0).getSourceImpressions(), mWebSuggestion.getSource()); } public void testSessionStats_allSourcesViewed() { final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); mEngine.onSourceRespond(mComponentA); cursor.requery(); sendClick(cursor, 1, 1); final List stats = mEngine.getSessionStats(); assertEquals("session stats.", 1, stats.size()); assertEquals("clicked.", mSuggestionFromA, stats.get(0).getClicked()); MoreAsserts.assertContentsInAnyOrder("sources viewed.", stats.get(0).getSourceImpressions(), mWebComponent, mComponentA); } public void testSessionStats_impressionsWithMoreNotExpanded() { final int numPromotedSources = 1; mSession = initSession( Lists.newArrayList(mWebSource, mSourceA), Lists.newArrayList(), mWebSource, numPromotedSources); final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); cursor.requery(); final Snapshot snapshot = getSnapshot(cursor); MoreAsserts.assertContentsInOrder("suggestions.", snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSearchTheWebSuggestion.getTitle(), MORE.getTitle()); assertEquals("should want notification of display of index of 'more'", 2, snapshot.displayNotify); sendClick(cursor, 0, 2); final List stats = mEngine.getSessionStats(); assertEquals("session stats.", 1, stats.size()); assertEquals("clicked.", mWebSuggestion, stats.get(0).getClicked()); MoreAsserts.assertContentsInAnyOrder( "sources viewed (should not include component of 'more results' suggestion.", stats.get(0).getSourceImpressions(), mWebComponent); } /** * When the user views a corpus entry under "more results" that hasn't even had a chance to * start running yet, it isn't fair to count an impression with no click against it. */ public void testSessionStats_impressionsWithMoreExpanded_beforeSourceResponds() { final int numPromotedSources = 1; mSession = initSession( Lists.newArrayList(mWebSource, mSourceA), Lists.newArrayList(), mWebSource, numPromotedSources); final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); cursor.requery(); { final Snapshot snapshot = getSnapshot(cursor); MoreAsserts.assertContentsInOrder("suggestions.", snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSearchTheWebSuggestion.getTitle(), MORE.getTitle()); } // click on "more" final int selectedPosition = sendClick(cursor, 2, 3); assertEquals("selected position should be index of 'more' after we click on 'more'", 2, selectedPosition); cursor.requery(); { final Snapshot snapshot = getSnapshot(cursor); MoreAsserts.assertContentsInOrder("suggestions.", snapshot.suggestionTitles, mWebSuggestion.getTitle(), mSearchTheWebSuggestion.getTitle(), MORE.getTitle(), makeCorpusEntry(mComponentA).getTitle()); assertFalse("isPending should be false once 'more results' are mixed in.", snapshot.isPending); } final List stats = mEngine.getSessionStats(); assertEquals("session stats.", 1, stats.size()); assertNull("Clicks on More should not be recorded", stats.get(0).getClicked()); MoreAsserts.assertContentsInAnyOrder( "sources viewed (should not include source that was viewed, but hasn't " + "started retrieving results yet.)", stats.get(0).getSourceImpressions(), mWebComponent); } public void testSessionStats_impressionsWithMoreExpanded_afterSourceResponds() { final int numPromotedSources = 1; mSession = initSession( Lists.newArrayList(mWebSource, mSourceA), Lists.newArrayList(), mWebSource, numPromotedSources); final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); cursor.requery(); assertEquals(3, cursor.getCount()); // click on "more" int selectedPosition = sendClick(cursor, 2, 2); assertEquals("selected position should be index of 'more' after we click on 'more'", 2, selectedPosition); cursor.requery(); assertEquals(4, cursor.getCount()); List stats = mEngine.getSessionStats(); assertEquals("session stats.", 1, stats.size()); assertNull("Clicks on More should not be recorded", stats.get(0).getClicked()); MoreAsserts.assertContentsInAnyOrder( "sources viewed.", stats.get(0).getSourceImpressions(), mWebComponent); // viewing that index should kick start the second component final Bundle b = new Bundle(); b.putInt(DialogCursorProtocol.METHOD, DialogCursorProtocol.THRESH_HIT); cursor.respond(b); // source responds mEngine.onSourceRespond(mComponentA); cursor.requery(); // click on More to collapse it sendClick(cursor, 2, 3); cursor.requery(); assertEquals(3, cursor.getCount()); stats = mEngine.getSessionStats(); assertEquals("session stats.", 2, stats.size()); assertNull("Clicks on More should not be recorded", stats.get(1).getClicked()); MoreAsserts.assertContentsInAnyOrder( "sources viewed.", stats.get(1).getSourceImpressions(), mWebComponent, mComponentA); } public void testSessionStats_search() { final Cursor cursor = mSession.query("a"); mEngine.onSourceRespond(mWebComponent); mEngine.onSourceRespond(mComponentA); cursor.requery(); sendSearch(cursor, "a", 1); final List stats = mEngine.getSessionStats(); assertEquals("session stats.", 1, stats.size()); SuggestionData searchSuggestion = createWebSearchShortcut("a"); assertEquals("clicked.", searchSuggestion, stats.get(0).getClicked()); MoreAsserts.assertContentsInAnyOrder("sources viewed.", stats.get(0).getSourceImpressions(), mWebComponent, mComponentA); } // --------------------- Utility methods --------------------- private int sendClick(Cursor cursor, int position, int maxDisplayedPosition) { final Bundle b = new Bundle(); b.putInt(DialogCursorProtocol.METHOD, DialogCursorProtocol.CLICK); b.putInt(DialogCursorProtocol.CLICK_SEND_POSITION, position); b.putInt(DialogCursorProtocol.CLICK_SEND_MAX_DISPLAY_POS, maxDisplayedPosition); final Bundle response = cursor.respond(b); return response.getInt(DialogCursorProtocol.CLICK_RECEIVE_SELECTED_POS, -1); } private void sendSearch(Cursor cursor, String query, int maxDisplayedPosition) { final Bundle b = new Bundle(); b.putInt(DialogCursorProtocol.METHOD, DialogCursorProtocol.SEARCH); b.putString(DialogCursorProtocol.SEARCH_SEND_QUERY, query); b.putInt(DialogCursorProtocol.SEARCH_SEND_MAX_DISPLAY_POS, maxDisplayedPosition); cursor.respond(b); } /** * @param cursor A cursor * @return A snapshot of information contained in that cursor. */ private Snapshot getSnapshot(Cursor cursor) { final ArrayList titles = new ArrayList(cursor.getCount()); if (!cursor.isBeforeFirst()) { cursor.moveToPosition(-1); } while (cursor.moveToNext()) { titles.add(cursor.getString( cursor.getColumnIndex(SearchManager.SUGGEST_COLUMN_TEXT_1))); } final Bundle bundleIn = new Bundle(); bundleIn.putInt(DialogCursorProtocol.METHOD, DialogCursorProtocol.POST_REFRESH); final Bundle bundleOut = cursor.respond(bundleIn); return new Snapshot( titles, bundleOut.getBoolean(DialogCursorProtocol.POST_REFRESH_RECEIVE_ISPENDING), bundleOut.getInt( DialogCursorProtocol.POST_REFRESH_RECEIVE_DISPLAY_NOTIFY, NONE)); } static class Snapshot { final ArrayList suggestionTitles; final boolean isPending; final int displayNotify; Snapshot(ArrayList suggestionTitles, boolean pending, int displayNotify) { this.suggestionTitles = suggestionTitles; isPending = pending; this.displayNotify = displayNotify; } } static final int NONE = -1; /** * Utility class to instrument the plumbing of {@link SuggestionSession} so we can * control how results are reported and processed, and keep track of when the session is * closed. */ static class QueryEngine extends PerTagExecutor implements Executor, DelayedExecutor, SuggestionSession.SessionCallback, ShortcutRepository { private long mNow = 0L; private final LinkedHashMap> mPending = new LinkedHashMap>(); private LinkedList mDelayed = new LinkedList(); private boolean mClosed = false; public QueryEngine() { super(null, 66); } /** * book keeping for delayed runnables for emulating delayed execution. */ private static class Delayed { final long start; final long delay; final Runnable runnable; Delayed(long start, long delay, Runnable runnable) { this.start = start; this.delay = delay; this.runnable = runnable; } } private List mSessionStats = new ArrayList(); /** * @return A list of sources that have been queried and haven't been triggered to respond * via {@link #onSourceRespond(android.content.ComponentName)} */ public List getPendingSources() { return new ArrayList(mPending.keySet()); } /** * Simulate a source responding. * * @param source The source to have respond. * @return The result of the response for further inspection. */ public SuggestionResult onSourceRespond(ComponentName source) { final FutureTask task = mPending.remove(source); if (task == null) { throw new IllegalArgumentException(source + " never started"); } task.run(); try { return task.get(); } catch (Exception e) { throw new RuntimeException(e); } } /** * Runs all pending source tasks. This can be useful when starting a new * query, to get to a consistent state before more assertions. */ public void finishAllSourceTasks() { for (FutureTask task : mPending.values()) { task.run(); } mPending.clear(); } /** * Moves time forward the specified number of milliseconds, executing any tasks * that were posted to {@link #postDelayed(Runnable, long)} as appropriate. * * @param millis */ public void moveTimeForward(long millis) { mNow += millis; List toRun = new ArrayList(); final Iterator it = mDelayed.iterator(); while (it.hasNext()) { Delayed delayed = it.next(); if (mNow >= delayed.start + delayed.delay) { it.remove(); toRun.add(delayed.runnable); } } // do this in a separate pass to avoid concurrent modification of list, // since these runnables might add more to the queue for (Runnable runnable : toRun) { runnable.run(); } } // ShortcutRepository public boolean hasHistory() {return true;} public void clearHistory() {} public void deleteRepository() {} public void close() {} public void reportStats(SessionStats stats) { mSessionStats.add(stats); } public ArrayList getShortcutsForQuery(String query) { return new ArrayList(); } public ArrayList getSourceRanking() { throw new IllegalArgumentException(); } public void refreshShortcut( ComponentName source, String shortcutId, SuggestionData refreshed) {} /** * @return The stats that have been reported */ public List getSessionStats() { return mSessionStats; } // Executor @Override public boolean execute(String tag, Runnable command) { execute(command); return false; } public void execute(Runnable command) { if (command instanceof QueryMultiplexer.SuggestionRequest) { final QueryMultiplexer.SuggestionRequest suggestionRequest = (QueryMultiplexer.SuggestionRequest) command; mPending.put( suggestionRequest.getSuggestionSource().getComponentName(), suggestionRequest); } else { command.run(); } } // DelayedExecutor public void postDelayed(Runnable runnable, long delayMillis) { mDelayed.add(new Delayed(mNow, delayMillis, runnable)); } public void postAtTime(Runnable runnable, long uptimeMillis) {runnable.run();} // Session callback public void closeSession() { mClosed = true; } public boolean isClosed() { return mClosed; } } static class TestSuggestionSession extends SuggestionSession { private final QueryEngine mEngine; public TestSuggestionSession(Config config, SourceLookup sourceLookup, ArrayList promotableSources, ArrayList unpromotableSources, SuggestionSessionTest test, QueryEngine engine, int numPromotedSources) { super(config, sourceLookup, promotableSources, unpromotableSources, engine, engine, engine, test, true); setListener(engine); setShortcutRepo(engine); setNumPromotedSources(numPromotedSources); mEngine = engine; } @Override long getNow() { return mEngine.mNow; } } }