Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new test for cmake_layout #17331

Open
wants to merge 3 commits into
base: develop2
Choose a base branch
from
Open

new test for cmake_layout #17331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd25040
new test for cmake_layout
memsharded Nov 18, 2024
5be2acf
Merge branch 'develop2' into test/cmake_layout_build_folders
memsharded Nov 29, 2024
6e806a6
new
memsharded Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions test/functional/toolchains/cmake/test_presets_inherit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,73 @@ def test_cmake_presets_with_user_presets_file():
c.run_command("build\\Release\\foo")

assert "Hello World Release!" in c.out


@pytest.mark.tool("cmake", "3.23")
def test_inherit_custom_folders():
# https://github.com/conan-io/conan/issues/17324
conanfile = textwrap.dedent("""\
from conan import ConanFile
from conan.tools.cmake import CMakeToolchain, CMakeDeps, cmake_layout
from conan.tools.files import load, save
import os

class CompressorRecipe(ConanFile):
# Binary configuration
settings = "os", "compiler", "build_type", "arch"

def layout(self):
self.folders.build_folder_vars = ["settings.compiler"]
cmake_layout(self)

def generate(self):
deps = CMakeDeps(self)
deps.generate()
tc = CMakeToolchain(self)
tc.user_presets_path = "ConanCMakePresets.json"
tc.generate()
""")
presets = textwrap.dedent("""\
{
"version": 4,
"include": ["ConanCMakePresets.json"],
"configurePresets": [
{
"name": "gcc",
"generator": "Ninja Multi-Config",
"inherits": ["conan-gcc"],
"binaryDir": "${sourceDir}/build"
}
],
"buildPresets": [
{
"name": "gcc-release",
"configuration": "Release",
"configurePreset": "gcc",
"inherits": ["conan-gcc-release"]
},
{
"name": "gcc-debug",
"configuration": "Debug",
"configurePreset": "gcc",
"inherits": ["conan-gcc-debug"]
}
]
}
""")
c = TestClient()
c.save({"conanfile.py": conanfile,
"CMakeLists.txt": "", # Irrelevant, only needed for Conan to generate the presets
"CMakePresets.json": presets})
conf = '-s compiler=gcc -s compiler.version=11 -s compiler.libcxx=libstdc++ ' \
'-c tools.cmake.cmaketoolchain:generator="Ninja Multi-Config"'
c.run(f"install . --build=missing -s build_type=Release {conf}")
print(c.out)
print(c.load("build/gcc/generators/CMakePresets.json"))
c.run(f"install . --build=missing -s build_type=Debug {conf}")
print(c.out)
print(c.load("build/gcc/generators/CMakePresets.json"))
c.run_command("cmake --list-presets")
print(c.out)
assert "gcc" in c.out
assert "conan-gcc" in c.out
100 changes: 58 additions & 42 deletions test/integration/toolchains/cmake/test_cmaketoolchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1287,6 +1287,29 @@ def layout(self):
assert "conan-windows-pkg-0.1-debug" in presets


def test_recipe_build_folders_vars_empty():
client = TestClient()
conanfile = textwrap.dedent("""
from conan import ConanFile
from conan.tools.cmake import cmake_layout

class Conan(ConanFile):
name = "pkg"
version = "0.1"
settings = "os", "arch", "compiler", "build_type"
generators = "CMakeToolchain"

def layout(self):
self.folders.build_folder_vars = ["settings.compiler", "settings.build_type"]
cmake_layout(self)
""")
client.save({"conanfile.py": conanfile})
client.run("install . -s os=Windows -s compiler=gcc -s compiler.version=10 "
"-s compiler.libcxx=libstdc++11 -s arch=armv8 -s build_type=Debug")
presets = client.load("build/gcc-debug/generators/CMakePresets.json")
assert "conan-gcc-debug" in presets


def test_build_folder_vars_constants_user():
c = TestClient()
conanfile = textwrap.dedent("""
Expand Down Expand Up @@ -1621,66 +1644,59 @@ def test_toolchain_extra_variables():
tools.cmake.cmaketoolchain:extra_variables={'CMAKE_GENERATOR_INSTANCE': '${GENERATOR_INSTANCE}/buildTools/', 'FOO': '42' }
""")

client = TestClient()
client.save({"conanfile.txt": "[generators]\nCMakeToolchain",
"windows": windows_profile})
c = TestClient()
c.save({"conanfile.txt": "[generators]\nCMakeToolchain",
"windows": windows_profile})

