bump version and update tests (#131)

* Use shallow clone for git repositories by default (#129)

* use shallow clone for git repositories by default

* remove trailing spaces

* Enable shallow clone for actual tags

* Support short commit hash

* Enable shallow only when downloading dependencies into cache

* Always honor user specified GIT_SHALLOW opiton

cmake/CPM.cmake

@@ -28,7 +28,7 @@
 
 cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
-set(CURRENT_CPM_VERSION 0.26.1)
+set(CURRENT_CPM_VERSION 0.27.1)
 
 if(CPM_DIRECTORY)
   if(NOT CPM_DIRECTORY STREQUAL CMAKE_CURRENT_LIST_DIR)
@@ -190,6 +190,8 @@ function(CPMAddPackage)
     SOURCE_DIR
     DOWNLOAD_COMMAND
     FIND_PACKAGE_ARGUMENTS
+    NO_CACHE
+    GIT_SHALLOW
   )
 
   set(multiValueArgs
@@ -229,6 +231,10 @@ function(CPMAddPackage)
 
   if (DEFINED CPM_ARGS_GIT_TAG)
     list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_TAG ${CPM_ARGS_GIT_TAG})
+    # If GIT_SHALLOW is explicitly specified, honor the value.
+    if (DEFINED CPM_ARGS_GIT_SHALLOW)
+      list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_SHALLOW ${CPM_ARGS_GIT_SHALLOW})
+    endif()
   endif()
 
   # Check if package has been added before
@@ -296,7 +302,7 @@ function(CPMAddPackage)
     list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS DOWNLOAD_COMMAND ${CPM_ARGS_DOWNLOAD_COMMAND})
   elseif (DEFINED CPM_ARGS_SOURCE_DIR)
     list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS SOURCE_DIR ${CPM_ARGS_SOURCE_DIR})
-  elseif (CPM_SOURCE_CACHE)
+  elseif (CPM_SOURCE_CACHE AND NOT CPM_ARGS_NO_CACHE)
     string(TOLOWER ${CPM_ARGS_NAME} lower_case_name)
     set(origin_parameters ${CPM_ARGS_UNPARSED_ARGUMENTS})
     list(SORT origin_parameters)
@@ -308,6 +314,15 @@ function(CPMAddPackage)
       list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS DOWNLOAD_COMMAND "${CMAKE_COMMAND}")
       set(PACKAGE_INFO "${download_directory}")
     else()
+      # Enable shallow clone when GIT_TAG is not a commit hash.
+      # Our guess may not be accurate, but it should guarantee no commit hash get mis-detected.
+      if (NOT DEFINED CPM_ARGS_GIT_SHALLOW)
+        cpm_is_git_tag_commit_hash("${CPM_ARGS_GIT_TAG}" IS_HASH)
+        if (NOT ${IS_HASH})
+          list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_SHALLOW TRUE)
+        endif()
+      endif()
+
       # remove timestamps so CMake will re-download the dependency
       file(REMOVE_RECURSE ${CMAKE_BINARY_DIR}/_deps/${lower_case_name}-subbuild)
       set(PACKAGE_INFO "${PACKAGE_INFO} -> ${download_directory}")
@@ -354,9 +369,10 @@ macro(cpm_export_variables name)
 endmacro()
 
 # declares a package, so that any call to CPMAddPackage for the
-# package name will use these arguments instead 
+# package name will use these arguments instead.
+# Previous declarations will not be overriden.
 macro(CPMDeclarePackage Name)
-  if (NOT DEFINED "${CPM_DECLARATION_${Name}}")
+  if (NOT DEFINED "CPM_DECLARATION_${Name}")
     set("CPM_DECLARATION_${Name}" "${ARGN}")
   endif()
 endmacro()
@@ -472,3 +488,18 @@ function(cpm_get_version_from_git_tag GIT_TAG RESULT)
     SET(${RESULT} ${CMAKE_MATCH_1} PARENT_SCOPE)
   endif()
 endfunction()
+
+# guesses if the git tag is a commit hash or an actual tag or a branch nane.
+function(cpm_is_git_tag_commit_hash GIT_TAG RESULT)
+  string(LENGTH "${GIT_TAG}" length)
+  # full hash has 40 characters, and short hash has at least 7 characters.
+  if (length LESS 7 OR length GREATER 40)
+    SET(${RESULT} 0 PARENT_SCOPE)
+  else()
+    if (${GIT_TAG} MATCHES "^[a-fA-F0-9]+$")
+      SET(${RESULT} 1 PARENT_SCOPE)
+    else()
+      SET(${RESULT} 0 PARENT_SCOPE)
+    endif()
+  endif()
+endfunction()

