Skip to content

ci(frontend): implement tests and setup gha workflow #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aadil96 merged 2 commits into from
Nov 19, 2025
Merged

ci(frontend): implement tests and setup gha workflow #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d872f4
ci(frontend): implement tests and setup gha workflow
aadil96 Nov 19, 2025
dc6cb36
fix(frontend): missing dev dependency
aadil96 Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions .github/workflows/frontend-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Frontend Tests

on:
pull_request:

jobs:
check_paths:
runs-on: ubuntu-latest
outputs:
should_run: ${{ steps.filter.outputs.backend }}
steps:
- uses: actions/checkout@v4
- uses: dorny/paths-filter@v3.0.2
id: filter
with:
filters: |
backend:
- 'src/frontend/**'
- '.github/workflows/frontend-tests.yaml'

test:
name: Test Frontend
needs: check_paths
if: ${{ needs.check_paths.outputs.should_run == 'true' }}
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./src/frontend

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install UV
uses: astral-sh/setup-uv@v5

- name: Set up Python
run: uv python install

- name: Install dependencies
run: |
uv sync --locked --dev

- name: Lint with Ruff
run: |
uv run ruff check --output-format=github --target-version=py313 src tests
uv run ruff format --diff --check --target-version=py313 src tests

- name: Run tests with coverage
run: |
uv run pytest

- name: Run tests with coverage
run: |
uv run pytest tests/ -v --cov=src/frontend --cov-report=xml --cov-fail-under=80

- name: Upload coverage report
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: ./src/frontend/coverage.xml
retention-days: 7
if: ${{ always() }}

- name: Coverage Report
uses: irongut/CodeCoverageSummary@v1.3.0
with:
filename: ./src/frontend/coverage.xml
badge: true
format: markdown
output: both

- name: Add Coverage PR Comment
uses: marocchino/sticky-pull-request-comment@v2
if: github.event_name == 'pull_request'
with:
header: test-coverage
recreate: true
path: code-coverage-results.md
Binary file added src/frontend/.coverage
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions src/frontend/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ WORKDIR /app
RUN --mount=type=cache,target=/root/.cache/uv \
--mount=type=bind,source=uv.lock,target=uv.lock \
--mount=type=bind,source=pyproject.toml,target=pyproject.toml \
uv sync --locked --no-install-project --no-editable
uv sync --locked --no-install-project --no-editable --no-dev

# Copy the project into the intermediate image
COPY . /app

# Sync the project and install it, now that we have access to the source code
RUN --mount=type=cache,target=/root/.cache/uv \
uv sync --locked --no-editable
uv sync --locked --no-editable --no-dev

FROM python:3.13-alpine

Expand Down
100 changes: 100 additions & 0 deletions src/frontend/coverage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<?xml version="1.0" ?>
<coverage version="7.12.0" timestamp="1763572171517" lines-valid="76" lines-covered="73" line-rate="0.9605" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.12.0 -->
<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
<sources>
<source>/workspaces/devops/src/frontend/src/frontend</source>
</sources>
<packages>
<package name="." line-rate="0.9605" branch-rate="0" complexity="0">
<classes>
<class name="__init__.py" filename="__init__.py" complexity="0" line-rate="1" branch-rate="0">
<methods/>
<lines>
<line number="8" hits="1"/>
<line number="11" hits="1"/>
</lines>
</class>
<class name="main.py" filename="main.py" complexity="0" line-rate="0.9595" branch-rate="0">
<methods/>
<lines>
<line number="1" hits="1"/>
<line number="2" hits="1"/>
<line number="3" hits="1"/>
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="6" hits="1"/>
<line number="9" hits="1"/>
<line number="12" hits="1"/>
<line number="15" hits="1"/>
<line number="18" hits="1"/>
<line number="19" hits="1"/>
<line number="20" hits="1"/>
<line number="21" hits="1"/>
<line number="22" hits="1"/>
<line number="25" hits="1"/>
<line number="27" hits="1"/>
<line number="28" hits="1"/>
<line number="29" hits="1"/>
<line number="30" hits="1"/>
<line number="34" hits="1"/>
<line number="36" hits="1"/>
<line number="37" hits="1"/>
<line number="40" hits="1"/>
<line number="41" hits="1"/>
<line number="44" hits="1"/>
<line number="47" hits="1"/>
<line number="49" hits="1"/>
<line number="50" hits="1"/>
<line number="51" hits="1"/>
<line number="52" hits="1"/>
<line number="55" hits="1"/>
<line number="57" hits="1"/>
<line number="58" hits="1"/>
<line number="59" hits="1"/>
<line number="64" hits="1"/>
<line number="65" hits="1"/>
<line number="66" hits="1"/>
<line number="67" hits="1"/>
<line number="68" hits="1"/>
<line number="72" hits="1"/>
<line number="73" hits="1"/>
<line number="75" hits="1"/>
<line number="76" hits="1"/>
<line number="79" hits="1"/>
<line number="80" hits="1"/>
<line number="82" hits="1"/>
<line number="83" hits="1"/>
<line number="84" hits="1"/>
<line number="86" hits="1"/>
<line number="87" hits="1"/>
<line number="88" hits="1"/>
<line number="90" hits="1"/>
<line number="91" hits="1"/>
<line number="92" hits="1"/>
<line number="94" hits="1"/>
<line number="95" hits="1"/>
<line number="97" hits="1"/>
<line number="99" hits="1"/>
<line number="100" hits="1"/>
<line number="102" hits="1"/>
<line number="105" hits="1"/>
<line number="106" hits="1"/>
<line number="108" hits="1"/>
<line number="110" hits="1"/>
<line number="113" hits="1"/>
<line number="114" hits="1"/>
<line number="115" hits="1"/>
<line number="117" hits="1"/>
<line number="118" hits="1"/>
<line number="123" hits="1"/>
<line number="125" hits="0"/>
<line number="126" hits="0"/>
<line number="129" hits="1"/>
<line number="130" hits="0"/>
</lines>
</class>
</classes>
</package>
</packages>
</coverage>
15 changes: 11 additions & 4 deletions src/frontend/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ description = "Frontend for DevOps Study Tracker application"
readme = "README.md"
authors = [{ name = "Mischa van den Burg", email = "mischa@gmail.com" }]
requires-python = ">=3.13"
dependencies = [
"flask>=3.1.2",
"requests>=2.32.5",
]
dependencies = ["flask>=3.1.2", "requests>=2.32.5"]

[project.scripts]
study-tracker-frontend = "frontend.main:main"
Expand All @@ -19,3 +16,13 @@ packages = ["src/frontend"]
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[dependency-groups]
dev = [
"httpx>=0.28.1",
"pytest>=9.0.1",
"pytest-asyncio>=1.3.0",
"pytest-cov>=7.0.0",
"responses>=0.25.8",
"ruff>=0.14.5",
]
29 changes: 29 additions & 0 deletions src/frontend/tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import pytest
from flask import template_rendered
from contextlib import contextmanager
from frontend.main import app


@contextmanager
def captured_templates(app):
"""Context manager to track templates rendered by the Flask app.
Allows test to assert on which templates were rendered and their contexts.
"""
recorded = []

def record(sender, template, context, **kwargs):
recorded.append((template, context))

template_rendered.connect(record, app)
try:
yield recorded
finally:
template_rendered.disconnect(record, app)


@pytest.fixture
def client():
"""Test client for the Flask application"""
app.config["TESTING"] = True
with app.test_client() as client:
yield client
Loading