टेस्ट ऐनिमेशन

Compose offers ComposeTestRule, जिसकी मदद से ऐनिमेशन के लिए टेस्ट लिखे जा सकते हैं. साथ ही, टेस्ट क्लॉक पर पूरा कंट्रोल रखा जा सकता है. इससे आपको एनिमेशन की इंटरमीडिएट वैल्यू की पुष्टि करने में मदद मिलती है. इसके अलावा, टेस्ट, ऐनिमेशन की असल अवधि से कम समय में भी पूरा हो सकता है.

ComposeTestRule, अपनी टेस्ट क्लॉक को mainClock के तौर पर दिखाता है. अपने टेस्ट कोड में घड़ी को कंट्रोल करने के लिए, autoAdvance प्रॉपर्टी को false पर सेट किया जा सकता है. जिस ऐनिमेशन को टेस्ट करना है उसे शुरू करने के बाद, advanceTimeBy की मदद से घड़ी को आगे बढ़ाया जा सकता है.

यहां ध्यान देने वाली बात यह है कि advanceTimeBy, घड़ी को तय की गई अवधि के हिसाब से ठीक-ठीक आगे नहीं बढ़ाता है. इसके बजाय, यह उसे फ़्रेम की अवधि के मल्टीप्लायर के तौर पर सबसे नज़दीकी अवधि तक राउंड अप करता है.

@get:Rule
val rule = createComposeRule()

@Test
fun testAnimationWithClock() {
    // Pause animations
    rule.mainClock.autoAdvance = false
    var enabled by mutableStateOf(false)
    rule.setContent {
        val color by animateColorAsState(
            targetValue = if (enabled) Color.Red else Color.Green,
            animationSpec = tween(durationMillis = 250)
        )
        Box(Modifier.size(64.dp).background(color))
    }

    // Initiate the animation.
    enabled = true

    // Let the animation proceed.
    rule.mainClock.advanceTimeBy(50L)

    // Compare the result with the image showing the expected result.
    // `assertAgainGolden` needs to be implemented in your code.
    rule.onRoot().captureToImage().assertAgainstGolden()
}

ऐनिमेशन टेस्ट को ऑप्टिमाइज़ करना

हाई-फ़िडेलिटी ऐनिमेशन की जांच करते समय, आपको अक्सर ऑटो-ऐडवांस सुविधा बंद करनी पड़ती है. साथ ही, यूज़र इंटरफ़ेस (यूआई) की इंटरमीडिएट स्थितियों की पुष्टि करने के लिए, फ़्रेम को मैन्युअल तरीके से देखना पड़ता है. फ़्रेम-बाय-फ़्रेम लूप के लिए, runWithoutImplicitWait तरीके का इस्तेमाल करके, अपने दावे लागू करें. स्टैंडर्ड नोड क्वेरी (जैसे कि onNodeWithTag या fetchSemanticsNode) से, अपने-आप सिंक्रनाइज़ेशन ट्रिगर होते हैं. जब क्लॉक को मैन्युअल तरीके से कंट्रोल किया जा रहा हो, तब ये क्वेरी काम की नहीं होती हैं. इसलिए, इन्हें बायपास करने से टेस्ट रनटाइम में काफ़ी तेज़ी आती है.

इस्तेमाल करने के दिशा-निर्देश

  • मैन्युअल तरीके से क्लॉक मैनेज करना: इस एपीआई का इस्तेमाल तब करें, जब mainClock.autoAdvance को false पर सेट किया गया हो और यूज़र इंटरफ़ेस (यूआई), मौजूदा फ़्रेम के लिए जानी-पहचानी और स्थिर स्थिति में हो.
  • यूज़र इंटरफ़ेस (यूआई) थ्रेड का एक्ज़ीक्यूशन: यूज़र इंटरफ़ेस (यूआई) ट्री की स्थिरता बनाए रखने के लिए, यूज़र इंटरफ़ेस (यूआई) थ्रेड पर runWithoutImplicitWait को कॉल करें. जैसे, runOnUiThread के साथ. इसे यूज़र इंटरफ़ेस (यूआई) थ्रेड से बाहर चलाने पर, आपके टेस्ट में रेस कंडिशन और पुरानी जानकारी को पढ़ने की समस्याएं आ सकती हैं.
  • सिर्फ़ पढ़ने के लिए उपलब्ध दावे: ब्लॉक में सिर्फ़ पढ़ने के लिए उपलब्ध दावे होने चाहिए. स्टेट में बदलाव करने वाली सभी कार्रवाइयां, इस ब्लॉक के बाहर की जानी चाहिए.

उदाहरण

@Test
fun runWithoutImplicitWaitSample() = runComposeUiTest {
    setContent { MainScreen() }
    mainClock.autoAdvance = false

    // Trigger an animation
    onNodeWithText("Start Animation").performClick()

    // Step through the animation frame-by-frame
    while (hasPendingWork()) {
        mainClock.advanceTimeByFrame()
        waitForIdle()
        runOnUiThread {
            // Suppress implicit synchronization inside this block to avoid redundant
            // waits on each node query, making the frame assertions execute much faster.
            runWithoutImplicitWait {
                val box1 = onNodeWithTag("Box1").fetchSemanticsNode()
                val box2 = onNodeWithTag("Box2").fetchSemanticsNode()
                val box3 = onNodeWithTag("Box3").fetchSemanticsNode()

                // Assert the exact intermediate state of all three properties for this frame
                assert(box1.boundsInRoot.right <= box2.boundsInRoot.left)
                assert(box2.boundsInRoot.right <= box3.boundsInRoot.left)
            }
        }
    }
}