]> git.lyx.org Git - lyx.git/blobdiff - development/autotests/export.cmake
ctests: log a waste and a success
[lyx.git] / development / autotests / export.cmake
index 51bd965bac2c45a40bddf052ea6b450033b1d4d6..43d6df8166b4eabfd644a3b4e68d86299e50b187 100755 (executable)
@@ -4,11 +4,11 @@
 # Copyright (c) 2012 Kornel Benko kornel@lyx.org
 #
 #
-# LYX_ROOT  = ${TOP_SRC_DIR}/lib/{doc,examples,templates}
+# LYX_ROOT  = ${TOP_SRC_DIR}/lib/{doc,examples,templates,tabletemplates}
 # LYX_USERDIR_VER = Name of environment variable for the user directory
 # lyx       =
-# format    = lyx16x|lyx21x|xhtml
-# extension = 16.lyx|21.lyx|xhtml
+# format    = lyx16x|lyx20x|lyx21x|lyx22x|xhtml|docbook5|epub
+# extension = 16.lyx|20.lyx|21.lyx|22.lyx|xhtml|xml|epub
 # file      = xxx
 #
 # Script should be called like:
 #       -Dformat=xxx \
 #       -Dfonttype=xxx \
 #       -Dextension=xxx \
+#       -DLYX_FORMAT_NUM=${_lyx_format_num} \
 #       -Dfile=xxx \
 #       -Dinverted=[01] \
-#       -DTOP_SRC_DIR=${TOP_SRC_DIR}
-#       -DPERL_EXECUTABLE=${PERL_EXECUTABLE}
+#       -DTOP_SRC_DIR=${TOP_SRC_DIR} \
+#       -DIgnoreErrorMessage=(ON/OFF) \
+#       -DPERL_EXECUTABLE=${PERL_EXECUTABLE} \
+#       -DXMLLINT_EXECUTABLE=${XMLLINT_EXECUTABLE} \
+#       -DJAVA_EXECUTABLE=${JAVA_EXECUTABLE} \
+#       -DENCODING=xxx \
 #       -P "${TOP_SRC_DIR}/development/autotests/export.cmake"
 #
 
+set(_TestResultMessage "")
+message(STATUS "IgnoreErrorMessage = \"${IgnoreErrorMessage}\"")
 set(Perl_Script "${TOP_SRC_DIR}/development/autotests/useSystemFonts.pl")
 set(Structure_Script "${TOP_SRC_DIR}/development/autotests/beginEndStructureCheck.pl")
 set(LanguageFile "${TOP_SRC_DIR}/lib/languages")
@@ -34,77 +41,265 @@ set(GetTempDir "${TOP_SRC_DIR}/development/autotests/getTempDir.pl")
 set(_ft ${fonttype})
 execute_process(COMMAND ${PERL_EXECUTABLE} "${GetTempDir}" "${WORKDIR}" OUTPUT_VARIABLE TempDir)
 message(STATUS "using fonttype = ${_ft}")
+if(NOT ENCODING)
+  set(ENCODING "default")
+endif()
+if(ENCODING STREQUAL "default")
+  set(_enc)
+else()
+  set(_enc "_${ENCODING}")
+endif()
+
+# move the the last directory part of LYX_ROOT to filename
+# to make the destination unique for otherwise identical
+# filenames
+get_filename_component(updir_ "${LYX_ROOT}" DIRECTORY)
+get_filename_component(updir2_ "${LYX_ROOT}" NAME)
+set(file "${updir2_}/${file}")
+set(LYX_ROOT "${updir_}")
+
 if(format MATCHES "dvi|pdf")
   message(STATUS "LYX_TESTS_USERDIR = ${LYX_TESTS_USERDIR}")
   message(STATUS "Converting with perl ${Perl_Script}")
-  set(LYX_SOURCE "${TempDir}/${file}_${format}_${_ft}.lyx")
+  set(LYX_SOURCE "${TempDir}/${file}_${format}_${_ft}${_enc}.lyx")
   message(STATUS "Using source \"${LYX_ROOT}/${file}.lyx\"")
   message(STATUS "Using dest \"${LYX_SOURCE}\"")
