system_image_uitests/app/src/androidTest/java/com/android/devtools/systemimage/uitest/smoke/VpnTest.java

/*
 * Copyright (c) 2016 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.devtools.systemimage.uitest.smoke;

import com.android.devtools.systemimage.uitest.annotations.TestInfo;
import com.android.devtools.systemimage.uitest.common.Res;
import com.android.devtools.systemimage.uitest.framework.SystemImageTestFramework;
import com.android.devtools.systemimage.uitest.utils.AppLauncher;
import com.android.devtools.systemimage.uitest.utils.Wait;
import com.android.devtools.systemimage.uitest.watchers.VpnPopupWatcher;

import org.junit.Assert;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.Timeout;
import org.junit.runner.RunWith;

import android.app.Instrumentation;
import android.support.test.runner.AndroidJUnit4;
import android.support.test.uiautomator.By;
import android.support.test.uiautomator.UiDevice;
import android.support.test.uiautomator.UiSelector;

import java.util.concurrent.TimeUnit;

/**
 * Test on VPN app.
 */
@RunWith(AndroidJUnit4.class)
public class VpnTest {
    private static final String VPN_ACTIVATED_TEXT = "VPN is activated by TestVPN";
    private static final String NETWORK_MONITORED_TEXT = "Network may be monitored";

    @Rule
    public final SystemImageTestFramework testFramework = new SystemImageTestFramework();

    @Rule
    public Timeout globalTimeout = Timeout.seconds(120);

    private boolean verifyVpnStatus(final UiDevice device) throws Exception {
        // Verify that a VPN lock icon is on the status bar.
        // Need to wait for a while to check the notification bar items
        // because opening notification is an animation.
        boolean isTrue;
        if (testFramework.getApi() >= 24) {
            // API 25 requires extra retry time to indentify VPN indicator.
            isTrue = new Wait(TimeUnit.MILLISECONDS.convert(10L, TimeUnit.SECONDS)).until(new Wait.ExpectedCondition() {
                @Override
                public boolean isTrue() throws Exception {
                    device.openNotification();
                    device.findObject(new UiSelector().resourceId(Res.NOTIFICATION_BAR_EXPAND_RES)
                            .className("android.widget.ImageView")).click();
                    return device.hasObject(By.text(NETWORK_MONITORED_TEXT));
                }
            });
        } else {
            isTrue = new Wait().until(new Wait.ExpectedCondition() {
                @Override
                public boolean isTrue() throws Exception {
                    device.openNotification();
                    return device.hasObject(By.res(Res.VPN_LOCK_ICON_RES)) ||
                            device.hasObject(By.text(VPN_ACTIVATED_TEXT));
                }
            });
        }
        device.pressHome();
        return isTrue;
    }

    /**
     * Tests if VPN works as expected.
     * <p>
     * This is run to qualify releases. Please involve the test team in substantial changes.
     * <p>
     * TR ID: C14578822
     * <p>
     *   <pre>
     *   Test Steps:
     *   1. Start the emulator.
     *   2. Install FredVPN app.
     *   3. Open the app.
     *   4. Tap on Connect.
     *   Verify:
     *   The VPN app runs on the emulator. A VPN lock icon displays on the status bar.
     *   </pre>
     * <p/>
     * This test does not run on API 19 due to TestVPN app crashing on API 19.
     */
    @Test
    @TestInfo(id = "14578822")
    public void testVpn() throws Exception {
        Instrumentation instrumentation = testFramework.getInstrumentation();
        UiDevice device = testFramework.getDevice();

        // Disable test for API 19. Enable when bug 30376641 is fixed.
        if (testFramework.getApi() == 19) {
            return;
        }
        // Check if VPN is on. If true, skip.
        if (!verifyVpnStatus(device)) {
            AppLauncher.launch(instrumentation, "TestVPN");

            device.findObject(new UiSelector().resourceId(Res.START_VPN_BUTTON_RES))
                    .clickAndWaitForNewWindow();
            new VpnPopupWatcher(device).checkForCondition();
            Assert.assertTrue("Failed to find the VPN lock icon after starting VPN!",
                    verifyVpnStatus(device));
        }
    }
}