# Test passing extra_variables from pro ile
client.run("install . --profile:host=windows")
toolchain = client.load("conan_toolchain.cmake")
c.run("install . --profile:host=windows")
toolchain = c.load("conan_toolchain.cmake")
assert 'set(CMAKE_GENERATOR_INSTANCE "${GENERATOR_INSTANCE}/buildTools/")' in toolchain
assert 'set(FOO "42")' in toolchain

# Test input from command line passing dict between doble quotes
client.run(textwrap.dedent(r"""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'CMAKE_GENERATOR_INSTANCE': '${GENERATOR_INSTANCE}/buildTools/', 'FOO': 42.2, 'DICT': {'value': 1}, 'CACHE_VAR': {'value': 'hello world', 'cache': True, 'type': 'BOOL', 'docstring': 'test variable'}}"
""")
)

toolchain = client.load("conan_toolchain.cmake")
v = "{'CMAKE_GENERATOR_INSTANCE': '${GENERATOR_INSTANCE}/buildTools/', 'FOO': 42.2, " \
"'DICT': {'value': 1}, 'CACHE_VAR': {'value': 'hello world', 'cache': True, " \
"'type': 'BOOL', 'docstring': 'test variable'}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"')
toolchain = c.load("conan_toolchain.cmake")
assert 'set(CMAKE_GENERATOR_INSTANCE "${GENERATOR_INSTANCE}/buildTools/")' in toolchain
assert 'set(FOO 42.2)' in toolchain
assert 'set(DICT 1)' in toolchain
assert 'set(CACHE_VAR "hello world" CACHE BOOL "test variable")' in toolchain


client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'myVar': {'value': 'hello world', 'cache': 'true'}}"
""") , assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" "cache" must be a boolean' in client.out
v = "{'myVar': {'value': 'hello world', 'cache': 'true'}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"', assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" "cache" must be a boolean' in c.out

# Test invalid force
client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'myVar': {'value': 'hello world', 'force': True}}"
""") , assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" "force" is only allowed for cache variables' in client.out
v = "{'myVar': {'value': 'hello world', 'force': True}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"', assert_error=True)
assert 'extra_variables "myVar" "force" is only allowed for cache variables' in c.out

client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'myVar': {'value': 'hello world', 'cache': True, 'force': 'true'}}"
""") , assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" "force" must be a boolean' in client.out
v = "{'myVar': {'value': 'hello world', 'cache': True, 'force': 'true'}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"', assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" "force" must be a boolean' in c.out

# Test invalid cache variable
client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'myVar': {'value': 'hello world', 'cache': True}}"
""") , assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" needs "type" defined for cache variable' in client.out

client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'myVar': {'value': 'hello world', 'cache': True, 'type': 'INVALID_TYPE'}}"
""") , assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" invalid type "INVALID_TYPE" for cache variable. Possible types: BOOL, FILEPATH, PATH, STRING, INTERNAL' in client.out

client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'CACHE_VAR_DEFAULT_DOC': {'value': 'hello world', 'cache': True, 'type': 'PATH'}}"
"""))
toolchain = client.load("conan_toolchain.cmake")
v = "{'myVar': {'value': 'hello world', 'cache': True}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"', assert_error=True)
assert 'extra_variables "myVar" needs "type" defined for cache variable' in c.out

v = "{'myVar': {'value': 'hello world', 'cache': True, 'type': 'INVALID_TYPE'}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"', assert_error=True)
assert 'tools.cmake.cmaketoolchain:extra_variables "myVar" invalid type "INVALID_TYPE" for ' \
'cache variable. Possible types: BOOL, FILEPATH, PATH, STRING, INTERNAL' in c.out

v = "{'CACHE_VAR_DEFAULT_DOC': {'value': 'hello world', 'cache': True, 'type': 'PATH'}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"')
toolchain = c.load("conan_toolchain.cmake")
assert 'set(CACHE_VAR_DEFAULT_DOC "hello world" CACHE PATH "CACHE_VAR_DEFAULT_DOC")' in toolchain

client.run(textwrap.dedent("""
install . -c tools.cmake.cmaketoolchain:extra_variables="{'myVar': {'value': 'hello world', 'cache': True, 'type': 'PATH', 'docstring': 'My cache variable', 'force': True}}"
"""))
toolchain = client.load("conan_toolchain.cmake")
v = "{'myVar': {'value': 'hello world', 'cache': True, 'type': 'PATH', " \
"'docstring': 'My cache variable', 'force': True}}"
c.run(f'install . -c tools.cmake.cmaketoolchain:extra_variables="{v}"')
toolchain = c.load("conan_toolchain.cmake")
assert 'set(myVar "hello world" CACHE PATH "My cache variable" FORCE)' in toolchain


Expand Down