add_to_group

Scope: function | Returns: callable

The add_to_group fixture returns a callable that adds users or subgroups to an existing group.

Signature

add_to_group(
    group: Group | int,
    user_members: Iterable[LimeUser | int] | None = None,
    subgroup_members: Iterable[Group | int] | None = None,
) -> None

Both group and the members can be passed as objects or IDs.

Basic usage

def test_something(create_user, create_group, add_to_group):
    user = create_user(username="alice", _return_entity=True)
    group = create_group(name="my_group", _return_entity=True)

    add_to_group(group, user_members=[user])

Adding subgroups

def test_something(create_group, add_to_group):
    parent = create_group(name="parent", _return_entity=True)
    child = create_group(name="child", _return_entity=True)

    add_to_group(parent, subgroup_members=[child])