ExternalData: Add tests covering interfaces and errors

Add a Module.ExternalData test to verify data retrieval and test
argument DATA{} references.

Add a RunCMake.ExternalData test to verify error handling and automatic
transformation of a raw data to a content link and staged object.

Tests/CMakeLists.txt

@@ -312,6 +312,18 @@ if(BUILD_TESTING)
 
   ADD_TEST_MACRO(Module.CheckTypeSize CheckTypeSize)
 
+  add_test(Module.ExternalData ${CMAKE_CTEST_COMMAND}
+    --build-and-test
+    "${CMake_SOURCE_DIR}/Tests/Module/ExternalData"
+    "${CMake_BINARY_DIR}/Tests/Module/ExternalData"
+    --build-generator ${CMAKE_TEST_GENERATOR}
+    --build-project ExternalDataTest
+    --build-makeprogram ${CMAKE_TEST_MAKEPROGRAM}
+    --force-new-ctest-process
+    --test-command ${CMAKE_CTEST_COMMAND} -C \${CTEST_CONFIGURATION_TYPE} -V
+    )
+  list(APPEND TEST_BUILD_DIRS "${CMake_BINARY_DIR}/Tests/Module/ExternalData")
+
   ADD_TEST_MACRO(Module.GenerateExportHeader GenerateExportHeader)
 
   if (APPLE OR CMAKE_CXX_COMPILER_ID MATCHES "GNU")

Tests/Module/ExternalData/CMakeLists.txt

+cmake_minimum_required(VERSION 2.8.10.20130115)
+project(ExternalDataTest NONE)
+
+include(CTest)
+
+include(ExternalData)
+set(ExternalData_URL_TEMPLATES
+  "file:///${CMAKE_CURRENT_SOURCE_DIR}/%(algo)/%(hash)"
+  )
+set(ExternalData_BINARY_ROOT "${CMAKE_CURRENT_BINARY_DIR}/ExternalData")
+file(REMOVE_RECURSE ${ExternalData_BINARY_ROOT}) # clean test
+
+ExternalData_Add_Test(Data1
+  NAME Data1Check
+  COMMAND ${CMAKE_COMMAND}
+    -D Data=DATA{Data.dat}
+    -D SeriesA=DATA{SeriesA.dat,:}
+    -D SeriesB=DATA{SeriesB.dat,:}
+    -D SeriesC=DATA{SeriesC.dat,:}
+    -D SeriesD=DATA{SeriesD.dat,:}
+    -D SeriesAn=DATA{SeriesAn1.dat,:}
+    -D SeriesBn=DATA{SeriesBn_1.dat,:}
+    -D SeriesCn=DATA{SeriesCn.1.dat,:}
+    -D SeriesDn=DATA{SeriesDn-1.dat,:}
+    -D Paired=DATA{PairedA.dat,PairedB.dat}
+    -D Meta=DATA{MetaTop.dat,REGEX:Meta[ABC].dat}
+    -P ${CMAKE_CURRENT_SOURCE_DIR}/Data1Check.cmake
+  )
+ExternalData_Add_Target(Data1)
+
+add_subdirectory(Data2)
+add_subdirectory(Data3)

Tests/Module/ExternalData/Data.dat.md5

+8c018830e3efa5caf3c7415028335a57

Tests/Module/ExternalData/Data1Check.cmake