test/unit/cache.cmake

@@ -3,23 +3,19 @@ cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 include(${CPM_PATH}/testing.cmake)
 include(CMakePackageConfigHelpers)
 
-
 set(CPM_SOURCE_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/CPM")
-set(TEST_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/cache)
+set(TEST_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/remote_dependency)
 
 function(clear_cache)
   message(STATUS "clearing CPM cache")
   FILE(REMOVE_RECURSE ${CPM_SOURCE_CACHE_DIR})
-  
-  if (EXISTS "${CPM_SOURCE_CACHE_DIR}")
-    ASSERTION_FAILED("cache not cleared")
-  endif()
+  ASSERT_NOT_EXISTS("${CPM_SOURCE_CACHE_DIR}")
 endfunction()
 
 function(update_cmake_lists)
   configure_package_config_file(
-    "${CMAKE_CURRENT_LIST_DIR}/cache/CMakeLists.txt.in"
-    "${CMAKE_CURRENT_LIST_DIR}/cache/CMakeLists.txt"
+    "${CMAKE_CURRENT_LIST_DIR}/remote_dependency/CMakeLists.txt.in"
+    "${CMAKE_CURRENT_LIST_DIR}/remote_dependency/CMakeLists.txt"
     INSTALL_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/junk
   )
 endfunction()
@@ -38,15 +34,12 @@ reset_test()
 
 execute_process(
   COMMAND 
-  ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/cache" "-B${TEST_BUILD_DIR}" "-DCPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}"
+  ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/remote_dependency" "-B${TEST_BUILD_DIR}" "-DCPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}"
   RESULT_VARIABLE ret
 )
 
 ASSERT_EQUAL(${ret} "0")
-
-if (NOT EXISTS "${CPM_SOURCE_CACHE_DIR}/fibonacci")
-  ASSERTION_FAILED("fibonacci not in cache")
-endif()
+ASSERT_EXISTS("${CPM_SOURCE_CACHE_DIR}/fibonacci")
 
 FILE(GLOB FIBONACCI_VERSIONs "${CPM_SOURCE_CACHE_DIR}/fibonacci/*")
 list(LENGTH FIBONACCI_VERSIONs FIBONACCI_VERSION_count)
@@ -84,10 +77,7 @@ execute_process(
 )
 
 ASSERT_EQUAL(${ret} "0")
-
-if (NOT EXISTS "${CPM_SOURCE_CACHE_DIR}/fibonacci")
-  ASSERTION_FAILED("fibonacci not in cache")
-endif()
+ASSERT_EXISTS("${CPM_SOURCE_CACHE_DIR}/fibonacci")
 
 ## Read CPM_SOURCE_CACHE from environment
 
@@ -95,21 +85,18 @@ reset_test()
 
 execute_process(
   COMMAND 
-  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/cache" "-B${TEST_BUILD_DIR}"
+  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/remote_dependency" "-B${TEST_BUILD_DIR}"
   RESULT_VARIABLE ret
 )
 
 ASSERT_EQUAL(${ret} "0")
-
-if (NOT EXISTS "${CPM_SOURCE_CACHE_DIR}/fibonacci")
-  ASSERTION_FAILED("fibonacci not in cache")
-endif()
+ASSERT_EXISTS("${CPM_SOURCE_CACHE_DIR}/fibonacci")
 
 ## Reuse cached packages for other build
 
 execute_process(
   COMMAND 
-  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/cache" "-B${TEST_BUILD_DIR}-2"
+  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/remote_dependency" "-B${TEST_BUILD_DIR}-2"
   RESULT_VARIABLE ret
 )
 
@@ -121,12 +108,40 @@ reset_test()
 
 execute_process(
   COMMAND 
-  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CMAKE_CURRENT_BINARY_DIR}/junk" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/cache" "-B${TEST_BUILD_DIR}" "-DCPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}"
+  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CMAKE_CURRENT_BINARY_DIR}/junk" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/remote_dependency" "-B${TEST_BUILD_DIR}" "-DCPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}"
   RESULT_VARIABLE ret
 )
 
 ASSERT_EQUAL(${ret} "0")
+ASSERT_EXISTS("${CPM_SOURCE_CACHE_DIR}/fibonacci")
 
