3 ## Copyright (c) 2014 The WebM project authors. All Rights Reserved.
5 ## Use of this source code is governed by a BSD-style license
6 ## that can be found in the LICENSE file in the root of the source
7 ## tree. An additional intellectual property rights grant can be found
8 ## in the file PATENTS. All contributing project authors may
9 ## be found in the AUTHORS file in the root of the source tree.
11 ## This file contains shell code shared by test scripts for libvpx tools.
13 # Use $VPX_TEST_TOOLS_COMMON_SH as a pseudo include guard.
14 if [ -z "${VPX_TEST_TOOLS_COMMON_SH}" ]; then
15 VPX_TEST_TOOLS_COMMON_SH=included
18 devnull='> /dev/null 2>&1'
26 if [ "${VPX_TEST_VERBOSE_OUTPUT}" = "yes" ]; then
31 # Sets $VPX_TOOL_TEST to the name specified by positional parameter one.
36 # Clears the VPX_TOOL_TEST variable after confirming that $VPX_TOOL_TEST matches
37 # positional parameter one.
39 if [ "$1" != "${VPX_TOOL_TEST}" ]; then
40 echo "FAIL completed test mismatch!."
41 echo " completed test: ${1}"
42 echo " active test: ${VPX_TOOL_TEST}."
45 VPX_TOOL_TEST='<unset>'
48 # Echoes the target configuration being tested.
49 test_configuration_target() {
50 vpx_config_mk="${LIBVPX_CONFIG_PATH}/config.mk"
51 # Find the TOOLCHAIN line, split it using ':=' as the field separator, and
52 # print the last field to get the value. Then pipe the value to tr to consume
53 # any leading/trailing spaces while allowing tr to echo the output to stdout.
54 awk -F ':=' '/TOOLCHAIN/ { print $NF }' "${vpx_config_mk}" | tr -d ' '
57 # Trap function used for failure reports and tool output directory removal.
58 # When the contents of $VPX_TOOL_TEST do not match the string '<unset>', reports
59 # failure of test stored in $VPX_TOOL_TEST.
61 if [ -n "${VPX_TOOL_TEST}" ] && [ "${VPX_TOOL_TEST}" != '<unset>' ]; then
62 echo "FAIL: $VPX_TOOL_TEST"
64 if [ -n "${VPX_TEST_OUTPUT_DIR}" ] && [ -d "${VPX_TEST_OUTPUT_DIR}" ]; then
65 rm -rf "${VPX_TEST_OUTPUT_DIR}"
69 # Echoes the git hash portion of the VERSION_STRING variable defined in
70 # $LIBVPX_CONFIG_PATH/config.mk to stdout, or the version number string when
71 # no git hash is contained in VERSION_STRING.
73 vpx_config_mk="${LIBVPX_CONFIG_PATH}/config.mk"
74 # Find VERSION_STRING line, split it with "-g" and print the last field to
75 # output the git hash to stdout.
76 vpx_version=$(awk -F -g '/VERSION_STRING/ {print $NF}' "${vpx_config_mk}")
77 # Handle two situations here:
78 # 1. The default case: $vpx_version is a git hash, so echo it unchanged.
79 # 2. When being run a non-dev tree, the -g portion is not present in the
80 # version string: It's only the version number.
81 # In this case $vpx_version is something like 'VERSION_STRING=v1.3.0', so
82 # we echo only what is after the '='.
83 echo "${vpx_version##*=}"
86 # Echoes the short form of the current git hash.
88 if git --version > /dev/null 2>&1; then
89 (cd "$(dirname "${0}")"
90 git rev-parse --short HEAD)
92 # Return the config hash if git is unavailable: Fail silently, git hashes
93 # are used only for warnings.
98 # Echoes warnings to stdout when git hash in vpx_config.h does not match the
101 hash_at_configure_time=$(config_hash)
102 hash_now=$(current_hash)
104 if [ "${hash_at_configure_time}" != "${hash_now}" ]; then
105 echo "Warning: git hash has changed since last configure."
109 # $1 is the name of an environment variable containing a directory name to
112 local dir=$(eval echo "\${$1}")
113 if [ ! -d "${dir}" ]; then
114 elog "'${dir}': No such directory"
115 elog "The $1 environment variable must be set to a valid directory."
120 # This script requires that the LIBVPX_BIN_PATH, LIBVPX_CONFIG_PATH, and
121 # LIBVPX_TEST_DATA_PATH variables are in the environment: Confirm that
122 # the variables are set and that they all evaluate to directory paths.
123 verify_vpx_test_environment() {
124 test_env_var_dir "LIBVPX_BIN_PATH" \
125 && test_env_var_dir "LIBVPX_CONFIG_PATH" \
126 && test_env_var_dir "LIBVPX_TEST_DATA_PATH"
129 # Greps vpx_config.h in LIBVPX_CONFIG_PATH for positional parameter one, which
130 # should be a LIBVPX preprocessor flag. Echoes yes to stdout when the feature
132 vpx_config_option_enabled() {
133 vpx_config_option="${1}"
134 vpx_config_file="${LIBVPX_CONFIG_PATH}/vpx_config.h"
135 config_line=$(grep "${vpx_config_option}" "${vpx_config_file}")
136 if echo "${config_line}" | egrep -q '1$'; then
141 # Echoes yes when output of test_configuration_target() contains win32 or win64.
142 is_windows_target() {
143 if test_configuration_target \
144 | grep -q -e win32 -e win64 > /dev/null 2>&1; then
149 # Echoes path to $1 when it's executable and exists in ${LIBVPX_BIN_PATH}, or an
150 # empty string. Caller is responsible for testing the string once the function
153 local readonly tool_name="$1"
154 local tool_path="${LIBVPX_BIN_PATH}/${tool_name}${VPX_TEST_EXE_SUFFIX}"
155 if [ ! -x "${tool_path}" ]; then
156 # Try one directory up: when running via examples.sh the tool could be in
157 # the parent directory of $LIBVPX_BIN_PATH.
158 tool_path="${LIBVPX_BIN_PATH}/../${tool_name}${VPX_TEST_EXE_SUFFIX}"
161 if [ ! -x "${tool_path}" ]; then
167 # Echoes yes to stdout when the file named by positional parameter one exists
168 # in LIBVPX_BIN_PATH, and is executable.
169 vpx_tool_available() {
171 local tool="${LIBVPX_BIN_PATH}/${tool_name}${VPX_TEST_EXE_SUFFIX}"
172 [ -x "${tool}" ] && echo yes
175 # Echoes yes to stdout when vpx_config_option_enabled() reports yes for
176 # CONFIG_VP8_DECODER.
177 vp8_decode_available() {
178 [ "$(vpx_config_option_enabled CONFIG_VP8_DECODER)" = "yes" ] && echo yes
181 # Echoes yes to stdout when vpx_config_option_enabled() reports yes for
182 # CONFIG_VP8_ENCODER.
183 vp8_encode_available() {
184 [ "$(vpx_config_option_enabled CONFIG_VP8_ENCODER)" = "yes" ] && echo yes
187 # Echoes yes to stdout when vpx_config_option_enabled() reports yes for
188 # CONFIG_VP9_DECODER.
189 vp9_decode_available() {
190 [ "$(vpx_config_option_enabled CONFIG_VP9_DECODER)" = "yes" ] && echo yes
193 # Echoes yes to stdout when vpx_config_option_enabled() reports yes for
194 # CONFIG_VP9_ENCODER.
195 vp9_encode_available() {
196 [ "$(vpx_config_option_enabled CONFIG_VP9_ENCODER)" = "yes" ] && echo yes
199 # Echoes yes to stdout when vpx_config_option_enabled() reports yes for
201 webm_io_available() {
202 [ "$(vpx_config_option_enabled CONFIG_WEBM_IO)" = "yes" ] && echo yes
205 # Filters strings from $1 using the filter specified by $2. Filter behavior
206 # depends on the presence of $3. When $3 is present, strings that match the
207 # filter are excluded. When $3 is omitted, strings matching the filter are
209 # The filtered result is echoed to stdout.
215 if [ -n "${exclude}" ]; then
216 # When positional parameter three exists the caller wants to remove strings.
217 # Tell grep to invert matches using the -v argument.
223 if [ -n "${filter}" ]; then
224 for s in ${strings}; do
225 if echo "${s}" | egrep -q ${exclude} "${filter}" > /dev/null 2>&1; then
226 filtered_strings="${filtered_strings} ${s}"
230 filtered_strings="${strings}"
232 echo "${filtered_strings}"
235 # Runs user test functions passed via positional parameters one and two.
236 # Functions in positional parameter one are treated as environment verification
237 # functions and are run unconditionally. Functions in positional parameter two
238 # are run according to the rules specified in vpx_test_usage().
240 local env_tests="verify_vpx_test_environment $1"
241 local tests_to_filter="$2"
242 local test_name="${VPX_TEST_NAME}"
244 if [ -z "${test_name}" ]; then
245 test_name="$(basename "${0%.*}")"
248 if [ "${VPX_TEST_RUN_DISABLED_TESTS}" != "yes" ]; then
249 # Filter out DISABLED tests.
250 tests_to_filter=$(filter_strings "${tests_to_filter}" ^DISABLED exclude)
253 if [ -n "${VPX_TEST_FILTER}" ]; then
254 # Remove tests not matching the user's filter.
255 tests_to_filter=$(filter_strings "${tests_to_filter}" ${VPX_TEST_FILTER})
258 # User requested test listing: Dump test names and return.
259 if [ "${VPX_TEST_LIST_TESTS}" = "yes" ]; then
260 for test_name in $tests_to_filter; do
266 # Don't bother with the environment tests if everything else was disabled.
267 [ -z "${tests_to_filter}" ] && return
269 # Combine environment and actual tests.
270 local tests_to_run="${env_tests} ${tests_to_filter}"
275 for test in ${tests_to_run}; do
283 local tested_config="$(test_configuration_target) @ $(current_hash)"
284 echo "${test_name}: Done, all tests pass for ${tested_config}."
289 Usage: ${0##*/} [arguments]
290 --bin-path <path to libvpx binaries directory>
291 --config-path <path to libvpx config directory>
292 --filter <filter>: User test filter. Only tests matching filter are run.
293 --run-disabled-tests: Run disabled tests.
294 --help: Display this message and exit.
295 --test-data-path <path to libvpx test data directory>
296 --show-program-output: Shows output from all programs being tested.
297 --prefix: Allows for a user specified prefix to be inserted before all test
298 programs. Grants the ability, for example, to run test programs
300 --list-tests: List all test names and exit without actually running tests.
301 --verbose: Verbose output.
303 When the --bin-path option is not specified the script attempts to use
304 \$LIBVPX_BIN_PATH and then the current directory.
306 When the --config-path option is not specified the script attempts to use
307 \$LIBVPX_CONFIG_PATH and then the current directory.
309 When the -test-data-path option is not specified the script attempts to use
310 \$LIBVPX_TEST_DATA_PATH and then the current directory.
314 # Returns non-zero (failure) when required environment variables are empty
316 vpx_test_check_environment() {
317 if [ -z "${LIBVPX_BIN_PATH}" ] || \
318 [ -z "${LIBVPX_CONFIG_PATH}" ] || \
319 [ -z "${LIBVPX_TEST_DATA_PATH}" ]; then
324 # Parse the command line.
325 while [ -n "$1" ]; do
332 LIBVPX_CONFIG_PATH="$2"
339 --run-disabled-tests)
340 VPX_TEST_RUN_DISABLED_TESTS=yes
347 LIBVPX_TEST_DATA_PATH="$2"
355 VPX_TEST_VERBOSE_OUTPUT=yes
357 --show-program-output)
361 VPX_TEST_LIST_TESTS=yes
371 # Handle running the tests from a build directory without arguments when running
372 # the tests on *nix/macosx.
373 LIBVPX_BIN_PATH="${LIBVPX_BIN_PATH:-.}"
374 LIBVPX_CONFIG_PATH="${LIBVPX_CONFIG_PATH:-.}"
375 LIBVPX_TEST_DATA_PATH="${LIBVPX_TEST_DATA_PATH:-.}"
377 # Create a temporary directory for output files, and a trap to clean it up.
378 if [ -n "${TMPDIR}" ]; then
379 VPX_TEST_TEMP_ROOT="${TMPDIR}"
380 elif [ -n "${TEMPDIR}" ]; then
381 VPX_TEST_TEMP_ROOT="${TEMPDIR}"
383 VPX_TEST_TEMP_ROOT=/tmp
386 VPX_TEST_OUTPUT_DIR="${VPX_TEST_TEMP_ROOT}/vpx_test_$$"
388 if ! mkdir -p "${VPX_TEST_OUTPUT_DIR}" || \
389 [ ! -d "${VPX_TEST_OUTPUT_DIR}" ]; then
390 echo "${0##*/}: Cannot create output directory, giving up."
391 echo "${0##*/}: VPX_TEST_OUTPUT_DIR=${VPX_TEST_OUTPUT_DIR}"
395 if [ "$(is_windows_target)" = "yes" ]; then
396 VPX_TEST_EXE_SUFFIX=".exe"
399 # Variables shared by tests.
400 VP8_IVF_FILE="${LIBVPX_TEST_DATA_PATH}/vp80-00-comprehensive-001.ivf"
401 VP9_IVF_FILE="${LIBVPX_TEST_DATA_PATH}/vp90-2-09-subpixel-00.ivf"
403 VP9_WEBM_FILE="${LIBVPX_TEST_DATA_PATH}/vp90-2-00-quantizer-00.webm"
405 YUV_RAW_INPUT="${LIBVPX_TEST_DATA_PATH}/hantro_collage_w352h288.yuv"
406 YUV_RAW_INPUT_WIDTH=352
407 YUV_RAW_INPUT_HEIGHT=288
409 # Setup a trap function to clean up after tests complete.
412 vlog "$(basename "${0%.*}") test configuration:
413 LIBVPX_BIN_PATH=${LIBVPX_BIN_PATH}
414 LIBVPX_CONFIG_PATH=${LIBVPX_CONFIG_PATH}
415 LIBVPX_TEST_DATA_PATH=${LIBVPX_TEST_DATA_PATH}
416 VP8_IVF_FILE=${VP8_IVF_FILE}
417 VP9_IVF_FILE=${VP9_IVF_FILE}
418 VP9_WEBM_FILE=${VP9_WEBM_FILE}
419 VPX_TEST_EXE_SUFFIX=${VPX_TEST_EXE_SUFFIX}
420 VPX_TEST_FILTER=${VPX_TEST_FILTER}
421 VPX_TEST_LIST_TESTS=${VPX_TEST_LIST_TESTS}
422 VPX_TEST_OUTPUT_DIR=${VPX_TEST_OUTPUT_DIR}
423 VPX_TEST_PREFIX=${VPX_TEST_PREFIX}
424 VPX_TEST_RUN_DISABLED_TESTS=${VPX_TEST_RUN_DISABLED_TESTS}
425 VPX_TEST_SHOW_PROGRAM_OUTPUT=${VPX_TEST_SHOW_PROGRAM_OUTPUT}
426 VPX_TEST_TEMP_ROOT=${VPX_TEST_TEMP_ROOT}
427 VPX_TEST_VERBOSE_OUTPUT=${VPX_TEST_VERBOSE_OUTPUT}
428 YUV_RAW_INPUT=${YUV_RAW_INPUT}
429 YUV_RAW_INPUT_WIDTH=${YUV_RAW_INPUT_WIDTH}
430 YUV_RAW_INPUT_HEIGHT=${YUV_RAW_INPUT_HEIGHT}"
432 fi # End $VPX_TEST_TOOLS_COMMON_SH pseudo include guard.