Skip to content

Commit

Permalink
Executable tutorial proposal (#2521)
Browse files Browse the repository at this point in the history
* Create README.md

* Create README.md

* Delete README.md
  • Loading branch information
WarlCang authored Sep 26, 2024
1 parent 2c4dc89 commit 5002e29
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions contributions/executable-tutorial/carlwang-jrybak/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Assignment Proposal

## Title

_Automated API testing using FastAPI, Startlette TestClient and Git Hooks_

## Names and KTH ID

- Carl Wang ([email protected])
- Jakub Rybak ([email protected])

## Deadline

- Task 3

## Category

- Executable Tutorial

## Description

The executable tutorial will provide a hands-on guide to implementing automated API testing using FastAPI, Starlette TestClient and Git Hooks. Consequently, the tutorial is going to cover the following topics:

- Setting up the required tools in the environment and creating a git repository
- Initializing a sample FastAPI project and running the API with Uvicorn
- Reviewing provided test cases for the sample API.
- Configuring Git Hooks to run provided Starlette TestClient test cases in automatic manner.
- Updating source code of the API
- Automation and regression testing of the new changes to the API

**Relevance**

Automation of testing is essential in DevOps, since it largely reduces the time taken to manually find pre-existing bugs, as well as significantly lowers the risk of accidentally introducing new ones. Moreover, this is especially vital in the area of API testing, in order to avoid regression bugs and ensure consistent performance and reliability across different environments and versions.

0 comments on commit 5002e29

Please sign in to comment.