WorkManager-এর সাথে ইন্টিগ্রেশন টেস্ট

WorkManager একটি work-testing আর্টিফ্যাক্ট প্রদান করে যা আপনার কর্মীদের পরীক্ষা করতে সাহায্য করে।

সেট-আপ করুন

work-testing আর্টিফ্যাক্ট ব্যবহার করতে, এটি build.gradle-এ androidTestImplementation ডিপেন্ডেন্সি হিসেবে যোগ করুন।

গ্ৰুভি

dependencies {
    def work_version = "2.5.0"

    ...

    // optional - Test helpers
    androidTestImplementation "androidx.work:work-testing:$work_version"
}

Kotlin

dependencies {
    val work_version = "2.4.0"

    ...

    // optional - Test helpers
    androidTestImplementation("androidx.work:work-testing:$work_version")
}

ডিপেন্ডেন্সি যোগ করার ব্যাপারে আরও তথ্যের জন্য, WorkManager রিলিজ নোট-এর ডিপেন্ডেন্সি ঘোষণা করা বিভাগটি দেখুন।

মনে রাখবেন: 2.1.0 থেকে শুরু করে, WorkManager TestWorkerBuilder এবং TestListenableWorkerBuilder ক্লাস প্রদান করে, যা আপনাকে WorkManagerTestInitHelper-এর সাথে WorkManager শুরু না করেই আপনার কর্মীদের ব্যবসায়িক লজিক পরীক্ষা করতে দেয়। Testing Worker implementation এইসব ক্লাস কভার করে। এই পৃষ্ঠার কন্টেন্ট এখনও আপনার জন্য উপযোগী, যখন আপনাকে ইন্টিগ্রেশন টেস্ট করতে হবে।

মনে রাখবেন: CoroutineWorker ইমপ্লিমেন্টেশন টেস্ট করার জন্য TestListenableWorkerBuilder ব্যবহার করার জন্য বিশেষভাবে সাজেস্ট করা হচ্ছে, কারণ work-testing আর্টিফ্যাক্ট আপনার ওয়ার্কার ইমপ্লিমেন্টেশনের CoroutineDispatcher-এর পরিবর্তে Dispatchers.Default ব্যবহার করে। এই API সম্পর্কে আরও তথ্য Testing Worker প্রয়োগ করা লিঙ্কে পাওয়া যাবে।

ধারণা

work-testing টেস্ট মোডের জন্য WorkManager-এর একটি বিশেষ প্রয়োগ প্রদান করে, যা WorkManagerTestInitHelper ব্যবহার করে শুরু করা হয়।

work-testing আর্টিফ্যাক্ট একটি SynchronousExecutor প্রদান করে যা একাধিক থ্রেড, লক বা ল্যাচ নিয়ে কাজ না করেই সিঙ্ক্রোনাস পদ্ধতিতে টেস্ট লেখা সহজ করে তোলে।

এইসব ক্লাস একসাথে কীভাবে ব্যবহার করতে হয় তার একটি উদাহরণ এখানে দেওয়া হল।

Kotlin

@RunWith(AndroidJUnit4::class)
class BasicInstrumentationTest {
    @Before
    fun setup() {
        val context = InstrumentationRegistry.getTargetContext()
        val config = Configuration.Builder()
            .setMinimumLoggingLevel(Log.DEBUG)
            .setExecutor(SynchronousExecutor())
            .build()

        // Initialize WorkManager for instrumentation tests.
        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
    }
}

জাভা

@RunWith(AndroidJUnit4.class)
public class BasicInstrumentationTest {
    @Before
    public void setup() {
        Context context = InstrumentationRegistry.getTargetContext();
        Configuration config = new Configuration.Builder()
                .setMinimumLoggingLevel(Log.DEBUG)
                .setExecutor(new SynchronousExecutor())
                .build();

        // Initialize WorkManager for instrumentation tests.
        WorkManagerTestInitHelper.initializeTestWorkManager(
            context, config);
    }
}

টেস্ট সাজানো হচ্ছে

