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ポートを開けてあります。
Flaskアプリケーションを作る
簡単なREST APIを作ります。
requirements.txt
インストールするパッケージのリストを書きます。
ptvsd
Flask
flask_restful
pymongo
app.py
Flaskのアプリケーションを書きます。
import os
from pymongo import MongoClient
from bson.objectid import ObjectId
from flask import Flask, request
from flask_restful import Api, Resource
app = Flask(__name__)
api = Api(app)
client = MongoClient('mongodb://db:27017')
db = client.test_db
todos = db['todos']
class Todos(Resource):
def post(self):
poseted_data = request.get_json()
new_todo = dict([
('task', poseted_data['task']),
('done', False)
])
result = todos.insert_one(new_todo)
new_todo['_id'] = str(result.inserted_id)
return new_todo
def get(self, todo_id=None):
if todo_id is not None:
todo_doc = todos.find_one({'_id': ObjectId(todo_id)})
todo = dict([
('_id', str(todo_doc['_id'])),
('task', todo_doc['task']),
('done', todo_doc['done'])
])
return todo
cursor = todos.find({})
existing_todos = []
for todo_doc in cursor:
todo = dict([
('_id', str(todo_doc['_id'])),
('task', todo_doc['task']),
('done', todo_doc['done'])
])
existing_todos.append(todo)
return existing_todos
def put(self, todo_id=None):
if todo_id is None:
error_data = {
'error': "The parameter 'todo_id' is required"
}
return error_data, 400
poseted_data = request.get_json()
update_todo = {}
if 'task' in poseted_data:
update_todo['task'] = poseted_data['task']
if 'done' in poseted_data:
update_todo['done'] = poseted_data['done']
result = todos.update_one({
'_id': ObjectId(todo_id)
}, {
'$set': update_todo
})
if result.modified_count == 0:
error_data = {
'error': "The todo doesn't exist"
}
return error_data, 404
else:
return {
'_id': todo_id
}
def delete(self, todo_id=None):
if todo_id is None:
error_data = {
'error': "The parameter 'todo_id' is required"
}
return error_data, 400
result = todos.delete_one({'_id': ObjectId(todo_id)})
if result.deleted_count == 0:
error_data = {
'error': "The todo doesn't exist"
}
return error_data, 404
else:
return {
'_id': todo_id
}
api.add_resource(Todos,
'/todos',
'/todos/'
)
if os.getenv('REMOTE_DEBUGGING', default=False) == 'True':
import ptvsd
ptvsd.enable_attach(
address=('0.0.0.0', 3000), redirect_output=True)
ptvsd.wait_for_attach()
if __name__ == '__main__':
app.run(host='0.0.0.0', port=5000, debug=False, use_reloader=False)
if __name__ == '__main__':
app.run(host='0.0.0.0', port=5000)
今回は環境変数として「REMOTE_DEBUGGING」のフラグを持たせることで、REMOTE_DEBUGGINGがTrueの場合にリモートデバッグができるようにしています。
注意点としては、リモートデバッグする時は、Flask実行時に「––no-debugger」(debug=False)と「––no-reload」(use_reloader=False)のオプションを有効にする必要があります。詳しくは公式ドキュメントを参照してください。
動作確認
それでは、APIの動作確認を簡単にしましょう。
$ docker-compose up --build -d
$ curl -v -H "Accept:application/json" -H "Content-Type:application/json" -X POST -d '{"task":"Install python3"}' http://localhost:5000/todos | jq
...
{
"task": "Install python3",
"done": false,
"_id": "5bdbbec1596a6b000bcf89dc"
}
$ curl -v -H "Accept:application/json" -H "Content-Type:application/json" -X POST -d '{"task":"Set visual studio code"}' http://localhost:5000/todos | jq
...
{
"task": "Set visual studio code",
"done": false,
"_id": "5bdbbee6596a6b000bcf89dd"
}
$ curl -v -H "Accept:application/json" -H "Content-Type:application/json" -X POST -d '{"task":"Develop my flask app"}' http://localhost:5000/todos | jq
...
{
"task": "Develop my flask app",
"done": false,
"_id": "5bdbbf19596a6b000bcf89de"
}
$ curl -v -H "Accept:application/json" http://localhost:5000/todos | jq
...
[
{
"_id": "5bdbbec1596a6b000bcf89dc",
"task": "Install python3",
"done": false
},
{
"_id": "5bdbbee6596a6b000bcf89dd",
"task": "Set visual studio code",
"done": false
},
{
"_id": "5bdbbf19596a6b000bcf89de",
"task": "Develop my flask app",
"done": false
}
]
$ curl -v -H "Accept:application/json" http://localhost:5000/todos/5bdbbf19596a6b000bcf89de | jq
...
{
"_id": "5bdbbf19596a6b000bcf89de",
"task": "Develop my flask app",
"done": false
}
$ curl -v -H "Accept:application/json" -H "Content-Type:application/json" -X PUT -d '{"done":true}' http://localhost:5000/todos/5bdbbee6596a6b000bcf89dd | jq
...
{
"_id": "5bdbbee6596a6b000bcf89dd"
}
$ curl -v -H "Accept:application/json" -X DELETE http://localhost:5000/todos/5bdbbec1596a6b000bcf89dc | jq
...
{
"_id": "5bdbbec1596a6b000bcf89dc"
}
$ curl -v -H "Accept:application/json" http://localhost:5000/todos | jq
...
[
{
"_id": "5bdbbee6596a6b000bcf89dd",
"task": "Set visual studio code",
"done": true
},
{
"_id": "5bdbbf19596a6b000bcf89de",
"task": "Develop my flask app",
"done": false
}
]
OKですね。
Visual Studio Codeでリモートデバッグする
次に、Dockerへのリモートデバッグをやってみましょう。
ローカルにptvsdをインストールする
Visual Studio Codeでリモートデバッグする場合は、PTVSDをローカルとDockerコンテナの両方にインストールする必要があります。
$ pip install ptvsd
Visual Studio Codeのデバッグ設定ファイルを作る
Visutal Studio Codeを開き、デバッグボタンから「構成の追加」をクリックします。
「Python」を選択します。
すると、ローカルに「.vscode/launch.json」のファイルが作成されます。
launch.json
「.vscode/launch.json」にリモートデバッグ用の設定を以下のように追加します。
{
"version": "0.2.0",
"configurations": [
{
"name": "Python: Attach (to Docker Container)",
"type": "python",
"request": "attach",
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "/usr/src/app"
}
],
"port": 3000,
"host": "localhost",
"internalConsoleOptions": "neverOpen"
}
]
}
リモートデバッグ用のポートを3000に設定しています。今回のDockerの設定ですでに3000ポートは開けてありますね。
動作確認
それではリモートデバッグの動作確認をしていきましょう。
まずは、REMOTE_DEBUGGINGを有効にして、Dockerを起動します。
$ vi docker-compose.yml
...
- REMOTE_DEBUGGING=True
...
$ docker-compose up --build
するとデータベースだけ起動して、以下のように接続待ち状態になります。
Visual Studio Codeからデバッグで接続します。
リモートデバッグの接続が完了するとFlaskアプリケーションが以下のように起動します。
これでリモートデバッグの準備は完了しました。
次に、POSTしたデータを取得している箇所でブレークポイントを設定しています。
コマンドラインからPOSTしてみます。
$ curl -v -H "Accept:application/json" -H "Content-Type:application/json" -X POST -d '{"task":"Debug remotely"}' http://localhost:5000/todos | jq
受信したデータがデバッグ画面に表示されています。
これでリモートデバッグが動いていることが確認できました。
最後に
いかがでしたか？これでDockerコンテナ上にPythonでアプリケーションを構築した場合に、Visutal Studio Codeからデバッグできるようになりましたね。それでは。
環境
- Visutal Studio Code: 1.28.2
- Docker: Docker version 18.06.1-ce, build e68fc7a
- Python: 3.7.1
- pip: 18.1
- ptvsd: 4.1.4
