Markers

Markers#

@pytest.mark.portal#

Configures a portal fixture before the test runs.

The marker is honored by all four portal fixtures: portal, portal_class, functional_portal, and functional_portal_class.

It accepts three keyword arguments, all optional:

profiles

A list of GenericSetup profile identifiers to apply. Both "my.addon:default" and the full "profile-my.addon:default" form work—the profile- prefix is added when missing.

content

A list of dictionaries. Each is passed as keyword arguments to plone.api.content.create(container=portal, **spec). Content is created as the site owner.

roles

A list of roles to grant to the default test user on the portal.

They are applied in that order: profiles, then content, then roles.

import pytest


@pytest.mark.portal(
    profiles=["my.addon:testing"],
    content=[{"type": "Document", "id": "doc1", "title": "A document"}],
    roles=["Manager"],
)
def test_portal_with_marker(portal):
    assert "doc1" in portal

Important

On the class-scoped fixtures, only a marker applied to the class is honored. A class-scoped fixture is created once for the whole class and cannot see markers on individual methods, so a method-level marker is silently ignored.

import pytest


@pytest.mark.portal(roles=["Manager"])
class TestDocument:
    def test_one(self, portal_class):
        assert portal_class.title == "Plone site"

    def test_two(self, portal_class):
        assert portal_class.title == "Plone site"

Registering the marker#

pytest-plone registers portal with pytest itself, so you do not need to declare it in your pytest.ini or pyproject.toml.

Contents