{"id":5773,"date":"2020-08-05T07:00:47","date_gmt":"2020-08-05T14:00:47","guid":{"rendered":"http:\/\/writeasync.net\/?p=5773"},"modified":"2020-08-01T15:59:22","modified_gmt":"2020-08-01T22:59:22","slug":"cross-platform-without-complexity-remote-linux","status":"publish","type":"post","link":"http:\/\/writeasync.net\/?p=5773","title":{"rendered":"Cross-platform without complexity: remote Linux"},"content":{"rendered":"

Previously, we showed how to enable the Visual Studio IDE to work with an ostensibly cross-platform CMake project<\/a>. Today we will prove that the project indeed can work on a non-Windows platform — at least as much as is possible when using the Windows Subsystem for Linux<\/a> (WSL).<\/p>\n

Let’s start by observing that Visual Studio has direct support for WSL<\/a>. While I do want to use WSL for this demo, I actually don’t want VS to specifically<\/em> target WSL. Instead, let’s use the generic remote Linux<\/a> functionality instead. After appropriately configuring my WSL instance using simple password auth (for use in local scenarios only<\/strong>, of course!<\/a>), we can add a remote connection for the WSL instance (e.g. using ::1<\/code> as the IPv6 localhost name and whichever port was chosen for SSH).<\/p>\n

Now we just need to instruct VS to create CMake configurations<\/a> for Linux-Clang-Debug<\/code> and Linux-Clang-Release<\/code> (GCC is also supported, but Clang is somewhat better integrated with VS<\/a>). The CMakeSettings.json<\/code> file now looks like this:<\/p>\n

\r\n{\r\n  "configurations": [\r\n    {\r\n      "name": "x64-Debug",\r\n      "generator": "Ninja",\r\n      "configurationType": "Debug",\r\n      "inheritEnvironments": [ "msvc_x64_x64" ],\r\n      "buildRoot": "${projectDir}\\\\out\\\\build\\\\${name}",\r\n      "installRoot": "${projectDir}\\\\out\\\\install\\\\${name}",\r\n      "cmakeCommandArgs": "",\r\n      "buildCommandArgs": "",\r\n      "ctestCommandArgs": "",\r\n      "variables": []\r\n    },\r\n    {\r\n      "name": "x64-Release",\r\n      "generator": "Ninja",\r\n      "configurationType": "RelWithDebInfo",\r\n      "buildRoot": "${projectDir}\\\\out\\\\build\\\\${name}",\r\n      "installRoot": "${projectDir}\\\\out\\\\install\\\\${name}",\r\n      "cmakeCommandArgs": "",\r\n      "buildCommandArgs": "",\r\n      "ctestCommandArgs": "",\r\n      "inheritEnvironments": [ "msvc_x64_x64" ],\r\n      "variables": []\r\n    },\r\n    {\r\n      "name": "Linux-Clang-Debug",\r\n      "generator": "Ninja",\r\n      "configurationType": "Debug",\r\n      "cmakeExecutable": "\/usr\/bin\/cmake",\r\n      "remoteCopySourcesExclusionList": [ ".vs", ".git", "out" ],\r\n      "cmakeCommandArgs": "",\r\n      "buildCommandArgs": "",\r\n      "ctestCommandArgs": "",\r\n      "inheritEnvironments": [ "linux_clang_x64" ],\r\n      "remoteMachineName": "${defaultRemoteMachineName}",\r\n      "remoteCMakeListsRoot": "$HOME\/.vs\/${projectDirName}\/${workspaceHash}\/src",\r\n      "remoteBuildRoot": "$HOME\/.vs\/${projectDirName}\/${workspaceHash}\/out\/build\/${name}",\r\n      "remoteInstallRoot": "$HOME\/.vs\/${projectDirName}\/${workspaceHash}\/out\/install\/${name}",\r\n      "remoteCopySources": true,\r\n      "rsyncCommandArgs": "-t --delete --delete-excluded",\r\n      "remoteCopyBuildOutput": false,\r\n      "remoteCopySourcesMethod": "rsync",\r\n      "addressSanitizerRuntimeFlags": "detect_leaks=0",\r\n      "variables": []\r\n    },\r\n    {\r\n      "name": "Linux-Clang-Release",\r\n      "generator": "Ninja",\r\n      "configurationType": "RelWithDebInfo",\r\n      "cmakeExecutable": "\/usr\/bin\/cmake",\r\n      "remoteCopySourcesExclusionList": [ ".vs", ".git", "out" ],\r\n      "cmakeCommandArgs": "",\r\n      "buildCommandArgs": "",\r\n      "ctestCommandArgs": "",\r\n      "inheritEnvironments": [ "linux_clang_x64" ],\r\n      "remoteMachineName": "${defaultRemoteMachineName}",\r\n      "remoteCMakeListsRoot": "$HOME\/.vs\/${projectDirName}\/${workspaceHash}\/src",\r\n      "remoteBuildRoot": "$HOME\/.vs\/${projectDirName}\/${workspaceHash}\/out\/build\/${name}",\r\n      "remoteInstallRoot": "$HOME\/.vs\/${projectDirName}\/${workspaceHash}\/out\/install\/${name}",\r\n      "remoteCopySources": true,\r\n      "rsyncCommandArgs": "-t --delete --delete-excluded",\r\n      "remoteCopyBuildOutput": false,\r\n      "remoteCopySourcesMethod": "rsync",\r\n      "addressSanitizerRuntimeFlags": "detect_leaks=0",\r\n      "variables": []\r\n    }\r\n  ]\r\n}\r\n<\/pre>\n
If your WSL instance has all the right packages installed (which could include clang<\/a>, gcc<\/a>, gdb<\/a>, libgtest-dev<\/a>, make<\/a>, ninja-build<\/a>, rsync<\/a>, and zip<\/a>), the remote build target should properly produce a debug or release build with ELF binaries<\/a>.<\/p>\n
To verify this, we can login to the WSL instance and locate the temporary output path that VS used to produce the build:<\/p>\n
\r\nuser@MACHINE:~\/.vs\/CMakeSampleVS\/7f954387-c6bd-4590-b386-6f2e8cdbc5b2\/out\/build\/Linux-Clang-Debug$ .\/sample-app Linux\r\nHello, Linux!\r\nuser@MACHINE:~\/.vs\/CMakeSampleVS\/7f954387-c6bd-4590-b386-6f2e8cdbc5b2\/out\/build\/Linux-Clang-Debug$ .\/sample-test\r\nRunning main() from gtest_main.cc\r\n[==========] Running 1 test from 1 test case.\r\n[----------] Global test environment set-up.\r\n[----------] 1 test from SampleTest\r\n[ RUN      ] SampleTest.GetName\r\n[       OK ] SampleTest.GetName (0 ms)\r\n[----------] 1 test from SampleTest (1 ms total)\r\n\r\n[----------] Global test environment tear-down\r\n[==========] 1 test from 1 test case ran. (4 ms total)\r\n[  PASSED  ] 1 test.\r\n<\/pre>\n
Success!<\/p>\n
Here is the GitHub repo with the changes up to this point: CMakeSampleVS<\/a><\/p>\n
It appears that everything works on Linux. The final frontier is the command line — how can we replicate the above build and test steps from the comfort of the console? We’ll see next time.<\/p>\n","protected":false},"excerpt":{"rendered":"
Previously, we showed how to enable the Visual Studio IDE to work with an ostensibly cross-platform CMake project. Today we will prove that the project indeed can work on a non-Windows platform — at least as much as is possible… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[107,101],"tags":[],"class_list":["post-5773","post","type-post","status-publish","format-standard","hentry","category-cross-platform","category-native"],"_links":{"self":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5773","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5773"}],"version-history":[{"count":5,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5773\/revisions"}],"predecessor-version":[{"id":5780,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5773\/revisions\/5780"}],"wp:attachment":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5773"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5773"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5773"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}