blob: 6dc68400553daa0d8585f73a9a7e55f01d22e4e4 [file] [log] [blame]
/*
* Copyright (C) 2017 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 android.view.inputmethod.cts;
import static android.view.WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE;
import static android.view.inputmethod.cts.util.TestUtils.runOnMainSync;
import static android.widget.PopupWindow.INPUT_METHOD_NOT_NEEDED;
import static com.android.cts.mockime.ImeEventStreamTestUtils.editorMatcher;
import static com.android.cts.mockime.ImeEventStreamTestUtils.expectBindInput;
import static com.android.cts.mockime.ImeEventStreamTestUtils.expectCommand;
import static com.android.cts.mockime.ImeEventStreamTestUtils.expectEvent;
import static com.android.cts.mockime.ImeEventStreamTestUtils.notExpectEvent;
import static org.junit.Assert.assertFalse;
import android.app.Instrumentation;
import android.content.Context;
import android.os.Build;
import android.os.IBinder;
import android.os.Process;
import android.os.SystemClock;
import android.text.TextUtils;
import android.view.View;
import android.view.inputmethod.EditorInfo;
import android.view.inputmethod.InputMethodManager;
import android.view.inputmethod.cts.util.EndToEndImeTestBase;
import android.view.inputmethod.cts.util.TestActivity;
import android.view.inputmethod.cts.util.TestUtils;
import android.view.inputmethod.cts.util.WindowFocusStealer;
import android.widget.EditText;
import android.widget.LinearLayout;
import android.widget.PopupWindow;
import android.widget.TextView;
import androidx.test.InstrumentationRegistry;
import androidx.test.filters.MediumTest;
import androidx.test.runner.AndroidJUnit4;
import com.android.compatibility.common.util.CtsTouchUtils;
import com.android.cts.mockime.ImeCommand;
import com.android.cts.mockime.ImeEvent;
import com.android.cts.mockime.ImeEventStream;
import com.android.cts.mockime.ImeSettings;
import com.android.cts.mockime.MockImeSession;
import org.junit.Test;
import org.junit.runner.RunWith;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
@MediumTest
@RunWith(AndroidJUnit4.class)
public class FocusHandlingTest extends EndToEndImeTestBase {
static final long TIMEOUT = TimeUnit.SECONDS.toMillis(5);
static final long NOT_EXPECT_TIMEOUT = TimeUnit.SECONDS.toMillis(1);
private static final String TEST_MARKER_PREFIX =
"android.view.inputmethod.cts.FocusHandlingTest";
public EditText launchTestActivity(String marker) {
final AtomicReference<EditText> editTextRef = new AtomicReference<>();
TestActivity.startSync(activity-> {
final LinearLayout layout = new LinearLayout(activity);
layout.setOrientation(LinearLayout.VERTICAL);
final EditText editText = new EditText(activity);
editText.setPrivateImeOptions(marker);
editText.setHint("editText");
editText.requestFocus();
editTextRef.set(editText);
layout.addView(editText);
return layout;
});
return editTextRef.get();
}
private static String getTestMarker() {
return TEST_MARKER_PREFIX + "/" + SystemClock.elapsedRealtimeNanos();
}
@Test
public void testOnStartInputCalledOnceIme() throws Exception {
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
InstrumentationRegistry.getInstrumentation().getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
final String marker = getTestMarker();
final EditText editText = launchTestActivity(marker);
// Wait until the MockIme gets bound to the TestActivity.
expectBindInput(stream, Process.myPid(), TIMEOUT);
// Emulate tap event
CtsTouchUtils.emulateTapOnViewCenter(
InstrumentationRegistry.getInstrumentation(), editText);
// Wait until "onStartInput" gets called for the EditText.
final ImeEvent onStart =
expectEvent(stream, editorMatcher("onStartInput", marker), TIMEOUT);
assertFalse(stream.dump(), onStart.getEnterState().hasDummyInputConnection());
assertFalse(stream.dump(), onStart.getArguments().getBoolean("restarting"));
// There shouldn't be onStartInput any more.
notExpectEvent(stream, editorMatcher("onStartInput", marker), NOT_EXPECT_TIMEOUT);
}
}
@Test
public void testSoftInputStateAlwaysVisibleWithoutFocusedEditorView() throws Exception {
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
InstrumentationRegistry.getInstrumentation().getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
final String marker = getTestMarker();
final TestActivity testActivity = TestActivity.startSync(activity -> {
final LinearLayout layout = new LinearLayout(activity);
layout.setOrientation(LinearLayout.VERTICAL);
final TextView textView = new TextView(activity) {
@Override
public boolean onCheckIsTextEditor() {
return false;
}
};
textView.setText("textView");
textView.setPrivateImeOptions(marker);
textView.requestFocus();
activity.getWindow().setSoftInputMode(SOFT_INPUT_STATE_ALWAYS_VISIBLE);
layout.addView(textView);
return layout;
});
if (testActivity.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.P) {
// Input shouldn't start
notExpectEvent(stream, editorMatcher("onStartInput", marker), TIMEOUT);
// There shouldn't be onStartInput because the focused view is not an editor.
notExpectEvent(stream, event -> "showSoftInput".equals(event.getEventName()), TIMEOUT);
} else {
// Wait until the MockIme gets bound to the TestActivity.
expectBindInput(stream, Process.myPid(), TIMEOUT);
// For apps that target pre-P devices, onStartInput() should be called.
expectEvent(stream, event -> "showSoftInput".equals(event.getEventName()), TIMEOUT);
}
}
}
@Test
public void testEditorStartsInput() throws Exception {
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
InstrumentationRegistry.getInstrumentation().getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
final String marker = getTestMarker();
TestActivity.startSync(activity -> {
final LinearLayout layout = new LinearLayout(activity);
layout.setOrientation(LinearLayout.VERTICAL);
final EditText editText = new EditText(activity);
editText.setPrivateImeOptions(marker);
editText.setText("Editable");
editText.requestFocus();
layout.addView(editText);
return layout;
});
// Input should start
expectEvent(stream, editorMatcher("onStartInput", marker), TIMEOUT);
}
}
@Test
public void testSoftInputStateAlwaysVisibleFocusedEditorView() throws Exception {
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
InstrumentationRegistry.getInstrumentation().getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
TestActivity.startSync(activity -> {
final LinearLayout layout = new LinearLayout(activity);
layout.setOrientation(LinearLayout.VERTICAL);
final EditText editText = new EditText(activity);
editText.setText("editText");
editText.requestFocus();
activity.getWindow().setSoftInputMode(SOFT_INPUT_STATE_ALWAYS_VISIBLE);
layout.addView(editText);
return layout;
});
// Wait until the MockIme gets bound to the TestActivity.
expectBindInput(stream, Process.myPid(), TIMEOUT);
expectEvent(stream, event -> "showSoftInput".equals(event.getEventName()), TIMEOUT);
}
}
/**
* Makes sure that an existing {@link android.view.inputmethod.InputConnection} will not be
* invalidated by showing a focusable {@link PopupWindow} with
* {@link PopupWindow#INPUT_METHOD_NOT_NEEDED}.
*
* <p>If {@link android.view.WindowManager.LayoutParams#FLAG_ALT_FOCUSABLE_IM} is set and
* {@link android.view.WindowManager.LayoutParams#FLAG_NOT_FOCUSABLE} is not set to a
* {@link android.view.Window}, showing that window must not invalidate an existing valid
* {@link android.view.inputmethod.InputConnection}.</p>
*
* @see android.view.WindowManager.LayoutParams#mayUseInputMethod(int)
*/
@Test
public void testFocusableWindowDoesNotInvalidateExistingInputConnection() throws Exception {
final Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation();
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
instrumentation.getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
final String marker = getTestMarker();
final EditText editText = launchTestActivity(marker);
instrumentation.runOnMainSync(() -> editText.requestFocus());
// Wait until the MockIme gets bound to the TestActivity.
expectBindInput(stream, Process.myPid(), TIMEOUT);
expectEvent(stream, editorMatcher("onStartInput", marker), TIMEOUT);
// Make sure that InputConnection#commitText() works.
final ImeCommand commit1 = imeSession.callCommitText("test commit", 1);
expectCommand(stream, commit1, TIMEOUT);
TestUtils.waitOnMainUntil(
() -> TextUtils.equals(editText.getText(), "test commit"), TIMEOUT);
instrumentation.runOnMainSync(() -> editText.setText(""));
// Create a popup window that cannot be the IME target.
final PopupWindow popupWindow = TestUtils.getOnMainSync(() -> {
final Context context = instrumentation.getTargetContext();
final PopupWindow popup = new PopupWindow(context);
popup.setFocusable(true);
popup.setInputMethodMode(INPUT_METHOD_NOT_NEEDED);
final TextView textView = new TextView(context);
textView.setText("Test Text");
popup.setContentView(textView);
return popup;
});
// Show the popup window.
instrumentation.runOnMainSync(() -> popupWindow.showAsDropDown(editText));
instrumentation.waitForIdleSync();
// Make sure that the EditText no longer has window-focus
TestUtils.waitOnMainUntil(() -> !editText.hasWindowFocus(), TIMEOUT);
// Make sure that InputConnection#commitText() works.
final ImeCommand commit2 = imeSession.callCommitText("Hello!", 1);
expectCommand(stream, commit2, TIMEOUT);
TestUtils.waitOnMainUntil(
() -> TextUtils.equals(editText.getText(), "Hello!"), TIMEOUT);
instrumentation.runOnMainSync(() -> editText.setText(""));
stream.skipAll();
final String marker2 = getTestMarker();
// Call InputMethodManager#restartInput()
instrumentation.runOnMainSync(() -> {
editText.setPrivateImeOptions(marker2);
editText.getContext()
.getSystemService(InputMethodManager.class)
.restartInput(editText);
});
// Make sure that onStartInput() is called with restarting == true.
expectEvent(stream, event -> {
if (!TextUtils.equals("onStartInput", event.getEventName())) {
return false;
}
if (!event.getArguments().getBoolean("restarting")) {
return false;
}
final EditorInfo editorInfo = event.getArguments().getParcelable("editorInfo");
return TextUtils.equals(marker2, editorInfo.privateImeOptions);
}, TIMEOUT);
// Make sure that InputConnection#commitText() works.
final ImeCommand commit3 = imeSession.callCommitText("World!", 1);
expectCommand(stream, commit3, TIMEOUT);
TestUtils.waitOnMainUntil(
() -> TextUtils.equals(editText.getText(), "World!"), TIMEOUT);
instrumentation.runOnMainSync(() -> editText.setText(""));
// Dismiss the popup window.
instrumentation.runOnMainSync(() -> popupWindow.dismiss());
instrumentation.waitForIdleSync();
// Make sure that the EditText now has window-focus again.
TestUtils.waitOnMainUntil(() -> editText.hasWindowFocus(), TIMEOUT);
// Make sure that InputConnection#commitText() works.
final ImeCommand commit4 = imeSession.callCommitText("Done!", 1);
expectCommand(stream, commit4, TIMEOUT);
TestUtils.waitOnMainUntil(
() -> TextUtils.equals(editText.getText(), "Done!"), TIMEOUT);
instrumentation.runOnMainSync(() -> editText.setText(""));
}
}
/**
* Test case for Bug 70629102.
*
* {@link InputMethodManager#restartInput(View)} can be called even when another process
* temporarily owns focused window. {@link InputMethodManager} should continue to work after
* the IME target application gains window focus again.
*/
@Test
public void testRestartInputWhileOtherProcessHasWindowFocus() throws Exception {
final Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation();
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
instrumentation.getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
final String marker = getTestMarker();
final EditText editText = launchTestActivity(marker);
instrumentation.runOnMainSync(() -> editText.requestFocus());
// Wait until the MockIme gets bound to the TestActivity.
expectBindInput(stream, Process.myPid(), TIMEOUT);
expectEvent(stream, editorMatcher("onStartInput", marker), TIMEOUT);
// Get app window token
final IBinder appWindowToken = TestUtils.getOnMainSync(
() -> editText.getApplicationWindowToken());
try (WindowFocusStealer focusStealer =
WindowFocusStealer.connect(instrumentation.getTargetContext(), TIMEOUT)) {
focusStealer.stealWindowFocus(appWindowToken, TIMEOUT);
// Wait until the edit text loses window focus.
TestUtils.waitOnMainUntil(() -> !editText.hasWindowFocus(), TIMEOUT);
// Call InputMethodManager#restartInput()
instrumentation.runOnMainSync(() -> {
editText.getContext()
.getSystemService(InputMethodManager.class)
.restartInput(editText);
});
}
// Wait until the edit text gains window focus again.
TestUtils.waitOnMainUntil(() -> editText.hasWindowFocus(), TIMEOUT);
// Make sure that InputConnection#commitText() still works.
final ImeCommand command = imeSession.callCommitText("test commit", 1);
expectCommand(stream, command, TIMEOUT);
TestUtils.waitOnMainUntil(
() -> TextUtils.equals(editText.getText(), "test commit"), TIMEOUT);
}
}
/**
* Test {@link EditText#setShowSoftInputOnFocus(boolean)}.
*/
@Test
public void testSetShowInputOnFocus() throws Exception {
try (MockImeSession imeSession = MockImeSession.create(
InstrumentationRegistry.getContext(),
InstrumentationRegistry.getInstrumentation().getUiAutomation(),
new ImeSettings.Builder())) {
final ImeEventStream stream = imeSession.openEventStream();
final String marker = getTestMarker();
final EditText editText = launchTestActivity(marker);
runOnMainSync(() -> editText.setShowSoftInputOnFocus(false));
// Wait until "onStartInput" gets called for the EditText.
expectEvent(stream, editorMatcher("onStartInput", marker), TIMEOUT);
// Emulate tap event
CtsTouchUtils.emulateTapOnViewCenter(
InstrumentationRegistry.getInstrumentation(), editText);
// "showSoftInput" must not happen when setShowSoftInputOnFocus(false) is called.
notExpectEvent(stream, event -> "showSoftInput".equals(event.getEventName()),
NOT_EXPECT_TIMEOUT);
}
}
}