| import operator |
| |
| from autotest_lib.client.common_lib.cros import chip_utils |
| |
| |
| NO_ARGS = tuple() |
| ONE_INT_ARG = (1, ) |
| ONE_STR_ARG = ("foo", ) |
| SAMPLE_FILE = "/tmp/foo" |
| CHIP_FW_NAMES = (chip.fw_name for chip in chip_utils.chip_id_map.itervalues()) |
| SAMPLE_CGPT_A = { |
| "UUID": "93EF7B23-606B-014B-A10C-E9D7CF53DFD3", |
| "successful": 1, |
| "partition": 2, |
| "priority": 1, |
| "tries": 0, |
| "Type": "ChromeOS kernel", |
| } |
| SAMPLE_CGPT_B = { |
| "UUID": "C6604D6B-5563-EE4E-9915-0C50530B158A", |
| "successful": 0, |
| "partition": 4, |
| "priority": 0, |
| "tries": 15, |
| "Type": "ChromeOS kernel", |
| } |
| |
| """ |
| RPC_CATEGORIES contains all the test cases for our RPC tests. |
| Each element of RPC_CATEGORIES must be a dict containing the following keys: |
| |
| @key category_name: A string naming the RPC category, such as bios or kernel. |
| @key test_cases: A list of test cases, each of which must be a dict containing |
| the following keys: |
| @key method_name (optional): A string naming an RPC method within |
| this category. Either this key or method_names |
| is required (but not both). |
| @key method_names (optional): An array of strings naming RPC methods within |
| this category. Either this key or method_name |
| is required (but not both). |
| @key passing_args: A list of tuples, each of which could be unpacked and |
| then passed into the RPC method as a valid set of |
| parameters. Each tuple might contain instances of |
| operator.itemgetter. If so, those instances will be |
| replaced with values from firmware_FAFTRPC._stored_values |
| before being passed into the RPC method. |
| @key failing_args: A list of tuples, each of which could be unpacked and |
| then passed into the RPC method as a set of parameters |
| which should yield an RPC error. Each tuple might contain |
| instances of operator.itemgetter. If so, those instances |
| will be replaced with values from |
| firmware_FAFTRPC._stored_values before being passed into |
| the RPC method. |
| @key silence_result: Normally, the RPC return value is logged. However, if |
| this key is truthy, then the result is not logged. |
| @key allow_error_msg (optional): String representing a regex pattern. |
| If the RPC method is called with a |
| passing_args tuple, but it yields an RPC |
| error whose message is matched by |
| re.search(allow_error_msg, error_msg), |
| then the test will be considered a pass. |
| @key store_result_as (optional): String. If this field is specified, then |
| the result from the RPC call will be stored |
| in firmware_FAFTRPC._stored_values. This |
| allows us to later reference the result |
| via an operator.itemgetter, as described |
| above in the docstrings for passing_args |
| and failing_args. |
| |
| """ |
| RPC_CATEGORIES = [ |
| { |
| "category_name": "system", |
| "test_cases": [ |
| { |
| "method_names": [ |
| "is_available", |
| "get_platform_name", |
| "get_model_name", |
| "dev_tpm_present", |
| "get_root_dev", |
| "get_root_part", |
| "get_fw_vboot2", |
| "request_recovery_boot", |
| "is_removable_device_boot", |
| "get_internal_device", |
| ], |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| }, |
| { |
| "method_name": "dump_log", |
| "passing_args": [ |
| NO_ARGS, |
| (True, ), |
| (False, ), |
| ], |
| "failing_args": [ |
| (True, False), |
| ], |
| "expected_return_type": str, |
| "silence_result": True, |
| }, |
| { |
| "method_name": "run_shell_command", |
| "passing_args": [ |
| ("ls -l", ), |
| ("ls -l", False), |
| ("ls -l", True) |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ("ls", "-l", 'foo'), |
| ], |
| }, |
| { |
| "method_name": "run_shell_command_get_status", |
| "passing_args": [ |
| ("ls", ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ("ls", "-l", 'foo'), |
| ], |
| }, |
| { |
| "method_name": "run_shell_command_get_status", |
| "passing_args": [ |
| ("ls ''",), |
| ], |
| }, |
| { |
| "method_name": "run_shell_command", |
| "failing_args": [ |
| ("ls ''",), |
| ], |
| }, |
| { |
| "method_name": "run_shell_command_check_output", |
| "passing_args": [ |
| ("ls -l", "total"), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ], |
| }, |
| { |
| "method_name": "run_shell_command_get_output", |
| "passing_args": [ |
| ("ls -l", True), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ], |
| }, |
| { |
| "method_name": "get_crossystem_value", |
| "passing_args": [ |
| ("fwid", ), |
| ], |
| "failing_args": [NO_ARGS], |
| }, |
| { |
| "method_name": "set_try_fw_b", |
| "passing_args": [ |
| NO_ARGS, |
| (1, ), |
| ], |
| "failing_args": [ |
| (1, 1), |
| ], |
| }, |
| { |
| "method_name": "set_fw_try_next", |
| "passing_args": [ |
| ("A", ), |
| ("A", 1), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ("A", 1, "B"), |
| ], |
| }, |
| { |
| "method_name": "get_dev_boot_usb", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| "store_result_as": "dev_boot_usb", |
| }, |
| { |
| "method_name": "set_dev_boot_usb", |
| "passing_args": [ |
| (operator.itemgetter("dev_boot_usb"), ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| (True, False), |
| ], |
| }, |
| { |
| "method_name": "create_temp_dir", |
| "passing_args": [ |
| NO_ARGS, |
| ONE_STR_ARG, |
| ], |
| "failing_args": [ |
| ONE_INT_ARG, |
| ("foo", "bar"), |
| ], |
| "expected_return_type": str, |
| "store_result_as": "temp_dir", |
| }, |
| { |
| "method_name": "remove_file", |
| "passing_args": [ |
| (SAMPLE_FILE, ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| (1, 2), |
| ], |
| }, |
| { |
| "method_name": "remove_dir", |
| "passing_args": [ |
| (operator.itemgetter("temp_dir"), ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| (1, 2), |
| ] |
| }, |
| { |
| "method_name": "check_keys", |
| "passing_args": [ |
| ([], ), |
| ([116], ), |
| ([28, 29, 32], ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ([], [116]), |
| ], |
| "expected_return_type": int, |
| }, |
| ] |
| }, |
| { |
| "category_name": "bios", |
| "test_cases": [ |
| { |
| "method_names": [ |
| "reload", |
| ], |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG] |
| }, |
| { |
| "method_name": "get_gbb_flags", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| "expected_return_type": int, |
| "store_result_as": "gbb_flags", |
| }, |
| { |
| "method_name": "set_gbb_flags", |
| "passing_args": [ |
| (operator.itemgetter("gbb_flags"), ), |
| ], |
| "failing_args": [NO_ARGS], |
| }, |
| { |
| "method_name": "get_preamble_flags", |
| "passing_args": [ |
| ("a", ), |
| ], |
| "failing_args": [NO_ARGS, ONE_INT_ARG], |
| "store_result_as": "preamble_flags", |
| }, |
| { |
| "method_name": "set_preamble_flags", |
| "passing_args": [ |
| ("a", operator.itemgetter("preamble_flags"), ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| ONE_STR_ARG, |
| ("c", operator.itemgetter("preamble_flags"), ), |
| ], |
| }, |
| { |
| "method_names": [ |
| "get_body_sha", |
| "get_sig_sha", |
| "get_section_fwid", |
| "get_version", |
| "get_datakey_version", |
| "get_kernel_subkey_version", |
| ], |
| "passing_args": [ |
| ("a", ), |
| ("b", ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| (("a", "b"), ), |
| ("c", ), |
| ] |
| }, |
| { |
| "method_names": [ |
| "corrupt_sig", |
| "restore_sig", |
| "corrupt_body", |
| "restore_body", |
| "move_version_backward", |
| "move_version_forward", |
| ], |
| "passing_args": [ |
| ("a", ), |
| ("b", ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| ("c", ), |
| ] |
| }, |
| { |
| "method_names": [ |
| "dump_whole", |
| "write_whole", |
| ], |
| "passing_args": [ |
| (SAMPLE_FILE, ), |
| ], |
| "failing_args": [NO_ARGS], |
| }, |
| { |
| "method_name": "strip_modified_fwids", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| "expected_return_type": dict |
| }, |
| { |
| "method_name": "set_write_protect_region", |
| "passing_args": [ |
| ("WP_RO",), |
| ("WP_RO", None), |
| ("WP_RO", True), |
| ("WP_RO", False) |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| (None,), |
| ("WP_RO", None, "EXTRA") |
| ], |
| }, |
| { |
| "method_name": "get_write_protect_status", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| "expected_return_type": dict |
| } |
| ], |
| }, |
| { |
| "category_name": "ec", |
| "test_cases": [ |
| { |
| "method_names": [ |
| "reload", |
| "get_version", |
| "get_active_hash", |
| "is_efs", |
| ], |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| "allow_error_msg": "list index out of range", |
| }, |
| { |
| "method_names": [ |
| "dump_whole", |
| "write_whole", |
| "dump_firmware" |
| ], |
| "passing_args": [ |
| (SAMPLE_FILE, ), |
| ], |
| "failing_args": [NO_ARGS], |
| }, |
| { |
| "method_name": "corrupt_body", |
| "passing_args": [ |
| ("rw", ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| ("ro", ), |
| ("rw", "rw"), |
| ], |
| }, |
| { |
| "method_name": "set_write_protect", |
| "passing_args": [ |
| (True, ), |
| (False, ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| (True, False), |
| ] |
| }, |
| { |
| "method_name": "copy_rw", |
| "passing_args": [ |
| ("rw", "rw"), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ("rw", "ro"), |
| ("ro", "rw"), |
| ("rw", ), |
| ], |
| }, |
| { |
| "method_name": "reboot_to_switch_slot", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| "allow_error_msg": "CmdError", |
| }, |
| ], |
| }, |
| { |
| "category_name": "kernel", |
| "test_cases": [ |
| { |
| "method_names": [ |
| "corrupt_sig", |
| "restore_sig", |
| "move_version_backward", |
| "move_version_forward", |
| ], |
| "passing_args": [ |
| ("a", ), |
| ("b", ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| ("c", ), |
| ("a", "b"), |
| ], |
| }, |
| { |
| "method_names": [ |
| "get_version", |
| "get_datakey_version", |
| "get_sha", |
| ], |
| "passing_args": [ |
| ("a", ), |
| ("b", ), |
| ], |
| "failing_args": [ |
| (("a", "b"), ), |
| ("c", ), |
| NO_ARGS, |
| ONE_INT_ARG, |
| ], |
| }, |
| { |
| "method_name": "diff_a_b", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ |
| ONE_INT_ARG, |
| ONE_STR_ARG, |
| ], |
| "expected_return_type": bool, |
| }, |
| { |
| "method_name": "resign_with_keys", |
| "passing_args": [ |
| ("a", ), |
| ("b", ), |
| ("b", SAMPLE_FILE), |
| ], |
| "failing_args": [ |
| (("a", "b"), ), |
| ("c", ), |
| NO_ARGS, |
| ONE_INT_ARG, |
| ], |
| }, |
| { |
| "method_names": [ |
| "dump", |
| "write", |
| ], |
| "passing_args": [ |
| ("a", SAMPLE_FILE), |
| ("b", SAMPLE_FILE), |
| ], |
| "failing_args": [ |
| (("a", "b"), SAMPLE_FILE), |
| ("c", SAMPLE_FILE), |
| ("a", ), |
| NO_ARGS, |
| ] |
| } |
| ], |
| }, |
| { |
| "category_name": "tpm", |
| "test_cases": [ |
| { |
| "method_names": [ |
| "get_firmware_version", |
| "get_firmware_datakey_version", |
| "get_kernel_version", |
| "get_kernel_datakey_version", |
| "get_tpm_version", |
| "stop_daemon", |
| "restart_daemon", |
| ], |
| "passing_args": [NO_ARGS], |
| "failing_args": [ONE_INT_ARG, ONE_STR_ARG], |
| }, |
| ] |
| }, |
| { |
| "category_name": "cgpt", |
| "test_cases": [ |
| { |
| "method_name": "get_attributes", |
| "passing_args": [NO_ARGS], |
| "failing_args": [ |
| ONE_INT_ARG, |
| ONE_STR_ARG, |
| ], |
| }, |
| { |
| "method_name": "set_attributes", |
| "passing_args": [ |
| NO_ARGS, |
| (SAMPLE_CGPT_A, ), |
| (None, SAMPLE_CGPT_B), |
| (SAMPLE_CGPT_A, SAMPLE_CGPT_B), |
| (None, None), |
| ], |
| "failing_args": [ |
| (None, None, None), |
| ], |
| } |
| ] |
| }, |
| { |
| "category_name": "updater", |
| "test_cases": [ |
| # TODO (gredelston/dgoyette): |
| # Uncomment the methods which write to flash memory, |
| # once we are able to set the firmware_updater to "emulate" mode. |
| { |
| "method_names": [ |
| "cleanup", |
| "stop_daemon", |
| "start_daemon", |
| # "modify_ecid_and_flash_to_bios", |
| "get_ec_hash", |
| "reset_shellball", |
| # "run_factory_install", |
| # "run_recovery", |
| "cbfs_setup_work_dir", |
| # "cbfs_sign_and_flash", |
| "get_temp_path", |
| "get_keys_path", |
| "get_work_path", |
| "get_bios_relative_path", |
| "get_ec_relative_path" |
| ], |
| "passing_args": [ |
| NO_ARGS, |
| ], |
| "failing_args": [ |
| ONE_INT_ARG, |
| ONE_STR_ARG, |
| ], |
| "allow_error_msg": ("command cp -rf " |
| "/usr/local/tmp/faft/autest/work " |
| "/usr/local/tmp/faft/autest/cbfs failed|" |
| "Could not detect a usable ec flash device") |
| }, |
| { |
| "method_name": "get_section_fwid", |
| "passing_args": [ |
| NO_ARGS, |
| ("bios", ), |
| ("ec", ), |
| ("bios", "b"), |
| ("ec", "rw"), |
| ], |
| "failing_args": [ |
| ("foo", ), |
| ("bios", "foo"), |
| ("ec", "foo"), |
| ], |
| "expected_return_type": str, |
| "allow_error_msg": r"is empty|does not contain", |
| }, |
| { |
| "method_names": [ |
| "get_all_fwids", |
| "get_all_installed_fwids", |
| ], |
| "passing_args": [ |
| NO_ARGS, |
| ("bios", ), |
| ("ec", ), |
| ], |
| "failing_args": [ |
| ("foo", ), |
| ], |
| "expected_return_type": dict, |
| "allow_error_msg": (r"is already modified|" |
| r"is empty|" |
| r"does not contain"), |
| }, |
| { |
| "method_name": "modify_fwids", |
| "passing_args": [ |
| NO_ARGS, |
| ("bios", ), |
| ("ec", ), |
| ("bios", ("b", "rec")), |
| ("ec", ("rw_b", )), |
| ], |
| "failing_args": [ |
| ("foo", ), |
| ("bios", ("foo", )), |
| ("ec", ("foo", )), |
| ], |
| "expected_return_type": dict, |
| "allow_error_msg": (r"is already modified|" |
| r"is empty|" |
| r"does not contain"), |
| }, |
| { |
| "method_name": "resign_firmware", |
| "passing_args": [ |
| ONE_INT_ARG, |
| (None, ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_STR_ARG, |
| (1, 1), |
| ], |
| }, |
| { |
| "method_names": [ |
| "repack_shellball", |
| "extract_shellball", |
| ], |
| "passing_args": [ |
| NO_ARGS, |
| ("test", ), |
| (None, ), |
| ], |
| "failing_args": [ |
| ("foo", "bar"), |
| ] |
| }, |
| { |
| "method_name": "run_firmwareupdate", |
| "passing_args": [ |
| ("autoupdate", ), |
| ("recovery", ), |
| ("bootok", ), |
| ("factory_install", ), |
| ("bootok", None), |
| ("bootok", "test"), |
| ("bootok", "test", ()), |
| ("bootok", "test", ("--noupdate_ec", "--wp=1")), |
| ], |
| "failing_args": [NO_ARGS], |
| }, |
| { |
| "method_names": [ |
| "run_autoupdate", |
| "run_bootok", |
| ], |
| "passing_args": [ |
| ("test",), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ("foo", "bar"), |
| ], |
| }, |
| { |
| "method_names": [ |
| "cbfs_extract_chip", |
| "cbfs_get_chip_hash", |
| "cbfs_replace_chip", |
| ], |
| "passing_args": [ |
| (chip_fw_name, ) for chip_fw_name in CHIP_FW_NAMES |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| ], |
| "allow_error_msg": "cbfstool /usr/local/tmp/faft/" |
| }, |
| { |
| "method_name": "copy_bios", |
| "passing_args": [ |
| ('/tmp/fake-bios.bin', ) |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ('/tmp/fake-bios.bin', "foo") |
| ], |
| "expected_return_type": str |
| }, |
| { |
| "method_name": "get_image_gbb_flags", |
| "passing_args": [ |
| NO_ARGS, |
| ('/tmp/fake-bios.bin',) |
| ], |
| "failing_args": [ |
| ('/tmp/fake-bios.bin', 'bogus') |
| ], |
| "store_result_as": "gbb_flags" |
| }, |
| { |
| "method_name": "set_image_gbb_flags", |
| "passing_args": [ |
| (operator.itemgetter('gbb_flags'),), |
| (operator.itemgetter('gbb_flags'), '/tmp/fake-bios.bin'), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ('too', 'many', 'args') |
| ] |
| } |
| ] |
| }, |
| { |
| "category_name": "rootfs", |
| "test_cases": [ |
| { |
| "method_name": "verify_rootfs", |
| "passing_args": [ |
| ("A", ), |
| ("B", ), |
| ], |
| "failing_args": [ |
| NO_ARGS, |
| ONE_INT_ARG, |
| ("C", ), |
| ("A", "B"), |
| ], |
| }, |
| ] |
| }, |
| { |
| "category_name": '', |
| "test_cases": [ |
| # explicit connect |
| {"method_name": "quit", "passing_args": [NO_ARGS]}, |
| {"method_name": "connect", "passing_args": [NO_ARGS]}, |
| {"method_name": "ready", "passing_args": [NO_ARGS]}, |
| {"method_name": "disconnect", "passing_args": [NO_ARGS]}, |
| {"method_name": "connect", "passing_args": [NO_ARGS]}, |
| {"method_name": "ready", "passing_args": [NO_ARGS]}, |
| |
| # implicit connect |
| {"method_name": "quit", "passing_args": [NO_ARGS]}, |
| {"method_name": "ready", "passing_args": [NO_ARGS]}, |
| {"method_name": "disconnect", "passing_args": [NO_ARGS]}, |
| {"method_name": "ready", "passing_args": [NO_ARGS]}, |
| ] |
| } |
| ] |
