diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml index a98b15e..93c2555 100644 --- a/.github/workflows/ci-cd.yml +++ b/.github/workflows/ci-cd.yml @@ -19,6 +19,16 @@ jobs: - name: Checkout code uses: actions/checkout@v4 + - uses: actions/setup-python@v4 + with: + python-version: 3.11 + + - run: pip install -r requirements.txt + + - name: Lint code + run: ruff check app/ tests/ --fix + + test: name: Run Tests runs-on: ubuntu-latest @@ -28,6 +38,15 @@ jobs: - name: Checkout code uses: actions/checkout@v4 + - uses: actions/setup-python@v4 + with: + python-version: 3.11 + + - run: pip install -r requirements.txt + + - name: Run coverage test + run: pytest --cov=app --cov-report=html --cov-fail-under=80 + build: name: Build Docker Image runs-on: ubuntu-latest @@ -40,3 +59,26 @@ jobs: steps: - name: Checkout code uses: actions/checkout@v4 + + - name: Build docker image + run: docker build -t ${{ secrets.REGISTRY_USERNAME }}/fastapi-gitops-starter:latest -f docker/Dockerfile . + + - name: Add tag image on release + if: github.event_name == 'release' + run: | + docker tag ${{ secrets.REGISTRY_USERNAME }}/fastapi-gitops-starter:latest \ + ${{ secrets.REGISTRY_USERNAME }}/fastapi-gitops-starter:${{ github.ref_name }} + + - name: Login to Container Registry + uses: docker/login-action@v1 + with: + username: ${{ secrets.REGISTRY_USERNAME }} + password: ${{ secrets.REGISTRY_PASSWORD }} + + - name: Push Docker image + run: | + docker push ${{ secrets.REGISTRY_USERNAME }}/fastapi-gitops-starter:latest + if [ "${GITHUB_EVENT_NAME}" = "release" ]; then + docker push ${{ secrets.REGISTRY_USERNAME }}/fastapi-gitops-starter:${GITHUB_REF_NAME} + fi + diff --git a/.github/workflows/markdown2pdf.yml b/.github/workflows/markdown2pdf.yml index fcb4671..4177b58 100644 --- a/.github/workflows/markdown2pdf.yml +++ b/.github/workflows/markdown2pdf.yml @@ -19,7 +19,7 @@ jobs: - name: Replace links run: | - cp README.md README_WITH_LINKS.md + cp README.md README_WITH_LINKS.md sed -i -e "s#\(^\!\[[^]]\+\](\)\(images/\)#\1$URL/\2#g" README_WITH_LINKS.md for file in sources/*; do sed -i -e "s#($file)#($URL/$file)#g" README_WITH_LINKS.md ; done diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d337d10..ac3c529 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,3 +3,9 @@ repos: rev: v5.0.0 hooks: - id: trailing-whitespace + - id: check-added-large-files + - id: check-yaml + exclude: "helm/.*\\.yaml" + - id: requirements-txt-fixer + - id: detect-private-key + - id: check-ast diff --git a/README.md b/README.md index 79bb814..057f54d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ GitOps with FastAPI ***University of Amsterdam*** -# 1. Introduction +# 1. Introduction In this tutorial, we use GitOps practices with FastAPI, including CI/CD pipelines, code quality tools, and automated testing. @@ -35,7 +35,7 @@ In this tutorial, we use GitOps practices with FastAPI, including CI/CD pipeline -# 2. Tutorial +# 2. Tutorial The steps of this tutorial are as follows: - [Building REST APIs with FastAPI](#21-setting-up-the-project) @@ -60,17 +60,17 @@ Prerequisites: ``` * Set Up the Python Environmentt: - + ```bash # Create a virtual environment python -m venv venv - + # Activate the virtual environment # On Linux/MacOS: source venv/bin/activate # On Windows: venv\Scripts\activate - + # Install dependencies pip install -r requirements.txt ``` @@ -110,7 +110,7 @@ Prerequisites: ```bash # Check for issues ruff check app/ tests/ - + # Fix auto-fixable issues ruff check app/ tests/ --fix ``` @@ -120,7 +120,7 @@ Prerequisites: ```bash # Check formatting black --check app/ tests/ - + # Format code black app/ tests/ ``` @@ -134,7 +134,7 @@ Pre-commit hooks automatically run checks before each commit to ensure consisten ```bash # Install pre-commit pip install pre-commit - + # Install the git hooks pre-commit install ``` @@ -142,11 +142,11 @@ Pre-commit hooks automatically run checks before each commit to ensure consisten * Using Pre-commit: Pre-commit will now run automatically on `git commit`. You can also run it manually: - + ```bash # Run on all files pre-commit run --all-files - + # Run on staged files pre-commit run ``` @@ -200,14 +200,14 @@ This repository includes a Helm chart for deploying the application to Kubernete - Kubernetes 1.19+ - Helm 3.0+ -* Install the Helm Chart: +* Install the Helm Chart: ```bash helm install my-release ./helm/fastapi-gitops-starter ``` -* Uninstall the Helm Chart: - +* Uninstall the Helm Chart: + ```bash helm uninstall my-release ``` @@ -239,7 +239,7 @@ including host and paths. * To make sure we do not commit secrets * To check code style - + ## 3.2 Add a New Endpoint 1. Open `app/main.py` diff --git a/app/main.py b/app/main.py index ae8adc6..30abb95 100644 --- a/app/main.py +++ b/app/main.py @@ -49,5 +49,11 @@ async def get_item(item_id: int): } +@app.post("/api/items") +async def create_item(name: str, description: str): + """Create a new item.""" + return {"id": 999, "name": name, "description": description, "created": True} + + if __name__ == "__main__": uvicorn.run(app, host="0.0.0.0", port=8000) diff --git a/docker/Dockerfile b/docker/Dockerfile index 1ef04da..8e41440 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -9,7 +9,7 @@ COPY ../requirements.txt . RUN pip install --no-cache-dir -r requirements.txt # Copy application code -COPY ../app ./app/ +COPY app/ ./app/ # Expose port 8000 EXPOSE 8000 diff --git a/helm/fastapi-gitops-starter/values.yaml b/helm/fastapi-gitops-starter/values.yaml index 20c08be..1290f90 100644 --- a/helm/fastapi-gitops-starter/values.yaml +++ b/helm/fastapi-gitops-starter/values.yaml @@ -5,19 +5,20 @@ replicaCount: 1 image: - repository: ghcr.io/qcdis/fastapi-gitops-starter - pullPolicy: IfNotPresent + repository: voshiii/fastapi-gitops-starter +# pullPolicy: IfNotPresent + pullPolicy: Never # Overrides the image tag whose default is the chart appVersion. - tag: "v0.4" + tag: latest registry: - createImagePullSecret: true - secretName: image-pull-secret - server: ghcr.io + createImagePullSecret: false + secretName: "" + server: "" token: "" -imagePullSecrets: - - name: image-pull-secret +#imagePullSecrets: +# - name: image-pull-secret nameOverride: "" fullnameOverride: "" @@ -50,7 +51,7 @@ securityContext: service: type: ClusterIP - port: 80 + port: 8000 targetPort: 8000 annotations: {} @@ -79,8 +80,8 @@ resources: livenessProbe: httpGet: - path: /GitOps-Starter/health - port: http + path: /health #/GitOps-Starter/health + port: 8000 initialDelaySeconds: 30 periodSeconds: 10 timeoutSeconds: 5 @@ -88,18 +89,18 @@ livenessProbe: readinessProbe: httpGet: - path: /GitOps-Starter/health - port: http + path: /health #/GitOps-Starter/health + port: 8000 initialDelaySeconds: 10 periodSeconds: 5 timeoutSeconds: 3 failureThreshold: 3 autoscaling: - enabled: false + enabled: true minReplicas: 2 maxReplicas: 10 - targetCPUUtilizationPercentage: 80 + targetCPUUtilizationPercentage: 10 targetMemoryUtilizationPercentage: 80 # Additional volumes on the output Deployment definition. diff --git a/requirements.txt b/requirements.txt index 0bdaab5..130e6a0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ +black==24.10.0 fastapi==0.115.5 -uvicorn[standard]==0.32.1 +httpx==0.28.1 pytest==8.3.4 pytest-cov==6.0.0 -httpx==0.28.1 ruff==0.8.4 -black==24.10.0 +uvicorn[standard]==0.32.1 diff --git a/tests/test_main.py b/tests/test_main.py index db89e2f..b942761 100644 --- a/tests/test_main.py +++ b/tests/test_main.py @@ -41,3 +41,17 @@ def test_get_item(): assert data["id"] == 5 assert data["name"] == "Item 5" assert "item number 5" in data["description"] + + +def test_post_item(): + """Test the post an item to endpoint.""" + response = client.post( + "/api/items", + params={"name": "NewItem", "description": "This is a newly added item"}, + ) + assert response.status_code == 200 + data = response.json() + assert data["id"] == 999 + assert data["name"] == "NewItem" + assert data["description"] == "This is a newly added item" + assert data["created"]