ericLemanissier/conan-center-index
1
0
Fork 1
mirror of https://github.com/conan-io/conan-center-index.git synced 2025-08-13 10:04:43 +00:00
Code Issues 6 Packages Projects Releases Wiki Activity

(#17705) docs: remove mention of the migration test_v1_package

Browse Source 
* Delete docs/package_templates/autotools_package/all/test_v1_package directory

* Delete docs/package_templates/cmake_package/all/test_v1_package directory

* Delete docs/package_templates/header_only/all/test_v1_package directory

* Delete docs/package_templates/meson_package/all/test_v1_package directory

* Delete docs/package_templates/msbuild_package/all/test_v1_package directory

* Delete docs/package_templates/prebuilt_tool_package/all/test_v1_package directory

* Update test_packages.md

* Update error_knowledge_base.md
This commit is contained in:
Chris Mc
2023-05-25 12:21:44 -07:00
committed by GitHub
parent 1868fc6e23
commit dfda985713
12 changed files with 9 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/adding_packages/test_packages.md
View File

@@ -8,19 +8,19 @@ themselves. It's possible to have ConanCenter run `conan test` on more then one
<!-- toc -->
## Contents
* [Files and Structure](#files-and-structure)
* [CMake targets](#cmake-targets)
* [Testing more generators with `test_<something>`](#testing-more-generators-with-test_something)
* [Testing CMake variables from FindModules](#testing-cmake-variables-from-findmodules)
* [How it works](#how-it-works)
* [Minimalist Source Code](#minimalist-source-code)<!-- endToc -->
* [Files and Structure](#files-and-structure)
* [CMake targets](#cmake-targets)
* [Testing more generators with `test_<something>`](#testing-more-generators-with-test_something)
* [Testing CMake variables from FindModules](#testing-cmake-variables-from-findmodules)
* [How it works](#how-it-works)
* [Minimalist Source Code](#minimalist-source-code)<!-- endToc -->
### Files and Structure
See the [recipe files and structures](README.md#recipe-files-structure) for a visual.
All ConanCenterIndex recipe should have a two [test_folders](https://docs.conan.io/1/reference/commands/creator/create.html?highlight=test_folder)
One for the current CMake generator in `test_package/` and on for the deprecated generators in `test_v1_package/`.
One for the current CMake generator in `test_package/`.
Please refer to the [Package Templates](../package_templates/) for the current practices about which files and what their content should be.
@@ -39,11 +39,7 @@ target_link_libraries(test_ranges PRIVATE fmt::fmt)
Refer to the [package template](https://github.com/conan-io/conan-center-index/blob/master/docs/package_templates/cmake_package/all/test_package/CMakeLists.txt) for more examples.
> **Notes** It's still important to test targets provided by `cmake_find_package[_multi]` generators.
> It should help in the migration (and compatibility) with Conan v2. See [v1 test package template](https://github.com/conan-io/conan-center-index/blob/master/docs/package_templates/cmake_package/all/test_v1_package/CMakeLists.txt) for details.
> You can see read [this conversation](https://github.com/conan-io/conan-center-index/issues/12888#issuecomment-1290817799) for more context.
In ConanCenter we try to accurately represent the names of the targets and the information provided by CMake's modules and config files that some libraries
In ConanCenterIndex, we try to accurately represent the names of the targets and the information provided by CMake's modules and config files that some libraries
provide. If CMake or the library itself don't enforce any target name, the default ones provided by Conan should be recommended. The minimal project
in the `test_package` folder should serve as an example of the best way to consume the package, and targets are preferred over raw variables.
@@ -60,7 +56,7 @@ of them together in the testing logs.
Sometimes it is useful to test the package using different build systems (CMake, Autotools,...). Instead of adding complex logic to one
`test_package/conanfile.py` file, it is better to add another `test_<something>/conanfile.py` file with a minimal example for that build system. That
way the examples will be short and easy to understand and maintain. In some other situations it could be useful to test different Conan generators
(`cmake_find_package`, `CMakeDeps`,...) using different folders and `conanfile.py` files.
(e.g. `CMakeDeps`) using different folders and `conanfile.py` files.
When using more than one `test_<something>` folder, create a different project for each of them to keep the content of the `conanfile.py` and the
project files as simple as possible, without the need of extra logic to handle different scenarios.