用 Python 和 Conu 測試容器

2018-11-25 21:51:00

越來越多的開發人員使用容器開發和部署他們的應用。這意味著可以輕鬆地測試容器也變得很重要。Conu (container utilities 的簡寫) 是一個 Python 庫,讓你編寫容器測試變得簡單。本文向你介紹如何使用它測試容器。

開始吧

首先,你需要一個容器程式來測試。為此,以下命令建立一個包含一個容器的 Dockerfile 和一個被容器伺服的 Flask 應用程式的資料夾。

$ mkdir container_test$ cd container_test$ touch Dockerfile$ touch app.py

將以下程式碼複製到 app.py 檔案中。這是慣常的基本 Flask 應用,它返回字串 “Hello Container World!”。

from flask import Flaskapp = Flask(__name__)@app.route('/')def hello_world():    return 'Hello Container World!'if __name__ == '__main__':    app.run(debug=True,host='0.0.0.0')

建立和構建測試容器

為了構建測試容器,將以下指令新增到 Dockerfile。

FROM registry.fedoraproject.org/fedora-minimal:latestRUN microdnf -y install python3-flask && microdnf clean allADD ./app.py /srvCMD ["python3", "/srv/app.py"]

然後使用 Docker CLI 工具構建容器。

$ sudo dnf -y install docker$ sudo systemctl start docker$ sudo docker build . -t flaskapp_container

提示:只有在系統上未安裝 Docker 時才需要前兩個命令。

構建之後使用以下命令執行容器。

$ sudo docker run -p 5000:5000 --rm flaskapp_container* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)* Restarting with stat* Debugger is active!* Debugger PIN: 473-505-51

最後,使用 curl 檢查 Flask 應用程式是否在容器內正確執行:

$ curl http://127.0.0.1:5000Hello Container World!

現在,flaskapp_container 正在執行並準備好進行測試,你可以使用 Ctrl+C 將其停止。

建立測試指令碼

在編寫測試指令碼之前,必須安裝 conu。在先前建立的 container_test 目錄中,執行以下命令。

$ python3 -m venv .venv$ source .venv/bin/activate(.venv)$ pip install --upgrade pip(.venv)$ pip install conu$ touch test_container.py

然後將以下指令碼複製並儲存在 test_container.py 檔案中。

import conuPORT = 5000with conu.DockerBackend() as backend:  image = backend.ImageClass("flaskapp_container")  options = ["-p", "5000:5000"]  container = image.run_via_binary(additional_opts=options)    try:    # Check that the container is running and wait for the flask application to start.    assert container.is_running()    container.wait_for_port(PORT)        # Run a GET request on / port 5000.    http_response = container.http_request(path="/", port=PORT)        # Check the response status code is 200    assert http_response.ok        # Get the response content    response_content = http_response.content.decode("utf-8")    # Check that the "Hello Container World!" string is served.    assert "Hello Container World!" in response_content    # Get the logs from the container    logs = [line for line in container.logs()]    # Check the the Flask application saw the GET request.    assert b'"GET / HTTP/1.1" 200 -' in logs[-1]  finally:    container.stop()    container.delete()

測試設定

這個指令碼首先設定 conu 使用 Docker 作為後端來執行容器。然後它設定容器映象以使用你在本教學第一部分中構建的 flaskapp_container。

下一步是設定執行容器所需的選項。在此範例中,Flask 應用在埠5000上提供內容。於是你需要暴露此埠並將其對映到主機上的同一埠。

最後,用這個指令碼啟動容器,現在可以測試了。

測試方法

在測試容器之前,檢查容器是否正在執行並準備就緒。示範指令碼使用 container.is_runningcontainer.wait_for_port。這些方法可確保容器正在執行,並且服務在預設埠上可用。

container.http_requestrequest 庫的包裝器,可以方便地在測試期間傳送 HTTP 請求。這個方法返回requests.Responseobject,因此可以輕鬆地存取響應的內容以進行測試。

conu 還可以存取容器紀錄檔。又一次,這在測試期間非常有用。在上面的範例中,container.logs 方法返回容器紀錄檔。你可以使用它們斷言列印了特定紀錄檔,或者,例如在測試期間沒有異常被引發。

conu 提供了許多與容器接合的有用方法。文件中提供了完整的 API 列表。你還可以參考 GitHub 上提供的範例。

執行本教學所需的所有程式碼和檔案也可以在 GitHub 上獲得。 對於想要進一步採用這個例子的讀者,你可以看看使用 pytest 來執行測試並構建一個容器測試套件。