+file(STRINGS "${Data}" lines LIMIT_INPUT 1024)
+if(NOT "x${lines}" STREQUAL "xInput file already transformed.")
+  message(SEND_ERROR "Input file:\n  ${Data}\ndoes not have expected content, but [[${lines}]]")
+endif()
+set(SeriesAn1 "1\\.dat")
+set(SeriesBn1 "_1\\.dat")
+set(SeriesCn1 "\\.1\\.dat")
+set(SeriesDn1 "-1\\.dat")
+set(SeriesAl 1 2 3)
+set(SeriesBl _1 _2 _3)
+set(SeriesCl .1 .2 .3)
+set(SeriesDl -1 -2 -3)
+foreach(s A B C D)
+  foreach(n "" ${Series${s}l})
+    string(REGEX REPLACE "\\.dat$" "${n}.dat" file "${Series${s}}")
+    if(NOT EXISTS "${file}")
+      message(SEND_ERROR "Input file:\n  ${file}\ndoes not exist!")
+    endif()
+  endforeach()
+endforeach()
+foreach(s A B C D)
+  foreach(n ${Series${s}l})
+    string(REGEX REPLACE "${Series${s}n1}$" "${n}.dat" file "${Series${s}n}")
+    if(NOT EXISTS "${file}")
+      message(SEND_ERROR "Input file:\n  ${file}\ndoes not exist!")
+    endif()
+  endforeach()
+endforeach()
+foreach(n A B)
+  string(REGEX REPLACE "A\\.dat$" "${n}.dat" file "${Paired}")
+  if(NOT EXISTS "${file}")
+    message(SEND_ERROR "Input file:\n  ${file}\ndoes not exist!")
+  endif()
+endforeach()
+foreach(n Top A B C)
+  string(REGEX REPLACE "Top\\.dat$" "${n}.dat" file "${Meta}")
+  if(NOT EXISTS "${file}")
+    message(SEND_ERROR "Input file:\n  ${file}\ndoes not exist!")
+  endif()
+endforeach()

Tests/Module/ExternalData/Data2.dat.md5

+8c018830e3efa5caf3c7415028335a57

Tests/Module/ExternalData/Data2/CMakeLists.txt

+set(ExternalData_SERIES_PARSE "([0-9]+)(_\\.my\\.dat)$")
+set(ExternalData_SERIES_MATCH "[0-9]+")
+ExternalData_Add_Test(Data2
+  NAME Data2Check
+  COMMAND ${CMAKE_COMMAND}
+    -D Data2=DATA{../Data2.dat}
+    -D SeriesC=DATA{SeriesC_1_.my.dat,:}
+    -P ${CMAKE_CURRENT_SOURCE_DIR}/Data2Check.cmake
+  )
+ExternalData_Add_Target(Data2)

Tests/Module/ExternalData/Data2/Data2Check.cmake

+if(NOT EXISTS "${Data2}")
+  message(SEND_ERROR "Input file:\n  ${Data2}\ndoes not exist!")
+endif()
+foreach(n 1 2 3)
+  string(REGEX REPLACE "_1_\\.my\\.dat$" "_${n}_.my.dat" SeriesCFile "${SeriesC}")
+  if(NOT EXISTS "${SeriesCFile}")
+    message(SEND_ERROR "Input file:\n  ${SeriesCFile}\ndoes not exist!")
+  endif()
+endforeach()

Tests/Module/ExternalData/Data2/SeriesC_1_.my.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/Data2/SeriesC_2_.my.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/Data2/SeriesC_3_.my.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/Data3/CMakeLists.txt

+set(Store0 ${CMAKE_BINARY_DIR}/ExternalData/Other)
+set(Store1 ${CMAKE_BINARY_DIR}/ExternalData/Objects)
+set(ExternalData_OBJECT_STORES ${Store0} ${Store1})
+ExternalData_Add_Test(Data3
+  NAME Data3Check
+  COMMAND ${CMAKE_COMMAND}
+    -D Data=DATA{Data.dat}
+    -D Other=DATA{Other.dat}
+    -D Store0=${Store0}
+    -D Store1=${Store1}
+    -P ${CMAKE_CURRENT_SOURCE_DIR}/Data3Check.cmake
+  )
+ExternalData_Add_Target(Data3)
+add_dependencies(Data3 Data1 Data2)

Tests/Module/ExternalData/Data3/Data.dat.md5

+8c018830e3efa5caf3c7415028335a57

Tests/Module/ExternalData/Data3/Data3Check.cmake

