Test Script APIs
The following functions are available to test scripts.
FIXTHIS - core functions: should document which of the functions are internal, and which are intended for test script use
list of routines (by providing script) [edit section]
from functions.sh
- bench_processing - do log processing for benchmark tests
- build - internal - perform the 'build' phase of test execution
- function_build_cleanup - internal -
- build_error - to be used externally - report an error and abort the test
- check_capability - check to see if the target has the specified capability
- cmd - to be used externally - execute a command on the target
- concurrent_check - wait for other test to complete before proceeding
- deploy - internal - perform the 'deploy phase of test execution
- dump_syslogs - dump the syslogs for the target under test
- fail_check_cases
- firmware - get the firmware name from the target
- get - to be used externally - get a file or files from the target
- get_testlog
- hd_test_mount_prepare
- hd_test_clean_umount
- is_empty - fail if an environment variable is empty
- kill_procs - kill process on the target
- log_compare - to be used by scripts (specifically by test_processing)
- pre_build - internal
- pre_deploy - internal
- pre_test
- post_build - internal
- post_deploy - internal
- post_test
- put - to be used externally - put a file or files on the target
- report - to be used externally - execute command and put stdout into log
- report_append - to be used externally - execute command and append stdout to log
- report_devlog
- safe_cmd - to be used externally
- syslog_cmp
- target_cleanup
- target_reboot - reboot the target
- target_setup_route_to_host
- unpack - internal - used to unpack the test program source tarball
from common.sh
- abort_job - abort the current test, emitting a reason string to output
- assert_define - to be used externally - check that an environment variable is defined
- run_python
from reports.sh
from overlays.sh
- set_overlay_vars - internal - process overlays and set variables for board, platform, test plan and test specs
FIXTHIS - need to document the ov_* functions as well, from the scripts in the engine/overlays/base directory.
From base-distrib.fuegoclass:
- ov_get_firmware
- ov_rootfs_reboot
- ov_rootfs_state
- ov_logger
- ov_rootfs_sync
- ov_rootfs_drop_caches
- ov_rootfs_oom
- ov_rootfs_kill
- ov_rootfs_logread
From base-board.fuegoclass:
From base-funcs.fuegoclass: