quivr/docs/developers/contribution/test.mdx

---
sidebar_position: 7
title: Testing Strategies
---

## Backend

- E2E Test
  - User journeys
- Unit Test
  - Test base classes for models for breaking change (Vectorstore, Brainpicking, etc...)
  - Test endpoints
  - Test utility functions
  - Test critical functions
    - Chat related functions

How:

- Pytest

### 🐛 Debugging the backend

The backend is running in a docker container. To debug the backend, you can attach a debugger to the container. The debugger server runs on port `5678`. The backend is started in dev mode with `make dev`.

#### Debug with VSCode

The configuration for this is already set up in the `launch.json` file in the `.vscode` folder. After you started the project in dev mode with `make dev` you can run a debugging session using the `Python: Remote attach` configuration.

## Frontend

- Functional tests
  - Good rendering of components
  - Backend call is made
  - State is updated
  - User can interact with the component

How:

- Vitest
- RTL (React Testing Library)
docs(tests): testing strategies (#464) 2023-07-03 12:30:29 +03:00			`---`
docs: update Quivr doc (#1531) Issue: https://github.com/StanGirard/quivr/issues/1526 2023-10-31 20:16:51 +03:00			`sidebar_position: 7`
feat(docs): added env file 2023-11-05 02:24:43 +03:00			`title: Testing Strategies`
docs(tests): testing strategies (#464) 2023-07-03 12:30:29 +03:00			`---`

			`## Backend`

			`- E2E Test`
			`- User journeys`
			`- Unit Test`
			`- Test base classes for models for breaking change (Vectorstore, Brainpicking, etc...)`
			`- Test endpoints`
			`- Test utility functions`
			`- Test critical functions`
			`- Chat related functions`

			`How:`
feat: ⚙️🐞 configure debugger for the backend (#1345) 2023-10-09 16:23:13 +03:00
docs(tests): testing strategies (#464) 2023-07-03 12:30:29 +03:00			`- Pytest`

feat: ⚙️🐞 configure debugger for the backend (#1345) 2023-10-09 16:23:13 +03:00			`### 🐛 Debugging the backend`

			The backend is running in a docker container. To debug the backend, you can attach a debugger to the container. The debugger server runs on port `5678`. The backend is started in dev mode with `make dev`.

			`#### Debug with VSCode`

			The configuration for this is already set up in the `launch.json` file in the `.vscode` folder. After you started the project in dev mode with `make dev` you can run a debugging session using the `Python: Remote attach` configuration.

			`## Frontend`
docs(tests): testing strategies (#464) 2023-07-03 12:30:29 +03:00
Tests.md typo correction (#606) 2023-07-12 10:24:53 +03:00			`- Functional tests`
docs(tests): testing strategies (#464) 2023-07-03 12:30:29 +03:00			`- Good rendering of components`
			`- Backend call is made`
			`- State is updated`
			`- User can interact with the component`

			`How:`
feat: ⚙️🐞 configure debugger for the backend (#1345) 2023-10-09 16:23:13 +03:00
docs(tests): testing strategies (#464) 2023-07-03 12:30:29 +03:00			`- Vitest`
Tests.md typo correction (#606) 2023-07-12 10:24:53 +03:00			`- RTL (React Testing Library)`