awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Help the examples with text but no images get generated more often. 

In case of error, well, make an error, but update the content anyway.
This will be enough for the CI but makes development less painful.

Also update the cmake targets to re-generate them more often.
This commit is contained in:
Emmanuel Lepage Vallee 2019-06-27 02:17:07 -04:00
parent b2ebf899d7
commit c48b03ca9c
2 changed files with 40 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
tests/examples/CMakeLists.txt
View File

@ -232,15 +232,23 @@ function(run_test test_path namespace escaped_content)
file(READ "${expected_output_path}" expected_output)
endif()
set(TEST_DOC_CONTENT
"${TEST_DOC_CONTENT}\n${DOC_LINE_PREFIX}\n${DOC_LINE_PREFIX}**Usage example output**:\n${DOC_LINE_PREFIX}"
)
if (NOT tmp_content MATCHES "--DOC_RAW_OUTPUT")
set(TEST_DOC_CONTENT
"${TEST_DOC_CONTENT}\n${DOC_LINE_PREFIX}\n${DOC_LINE_PREFIX}**Usage example output**:\n${DOC_LINE_PREFIX}"
)
# Markdown requires an empty line before and after, and 4 spaces.
escape_string(
"\n${expected_output}"
"${TEST_DOC_CONTENT}" TEST_DOC_CONTENT " "
)
else()
escape_string(
"\n${expected_output}"
"${TEST_DOC_CONTENT}" TEST_DOC_CONTENT ""
)
endif()
# Markdown requires an empty line before and after, and 4 spaces.
escape_string(
"\n${expected_output}"
"${TEST_DOC_CONTENT}" TEST_DOC_CONTENT " "
)
set(TEST_DOC_CONTENT "${TEST_DOC_CONTENT}\n${DOC_LINE_PREFIX}")
endif()
@ -270,14 +278,31 @@ function(run_test test_path namespace escaped_content)
if(NOT ${OUTPUT_IMAGE_PATH} STREQUAL "")
file(RELATIVE_PATH rel_output "${TOP_SOURCE_DIR}" "${OUTPUT_IMAGE_PATH}")
add_custom_command(
COMMAND "${TOP_SOURCE_DIR}/tests/examples/runner.sh" "${expected_output_path}" ${LUA_COV_RUNNER} ${template} ${test_path} ${IMAGE_PATH} ${IGNORE_ERRORS}
# COMMENT "Running ${rel_test_path} (via ${rel_template}, generating ${rel_output})"
DEPENDS ${template} ${test_path}
OUTPUT ${OUTPUT_IMAGE_PATH}
VERBATIM)
if(tmp_content MATCHES "--DOC_GEN_OUTPUT")
add_custom_command(
COMMAND "${TOP_SOURCE_DIR}/tests/examples/runner.sh" "${expected_output_path}" ${LUA_COV_RUNNER} ${template} ${test_path} ${IMAGE_PATH} ${IGNORE_ERRORS}
# COMMENT "Running ${rel_test_path} (via ${rel_template}, generating ${rel_output})"
DEPENDS ${template} ${test_path}
OUTPUT ${OUTPUT_IMAGE_PATH}
OUTPUT ${expected_output_path}
VERBATIM)
else()
add_custom_command(
COMMAND "${TOP_SOURCE_DIR}/tests/examples/runner.sh" "${expected_output_path}" ${LUA_COV_RUNNER} ${template} ${test_path} ${IMAGE_PATH} ${IGNORE_ERRORS}
# COMMENT "Running ${rel_test_path} (via ${rel_template}, generating ${rel_output})"
DEPENDS ${template} ${test_path}
OUTPUT ${OUTPUT_IMAGE_PATH}
VERBATIM)
endif()
set(EXAMPLE_DOC_GENERATED_FILES ${OUTPUT_IMAGE_PATH} ${EXAMPLE_DOC_GENERATED_FILES}
PARENT_SCOPE)
elseif(tmp_content MATCHES "--DOC_GEN_OUTPUT")
add_custom_command(
COMMAND "${TOP_SOURCE_DIR}/tests/examples/runner.sh" "${expected_output_path}" ${LUA_COV_RUNNER} ${template} ${test_path} "" ${IGNORE_ERRORS}
# COMMENT "Running ${rel_test_path} (via ${rel_template}, generating ${rel_output})"
DEPENDS ${template} ${test_path}
OUTPUT ${expected_output_path}
VERBATIM)
endif()
# Export the outout to the parent scope.

1
tests/examples/runner.sh
View File

@ -49,6 +49,7 @@ if ! cmp --silent "${file_stdout}" "${expected_output}"
then
echo "Expected text from ${expected_output}, but got:"
diff -u "${expected_output}" "${file_stdout}" || true
cp "${file_stdout}" "${expected_output}"
exit 1
fi