adservices/apk/unittest/src/com/android/adservices/topics/TopicsServiceTest.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.topics;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.eq;
import static org.mockito.Mockito.spy;

import android.content.Context;
import android.content.Intent;
import android.os.IBinder;

import androidx.test.core.app.ApplicationProvider;

import com.android.adservices.data.enrollment.EnrollmentDao;
import com.android.adservices.download.MddJobService;
import com.android.adservices.service.Flags;
import com.android.adservices.service.FlagsFactory;
import com.android.adservices.service.MaintenanceJobService;
import com.android.adservices.service.common.AppImportanceFilter;
import com.android.adservices.service.common.PackageChangedReceiver;
import com.android.adservices.service.consent.AdServicesApiConsent;
import com.android.adservices.service.consent.AdServicesApiType;
import com.android.adservices.service.consent.ConsentManager;
import com.android.adservices.service.stats.AdServicesLoggerImpl;
import com.android.adservices.service.topics.EpochJobService;
import com.android.adservices.service.topics.TopicsWorker;
import com.android.dx.mockito.inline.extended.ExtendedMockito;

import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.MockitoSession;

import java.util.function.Supplier;

/** Unit test for {@link com.android.adservices.topics.TopicsService}. */
public class TopicsServiceTest {
    @SuppressWarnings("unused")
    private static final String TAG = "TopicsServiceTest";

    @Mock TopicsWorker mMockTopicsWorker;
    @Mock ConsentManager mMockConsentManager;
    @Mock EnrollmentDao mMockEnrollmentDao;
    @Mock AppImportanceFilter mMockAppImportanceFilter;
    @Mock Flags mMockFlags;
    @Mock AdServicesApiConsent mMockAdServicesApiConsent;

    @Before
    public void setup() {
        MockitoAnnotations.initMocks(this);
    }

    @Test
    public void testBindableTopicsService_killswitchOff() {
        // Start a mockitoSession to mock static method
        MockitoSession session =
                ExtendedMockito.mockitoSession()
                        .spyStatic(FlagsFactory.class)
                        .spyStatic(TopicsWorker.class)
                        .spyStatic(ConsentManager.class)
                        .spyStatic(AdServicesLoggerImpl.class)
                        .spyStatic(MaintenanceJobService.class)
                        .spyStatic(EpochJobService.class)
                        .spyStatic(MddJobService.class)
                        .spyStatic(EnrollmentDao.class)
                        .spyStatic(AppImportanceFilter.class)
                        .spyStatic(PackageChangedReceiver.class)
                        .startMocking();

        try {
            // Killswitch is off.
            doReturn(false).when(mMockFlags).getTopicsKillSwitch();
            doReturn(false).when(mMockFlags).getGaUxFeatureEnabled();

            // Mock static method FlagsFactory.getFlags() to return Mock Flags.
            ExtendedMockito.doReturn(mMockFlags).when(FlagsFactory::getFlags);

            ExtendedMockito.doReturn(mMockTopicsWorker)
                    .when(() -> TopicsWorker.getInstance(any(Context.class)));

            TopicsService spyTopicsService = spy(new TopicsService());
            ExtendedMockito.doReturn(mMockConsentManager)
                    .when(() -> ConsentManager.getInstance(any(Context.class)));
            doReturn(true).when(mMockAdServicesApiConsent).isGiven();
            doReturn(mMockAdServicesApiConsent).when(mMockConsentManager).getConsent();

            ExtendedMockito.doReturn(true)
                    .when(() -> PackageChangedReceiver.enableReceiver(any(Context.class)));
            ExtendedMockito.doReturn(true)
                    .when(
                            () ->
                                    MaintenanceJobService.scheduleIfNeeded(
                                            any(Context.class), eq(false)));
            ExtendedMockito.doReturn(true)
                    .when(() -> EpochJobService.scheduleIfNeeded(any(Context.class), eq(false)));
            ExtendedMockito.doReturn(true)
                    .when(() -> MddJobService.scheduleIfNeeded(any(Context.class), eq(false)));

            ExtendedMockito.doReturn(mMockEnrollmentDao)
                    .when(() -> EnrollmentDao.getInstance(any(Context.class)));
            ExtendedMockito.doReturn(mMockAppImportanceFilter)
                    .when(
                            () ->
                                    AppImportanceFilter.create(
                                            any(Context.class), anyInt(), any(Supplier.class)));

            spyTopicsService.onCreate();
            IBinder binder = spyTopicsService.onBind(getIntentForTopicsService());
            assertNotNull(binder);
            verifyMethodExecutionOnUserConsentGiven();
        } finally {
            session.finishMocking();
        }
    }

