pcdshub / pcdshub/hutch-python

Test logging needs cleanup

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

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
18
Avg merge
7d 9h
Merged PRs (30d)
1

Description

Expected Behavior

All unit tests should be independent

Current Behavior

Certain tests that run through the hutch-python logging setup mechanisms can break other tests that test the logging mechanism when they fail, because they also fail to clean up the mess they've made.

Possible Solution

Use fixtures or try/except for cleanup

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

Locate the unit tests that exercise the hutch-python logging setup mechanisms and run them with the broader test suite. Review how those tests alter logging state and add cleanup that also runs when a test fails. Done means each test restores its logging state so failures cannot affect other logging tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.