Add cmake module for building dependencies at configuration time (#1144)

cmake/AwsPrebuildDependency.cmake

@@ -0,0 +1,73 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0.
+
+# Build given dependency project during CMake configuration step and install it into CMAKE_BINARY_DIR.
+# Arguments:
+#  DEPENDENCY_NAME Project name that should be built and installed.
+#  SOURCE_DIR Path to the project.
+#  CMAKE_ARGUMENTS Additional arguments that will be passed to cmake command.
+#
+# Set ${DEPENDENCY_NAME}_PREBUILT variable on success.
+function(prebuild_dependency)
+    set(oneValueArgs DEPENDENCY_NAME SOURCE_DIR)
+    set(multiValueArgs CMAKE_ARGUMENTS)
+    cmake_parse_arguments(AWS_PREBUILD "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if(NOT AWS_PREBUILD_DEPENDENCY_NAME)
+        message(FATAL_ERROR "Missing DEPENDENCY_NAME argument in prebuild_dependency function")
+    endif()
+
+    if(NOT AWS_PREBUILD_SOURCE_DIR)
+        message(FATAL_ERROR "Missing SOURCE_DIR argument in prebuild_dependency function")
+    endif()
+
+    set(depBinaryDir ${CMAKE_BINARY_DIR}/deps/${AWS_PREBUILD_DEPENDENCY_NAME})
+    set(depInstallDir ${depBinaryDir}/install)
+    file(MAKE_DIRECTORY ${depBinaryDir})
+
+    # For execute_process to accept a dynamically constructed command, it should be passed in a list format.
+    set(cmakeCommand "COMMAND" "${CMAKE_COMMAND}")
+    list(APPEND cmakeCommand -S ${AWS_PREBUILD_SOURCE_DIR})
+    list(APPEND cmakeCommand -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE})
+    list(APPEND cmakeCommand -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
+    list(APPEND cmakeCommand -DCMAKE_INSTALL_PREFIX=${depInstallDir})
+    list(APPEND cmakeCommand -DCMAKE_INSTALL_RPATH=${CMAKE_INSTALL_RPATH})
+    list(APPEND cmakeCommand -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS})
+
+    # Append provided arguments to CMake command.
+    if(AWS_PREBUILD_CMAKE_ARGUMENTS)
+        list(APPEND cmakeCommand ${AWS_PREBUILD_CMAKE_ARGUMENTS})
+    endif()
+
+    list(APPEND cmakeCommand WORKING_DIRECTORY ${depBinaryDir})
+    list(APPEND cmakeCommand RESULT_VARIABLE result)
+
+    # Configure dependency project.
+    execute_process(${cmakeCommand})
+    if (NOT ${result} EQUAL 0)
+        message(FATAL_ERROR "Configuration failed for dependency project ${AWS_PREBUILD_DEPENDENCY_NAME}")
+    endif()
+
+    # Build and install dependency project into depInstallDir directory.
+    execute_process(
+        COMMAND ${CMAKE_COMMAND} --build . --target install
+        WORKING_DIRECTORY ${depBinaryDir}
+        RESULT_VARIABLE result
+    )
+    if (NOT ${result} EQUAL 0)
+        message(FATAL_ERROR "Build failed for dependency project ${AWS_PREBUILD_DEPENDENCY_NAME}")
+    endif()
+
+    # Make the installation visible for others.
+    list(INSERT CMAKE_PREFIX_PATH 0 ${depInstallDir}/)
+    set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} PARENT_SCOPE)
+
+    set(${AWS_PREBUILD_DEPENDENCY_NAME}_PREBUILT TRUE CACHE INTERNAL "Indicate that dependency is built and can be used")
+
+    # Generates installation rules for the dependency project.
+    # On installing targets, CMake will just copy this prebuilt version to a designated installation directory.
+    install(
+        DIRECTORY ${depInstallDir}/
+        DESTINATION ${CMAKE_INSTALL_PREFIX}
+    )
+endfunction()