    /**
     * Test whether the {@link TopicsService} works properly with the GA UX feature flag on. It
     * changes the behaviour of the consent - it's retrieved by a different method and it's per API.
     */
    @Test
    public void testBindableTopicsService_killswitchOffGaUxFeatureFlagOn() {
        // Start a mockitoSession to mock static method
        MockitoSession session =
                ExtendedMockito.mockitoSession()
                        .spyStatic(FlagsFactory.class)
                        .spyStatic(TopicsWorker.class)
                        .spyStatic(ConsentManager.class)
                        .spyStatic(AdServicesLoggerImpl.class)
                        .spyStatic(MaintenanceJobService.class)
                        .spyStatic(EpochJobService.class)
                        .spyStatic(MddJobService.class)
                        .spyStatic(EnrollmentDao.class)
                        .spyStatic(AppImportanceFilter.class)
                        .spyStatic(PackageChangedReceiver.class)
                        .startMocking();

        try {
            // Killswitch is off.
            doReturn(false).when(mMockFlags).getTopicsKillSwitch();
            doReturn(true).when(mMockFlags).getGaUxFeatureEnabled();

            // Mock static method FlagsFactory.getFlags() to return Mock Flags.
            ExtendedMockito.doReturn(mMockFlags).when(FlagsFactory::getFlags);

            ExtendedMockito.doReturn(mMockTopicsWorker)
                    .when(() -> TopicsWorker.getInstance(any(Context.class)));

            TopicsService spyTopicsService = spy(new TopicsService());
            ExtendedMockito.doReturn(mMockConsentManager)
                    .when(() -> ConsentManager.getInstance(any(Context.class)));
            doReturn(true).when(mMockAdServicesApiConsent).isGiven();
            doReturn(mMockAdServicesApiConsent)
                    .when(mMockConsentManager)
                    .getConsent(AdServicesApiType.TOPICS);

            ExtendedMockito.doReturn(true)
                    .when(() -> PackageChangedReceiver.enableReceiver(any(Context.class)));
            ExtendedMockito.doReturn(true)
                    .when(
                            () ->
                                    MaintenanceJobService.scheduleIfNeeded(
                                            any(Context.class), eq(false)));
            ExtendedMockito.doReturn(true)
                    .when(() -> EpochJobService.scheduleIfNeeded(any(Context.class), eq(false)));
            ExtendedMockito.doReturn(true)
                    .when(() -> MddJobService.scheduleIfNeeded(any(Context.class), eq(false)));

            ExtendedMockito.doReturn(mMockEnrollmentDao)
                    .when(() -> EnrollmentDao.getInstance(any(Context.class)));
            ExtendedMockito.doReturn(mMockAppImportanceFilter)
                    .when(
                            () ->
                                    AppImportanceFilter.create(
                                            any(Context.class), anyInt(), any(Supplier.class)));

            spyTopicsService.onCreate();
            IBinder binder = spyTopicsService.onBind(getIntentForTopicsService());
            assertNotNull(binder);
            verifyMethodExecutionOnUserConsentGiven();
        } finally {
            session.finishMocking();
        }
    }

    @Test
    public void testBindableTopicsService_killswitchOn() {
        // Start a mockitoSession to mock static method
        MockitoSession session =
                ExtendedMockito.mockitoSession().spyStatic(FlagsFactory.class).startMocking();

        try {
            // Killswitch is on.
            doReturn(true).when(mMockFlags).getTopicsKillSwitch();

            // Mock static method FlagsFactory.getFlags() to return Mock Flags.
            ExtendedMockito.doReturn(mMockFlags).when(FlagsFactory::getFlags);

            TopicsService topicsService = new TopicsService();
            topicsService.onCreate();
            IBinder binder = topicsService.onBind(getIntentForTopicsService());
            assertNull(binder);
        } finally {
            session.finishMocking();
        }
    }

    private Intent getIntentForTopicsService() {
        return new Intent(ApplicationProvider.getApplicationContext(), TopicsService.class);
    }

    private void verifyMethodExecutionOnUserConsentGiven() {
        ExtendedMockito.verify(() -> PackageChangedReceiver.enableReceiver(any(Context.class)));
        ExtendedMockito.verify(
                () -> MaintenanceJobService.scheduleIfNeeded(any(Context.class), eq(false)));
        ExtendedMockito.verify(
                () -> EpochJobService.scheduleIfNeeded(any(Context.class), eq(false)));
        ExtendedMockito.verify(() -> MddJobService.scheduleIfNeeded(any(Context.class), eq(false)));
    }
}