1/* 2 * Copyright 2017 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package androidx.work.impl.background.systemjob; 18 19import static androidx.work.NetworkType.CONNECTED; 20import static androidx.work.NetworkType.METERED; 21import static androidx.work.NetworkType.NOT_REQUIRED; 22import static androidx.work.NetworkType.NOT_ROAMING; 23import static androidx.work.NetworkType.UNMETERED; 24 25import static org.hamcrest.CoreMatchers.is; 26import static org.hamcrest.MatcherAssert.assertThat; 27import static org.hamcrest.Matchers.arrayContaining; 28 29import android.app.job.JobInfo; 30import android.net.Uri; 31import android.os.Build; 32import android.support.test.InstrumentationRegistry; 33import android.support.test.filters.SdkSuppress; 34import android.support.test.filters.SmallTest; 35import android.support.test.runner.AndroidJUnit4; 36 37import androidx.work.BackoffPolicy; 38import androidx.work.Constraints; 39import androidx.work.NetworkType; 40import androidx.work.OneTimeWorkRequest; 41import androidx.work.PeriodicWorkRequest; 42import androidx.work.WorkManagerTest; 43import androidx.work.impl.WorkManagerImpl; 44import androidx.work.impl.model.WorkSpec; 45import androidx.work.worker.TestWorker; 46 47import org.junit.Before; 48import org.junit.Test; 49import org.junit.runner.RunWith; 50 51@RunWith(AndroidJUnit4.class) 52@SdkSuppress(minSdkVersion = WorkManagerImpl.MIN_JOB_SCHEDULER_API_LEVEL) 53public class SystemJobInfoConverterTest extends WorkManagerTest { 54 55 private static final long TEST_INTERVAL_DURATION = 56 PeriodicWorkRequest.MIN_PERIODIC_INTERVAL_MILLIS + 1232L; 57 private static final long TEST_FLEX_DURATION = 58 PeriodicWorkRequest.MIN_PERIODIC_FLEX_MILLIS + 112L; 59 private static final int JOB_ID = 101; 60 61 private SystemJobInfoConverter mConverter; 62 63 @Before 64 public void setUp() { 65 mConverter = new SystemJobInfoConverter( 66 InstrumentationRegistry.getTargetContext()); 67 } 68 69 @Test 70 @SmallTest 71 public void testConvert_ids() { 72 final String expectedWorkSpecId = "026e3422-9cd1-11e7-abc4-cec278b6b50a"; 73 WorkSpec workSpec = new WorkSpec(expectedWorkSpecId, TestWorker.class.getName()); 74 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 75 String actualWorkSpecId = jobInfo.getExtras().getString( 76 SystemJobInfoConverter.EXTRA_WORK_SPEC_ID); 77 assertThat(actualWorkSpecId, is(expectedWorkSpecId)); 78 assertThat(jobInfo.getId(), is(JOB_ID)); 79 } 80 81 @Test 82 @SmallTest 83 public void testConvert_setPersistedByDefault() { 84 JobInfo jobInfo = mConverter.convert( 85 new WorkSpec("id", TestWorker.class.getName()), JOB_ID); 86 assertThat(jobInfo.isPersisted(), is(false)); 87 } 88 89 /** 90 * Due to b/6771687, calling {@link JobInfo.Builder#build} with no constraints throws an 91 * {@link IllegalArgumentException}. This is testing that {@link SystemJobInfoConverter#convert} 92 * sets some dummy constraint to toggle some internal boolean flags in {@link JobInfo.Builder} 93 * to allow {@link OneTimeWorkRequest} with no constraints to be converted without affecting its 94 * runtime, e.g. calling builder.setMinLatencyMillis(0L). 95 */ 96 @Test 97 @SmallTest 98 public void testConvert_noConstraints_doesNotThrowException() { 99 mConverter.convert(new WorkSpec("id", TestWorker.class.getName()), JOB_ID); 100 } 101 102 @Test 103 @SmallTest 104 public void testConvert_retryPolicy() { 105 long expectedBackoffDelayDuration = 50000; 106 WorkSpec workSpec = new WorkSpec("id", TestWorker.class.getName()); 107 workSpec.setBackoffDelayDuration(expectedBackoffDelayDuration); 108 workSpec.backoffPolicy = BackoffPolicy.LINEAR; 109 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 110 assertThat(jobInfo.getInitialBackoffMillis(), is(expectedBackoffDelayDuration)); 111 assertThat(jobInfo.getBackoffPolicy(), is(JobInfo.BACKOFF_POLICY_LINEAR)); 112 } 113 114 @Test 115 @SmallTest 116 public void testConvert_initialDelay() { 117 final long expectedInitialDelay = 12123L; 118 WorkSpec workSpec = new WorkSpec("id", TestWorker.class.getName()); 119 workSpec.initialDelay = expectedInitialDelay; 120 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 121 assertThat(jobInfo.getMinLatencyMillis(), is(expectedInitialDelay)); 122 } 123 124 @Test 125 @SmallTest 126 public void testConvert_periodicWithNoFlex() { 127 WorkSpec workSpec = new WorkSpec("id", TestWorker.class.getName()); 128 workSpec.setPeriodic(TEST_INTERVAL_DURATION); 129 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 130 assertThat(jobInfo.getIntervalMillis(), is(TEST_INTERVAL_DURATION)); 131 } 132 133 @Test 134 @SmallTest 135 @SdkSuppress(minSdkVersion = 24) 136 public void testConvert_periodicWithFlex() { 137 WorkSpec workSpec = new WorkSpec("id", TestWorker.class.getName()); 138 workSpec.setPeriodic(TEST_INTERVAL_DURATION, TEST_FLEX_DURATION); 139 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 140 assertThat(jobInfo.getIntervalMillis(), is(TEST_INTERVAL_DURATION)); 141 assertThat(jobInfo.getFlexMillis(), is(TEST_FLEX_DURATION)); 142 } 143 144 @Test 145 @SmallTest 146 public void testConvert_requireCharging() { 147 final boolean expectedRequireCharging = true; 148 WorkSpec workSpec = getTestWorkSpecWithConstraints(new Constraints.Builder() 149 .setRequiresCharging(expectedRequireCharging).build()); 150 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 151 assertThat(jobInfo.isRequireCharging(), is(expectedRequireCharging)); 152 } 153 154 @Test 155 @SmallTest 156 @SdkSuppress(minSdkVersion = 24) 157 public void testConvert_requireContentUriTrigger() { 158 final Uri expectedUri = Uri.parse("TEST_URI"); 159 final JobInfo.TriggerContentUri expectedTriggerContentUri = 160 new JobInfo.TriggerContentUri( 161 expectedUri, JobInfo.TriggerContentUri.FLAG_NOTIFY_FOR_DESCENDANTS); 162 WorkSpec workSpec = getTestWorkSpecWithConstraints(new Constraints.Builder() 163 .addContentUriTrigger(expectedUri, true).build()); 164 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 165 166 JobInfo.TriggerContentUri[] triggerContentUris = jobInfo.getTriggerContentUris(); 167 assertThat(triggerContentUris, is(arrayContaining(expectedTriggerContentUri))); 168 } 169 170 @Test 171 @SmallTest 172 public void testConvert_requireDeviceIdle() { 173 final boolean expectedRequireDeviceIdle = true; 174 WorkSpec workSpec = getTestWorkSpecWithConstraints(new Constraints.Builder() 175 .setRequiresDeviceIdle(expectedRequireDeviceIdle).build()); 176 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 177 assertThat(jobInfo.isRequireDeviceIdle(), is(expectedRequireDeviceIdle)); 178 } 179 180 @Test 181 @SmallTest 182 @SdkSuppress(minSdkVersion = 26) 183 public void testConvert_requireBatteryNotLow() { 184 final boolean expectedRequireBatteryNotLow = true; 185 WorkSpec workSpec = getTestWorkSpecWithConstraints(new Constraints.Builder() 186 .setRequiresBatteryNotLow(expectedRequireBatteryNotLow).build()); 187 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 188 assertThat(jobInfo.isRequireBatteryNotLow(), is(expectedRequireBatteryNotLow)); 189 } 190 191 @Test 192 @SmallTest 193 @SdkSuppress(minSdkVersion = 26) 194 public void testConvert_requireStorageNotLow() { 195 final boolean expectedRequireStorageNotLow = true; 196 WorkSpec workSpec = getTestWorkSpecWithConstraints(new Constraints.Builder() 197 .setRequiresStorageNotLow(expectedRequireStorageNotLow).build()); 198 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 199 assertThat(jobInfo.isRequireStorageNotLow(), is(expectedRequireStorageNotLow)); 200 } 201 202 @Test 203 @SmallTest 204 public void testConvert_networkTypeNotRoamingRequiresApi24() { 205 convertWithRequiredNetworkType(NOT_ROAMING, JobInfo.NETWORK_TYPE_NOT_ROAMING, 24); 206 } 207 208 @Test 209 @SmallTest 210 public void testConvert_networkTypeMeteredRequiresApi26() { 211 convertWithRequiredNetworkType(METERED, JobInfo.NETWORK_TYPE_METERED, 26); 212 } 213 214 private void convertWithRequiredNetworkType(NetworkType networkType, 215 int jobInfoNetworkType, 216 int minSdkVersion) { 217 WorkSpec workSpec = getTestWorkSpecWithConstraints(new Constraints.Builder() 218 .setRequiredNetworkType(networkType).build()); 219 JobInfo jobInfo = mConverter.convert(workSpec, JOB_ID); 220 if (Build.VERSION.SDK_INT >= minSdkVersion) { 221 assertThat(jobInfo.getNetworkType(), is(jobInfoNetworkType)); 222 } else { 223 assertThat(jobInfo.getNetworkType(), is(JobInfo.NETWORK_TYPE_ANY)); 224 } 225 } 226 227 @Test 228 @SmallTest 229 public void testConvertNetworkType_none() { 230 assertThat(SystemJobInfoConverter.convertNetworkType(NOT_REQUIRED), 231 is(JobInfo.NETWORK_TYPE_NONE)); 232 } 233 234 @Test 235 @SmallTest 236 public void testConvertNetworkType_any() { 237 assertThat(SystemJobInfoConverter.convertNetworkType(CONNECTED), 238 is(JobInfo.NETWORK_TYPE_ANY)); 239 } 240 241 @Test 242 @SmallTest 243 public void testConvertNetworkType_unmetered() { 244 assertThat(SystemJobInfoConverter.convertNetworkType(UNMETERED), 245 is(JobInfo.NETWORK_TYPE_UNMETERED)); 246 } 247 248 @Test 249 @SmallTest 250 @SdkSuppress(minSdkVersion = 23, maxSdkVersion = 23) 251 public void testConvertNetworkType_notRoaming_returnAnyBeforeApi24() { 252 assertThat(SystemJobInfoConverter.convertNetworkType(NOT_ROAMING), 253 is(JobInfo.NETWORK_TYPE_ANY)); 254 } 255 256 @Test 257 @SmallTest 258 @SdkSuppress(minSdkVersion = 24) 259 public void testConvertNetworkType_notRoaming_returnsNotRoamingAtOrAfterApi24() { 260 assertThat(SystemJobInfoConverter.convertNetworkType(NOT_ROAMING), 261 is(JobInfo.NETWORK_TYPE_NOT_ROAMING)); 262 } 263 264 @Test 265 @SmallTest 266 @SdkSuppress(minSdkVersion = WorkManagerImpl.MIN_JOB_SCHEDULER_API_LEVEL, maxSdkVersion = 25) 267 public void testConvertNetworkType_metered_returnsAnyBeforeApi26() { 268 assertThat(SystemJobInfoConverter.convertNetworkType(METERED), 269 is(JobInfo.NETWORK_TYPE_ANY)); 270 } 271 272 @Test 273 @SmallTest 274 @SdkSuppress(minSdkVersion = 26) 275 public void testConvertNetworkType_metered_returnsMeteredAtOrAfterApi26() { 276 assertThat(SystemJobInfoConverter.convertNetworkType(METERED), 277 is(JobInfo.NETWORK_TYPE_METERED)); 278 } 279 280 private WorkSpec getTestWorkSpecWithConstraints(Constraints constraints) { 281 return getWorkSpec(new OneTimeWorkRequest.Builder(TestWorker.class) 282 .setConstraints(constraints) 283 .build()); 284 } 285} 286