So implementieren Sie kontinuierliche Integration und automatisiertes Testen von Anforderungen in FastAPI

So implementieren Sie kontinuierliche Integration und automatisiertes Testen von Anforderungen in FastAPI

FastAPI ist ein leistungsstarkes Web-Framework auf Basis von Python, das eine einfache und benutzerfreundliche API-Entwicklungserfahrung bietet. Gleichzeitig sind kontinuierliche Integration und automatisiertes Testen unverzichtbare Bindeglieder in der modernen Softwareentwicklung, die die Qualität und Entwicklungseffizienz von Projekten erheblich verbessern können. In diesem Artikel wird erläutert, wie kontinuierliche Integration und automatisiertes Testen von Anforderungen in FastAPI implementiert werden, und es werden entsprechende Codebeispiele beigefügt.

Zuerst müssen wir ein kontinuierliches Integrationstool wie GitHub Actions, Jenkins oder Travis CI verwenden. Diese Tools helfen uns, die Erstellung, das Testen und die Bereitstellung unserer FastAPI-Anwendungen zu automatisieren.

In unserer FastAPI-Anwendung müssen wir Pytest verwenden, um automatisierte Tests zu schreiben und auszuführen. pytest ist ein leistungsstarkes und benutzerfreundliches Python-Testframework, das uns beim Schreiben zuverlässiger Unit-Tests, Integrationstests und End-to-End-Tests helfen kann.

Hier ist der Code für eine Beispiel-FastAPI-Anwendung:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

In unserem Projektstammverzeichnis müssen wir ein Verzeichnis namens tests erstellen und unsere automatisierten Tests darin schreiben. tests的目录，并在其中编写我们的自动化测试。

下面是一个测试root端点的示例：

def test_root():
    from fastapi.testclient import TestClient
    from main import app

    client = TestClient(app)
    response = client.get("/")

    assert response.status_code == 200
    assert response.json() == {"message": "Hello World"}

在上面的示例中，我们使用了TestClient来模拟一个HTTP客户端，发送一个GET请求到我们的root端点，并断言返回的状态码和响应体是否符合预期。

为了在代码提交时自动运行测试和lint检查，我们可以使用持续集成工具提供的钩子或命令来调用pytest和lint工具。例如，在.github/workflows目录中创建一个名为ci.yml的文件，内容如下：

name: Continuous Integration

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Check out code
      uses: actions/checkout@v2

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.9

    - name: Install dependencies
      run: pip install -r requirements.txt

    - name: Run tests
      run: pytest

    - name: Run lint
      run: pylint main.py

在上面的示例中，我们配置了一个在代码提交到main

Hier ist ein Beispiel für das Testen des root-Endpunkts:

rrreee

Im obigen Beispiel haben wir TestClient verwendet, um einen HTTP-Client zu simulieren und eine GET-Anfrage an unseren root-Endpunkt und prüfen Sie, ob der zurückgegebene Statuscode und der Antworttext wie erwartet sind.

Um bei der Übermittlung von Code automatisch Tests und Lint-Prüfungen durchzuführen, können wir Hooks oder Befehle verwenden, die von Tools für die kontinuierliche Integration bereitgestellt werden, um Pytest- und Lint-Tools aufzurufen. Erstellen Sie beispielsweise eine Datei mit dem Namen ci.yml im Verzeichnis .github/workflows mit folgendem Inhalt: 🎜rrreee🎜Im obigen Beispiel haben wir eine kontinuierliche A-Integration konfiguriert Job, der ausgeführt wird, wenn Code in den Zweig main übertragen wird. Der Job besteht aus einer Reihe von Schritten, darunter das Auschecken des Codes, das Einrichten der Python-Umgebung, das Installieren von Abhängigkeiten, das Ausführen von Tests und das Ausführen von Lint. 🎜🎜Es ist zu beachten, dass dies nur ein Beispiel ist und nicht für alle Projekte gilt. Abhängig von der tatsächlichen Situation können entsprechende Modifikationen und Anpassungen erforderlich sein. 🎜🎜Durch kontinuierliche Integration und automatisierte Tests können wir sicherstellen, dass jede Code-Übermittlung automatisierte Tests und Lint-Checks durchläuft und so die Codequalität und Entwicklungseffizienz verbessert. Die Implementierung von kontinuierlicher Integration und automatisiertem Testen von Anforderungen in FastAPI kann uns dabei helfen, qualitativ hochwertige API-Anwendungen effektiv zu erstellen und zu warten. 🎜

Das obige ist der detaillierte Inhalt vonSo implementieren Sie kontinuierliche Integration und automatisiertes Testen von Anforderungen in FastAPI. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!