C++の開発環境をDockerで構築してVSCodeでリモート開発

ことの発端

VSCode でC++の開発環境構築（Windows / MacOS） の記事を書いていて「何故にdocker使わない？」ということに気付き、やってみたら、更に簡単だったのでメモ。

Docker 未経験の方でも、Dockerさえインストールできれば¹、この手順で進めれば大丈夫です。
これをキッカケに Docker って何者なのかを調べてみると良いかと思います。

手順

1. DockerFile を作成

ここで開発用のフォルダを作成し、まずは Dockerileを作成します。

Dockerfile

FROM ubuntu:18.04
RUN apt-get update && apt-get install -y build-essential gdb cmake

今回は docker-compose は使用しません。²

2. VSCodeからコンテナ内へリモート接続する

1. 拡張機能 Remote - Containers : ms-vscode-remote.remote-containers をインストールします。

2. インストールすると、左下の緑色のボタンが表示されるので、クリックします。
   

3. コマンドパレットが表示されるので今回はRemote-Containers: Open Folder in Containers...を選びます。
   

4. フォルダ選択画面が表示されるので、Dockerファイルが存在するフォルダを選択します。

5. コマンドパレットが表示されるのでFrom 'Dockerfile'を選択します。
   

この手順で、コンテナビルド→設定→起動→ログインが行われます。

3. 開発用の拡張機能をインストール

1. 拡張機能 C/C++ : ms-vscode.cpptools をインストールします。

2. 拡張機能CMake Tools : ms-vscode.cmake-tools をインストールします。

VSCodeはリモート環境毎に拡張機能をインストールするという素晴らしい仕様なので、既にローカルで拡張機能をインストールしていても、再度インストールがされているか確認をしてください。

4. 開発開始

1. [F1] でコマンドパレットを表示しして、Cmake: Configure を選択します。
   

2. Kit の選択が要求されるので GCC 7.5.0 を選択します。
   

3. 右下に CMakeLists.txt を作るか聞いてくるのでCreateを押下します。
   

4. プロジェクト名を入力してと言われるので、適切な名前を入力します。
   

5. 実行ファイル（Executable）からライブラリファイル（Library）かと聞かれるので、Executable を選択します。
   

この手順で、CMakeLists.txtとmain.cpp が生成されます。

5. ビルドとデバッグ実行

1. [F7] でビルドが行われます。
2. [CTRL] + [F5] でデバッグ実行が開始されます。

ブレイクポイントやら、スタックトレース、変数のウォッチなどは、一般的な開発環境と同じなので、ここでは割愛します。

その他

• VSCode を閉じれば、コンテナは自動的に停止します。
• 次回からは VSCode を起動して Recent からフォルダを選択すれば、自動的にコンテナを起動してくれます。
• VSCodeでgitの操作を行いたいなら、Dockerfileにgitを追加しましょう。
• gitを使う場合 .gitignore に build と .devcontainer を追加しましょう。
• Remote-Container使えば、C++以外でもDockerを使って開発環境構築するのは良いかも。

1. VT-xを使っているミドルウエア（VMWareやVirtualBoxなど）をインストールしている場合はホスト環境にDockerを入れると、ネットワークドライバがコンフリクトしてアンインストールに苦労するかもなので、注意してください。 ↩

2. docker-compose.ymlを書いても良いのですが、MS謹製の Remote-Containers がvolumeのbindとか面倒見てくれるので今回はこの子に甘えます。外部からのネットワークかインバウンドを想定したプログラムならdocker-compose.ymlを記述する必要がありますが、ここでは割愛します。VSCodeのターミナルで起動したプロセスがTCPをリスニングした場合、自動的にポートフォワードしてくれるので特に設定不要です。 ↩