Robolectric — คืออะไร หลักการทำงาน และการทดสอบหน่วย Android

Robolectric คืออะไร

Robolectric เป็นเฟรมเวิร์กโอเพนซอร์สที่สร้างขึ้นในปี 2010 เพื่อเร่งการทดสอบแอปพลิเคชัน Android แทนที่จะทำงานบนโปรแกรมจำลองหรืออุปกรณ์ Robolectric มอบการใช้งานเงาของคลาส Android SDK ที่ทำงานโดยตรงบนเครื่องเสมือน Java (JVM) ซึ่งช่วยให้เรียกใช้การทดสอบนับพันรายการได้ภายในไม่กี่วินาที

ปัญหาที่ Robolectric แก้ไข

การทดสอบ Android แบบดั้งเดิมต้องเรียกใช้แอปพลิเคชันบนโปรแกรมจำลอง ซึ่งใช้เวลา 3–10 นาทีในการสร้าง APK ติดตั้ง และเริ่มต้น Robolectric ขจัดขั้นตอนนี้: การทดสอบจะถูกคอมไพล์เป็นการทดสอบ Java/Kotlin ปกติและเรียกใช้ผ่าน JUnit ซึ่งให้รอบการตอบกลับภายในไม่กี่วินาทีแทนที่จะเป็นนาที

เวอร์ชัน Android ที่รองรับ

Robolectric รองรับทุกเวอร์ชัน Android ตั้งแต่ API 16 (Android 4.1) จนถึงรุ่นเสถียรล่าสุด สำหรับแต่ละเวอร์ชันจะมีชุดวัตถุเงาที่เกี่ยวข้องซึ่งจำลองพฤติกรรมของเวอร์ชันแพลตฟอร์มที่กำลังทดสอบแอปพลิเคชัน

สถาปัตยกรรมและวัตถุเงา

สถาปัตยกรรมของ Robolectric อาศัยกลไกการสกัดกั้นการเรียกผ่านการแทนที่ตัวโหลดคลาส เมื่อการทดสอบเรียกเมธอด Android SDK Robolectric จะสกัดกั้นการเรียกและส่งต่อไปยังวัตถุเงา วัตถุเงาคือคลาส Java ที่เลียนแบบพฤติกรรมจริงของส่วนประกอบ Android แต่ทำงานโดยไม่มีแพลตฟอร์มดั้งเดิม

เงาทำงานอย่างไร

วัตถุเงาใช้เมธอดหลักของคลาส Android ดั้งเดิม ตัวอย่างเช่น ShadowTextView เลียนแบบเมธอดเช่น getText(), setText(), getCurrentTextColor() และอื่น ๆ เมื่อเรียก textView.setText("สวัสดี") เงาจะบันทึกสตริงและส่งคืนเมื่อเรียก getText() สิ่งนี้แยกการทดสอบจากการเรนเดอร์จริงและบริการของระบบ

ลำดับชั้นของเงา

Robolectric รองรับคลาสเงามากกว่า 200 คลาสที่ครอบคลุมส่วนประกอบหลักของ Android SDK: Activity, Fragment, TextView, Button, RecyclerView, WebView, LocationManager, ConnectivityManager และอื่น ๆ อีกมากมาย วัตถุเงาทำตามลำดับชั้นการสืบทอดเดียวกันกับคลาส Android ดั้งเดิม

การติดตั้งและกำหนดค่า Robolectric

การติดตั้ง Robolectric ในโปรเจกต์ Gradle ต้องเพิ่มการพึ่งพา testImplementation "org.robolectric:robolectric:4.x" นอกจากนี้ยังต้องระบุการกำหนดค่าandroidsdk ในไฟล์ build.gradle และเพิ่มความละเอียด android:testInstrumentationRunner ไม่จำเป็นต้องใช้ปลั๊กอินการทดสอบ Android เพื่อทำงานกับ Robolectric

การกำหนดค่า Gradle พื้นฐาน

หลังจากเพิ่มการพึ่งพา ต้องกำหนดค่าไดเรกทอรีสำหรับ manifset ทรัพยากรและสินทรัพย์ Robolectric จะค้นหา AndroidManifest.xml โดยอัตโนมัติ แต่อาจต้องระบุเส้นทางด้วยตนเองผ่านคำอธิบายประกอบ@Config หรือคุณสมบัติของระบบ สำหรับโปรเจกต์หลายโมดูล การกำหนดค่าจะถูกตั้งค่าแยกกันสำหรับแต่ละโมดูล

// build.gradle — การกำหนดค่า Robolectric
android {
    testOptions {
        unitTests.includeAndroidResources = true
        unitTests.all {
            systemProperty 'robolectric.dependency.dir',
                project.rootDir.absolutePath + '/build/intermediates'
        }
    }
}

dependencies {
    testImplementation 'org.robolectric:robolectric:4.13'
    testImplementation 'org.junit.jupiter:junit-jupiter:5.10.0'
}

คำอธิบายประกอบ @Config

