Deltares / Deltares/imod-python

decide on a policy for using fixtures

Open
#769 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion
Dominant language
Python
Stars
41
Forks
12
Avg merge
21h 8m
Merged PRs (30d)
1

Description

Fixtures provide a convenient way to set up tests, but there are alternatives as well. Most of what they achieve could also be achieved by calling regular functions, or by using pytest cases. In fact, all three of these approaches are used in our testing code.
We should investigate which approach brings what benefits and what disadvantages, and come up wit a policy for choosing the approach.
We can use other python projects for reference/inspiration (such as xarray), read testing framework documentation, and discuss the findings.

Contributor guide

No contributing guide indexed for this repository

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

Review the existing testing code to compare fixtures, regular function calls, and pytest cases, then consult testing framework documentation and the xarray project for reference. Done means producing and discussing a clear policy that explains the benefits and disadvantages of each approach and when to choose one.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.