remote-debugging | Casual Developers Note

Docker上でPython FlaskのRESTアプリケーションを構築し、Visual Studio Codeからリモートデバッグする方法

Docker上にアプリケーションを構築するのが一般的になってきた昨今、Dockerコンテナへのリモートデバッグはバグ解析には必須です。今回は、Visual Studio CodeでPythonのFlaskで作成したRES APIアプリケーションをリモートデバッグする方法を紹介します。

はじめに

FlaskはPythonでサーバーサイドアプリケーションを作る人気のフレームワークです。Visual Studio CodeはもとはJavaScript向けのエディタでしたが、今ではPythonの開発環境としても人気のエディタです。

リモートデバッグとは、リモート(ローカル以外)で稼働しているアプリケーションに対して、ローカルから接続して、デバッグすることです。Docker上にあるアプリケーションをデバッグするには、リモートデバッグで行う必要があります。

今回は、Docker上でFlaskで作ったREST APIアプリケーションを構築し、そのアプリケーションへVisual Studio Codeからリモートデバッグしていきましょう。

前提

以下の準備が整っている必要があります。

Dockerがインストールされている
Visual Studio Codeがインストールされている(Python用の基本設定は以前の記事を参照してください)
Python3がインストールされている

細かいバージョンは「環境」を参照してください。

Docker上に簡単なFlaskのREST APIアプリケーションを作る

ベースを作る

まずはデバッグする対象となるRESTアプリケーションを簡単に作成しましょう。FlaskでRESTなAPIを作ります。

$ mkdir flask-vscodea-app
$ cd flask-vscodea-app/
$ touch app.py
$ touch requirements.txt
$ touch Dockerfile
$ touch docker-compose.yml

Dockerの設定ファイルを作る

今回のアプリケーションはFlakeのアプリケーションからMongoDBを使う構成にします。

Dockerfile

以下のようにします。

FROM python:3-slim-stretch

WORKDIR /usr/src/app

COPY requirements.txt ./
RUN pip install --upgrade pip setuptools \
  && pip install --no-cache-dir -r requirements.txt

ENV PYTHONUNBUFFERED 1
ENV FLASK_APP app.py

COPY ./ ./

EXPOSE 5000

CMD python app.py

注意点としては、PythonのイメージとしてAlpineを選択するとビルドできないパッケージがあるという点です。Dockerに慣れているとAlpineを選択しがちですが、PythonではSlimを選択するのがベターです。

また、DockerでPython環境を構築する場合は、venvで仮想環境を構築する必要はなく、単にグローバルにパッケージをインストールして使います。

docker-compose.yml

FlakeのアプリケーションからMongoDBを使う構成になるように以下のように書きます。

version: '3'

services:
  web:
    build: .
    ports:
      - "3000:3000"
      - "5000:5000"
    environment:
      - FLASK_ENV=development
      - REMOTE_DEBUGGING=False
    volumes:
      - .:/usr/src/app
    links:
      - db

  db:
    image: mongo
    ports:
      - "27017:27017"

外部ポートは、Flaskアプリケーション用に5000ポート、リモートデバッグ用に3000ポートを開けてあります。