-if (NOT EXISTS "${CPM_SOURCE_CACHE_DIR}/fibonacci")
-  ASSERTION_FAILED("fibonacci not in cache")
-endif()
+## Use NO_CACHE option
+
+set(FIBONACCI_PACKAGE_ARGS "NO_CACHE YES")
+set(FIBONACCI_VERSION 1.0)
+update_cmake_lists()
+reset_test()
+
+execute_process(
+  COMMAND 
+  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/remote_dependency" "-B${TEST_BUILD_DIR}"
+  RESULT_VARIABLE ret
+)
+
+ASSERT_EQUAL(${ret} "0")
+ASSERT_NOT_EXISTS("${CPM_SOURCE_CACHE_DIR}/fibonacci")
+
+## Use commit hash after version
+
+set(FIBONACCI_PACKAGE_ARGS "NO_CACHE YES GIT_TAG e9ebf168ca0fffaa4ef8c6fefc6346aaa22f6ed5")
+set(FIBONACCI_VERSION 1.1)
+update_cmake_lists()
+
+execute_process(
+  COMMAND 
+  ${CMAKE_COMMAND} -E env "CPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/remote_dependency" "-B${TEST_BUILD_DIR}"
+  RESULT_VARIABLE ret
+)
+
+ASSERT_EQUAL(${ret} "0")
+ASSERT_NOT_EXISTS("${CPM_SOURCE_CACHE_DIR}/fibonacci")

test/unit/is_git_tag_commit_hash.cmake

@@ -0,0 +1,22 @@
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+include(${CPM_PATH}/CPM.cmake)
+include(${CPM_PATH}/testing.cmake)
+
+CPM_IS_GIT_TAG_COMMIT_HASH("v1.2.3" RESULT)
+ASSERT_EQUAL("0" ${RESULT})
+
+CPM_IS_GIT_TAG_COMMIT_HASH("asio-1-12-1" RESULT)
+ASSERT_EQUAL("0" ${RESULT})
+
+CPM_IS_GIT_TAG_COMMIT_HASH("513039e3cba83284cec71287fd829865b9f423bc" RESULT)
+ASSERT_EQUAL("1" ${RESULT})
+
+CPM_IS_GIT_TAG_COMMIT_HASH("513039E3CBA83284CEC71287FD829865B9F423BC" RESULT)
+ASSERT_EQUAL("1" ${RESULT})
+
+CPM_IS_GIT_TAG_COMMIT_HASH("513039E" RESULT)
+ASSERT_EQUAL("1" ${RESULT})
+
+CPM_IS_GIT_TAG_COMMIT_HASH("513039E3CBA8" RESULT)
+ASSERT_EQUAL("1" ${RESULT})

test/unit/modules.cmake

@@ -6,14 +6,14 @@ set(TEST_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/modules)
 
 function(initProjectWithDependency TEST_DEPENDENCY_NAME)
   configure_package_config_file(
-    "${CMAKE_CURRENT_LIST_DIR}/test_project/ModuleCMakeLists.txt.in"
-    "${CMAKE_CURRENT_LIST_DIR}/test_project/CMakeLists.txt"
+    "${CMAKE_CURRENT_LIST_DIR}/local_dependency/ModuleCMakeLists.txt.in"
+    "${CMAKE_CURRENT_LIST_DIR}/local_dependency/CMakeLists.txt"
     INSTALL_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/junk
   )
 
   execute_process(
     COMMAND 
-    ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/test_project" "-B${TEST_BUILD_DIR}"
+    ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/local_dependency" "-B${TEST_BUILD_DIR}"
     RESULT_VARIABLE ret
   )
 

test/unit/package-lock.cmake

@@ -10,20 +10,20 @@ function(configureWithDeclare DECLARE_DEPENDENCY)
   if (DECLARE_DEPENDENCY)
     set(PREPARE_CODE "CPMDeclarePackage(Dependency
       NAME Dependency 
-      SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/test_project/dependency
+      SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/local_dependency/dependency
     )")
   else()
     set(PREPARE_CODE "")
   endif()
 
   configure_package_config_file(
-    "${CMAKE_CURRENT_LIST_DIR}/test_project/PackageLockCMakeLists.txt.in"
-    "${CMAKE_CURRENT_LIST_DIR}/test_project/CMakeLists.txt"
+    "${CMAKE_CURRENT_LIST_DIR}/local_dependency/PackageLockCMakeLists.txt.in"
+    "${CMAKE_CURRENT_LIST_DIR}/local_dependency/CMakeLists.txt"
     INSTALL_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/junk
   )
 
   execute_process(
-    COMMAND ${CMAKE_COMMAND} -H${CMAKE_CURRENT_LIST_DIR}/test_project -B${TEST_BUILD_DIR} -DCPM_INCLUDE_ALL_IN_PACKAGE_LOCK=1
+    COMMAND ${CMAKE_COMMAND} -H${CMAKE_CURRENT_LIST_DIR}/local_dependency -B${TEST_BUILD_DIR} -DCPM_INCLUDE_ALL_IN_PACKAGE_LOCK=1
     RESULT_VARIABLE ret
   )
 
