Add GENERATED package lock mode (pnpm/npm style, commit-pinned) #707
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| include(${CPM_PATH}/testing.cmake) | ||
|
|
||
| # Exercises `CPMUsePackageLock(<file> GENERATED)`: the lock must be written into the source tree on | ||
| # configure (no cpm-update-package-lock step) with git packages pinned to the resolved commit. Uses | ||
| # a throwaway local git repo so the test is hermetic (no network). | ||
|
|
||
| find_package(Git REQUIRED) | ||
|
|
||
| set(SCRATCH ${CMAKE_CURRENT_BINARY_DIR}/package-lock-generated) | ||
| set(REPO ${SCRATCH}/dep-repo) | ||
| set(PROJECT_DIR ${SCRATCH}/project) | ||
| set(BUILD_DIR ${SCRATCH}/build) | ||
| set(LOCK ${PROJECT_DIR}/package-lock.cmake) | ||
|
|
||
| execute_process(COMMAND ${CMAKE_COMMAND} -E rm -rf ${SCRATCH}) | ||
| file(MAKE_DIRECTORY ${REPO}) | ||
|
|
||
| # ---- create a dependency git repo with a single commit on branch `testbranch` ---- | ||
| file(WRITE ${REPO}/VERSION "1.0") | ||
|
|
||
| function(git) | ||
| execute_process( | ||
| COMMAND ${GIT_EXECUTABLE} ${ARGN} | ||
| WORKING_DIRECTORY ${REPO} | ||
| RESULT_VARIABLE git_result | ||
| OUTPUT_QUIET ERROR_QUIET | ||
| ) | ||
| assert_equal(${git_result} "0") | ||
| endfunction() | ||
|
|
||
| git(init) | ||
| git(config user.email "test@example.com") | ||
| git(config user.name "CPM Test") | ||
| git(add -A) | ||
| git(commit -m "initial commit") | ||
| git(branch -M testbranch) | ||
|
|
||
| execute_process( | ||
| COMMAND ${GIT_EXECUTABLE} rev-parse HEAD | ||
| WORKING_DIRECTORY ${REPO} | ||
| OUTPUT_VARIABLE EXPECTED_SHA | ||
| OUTPUT_STRIP_TRAILING_WHITESPACE | ||
| ) | ||
|
|
||
| # ---- a project that locks the dependency in GENERATED mode, declared against the branch ---- | ||
| file(MAKE_DIRECTORY ${PROJECT_DIR}) | ||
| file( | ||
| WRITE ${PROJECT_DIR}/CMakeLists.txt | ||
| "cmake_minimum_required(VERSION 3.14) | ||
| project(GeneratedLockTest NONE) | ||
| include(${CPM_PATH}/CPM.cmake) | ||
| CPMUsePackageLock(package-lock.cmake GENERATED) | ||
| CPMAddPackage( | ||
| NAME Dep | ||
| GIT_REPOSITORY ${REPO} | ||
| GIT_TAG testbranch | ||
| DOWNLOAD_ONLY YES | ||
| ) | ||
| " | ||
| ) | ||
|
|
||
| # Configure only — no `cpm-update-package-lock` target is built. | ||
| execute_process(COMMAND ${CMAKE_COMMAND} -S ${PROJECT_DIR} -B ${BUILD_DIR} RESULT_VARIABLE ret) | ||
| assert_equal(${ret} "0") | ||
|
|
||
| # The lock must have been authored into the source tree automatically. | ||
| assert_exists(${LOCK}) | ||
|
|
||
| file(READ ${LOCK} LOCK_RUN1) | ||
|
|
||
| string(FIND "${LOCK_RUN1}" "${EXPECTED_SHA}" sha_pos) | ||
| if(sha_pos EQUAL -1) | ||
| assertion_failed( | ||
| "generated lock did not pin Dep to the resolved commit ${EXPECTED_SHA}:\n${LOCK_RUN1}" | ||
| ) | ||
| endif() | ||
| message(STATUS "test passed: generated lock pinned Dep to ${EXPECTED_SHA}") | ||
|
|
||
| string(FIND "${LOCK_RUN1}" "GIT_TAG testbranch" branch_pos) | ||
| if(NOT branch_pos EQUAL -1) | ||
| assertion_failed("generated lock still references the moving branch instead of a commit") | ||
| endif() | ||
| message(STATUS "test passed: generated lock does not reference the moving branch") | ||
|
|
||
| # Reconfiguring must be idempotent: the pin is consumed and an identical lock is produced. | ||
| execute_process(COMMAND ${CMAKE_COMMAND} -S ${PROJECT_DIR} -B ${BUILD_DIR} RESULT_VARIABLE ret2) | ||
| assert_equal(${ret2} "0") | ||
| file(READ ${LOCK} LOCK_RUN2) | ||
| assert_equal("${LOCK_RUN1}" "${LOCK_RUN2}") | ||
| message(STATUS "test passed: generated lock is stable across reconfigures") |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| include(${CPM_PATH}/testing.cmake) | ||
|
|
||
| # Regression test for nested CPMUsePackageLock calls: when a dependency also calls | ||
| # CPMUsePackageLock, the nested call must be a no-op so it does not overwrite (or redirect writes | ||
| # away from) the consuming project's lock file. Uses a throwaway local git repo so the test is | ||
| # hermetic (no network). | ||
|
|
||
| find_package(Git REQUIRED) | ||
|
|
||
| set(SCRATCH ${CMAKE_CURRENT_BINARY_DIR}/package-lock-nested) | ||
| set(REPO ${SCRATCH}/dep-repo) | ||
| set(PROJECT_DIR ${SCRATCH}/project) | ||
| set(BUILD_DIR ${SCRATCH}/build) | ||
| set(LOCK ${PROJECT_DIR}/package-lock.cmake) | ||
|
|
||
| execute_process(COMMAND ${CMAKE_COMMAND} -E rm -rf ${SCRATCH}) | ||
| file(MAKE_DIRECTORY ${REPO}) | ||
|
|
||
| # ---- create a dependency that itself calls CPMUsePackageLock when added ---- | ||
| file( | ||
| WRITE ${REPO}/CMakeLists.txt | ||
| "cmake_minimum_required(VERSION 3.14) | ||
| project(Dep NONE) | ||
| include(${CPM_PATH}/CPM.cmake) | ||
| # A nested lock declaration that must not take effect (and so must never create dep-lock.cmake). | ||
| CPMUsePackageLock(dep-lock.cmake GENERATED) | ||
| " | ||
| ) | ||
|
|
||
| function(git) | ||
| execute_process( | ||
| COMMAND ${GIT_EXECUTABLE} ${ARGN} | ||
| WORKING_DIRECTORY ${REPO} | ||
| RESULT_VARIABLE git_result | ||
| OUTPUT_QUIET ERROR_QUIET | ||
| ) | ||
| assert_equal(${git_result} "0") | ||
| endfunction() | ||
|
|
||
| git(init) | ||
| git(config user.email "test@example.com") | ||
| git(config user.name "CPM Test") | ||
| git(add -A) | ||
| git(commit -m "initial commit") | ||
| git(branch -M testbranch) | ||
|
|
||
| execute_process( | ||
| COMMAND ${GIT_EXECUTABLE} rev-parse HEAD | ||
| WORKING_DIRECTORY ${REPO} | ||
| OUTPUT_VARIABLE EXPECTED_SHA | ||
| OUTPUT_STRIP_TRAILING_WHITESPACE | ||
| ) | ||
|
|
||
| # ---- a project that locks the dependency in GENERATED mode and pulls in the dependency ---- | ||
| file(MAKE_DIRECTORY ${PROJECT_DIR}) | ||
| file( | ||
| WRITE ${PROJECT_DIR}/CMakeLists.txt | ||
| "cmake_minimum_required(VERSION 3.14) | ||
| project(NestedLockTest NONE) | ||
| include(${CPM_PATH}/CPM.cmake) | ||
| CPMUsePackageLock(package-lock.cmake GENERATED) | ||
| CPMAddPackage( | ||
| NAME Dep | ||
| GIT_REPOSITORY ${REPO} | ||
| GIT_TAG testbranch | ||
| ) | ||
| " | ||
| ) | ||
|
|
||
| execute_process(COMMAND ${CMAKE_COMMAND} -S ${PROJECT_DIR} -B ${BUILD_DIR} RESULT_VARIABLE ret) | ||
| assert_equal(${ret} "0") | ||
|
|
||
| # The consuming project's lock must exist and pin the dependency: the nested CPMUsePackageLock in the | ||
| # dependency must not have redirected the recording to its own lock file. | ||
| assert_exists(${LOCK}) | ||
| file(READ ${LOCK} LOCK_CONTENTS) | ||
| string(FIND "${LOCK_CONTENTS}" "${EXPECTED_SHA}" sha_pos) | ||
| if(sha_pos EQUAL -1) | ||
| assertion_failed( | ||
| "consuming project's lock did not pin Dep to the resolved commit ${EXPECTED_SHA}; the nested " | ||
| "CPMUsePackageLock call was not a no-op:\n${LOCK_CONTENTS}" | ||
| ) | ||
| endif() | ||
| message(STATUS "test passed: nested CPMUsePackageLock did not hijack the consuming lock") | ||
|
|
||
| # The nested GENERATED call must not have authored a lock in the dependency's source tree. | ||
| assert_not_exists(${BUILD_DIR}/_deps/dep-src/dep-lock.cmake) | ||
| message(STATUS "test passed: nested CPMUsePackageLock did not create its own lock file") |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding documentation! We should add that also changing any additional arguments like the
OPTIONSwill not work without removing the lockfile or the entry from the lockfile first.Maybe it would also make sense to mark this as experimental for now, as for a proper npm-style lock one might expect.
CPMAddPackagewould still be respected, the lock should only impact theGIT_TAGandGIT_REPOSITORYentries.Implementing this in the future could be a breaking change or lead to unexpected updates, so it makes sense to advertise caution for now.