ondevicepersonalization/services/OnDevicePersonalizationBroadcastReceiverTests.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.ondevicepersonalization.services;

import static android.content.pm.PackageManager.COMPONENT_ENABLED_STATE_ENABLED;

import static com.android.dx.mockito.inline.extended.ExtendedMockito.verify;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.AGGREGATE_ERROR_DATA_REPORTING_JOB_ID;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.MAINTENANCE_TASK_JOB_ID;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.MDD_CELLULAR_CHARGING_PERIODIC_TASK_JOB_ID;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.MDD_CHARGING_PERIODIC_TASK_JOB_ID;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.MDD_MAINTENANCE_PERIODIC_TASK_JOB_ID;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.MDD_WIFI_CHARGING_PERIODIC_TASK_JOB_ID;
import static com.android.ondevicepersonalization.services.OnDevicePersonalizationConfig.USER_DATA_COLLECTION_ID;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.when;

import android.app.job.JobScheduler;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;

import androidx.test.core.app.ApplicationProvider;

import com.android.dx.mockito.inline.extended.ExtendedMockito;
import com.android.modules.utils.testing.ExtendedMockitoRule;
import com.android.odp.module.common.DeviceUtils;
import com.android.ondevicepersonalization.services.data.errors.AggregateErrorDataReportingJob;
import com.android.ondevicepersonalization.services.data.user.UserDataCollectionJob;
import com.android.ondevicepersonalization.services.download.mdd.MobileDataDownloadFactory;
import com.android.ondevicepersonalization.services.maintenance.OnDevicePersonalizationMaintenanceJob;

import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Mock;
import org.mockito.quality.Strictness;

@RunWith(JUnit4.class)
public class OnDevicePersonalizationBroadcastReceiverTests {
    private static final Intent BOOT_COMPLETED_INTENT = new Intent(Intent.ACTION_BOOT_COMPLETED);

    /** All the jobs that the BroadcastReceiver is responsible for scheduling. */
    private static final ImmutableList<Integer> JOB_IDS =
            ImmutableList.of(
                    // Job Ids for ODP maintenance jobs that are scheduled/cancelled by the
                    // receiver.
                    MAINTENANCE_TASK_JOB_ID,
                    AGGREGATE_ERROR_DATA_REPORTING_JOB_ID,
                    USER_DATA_COLLECTION_ID,
                    // Job Ids for various Mdd Jobs
                    MDD_MAINTENANCE_PERIODIC_TASK_JOB_ID,
                    MDD_CHARGING_PERIODIC_TASK_JOB_ID,
                    MDD_CELLULAR_CHARGING_PERIODIC_TASK_JOB_ID,
                    MDD_WIFI_CHARGING_PERIODIC_TASK_JOB_ID);

    private final Context mContext = ApplicationProvider.getApplicationContext();

    // Use direct executor to keep all work sequential for the tests
    private final ListeningExecutorService mDirectExecutorService =
            MoreExecutors.newDirectExecutorService();

    private final JobScheduler mJobScheduler = mContext.getSystemService(JobScheduler.class);

    private final OnDevicePersonalizationBroadcastReceiver mReceiverUnderTest =
            new OnDevicePersonalizationBroadcastReceiver(mDirectExecutorService);
    @Mock private Flags mMockFlags;

    @Rule
    public final ExtendedMockitoRule mExtendedMockitoRule =
            new ExtendedMockitoRule.Builder(this)
                    .spyStatic(FlagsFactory.class)
                    .spyStatic(DeviceUtils.class)
                    .spyStatic(AggregateErrorDataReportingJob.class)
                    .spyStatic(OnDevicePersonalizationMaintenanceJob.class)
                    .spyStatic(UserDataCollectionJob.class)
                    .setStrictness(Strictness.LENIENT)
                    .build();

    @Before
    public void setup() throws Exception {
        ExtendedMockito.doReturn(mMockFlags).when(FlagsFactory::getFlags);
        when(mMockFlags.getGlobalKillSwitch()).thenReturn(false);

        // By default, disable SPE and aggregate error reporting.
        when(mMockFlags.getSpePilotJobEnabled()).thenReturn(false);
        when(mMockFlags.getSpeOnAggregateErrorDataReportingJobEnabled()).thenReturn(false);
        when(mMockFlags.getAggregatedErrorReportingEnabled()).thenReturn(false);

        ExtendedMockito.doReturn(true).when(() -> DeviceUtils.isOdpSupported(any()));

        // Cancel any pending maintenance and MDD jobs
        for (int jobId : JOB_IDS) {
            mJobScheduler.cancel(jobId);
        }
    }

    @Test
    public void testOnReceive() {
        when(mMockFlags.getAggregatedErrorReportingEnabled()).thenReturn(true);
        MobileDataDownloadFactory.getMdd(mContext, mDirectExecutorService, mDirectExecutorService);

        mReceiverUnderTest.onReceive(mContext, BOOT_COMPLETED_INTENT);

        verify(() -> OnDevicePersonalizationMaintenanceJob.schedule(mContext));
        verify(() -> UserDataCollectionJob.schedule(mContext));
        verify(() -> AggregateErrorDataReportingJob.schedule(mContext));
        assertAllJobsScheduled();
    }

    @Test
    public void testOnReceiveKillSwitchOn() {
        when(mMockFlags.getGlobalKillSwitch()).thenReturn(true);

        mReceiverUnderTest.onReceive(mContext, BOOT_COMPLETED_INTENT);

        verify(() -> OnDevicePersonalizationMaintenanceJob.schedule(mContext), never());
        verify(() -> UserDataCollectionJob.schedule(mContext), never());
        verify(() -> AggregateErrorDataReportingJob.schedule(mContext), never());
        assertNoJobsScheduled();
    }

    @Test
    public void testOnReceiveDeviceNotSupported() {
        ExtendedMockito.doReturn(false).when(() -> DeviceUtils.isOdpSupported(any()));

        mReceiverUnderTest.onReceive(mContext, BOOT_COMPLETED_INTENT);

        verify(() -> OnDevicePersonalizationMaintenanceJob.schedule(mContext), never());
        verify(() -> UserDataCollectionJob.schedule(mContext), never());
        verify(() -> AggregateErrorDataReportingJob.schedule(mContext), never());
        assertNoJobsScheduled();
    }

    @Test
    public void testOnReceiveInvalidIntent() {
        mReceiverUnderTest.onReceive(mContext, new Intent(Intent.ACTION_DIAL_EMERGENCY));

        verify(() -> OnDevicePersonalizationMaintenanceJob.schedule(mContext), never());
        verify(() -> UserDataCollectionJob.schedule(mContext), never());
        verify(() -> AggregateErrorDataReportingJob.schedule(mContext), never());
        assertNoJobsScheduled();
    }

    @Test
    public void testEnableReceiver() {
        ComponentName componentName =
                new ComponentName(mContext, OnDevicePersonalizationBroadcastReceiver.class);

        assertTrue(OnDevicePersonalizationBroadcastReceiver.enableReceiver(mContext));
        int result = mContext.getPackageManager().getComponentEnabledSetting(componentName);
        assertEquals(COMPONENT_ENABLED_STATE_ENABLED, result);
    }

    private void assertAllJobsScheduled() {
        for (int jobId : JOB_IDS) {
            assertNotNull(mJobScheduler.getPendingJob(jobId));
        }
    }

    private void assertNoJobsScheduled() {
        for (int jobId : JOB_IDS) {
            assertNull(mJobScheduler.getPendingJob(jobId));
        }
    }
}