+if(NOT EXISTS "${Data}")
+  message(SEND_ERROR "Input file:\n  ${Data}\ndoes not exist!")
+endif()
+if(NOT EXISTS "${Other}")
+  message(SEND_ERROR "Input file:\n  ${Other}\ndoes not exist!")
+endif()
+# Verify that the 'Data' object was found in the second store location left
+# from Data1 target downloads and that the 'Other' object was downloaded to
+# our first store location.  Neither object should exist in the other store.
+foreach(should_exist
+    "${Store0}/MD5/aaad162b85f60d1eb57ca71a23e8efd7"
+    "${Store1}/MD5/8c018830e3efa5caf3c7415028335a57"
+    )
+  if(NOT EXISTS ${should_exist})
+    message(SEND_ERROR "Store file:\n  ${should_exist}\nshould exist!")
+  endif()
+endforeach()
+foreach(should_not_exist
+    "${Store0}/MD5/8c018830e3efa5caf3c7415028335a57"
+    "${Store1}/MD5/aaad162b85f60d1eb57ca71a23e8efd7"
+    )
+  if(EXISTS ${should_not_exist})
+    message(SEND_ERROR "Store file:\n  ${should_not_exist}\nshould not exist!")
+  endif()
+endforeach()

Tests/Module/ExternalData/Data3/Other.dat.md5

+aaad162b85f60d1eb57ca71a23e8efd7

Tests/Module/ExternalData/MD5/.gitattributes

+*               -crlf

Tests/Module/ExternalData/MD5/08cfcf221f76ace7b906b312284e73d7

+MetaTop

Tests/Module/ExternalData/MD5/30ba0acdee9096b3b9fc6c69362c6b42

+Series.3

Tests/Module/ExternalData/MD5/31eff09e84fca01415f8cd9d82ec432b

+Series.1

Tests/Module/ExternalData/MD5/401767f22a456b3522953722090a2c36

+PairedA

Tests/Module/ExternalData/MD5/8c018830e3efa5caf3c7415028335a57

+Input file already transformed.

Tests/Module/ExternalData/MD5/8f4add4581551facf27237e6577fd662

+MetaB

Tests/Module/ExternalData/MD5/9d980b06c2f0fec3d4872d68175b9822

+MetaA

Tests/Module/ExternalData/MD5/aaad162b85f60d1eb57ca71a23e8efd7

+Another input file already transformed.

Tests/Module/ExternalData/MD5/c1030719c95f3435d8abc39c0d442946

+MetaC

Tests/Module/ExternalData/MD5/ecfa1ecd417d4253af81ae04d1bd6581

+PairedB

Tests/Module/ExternalData/MD5/f41c94425d01ecbbee70440b951cb058

+Series

Tests/Module/ExternalData/MD5/f7ab5a04aae9cb9a520e70b20b9c8ed7

+Series.2

Tests/Module/ExternalData/MetaA.dat.md5

+9d980b06c2f0fec3d4872d68175b9822

Tests/Module/ExternalData/MetaB.dat.md5

+8f4add4581551facf27237e6577fd662

Tests/Module/ExternalData/MetaC.dat.md5

+c1030719c95f3435d8abc39c0d442946

Tests/Module/ExternalData/MetaTop.dat.md5

+08cfcf221f76ace7b906b312284e73d7

Tests/Module/ExternalData/PairedA.dat.md5

+401767f22a456b3522953722090a2c36

Tests/Module/ExternalData/PairedB.dat.md5

+ecfa1ecd417d4253af81ae04d1bd6581

Tests/Module/ExternalData/SeriesA.dat.md5

+f41c94425d01ecbbee70440b951cb058

Tests/Module/ExternalData/SeriesA1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesA2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesA3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesAn1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesAn2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesAn3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesB.dat.md5

+f41c94425d01ecbbee70440b951cb058

Tests/Module/ExternalData/SeriesB_1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesB_2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesB_3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesBn_1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesBn_2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesBn_3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesC.1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesC.2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesC.3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesC.dat.md5

+f41c94425d01ecbbee70440b951cb058

Tests/Module/ExternalData/SeriesCn.1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesCn.2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesCn.3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesD-1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesD-2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesD-3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/Module/ExternalData/SeriesD.dat.md5

+f41c94425d01ecbbee70440b951cb058

Tests/Module/ExternalData/SeriesDn-1.dat.md5

+31eff09e84fca01415f8cd9d82ec432b

Tests/Module/ExternalData/SeriesDn-2.dat.md5

+f7ab5a04aae9cb9a520e70b20b9c8ed7

Tests/Module/ExternalData/SeriesDn-3.dat.md5

