การสร้างการทดสอบระบบ SDV

การทดสอบระบบหมายถึงการทดสอบ SDV ใดก็ตามที่สร้างขึ้นโดยใช้เฟรมเวิร์กการทดสอบ SDV

การสร้างการทดสอบ

ตำแหน่งการทดสอบ

  • <test_repository_root>/sample_tests
  • <test_repository_root>/e2e_tests
  • <test_repository_root>/long_running_tests
  • <test_repository_root>/performance_tests
  • <test_repository_root>/hardware

ทดสอบไฟล์

  • README.md: การทดสอบทั้งหมดต้องมีคำอธิบายเกี่ยวกับวัตถุประสงค์ของการทดสอบและวิธีเรียกใช้การทดสอบ

  • ไฟล์ทดสอบ: การทดสอบทั้งหมดมีโครงสร้างที่คล้ายกัน ดังนี้

"""SDV Name Test"""

from sdv_test_fw.test_execution import sdv_base_test, sdv_test_runner

class SdvTypeNameTest(sdv_base_test.SdvBaseTestClass):

    def setup_class(self):
      # Setup code. Executed only once at the beginning of the test.
      super().setup_class()
      self.sdv_device1 = self.get_device('device1')
      self.sdv_device2 = self.get_device('device2')
      ...

    # Remove if not needed.
    def setup_test(self):
      super().setup_test()
      # Setup code. Executed before every test case.
      # Remove override if not needed.

    # Remove if not needed.
    def teardown_test(self):
      # Cleanup code. Executed after every test case.
      super().teardown_test()

    # Remove if not needed.
    def teardown_class(self):
      # Cleanup code. Executed once at the end of the test.
      super().teardown_class()

    def test_name_case1(self):
      # Test case step
      # Test case verification

    def test_name_case2(self):
      # Test case step
      # Test case verification

if __name__ == '__main__':
    # Start Test Execution Using SDV Test Framework
    sdv_test_runner.run()
  • ไฟล์บิลด์: Android.bp โครงสร้างไฟล์มีลักษณะดังนี้
python_test_host {
    name: "SdvTypeNameTest", // Should match the name of the test class.
    main: "sdv_type_name_test.py",
    srcs: [
        "sdv_type_name_test.py",
    ],
    data: [
        ":sdv_test_fw_device_configs",
    ],
    test_options: {
        unit_test: false,
    },
    defaults: [
        "sdv_test_fw_defaults",
    ],
    test_config_template: ":<DEFAULT_TEMPLATE_NAME>",
}

รูปแบบการตั้งชื่อ

หากต้องการระบุและค้นหาการทดสอบประเภทต่างๆ คุณต้องสร้างการทดสอบตามรูปแบบการตั้งชื่อที่เฉพาะเจาะจง

การทดสอบตัวอย่าง

  • ชื่อไฟล์: sdv_sample_<NAME>_test.py

  • ชื่อชั้นเรียน: SdvSampleNameTest

การทดสอบ E2E

  • ชื่อไฟล์: sdv_e2e_<NAME>_test.py

  • ชื่อชั้นเรียน: SdvE2ENameTest

การทดสอบที่ใช้เวลานาน

  • ชื่อไฟล์: sdv_long_running_<NAME>_test.py

  • ชื่อชั้นเรียน: SdvLongRunningNameTest

การทดสอบประสิทธิภาพ

  • ชื่อไฟล์: sdv_performance_<NAME>_test.py

  • ชื่อชั้นเรียน: SdvPerformanceNameTest

การทดสอบฮาร์ดแวร์

  • ชื่อไฟล์: sdv_hw_<NAME>_test.py

  • ชื่อชั้นเรียน: SdvHWNameTest

หลักเกณฑ์เกี่ยวกับโค้ด

ส่วนนี้มีหลักเกณฑ์และแนวทางปฏิบัติแนะนำสำหรับการเขียนการทดสอบระบบ SDV

Python และ Mobly

