前言

使用C++作為主要開(kāi)發(fā)語(yǔ)言的程序猿們應(yīng)該會(huì)認(rèn)同搭建開(kāi)發(fā)環(huán)境是一件煩人的事情。為了編譯一個(gè)程序不僅需要下載各種依賴包，還可能面臨本地系統(tǒng)不兼容、編譯器版本不一致、包版本沖突等各種問(wèn)題。筆者在運(yùn)營(yíng)iLogtail開(kāi)源社區(qū)的過(guò)程中發(fā)現(xiàn)開(kāi)發(fā)和調(diào)試環(huán)境問(wèn)題也是成員問(wèn)的最多的問(wèn)題之一，那么有沒(méi)有一種方法可以徹底解決這一問(wèn)題呢？

有。容器技術(shù)使應(yīng)用在各種環(huán)境可以一鍵部署，一致執(zhí)行，同樣的原理也適用于開(kāi)發(fā)環(huán)境部署。利用 VSCode 的 Remote-Development 插件就可以使整個(gè)開(kāi)發(fā)環(huán)境運(yùn)行在遠(yuǎn)程容器中。使用這種方式不但可以直接使用一致的環(huán)境開(kāi)發(fā)編譯，而且還自然實(shí)現(xiàn)了多個(gè)開(kāi)發(fā)環(huán)境的隔離。下面讓就我們由淺到深搭建這樣的遠(yuǎn)端容器開(kāi)發(fā)環(huán)境。

原理簡(jiǎn)介

為什么要遠(yuǎn)程+容器？遠(yuǎn)程解決的是開(kāi)發(fā)機(jī)資源問(wèn)題和代碼安全問(wèn)題，本地電腦的CPU和內(nèi)存比較有限，為了提高編譯、測(cè)試效率一般都會(huì)準(zhǔn)備一臺(tái)專門用于開(kāi)發(fā)測(cè)試的機(jī)器，而部分公司為了防止代碼外泄，只允許內(nèi)部開(kāi)發(fā)機(jī)訪問(wèn)代碼庫(kù)。容器解決的是開(kāi)發(fā)環(huán)境一致性問(wèn)題。兩者結(jié)合起來(lái)便能構(gòu)建最理想的開(kāi)發(fā)環(huán)境。

在使用 Remote-Development 插件時(shí)，插件會(huì)ssh連接到遠(yuǎn)程開(kāi)發(fā)機(jī)，然后根據(jù)配置直接啟動(dòng)或是鑄造開(kāi)發(fā)環(huán)境鏡像后啟動(dòng)開(kāi)發(fā)環(huán)境容器。啟動(dòng)時(shí)將開(kāi)發(fā)機(jī)的Workspace目錄作為源掛載到容器中。開(kāi)發(fā)環(huán)境容器啟動(dòng)后，插件會(huì)自動(dòng)安裝VS Code Server，并安裝配置指定的VS Code插件。一旦容器內(nèi)的VS Code Server啟動(dòng)后，本地的VS Code就會(huì)直接與容器內(nèi)的VS Code Server建立通信。容器內(nèi)可以訪問(wèn)Workspace所有文件，并且修改不會(huì)因容器退出而丟失。容器開(kāi)發(fā)環(huán)境可以使用的VS Code插件，在Workspace的devcontainer.json配置中指定，下文會(huì)有詳細(xì)描述。

為了提高啟動(dòng)速度并保留容器內(nèi)插件的配置，開(kāi)發(fā)容器內(nèi)的/vscode目錄其實(shí)掛載了一個(gè)docker volume，不會(huì)自動(dòng)隨docker退出而回收，因此從第二次連接容器開(kāi)發(fā)環(huán)境開(kāi)始，無(wú)需重新安裝VS Code Server、插件等，啟動(dòng)速度大大提高。

環(huán)境準(zhǔn)備

要使VS Code可以遠(yuǎn)程連接開(kāi)發(fā)機(jī)，最好使用ssh密鑰建立本地電腦和開(kāi)發(fā)機(jī)的信任關(guān)系。要使用容器進(jìn)行開(kāi)發(fā)，開(kāi)發(fā)機(jī)上必須安裝Docker。這兩步相關(guān)教程網(wǎng)上較多，在這里就不再贅述。