এখন যেহেতু WorkManager টেস্ট মোডে শুরু করা হয়েছে, আপনি নিজের কর্মীদের পরীক্ষা করার জন্য প্রস্তুত।

ধরা যাক, আপনার কাছে একটি EchoWorker আছে যা কিছু inputData আশা করে এবং সহজেই এর ইনপুট outputData-এ কপি (ইকো) করে।

Kotlin

class EchoWorker(context: Context, parameters: WorkerParameters)
   : Worker(context, parameters) {
   override fun doWork(): Result {
       return when(inputData.size()) {
           0 -> Result.failure()
           else -> Result.success(inputData)
       }
   }
}

জাভা

public class EchoWorker extends Worker {
  public EchoWorker(Context context, WorkerParameters parameters) {
      super(context, parameters);
  }

  @NonNull
  @Override
  public Result doWork() {
      Data input = getInputData();
      if (input.size() == 0) {
          return Result.failure();
      } else {
          return Result.success(input);
      }
  }
}

প্রাথমিক টেস্ট

নিচে একটি Android ইন্সট্রুমেন্টেশন টেস্ট দেওয়া হল যা EchoWorker টেস্ট করে। এখানে মূল বিষয় হল, টেস্ট মোডে EchoWorker টেস্ট করা এবং আসল অ্যাপ্লিকেশনে EchoWorker ব্যবহার করার মধ্যে খুব বেশি পার্থক্য নেই।

Kotlin

@Test
@Throws(Exception::class)
fun testSimpleEchoWorker() {
    // Define input data
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    // Create request
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .setInputData(input)
        .build()

    val workManager = WorkManager.getInstance(applicationContext)
    // Enqueue and wait for result. This also runs the Worker synchronously
    // because we are using a SynchronousExecutor.
    workManager.enqueue(request).result.get()
    // Get WorkInfo and outputData
    val workInfo = workManager.getWorkInfoById(request.id).get()
    val outputData = workInfo.outputData

    // Assert
    assertThat(workInfo.state, `is`(WorkInfo.State.SUCCEEDED))
    assertThat(outputData, `is`(input))
}

জাভা

@Test
public void testSimpleEchoWorker() throws Exception {
   // Define input data
   Data input = new Data.Builder()
           .put(KEY_1, 1)
           .put(KEY_2, 2)
           .build();

   // Create request
   OneTimeWorkRequest request =
       new OneTimeWorkRequest.Builder(EchoWorker.class)
           .setInputData(input)
           .build();

   WorkManager workManager = WorkManager.getInstance(getApplicationContext());
   // Enqueue and wait for result. This also runs the Worker synchronously
   // because we are using a SynchronousExecutor.
   workManager.enqueue(request).getResult().get();
   // Get WorkInfo and outputData
   WorkInfo workInfo = workManager.getWorkInfoById(request.getId()).get();
   Data outputData = workInfo.getOutputData();

   // Assert
   assertThat(workInfo.getState(), is(WorkInfo.State.SUCCEEDED));
   assertThat(outputData, is(input));
}

আসুন, আরেকটি টেস্ট লিখি যা নিশ্চিত করে যে EchoWorker কোনও ইনপুট ডেটা না পেলে, প্রত্যাশিত Result হল Result.failure()।

Kotlin

@Test
@Throws(Exception::class)
fun testEchoWorkerNoInput() {
   // Create request
   val request = OneTimeWorkRequestBuilder<EchoWorker>()
       .build()

   val workManager = WorkManager.getInstance(applicationContext)
   // Enqueue and wait for result. This also runs the Worker synchronously
   // because we are using a SynchronousExecutor.
   workManager.enqueue(request).result.get()
   // Get WorkInfo
   val workInfo = workManager.getWorkInfoById(request.id).get()

   // Assert
   assertThat(workInfo.state, `is`(WorkInfo.State.FAILED))
}

জাভা

