path: root/adservices/tests/cts/endtoends/permissions/valid/src/com/android/adservices/tests/permissions/PermissionsValidTest.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.permissions;

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

import static org.junit.Assert.assertThrows;

import android.Manifest;
import android.adservices.adselection.AdSelectionConfig;
import android.adservices.adselection.AdSelectionConfigFixture;
import android.adservices.adselection.ReportImpressionRequest;
import android.adservices.clients.adselection.AdSelectionClient;
import android.adservices.clients.customaudience.AdvertisingCustomAudienceClient;
import android.adservices.clients.topics.AdvertisingTopicsClient;
import android.adservices.common.AdTechIdentifier;
import android.adservices.customaudience.CustomAudience;
import android.adservices.topics.GetTopicsResponse;
import android.content.Context;
import android.net.Uri;

import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import androidx.test.platform.app.InstrumentationRegistry;

import com.android.adservices.service.PhFlagsFixture;
import com.android.compatibility.common.util.ShellUtils;

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

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;

@RunWith(AndroidJUnit4.class)
// TODO: Add tests for measurement (b/238194122).
public class PermissionsValidTest {
    private static final Executor CALLBACK_EXECUTOR = Executors.newCachedThreadPool();
    private static final Context sContext = ApplicationProvider.getApplicationContext();
    private static final String PERMISSION_NOT_REQUESTED =
            "Caller is not authorized to call this API. Permission was not requested.";

    @Before
    public void setup() {
        overrideConsentManagerDebugMode(true);
        overridingAdservicesLoggingLevel("VERBOSE");
        InstrumentationRegistry.getInstrumentation()
                .getUiAutomation()
                .adoptShellPermissionIdentity(Manifest.permission.WRITE_DEVICE_CONFIG);
    }

    @After
    public void teardown() {
        overrideConsentManagerDebugMode(false);
    }

    @Test
    public void testValidPermissions_topics() throws Exception {
        overrideDisableTopicsEnrollmentCheck("1");

        AdvertisingTopicsClient advertisingTopicsClient1 =
                new AdvertisingTopicsClient.Builder()
                        .setContext(sContext)
                        .setSdkName("sdk1")
                        .setExecutor(CALLBACK_EXECUTOR)
                        .build();

        GetTopicsResponse sdk1Result = advertisingTopicsClient1.getTopics().get();
        // Not getting an error here indicates that permissions are valid. The valid case is also
        // tested in TopicsManagerTest.
        assertThat(sdk1Result.getTopics()).isEmpty();
        overrideDisableTopicsEnrollmentCheck("0");
    }

    @Test
    public void testValidPermissions_fledgeJoinCustomAudience()
            throws ExecutionException, InterruptedException {
        PhFlagsFixture.overrideFledgeEnrollmentCheck(false);

        try {
            AdvertisingCustomAudienceClient customAudienceClient =
                    new AdvertisingCustomAudienceClient.Builder()
                            .setContext(sContext)
                            .setExecutor(CALLBACK_EXECUTOR)
                            .build();

            CustomAudience customAudience =
                    new CustomAudience.Builder()
                            .setBuyer(AdTechIdentifier.fromString("test.com"))
                            .setName("exampleCustomAudience")
                            .setDailyUpdateUri(Uri.parse("https://test.com/daily-update"))
                            .setBiddingLogicUri(Uri.parse("https://test.com/bidding-logic"))
                            .build();

            customAudienceClient.joinCustomAudience(customAudience).get();
        } finally {
            PhFlagsFixture.overrideFledgeEnrollmentCheck(true);
        }
    }

    @Test
    public void testValidPermissions_selectAds() {
        PhFlagsFixture.overrideFledgeEnrollmentCheck(false);

        AdSelectionConfig adSelectionConfig = AdSelectionConfigFixture.anAdSelectionConfig();

        try {
            AdSelectionClient mAdSelectionClient =
                    new AdSelectionClient.Builder()
                            .setContext(sContext)
                            .setExecutor(CALLBACK_EXECUTOR)
                            .build();

            ExecutionException exception =
                    assertThrows(
                            ExecutionException.class,
                            () -> mAdSelectionClient.selectAds(adSelectionConfig).get());
            // We only need to get past the permissions check for this test to be valid
            assertThat(exception.getMessage()).isNotEqualTo(PERMISSION_NOT_REQUESTED);
        } finally {
            PhFlagsFixture.overrideFledgeEnrollmentCheck(true);
        }
    }

    @Test
    public void testValidPermissions_reportImpression() {
        PhFlagsFixture.overrideFledgeEnrollmentCheck(false);

        AdSelectionConfig adSelectionConfig = AdSelectionConfigFixture.anAdSelectionConfig();

        long adSelectionId = 1;

        try {
            AdSelectionClient mAdSelectionClient =
                    new AdSelectionClient.Builder()
                            .setContext(sContext)
                            .setExecutor(CALLBACK_EXECUTOR)
                            .build();

            ReportImpressionRequest request =
                    new ReportImpressionRequest(adSelectionId, adSelectionConfig);

            ExecutionException exception =
                    assertThrows(
                            ExecutionException.class,
                            () -> mAdSelectionClient.reportImpression(request).get());
            // We only need to get past the permissions check for this test to be valid
            assertThat(exception.getMessage()).isNotEqualTo(PERMISSION_NOT_REQUESTED);
        } finally {
            PhFlagsFixture.overrideFledgeEnrollmentCheck(true);
        }
    }

    @Test
    public void testValidPermissions_fledgeLeaveCustomAudience()
            throws ExecutionException, InterruptedException {
        PhFlagsFixture.overrideFledgeEnrollmentCheck(false);

        try {
            AdvertisingCustomAudienceClient customAudienceClient =
                    new AdvertisingCustomAudienceClient.Builder()
                            .setContext(sContext)
                            .setExecutor(CALLBACK_EXECUTOR)
                            .build();

            customAudienceClient
                    .leaveCustomAudience(
                            AdTechIdentifier.fromString("test.com"),
                            "exampleCustomAudience")
                    .get();
        } finally {
            PhFlagsFixture.overrideFledgeEnrollmentCheck(true);
        }
    }

    // Override the flag to disable Topics enrollment check.
    private void overrideDisableTopicsEnrollmentCheck(String val) {
        // Setting it to 1 here disables the Topics enrollment check.
        ShellUtils.runShellCommand(
                "setprop debug.adservices.disable_topics_enrollment_check " + val);
    }

    private void overridingAdservicesLoggingLevel(String loggingLevel) {
        ShellUtils.runShellCommand("setprop log.tag.adservices %s", loggingLevel);
    }

    // Override the Consent Manager behaviour - Consent Given
    private void overrideConsentManagerDebugMode(boolean isGiven) {
        ShellUtils.runShellCommand(
                "setprop debug.adservices.consent_manager_debug_mode " + isGiven);
    }
}