openlibhums / openlibhums/janeway

Add unit tests for Janeway's REST Interface

Open
#3,376 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Infrastructure
Dominant language
Python
Stars
238
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

Describe the bug
There are no tests written for the Django REST Framework-based Janeway API, other than the OAI tests. The DRF includes a few helper classes that extend Django's existing test framework, and improve support for making API requests. The whole API needs testing.

Janeway version
1.4.3, but any version with the API included lacks tests for anything except the OAI endpoints

To Reproduce
Steps to reproduce the behavior:

  1. Go to the src/api/tests folder
  2. Observe that there are only tests written for the OAI endpoints

Expected behavior
All endpoints in the API need tests.

Screenshots
n/a

Front-end Issues

n/a

Desktop (please complete the following information):
n/a

Smartphone (please complete the following information):
n/a

Additional context
n/a

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/api/tests and review the existing OAI endpoint tests, then read the Django REST Framework testing guide linked in the issue. Identify the remaining API endpoints and add coverage for them; done means the API endpoints beyond OAI have unit tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
api, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.