= NAME =
snapshot

= SYNOPSIS =
 * deploy

= DESCRIPTION =
The snapshot function performs the 'snapshot' phase for a particular test.

It calls creates the snapshot file (which is named machine-snapshot.txt
in the run directory for this a run), and by default puts the host environment
and board firmware into it.

If fuego_test.sh defines a [[function_test_snapshot|test_snapshot]] function, that routine is called
to populate the snapshot file.  Otherwise [[function_ov_rootfs_state|ov_rootfs_state]] is called to
populate the snapshot file.

= EXAMPLES =

= ENVIRONMENT and ARGUMENTS =
exports $SNAPSHOT_FILENAME

= RETURN =
returns 0 on success

= SOURCE =
Located in ''scripts/functions.sh''

= SEE ALSO =
 * [[function test_snapshot|test_snapshot]], [[function_ov_rootfs_state|ov_rootfs_state]]