adservices/tests/cts/appsetid/src/com/android/adservices/tests/appsetid/AppSetIdManagerTest.java

/*
 * Copyright (C) 2022 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.adservices.tests.appsetid;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import android.adservices.appsetid.AppSetId;
import android.adservices.appsetid.AppSetIdManager;
import android.content.Context;
import android.os.LimitExceededException;
import android.os.OutcomeReceiver;

import androidx.annotation.NonNull;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.runner.AndroidJUnit4;

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

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

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;

@RunWith(AndroidJUnit4.class)
public class AppSetIdManagerTest {
    private static final Executor CALLBACK_EXECUTOR = Executors.newCachedThreadPool();
    private static final Context sContext = ApplicationProvider.getApplicationContext();

    @Before
    public void setup() {
        overrideAppSetIdKillSwitch(true);
    }

    @After
    public void tearDown() throws Exception {
        overrideAppSetIdKillSwitch(false);
        // Cool-off rate limiter
        TimeUnit.SECONDS.sleep(1);
    }

    // Override appsetid related kill switch to ignore the effect of actual PH values.
    // If shouldOverride = true, override appsetid related kill switch to OFF to allow adservices
    // If shouldOverride = false, override appsetid related kill switch to meaningless value so that
    // PhFlags will use the default value.
    private void overrideAppSetIdKillSwitch(boolean shouldOverride) {
        String overrideString = shouldOverride ? "false" : "null";
        ShellUtils.runShellCommand(
                "setprop debug.adservices.appsetid_kill_switch " + overrideString);
    }

    @Test
    public void testAppSetIdManager() throws Exception {
        AppSetIdManager appSetIdManager = sContext.getSystemService(AppSetIdManager.class);
        CompletableFuture<AppSetId> future = new CompletableFuture<>();
        OutcomeReceiver<AppSetId, Exception> callback =
                new OutcomeReceiver<AppSetId, Exception>() {
                    @Override
                    public void onResult(AppSetId result) {
                        future.complete(result);
                    }

                    @Override
                    public void onError(Exception error) {
                        Assert.fail();
                    }
                };
        appSetIdManager.getAppSetId(CALLBACK_EXECUTOR, callback);
        AppSetId resultAppSetId = future.get();
        Assert.assertNotNull(resultAppSetId.getId());
        Assert.assertNotNull(resultAppSetId.getScope());
    }

    @Test
    public void testAppSetIdManager_verifyRateLimitReached() throws Exception {
        final AppSetIdManager appSetIdManager = sContext.getSystemService(AppSetIdManager.class);

        // Rate limit hasn't reached yet
        assertFalse(getAppSetIdAndVerifyRateLimitReached(appSetIdManager));
        assertFalse(getAppSetIdAndVerifyRateLimitReached(appSetIdManager));
        assertFalse(getAppSetIdAndVerifyRateLimitReached(appSetIdManager));
        assertFalse(getAppSetIdAndVerifyRateLimitReached(appSetIdManager));
        assertFalse(getAppSetIdAndVerifyRateLimitReached(appSetIdManager));

        // Due to bursting, we could reach the limit at the exact limit or limit + 1. Therefore,
        // triggering one more call without checking the outcome.
        getAppSetIdAndVerifyRateLimitReached(appSetIdManager);

        // Verify limit reached
        assertTrue(getAppSetIdAndVerifyRateLimitReached(appSetIdManager));
    }

    private boolean getAppSetIdAndVerifyRateLimitReached(AppSetIdManager manager)
            throws InterruptedException {
        final AtomicBoolean reachedLimit = new AtomicBoolean(false);
        final CountDownLatch countDownLatch = new CountDownLatch(1);

        manager.getAppSetId(
                CALLBACK_EXECUTOR,
                createCallbackWithCountdownOnLimitExceeded(countDownLatch, reachedLimit));

        countDownLatch.await();
        return reachedLimit.get();
    }

    private OutcomeReceiver<AppSetId, Exception> createCallbackWithCountdownOnLimitExceeded(
            CountDownLatch countDownLatch, AtomicBoolean reachedLimit) {
        return new OutcomeReceiver<AppSetId, Exception>() {
            @Override
            public void onResult(@NonNull AppSetId result) {
                countDownLatch.countDown();
            }

            @Override
            public void onError(@NonNull Exception error) {
                if (error instanceof LimitExceededException) {
                    reachedLimit.set(true);
                }
                countDownLatch.countDown();
            }
        };
    }
}