+30ba0acdee9096b3b9fc6c69362c6b42

Tests/RunCMake/CMakeLists.txt

@@ -46,6 +46,7 @@ macro(add_RunCMake_test test)
 endmacro()
 
 add_RunCMake_test(CMP0019)
+add_RunCMake_test(ExternalData)
 add_RunCMake_test(GeneratorExpression)
 add_RunCMake_test(TargetPropertyGeneratorExpressions)
 add_RunCMake_test(Languages)

Tests/RunCMake/ExternalData/BadHashAlgo1-result.txt

+1

Tests/RunCMake/ExternalData/BadHashAlgo1-stderr.txt

+CMake Error at .*/Modules/ExternalData.cmake:[0-9]+ \(message\):
+  Unknown hash algorithm specified by ExternalData_LINK_CONTENT:
+
+    BAD
+Call Stack \(most recent call first\):
+  .*
+  BadHashAlgo1.cmake:3 \(ExternalData_Expand_Arguments\)
+  CMakeLists.txt:3 \(include\)

Tests/RunCMake/ExternalData/BadHashAlgo1.cmake

+include(ExternalData)
+set(ExternalData_LINK_CONTENT BAD)
+ExternalData_Expand_Arguments(Data args DATA{BadHashAlgo1.txt})

Tests/RunCMake/ExternalData/BadHashAlgo1.txt

+Sample input file that should not be transformed.

Tests/RunCMake/ExternalData/BadOption1-result.txt

+1

Tests/RunCMake/ExternalData/BadOption1-stderr.txt

+CMake Error at .*/Modules/ExternalData.cmake:[0-9]+ \(message\):
+  Unknown option "Bad/Option" in argument
+
+    DATA{Data.txt,Bad/Option}
+
+Call Stack \(most recent call first\):
+  .*
+  BadOption1.cmake:2 \(ExternalData_Add_Test\)
+  CMakeLists.txt:3 \(include\)

Tests/RunCMake/ExternalData/BadOption1.cmake

+include(ExternalData)
+ExternalData_Add_Test(Data
+  NAME Test
+  COMMAND ${CMAKE_COMMAND} -E echo DATA{Data.txt,Bad/Option}
+  )

Tests/RunCMake/ExternalData/BadOption2-result.txt

+1

Tests/RunCMake/ExternalData/BadOption2-stderr.txt

+CMake Error at .*/Modules/ExternalData.cmake:[0-9]+ \(message\):
+  Unknown option "Bad:Option" in argument
+
+    DATA{Data.txt,Bad:Option}
+
+Call Stack \(most recent call first\):
+  .*
+  BadOption2.cmake:2 \(ExternalData_Add_Test\)
+  CMakeLists.txt:3 \(include\)

Tests/RunCMake/ExternalData/BadOption2.cmake

+include(ExternalData)
+ExternalData_Add_Test(Data
+  NAME Test
+  COMMAND ${CMAKE_COMMAND} -E echo DATA{Data.txt,Bad:Option}
+  )

Tests/RunCMake/ExternalData/BadSeries1-result.txt

+1

Tests/RunCMake/ExternalData/BadSeries1-stderr.txt

+CMake Error at .*/Modules/ExternalData.cmake:[0-9]+ \(message\):
+  ExternalData_SERIES_PARSE is set to
+
+    NotASeriesRegex
+
+  which is not of the form
+
+    \(<number>\)\(<suffix>\)\$
+
+  Fix the regular expression or set variables
+
+    ExternalData_SERIES_PARSE_PREFIX = <prefix> regex group number, if any
+    ExternalData_SERIES_PARSE_NUMBER = <number> regex group number
+    ExternalData_SERIES_PARSE_SUFFIX = <suffix> regex group number
+
+Call Stack \(most recent call first\):
+  .*
+  BadSeries1.cmake:3 \(ExternalData_Expand_Arguments\)
+  CMakeLists.txt:3 \(include\)

Tests/RunCMake/ExternalData/BadSeries1.cmake

+include(ExternalData)
+set(ExternalData_SERIES_PARSE NotASeriesRegex)
+ExternalData_Expand_Arguments(Data args DATA{Data.txt,:})