需要注意的是，要使VS Code通過(guò)ssh連上開(kāi)發(fā)機(jī)并通過(guò)docker啟動(dòng)開(kāi)發(fā)環(huán)境容器，建立信任關(guān)系的賬戶必須具備docker使用權(quán)限。如果使用root賬戶，那么自然具備。如果非root則可以使用任意一種方式使賬戶獲得docker使用權(quán)限：

1. 將用戶加入docker組。參考Post-installation steps for Linux(https://docs.docker.com/engine/install/linux-postinstall)。
   sudo usermod -aG docker $USER

2. 將docker.sock權(quán)限修改為777（不太推薦，除非上述方法無(wú)法奏效）。
   sudo chmod 777 /var/run/docker.sock

下面假設(shè)開(kāi)發(fā)機(jī)使用的是Linux系統(tǒng)，并且與本地電腦已經(jīng)建立好信任關(guān)系，而且安裝并具備Docker訪問(wèn)權(quán)限。

安裝插件

在VS Code的Marketplace中搜索“Remote Development”安裝插件。

安裝完成后，會(huì)發(fā)現(xiàn)多出了3個(gè)子插件。

• Remote - Containers：連接容器開(kāi)發(fā)

• Remote - SSH：連接ssh遠(yuǎn)程開(kāi)發(fā)

• Remote - WSL：連接WSL（Windows Linux子系統(tǒng)）開(kāi)發(fā)

使用鏡像開(kāi)發(fā)

使用 Remote Development 插件最直接的方式就是利用現(xiàn)成的編譯鏡像啟動(dòng)開(kāi)發(fā)容器。這里以使用C++和Go語(yǔ)言編寫、依賴環(huán)境相對(duì)復(fù)雜的開(kāi)源項(xiàng)目iLogtail數(shù)據(jù)采集器項(xiàng)目為例，說(shuō)明如何利用 Remote Development 插件進(jìn)行遠(yuǎn)程容器開(kāi)發(fā)。

1. 創(chuàng)建Remote Development配置

在iLogtail Workspace的頂層目錄創(chuàng)建.devcontainer目錄，并在里面創(chuàng)建devcontainer.json文件。

配置文件的內(nèi)容如下：

{  "image": "sls-opensource-registry.cn-shanghai.cr.aliyuncs.com/ilogtail-community-edition/ilogtail-build-linux:latest",  "customizations": {    "vscode": {      "extensions": [        "golang.Go",        "ms-vscode.cpptools-extension-pack"      ]    }  }}

其中，image字段是Remote Development插件啟動(dòng)開(kāi)發(fā)環(huán)境的鏡像地址，customizations.vscode.extensions指定了開(kāi)發(fā)環(huán)境的插件。部分插件介紹如下，開(kāi)發(fā)者也可以按照自己的習(xí)慣進(jìn)行修改。

2. 在容器中打開(kāi)代碼庫(kù)

使用Shift + Command + P（Mac）或Ctrl + Shift + P（Win）打開(kāi)命令面板，輸入reopen，選擇Remote-Containers: Reopen in Container。

或者若出現(xiàn)如下圖提示，則可以直接點(diǎn)擊在容器中重新打開(kāi)。

首次打開(kāi)時(shí)會(huì)比較慢，因?yàn)橐螺d鏡像并安裝插件，后面再次打開(kāi)時(shí)速度會(huì)很快。按照提示進(jìn)行鏡像Build。

完成上述步驟后，我們已經(jīng)可以使用VS Code進(jìn)行代碼編輯，并在其中進(jìn)行代碼編譯。

注：如果以前拉取過(guò)編譯鏡像，可能需要觸發(fā)Remote-Containers: Rebuild Container重新構(gòu)建。

3. 在容器中進(jìn)行開(kāi)發(fā)

開(kāi)發(fā)容器啟動(dòng)后，我們已經(jīng)可以在VS Code中瀏覽Workspace代碼了。但是隨便打開(kāi)一個(gè)文件，滿眼都是錯(cuò)誤提示，代碼的跳轉(zhuǎn)功能也不能正常工作。這是因?yàn)镃++開(kāi)發(fā)環(huán)境的includePath沒(méi)有被正確配置。

打開(kāi)命令面板，輸入C++ config，選擇C/C++: Edit Configurations(UI)。

