tweag/FawltyDeps

Tests if the generated toml config is loaded correctly as the same `Settings` object: property -based check

Open

#295 opened on Apr 6, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (18 forks)auto 404
P3good first issuetype: refactoring

Repository metrics

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

Description

Test if the operation of generating pyproject.toml FawltyDeps section via:

fawltydeps --generate-toml-config

is loaded again gives the same object.

This will be best achieved with the property-based test of function and its inverse. The same may be done for toml settings -> Settings object ->` toml settings check.

Proposed outline of the hypothesis-based test:

generate_settings = strategies.just(Settings()) # here we need to write proper strategies

@given(setting_example=generate_settings)
def test_property__load_printed_config_gives_the_same_object(setting_example, tmp_path):
    with open(tmp_path / "pyproject.toml") as f:
        print_toml_config(setting_example, out=f)

    settings_loaded = Settings.config(config_file=tmp_path / "pyproject.toml").create()

    assert setting_example == settings_loaded

It is possible, that refactor of Setting object will be needed or some clever way to use temporary directories in a hypothesis check.

Contributor guide

Research direction
Implement the property based test as outlined using Hypothesis. You may need to write custom strategies for the Settings object and handle temporary directories within Hypothesis. Refactor the Settings object if needed to enable equality comparison and serialization roundtrips.
Tech stack
python
Domain
backendcli
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
PythonHypothesis
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65