From 90cdfe0514154bbc008d39f1c99f7a1d2684446c Mon Sep 17 00:00:00 2001
From: Abodunrinwa Toki <toki@google.com>
Date: Tue, 15 Sep 2015 21:15:56 +0100
Subject: [PATCH] TextViewActions for Espresso-testing TextView.

The plan is to add common TextView actions here so they can be used
in tests.
The locateTextAtIndex method is probably not the most efficient way
to locate a particular spot in the TextView but it works well enough
and doesn't use any private/hidden APIs. This might make it easy to
port this test as CTS.
Ideas on alternative implementations for this method are welcome.

Bug: 24102650
Change-Id: Ifb07cc86c58bd5833c37919fa9294a2374dba2a0
---
 .../android/widget/TextViewActivityTest.java  |  16 +++
 .../widget/espresso/TextViewActions.java      | 105 ++++++++++++++++++
 2 files changed, 121 insertions(+)
 create mode 100644 core/tests/coretests/src/android/widget/espresso/TextViewActions.java

diff --git a/core/tests/coretests/src/android/widget/TextViewActivityTest.java b/core/tests/coretests/src/android/widget/TextViewActivityTest.java
index 54117df35a01c..b37688f0e2128 100644
--- a/core/tests/coretests/src/android/widget/TextViewActivityTest.java
+++ b/core/tests/coretests/src/android/widget/TextViewActivityTest.java
@@ -16,8 +16,10 @@
 
 package android.widget;
 
+import static android.widget.espresso.TextViewActions.clickOnTextAtIndex;
 import static android.support.test.espresso.Espresso.onView;
 import static android.support.test.espresso.action.ViewActions.click;
+import static android.support.test.espresso.action.ViewActions.pressKey;
 import static android.support.test.espresso.action.ViewActions.typeTextIntoFocusedView;
 import static android.support.test.espresso.assertion.ViewAssertions.matches;
 import static android.support.test.espresso.matcher.ViewMatchers.withId;
@@ -27,6 +29,7 @@ import com.android.frameworks.coretests.R;
 
 import android.test.ActivityInstrumentationTestCase2;
 import android.test.suitebuilder.annotation.SmallTest;
+import android.view.KeyEvent;
 
 /**
  * Tests the TextView widget from an Activity
@@ -47,4 +50,17 @@ public class TextViewActivityTest extends ActivityInstrumentationTestCase2<TextV
 
         onView(withId(R.id.textview)).check(matches(withText(helloWorld)));
     }
+
+    @SmallTest
+    public void testPositionCursorAtTextAtIndex() throws Exception {
+        getActivity();
+
+        final String helloWorld = "Hello world!";
+        onView(withId(R.id.textview)).perform(typeTextIntoFocusedView(helloWorld));
+        onView(withId(R.id.textview)).perform(clickOnTextAtIndex(helloWorld.indexOf("world")));
+
+        // Delete text at specified index and see if we got the right one.
+        onView(withId(R.id.textview)).perform(pressKey(KeyEvent.KEYCODE_FORWARD_DEL));
+        onView(withId(R.id.textview)).check(matches(withText("Hello orld!")));
+    }
 }
diff --git a/core/tests/coretests/src/android/widget/espresso/TextViewActions.java b/core/tests/coretests/src/android/widget/espresso/TextViewActions.java
new file mode 100644
index 0000000000000..425dccdf4936d
--- /dev/null
+++ b/core/tests/coretests/src/android/widget/espresso/TextViewActions.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2015 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.widget.espresso;
+
+import static android.support.test.espresso.action.ViewActions.actionWithAssertions;
+
+import android.content.res.Resources;
+import android.support.test.espresso.PerformException;
+import android.support.test.espresso.ViewAction;
+import android.support.test.espresso.action.CoordinatesProvider;
+import android.support.test.espresso.action.GeneralClickAction;
+import android.support.test.espresso.action.Press;
+import android.support.test.espresso.action.Tap;
+import android.support.test.espresso.util.HumanReadables;
+import android.text.Layout;
+import android.util.DisplayMetrics;
+import android.util.TypedValue;
+import android.view.View;
+import android.widget.TextView;
+
+/**
+ * A collection of actions on a {@link android.widget.TextView}.
+ */
+public final class TextViewActions {
+
+    private TextViewActions() {}
+
+    /**
+     * Returns an action that clicks on text at an index on the text view.<br>
+     * <br>
+     * View constraints:
+     * <ul>
+     * <li>must be a text view displayed on screen
+     * <ul>
+     */
+    public static ViewAction clickOnTextAtIndex(int index) {
+        return actionWithAssertions(
+                new GeneralClickAction(Tap.SINGLE, new TextCoordinates(index), Press.FINGER));
+    }
+
+    /**
+     * A provider of the x, y coordinates of the text at the specified index in a text view.
+     */
+    private static final class TextCoordinates implements CoordinatesProvider {
+
+        private final int mIndex;
+        private final String mActionDescription;
+
+        public TextCoordinates(int index) {
+            mIndex = index;
+            mActionDescription = "Could not locate text at index: " + mIndex;
+        }
+
+        @Override
+        public float[] calculateCoordinates(View view) {
+            try {
+                return locateTextAtIndex((TextView) view, mIndex);
+            } catch (ClassCastException e) {
+                throw new PerformException.Builder()
+                        .withActionDescription(mActionDescription)
+                        .withViewDescription(HumanReadables.describe(view))
+                        .withCause(e)
+                        .build();
+            } catch (StringIndexOutOfBoundsException e) {
+                throw new PerformException.Builder()
+                        .withActionDescription(mActionDescription)
+                        .withViewDescription(HumanReadables.describe(view))
+                        .withCause(e)
+                        .build();
+            }
+        }
+
+        /**
+         * @throws StringIndexOutOfBoundsException
+         */
+        private float[] locateTextAtIndex(TextView textView, int index) {
+            if (index < 0 || index > textView.getText().length()) {
+                throw new StringIndexOutOfBoundsException(index);
+            }
+            final int[] xy = new int[2];
+            textView.getLocationOnScreen(xy);
+            final Layout layout = textView.getLayout();
+            final int line = layout.getLineForOffset(index);
+            final float x = textView.getTotalPaddingLeft() - textView.getScrollX()
+                    + layout.getPrimaryHorizontal(index);
+            final float y = textView.getTotalPaddingTop() - textView.getScrollY()
+                    + layout.getLineTop(line);
+            return new float[]{x + xy[0], y + xy[1]};
+        }
+    }
+}