@Test
public void testEchoWorkerNoInput() throws Exception {
  // Create request
  OneTimeWorkRequest request =
      new OneTimeWorkRequest.Builder(EchoWorker.class)
         .build();

  WorkManager workManager = WorkManager.getInstance(getApplicationContext());
  // Enqueue and wait for result. This also runs the Worker synchronously
  // because we are using a SynchronousExecutor.
  workManager.enqueue(request).getResult().get();
  // Get WorkInfo
  WorkInfo workInfo = workManager.getWorkInfoById(request.getId()).get();

  // Assert
  assertThat(workInfo.getState(), is(WorkInfo.State.FAILED));
}

সীমাবদ্ধতা, বিলম্ব এবং পর্যায়ক্রমিক কাজ সিমুলেট করা

WorkManagerTestInitHelper আপনাকে TestDriver-এর একটি ইনস্ট্যান্স প্রদান করে যা প্রাথমিক বিলম্ব, ListenableWorker ইনস্ট্যান্সের জন্য সীমাবদ্ধতা পূরণ হওয়ার শর্ত এবং PeriodicWorkRequest ইনস্ট্যান্সের জন্য ব্যবধান সিমুলেট করতে ব্যবহার করা যেতে পারে।

প্রাথমিক বিলম্ব পরীক্ষা করুন

শুরুতে ওয়ার্কারদের দেরি হতে পারে। initialDelay-এর সাথে EchoWorker টেস্ট করতে, আপনার টেস্টে initialDelay-এর জন্য অপেক্ষা করার পরিবর্তে, আপনি TestDriver ব্যবহার করে কাজের অনুরোধের প্রাথমিক বিলম্বকে setInitialDelayMet ব্যবহার করে মিট করা হয়েছে হিসেবে চিহ্নিত করতে পারেন।

Kotlin

@Test
@Throws(Exception::class)
fun testWithInitialDelay() {
    // Define input data
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    // Create request
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .setInputData(input)
        .setInitialDelay(10, TimeUnit.SECONDS)
        .build()

    val workManager = WorkManager.getInstance(getApplicationContext())
    // Get the TestDriver
    val testDriver = WorkManagerTestInitHelper.getTestDriver()
    // Enqueue
    workManager.enqueue(request).result.get()
    // Tells the WorkManager test framework that initial delays are now met.
    testDriver.setInitialDelayMet(request.id)
    // Get WorkInfo and outputData
    val workInfo = workManager.getWorkInfoById(request.id).get()
    val outputData = workInfo.outputData

    // Assert
    assertThat(workInfo.state, `is`(WorkInfo.State.SUCCEEDED))
    assertThat(outputData, `is`(input))
}

জাভা

@Test
public void testWithInitialDelay() throws Exception {
  // Define input data
  Data input = new Data.Builder()
          .put(KEY_1, 1)
          .put(KEY_2, 2)
          .build();

  // Create request
  OneTimeWorkRequest request = new OneTimeWorkRequest.Builder(EchoWorker.class)
          .setInputData(input)
          .setInitialDelay(10, TimeUnit.SECONDS)
          .build();

  WorkManager workManager = WorkManager.getInstance(myContext);
  // Get the TestDriver
  TestDriver testDriver = WorkManagerTestInitHelper.getTestDriver();
  // Enqueue
  workManager.enqueue(request).getResult().get();
  // Tells the WorkManager test framework that initial delays are now met.
  testDriver.setInitialDelayMet(request.getId());
  // Get WorkInfo and outputData
  WorkInfo workInfo = workManager.getWorkInfoById(request.getId()).get();
  Data outputData = workInfo.getOutputData();

  // Assert
  assertThat(workInfo.getState(), is(WorkInfo.State.SUCCEEDED));
  assertThat(outputData, is(input));
}

সীমাবদ্ধতা পরীক্ষা করা হচ্ছে

setAllConstraintsMet ব্যবহার করে সীমাবদ্ধতা পূরণ হয়েছে হিসেবে চিহ্নিত করতেও TestDriver ব্যবহার করা যেতে পারে। এখানে একটি উদাহরণ দেওয়া হল যে কীভাবে আপনি সীমাবদ্ধতা সহ Worker পরীক্ষা করতে পারেন।

Kotlin