ทำความคุ้นเคยกับคู่มือสไตล์ Python และแนวทางปฏิบัติแนะนำของ Mobly รวมถึงพิจารณาคำแนะนำเฉพาะของ SDV ต่อไปนี้

  • หลีกเลี่ยงการนำเข้า Mobly โดยตรง ยกเว้นการยืนยัน เฟรมเวิร์กการทดสอบ SDV สร้างขึ้นจากเฟรมเวิร์กนี้โดยมุ่งเน้นที่ SDV

  • การยืนยัน: ใช้การยืนยัน Mobly โดยตรง

การทดสอบ SDV

ส่วนต่อไปนี้จะสรุปหลักเกณฑ์และแนวทางปฏิบัติแนะนำที่เฉพาะเจาะจงสำหรับการพัฒนาการทดสอบภายในเฟรมเวิร์กการทดสอบ SDV

การตั้งค่าและการทำความสะอาดข้อมูล

โค้ดการตั้งค่าและการล้างข้อมูลต้องอยู่นอกกรอบการทดสอบ ระบบจะเรียกใช้เมธอด Teardown แม้ว่าการทดสอบจะล้มเหลว เพื่อให้การล้างข้อมูลอุปกรณ์เป็นไปอย่างเหมาะสม

ตำแหน่งของโค้ดการตั้งค่าและการล้างข้อมูลจะขึ้นอยู่กับความต้องการเฉพาะของการทดสอบ แม้ว่าการทดสอบจะถูกขัดจังหวะก็ตาม

  1. หากต้องการเรียกใช้เพียงครั้งเดียว ที่จุดเริ่มต้นและจุดสิ้นสุดของการทดสอบทั้งหมด ให้ใช้ setup_class และ teardown_class เช่น รับอุปกรณ์ ตั้งค่าตัวแปรหรือสถานะที่ไม่เปลี่ยนแปลงระหว่างกรอบการทดสอบ กำหนดค่าพร็อพเพอร์ตี้ทั่วไปของอุปกรณ์ หรือตั้งค่าแฟล็ก
def setup_class(self):
  super().setup_class()
  # setup code

def teardown_class(self):
  # teardown code
  super().teardown_class()
  1. หากต้องการเรียกใช้ระหว่างกรอบการทดสอบ ก่อนและหลังกรอบการทดสอบแต่ละรายการ เช่น เซสชันแบบโต้ตอบหรือการดำเนินการบริการทั่วไป
def setup_test(self):
  super().setup_test()
  # setup code

def teardown_test(self):
  # teardown code
  super().teardown_test()

กรอบการทดสอบที่มีพารามิเตอร์

ใช้กรอบการทดสอบที่มีพารามิเตอร์เมื่อขั้นตอนต่างๆ เป็นเรื่องปกติในกรอบการทดสอบต่างๆ เพื่อหลีกเลี่ยงการทำโค้ดซ้ำ

from absl.testing import parameterized

@parameterized.named_parameters(
  {
      'testcase_name': 'ab',
      'input1': 'a',
      'input2': 'b',
  },
  {
      'testcase_name': 'cd',
      'input1': 'c',
      'input2': 'd',
  },
  )
  def test_name(self, input1, input2):
    # test

ตัวอย่างนี้สร้างกรอบการทดสอบ 2 รายการ ได้แก่ test_name_ab และ test_name_cd

กรอบการทดสอบ 1 รายการสำหรับการยืนยันลักษณะการทำงาน

กรอบการทดสอบควรมีขนาดกะทัดรัดและมุ่งเน้นที่ลักษณะการทำงานที่เฉพาะเจาะจง 1 อย่าง หากลักษณะการทำงานหลายอย่างมีข้อกำหนดเบื้องต้นหรือขั้นตอนที่เหมือนกัน ให้พิจารณาแยกข้อกำหนดเบื้องต้นหรือขั้นตอนเหล่านั้น คุณสามารถใช้ setup_test หรือการกำหนดพารามิเตอร์เพื่อลดจำนวนโค้ดที่ซ้ำกัน

การใช้แนวทางนี้จะทำให้การทดสอบอ่านและแก้ไขข้อบกพร่องได้ง่ายขึ้น เนื่องจากจะระบุขั้นตอนและเงื่อนไขที่ล้มเหลวอย่างชัดเจน

