如何配置CMake同步源码至远程主机并解决构建报错问题

问题 #

刚接触CMake，想让代码库同时在本地Windows机器和远程Linux服务器运行，现在遇到了“先有鸡还是先有蛋”的问题：想通过CMake把源码部署到远程机器，但CMake脚本在复制文件前就因找不到远程机器上的文件报错。

本地Windows开发一切正常，源码存于本地文件系统，项目根目录的简化CMakeLists.txt可正常工作：

cmake_minimum_required(VERSION 3.10)
project(MySampleApp VERSION 1.0)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

add_executable(MySampleApp main.cpp program_options.h program_options.cpp )

切换CMake目标到远程Linux服务器时，出现错误：cannot find source file: main.cpp
明白这是因为文件还没传输，但不知道该怎么先完成传输。

以下是Linux构建的设置，原本预期remoteCopySources能确保本地与远程同步：

"name": "Linux-GCC-Debug",
"generator": "Ninja",
"configurationType": "Debug",
"cmakeExecutable": "cmake",
"remoteCopySourcesExclusionList": [ ".vs", ".git", "out" ],
"cmakeCommandArgs": "",
"buildCommandArgs": "",
"ctestCommandArgs": "",
"inheritEnvironments": [ "linux_x64" ],
"remoteMachineName": "${defaultRemoteMachineName}",
"remoteCMakeListsRoot": "/path/to/server/${projectDirName}/${workspaceHash}/src",
"remoteBuildRoot": "/path/to/server/${projectDirName}/${workspaceHash}/out/build/${name}",
"remoteInstallRoot": "/path/to/server/${projectDirName}/${workspaceHash}/out/install/${name}",
"remoteCopySources": true,
"rsyncCommandArgs": "-t --delete",
"remoteCopyBuildOutput": false,
"remoteCopySourcesMethod": "rsync",
"variables": []           

想问：如何正确定义文件路径以指向脚本完成同步后文件的部署位置？有没有更优的方法确保跨系统源码同步？

解决方案 #

1. 确认路径逻辑的正确性 #

CMake远程构建时，是在远程机器上执行配置流程，你当前CMakeLists.txt里用的相对源文件路径（如main.cpp）本身没问题，问题核心是源码同步时机滞后于CMake配置。

2. 强制提前触发源码同步 #

VS的远程CMake配置偶尔会出现同步顺序异常，你可以手动干预：

• 打开VS的「CMake」菜单，选择「Remote Copy Sources」先手动完成一次同步，再重新触发远程CMake配置。
• 检查远程机器上的remoteCMakeListsRoot路径是否存在，若路径不存在，rsync可能无法完成同步，需确保该路径可被VS远程用户创建或已存在。

3. 优化rsync同步参数 #

当前rsyncCommandArgs仅包含-t --delete，建议补充递归同步和日志输出参数，确保同步完整性并方便排查：

-rtv --delete

其中-r保证子目录文件被同步，-v输出同步日志，可用来确认文件是否真的传到了远程的remoteCMakeListsRoot目录。

4. 更可控的跨系统同步方案 #

方案一：用Git前置同步

不依赖VS自动同步，先将本地代码推送到Git仓库，远程机器拉取最新代码后，让CMake直接指向远程机器上的Git仓库目录。这种方式更稳定，也便于代码版本管理。

方案二：用CMake ExternalProject模块嵌入同步步骤

如果必须在CMake流程内完成同步，可使用ExternalProject_Add强制在配置阶段前完成源码同步，示例代码：

include(ExternalProject)
ExternalProject_Add(
    SyncSources
    PREFIX ${CMAKE_BINARY_DIR}/sync
    DOWNLOAD_COMMAND rsync -rtv --delete /path/to/local/source/ user@remote:/path/to/remote/source/
    CONFIGURE_COMMAND ""
    BUILD_COMMAND ""
    INSTALL_COMMAND ""
)

# 让主可执行目标依赖同步步骤
add_executable(MySampleApp main.cpp program_options.h program_options.cpp )
add_dependencies(MySampleApp SyncSources)

注意：需提前配置远程机器的SSH免密登录，避免同步时因输入密码中断流程。

5. 检查远程配置细节 #

• 确认remoteMachineName对应的远程机器已配置SSH免密登录，VS可无密码连接。
• 检查远程机器上remoteCMakeListsRoot目录的权限，确保VS使用的远程用户有读写权限。

内容的提问来源于stack exchange，提问作者Josh Jones