@@ -39,11 +39,11 @@ function(updatePackageLock)
   ASSERT_EQUAL(${ret} "0")
 endfunction()
 
-execute_process(COMMAND ${CMAKE_COMMAND} -E rm -f ${CMAKE_CURRENT_LIST_DIR}/test_project/package-lock.cmake)
+execute_process(COMMAND ${CMAKE_COMMAND} -E rm -f ${CMAKE_CURRENT_LIST_DIR}/local_dependency/package-lock.cmake)
 configureWithDeclare(YES)
-ASSERT_NOT_EXISTS(${CMAKE_CURRENT_LIST_DIR}/test_project/package-lock.cmake)
+ASSERT_NOT_EXISTS(${CMAKE_CURRENT_LIST_DIR}/local_dependency/package-lock.cmake)
 updatePackageLock()
-ASSERT_EXISTS(${CMAKE_CURRENT_LIST_DIR}/test_project/package-lock.cmake)
+ASSERT_EXISTS(${CMAKE_CURRENT_LIST_DIR}/local_dependency/package-lock.cmake)
 configureWithDeclare(NO)
-execute_process(COMMAND ${CMAKE_COMMAND} -E rm -f ${CMAKE_CURRENT_LIST_DIR}/test_project/package-lock.cmake)
+execute_process(COMMAND ${CMAKE_COMMAND} -E rm -f ${CMAKE_CURRENT_LIST_DIR}/local_dependency/package-lock.cmake)
 

test/unit/package-override.cmake

@@ -7,13 +7,13 @@ set(TEST_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/project-override)
 execute_process(COMMAND ${CMAKE_COMMAND} -E rm -rf ${TEST_BUILD_DIR})
 
 configure_package_config_file(
-  "${CMAKE_CURRENT_LIST_DIR}/test_project/OverrideCMakeLists.txt.in"
-  "${CMAKE_CURRENT_LIST_DIR}/test_project/CMakeLists.txt"
+  "${CMAKE_CURRENT_LIST_DIR}/local_dependency/OverrideCMakeLists.txt.in"
+  "${CMAKE_CURRENT_LIST_DIR}/local_dependency/CMakeLists.txt"
   INSTALL_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/junk
 )
 
 execute_process(
-  COMMAND ${CMAKE_COMMAND} -H${CMAKE_CURRENT_LIST_DIR}/test_project -B${TEST_BUILD_DIR} -DCPM_Dependency_SOURCE=${CMAKE_CURRENT_LIST_DIR}/test_project/dependency
+  COMMAND ${CMAKE_COMMAND} -H${CMAKE_CURRENT_LIST_DIR}/local_dependency -B${TEST_BUILD_DIR} -DCPM_Dependency_SOURCE=${CMAKE_CURRENT_LIST_DIR}/local_dependency/dependency
   RESULT_VARIABLE ret
 )
 

test/unit/remote_dependency/CMakeLists.txt.in

@@ -14,6 +14,7 @@ CPMAddPackage(
   NAME fibonacci
   GIT_REPOSITORY https://github.com/TheLartians/Fibonacci.git
   VERSION @FIBONACCI_VERSION@
+  @FIBONACCI_PACKAGE_ARGS@
 )
 
 # ---- Create binary ----

test/unit/source_dir.cmake

@@ -7,14 +7,14 @@ set(TEST_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/source_dir)
 set(TEST_DEPENDENCY_NAME Dependency)
 
 configure_package_config_file(
-  "${CMAKE_CURRENT_LIST_DIR}/test_project/ModuleCMakeLists.txt.in"
-  "${CMAKE_CURRENT_LIST_DIR}/test_project/CMakeLists.txt"
+  "${CMAKE_CURRENT_LIST_DIR}/local_dependency/ModuleCMakeLists.txt.in"
+  "${CMAKE_CURRENT_LIST_DIR}/local_dependency/CMakeLists.txt"
   INSTALL_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/junk
 )
 
 execute_process(
   COMMAND 
-  ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/test_project" "-B${TEST_BUILD_DIR}"
+  ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/local_dependency" "-B${TEST_BUILD_DIR}"
   RESULT_VARIABLE ret
 )