core/tests/coretests/src/android/widget/espresso/MouseUiController.java

/*
 * 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 com.android.internal.util.Preconditions.checkNotNull;

import android.annotation.IntDef;
import android.os.SystemClock;
import android.view.InputDevice;
import android.view.KeyEvent;
import android.view.MotionEvent;

import androidx.test.espresso.InjectEventSecurityException;
import androidx.test.espresso.UiController;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Iterator;

/**
 * Class to wrap an UiController to overwrite source of motion events to SOURCE_MOUSE.
 * Note that this doesn't change the tool type.
 */
public final class MouseUiController implements UiController {
    @Retention(RetentionPolicy.SOURCE)
    @IntDef({MotionEvent.BUTTON_PRIMARY, MotionEvent.BUTTON_SECONDARY, MotionEvent.BUTTON_TERTIARY})
    public @interface MouseButton {}

    private final UiController mUiController;
    @MouseButton
    private final int mButton;

    public MouseUiController(UiController uiController) {
        this(uiController, MotionEvent.BUTTON_PRIMARY);
    }

    /**
     * Constructs MouseUiController.
     *
     * @param uiController the uiController to wrap
     * @param button the button to be used for generating input events.
     */
    public MouseUiController(UiController uiController, @MouseButton int button) {
        mUiController = checkNotNull(uiController);
        mButton = button;
    }

    @Override
    public boolean injectKeyEvent(KeyEvent event) throws InjectEventSecurityException {
        return mUiController.injectKeyEvent(event);
    }

    @Override
    public boolean injectMotionEvent(MotionEvent event) throws InjectEventSecurityException {
        // Modify the event to mimic mouse event.
        event.setSource(InputDevice.SOURCE_MOUSE);
        if (event.getActionMasked() != MotionEvent.ACTION_UP) {
            event.setButtonState(mButton);
        }
        return mUiController.injectMotionEvent(event);
    }

    /**
     * Copied from latest {@link androidx.test.espresso.UiController}, since current
     * {@link androidx.test.espresso.UiController#injectMotionEventSequence(Iterable)} seems not a
     * default method.
     */
    @Override
    public boolean injectMotionEventSequence(Iterable<MotionEvent> events)
            throws InjectEventSecurityException {
        android.util.Log.w(
                "UIC",
                "Using default injectMotionEventSeq() - this may not inject a sequence properly. "
                + "If wrapping UIController please override this method and delegate.");
        Iterator<MotionEvent> mei = events.iterator();
        boolean success = true;
        while (mei.hasNext()) {
            MotionEvent me = mei.next();
            if (me.getEventTime() - SystemClock.uptimeMillis() > 10) {
                // Because the loopMainThreadForAtLeast is overkill for waiting, intentially only
                // call it with a smaller amount of milliseconds as best effort
                loopMainThreadForAtLeast(10);
            }
            success &= injectMotionEvent(me);
        }
        return success;
    }

    @Override
    public boolean injectString(String str) throws InjectEventSecurityException {
        return mUiController.injectString(str);
    }

    @Override
    public void loopMainThreadForAtLeast(long millisDelay) {
        mUiController.loopMainThreadForAtLeast(millisDelay);
    }

    @Override
    public void loopMainThreadUntilIdle() {
        mUiController.loopMainThreadUntilIdle();
    }
}