เอกสารนี้อธิบายวิธีทำงานทดสอบอัตโนมัติทั่วไปให้เสร็จสมบูรณ์โดยใช้ Espresso API
Espresso API สนับสนุนให้ผู้เขียนการทดสอบคิดถึงสิ่งที่ผู้ใช้อาจทำขณะโต้ตอบกับแอปพลิเคชัน เช่น การค้นหาองค์ประกอบ UI และการโต้ตอบกับองค์ประกอบเหล่านั้น ขณะเดียวกัน เฟรมเวิร์กจะป้องกันการเข้าถึงกิจกรรมและมุมมองของแอปพลิเคชันโดยตรง เนื่องจากการเก็บออบเจ็กต์เหล่านี้ไว้และดำเนินการกับออบเจ็กต์เหล่านั้นนอกเธรด UI เป็นสาเหตุหลักที่ทำให้การทดสอบไม่เสถียร ดังนั้น คุณจะไม่เห็นเมธอดอย่าง getView() และ getCurrentActivity() ใน Espresso API
คุณยังคงดำเนินการกับมุมมองได้อย่างปลอดภัยโดยใช้คลาสย่อยของคุณเองของ ViewAction และ ViewAssertion
คอมโพเนนต์ API
องค์ประกอบหลักของ Espresso มีดังนี้
- Espresso – จุดแรกเข้าสำหรับการโต้ตอบกับมุมมอง (ผ่าน
onView()และonData()) นอกจากนี้ยังแสดง API ที่ไม่จำเป็นต้องเชื่อมโยงกับมุมมองใดๆ เช่นpressBack() - ViewMatchers – คอลเล็กชันของออบเจ็กต์ที่ใช้อินเทอร์เฟซ
Matcher<? super View>คุณสามารถส่งค่าเหล่านี้อย่างน้อย 1 ค่าไปยังเมธอดonView()เพื่อค้นหามุมมองภายในลำดับชั้นการแสดงผลปัจจุบัน - ViewActions – คอลเล็กชันของออบเจ็กต์
ViewActionที่สามารถส่งไปยังเมธอดViewInteraction.perform()เช่นclick() - ViewAssertions – คอลเล็กชันของออบเจ็กต์
ViewAssertionที่สามารถส่งผ่านเมธอดViewInteraction.check()ได้ ส่วนใหญ่แล้ว คุณจะใช้การยืนยัน `matches` ซึ่งใช้ View matcher เพื่อยืนยันสถานะของมุมมองที่เลือกในปัจจุบัน
ตัวอย่าง
// withId(R.id.my_view) is a ViewMatcher. // click() is a ViewAction. // matches(isDisplayed()) is a ViewAssertion. onView(withId(R.id.my_view)) .perform(click()) .check(matches(isDisplayed()))
ค้นหามุมมอง
ในกรณีส่วนใหญ่ เมธอด onView() จะใช้ตัวจับคู่ Hamcrest ที่คาดว่าจะตรงกับมุมมองเดียวเท่านั้นภายในลำดับชั้นการแสดงผลปัจจุบัน Matcher มีประสิทธิภาพและผู้ที่เคยใช้กับ Mockito หรือ JUnit จะคุ้นเคยเป็นอย่างดี หากคุณไม่คุ้นเคยกับ Hamcrest Matcher เราขอแนะนำให้เริ่มด้วยการดูงานนำเสนอนี้อย่างรวดเร็ว
บ่อยครั้งที่มุมมองที่ต้องการมี R.id ที่ไม่ซ้ำกัน และตัวจับคู่ withId แบบง่ายจะจำกัดการค้นหามุมมองให้แคบลง อย่างไรก็ตาม มีหลายกรณีที่ถูกต้องตามกฎหมายซึ่งคุณไม่สามารถระบุ R.id ในเวลาที่พัฒนาการทดสอบได้ เช่น มุมมองที่เฉพาะเจาะจงอาจไม่มี R.id หรือ R.id ไม่ซ้ำกัน ซึ่งอาจทำให้การทดสอบการวัดคุมตามปกติไม่เสถียรและเขียนได้ยาก เนื่องจากวิธีปกติในการเข้าถึงมุมมองด้วย findViewById() จะใช้ไม่ได้ ดังนั้น คุณอาจต้องเข้าถึงสมาชิกส่วนตัวของกิจกรรมหรือ Fragment ที่มีมุมมอง หรือค้นหาคอนเทนเนอร์ที่มี R.id ที่รู้จักและไปยังเนื้อหาสำหรับมุมมองนั้นๆ
Espresso จัดการปัญหานี้ได้อย่างหมดจดโดยให้คุณจำกัดมุมมองให้แคบลงโดยใช้ออบเจ็กต์ ViewMatcher ที่มีอยู่หรือออบเจ็กต์ที่กำหนดเองของคุณเอง
การค้นหามุมมองตาม R.id นั้นง่ายพอๆ กับการเรียกใช้ onView() ดังนี้
onView(withId(R.id.my_view))
บางครั้งค่า R.id จะใช้ร่วมกันระหว่างการดูหลายครั้ง เมื่อเกิดกรณีนี้ขึ้น การพยายามใช้ R.id บางรายการจะทำให้เกิดข้อยกเว้น เช่น AmbiguousViewMatcherException ข้อความแสดงข้อยกเว้นจะแสดงข้อความที่แสดงถึงลำดับชั้นการแสดงผลปัจจุบัน ซึ่งคุณสามารถค้นหาและดูการแสดงผลที่ตรงกับ R.id ที่ไม่ซ้ำกันได้
java.lang.RuntimeException:
androidx.test.espresso.AmbiguousViewMatcherException
This matcher matches multiple views in the hierarchy: (withId: is <123456789>)
...
+----->SomeView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=false, enabled=true,
selected=false, is-layout-requested=false, text=,
root-is-layout-requested=false, x=0.0, y=625.0, child-count=1}
****MATCHES****
|
+------>OtherView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=true, enabled=true,
selected=false, is-layout-requested=false, text=Hello!,
root-is-layout-requested=false, x=0.0, y=0.0, child-count=1}
****MATCHES****
เมื่อดูแอตทริบิวต์ต่างๆ ของมุมมอง คุณอาจพบพร็อพเพอร์ตี้ที่ระบุตัวตนได้อย่างแน่ชัด ในตัวอย่างด้านบน มุมมองหนึ่งมีข้อความ "Hello!" คุณสามารถใช้ตัวเลือกนี้เพื่อจำกัดการค้นหาให้แคบลงโดยใช้ตัวจับคู่แบบผสม ดังนี้
onView(allOf(withId(R.id.my_view), withText("Hello!")))
นอกจากนี้ คุณยังเลือกที่จะไม่กลับค่าของตัวจับคู่ได้ด้วย ดังนี้
onView(allOf(withId(R.id.my_view), not(withText("Unwanted"))))
สำหรับตัวจับคู่มุมมองทั่วไปที่ Espresso มีให้ ให้ตรวจสอบ androidx.test.espresso.matcher.ViewMatchers ใน IDE ของคุณหรือดูข้อมูลสรุปของ Espresso
ข้อควรพิจารณา
- ในแอปพลิเคชันที่ทำงานได้ดี มุมมองทั้งหมดที่ผู้ใช้โต้ตอบได้ควรมีข้อความอธิบายหรือมีคำอธิบายเนื้อหา ดูรายละเอียดเพิ่มเติมได้ที่การทำให้แอปเข้าถึงได้ง่ายขึ้น หากคุณไม่สามารถจำกัดการค้นหาให้แคบลงโดยใช้
withText()หรือwithContentDescription()ให้พิจารณาว่านี่เป็นข้อบกพร่องด้านการช่วยเหลือพิเศษ - ใช้ตัวจับคู่ที่สื่อความหมายน้อยที่สุดซึ่งค้นหามุมมองเดียวที่คุณต้องการ อย่าระบุมากเกินไปเพราะจะทำให้เฟรมเวิร์กทำงานมากกว่าที่จำเป็น ตัวอย่างเช่น หากมุมมองสามารถระบุตัวตนได้อย่างแน่ชัดด้วยข้อความ คุณไม่จำเป็นต้องระบุว่ามุมมองนั้นกำหนดได้จาก
TextViewด้วย สำหรับมุมมองจำนวนมากR.idของมุมมองควรจะเพียงพอ - หากมุมมองเป้าหมายอยู่ภายใน
AdapterViewเช่นListView,GridViewหรือSpinnerเมธอดonView()อาจไม่ทำงาน ในกรณีเหล่านี้ คุณควรใช้onData()แทน
ดำเนินการกับมุมมอง
เมื่อพบ Matcher ที่เหมาะกับมุมมองเป้าหมายแล้ว คุณจะดำเนินการอินสแตนซ์ของ ViewAction ในมุมมองนั้นได้โดยใช้เมธอด perform
เช่น หากต้องการคลิกที่มุมมอง ให้ทำดังนี้
onView(...).perform(click())
คุณสามารถดำเนินการมากกว่า 1 รายการด้วยการเรียกใช้ perform 1 ครั้ง ดังนี้
onView(...).perform(typeText("Hello"), click())
หากมุมมองที่คุณกำลังใช้งานอยู่ภายใน ScrollView (แนวตั้งหรือแนวนอน) ให้พิจารณาการดำเนินการก่อนหน้าที่กำหนดให้แสดงมุมมอง เช่น click() และ typeText() โดยใช้ scrollTo() ซึ่งจะช่วยให้มั่นใจได้ว่าระบบจะแสดงมุมมองก่อนที่จะดำเนินการอื่นๆ ต่อไป
onView(...).perform(scrollTo(), click())
สำหรับการดำเนินการกับมุมมองทั่วไปที่ Espresso มีให้ ให้ตรวจสอบ androidx.test.espresso.action.ViewActions ใน IDE หรือดูข้อมูลสรุปของ Espresso
ตรวจสอบการยืนยันมุมมอง
คุณใช้การยืนยันกับมุมมองที่เลือกอยู่ในปัจจุบันได้ด้วยเมธอด check() การยืนยันที่ใช้บ่อยที่สุดคือการยืนยัน matches() โดยใช้ออบเจ็กต์ ViewMatcher เพื่อยืนยันสถานะของมุมมองที่เลือกในปัจจุบัน
เช่น หากต้องการตรวจสอบว่ามุมมองมีข้อความ "Hello!" หรือไม่ ให้ทำดังนี้
onView(...).check(matches(withText("Hello!")))
หากต้องการยืนยันว่า "Hello!" เป็นเนื้อหาของมุมมอง การดำเนินการต่อไปนี้ถือเป็นแนวทางปฏิบัติที่ไม่ดี
// Don't use assertions like withText inside onView. onView(allOf(withId(...), withText("Hello!"))).check(matches(isDisplayed()))
ในทางกลับกัน หากต้องการยืนยันว่ามุมมองที่มีข้อความ "Hello!" ปรากฏอยู่ เช่น หลังจากเปลี่ยนแฟล็กระดับการเข้าถึงของมุมมอง โค้ดจะไม่มีปัญหา
ดูการทดสอบการยืนยันอย่างง่าย
ในตัวอย่างนี้ SimpleActivity มี Button และ TextView เมื่อคลิกปุ่ม เนื้อหาของ TextView จะเปลี่ยนเป็น "Hello Espresso!"
วิธีทดสอบด้วย Espresso มีดังนี้
คลิกปุ่ม
ขั้นตอนแรกคือการมองหาพร็อพเพอร์ตี้ที่ช่วยค้นหาปุ่ม ปุ่มใน SimpleActivity มี R.id ที่ไม่ซ้ำกันตามที่คาดไว้
onView(withId(R.id.button_simple))
วิธีคลิกมีดังนี้
onView(withId(R.id.button_simple)).perform(click())
ยืนยันข้อความ TextView
TextView ที่มีข้อความที่จะยืนยันก็มี R.id ที่ไม่ซ้ำกันด้วย ดังนี้
onView(withId(R.id.text_simple))
วิธียืนยันข้อความเนื้อหา
onView(withId(R.id.text_simple)).check(matches(withText("Hello Espresso!")))
ตรวจสอบการโหลดข้อมูลในมุมมองอะแดปเตอร์
AdapterView เป็นวิดเจ็ตประเภทพิเศษที่โหลดข้อมูลแบบไดนามิกจาก Adapter ตัวอย่างที่พบบ่อยที่สุดของ AdapterView คือ ListView ซึ่งแตกต่างจากวิดเจ็ตแบบคงที่อย่าง LinearLayout เนื่องจากระบบอาจโหลดเฉพาะส่วนย่อยขององค์ประกอบย่อย AdapterView ลงในลำดับชั้นการแสดงผลปัจจุบัน การค้นหา onView() แบบง่ายจะไม่พบมุมมองที่ไม่ได้โหลดอยู่ในปัจจุบัน
Espresso จะจัดการปัญหานี้โดยระบุจุดแรกเข้า onData() แยกต่างหาก ซึ่งสามารถโหลดรายการอะแดปเตอร์ที่เป็นปัญหาได้ก่อน โดยจะโฟกัสที่รายการดังกล่าวก่อนที่จะดำเนินการกับรายการนั้นหรือรายการย่อย
คำเตือน: การติดตั้งใช้งาน AdapterView ที่กำหนดเองอาจมีปัญหากับเมธอด onData() หากละเมิดสัญญาการรับค่า โดยเฉพาะ API getItem() ในกรณีเช่นนี้ แนวทางปฏิบัติที่ดีที่สุดคือการเปลี่ยนโครงสร้างภายในโค้ดของแอปพลิเคชัน หากทำไม่ได้ คุณสามารถใช้ AdapterViewProtocol ที่กำหนดเองที่ตรงกันได้ ดูข้อมูลเพิ่มเติมได้ที่ DataInteraction.usingAdapterViewProtocol() และตรวจสอบ androidx.test.espresso.action.AdapterViewProtocols ใน androidx.test.espresso:espresso-core
การทดสอบมุมมองอะแดปเตอร์แบบง่าย
การทดสอบง่ายๆ นี้แสดงวิธีใช้ onData() SimpleActivity มี Spinner ที่มีรายการ 2-3 รายการซึ่งแสดงถึงประเภทของเครื่องดื่มกาแฟ เมื่อเลือกรายการ จะมี TextView ที่เปลี่ยนเป็น "One %s a day!" โดยที่ %s แสดงถึงรายการที่เลือก
เป้าหมายของการทดสอบนี้คือการเปิด Spinner เลือกรายการที่เฉพาะเจาะจง และยืนยันว่า TextView มีรายการดังกล่าว เนื่องจากคลาส Spinner อิงตาม AdapterView เราขอแนะนำให้ใช้ onData() แทน onView() เพื่อจับคู่รายการ
เปิดการเลือกรายการ
onView(withId(R.id.spinner_simple)).perform(click())
เลือกรายการ
สำหรับการเลือกรายการ Spinner จะสร้าง ListView พร้อมเนื้อหา
มุมมองนี้อาจยาวมาก และองค์ประกอบอาจไม่ได้มีส่วนร่วมในลำดับชั้นการแสดงผล การใช้ onData() จะเป็นการบังคับให้องค์ประกอบที่ต้องการเข้าไปอยู่ในลำดับชั้นการแสดงผล รายการใน Spinner เป็นสตริง ดังนั้นเราจึงต้องการจับคู่รายการที่เท่ากับสตริง "Americano":
onData( allOf( `is`(instanceOf(String::class.java)), `is`("Americano") ) ).perform(click())
ยืนยันว่าข้อความถูกต้อง
onView(withId(R.id.spinnertext_simple)) .check(matches(withText(containsString("Americano"))))
การแก้ไขข้อบกพร่อง
Espresso จะให้ข้อมูลการแก้ไขข้อบกพร่องที่เป็นประโยชน์เมื่อการทดสอบไม่สำเร็จ ดังนี้
การบันทึก
Espresso จะบันทึกการดำเนินการดูทั้งหมดลงใน logcat เช่น
ViewInteraction: Performing 'single click' action on view with text: Espresso
ดูลำดับชั้น
Espresso จะพิมพ์ลำดับชั้นการแสดงผลในข้อความแสดงข้อยกเว้นเมื่อ onView() ไม่สำเร็จ
- หาก
onView()ไม่พบมุมมองเป้าหมาย ระบบจะแสดงNoMatchingViewExceptionคุณสามารถตรวจสอบลำดับชั้นการแสดงผลในสตริงข้อยกเว้นเพื่อวิเคราะห์สาเหตุที่ Matcher ไม่ตรงกับมุมมองใดๆ - หาก
onView()พบมุมมองหลายรายการที่ตรงกับ Matcher ที่ระบุ ระบบจะแสดงAmbiguousViewMatcherExceptionระบบจะพิมพ์ลำดับชั้นการแสดงผลและทำเครื่องหมายการแสดงผลทั้งหมดที่ตรงกันด้วยป้ายกำกับMATCHESดังนี้
java.lang.RuntimeException:
androidx.test.espresso.AmbiguousViewMatcherException
This matcher matches multiple views in the hierarchy: (withId: is <123456789>)
...
+----->SomeView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=false, enabled=true,
selected=false, is-layout-requested=false, text=,
root-is-layout-requested=false, x=0.0, y=625.0, child-count=1}
****MATCHES****
|
+------>OtherView{id=123456789, res-name=plus_one_standard_ann_button,
visibility=VISIBLE, width=523, height=48, has-focus=false, has-focusable=true,
window-focus=true, is-focused=false, is-focusable=true, enabled=true,
selected=false, is-layout-requested=false, text=Hello!,
root-is-layout-requested=false, x=0.0, y=0.0, child-count=1}
****MATCHES****
เมื่อต้องจัดการกับลำดับชั้นการแสดงผลที่ซับซ้อนหรือลักษณะการทำงานที่ไม่คาดคิดของวิดเจ็ต การใช้ตัวดูลำดับชั้นใน Android Studio เพื่อดูคำอธิบายจะมีประโยชน์เสมอ
คำเตือนเกี่ยวกับมุมมองอะแดปเตอร์
Espresso จะเตือนผู้ใช้เกี่ยวกับการมีอยู่ของวิดเจ็ต AdapterView เมื่อการดำเนินการ onView() แสดง NoMatchingViewException และวิดเจ็ต AdapterView ปรากฏในลำดับชั้นการแสดงผล วิธีแก้ปัญหาที่พบบ่อยที่สุดคือการใช้ onData()
ข้อความแสดงข้อยกเว้นจะมีคำเตือนพร้อมรายการมุมมองอะแดปเตอร์
คุณสามารถใช้ข้อมูลนี้เพื่อเรียกใช้ onData() เพื่อโหลดมุมมองเป้าหมาย
แหล่งข้อมูลเพิ่มเติม
ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ Espresso ในการทดสอบ Android ได้ที่แหล่งข้อมูลต่อไปนี้
ตัวอย่าง
- CustomMatcherSample:
แสดงวิธีขยาย Espresso เพื่อให้ตรงกับพร็อพเพอร์ตี้คำแนะนำของออบเจ็กต์
EditText - RecyclerViewSample:
RecyclerViewการดำเนินการสำหรับ Espresso - (เพิ่มเติม...)