คำอธิบายประกอบ@Config อนุญาตให้แทนที่พารามิเตอร์การทดสอบ: sdk (เวอร์ชัน API), manifest (เส้นทางไปยัง manifset), qualifiers (การกำหนดค่าหน้าจอ, ภาษา) สิ่งนี้มีประโยชน์สำหรับการทดสอบพฤติกรรมของแอปพลิเคชันบนเวอร์ชัน Android ที่แตกต่างกัน การวางแนวหน้าจอ และการแปลภาษา

การเขียนทดสอบด้วย Robolectric

การทดสอบ Robolectric เขียนเป็นการทดสอบหน่วยปกติด้วย @RunWith(RobolectricTestRunner.class) สำหรับ JUnit 4 หรือผ่าน RobolectricExtension สำหรับ JUnit 5 ActivityController จัดการวงจรชีวิตของ Activity: create(), start(), resume(), pause(), stop(), destroy() ซึ่งช่วยให้ทดสอบการเปลี่ยนสถานะแต่ละครั้งโดยละเอียด

การทดสอบ Activity

ในการทดสอบ Activity ให้ใช้ ActivityController ซึ่งจะผ่านขั้นตอนวงจรชีวิตตามลำดับ การเข้าถึง Activity ทำได้ผ่าน controller.get() ส่วนประกอบมุมมองทั้งหมดเข้าถึงได้ผ่าน findViewById เช่นเดียวกับในแอปพลิเคชันจริง วัตถุเงาช่วยให้ตรวจสอบข้อความ การมองเห็น สี และคุณลักษณะอื่น ๆ ของมุมมอง

@RunWith(RobolectricTestRunner.class)
@Config(sdk = BuildConfig.SDK_INT)
public class MainActivityTest {

    @Test
    public void testActivityDisplaysGreeting() {
        ActivityController<MainActivity> controller =
            Robolectric.buildActivity(MainActivity.class);
        controller.create().start().resume();

        MainActivity activity = controller.get();
        TextView greeting = activity.findViewById(R.id.greeting);
        ShadowTextView shadow = Shadows.shadowOf(greeting);

        assertEquals("Welcome!", shadow.getText());
    }
}

การทดสอบ Intent และการนำทาง

Robolectric สกัดกั้นการเรียก startActivity() และอนุญาตให้ตรวจสอบ intent ที่ส่งผ่าน ShadowActivity ซึ่งทำให้สามารถทดสอบการนำทาง: ตรวจสอบว่าเมื่อคลิกปุ่ม Intent ถูกส่งด้วย Action, Data และพารามิเตอร์ Extra ที่ถูกต้อง

@Test
public void testNavigationToDetails() {
    controller.create().start().resume();
    MainActivity activity = controller.get();

    activity.findViewById(R.id.detailsButton).performClick();

    ShadowActivity shadowActivity = Shadows.shadowOf(activity);
    Intent intent = shadowActivity.getNextStartedActivity();
    assertEquals(
        DetailsActivity.class.getName(),
        intent.getComponent().getClassName()
    );
}

Robolectric กับโปรแกรมจำลอง

Robolectric และโปรแกรมจำลองแก้ปัญหางานที่แตกต่างกัน Robolectric เหมาะสำหรับการทดสอบหน่วยที่รวดเร็ว การตรวจสอบตรรกะ UI ส่วนประกอบทางธุรกิจและพื้นที่เก็บข้อมูล โปรแกรมจำลองจำเป็นสำหรับการทดสอบเครื่องมือ การตรวจสอบการรวมกับ API การทดสอบกล้อง เซ็นเซอร์ และประสิทธิภาพ

การทดสอบ ViewModel และ Repository

Robolectric เหมาะอย่างยิ่งสำหรับการทดสอบ ViewModel, Repository และ UseCase — ส่วนประกอบที่ใช้ Android SDK แต่ไม่ต้องการ UI จริง ViewModel ถูกทดสอบผ่านการทดสอบ JUnit ปกติด้วย RobolectricExtension ในขณะที่ส่วนประกอบวงจรชีวิต (LiveData, StateFlow) ทำงานในสภาพแวดล้อมเงาโดยไม่ต้องใช้ mock

การทดสอบ LiveData

Robolectric รองรับ LiveData ทันที: คุณสามารถสมัครรับ LiveData ในการทดสอบ เปลี่ยนสถานะผ่าน ViewModel และตรวจสอบค่าที่ส่งออก สำหรับการทำงานแบบอะซิงโครนัส จะใช้ InstantTaskExecutorRule หรือ runBlocking สำหรับ coroutine ซึ่งช่วยลดความจำเป็นในการจำลองส่วนประกอบทางสถาปัตยกรรม

@RunWith(RobolectricTestRunner::class)
@Config(sdk = [BuildConfig.SDK_INT])
class ProfileViewModelTest {

    private val repository = FakeUserRepository()
    private val viewModel = ProfileViewModel(repository)

    @Test
    fun `loading profile sets state to success`() = runBlocking {
        viewModel.loadProfile("user123")
        val state = viewModel.profileState.getOrAwaitValue()
        Assertions.assertTrue(state is UiState.Success)
    }
}

วัตถุเงาที่กำหนดเอง