找到Include path，輸入鏡像內(nèi)依賴庫(kù)的路徑。

再回來(lái)看代碼時(shí)，錯(cuò)誤提示都消失了，并且函數(shù)定義跳轉(zhuǎn)正常。

4. 在容器中進(jìn)行編譯

打開(kāi)新Terminal（找不到的可以在命令面板中輸入Terminal，選擇新開(kāi)一個(gè)）

• 編譯iLogtail Go插件

make vendor       # 若需要更新插件依賴庫(kù)
make plugin_local # 每次更新插件代碼后從這里開(kāi)始

• 編譯iLogtail C++代碼

mkdir -p core/build # 若之前沒(méi)有建過(guò)cd core/buildcmake .. # 若增刪文件，修改CMakeLists.txt后需要重新執(zhí)行make -sj$(nproc)    # 每次更新core代碼后從這里開(kāi)始

5. 獲取編譯產(chǎn)出

由于VS Code是直接將代碼庫(kù)目錄掛載到鏡像內(nèi)的，因此主機(jī)上可以直接訪問(wèn)鏡像內(nèi)的編譯產(chǎn)出。

到這里，如果要求不高的話就可以結(jié)束了，但細(xì)心的讀者一定發(fā)現(xiàn)了一個(gè)問(wèn)題，容器內(nèi)生成的文件在主機(jī)上都是root權(quán)限，必須執(zhí)行sudo chown -R $USER .進(jìn)行修復(fù)。如果社區(qū)的成員開(kāi)發(fā)機(jī)沒(méi)有sudo權(quán)限怎么辦？作為iLogtail社區(qū)核心貢獻(xiàn)者，當(dāng)然不能把這樣的坑留給隊(duì)友了。

使用Dockerfile開(kāi)發(fā)

那有沒(méi)有辦法做到容器內(nèi)權(quán)限自動(dòng)適配主機(jī)呢？這樣的問(wèn)題當(dāng)然不會(huì)難倒VS Code了。Remote Development 插件支持使用 Dockerfile 在容器中進(jìn)行開(kāi)發(fā)，即在啟動(dòng)開(kāi)發(fā)容器前先使用docker build一個(gè)開(kāi)發(fā)鏡像，這給了修正容器內(nèi)賬戶權(quán)限的機(jī)會(huì)。

修正的原理如下：

1. 在Remote Development 插件 docker build 前將開(kāi)發(fā)機(jī)的賬戶名、賬戶ID、組名和組ID暴露給 docker。

2. docker build時(shí)利用這些賬戶信息修正容器執(zhí)行賬戶和容器內(nèi)文件權(quán)限。

接下來(lái)我們進(jìn)行實(shí)際操作。

1. 修改.devcontainer.json配置文件

在配置文件中，將image部分修改為build部分，使用Dockerfile啟動(dòng)開(kāi)發(fā)容器。同時(shí)，加入initializeCommand，在build鏡像前，將賬戶信息暴露給docker。

{  "build": {    "dockerfile": "Dockerfile",    "args": {      "USERNAME": "${localEnv:USER}"    }  },  "initializeCommand": ".devcontainer/gen_env.sh",  "customizations": {    "vscode": {      "extensions": [        "golang.Go",        "ms-vscode.cpptools-extension-pack"      ]    }  }}

2. 創(chuàng)建Dockerfile

以編譯鏡像作為基礎(chǔ)鏡像，編寫Dockerfile對(duì)鏡像內(nèi)賬戶和文件權(quán)限進(jìn)行修正。

FROM sls-opensource-registry.cn-shanghai.cr.aliyuncs.com/ilogtail-community-edition/ilogtail-build-linux:latest
ARG USERNAME=adminUSER root
# Create the userCOPY .env /tmp/.envRUN source /tmp/.env && rm /tmp/.env;     if getent passwd $USERNAME; then userdel -f $USERNAME; fi;     if [ $HOST_OS = "Linux" ]; then     if getent group $GROUPNAME; then groupdel $GROUPNAME; fi;     groupadd --gid $GROUP_GID $GROUPNAME;     fi;     useradd --uid $USER_UID --gid $GROUP_GID -m $USERNAME;     echo $USERNAME ALL=(root) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME;     chmod 0440 /etc/sudoers.d/$USERNAME;     chown -R $USERNAME:$GROUPNAME /root/go /opt/logtail $(eval echo ~$USERNAME);     chmod 755 $(eval echo ~$USERNAME);
USER $USERNAME

