Replace _get_url abstract test method with a pytest fixture

[sbland]

• fixes Use url fixture instead of abstract method in tests #750

Description

Replaces the use of the _get_url abstract method with a def url(self)... fixture. This allows accessing other fixture data such as database mocked instances.

Fixes #750

Type of change

• Documentation (non-breaking change that adds or improves the documentation)
• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Technical work (non-breaking, change which is work as part of a new feature)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass (eg. python -m pytest)
• The documentation builds and looks OK (eg. mkdocs serve)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[sbland]

@AdrianDAlessandro I needed to implement this to do tests where we needed to pass url params to the _get_url method, particularly for beautiful soup tests.

Also there was a failing test on the main branch. I'm not sure if this is just local to me.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[AdrianDAlessandro]

I'm not sure exactly what this is trying to fix. The issue says it's to be able to pass arguments to the _get_url method, but that is already done in some places. I've commented on the parts that do it.

[AdrianDAlessandro]

Is what you are trying to do achieved by this existing pattern?

[AdrianDAlessandro]

Results in being able to pass args to reverse like this

[sbland]

I'm not sure exactly what this is trying to fix. The issue says it's to be able to pass arguments to the _get_url method, but that is already done in some places. I've commented on the parts that do it.

The existing method works if you are calling _get_url from inside the class that defines get_url but doesn't work when we use _get_url in a fixture. Example here: https://github.com/direct-framework/direct-webapp/blob/main/tests/main/view_utils.py#L63

The use case I couldn't implement is when the url should use params that are defined from mocked database instance objects.

Edit:

class BS4Mixin(ABC):
    """Mixin for tests that use BeautifulSoup4. It makes the `soup` fixture available.

    Note: Using this requires the test class to define:
        - A `_get_url` method
    """

    @abstractmethod
    def _get_url(self) -> str:
        return NotImplemented

    @pytest.fixture
    def soup(self, client) -> BeautifulSoup:
        """A fixture of the BeautifulSoup4 object of the requested page."""
        response = client.get(self._get_url()) # << This does not allow passing args
        return BeautifulSoup(response.content, "html.parser")
...