หากวัตถุเงามาตรฐานของ Robolectric ไม่ครอบคลุมคลาส Android SDK ที่ต้องการ คุณสามารถสร้างเงาที่กำหนดเองได้ โดยสร้างคลาสด้วยคำอธิบายประกอบ @Implements(ClassName.class) และใช้เมธอดที่ต้องการด้วย @Implementation เงาที่กำหนดเองจะถูกลงทะเบียนผ่าน @Config(shadows = [CustomShadow::class])

การทดสอบ ContentProvider และทรัพยากร

Robolectric รองรับการทดสอบ ContentProvider ผ่าน Robolectric.buildContentProvider() คุณสามารถตรวจสอบการดำเนินการ CRUD, การสอบถามด้วยการจับคู่ URI และการจัดการสิทธิ์การเข้าถึง ทรัพยากร (สตริง สี ขนาด) ยังเข้าถึงได้ผ่าน RuntimeEnvironment.application.resources ซึ่งช่วยให้ทดสอบโค้ดที่ขึ้นอยู่กับทรัพยากร

การย้ายจากโปรแกรมจำลองไปยัง Robolectric

การเปลี่ยนจากการทดสอบเครื่องมือไปยัง Robolectric ต้องการการเปลี่ยนแปลงแนวทาง การทดสอบเครื่องมือ (AndroidJUnit4) ตรวจสอบพฤติกรรมจริงบนโปรแกรมจำลอง ในขณะที่ Robolectric ตรวจสอบตรรกะที่แยกออกมาในสภาพแวดล้อมเงา แนะนำให้ครอบคลุมตรรกะทางธุรกิจด้วยการทดสอบ Robolectric และปล่อยให้การทดสอบเครื่องมือสำหรับสถานการณ์การรวม

การปรับการทดสอบที่มีอยู่

เมื่อย้าย ต้อง: แทนที่ AndroidJUnit4 ด้วย RobolectricTestRunner, เพิ่ม @Config ด้วยเวอร์ชัน SDK เป้าหมาย, แทนที่ ActivityTestRule ด้วย ActivityController และย้ายการพึ่งพาจาก androidTestImplementation ไปยัง testImplementation Mock (MockK, Mockito) ทำงานกับ Robolectric โดยไม่มีการเปลี่ยนแปลง — ไม่ขึ้นกับแพลตฟอร์ม

ข้อจำกัดในการย้าย

Robolectric ไม่รองรับ: การทดสอบกล้อง (CameraX), NFC, Bluetooth, การตรวจสอบไบโอเมตริก, การทำงานกับไฟล์จริงและไลบรารีดั้งเดิม สถานการณ์เหล่านี้ต้องการการทดสอบเครื่องมือบนโปรแกรมจำลอง Robolectric ไม่สร้างการเรนเดอร์จริงขึ้นมาใหม่เช่นกัน — การทดสอบเลย์เอาต์ควรทำผ่าน Compose Test Rule หรือ Espresso อย่างไรก็ตาม สำหรับการตรวจสอบตรรกะทางธุรกิจ การนำทาง และสถานะ ViewModel Robolectric แทนที่โปรแกรมจำลองอย่างสมบูรณ์ด้วยความเร็วที่เร็วกว่า 10 เท่า

ความเข้ากันได้กับเวอร์ชัน Java และ Kotlin

Robolectric ต้องการ JDK 11 ขึ้นไปและเข้ากันได้กับ AGP (Android Gradle Plugin) ตั้งแต่ 7.0 จนถึงเวอร์ชันเสถียรล่าสุด ตัวจัดการ SDK ของ Robolectric ดาวน์โหลดเวอร์ชัน Android API ที่จำเป็นโดยอัตโนมัติเมื่อเรียกใช้ครั้งแรก — เป็นการดำเนินการครั้งเดียว สำหรับเซิร์ฟเวอร์ CI แนะนำให้โหลด SDK ล่วงหน้าผ่าน sdkmanager เพื่อหลีกเลี่ยงความล่าช้าในการเรียกใช้การทดสอบครั้งแรก การอัปเดต Robolectric เป็นเวอร์ชันใหม่มักไม่ต้องการการเปลี่ยนแปลงโค้ดทดสอบ เพียงอัปเดตหมายเลขการพึ่งพาใน build.gradle

การรวมกับ MockK และ Mockito

Robolectric เข้ากันได้กับเฟรมเวิร์กการจำลองยอดนิยม: MockK สำหรับ Kotlin และ Mockito สำหรับ Java Mock ใช้สำหรับแยกการพึ่งพา: ที่เก็บข้อมูล, ไคลเอ็นต์ API, SharedPreferences กฎหลักคือไม่จำลองคลาส Android SDK — มีวัตถุเงาสำหรับสิ่งนั้น จำลองเฉพาะเลเยอร์แอปพลิเคชัน: UseCase, Repository, DataSource และส่วนประกอบตรรกะทางธุรกิจอื่น ๆ การรวมกันของวัตถุเงาและ mock นี้ให้ความยืดหยุ่นสูงสุดด้วยความพยายามในการเขียนทดสอบน้อยที่สุด