COPY .env /tmp/.env將主機(jī)的賬戶信息通過(guò)文件形式復(fù)制到容器中。

接下來(lái)的幾行根據(jù)這些信息在容器內(nèi)創(chuàng)建對(duì)應(yīng)的賬戶。

echo $USERNAME ALL=(root) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME;授予該用戶sudo權(quán)限。

chmod和chown的幾行對(duì)文件權(quán)限進(jìn)行修正，使新建的用戶有權(quán)限讀寫對(duì)應(yīng)目錄。其中對(duì)HOME（~$USERNAME）目錄的修正必須在這里進(jìn)行，否則會(huì)導(dǎo)致VS Code Sever沒(méi)有權(quán)限安裝，導(dǎo)致插件啟動(dòng)失敗。

3. 創(chuàng)建腳本暴露主機(jī)賬戶信息

gen_env.sh腳本內(nèi)容如下。該腳本對(duì)開(kāi)發(fā)機(jī)為Mac系統(tǒng)也做了兼容。

set -ueset -o pipefail
if uname -s | grep Linux; then  echo -e "HOST_OS=Linux
USERNAME=$USER
USER_UID=$(id -u $USER)
GROUPNAME=$(id -gn $USER)
GROUP_GID=$(id -g $USER)" > .devcontainer/.env;else  echo "HOST_OS=Darwin
USERNAME=$USER
USER_UID=$(id -u $USER)
GROUPNAME=root
GROUP_GID=0" > .devcontainer/.env;  fi

前3步完成后，Workspace中的配置目錄應(yīng)該有這樣3個(gè)文件：

4. 運(yùn)行觀察效果

使用Shift + Command + P（Mac）或Ctrl + Shift + P（Win）打開(kāi)命令面板，輸入reopen，選擇Remote-Containers: Rebuild Container。

在容器內(nèi)重新執(zhí)行id命令查看賬戶信息，可以看到與開(kāi)發(fā)機(jī)一致。

在容器內(nèi)重新執(zhí)行之前的編譯命令。然后會(huì)到開(kāi)發(fā)機(jī)上查看生成的文件權(quán)限，可以看到容器內(nèi)生成的文件，在開(kāi)發(fā)機(jī)上都已經(jīng)變成正確的權(quán)限了。

在容器內(nèi)調(diào)試

除了編譯代碼，開(kāi)發(fā)環(huán)境另一個(gè)重要功能是進(jìn)行本地調(diào)試。打開(kāi)一個(gè)iLogtail插件的單元測(cè)試文件，設(shè)置斷電然后點(diǎn)擊“debug test”。

什么？Failed to launch: could not launch process: fork/fork/exec ...: operation not permitted，出錯(cuò)了！

查閱資料，原來(lái)是docker默認(rèn)的安全策略使用Secure computing mode (seccomp)僅允許白名單系統(tǒng)調(diào)用，debug所需的系統(tǒng)調(diào)用被拒絕了。我們嘗試在配置文件中添加一行"runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ]，禁用該功能。

{  "build": {    "dockerfile": "Dockerfile",    "args": {      "USERNAME": "${localEnv:USER}"    }  },  "initializeCommand": ".devcontainer/gen_env.sh",  "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],  "customizations": {    "vscode": {      "extensions": [        "golang.Go",        "ms-vscode.cpptools-extension-pack",        "DavidAnson.vscode-markdownlint"      ]    }  }}

Rebuild Container后，再次嘗試調(diào)試功能。It works!

總結(jié)

至此，我們已經(jīng)可以happy地通過(guò)VS Code的Remote Development插件在遠(yuǎn)程容器內(nèi)開(kāi)發(fā)了。并且使用的編譯鏡像和插件配置文件都是可移植，可重復(fù)的，CI到代碼庫(kù)后可以供任何開(kāi)發(fā)者使用。文章中提到的代碼都可以到iLogtaill的GitHub倉(cāng)庫(kù)（https://github.com/alibaba/ilogtail）獲取。

Remote Development插件還有很多的功能沒(méi)有在本篇文章中使用到，感興趣的讀者可以根據(jù)文末參考資料進(jìn)一步研究探索。