-  execute_process(COMMAND ${PERL_EXECUTABLE} "${Perl_Script}" "${LYX_ROOT}/${file}.lyx" "${LYX_SOURCE}" ${format} ${_ft} ${LanguageFile}
+  if(NOT "${ENCODING}" STREQUAL "default")
+    # message(STATUS "ENCODING = ${ENCODING}")
+  endif()
+  message(STATUS "Executing ${PERL_EXECUTABLE} \"${Perl_Script}\" \"${LYX_ROOT}/${file}.lyx\" \"${LYX_SOURCE}\" ${format} ${_ft} ${ENCODING} ${LanguageFile}")
+  execute_process(COMMAND ${PERL_EXECUTABLE} "${Perl_Script}" "${LYX_ROOT}/${file}.lyx" "${LYX_SOURCE}" ${format} ${_ft} ${ENCODING} ${LanguageFile}
     RESULT_VARIABLE _err)
   string(COMPARE EQUAL  ${_err} 0 _erg)
   if(NOT _erg)
     message(FATAL_ERROR "Export failed while converting")
   endif()
-  set(result_file_name ${file}_${_ft}.${extension})
+  # We only need "_${ENCODING}" for unicode tests (because multiple encodings
+  # are tested with the same format), but doesn't hurt to include for all.
+  set(result_file_name ${file}_${_ft}_${ENCODING}.${extension})
 else()
-  message(STATUS "Not converting")
-  set(LYX_SOURCE "${LYX_ROOT}/${file}.lyx")
-  # Font-type not relevant for lyx16/lyx21 exports
-  set(result_file_name ${file}.${extension})
-  set(result_file_name2 ${file}.${extension2})
+  message(STATUS "Converting with perl ${Perl_Script}")
+  set(LYX_SOURCE "${TempDir}/${file}.lyx")
+  message(STATUS "Using source \"${LYX_ROOT}/${file}.lyx\"")
+  message(STATUS "Using dest \"${LYX_SOURCE}\"")
+  execute_process(COMMAND ${PERL_EXECUTABLE} "${Perl_Script}" "${LYX_ROOT}/${file}.lyx" "${LYX_SOURCE}" ${format} "dontChange" "default" ${LanguageFile}
+    RESULT_VARIABLE _err)
+  string(COMPARE EQUAL  ${_err} 0 _erg)
+  if(NOT _erg)
+    message(FATAL_ERROR "Export failed while converting")
+    endif()
+  if(extension MATCHES "\\.lyx$")
+    # Font-type not relevant for lyx16/lyx2[0123] exports
+    set(result_file_base "${TempDir}/${file}")
+  else()
+    set(result_file_name ${file}.${extension})
+  endif()
 endif()
 
-message(STATUS "Executing ${lyx} -userdir \"${LYX_TESTS_USERDIR}\" -E ${format} ${result_file_name} \"${LYX_SOURCE}\"")
-set(ENV{${LYX_USERDIR_VER}} "${LYX_TESTS_USERDIR}")
-execute_process(COMMAND ${CMAKE_COMMAND} -E remove ${result_file_name} ${result_file_name}.emergency)
-execute_process(
-  COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E ${format} ${result_file_name} "${LYX_SOURCE}"
-  RESULT_VARIABLE _err)
+function(get_md5sum msource mresult mreserr)
+  execute_process(
+    COMMAND ${CMAKE_COMMAND} -E md5sum ${${msource}}
+    OUTPUT_VARIABLE msource_md5sum_x
+    RESULT_VARIABLE mres_err)
+  if (NOT mres_err)
+    string(REGEX REPLACE " .*" "" msource_md5sum ${msource_md5sum_x})
+    set(${mresult} ${msource_md5sum} PARENT_SCOPE)
+    message(STATUS "MD5SUM of \"${${msource}}\" is ${msource_md5sum}")
+  else()
+    set(${mresult} "xx" PARENT_SCOPE)
+    message(STATUS "Error getting MD5SUM of \"${${msource}}\"")
+  endif()
+  set(${mreserr} ${mres_err} PARENT_SCOPE)
+endfunction()
 
-#check if result file created
-if (NOT _err)
-  if (NOT EXISTS "${result_file_name}")
-    message(STATUS "Expected result file \"${result_file_name}\" does not exist")
-    set(_err -1)
+macro(Summary _err _msg)
+  if (${_err})
+    list(APPEND _TestResultMessage "Error: ${_msg}")
   else()
-    message(STATUS "Expected result file \"${result_file_name}\" exists")
+    list(APPEND _TestResultMessage "OK: ${_msg}")
   endif()
-endif()
+endmacro()
 
-include(${TOP_SRC_DIR}/development/autotests/CheckLoadErrors.cmake)
-# If no error, and extension matches '\.lyx$', try to load the created lyx file
-if (NOT _err)
-  if (result_file_name MATCHES "\\.lyx$")
-    set(ENV{${LYX_USERDIR_VER}} "${LYX_TESTS_USERDIR}")
-    set(ENV{LANG} "en") # to get all error-messages in english
-    message(STATUS "check structures of ${result_file_name}")
+set(ENV{${LYX_USERDIR_VER}} "${LYX_TESTS_USERDIR}")
+set(ENV{LANG} "en_US.UTF-8") # to get all error-messages in english
+set(ENV{LANGUAGE} "US:en")
+#set(ENV{LC_ALL} "C")
+if (extension MATCHES "\\.lyx$")
+  include(${TOP_SRC_DIR}/development/autotests/CheckLoadErrors.cmake)
+  get_md5sum(LYX_SOURCE source_md5sum _err)
+  foreach(_lv RANGE 1 20)
+    set(used_tex_file "${result_file_base}.tex")
+    set(result_file_base "${result_file_base}.${LYX_FORMAT_NUM}")
+    set(result_file_name "${result_file_base}.lyx")
+    file(REMOVE "${result_file_name}" "${result_file_name}.emergency" )
+    message(STATUS "Executing ${lyx} -userdir \"${LYX_TESTS_USERDIR}\" -E ${format} ${result_file_name} \"${LYX_SOURCE}\"")
+    message(STATUS "This implicitly checks load of ${LYX_SOURCE}")
     execute_process(
-      COMMAND ${PERL_EXECUTABLE} ${Structure_Script} "${WORKDIR}/${result_file_name}"
+      COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E ${format} ${result_file_name} "${LYX_SOURCE}"
       RESULT_VARIABLE _err
       ERROR_VARIABLE lyxerr)
-    if (NOT _err)
-      message(STATUS "check load of ${result_file_name}")
+    Summary(_err "Converting \"${LYX_SOURCE}\" to format ${format}")
+    if(_err)
+      break()
+    else()
+      if(NOT EXISTS "${result_file_name}")
+        set(_err -1)
+        Summary(_err "Expected result file \"${result_file_name}\" does not exist")
+        break()
+      else()
+        message(STATUS "Expected result file \"${result_file_name}\" exists")
+        execute_process(
+          COMMAND ${PERL_EXECUTABLE} ${Structure_Script} "${result_file_name}"
+          RESULT_VARIABLE _err)
+        Summary(_err "Structure of the intermediate file \"${result_file_name}\"")
+        if(_err)
+          break()
+        endif()
+        checkLoadErrors(lyxerr "${TOP_SRC_DIR}/development/autotests" _err)
+        Summary(_err "Examination of error/warning messages of the conversion of \"${LYX_SOURCE}\" to format ${format}")
+        if(_err)
+          break()
+        endif()
+        message(STATUS "Create the corresponding .tex file \"${used_tex_file}\"")
+        execute_process(
+          COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E pdflatex ${used_tex_file} "${LYX_SOURCE}"
+          RESULT_VARIABLE _errx)
+      endif()
+    endif()
+    get_md5sum(result_file_name result_md5sum _err)
+    Summary(_err "Getting md5sum of \"${result_file_name}\"")
+    if(_err)
+      # Somehow the created file is not readable?
+      break()
+    endif()
+    # Check if result file identical to source file
+    if(result_md5sum STREQUAL ${source_md5sum})
+      if (format MATCHES "lyx(1[0-9]|2[01])x")
+        # Do not compile, missing \origin statement prevents inclusion of
+        # files with relative path
+        message(STATUS "Not exporting due to missing \\origin statement")
+        break()
+      elseif(format MATCHES "lyx22x" AND file MATCHES "Minted")
+        message(STATUS "Not exporting due to missing minted support")
+        break()
+      endif()
+      message(STATUS "Source(${LYX_SOURCE}) and dest(${result_file_name}) are equal")
+      message(STATUS "Now try to export the lyx2lyx created file")
+      message(STATUS "Executing ${lyx} -userdir \"${LYX_TESTS_USERDIR}\" -E default \"${result_file_name}.default\" \"${result_file_name}\"")
       execute_process(
-        COMMAND ${lyx} -batch -userdir "${LYX_TESTS_USERDIR}" ${result_file_name}
+        COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E default "${result_file_name}.default" "${result_file_name}"
         RESULT_VARIABLE _err
         ERROR_VARIABLE lyxerr)
-      if (NOT _err)
-        CheckLoadErrors(lyxerr "${TOP_SRC_DIR}/development/autotests" _err)
-        if (NOT _err)
+      Summary(_err "Test-compilation of \"${result_file_name}\" to format default")
+      break()
+    else()
+      list(APPEND _TestResultMessage "Warning: \"${LYX_SOURCE}\" and \"${result_file_name}\" differ")
+      message(STATUS "Source(${LYX_SOURCE}) and dest(${result_file_name}) are still different")
+      if (_lv GREATER 10)
+        set(_err 1)
+        message(STATUS "Possible endless loop encountered")
+        Summary(_err "Test-Loop exceeded the count of 10, Possible endless loop")
+        break()
+      endif()
+    endif()
+    set(source_md5sum ${result_md5sum})
+    set(LYX_SOURCE ${result_file_name})
+  endforeach()
+else()
+  if ($ENV{LYX_DEBUG_LATEX})
+    set(LyXExtraParams -dbg latex)
+  else()
+    set(LyXExtraParams -dbg info)
+  endif()
+  if(IgnoreErrorMessage)
+    foreach (_em ${IgnoreErrorMessage})
+      list(APPEND LyXExtraParams --ignore-error-message ${_em})
+    endforeach()
+  endif()
+  string(REGEX REPLACE ";" " " _LyXExtraParams "${LyXExtraParams}")
+  message(STATUS "Executing in working dir ${TempDir}")
+  message(STATUS "Executing ${lyx} ${_LyXExtraParams} -userdir \"${LYX_TESTS_USERDIR}\" -E ${format} ${result_file_name} \"${LYX_SOURCE}\"")
+  file(REMOVE "${TempDir}/${result_file_name}")
+  execute_process(
+    COMMAND ${lyx} ${LyXExtraParams} -userdir "${LYX_TESTS_USERDIR}" -E ${format} ${result_file_name} "${LYX_SOURCE}"
+    WORKING_DIRECTORY "${TempDir}"
+    RESULT_VARIABLE _err)
+  Summary(_err "Exporting \"${LYX_SOURCE}\" to format ${format}")
+  if (NOT _err)
+    #check if result file created
+    if (NOT EXISTS "${TempDir}/${result_file_name}")
+      message(STATUS "Expected result file \"${TempDir}/${result_file_name}\" does not exist")
+      set(_err -1)
+      Summary(_err "Expected result file \"${TempDir}/${result_file_name}\" does not exists")
+    else()
+      message(STATUS "Expected result file \"${TempDir}/${result_file_name}\" exists")
+      if (extension MATCHES "^x(ht)?ml$")
+        if (format MATCHES "xhtml")
+          set(xmllint_params --loaddtd --noout)
+          set(executable_ ${XMLLINT_EXECUTABLE})
+        else()
+          set(xmllint_params)
+          set(executable_ ${PERL_EXECUTABLE} "${TOP_SRC_DIR}/development/autotests/filterXml4Sax.pl")
+          # Check with perl xml-parser
+          # needs XML::Parser module
+          message(STATUS "Calling ${PERL_EXECUTABLE} \"${TOP_SRC_DIR}/development/autotests/xmlParser.pl\" \"${result_file_name}\"")
           execute_process(
-            COMMAND ${lyx} -userdir "${LYX_TESTS_USERDIR}" -E ${format} ${result_file_name2} ${result_file_name}
+            COMMAND ${PERL_EXECUTABLE} "${TOP_SRC_DIR}/development/autotests/xmlParser.pl" "${result_file_name}"
+           WORKING_DIRECTORY "${TempDir}"
+            OUTPUT_VARIABLE parserout
+            ERROR_VARIABLE parsererr
             RESULT_VARIABLE _err
-            ERROR_VARIABLE lyxerr)
+          )
+          if (_err)
+            message(STATUS "${parsererr}")
+          endif()
+          Summary(_err "Checking \"${TempDir}/${result_file_name}\" with xmlParser.pl")
+        endif()
+        if (XMLLINT_EXECUTABLE)
+          string(REPLACE ";" " " xmllint_params2 " ${xmllint_params}")
+          message(STATUS "Calling: " ${executable_} ${xmllint_params2} " ${WORKDIR}/${result_file_name}")
+          # check the created xhtml file
+          execute_process(
+            COMMAND ${executable_} ${xmllint_params}  "${result_file_name}"
+           WORKING_DIRECTORY "${TempDir}"
+            OUTPUT_VARIABLE xmlout
+            ERROR_VARIABLE xmlerr
+            RESULT_VARIABLE _err)
+          file(WRITE "${TempDir}/${result_file_name}.sax_out" ${xmlout})
+          Summary(_err "Checking \"${TempDir}/${result_file_name}\" with ${XMLLINT_EXECUTABLE}")
+          if (NOT _err)
+            # check if parser output contains error messages
+            message(STATUS "Check the output: ${PERL_EXECUTABLE} ${TOP_SRC_DIR}/development/autotests/examineXmllintOutput.pl")
+            execute_process(
+              COMMAND ${PERL_EXECUTABLE} "${TOP_SRC_DIR}/development/autotests/examineXmllintOutput.pl" "${result_file_name}.sax_out"
+             WORKING_DIRECTORY "${TempDir}"
+              OUTPUT_VARIABLE xmlout
+              RESULT_VARIABLE _err)
+            Summary(_err "Parse messages of ${XMLLINT_EXECUTABLE} for errors")
+          else()
+            message(STATUS "Errors from xmllint: ${xmlerr}")
+          endif()
           if (NOT _err)
