pyceo/tests/ceod/api/test_groups.py

import ldap3
import pytest

from ceod.model import Group


def test_api_group_not_found(client):
    status, data = client.get('/api/groups/no_such_group')
    assert status == 404


@pytest.fixture(scope='module')
def create_group_resp(client):
    status, data = client.post('/api/groups', json={
        'cn': 'test_group1',
        'description': 'Test Group One',
    })
    assert status == 200
    assert data[-1]['status'] == 'completed'
    yield status, data
    status, data = client.delete('/api/groups/test_group1')
    assert status == 200
    assert data[-1]['status'] == 'completed'


@pytest.fixture(scope='module')
def create_group_result(create_group_resp):
    # convenience method
    _, data = create_group_resp
    return data[-1]['result']


def test_api_create_group(cfg, create_group_resp, ldap_conn):
    _, data = create_group_resp
    min_uid = cfg.get('clubs_min_id')
    users_base = cfg.get('ldap_users_base')
    sudo_base = cfg.get('ldap_sudo_base')

    expected = [
        {"status": "in progress", "operation": "add_user_to_ldap"},
        {"status": "in progress", "operation": "add_group_to_ldap"},
        {"status": "in progress", "operation": "add_sudo_role"},
        {"status": "in progress", "operation": "create_home_dir"},
        {"status": "completed", "result": {
            "cn": "test_group1",
            "gid_number": min_uid,
            "description": "Test Group One",
            "members": [],
        }},
    ]
    assert data == expected

    # verify that a user was also created
    ldap_conn.search(
        f'uid=test_group1,{users_base}', '(objectClass=*)',
        search_scope=ldap3.BASE)
    assert len(ldap_conn.entries) == 1

    # verify that a sudo role was also created
    ldap_conn.search(
        f'cn=%test_group1,{sudo_base}', '(objectClass=*)',
        search_scope=ldap3.BASE)
    assert len(ldap_conn.entries) == 1


def test_api_get_group(cfg, client, create_group_result):
    old_data = create_group_result
    cn = old_data['cn']

    status, data = client.get(f'/api/groups/{cn}')
    assert status == 200
    assert data == old_data


def test_api_add_member_to_group(client, create_group_result, ldap_user):
    uid = ldap_user.uid
    cn = create_group_result['cn']

    status, data = client.post(f'/api/groups/{cn}/members/{uid}')
    assert status == 200
    expected = [
        {"status": "in progress", "operation": "add_user_to_group"},
        {"status": "completed", "result": {"added_to_groups": [cn]}},
    ]
    assert data == expected

    _, data = client.get(f'/api/groups/{cn}')
    expected = {
        "cn": cn,
        "gid_number": create_group_result['gid_number'],
        "description": create_group_result['description'],
        "members": [
            {
                "cn": ldap_user.cn,
                "program": ldap_user.program,
                "uid": ldap_user.uid,
            }
        ],
    }
    assert data == expected

    status, data = client.delete(f'/api/groups/{cn}/members/{uid}')
    assert status == 200
    expected = [
        {"status": "in progress", "operation": "remove_user_from_group"},
        {"status": "completed", "result": {"removed_from_groups": [cn]}},
    ]
    assert data == expected

    _, data = client.get(f'/api/groups/{cn}')
    assert data['members'] == []


def test_api_group_auxiliary(cfg, client, ldap_user, g_admin_ctx):
    # Make sure that syscom has auxiliary mailing lists and groups
    # defined in ceod_test_local.ini.
    # Also make sure that the auxiliary mailing lists are defined in
    # MockMailmanServer.py.
    aux_groups = cfg.get('auxiliary groups_syscom')
    aux_lists = cfg.get('auxiliary mailing lists_syscom')
    min_uid = cfg.get('clubs_min_id')
    # add one to account for the 'Test Group One' group, above
    min_uid += 1

    group_names = ['syscom'] + aux_groups
    groups = []
    with g_admin_ctx():
        for group_name in group_names:
            group = Group(
                cn=group_name,
                gid_number=min_uid,
            )
            group.add_to_ldap()
            groups.append(group)
            min_uid += 1

    uid = ldap_user.uid
    _, data = client.post(f'/api/groups/syscom/members/{uid}')
    expected = [
        {"status": "in progress", "operation": "add_user_to_group"},
        {"status": "in progress", "operation": "add_user_to_auxiliary_groups"},
        {"status": "in progress", "operation": "subscribe_user_to_auxiliary_mailing_lists"},
        {"status": "completed", "result": {
            "added_to_groups": group_names,
            "subscribed_to_lists": aux_lists,
        }},
    ]
    assert data == expected

    _, data = client.delete(f'/api/groups/syscom/members/{uid}')
    expected = [
        {"status": "in progress", "operation": "remove_user_from_group"},
        {"status": "in progress", "operation": "remove_user_from_auxiliary_groups"},
        {"status": "in progress", "operation": "unsubscribe_user_from_auxiliary_mailing_lists"},
        {"status": "completed", "result": {
            "removed_from_groups": group_names,
            "unsubscribed_from_lists": aux_lists,
        }},
    ]
    assert data == expected

    with g_admin_ctx():
        for group in groups:
            group.remove_from_ldap()