def replace_paths_test(self):
folder = temp_folder()
path = os.path.join(folder, "file")
replace_with = "MYPATH"
expected = 'Some other contentsMYPATH"finally all text'
out = TestBufferConanOutput()
save(path, 'Some other contentsc:\\Path\\TO\\file.txt"finally all text')
ret = tools.replace_path_in_file(path, "C:/Path/to/file.txt", replace_with,
windows_paths=True, output=out)
self.assertEqual(load(path), expected)
self.assertTrue(ret)
save(path, 'Some other contentsC:/Path\\TO\\file.txt"finally all text')
ret = tools.replace_path_in_file(path, "C:/PATH/to/FILE.txt", replace_with,
windows_paths=True, output=out)
self.assertEqual(load(path), expected)
self.assertTrue(ret)
save(path, 'Some other contentsD:/Path\\TO\\file.txt"finally all text')
ret = tools.replace_path_in_file(path, "C:/PATH/to/FILE.txt", replace_with, strict=False,
windows_paths=True, output=out)
self.assertEqual(load(path), 'Some other contentsD:/Path\\TO\\file.txt"finally all text')
self.assertFalse(ret)
# Multiple matches
s = 'Some other contentsD:/Path\\TO\\file.txt"finally all textd:\\PATH\\to\\file.TXTMoretext'
save(path, s)
ret = tools.replace_path_in_file(path, "D:/PATH/to/FILE.txt", replace_with, strict=False,
windows_paths=True, output=out)
self.assertEqual(load(path), 'Some other contentsMYPATH"finally all textMYPATHMoretext')
self.assertTrue(ret)
# Automatic windows_paths
save(path, s)
ret = tools.replace_path_in_file(path, "D:/PATH/to/FILE.txt", replace_with, strict=False,
output=out)
if platform.system() == "Windows":
self.assertEqual(load(path), 'Some other contentsMYPATH"finally all textMYPATHMoretext')
self.assertTrue(ret)
else:
self.assertFalse(ret)
def patch_config_paths(self):
"""
changes references to the absolute path of the installed package and its dependencies in
exported cmake config files to the appropriate conan variable. This makes
most (sensible) cmake config files portable.
For example, if a package foo installs a file called "fooConfig.cmake" to
be used by cmake's find_package method, normally this file will contain
absolute paths to the installed package folder, for example it will contain
a line such as:
SET(Foo_INSTALL_DIR /home/developer/.conan/data/Foo/1.0.0/...)
This will cause cmake find_package() method to fail when someone else
installs the package via conan.
This function will replace such mentions to
SET(Foo_INSTALL_DIR ${CONAN_FOO_ROOT})
which is a variable that is set by conanbuildinfo.cmake, so that find_package()
now correctly works on this conan package.
For dependent packages, if a package foo installs a file called "fooConfig.cmake" to
be used by cmake's find_package method and if it depends to a package bar,
normally this file will contain absolute paths to the bar package folder,
for example it will contain a line such as:
SET_TARGET_PROPERTIES(foo PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES
"/home/developer/.conan/data/Bar/1.0.0/user/channel/id/include")
This function will replace such mentions to
SET_TARGET_PROPERTIES(foo PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES
"${CONAN_BAR_ROOT}/include")
If the install() method of the CMake object in the conan file is used, this
function should be called _after_ that invocation. For example:
def build(self):
cmake = CMake(self)
cmake.configure()
cmake.build()
cmake.install()
cmake.patch_config_paths()
"""
if not self._conanfile.should_install:
return
if not self._conanfile.name:
raise ConanException(
"cmake.patch_config_paths() can't work without package name. "
"Define name in your recipe")
pf = self.definitions.get(cmake_install_prefix_var_name)
replstr = "${CONAN_%s_ROOT}" % self._conanfile.name.upper()
allwalk = chain(walk(self._conanfile.build_folder),
walk(self._conanfile.package_folder))
# We don't want warnings printed because there is no replacement of the abs path.
# there could be MANY cmake files in the package and the normal thing is to not find
# the abs paths
_null_out = ConanOutput(StringIO())
for root, _, files in allwalk:
for f in files:
if f.endswith(".cmake") and not f.startswith("conan"):
path = os.path.join(root, f)
tools.replace_path_in_file(path,
pf,
replstr,
strict=False,
output=_null_out)
# patch paths of dependent packages that are found in any cmake files of the
# current package
for dep in self._conanfile.deps_cpp_info.deps:
from_str = self._conanfile.deps_cpp_info[dep].rootpath
dep_str = "${CONAN_%s_ROOT}" % dep.upper()
ret = tools.replace_path_in_file(path,
from_str,
dep_str,
strict=False,
output=_null_out)
if ret:
self._conanfile.output.info(
"Patched paths for %s: %s to %s" %
(dep, from_str, dep_str))