-            message(STATUS "check load of ${result_file_name2}")
-            CheckLoadErrors(lyxerr "${TOP_SRC_DIR}/development/autotests" _err)
+            if (NOT "${xmlout}" STREQUAL "")
+              message(STATUS "${xmlout}")
+              set(_err -1)
+              Summary(_err "Non empty output of \"${XMLLINT_EXECUTABLE}\"")
+            endif()
           endif()
         endif()
+        if (NOT _err AND format MATCHES "docbook5" AND JAVA_EXECUTABLE)
+          # check with jing
+          message(STATUS "Calling: ${JAVA_EXECUTABLE} -jar \"${TOP_SRC_DIR}/development/tools/jing.jar\" https://docbook.org/xml/5.2b09/rng/docbook.rng \"${WORKDIR}/${result_file_name}\"")
+          execute_process(
+            COMMAND ${JAVA_EXECUTABLE} -jar "${TOP_SRC_DIR}/development/tools/jing.jar" "https://docbook.org/xml/5.2b09/rng/docbook.rng" "${result_file_name}"
+           WORKING_DIRECTORY "${TempDir}"
+            OUTPUT_VARIABLE jingout
+            RESULT_VARIABLE _err)
+          message(STATUS "_err = ${_err}, jingout = ${jingout}")
+          Summary(_err "Checking for empty output of ${JAVA_EXECUTABLE} -jar \"${TOP_SRC_DIR}/development/tools/jing.jar\"")
+        endif()
       endif()
     endif()
-  else()
-    message(STATUS "\"${result_file_name}\" is not a lyx file, do not check load")
   endif()
 endif()
 
@@ -113,7 +308,22 @@ if(inverted)
 else()
   string(COMPARE NOTEQUAL  ${_err} 0 _erg)
 endif()
-execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory "${TempDir}")
+
+if ($ENV{LYX_DEBUG_LATEX})
+  # Do not remove temporary files if one wants to examine them
+  # for example if setting the env-var LYX_DEBUG_LATEX
+  # This needs a remove all temp-dirs from time to time
+  # $ cd build-dir
+  # $ find autotests/out-home -name AbC_\* | xargs rm -rf
+else()
+  execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory "${TempDir}")
+endif()
+if(_TestResultMessage)
+  message(STATUS "Msg Summary:")
+  foreach(_l ${_TestResultMessage})
+    message(STATUS "\t${_l}")
+  endforeach()
+endif()
 if(_erg)
   message(STATUS "Exporting ${file}.lyx to ${format}")
   message(FATAL_ERROR "Export failed")