jerdra/niviz-rater

MAINT: Testing mega-effort

Open

#10 opened on Dec 7, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4 forks)auto 404
backendfrontendhelp wantedimpact: largemaintenance

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

niviz-rater was a cow-boy project of trying to solve the problem of QC sucking. As a result, its lacking in structure and testing. This issue is my hopes and dreams of making this a properly set up project. Tests are needed for the following major items:

Backend

  1. index.py does it create the correct database when initialized?
  2. api.py does it return the correct values from GET requests
  3. api.py does it implement the current SQL calls on POST requests

Note that part of this may require some refactoring to make sure that the backend is sufficiently testable

Frontend

Svelte is relatively new territory for me, but this is probably a good place to start:

https://github.com/testing-library/svelte-testing-library

Contributor guide

Research direction
Check the existing project structure for any tests. Understand how index.py creates the database and how api.py implements GET and POST endpoints. For the Svelte frontend, explore component behavior and consider using svelte testing library. Start with backend tests, then add frontend tests.
Tech stack
pythonsveltesql
Domain
backendfrontendtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSvelteGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20