lightly-ai/lightly

Cleanup Tests

Open

#1,206 opened on May 10, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (337 forks)auto 404
help wanted

Repository metrics

Stars
 (3,775 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

The goal is to:

  • Rename test files to match package file structure
  • Move all tests to pytest format
  • Split subtests into individual tests or use pytest.mark.parametrize
  • Move tests for classes into classes and tests for functions into functions. For example: 
    class TestClassName:
    def test_method(self) -> None:
        assert ClassName().method() == something

def test_function() -> None:
    assert module.function() == something

In this issue we don't care about the api tests. They are handled in a different project.

For outdated/deprecated modules, such as active learning, we should keep the effort minimal. I would suggest to only make the test filenames match the package file structure. But not change the tests themselves.

See https://github.com/lightly-ai/lightly/blob/master/tests/models/modules/test_memory_bank.py for an example test file.

Tasks

  • Cleanup tests for the lightly/transforms subpackage
  • Cleanup tests for the lightly/loss subpackage
  • Cleanup tests for the lightly/models/modules subpackage
  • Cleanup tests for lightly/models/utils.py
  • Rename test files for models in lightly/models subpackage
  • Cleanup tests for the lightly/data subpackage
  • Cleanup tests for the lightly/embedding subpackage
  • Cleanup tests for lightly/utils subpackage

Contributor guide

Research direction
Examine the existing test files under the listed subpackages and restructure them according to the guidelines: rename files to match package structure, use pytest format, split subtests, and organize tests into classes/functions. Reference the example test file at tests/models/modules/test memory bank.py. For deprecated modules like active learning, only rename test files, don't change tests.
Tech stack
python
Domain
backendtesting
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60