ตัวอย่าง
test_verify_process():
  device.start_process()

  # precondition 1
  device.send_signal1()
  # verification signal1 received
  ...

  # precondition 2
  device.send_signal2()
  # verification signal2 received
  ...

  # precondition 3
  device.start_agent()
  # verification behavior
  ...

  device.kill_process()

test_setup_test():
  super().setup_test()
  device.start_process()

test_signal1():
  # precondition
  device.send_signal1()
  # verification signal1 received
  ...

test_signal2():
  # precondition
  device.send_signal2()
  # verification signal2 received
  ...

test_agent():
  # precondition
  device.start_agent()
  # verification behavior
  ...

teardown_test():
  device.kill_process()
  super().teardown_test()

ลักษณะการทำงานของการทดสอบที่กำหนดได้

หลีกเลี่ยงการเพิ่มเงื่อนไขในการทดสอบที่แยกย่อยลักษณะการทำงาน หากต้องแยกการยืนยัน ให้ใช้กรอบการทดสอบ 2 รายการที่แตกต่างกันแทน

อย่าใช้ข้อยกเว้น

การทดสอบและตัวช่วยทั่วไปต้องใช้การยืนยันแทนข้อยกเว้น ซึ่งจะช่วยให้การแก้ไขข้อบกพร่องง่ายขึ้นและเป็นไปตามรูปแบบการทดสอบ

ตัวอย่าง
result = self.some_calculations()
if result is None:
  raise Exception("No result")

result = self.some_calculations()
self.get_test_validator().assert_is_not_none(result)
ตัวอย่าง
if not self.device.is_subprocess_running(
  self.EXPECTED_PROCESS
):
  raise Exception("Process is not running")

self.get_test_validator().assert_true(
  self.device.is_subprocess_running(self.EXPECTED_PROCESS),
  "Process is not running"
)

อย่าใช้ sleep()

หลีกเลี่ยงการใช้ sleep() เนื่องจากจะเพิ่มเวลาในการดำเนินการทดสอบและทำให้เกิดความไม่แน่นอน

เมื่อการทดสอบต้องรอให้เหตุการณ์หรือการยืนยันดำเนินการต่อ ให้ใช้วิธีการรอที่ระบุไว้ในเฟรมเวิร์กแทน

ใช้วิธีการรออย่างระมัดระวัง เนื่องจากระบบจะบล็อกการดำเนินการทดสอบไว้จนกว่าเงื่อนไขจะตรงกันหรือถึงระยะหมดเวลา

เมื่อคุณต้องรอให้เงื่อนไขเสร็จสมบูรณ์ในการทดสอบ ให้ถามคำถามต่อไปนี้

  1. ระยะหมดเวลาที่สมเหตุสมผลคือเท่าใด

    หากคาดว่าจะเกิดเหตุการณ์ภายในกรอบเวลาที่เฉพาะเจาะจง ระยะหมดเวลาควรตรงกับความคาดหวังนั้นเพื่อให้แน่ใจว่าการทดสอบจะล้มเหลวอย่างรวดเร็ว ลดระยะหมดเวลาหากจำเป็น (ค่าเริ่มต้นคือ 30 วินาที)

  2. การดำเนินการที่วิธีการรอทำมีค่าใช้จ่ายสูงเพียงใด

    หลีกเลี่ยงการเรียกใช้การดำเนินการที่มีค่าใช้จ่ายสูงบ่อยๆ เพิ่มช่วงเวลาการสำรวจหากจำเป็น (ค่าเริ่มต้นคือ 0.5 วินาที)

กรอบการทดสอบที่มีข้อกำหนด

หากการทดสอบมีกรอบการทดสอบที่มีข้อกำหนดที่ชัดเจนในการทำงาน (เช่น เป้าหมายที่ควรเรียกใช้) คุณสามารถข้ามกรอบการทดสอบเหล่านั้นได้หากไม่ตรงกับข้อกำหนด

def test_with_requirement():
  self.get_test_validator().skip_if(expr, reason)
  # Test case