(#14257) butteraugli: conan v2 support

Author: SpaceIm

recipes/butteraugli/all/CMakeLists.txt

@@ -1,31 +1,31 @@
-cmake_minimum_required(VERSION 3.4)
-project(cmake_wrapper)
+cmake_minimum_required(VERSION 3.8)
+project(butteraugli LANGUAGES CXX)
 
-include(conanbuildinfo.cmake)
-conan_basic_setup()
+option(BUTTERAUGLI_TOOL "Build comparison tool" ON)
 
-if(WIN32 AND BUILD_SHARED_LIBS)
-    set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
-endif(WIN32 AND BUILD_SHARED_LIBS)
+add_library(butteraugli_lib ${BUTTERAUGLI_SRC_DIR}/butteraugli/butteraugli.cc)
+target_include_directories(butteraugli_lib PUBLIC ${BUTTERAUGLI_SRC_DIR})
+set_target_properties(butteraugli_lib PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON)
+target_compile_features(butteraugli_lib PUBLIC cxx_std_11)
 
-set(butteraugli_DIR ${CMAKE_CURRENT_SOURCE_DIR}/source_subfolder)
-
-set(SRCS_FILES ${butteraugli_DIR}/butteraugli/butteraugli.cc)
-set(HDRS_FILES ${butteraugli_DIR}/butteraugli/butteraugli.h)
-add_library(butteraugli_lib ${SRCS_FILES} ${HDRS_FILES})
-target_include_directories(butteraugli_lib PUBLIC ${butteraugli_DIR})
-set_property(TARGET butteraugli_lib PROPERTY CXX_STANDARD 11)
-
-find_package(JPEG REQUIRED)
-find_package(PNG REQUIRED)
-
-add_library(butteraugli ${butteraugli_DIR}/butteraugli/butteraugli_main.cc)
-target_link_libraries(butteraugli butteraugli_lib ${JPEG_LIBRARIES} ${PNG_LIBRARIES})
-set_property(TARGET butteraugli PROPERTY CXX_STANDARD 11)
-
-install(TARGETS butteraugli butteraugli_lib
+install(
+    TARGETS butteraugli_lib
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )
-install(FILES ${HDRS_FILES} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/butteraugli)
+install(
+    FILES ${BUTTERAUGLI_SRC_DIR}/butteraugli/butteraugli.h
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/butteraugli
+)
+
+if(BUTTERAUGLI_TOOL)
+    find_package(JPEG REQUIRED)
+    find_package(PNG REQUIRED)
+
+    add_executable(butteraugli ${BUTTERAUGLI_SRC_DIR}/butteraugli/butteraugli_main.cc)
+    target_link_libraries(butteraugli PRIVATE butteraugli_lib JPEG::JPEG PNG::PNG)
+    target_compile_features(butteraugli PRIVATE cxx_std_11)
+
+    install(TARGETS butteraugli DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()

recipes/butteraugli/all/conandata.yml

@@ -5,4 +5,3 @@ sources:
 patches:
   "cci.20190319":
     - patch_file: "patches/0001-compilation-fixes-for-vs2015.patch"
-      base_path: "source_subfolder"

recipes/butteraugli/all/conanfile.py

@@ -1,75 +1,84 @@
+from conan import ConanFile
+from conan.tools.build import check_min_cppstd
+from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain, cmake_layout
+from conan.tools.files import apply_conandata_patches, copy, export_conandata_patches, get
 import os
-import glob
-from conans import ConanFile, CMake, tools
+
+required_conan_version = ">=1.53.0"
+
 
 class ButteraugliConan(ConanFile):
     name = "butteraugli"
     description = "A tool for measuring perceived differences between images"
     license = "Apache-2.0"
-    topics = ("conan", "image", "butteraugli", "diff")
+    topics = ("image", "diff")
     homepage = "https://github.com/google/butteraugli"
     url = "https://github.com/conan-io/conan-center-index"
+
     settings = "os", "arch", "compiler", "build_type"
-    exports_sources = ["CMakeLists.txt", "patches/**"]
-    generators = "cmake", "cmake_find_package"
     options = {
         "shared": [True, False],
         "fPIC": [True, False],
+        "tool": [True, False],
     }
     default_options = {
         "shared": False,
         "fPIC": True,
+        "tool": True,
     }
 
-    _cmake = None
-
-    @property
-    def _source_subfolder(self):
-        return "source_subfolder"
-
-    @property
-    def _build_subfolder(self):
-        return "build_subfolder"
+    def export_sources(self):
+        copy(self, "CMakeLists.txt", src=self.recipe_folder, dst=self.export_sources_folder)
+        export_conandata_patches(self)
 
     def config_options(self):
         if self.settings.os == "Windows":
             del self.options.fPIC
 
     def configure(self):
         if self.options.shared:
-            del self.options.fPIC
+            self.options.rm_safe("fPIC")
+
+    def layout(self):
+        cmake_layout(self, src_folder="src")
 
     def requirements(self):
-        self.requires("libpng/1.6.37")
-        self.requires("libjpeg/9d")
+        if self.options.tool:
+            self.requires("libpng/1.6.38")
+            self.requires("libjpeg/9e")
 
-    def source(self):
-        tools.get(**self.conan_data["sources"][self.version])
-        extracted_dir = glob.glob('butteraugli-*/')[0]
-        os.rename(extracted_dir, self._source_subfolder)
+    def validate(self):
+        if self.info.settings.compiler.get_safe("cppstd"):
+            check_min_cppstd(self, 11)
 
-    def _patch_sources(self):
-        for patch in self.conan_data.get("patches", {}).get(self.version, []):
-            tools.patch(**patch)
+    def source(self):
+        get(self, **self.conan_data["sources"][self.version],
+            destination=self.source_folder, strip_root=True)
 
-    def _configure_cmake(self):
-        if self._cmake:
-            return self._cmake
-        self._cmake = CMake(self)
-        self._cmake.configure(build_folder=self._build_subfolder)
-        return self._cmake
+    def generate(self):
+        tc = CMakeToolchain(self)
+        tc.variables["BUTTERAUGLI_SRC_DIR"] = self.source_folder.replace("\\", "/")
+        tc.variables["BUTTERAUGLI_TOOL"] = self.options.tool
+        tc.generate()
+        deps = CMakeDeps(self)
+        deps.generate()
 
     def build(self):
-        self._patch_sources()
-        cmake = self._configure_cmake()
+        apply_conandata_patches(self)
+        cmake = CMake(self)
+        cmake.configure(build_script_folder=os.path.join(self.source_folder, os.pardir))
         cmake.build()
 
     def package(self):
-        self.copy("LICENSE", dst="licenses", src=self._source_subfolder)
-        cmake = self._configure_cmake()
+        copy(self, "LICENSE", src=self.source_folder, dst=os.path.join(self.package_folder, "licenses"))
+        cmake = CMake(self)
         cmake.install()
 
     def package_info(self):
-        self.cpp_info.libs = tools.collect_libs(self)
-        if self.settings.os == "Linux":
+        self.cpp_info.libs = ["butteraugli_lib"]
+        if self.settings.os in ["Linux", "FreeBSD"]:
             self.cpp_info.system_libs = ["m"]
+
+        if self.options.tool:
+            # TODO: to remove in conan v2
+            self.env_info.PATH.append(os.path.join(self.package_folder, "bin"))

recipes/butteraugli/all/test_package/CMakeLists.txt

@@ -1,9 +1,8 @@
-cmake_minimum_required(VERSION 3.1)
-project(test_package)
+cmake_minimum_required(VERSION 3.8)
+project(test_package LANGUAGES CXX)
 
-include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
-conan_basic_setup()
+find_package(butteraugli REQUIRED CONFIG)
 
 add_executable(${PROJECT_NAME} test_package.cpp)
-target_link_libraries(${PROJECT_NAME} ${CONAN_LIBS})
-set_property(TARGET ${PROJECT_NAME} PROPERTY CXX_STANDARD 11)
+target_link_libraries(${PROJECT_NAME} PRIVATE butteraugli::butteraugli)
+target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_11)

recipes/butteraugli/all/test_package/conanfile.py

@@ -1,17 +1,26 @@
+from conan import ConanFile
+from conan.tools.build import can_run
+from conan.tools.cmake import CMake, cmake_layout
 import os
 
-from conans import ConanFile, CMake, tools
 
 class TestPackageConan(ConanFile):
-    settings = "os", "compiler", "build_type", "arch"
-    generators = "cmake"
+    settings = "os", "arch", "compiler", "build_type"
+    generators = "CMakeToolchain", "CMakeDeps", "VirtualRunEnv"
+    test_type = "explicit"
+
+    def layout(self):
+        cmake_layout(self)
+
+    def requirements(self):
+        self.requires(self.tested_reference_str)
 
     def build(self):
         cmake = CMake(self)
         cmake.configure()
         cmake.build()
 
     def test(self):
-        if not tools.cross_building(self.settings):
-            bin_path = os.path.join("bin", "test_package")
-            self.run(bin_path, run_environment=True)
+        if can_run(self):
+            bin_path = os.path.join(self.cpp.build.bindirs[0], "test_package")
+            self.run(bin_path, env="conanrun")

recipes/butteraugli/all/test_v1_package/CMakeLists.txt

@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.1)
+project(test_package)
+
+include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
+conan_basic_setup(TARGETS)
+
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/../test_package
+                 ${CMAKE_CURRENT_BINARY_DIR}/test_package)

recipes/butteraugli/all/test_v1_package/conanfile.py

@@ -0,0 +1,17 @@
+from conans import ConanFile, CMake, tools
+import os
+
+
+class TestPackageConan(ConanFile):
+    settings = "os", "arch", "compiler", "build_type"
+    generators = "cmake", "cmake_find_package_multi"
+
+    def build(self):
+        cmake = CMake(self)
+        cmake.configure()
+        cmake.build()
+
+    def test(self):
+        if not tools.cross_building(self):
+            bin_path = os.path.join("bin", "test_package")
+            self.run(bin_path, run_environment=True)