@Test
@Throws(Exception::class)
fun testWithConstraints() {
    // Define input data
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    val constraints = Constraints.Builder()
        .setRequiredNetworkType(NetworkType.CONNECTED)
        .build()

    // Create request
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .setInputData(input)
        .setConstraints(constraints)
        .build()

    val workManager = WorkManager.getInstance(myContext)
    val testDriver = WorkManagerTestInitHelper.getTestDriver()
    // Enqueue
    workManager.enqueue(request).result.get()
    // Tells the testing framework that all constraints are met.
    testDriver.setAllConstraintsMet(request.id)
    // Get WorkInfo and outputData
    val workInfo = workManager.getWorkInfoById(request.id).get()
    val outputData = workInfo.outputData

    // Assert
    assertThat(workInfo.state, `is`(WorkInfo.State.SUCCEEDED))
    assertThat(outputData, `is`(input))
}

জাভা

@Test
public void testWithConstraints() throws Exception {
    // Define input data
    Data input = new Data.Builder()
            .put(KEY_1, 1)
            .put(KEY_2, 2)
            .build();

    // Define constraints
    Constraints constraints = new Constraints.Builder()
            .setRequiresDeviceIdle(true)
            .build();

    // Create request
    OneTimeWorkRequest request = new OneTimeWorkRequest.Builder(EchoWorker.class)
            .setInputData(input)
            .setConstraints(constraints)
            .build();

    WorkManager workManager = WorkManager.getInstance(myContext);
    TestDriver testDriver = WorkManagerTestInitHelper.getTestDriver();
    // Enqueue
    workManager.enqueue(request).getResult().get();
    // Tells the testing framework that all constraints are met.
    testDriver.setAllConstraintsMet(request.getId());
    // Get WorkInfo and outputData
    WorkInfo workInfo = workManager.getWorkInfoById(request.getId()).get();
    Data outputData = workInfo.getOutputData();

    // Assert
    assertThat(workInfo.getState(), is(WorkInfo.State.SUCCEEDED));
    assertThat(outputData, is(input));
}

পিরিওডিক ওয়ার্ক টেস্ট করা হচ্ছে

এছাড়াও, TestDriver একটি setPeriodDelayMet প্রকাশ করে যা কোনও ইন্টারভাল সম্পূর্ণ হয়েছে কিনা তা নির্দেশ করতে ব্যবহার করা যেতে পারে। এখানে setPeriodDelayMet-এর ব্যবহারের একটি উদাহরণ দেওয়া হল।

Kotlin

@Test
@Throws(Exception::class)
fun testPeriodicWork() {
    // Define input data
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    // Create request
    val request = PeriodicWorkRequestBuilder<EchoWorker>(15, MINUTES)
        .setInputData(input)
        .build()

    val workManager = WorkManager.getInstance(myContext)
    val testDriver = WorkManagerTestInitHelper.getTestDriver()
    // Enqueue and wait for result.
    workManager.enqueue(request).result.get()
    // Tells the testing framework the period delay is met
    testDriver.setPeriodDelayMet(request.id)
    // Get WorkInfo and outputData
    val workInfo = workManager.getWorkInfoById(request.id).get()

    // Assert
    assertThat(workInfo.state, `is`(WorkInfo.State.ENQUEUED))
}

জাভা

@Test
public void testPeriodicWork() throws Exception {
    // Define input data
    Data input = new Data.Builder()
            .put(KEY_1, 1)
            .put(KEY_2, 2)
            .build();

    // Create request
    PeriodicWorkRequest request =
            new PeriodicWorkRequest.Builder(EchoWorker.class, 15, MINUTES)
            .setInputData(input)
            .build();

    WorkManager workManager = WorkManager.getInstance(myContext);
    TestDriver testDriver = WorkManagerTestInitHelper.getTestDriver();
    // Enqueue and wait for result.
    workManager.enqueue(request).getResult().get();
    // Tells the testing framework the period delay is met
    testDriver.setPeriodDelayMet(request.getId());
    // Get WorkInfo and outputData
    WorkInfo workInfo = workManager.getWorkInfoById(request.getId()).get();

    // Assert
    assertThat(workInfo.getState(), is(WorkInfo.State.ENQUEUED));
}