tests/ambientcontext/src/android/ambientcontext/cts/CtsAmbientContextDetectionServiceDeviceTest.java

/*
 * Copyright (C) 2021 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.ambientcontext.cts;

import static androidx.test.platform.app.InstrumentationRegistry.getInstrumentation;

import static com.android.compatibility.common.util.ShellUtils.runShellCommand;

import static com.google.common.truth.Truth.assertThat;

import static org.junit.Assume.assumeTrue;

import android.app.ambientcontext.AmbientContextEvent;
import android.app.ambientcontext.AmbientContextEventResponse;
import android.os.Build.VERSION;
import android.os.Build.VERSION_CODES;
import android.platform.test.annotations.AppModeFull;
import android.text.TextUtils;

import androidx.test.ext.junit.runners.AndroidJUnit4;

import com.android.compatibility.common.util.DeviceConfigStateChangerRule;

import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;


/**
 * This suite of test ensures that AmbientContextService behaves correctly when properly
 * bound to an AmbientContextDetectionService implementation.
 */
@RunWith(AndroidJUnit4.class)
@AppModeFull(
        reason = "PM will not recognize CtsTestAmbientContextDetectionService in instantMode.")
public class CtsAmbientContextDetectionServiceDeviceTest {

    private static final String NAMESPACE_ambient_context = "ambient_context";
    private static final String KEY_SERVICE_ENABLED = "service_enabled";
    private static final String FAKE_SERVICE_PACKAGE =
            CtsAmbientContextDetectionService.class.getPackage().getName();
    private static final String USER_ID = "0";

    private static final AmbientContextEvent FAKE_EVENT = new AmbientContextEvent.Builder()
            .setEventType(AmbientContextEvent.EVENT_COUGH)
            .setConfidenceLevel(AmbientContextEvent.LEVEL_HIGH)
            .setDensityLevel(AmbientContextEvent.LEVEL_MEDIUM)
            .build();
    private static final long TEMPORARY_SERVICE_DURATION = 5000L;

    private final boolean mIsTestable =
            !TextUtils.isEmpty(getAmbientContextDetectionServiceComponent());

    @Rule
    public final DeviceConfigStateChangerRule mLookAllTheseRules =
            new DeviceConfigStateChangerRule(getInstrumentation().getTargetContext(),
                    NAMESPACE_ambient_context,
                    KEY_SERVICE_ENABLED,
                    "true");

    @Before
    public void setUp() {
        assumeTrue("VERSION.SDK_INT=" + VERSION.SDK_INT,
                VERSION.SDK_INT >= VERSION_CODES.TIRAMISU);
        assumeTrue("Feature not available on this device. Skipping test.", mIsTestable);
        clearTestableAmbientContextDetectionService();
        CtsAmbientContextDetectionService.reset();
        bindToTestService();
    }

    @After
    public void tearDown() {
        clearTestableAmbientContextDetectionService();
    }

    @Test
    public void testAmbientContextDetectionService_OnSuccess() {
        // From manager, call startDetection() on test service
        assertThat(CtsAmbientContextDetectionService.hasPendingRequest()).isFalse();
        callStartDetection();
        assertThat(CtsAmbientContextDetectionService.hasPendingRequest()).isTrue();

        // From test service, respond with onSuccess
        CtsAmbientContextDetectionService.respondSuccess(FAKE_EVENT);

        // From manager, verify callback was called
        assertThat(getLastStatusCode()).isEqualTo(AmbientContextEventResponse.STATUS_SUCCESS);
    }

    @Test
    public void testAmbientContextDetectionService_OnServiceUnavailable() {
        // From manager, call startDetection() on test service
        assertThat(CtsAmbientContextDetectionService.hasPendingRequest()).isFalse();
        callStartDetection();
        assertThat(CtsAmbientContextDetectionService.hasPendingRequest()).isTrue();

        // From test service, cancel the request and respond with STATUS_SERVICE_UNAVAILABLE
        CtsAmbientContextDetectionService.respondFailure(
                AmbientContextEventResponse.STATUS_SERVICE_UNAVAILABLE);

        // From test service, verify that the request was cancelled
        assertThat(CtsAmbientContextDetectionService.hasPendingRequest()).isFalse();

        // From manager, verify that the callback was called with STATUS_SERVICE_UNAVAILABLE
        assertThat(getLastStatusCode()).isEqualTo(
                AmbientContextEventResponse.STATUS_SERVICE_UNAVAILABLE);
    }

    private int getLastStatusCode() {
        return Integer.parseInt(runShellCommand(
                "cmd ambient_context get-last-status-code"));
    }

    private void bindToTestService() {
        // On Manager, bind to test service
        assertThat(getAmbientContextDetectionServiceComponent()).isNotEqualTo(FAKE_SERVICE_PACKAGE);
        setTestableAmbientContextDetectionService(FAKE_SERVICE_PACKAGE);
        assertThat(getAmbientContextDetectionServiceComponent()).contains(FAKE_SERVICE_PACKAGE);
    }

    private String getAmbientContextDetectionServiceComponent() {
        return runShellCommand("cmd ambient_context get-bound-package %s", USER_ID);
    }

    /**
     * This call is asynchronous (manager spawns + binds to service and then asynchronously makes a
     * call).
     * As such, we need to ensure consistent testing results, by waiting until we receive a response
     * in our test service w/ CountDownLatch(s).
     */
    private void callStartDetection() {
        runShellCommand("cmd ambient_context start-detection %s %s",
                USER_ID, FAKE_SERVICE_PACKAGE);
        CtsAmbientContextDetectionService.onReceivedResponse();
    }

    private void setTestableAmbientContextDetectionService(String service) {
        runShellCommand("cmd ambient_context set-temporary-service %s %s %s",
                USER_ID, service, TEMPORARY_SERVICE_DURATION);
    }

    private void clearTestableAmbientContextDetectionService() {
        runShellCommand("cmd ambient_context set-temporary-service %s", USER_ID);
    }
}