mirror of
https://github.com/cpm-cmake/CPM.cmake.git
synced 2025-11-18 15:17:30 -05:00
Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
96c268827b | ||
|
|
dad37fbe4e | ||
|
|
fed5f8e8a2 | ||
|
|
d65613e860 | ||
|
|
718ea71759 | ||
|
|
6491382204 | ||
|
|
634800c619 | ||
|
|
f552da96bd | ||
|
|
ea6a8eb895 | ||
|
|
a5c22bf6e8 | ||
|
|
c5cb85b2f1 | ||
|
|
91585e3864 | ||
|
|
9675d46517 | ||
|
|
7078e8286a | ||
|
|
6a0277f16e | ||
|
|
4502bf1e04 | ||
|
|
dd3ba9792c | ||
|
|
de5551e42c |
@@ -34,6 +34,7 @@ parse:
|
||||
HTTP_USERNAME: 1
|
||||
HTTP_PASSWORD: 1
|
||||
EXCLUDE_FROM_ALL: 1
|
||||
SOURCE_SUBDIR: 1
|
||||
OPTIONS: +
|
||||
cpmfindpackage:
|
||||
pargs:
|
||||
|
||||
30
.github/workflows/examples.yml
vendored
Normal file
30
.github/workflows/examples.yml
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
name: Examples
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
gcc:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: build all
|
||||
env:
|
||||
CC: gcc
|
||||
CXX: g++
|
||||
run: python3 examples/build_all.py
|
||||
|
||||
clang:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: build all
|
||||
env:
|
||||
CC: clang
|
||||
CXX: clang++
|
||||
run: python3 examples/build_all.py
|
||||
50
.travis.yml
50
.travis.yml
@@ -1,50 +0,0 @@
|
||||
language: cpp
|
||||
sudo: require
|
||||
dist: xenial
|
||||
|
||||
common_sources: &all_sources
|
||||
- ubuntu-toolchain-r-test
|
||||
- llvm-toolchain-trusty
|
||||
|
||||
python:
|
||||
- 3.7
|
||||
|
||||
matrix:
|
||||
include:
|
||||
- os: linux
|
||||
compiler: gcc
|
||||
addons: &gcc8
|
||||
apt:
|
||||
sources: *all_sources
|
||||
packages:
|
||||
- g++-8
|
||||
env:
|
||||
- MATRIX_EVAL="export CC=gcc-8; export CXX=g++-8;"
|
||||
|
||||
- os: linux
|
||||
compiler: clang
|
||||
addons:
|
||||
apt:
|
||||
sources: *all_sources
|
||||
packages:
|
||||
- g++-8
|
||||
- clang-6.0
|
||||
env:
|
||||
- MATRIX_EVAL="export CC=clang-6.0; export CXX=clang++-6.0;"
|
||||
|
||||
before_install:
|
||||
# Update compilers
|
||||
- eval "${MATRIX_EVAL}"
|
||||
- echo "CC=$CC CXX=$CXX"
|
||||
# Install a supported cmake version (>= 3.14)
|
||||
- wget -O cmake.sh https://cmake.org/files/v3.14/cmake-3.14.0-Linux-x86_64.sh
|
||||
- sudo sh cmake.sh --skip-license --exclude-subdir --prefix=/usr/local
|
||||
- export PATH=/usr/local/bin:$PATH
|
||||
- cmake --version
|
||||
|
||||
script:
|
||||
# unit tests
|
||||
- cmake -Htest -Bbuild/test
|
||||
- cmake --build build/test --target test-verbose
|
||||
# build examples
|
||||
- python3 examples/build_all.py
|
||||
39
README.md
39
README.md
@@ -1,4 +1,3 @@
|
||||
[](https://travis-ci.com/cpm-cmake/CPM.cmake)
|
||||
[](https://github.com/cpm-cmake/CPM.cmake/actions)
|
||||
[](https://github.com/cpm-cmake/CPM.cmake/actions)
|
||||
[](https://github.com/cpm-cmake/CPM.cmake/actions)
|
||||
@@ -44,7 +43,7 @@ CPMAddPackage(
|
||||
The origin may be specified by a `GIT_REPOSITORY`, but other sources, such as direct URLs, are [also supported](https://cmake.org/cmake/help/v3.11/module/ExternalProject.html#external-project-definition).
|
||||
If `GIT_TAG` hasn't been explicitly specified it defaults to `v(VERSION)`, a common convention for git projects.
|
||||
On the other hand, if `VERSION` hasn't been explicitly specified, CPM can automatically identify the version from the git tag in some common cases.
|
||||
`GIT_TAG` can also be set to a specific commit or a branch name such as `master` to always download the most recent version.
|
||||
`GIT_TAG` can also be set to a specific commit or a branch name such as `master`, however this isn't recommended, as such packages will only be updated when the cache is cleared.
|
||||
|
||||
If an additional optional parameter `EXCLUDE_FROM_ALL` is set to a truthy value, then any targets defined inside the dependency won't be built by default. See the [CMake docs](https://cmake.org/cmake/help/latest/prop_tgt/EXCLUDE_FROM_ALL.html) for details.
|
||||
|
||||
@@ -53,13 +52,13 @@ A single-argument compact syntax is also supported:
|
||||
```cmake
|
||||
# A git package from a given uri with a version
|
||||
CPMAddPackage("uri@version")
|
||||
# A git package from a given uri with a git tag or commit hash, or branch name
|
||||
# A git package from a given uri with a git tag or commit hash
|
||||
CPMAddPackage("uri#tag")
|
||||
# A git package with both version and tag provided
|
||||
CPMAddPackage("uri@version#tag")
|
||||
```
|
||||
|
||||
In the shorthand syntax if the URI is of the form `gh:user/name`, it is interpreted as GitHub URI and converted to `https://github.com/user/name.git`. If the URI is of the form `gl:user/name`, it is interpreted as a [GitLab](https://gitlab.com/explore/) URI and coverted to `https://gitlab.com/user/name.git`. Otherwise the URI used verbatim as a git URL. All packages added using the shorthand syntax will be added using the [EXCLUDE_FROM_ALL](https://cmake.org/cmake/help/latest/prop_tgt/EXCLUDE_FROM_ALL.html) flag.
|
||||
In the shorthand syntax if the URI is of the form `gh:user/name`, it is interpreted as GitHub URI and converted to `https://github.com/user/name.git`. If the URI is of the form `gl:user/name`, it is interpreted as a [GitLab](https://gitlab.com/explore/) URI and converted to `https://gitlab.com/user/name.git`. If the URI is of the form `bb:user/name`, it is interpreted as a [Bitbucket](https://bitbucket.org/) URI and converted to `https://bitbucket.org/user/name.git`. Otherwise the URI used verbatim as a git URL. All packages added using the shorthand syntax will be added using the [EXCLUDE_FROM_ALL](https://cmake.org/cmake/help/latest/prop_tgt/EXCLUDE_FROM_ALL.html) flag.
|
||||
|
||||
The single-argument syntax also works for URLs:
|
||||
|
||||
@@ -156,7 +155,7 @@ CPM.cmake is a wrapper for CMake's FetchContent module and adds a number of feat
|
||||
The most notable features are:
|
||||
|
||||
- A simpler to use API
|
||||
- Version checking: CPM.cmake will check the version number of any added dependency and omit a warning if another dependency requires a more recent version.
|
||||
- Version checking: CPM.cmake will check the version number of any added dependency and emit a warning if another dependency requires a more recent version.
|
||||
- Offline builds: CPM.cmake will override CMake's download and update commands, which allows new builds to be configured while offline if all dependencies [are available locally](#cpm_source_cache).
|
||||
- Automatic shallow clone: if a version tag (e.g. `v2.2.0`) is provided and `CPM_SOURCE_CACHE` is used, CPM.cmake will perform a shallow clone of the dependency, which should be significantly faster while using less storage than a full clone.
|
||||
- Overridable: all `CPMAddPackage` can be configured to use `find_package` by setting a [CMake flag](#cpm_use_local_packages), making it easy to integrate into projects that may require local versioning through the system's package manager.
|
||||
@@ -196,6 +195,11 @@ These options can also be set as environmental variables.
|
||||
|
||||
In the case that `find_package` requires additional arguments, the parameter `FIND_PACKAGE_ARGUMENTS` may be specified in the `CPMAddPackage` call. The value of this parameter will be forwarded to `find_package`.
|
||||
|
||||
### CPM_USE_NAMED_CACHE_DIRECTORIES
|
||||
|
||||
If set, CPM use additional directory level in cache to improve readability of packages names in IDEs like CLion. It changes cache structure, so all dependencies are downloaded again. There is no problem to mix both structures in one cache directory but then there may be 2 copies of some dependencies.
|
||||
This can also be set as an environmental variable.
|
||||
|
||||
## Local package override
|
||||
|
||||
Library developers are often in the situation where they work on a locally checked out dependency at the same time as on a consumer project.
|
||||
@@ -270,10 +274,10 @@ See the [wiki](https://github.com/cpm-cmake/CPM.cmake/wiki/More-Snippets) for mo
|
||||
CPMAddPackage("gh:catchorg/Catch2@2.5.0")
|
||||
```
|
||||
|
||||
### [Boost (via boost-cmake)](https://github.com/Orphis/boost-cmake)
|
||||
### [Range-v3](https://github.com/ericniebler/range-v3)
|
||||
|
||||
```CMake
|
||||
CPMAddPackage("gh:Orphis/boost-cmake@1.67.0")
|
||||
```Cmake
|
||||
CPMAddPackage("gh:ericniebler/range-v3#0.11.0")
|
||||
```
|
||||
|
||||
### [Yaml-cpp](https://github.com/jbeder/yaml-cpp)
|
||||
@@ -283,12 +287,6 @@ CPMAddPackage("gh:Orphis/boost-cmake@1.67.0")
|
||||
CPMAddPackage("gh:jbeder/yaml-cpp#yaml-cpp-0.6.3@0.6.3")
|
||||
```
|
||||
|
||||
### [Range-v3](https://github.com/ericniebler/range-v3)
|
||||
|
||||
```Cmake
|
||||
CPMAddPackage("gh:ericniebler/range-v3#0.11.0")
|
||||
```
|
||||
|
||||
### [nlohmann/json](https://github.com/nlohmann/json)
|
||||
|
||||
```cmake
|
||||
@@ -300,6 +298,19 @@ CPMAddPackage(
|
||||
)
|
||||
```
|
||||
|
||||
### [Boost ](https://github.com/boostorg/boost)
|
||||
|
||||
```CMake
|
||||
# boost is a huge project and will take a while to download
|
||||
# using `CPM_SOURCE_CACHE` is strongly recommended
|
||||
CPMAddPackage(
|
||||
NAME Boost
|
||||
VERSION 1.77.0
|
||||
GITHUB_REPOSITORY "boostorg/boost"
|
||||
GIT_TAG "boost-1.77.0"
|
||||
)
|
||||
```
|
||||
|
||||
### [cxxopts](https://github.com/jarro2783/cxxopts)
|
||||
|
||||
```cmake
|
||||
|
||||
154
cmake/CPM.cmake
154
cmake/CPM.cmake
@@ -57,6 +57,13 @@ See https://github.com/cpm-cmake/CPM.cmake for more information."
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(CURRENT_CPM_VERSION MATCHES "development-version")
|
||||
message(WARNING "Your project is using an unstable development version of CPM.cmake. \
|
||||
Please update to a recent release if possible. \
|
||||
See https://github.com/cpm-cmake/CPM.cmake for details."
|
||||
)
|
||||
endif()
|
||||
|
||||
set_property(GLOBAL PROPERTY CPM_INITIALIZED true)
|
||||
|
||||
option(CPM_USE_LOCAL_PACKAGES "Always try to use `find_package` to get dependencies"
|
||||
@@ -76,6 +83,10 @@ option(CPM_INCLUDE_ALL_IN_PACKAGE_LOCK
|
||||
"Add all packages added through CPM.cmake to the package lock"
|
||||
$ENV{CPM_INCLUDE_ALL_IN_PACKAGE_LOCK}
|
||||
)
|
||||
option(CPM_USE_NAMED_CACHE_DIRECTORIES
|
||||
"Use additional directory of package name in cache on the most nested level."
|
||||
$ENV{CPM_USE_NAMED_CACHE_DIRECTORIES}
|
||||
)
|
||||
|
||||
set(CPM_VERSION
|
||||
${CURRENT_CPM_VERSION}
|
||||
@@ -223,7 +234,7 @@ function(cpm_create_module_file Name)
|
||||
if(NOT CPM_DONT_UPDATE_MODULE_PATH)
|
||||
# erase any previous modules
|
||||
file(WRITE ${CPM_MODULE_PATH}/Find${Name}.cmake
|
||||
"include(${CPM_FILE})\n${ARGN}\nset(${Name}_FOUND TRUE)"
|
||||
"include(\"${CPM_FILE}\")\n${ARGN}\nset(${Name}_FOUND TRUE)"
|
||||
)
|
||||
endif()
|
||||
endfunction()
|
||||
@@ -302,6 +313,9 @@ function(cpm_parse_add_package_single_arg arg outArgs)
|
||||
elseif(scheme STREQUAL "gl")
|
||||
set(out "GITLAB_REPOSITORY;${uri}")
|
||||
set(packageType "git")
|
||||
elseif(scheme STREQUAL "bb")
|
||||
set(out "BITBUCKET_REPOSITORY;${uri}")
|
||||
set(packageType "git")
|
||||
# A CPM-specific scheme was not found. Looks like this is a generic URL so try to determine
|
||||
# type
|
||||
elseif(arg MATCHES ".git/?(@|#|$)")
|
||||
@@ -351,6 +365,68 @@ function(cpm_parse_add_package_single_arg arg outArgs)
|
||||
)
|
||||
endfunction()
|
||||
|
||||
# Check that the working directory for a git repo is clean
|
||||
function(cpm_check_git_working_dir_is_clean repoPath gitTag isClean)
|
||||
|
||||
find_package(Git REQUIRED)
|
||||
|
||||
if(NOT GIT_EXECUTABLE)
|
||||
# No git executable, assume directory is clean
|
||||
set(${isClean}
|
||||
TRUE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
return()
|
||||
endif()
|
||||
|
||||
# check for uncommited changes
|
||||
execute_process(
|
||||
COMMAND ${GIT_EXECUTABLE} status --porcelain
|
||||
RESULT_VARIABLE resultGitStatus
|
||||
OUTPUT_VARIABLE repoStatus
|
||||
OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET
|
||||
WORKING_DIRECTORY ${repoPath}
|
||||
)
|
||||
if(resultGitStatus)
|
||||
# not supposed to happen, assume clean anyway
|
||||
message(WARNING "Calling git status on folder ${repoPath} failed")
|
||||
set(${isClean}
|
||||
TRUE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
return()
|
||||
endif()
|
||||
|
||||
if(NOT "${repoStatus}" STREQUAL "")
|
||||
set(${isClean}
|
||||
FALSE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
return()
|
||||
endif()
|
||||
|
||||
# check for commited changes
|
||||
execute_process(
|
||||
COMMAND ${GIT_EXECUTABLE} diff -s --exit-code ${gitTag}
|
||||
RESULT_VARIABLE resultGitDiff
|
||||
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_QUIET
|
||||
WORKING_DIRECTORY ${repoPath}
|
||||
)
|
||||
|
||||
if(${resultGitDiff} EQUAL 0)
|
||||
set(${isClean}
|
||||
TRUE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
else()
|
||||
set(${isClean}
|
||||
FALSE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
endif()
|
||||
|
||||
endfunction()
|
||||
|
||||
# Download and add a package from source
|
||||
function(CPMAddPackage)
|
||||
list(LENGTH ARGN argnLength)
|
||||
@@ -369,6 +445,7 @@ function(CPMAddPackage)
|
||||
DOWNLOAD_ONLY
|
||||
GITHUB_REPOSITORY
|
||||
GITLAB_REPOSITORY
|
||||
BITBUCKET_REPOSITORY
|
||||
GIT_REPOSITORY
|
||||
SOURCE_DIR
|
||||
DOWNLOAD_COMMAND
|
||||
@@ -399,10 +476,10 @@ function(CPMAddPackage)
|
||||
|
||||
if(DEFINED CPM_ARGS_GITHUB_REPOSITORY)
|
||||
set(CPM_ARGS_GIT_REPOSITORY "https://github.com/${CPM_ARGS_GITHUB_REPOSITORY}.git")
|
||||
endif()
|
||||
|
||||
if(DEFINED CPM_ARGS_GITLAB_REPOSITORY)
|
||||
elseif(DEFINED CPM_ARGS_GITLAB_REPOSITORY)
|
||||
set(CPM_ARGS_GIT_REPOSITORY "https://gitlab.com/${CPM_ARGS_GITLAB_REPOSITORY}.git")
|
||||
elseif(DEFINED CPM_ARGS_BITBUCKET_REPOSITORY)
|
||||
set(CPM_ARGS_GIT_REPOSITORY "https://bitbucket.org/${CPM_ARGS_BITBUCKET_REPOSITORY}.git")
|
||||
endif()
|
||||
|
||||
if(DEFINED CPM_ARGS_GIT_REPOSITORY)
|
||||
@@ -466,10 +543,13 @@ function(CPMAddPackage)
|
||||
set(PACKAGE_SOURCE ${CPM_${CPM_ARGS_NAME}_SOURCE})
|
||||
set(CPM_${CPM_ARGS_NAME}_SOURCE "")
|
||||
CPMAddPackage(
|
||||
NAME ${CPM_ARGS_NAME}
|
||||
SOURCE_DIR ${PACKAGE_SOURCE}
|
||||
NAME "${CPM_ARGS_NAME}"
|
||||
SOURCE_DIR "${PACKAGE_SOURCE}"
|
||||
EXCLUDE_FROM_ALL "${CPM_ARGS_EXCLUDE_FROM_ALL}"
|
||||
OPTIONS "${CPM_ARGS_OPTIONS}"
|
||||
SOURCE_SUBDIR "${CPM_ARGS_SOURCE_SUBDIR}"
|
||||
DOWNLOAD_ONLY "${DOWNLOAD_ONLY}"
|
||||
FORCE True
|
||||
OPTIONS ${CPM_ARGS_OPTIONS}
|
||||
)
|
||||
cpm_export_variables(${CPM_ARGS_NAME})
|
||||
return()
|
||||
@@ -527,14 +607,31 @@ function(CPMAddPackage)
|
||||
string(TOLOWER ${CPM_ARGS_NAME} lower_case_name)
|
||||
set(origin_parameters ${CPM_ARGS_UNPARSED_ARGUMENTS})
|
||||
list(SORT origin_parameters)
|
||||
string(SHA1 origin_hash "${origin_parameters}")
|
||||
set(download_directory ${CPM_SOURCE_CACHE}/${lower_case_name}/${origin_hash})
|
||||
if(CPM_USE_NAMED_CACHE_DIRECTORIES)
|
||||
string(SHA1 origin_hash "${origin_parameters};NEW_CACHE_STRUCTURE_TAG")
|
||||
set(download_directory ${CPM_SOURCE_CACHE}/${lower_case_name}/${origin_hash}/${CPM_ARGS_NAME})
|
||||
else()
|
||||
string(SHA1 origin_hash "${origin_parameters}")
|
||||
set(download_directory ${CPM_SOURCE_CACHE}/${lower_case_name}/${origin_hash})
|
||||
endif()
|
||||
# Expand `download_directory` relative path. This is important because EXISTS doesn't work for
|
||||
# relative paths.
|
||||
get_filename_component(download_directory ${download_directory} ABSOLUTE)
|
||||
list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS SOURCE_DIR ${download_directory})
|
||||
if(EXISTS ${download_directory})
|
||||
# avoid FetchContent modules to improve performance
|
||||
set(${CPM_ARGS_NAME}_BINARY_DIR ${CPM_FETCHCONTENT_BASE_DIR}/${lower_case_name}-build)
|
||||
set(${CPM_ARGS_NAME}_ADDED YES)
|
||||
set(${CPM_ARGS_NAME}_SOURCE_DIR ${download_directory})
|
||||
|
||||
if(DEFINED CPM_ARGS_GIT_TAG)
|
||||
# warn if cache has been changed since checkout
|
||||
cpm_check_git_working_dir_is_clean(${download_directory} ${CPM_ARGS_GIT_TAG} IS_CLEAN)
|
||||
if(NOT ${IS_CLEAN})
|
||||
message(WARNING "Cache for ${CPM_ARGS_NAME} (${download_directory}) is dirty")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
cpm_add_subdirectory(
|
||||
"${CPM_ARGS_NAME}" "${DOWNLOAD_ONLY}"
|
||||
"${${CPM_ARGS_NAME}_SOURCE_DIR}/${CPM_ARGS_SOURCE_SUBDIR}" "${${CPM_ARGS_NAME}_BINARY_DIR}"
|
||||
@@ -578,12 +675,14 @@ function(CPMAddPackage)
|
||||
cpm_declare_fetch(
|
||||
"${CPM_ARGS_NAME}" "${CPM_ARGS_VERSION}" "${PACKAGE_INFO}" "${CPM_ARGS_UNPARSED_ARGUMENTS}"
|
||||
)
|
||||
cpm_fetch_package("${CPM_ARGS_NAME}")
|
||||
cpm_add_subdirectory(
|
||||
"${CPM_ARGS_NAME}" "${DOWNLOAD_ONLY}"
|
||||
"${${CPM_ARGS_NAME}_SOURCE_DIR}/${CPM_ARGS_SOURCE_SUBDIR}" "${${CPM_ARGS_NAME}_BINARY_DIR}"
|
||||
"${CPM_ARGS_EXCLUDE_FROM_ALL}" "${CPM_ARGS_OPTIONS}"
|
||||
)
|
||||
cpm_fetch_package("${CPM_ARGS_NAME}" populated)
|
||||
if(${populated})
|
||||
cpm_add_subdirectory(
|
||||
"${CPM_ARGS_NAME}" "${DOWNLOAD_ONLY}"
|
||||
"${${CPM_ARGS_NAME}_SOURCE_DIR}/${CPM_ARGS_SOURCE_SUBDIR}" "${${CPM_ARGS_NAME}_BINARY_DIR}"
|
||||
"${CPM_ARGS_EXCLUDE_FROM_ALL}" "${CPM_ARGS_OPTIONS}"
|
||||
)
|
||||
endif()
|
||||
cpm_get_fetch_properties("${CPM_ARGS_NAME}")
|
||||
endif()
|
||||
|
||||
@@ -728,8 +827,8 @@ function(
|
||||
set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
|
||||
|
||||
foreach(OPTION ${OPTIONS})
|
||||
cpm_parse_option(${OPTION})
|
||||
set(${OPTION_KEY} ${OPTION_VALUE})
|
||||
cpm_parse_option("${OPTION}")
|
||||
set(${OPTION_KEY} "${OPTION_VALUE}")
|
||||
endforeach()
|
||||
endif()
|
||||
set(CPM_OLD_INDENT "${CPM_INDENT}")
|
||||
@@ -741,7 +840,11 @@ endfunction()
|
||||
|
||||
# downloads a previously declared package via FetchContent and exports the variables
|
||||
# `${PACKAGE}_SOURCE_DIR` and `${PACKAGE}_BINARY_DIR` to the parent scope
|
||||
function(cpm_fetch_package PACKAGE)
|
||||
function(cpm_fetch_package PACKAGE populated)
|
||||
set(${populated}
|
||||
FALSE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
if(${CPM_DRY_RUN})
|
||||
message(STATUS "${CPM_INDENT} package ${PACKAGE} not fetched (dry run)")
|
||||
return()
|
||||
@@ -749,11 +852,16 @@ function(cpm_fetch_package PACKAGE)
|
||||
|
||||
FetchContent_GetProperties(${PACKAGE})
|
||||
|
||||
string(TOLOWER "${PACKAGE}" lower_case_name)
|
||||
|
||||
if(NOT ${lower_case_name}_POPULATED)
|
||||
FetchContent_Populate(${PACKAGE})
|
||||
set(${populated}
|
||||
TRUE
|
||||
PARENT_SCOPE
|
||||
)
|
||||
endif()
|
||||
|
||||
string(TOLOWER "${PACKAGE}" lower_case_name)
|
||||
set(${PACKAGE}_SOURCE_DIR
|
||||
${${lower_case_name}_SOURCE_DIR}
|
||||
PARENT_SCOPE
|
||||
@@ -766,15 +874,15 @@ endfunction()
|
||||
|
||||
# splits a package option
|
||||
function(cpm_parse_option OPTION)
|
||||
string(REGEX MATCH "^[^ ]+" OPTION_KEY ${OPTION})
|
||||
string(LENGTH ${OPTION} OPTION_LENGTH)
|
||||
string(LENGTH ${OPTION_KEY} OPTION_KEY_LENGTH)
|
||||
string(REGEX MATCH "^[^ ]+" OPTION_KEY "${OPTION}")
|
||||
string(LENGTH "${OPTION}" OPTION_LENGTH)
|
||||
string(LENGTH "${OPTION_KEY}" OPTION_KEY_LENGTH)
|
||||
if(OPTION_KEY_LENGTH STREQUAL OPTION_LENGTH)
|
||||
# no value for key provided, assume user wants to set option to "ON"
|
||||
set(OPTION_VALUE "ON")
|
||||
else()
|
||||
math(EXPR OPTION_KEY_LENGTH "${OPTION_KEY_LENGTH}+1")
|
||||
string(SUBSTRING ${OPTION} "${OPTION_KEY_LENGTH}" "-1" OPTION_VALUE)
|
||||
string(SUBSTRING "${OPTION}" "${OPTION_KEY_LENGTH}" "-1" OPTION_VALUE)
|
||||
endif()
|
||||
set(OPTION_KEY
|
||||
"${OPTION_KEY}"
|
||||
|
||||
7
examples/TestingFramework/CMakeLists.txt
Normal file
7
examples/TestingFramework/CMakeLists.txt
Normal file
@@ -0,0 +1,7 @@
|
||||
cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
|
||||
|
||||
project(CPMTestingFrameworkExample)
|
||||
|
||||
include(../../cmake/CPM.cmake)
|
||||
CPMAddPackage("bb:HEMRND/TestingFramework@0.4.1")
|
||||
add_test_suites(TESTS SomeTest)
|
||||
19
examples/TestingFramework/SomeTest.cpp
Normal file
19
examples/TestingFramework/SomeTest.cpp
Normal file
@@ -0,0 +1,19 @@
|
||||
#include <HEM/TestingFramework.hpp>
|
||||
|
||||
using namespace fakeit;
|
||||
|
||||
class ITest {
|
||||
public:
|
||||
virtual int getInt() = 0;
|
||||
};
|
||||
|
||||
TEST_CASE("Testing Framework Test") {
|
||||
constexpr int someIntValue = 123456;
|
||||
|
||||
Mock<ITest> testMock;
|
||||
When(Method(testMock, getInt)).Return(someIntValue);
|
||||
|
||||
int readValue = testMock.get().getInt();
|
||||
|
||||
REQUIRE(readValue == someIntValue);
|
||||
}
|
||||
@@ -11,14 +11,11 @@ target_compile_features(CPMExampleBoost PRIVATE cxx_std_17)
|
||||
|
||||
include(../../cmake/CPM.cmake)
|
||||
|
||||
CPMFindPackage(
|
||||
CPMAddPackage(
|
||||
NAME Boost
|
||||
GITHUB_REPOSITORY Orphis/boost-cmake
|
||||
VERSION 1.67.0
|
||||
# setting FIND_PACKAGE_ARGUMENTS allow usage with `CPM_USE_LOCAL_PACKAGES`
|
||||
FIND_PACKAGE_ARGUMENTS "COMPONENTS system"
|
||||
VERSION 1.77.0
|
||||
GITHUB_REPOSITORY "boostorg/boost"
|
||||
GIT_TAG "boost-1.77.0"
|
||||
)
|
||||
|
||||
find_package(Threads REQUIRED)
|
||||
|
||||
target_link_libraries(CPMExampleBoost PRIVATE Boost::system Threads::Threads)
|
||||
target_link_libraries(CPMExampleBoost PRIVATE Boost::asio)
|
||||
|
||||
@@ -3,8 +3,14 @@
|
||||
|
||||
int main(int argc, char** argv) {
|
||||
cxxopts::Options options("MyProgram", "One line description of MyProgram");
|
||||
options.add_options()("h,help", "Show help")("d,debug", "Enable debugging")(
|
||||
"f,file", "File name", cxxopts::value<std::string>());
|
||||
|
||||
// clang-format off
|
||||
options.add_options()
|
||||
("h,help", "Show help")
|
||||
("d,debug", "Enable debugging")
|
||||
("f,file", "File name", cxxopts::value<std::string>()
|
||||
);
|
||||
// clang-format on
|
||||
|
||||
auto result = options.parse(argc, argv);
|
||||
|
||||
|
||||
49
test/unit/dirty-cache-check.cmake
Normal file
49
test/unit/dirty-cache-check.cmake
Normal file
@@ -0,0 +1,49 @@
|
||||
include(${CPM_PATH}/CPM.cmake)
|
||||
include(${CPM_PATH}/testing.cmake)
|
||||
|
||||
set(baseDir "${CMAKE_CURRENT_BINARY_DIR}/test_dirty_cache")
|
||||
|
||||
find_package(Git REQUIRED)
|
||||
|
||||
function(git_do dir)
|
||||
execute_process(
|
||||
COMMAND ${GIT_EXECUTABLE} -c user.name='User' -c user.email='user@email.org' ${ARGN}
|
||||
RESULT_VARIABLE result
|
||||
OUTPUT_VARIABLE status
|
||||
OUTPUT_STRIP_TRAILING_WHITESPACE
|
||||
WORKING_DIRECTORY "${dir}"
|
||||
)
|
||||
if(result)
|
||||
message(FATAL_ERROR "git ${ARGN} fail: ${result} ${status}")
|
||||
endif()
|
||||
endfunction()
|
||||
|
||||
file(MAKE_DIRECTORY "${baseDir}")
|
||||
|
||||
file(WRITE "${baseDir}/draft.txt" "this is a test")
|
||||
|
||||
git_do("${baseDir}" init -b main)
|
||||
git_do("${baseDir}" commit --allow-empty -m "empty repo")
|
||||
message(STATUS "empty repo with file")
|
||||
cpm_check_git_working_dir_is_clean(${baseDir} HEAD emptygit_test)
|
||||
assert_falsy(emptygit_test)
|
||||
|
||||
git_do("${baseDir}" add draft.txt)
|
||||
git_do("${baseDir}" commit -m "test change")
|
||||
git_do("${baseDir}" tag v0.0.0)
|
||||
message(STATUS "commit a change")
|
||||
cpm_check_git_working_dir_is_clean(${baseDir} v0.0.0 onecommit_test)
|
||||
assert_truthy(onecommit_test)
|
||||
|
||||
file(WRITE "${baseDir}/draft.txt" "a modification")
|
||||
message(STATUS "dirty repo")
|
||||
cpm_check_git_working_dir_is_clean(${baseDir} v0.0.0 nonemptygit_test)
|
||||
assert_falsy(nonemptygit_test)
|
||||
|
||||
git_do("${baseDir}" add draft.txt)
|
||||
git_do("${baseDir}" commit -m "another change")
|
||||
message(STATUS "repo clean")
|
||||
cpm_check_git_working_dir_is_clean(${baseDir} v0.0.0 twocommit_test)
|
||||
assert_falsy(twocommit_test)
|
||||
|
||||
file(REMOVE_RECURSE "${baseDir}")
|
||||
38
test/unit/fetchcontent_dependency.cmake
Normal file
38
test/unit/fetchcontent_dependency.cmake
Normal file
@@ -0,0 +1,38 @@
|
||||
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}/fetchcontent_dependency)
|
||||
|
||||
function(clear_cache)
|
||||
message(STATUS "clearing CPM cache")
|
||||
file(REMOVE_RECURSE ${CPM_SOURCE_CACHE_DIR})
|
||||
assert_not_exists("${CPM_SOURCE_CACHE_DIR}")
|
||||
endfunction()
|
||||
|
||||
function(update_cmake_lists)
|
||||
configure_package_config_file(
|
||||
"${CMAKE_CURRENT_LIST_DIR}/fetchcontent_dependency/CMakeLists.txt.in"
|
||||
"${CMAKE_CURRENT_LIST_DIR}/fetchcontent_dependency/CMakeLists.txt"
|
||||
INSTALL_DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/junk
|
||||
)
|
||||
endfunction()
|
||||
|
||||
function(reset_test)
|
||||
clear_cache()
|
||||
file(REMOVE_RECURSE ${TEST_BUILD_DIR})
|
||||
update_cmake_lists()
|
||||
endfunction()
|
||||
|
||||
# Read CPM_SOURCE_CACHE from arguments
|
||||
|
||||
reset_test()
|
||||
|
||||
execute_process(
|
||||
COMMAND ${CMAKE_COMMAND} "-H${CMAKE_CURRENT_LIST_DIR}/fetchcontent_dependency"
|
||||
"-B${TEST_BUILD_DIR}" "-DCPM_SOURCE_CACHE=${CPM_SOURCE_CACHE_DIR}" RESULT_VARIABLE ret
|
||||
)
|
||||
|
||||
assert_equal(${ret} "0")
|
||||
2
test/unit/fetchcontent_dependency/.gitignore
vendored
Normal file
2
test/unit/fetchcontent_dependency/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
/CMakeLists.txt
|
||||
/package-lock.cmake
|
||||
38
test/unit/fetchcontent_dependency/CMakeLists.txt.in
Normal file
38
test/unit/fetchcontent_dependency/CMakeLists.txt.in
Normal file
@@ -0,0 +1,38 @@
|
||||
# ~~~
|
||||
# ┌────────────────────────┐
|
||||
# │ FetchContentDependency │
|
||||
# └─────┬────────────┬─────┘
|
||||
# │1. │3.
|
||||
# │ │
|
||||
# ┌────────▼────┐ ┌───▼─────────┐
|
||||
# │ Dependency ├───► Fibonacci │
|
||||
# └─────────────┘2. └─────────────┘
|
||||
#
|
||||
# 1. Add Project with CPMAddPackage
|
||||
# 2. Dependency will add Fibonacci with FetchContent
|
||||
# 3. Our project add Fibonacci with CPMAddPackage
|
||||
# ~~~
|
||||
|
||||
cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
|
||||
|
||||
project(CPMTest_FetchContentDependency)
|
||||
|
||||
# ---- Dependencies ----
|
||||
|
||||
include(@CPM_PATH@/CPM.cmake)
|
||||
|
||||
# 1 & 2 Dependency will add Fibonacci using FetchContent (1 & 2)
|
||||
CPMAddPackage(NAME Dependency SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/dependency)
|
||||
|
||||
# 3 Add again Fibonacci that have already been populated with FetchContent_MakeAvailable
|
||||
#
|
||||
# * This test should highlight the fact that cpm_add_subdirectory is always called, even when
|
||||
# cpm_fetch_package isn't populating the dependency
|
||||
# * NO_CACHE YES highlight a bug introduced in 32b063eba5c754f833725ed4b9e5f352bc3ca959 where
|
||||
# cpm_fetch_package was checking undefined ${lower_case_name}_POPULATED variable
|
||||
CPMAddPackage(
|
||||
NAME Fibonacci
|
||||
GIT_REPOSITORY https://github.com/cpm-cmake/testpack-fibonacci.git
|
||||
VERSION 2.0
|
||||
NO_CACHE YES
|
||||
)
|
||||
15
test/unit/fetchcontent_dependency/dependency/CMakeLists.txt
Normal file
15
test/unit/fetchcontent_dependency/dependency/CMakeLists.txt
Normal file
@@ -0,0 +1,15 @@
|
||||
cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
|
||||
|
||||
project(CPMTest_Dependency)
|
||||
|
||||
# ---- Dependencies ----
|
||||
|
||||
include(FetchContent)
|
||||
|
||||
FetchContent_Declare(
|
||||
Fibonacci
|
||||
GIT_REPOSITORY https://github.com/cpm-cmake/testpack-fibonacci.git
|
||||
GIT_TAG v2.0
|
||||
)
|
||||
|
||||
FetchContent_MakeAvailable(Fibonacci)
|
||||
@@ -13,7 +13,9 @@ include(@CPM_PATH@/CPM.cmake)
|
||||
CPMAddPackage(
|
||||
NAME Dependency
|
||||
SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/dependency
|
||||
OPTIONS "DEFINE_ALTERNATIVE_FUNCTION YES"
|
||||
OPTIONS
|
||||
"DEFINE_ALTERNATIVE_FUNCTION YES"
|
||||
"LIST_ARGUMENT a\\\\;b\\\\;c"
|
||||
EXCLUDE_FROM_ALL YES
|
||||
)
|
||||
|
||||
|
||||
@@ -8,6 +8,12 @@ if(NOT DEFINE_ALTERNATIVE_FUNCTION)
|
||||
message("called external method")
|
||||
endfunction()
|
||||
else()
|
||||
|
||||
# check if list was passed correctly
|
||||
if(NOT "${LIST_ARGUMENT}" STREQUAL "a;b;c")
|
||||
message(FATAL_ERROR "list argument not properly passed to dependency: '${LIST_ARGUMENT}'")
|
||||
endif()
|
||||
|
||||
function(alternative_dependency_function)
|
||||
message("called alternative external method")
|
||||
endfunction()
|
||||
|
||||
@@ -30,6 +30,12 @@ assert_equal("GITLAB_REPOSITORY;foo/bar" "${args}")
|
||||
cpm_parse_add_package_single_arg("gl:foo/Bar" args)
|
||||
assert_equal("GITLAB_REPOSITORY;foo/Bar" "${args}")
|
||||
|
||||
cpm_parse_add_package_single_arg("bb:foo/bar" args)
|
||||
assert_equal("BITBUCKET_REPOSITORY;foo/bar" "${args}")
|
||||
|
||||
cpm_parse_add_package_single_arg("bb:foo/Bar" args)
|
||||
assert_equal("BITBUCKET_REPOSITORY;foo/Bar" "${args}")
|
||||
|
||||
cpm_parse_add_package_single_arg("https://github.com/cpm-cmake/CPM.cmake.git@0.30.5" args)
|
||||
assert_equal("GIT_REPOSITORY;https://github.com/cpm-cmake/CPM.cmake.git;VERSION;0.30.5" "${args}")
|
||||
|
||||
|
||||
Reference in New Issue
Block a user