1 # This file is part of LyX, the document processor.
2 # Licence details can be found in the file COPYING.
4 # Copyright (c) 2012 Kornel Benko kornel@lyx.org
7 # LYX_ROOT = ${TOP_SRC_DIR}/lib/{doc,examples,templates}
8 # LYX_USERDIR_VER = Name of environment variable for the user directory
10 # format = lyx16x|lyx20x|lyx21x|lyx22x|xhtml
11 # extension = 16.lyx|20.lyx|21.lyx|22.lyx|xhtml
14 # Script should be called like:
15 # cmake -DLYX_ROOT=xxx \
16 # -DLYX_TESTS_USERDIR=${LYX_TESTS_USERDIR} \
17 # -DWORKDIR=${BUILD_DIR}/autotests/out-home \
18 # -DLYX_USERDIR_VER=${LYX_USERDIR_VER} \
23 # -DLYX_FORMAT_NUM=${_lyx_format_num} \
26 # -DTOP_SRC_DIR=${TOP_SRC_DIR} \
27 # -DIgnoreErrorMessage=(ON/OFF) \
28 # -DPERL_EXECUTABLE=${PERL_EXECUTABLE} \
29 # -DXMLLINT_EXECUTABLE=${XMLLINT_EXECUTABLE} \
31 # -P "${TOP_SRC_DIR}/development/autotests/export.cmake"
34 set(_TestResultMessage "")
35 message(STATUS "IgnoreErrorMessage = \"${IgnoreErrorMessage}\"")
36 set(Perl_Script "${TOP_SRC_DIR}/development/autotests/useSystemFonts.pl")
37 set(Structure_Script "${TOP_SRC_DIR}/development/autotests/beginEndStructureCheck.pl")
38 set(LanguageFile "${TOP_SRC_DIR}/lib/languages")
39 set(GetTempDir "${TOP_SRC_DIR}/development/autotests/getTempDir.pl")
41 execute_process(COMMAND ${PERL_EXECUTABLE} "${GetTempDir}" "${WORKDIR}" OUTPUT_VARIABLE TempDir)
42 message(STATUS "using fonttype = ${_ft}")
44 set(ENCODING "default")
46 if(ENCODING STREQUAL "default")
49 set(_enc "_${ENCODING}")
51 if(format MATCHES "dvi|pdf")
52 message(STATUS "LYX_TESTS_USERDIR = ${LYX_TESTS_USERDIR}")
53 message(STATUS "Converting with perl ${Perl_Script}")
54 set(LYX_SOURCE "${TempDir}/${file}_${format}_${_ft}${_enc}.lyx")
55 message(STATUS "Using source \"${LYX_ROOT}/${file}.lyx\"")
56 message(STATUS "Using dest \"${LYX_SOURCE}\"")
57 if(NOT "${ENCODING}" STREQUAL "default")
58 # message(STATUS "ENCODING = ${ENCODING}")
60 message(STATUS "Executing ${PERL_EXECUTABLE} \"${Perl_Script}\" \"${LYX_ROOT}/${file}.lyx\" \"${LYX_SOURCE}\" ${format} ${_ft} ${ENCODING} ${LanguageFile}")
61 execute_process(COMMAND ${PERL_EXECUTABLE} "${Perl_Script}" "${LYX_ROOT}/${file}.lyx" "${LYX_SOURCE}" ${format} ${_ft} ${ENCODING} ${LanguageFile}
63 string(COMPARE EQUAL ${_err} 0 _erg)
65 message(FATAL_ERROR "Export failed while converting")
67 set(result_file_name ${file}_${_ft}.${extension})
69 message(STATUS "Converting with perl ${Perl_Script}")
70 set(LYX_SOURCE "${TempDir}/${file}.lyx")
71 message(STATUS "Using source \"${LYX_ROOT}/${file}.lyx\"")
72 message(STATUS "Using dest \"${LYX_SOURCE}\"")
73 execute_process(COMMAND ${PERL_EXECUTABLE} "${Perl_Script}" "${LYX_ROOT}/${file}.lyx" "${LYX_SOURCE}" ${format} "dontChange" "default" ${LanguageFile}
75 string(COMPARE EQUAL ${_err} 0 _erg)
77 message(FATAL_ERROR "Export failed while converting")
79 if(extension MATCHES "\\.lyx$")
80 # Font-type not relevant for lyx16/lyx2[0123] exports
81 set(result_file_base "${TempDir}/${file}")
83 set(result_file_name ${file}.${extension})
87 function(get_md5sum msource mresult mreserr)
89 COMMAND ${CMAKE_COMMAND} -E md5sum ${${msource}}
90 OUTPUT_VARIABLE msource_md5sum_x
91 RESULT_VARIABLE mres_err)
93 string(REGEX REPLACE " .*" "" msource_md5sum ${msource_md5sum_x})
94 set(${mresult} ${msource_md5sum} PARENT_SCOPE)
95 message(STATUS "MD5SUM of \"${${msource}}\" is ${msource_md5sum}")
97 set(${mresult} "xx" PARENT_SCOPE)
98 message(STATUS "Error getting MD5SUM of \"${${msource}}\"")
100 set(${mreserr} ${mres_err} PARENT_SCOPE)
103 set(ENV{${LYX_USERDIR_VER}} "${LYX_TESTS_USERDIR}")
104 set(ENV{LANG} "en_US.UTF-8") # to get all error-messages in english
105 #set(ENV{LC_ALL} "C")
106 if (extension MATCHES "\\.lyx$")
107 include(${TOP_SRC_DIR}/development/autotests/CheckLoadErrors.cmake)
108 get_md5sum(LYX_SOURCE source_md5sum _err)
109 foreach(_lv RANGE 1 20)
110 set(used_tex_file "${result_file_base}.tex")
111 set(result_file_base "${result_file_base}.${LYX_FORMAT_NUM}")
112 set(result_file_name "${result_file_base}.lyx")
113 file(REMOVE "${result_file_name}" "${result_file_name}.emergency" )
114 message(STATUS "Executing ${lyx} -userdir \"${LYX_TESTS_USERDIR}\" -E ${format} ${result_file_name} \"${LYX_SOURCE}\"")
115 message(STATUS "This implicitly checks load of ${LYX_SOURCE}")
117 COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E ${format} ${result_file_name} "${LYX_SOURCE}"
119 ERROR_VARIABLE lyxerr)
120 set(_mymsg "Converting \"${LYX_SOURCE}\" to format ${format}")
122 list(APPEND _TestResultMessage "Error: ${_mymsg}")
125 list(APPEND _TestResultMessage "OK: ${_mymsg}")
126 if(NOT EXISTS "${result_file_name}")
127 message(STATUS "Expected result file \"${result_file_name}\" does not exist")
128 list(APPEND _TestResultMessage "Error: The conversion of \"${LYX_SOURCE}\" to format ${format} did not create result file \"${result_file_name}\"")
132 message(STATUS "Expected result file \"${result_file_name}\" exists")
134 COMMAND ${PERL_EXECUTABLE} ${Structure_Script} "${result_file_name}"
135 RESULT_VARIABLE _err)
136 set(_mymsg "Structure of the intermediate file \"${result_file_name}\"")
138 list(APPEND _TestResultMessage "Error: ${_mymsg} seems to be broken")
141 list(APPEND _TestResultMessage "OK: ${_mymsg}")
143 checkLoadErrors(lyxerr "${TOP_SRC_DIR}/development/autotests" _err)
144 set(_mymsg "Examination of error/warning messages of the conversion of \"${LYX_SOURCE}\" to format ${format}")
146 list(APPEND _TestResultMessage "Error: ${_mymsg}")
149 list(APPEND _TestResultMessage "OK: ${_mymsg}")
151 message(STATUS "Create the corresponding .tex file \"${used_tex_file}\"")
153 COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E pdflatex ${used_tex_file} "${LYX_SOURCE}"
154 RESULT_VARIABLE _errx)
157 get_md5sum(result_file_name result_md5sum _err)
158 set(_mymsg "Getting md5sum of \"${result_file_name}\"")
160 # Somehow the created file is not readable?
161 list(APPEND _TestResultMessage "Error: ${_mymsg}")
164 list(APPEND _TestResultMessage "OK: ${_mymsg}")
166 # Check if result file identical to source file
167 if(result_md5sum STREQUAL ${source_md5sum})
168 if (format MATCHES "lyx(1[0-9]|2[01])x")
169 # Do not compile, missing \origin statement prevents inclusion of
170 # files with relative path
171 message(STATUS "Not exporting due to missing \\origin statement")
174 message(STATUS "Source(${LYX_SOURCE}) and dest(${result_file_name}) are equal")
175 message(STATUS "Now try to export the lyx2lyx created file")
176 message(STATUS "Executing ${lyx} -userdir \"${LYX_TESTS_USERDIR}\" -E default \"${result_file_name}.default\" \"${result_file_name}\"")
178 COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E default "${result_file_name}.default" "${result_file_name}"
180 ERROR_VARIABLE lyxerr)
181 set(_mymsg "Test-compilation of \"${result_file_name}\" to format default")
183 list(APPEND _TestResultMessage "Error: ${_mymsg}")
185 list(APPEND _TestResultMessage "OK: ${_mymsg}")
189 list(APPEND _TestResultMessage "Warning: \"${LYX_SOURCE}\" and \"${result_file_name}\" differ")
190 message(STATUS "Source(${LYX_SOURCE}) and dest(${result_file_name}) are still different")
193 message(STATUS "Possible endless loop encountered")
194 list(APPEND _TestResultMessage "Error: Test-Loop exceeded the count of 10, Possible endless loop")
198 set(source_md5sum ${result_md5sum})
199 set(LYX_SOURCE ${result_file_name})
202 if ($ENV{LYX_DEBUG_LATEX})
203 set(LyXExtraParams -dbg latex)
207 if(IgnoreErrorMessage)
208 foreach (_em ${IgnoreErrorMessage})
209 list(APPEND LyXExtraParams --ignore-error-message ${_em})
212 string(REGEX REPLACE ";" " " _LyXExtraParams "${LyXExtraParams}")
213 message(STATUS "Executing ${lyx} ${_LyXExtraParams} -userdir \"${LYX_TESTS_USERDIR}\" -E ${format} ${result_file_name} \"${LYX_SOURCE}\"")
214 file(REMOVE ${result_file_name})
216 COMMAND ${lyx} ${LyXExtraParams} -userdir "${LYX_TESTS_USERDIR}" -E ${format} ${result_file_name} "${LYX_SOURCE}"
217 RESULT_VARIABLE _err)
219 #check if result file created
221 if (NOT EXISTS "${result_file_name}")
222 message(STATUS "Expected result file \"${result_file_name}\" does not exist")
225 message(STATUS "Expected result file \"${result_file_name}\" exists")
226 if (format MATCHES "xhtml")
227 if (XMLLINT_EXECUTABLE)
228 message(STATUS "Calling: ${XMLLINT_EXECUTABLE} --sax --html --valid")
229 # check the created xhtml file
231 COMMAND ${XMLLINT_EXECUTABLE} --sax --html --valid "${result_file_name}"
232 OUTPUT_VARIABLE xmlout
233 ERROR_VARIABLE xmlerr
234 RESULT_VARIABLE _err)
235 file(WRITE "${result_file_name}.sax_out" ${xmlout})
237 # check if sax-parser output contains error messages
238 message(STATUS "Check the output: ${PERL_EXECUTABLE} ${TOP_SRC_DIR}/development/autotests/examineXmllintOutput.pl")
240 COMMAND ${PERL_EXECUTABLE} "${TOP_SRC_DIR}/development/autotests/examineXmllintOutput.pl" "${result_file_name}.sax_out"
241 OUTPUT_VARIABLE xmlout
242 RESULT_VARIABLE _err)
245 if (NOT "${xmlout}" STREQUAL "")
246 message(STATUS "${xmlout}")
257 string(COMPARE EQUAL ${_err} 0 _erg)
259 string(COMPARE NOTEQUAL ${_err} 0 _erg)
261 #execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory "${TempDir}")
262 if(_TestResultMessage)
263 message(STATUS "Msg Summary:")
264 foreach(_l ${_TestResultMessage})
265 message(STATUS "\t${_l}")
269 message(STATUS "Exporting ${file}.lyx to ${format}")
270 message(FATAL_ERROR "Export failed")