initial release

[gnudebbugs.git] / tests / test_soap.py

# Copyright (C) 2021 Free Software Foundation, Inc.
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or at your option) any
# later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

"""Tests for the soap module."""

from pathlib import Path
from typing import Any, List
import unittest

import pytest

from gnudebbugs import soap

TEST_DIR = Path(__file__).resolve().parent
TEST_DATA = TEST_DIR / 'data'


# The start of every SOAP request.
SOAP_HEADER = """<?xml version="1.0" encoding="UTF-8"?>\
<soap:Envelope soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" \
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" \
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" \
xmlns:xsd="http://www.w3.org/2001/XMLSchema" \
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\
<soap:Body>"""

# The end of every SOAP request.
SOAP_FOOTER = """</soap:Body></soap:Envelope>"""


@pytest.mark.parametrize("func,args,kwargs,expected", (
    (soap.Api.get_bug_log, [1234], {}, '<get_bug_log><xsd:int>1234</xsd:int></get_bug_log>'),
    (soap.Api.get_bugs, [], {}, '<get_bugs></get_bugs>'),
    (soap.Api.get_bugs, [], {'package': 'automake'}, '<get_bugs><a0>package</a0><a1>automake</a1></get_bugs>'),
    (soap.Api.get_status, [[]], {}, '<get_status></get_status>'),
    (soap.Api.get_status, [[1]], {}, '<get_status><xsd:int>1</xsd:int></get_status>'),
    (soap.Api.get_status, [[1, 2]], {}, '<get_status><xsd:int>1</xsd:int><xsd:int>2</xsd:int></get_status>'),
#    (soap.Api.get_usertag, ['v@b', []], {}, '<get_status><xsd:int>1</xsd:int><xsd:int>2</xsd:int></get_status>'),
    (soap.Api.newest_bugs, [0], {}, '<newest_bugs><xsd:int>0</xsd:int></newest_bugs>'),
    (soap.Api.newest_bugs, [100], {}, '<newest_bugs><xsd:int>100</xsd:int></newest_bugs>'),
))
def test_encode(func, args: List[Any], kwargs, expected: str):
    expected = SOAP_HEADER + expected + SOAP_FOOTER
    result = func(*args, **kwargs)
    assert result == expected


@pytest.mark.parametrize("filename,expected", (
    ('get_bug_log-33711.xml', [
        {
            'attachments': [],
            'body': 'I compiled ...',
            'header': '...',
            'msg_num': 5,
        },
        {
            'attachments': [],
            'body': 'reassign 33711 autoconf...',
            'header': '...',
            'msg_num': 8,
        },
        {
            'attachments': [],
            'body': 'reassign 33711 autoconf\nstop\n',
            'header': '...',
            'msg_num': 10,
        },
        {
            'attachments': [],
            'body': 'owner 33711 bug-autoconf@gnu.org\nstop\n',
            'header': '...',
            'msg_num': 12,
        },
    ]),
    ('get_bugs-0.xml', []),
    ('get_bugs-2.xml', [25740, 33711]),
    ('get_status-0.xml', None),
    ('get_status-1.xml', {
        52435: {
            'affects': '',
            'archived': 0,
            'blockedby': '',
            'blocks': '',
            'bug_num': 52435,
            'date': 1639234742,
            'done': '',
            'fixed': None,
            'fixed_date': [],
            'fixed_versions': [],
            'forwarded': '',
            'found': {
                '29.0.50': None,
            },
            'found_date': [],
            'found_versions': [
              '29.0.50',
            ],
            'id': 52435,
            'keywords': '',
            'last_modified': 1639234742,
            'location': 'db-h',
            'log_modified': 1639234742,
            'mergedwith': '',
            'msgid': '<46037FBE-8DAB-4913-850C-96F4F78622E2@Web.DE>',
            'originator': 'The Reporter <example@example.com>',
            'owner': '',
            'package': 'emacs',
            'pending': 'pending',
            'severity': 'normal',
            'source': 'unknown',
            'subject': '29.0.50; C-y seems to contain an old contents',
            'summary': '',
            'tags': '',
            'unarchived': '',
        },
    }),
    ('get_status-2.xml', {
        52435: {
            'affects': '',
            'archived': 0,
            'blockedby': '',
            'blocks': '',
            'bug_num': 52435,
            'date': 1639234742,
            'done': '',
            'fixed': None,
            'fixed_date': [],
            'fixed_versions': [],
            'forwarded': '',
            'found': {
                '29.0.50': None,
                '4.16': None,
            },
            'found_date': [],
            'found_versions': [
              '29.0.50',
            ],
            'id': 52435,
            'keywords': '',
            'last_modified': 1639234742,
            'location': 'db-h',
            'log_modified': 1639234742,
            'mergedwith': '',
            'msgid': '<46037FBE-8DAB-4913-850C-96F4F78622E2@Web.DE>',
            'originator': 'The Reporter <example@example.com>',
            'owner': '',
            'package': 'emacs',
            'pending': 'pending',
            'severity': 'normal',
            'source': 'unknown',
            'subject': '29.0.50; C-y seems to contain an old contents',
            'summary': '',
            'tags': '',
            'unarchived': '',
        },
        52436: {
            'affects': '',
            'archived': 0,
            'blockedby': '',
            'blocks': '',
            'bug_num': 52436,
            'date': 1639234742,
            'done': '',
            'fixed': None,
            'fixed_date': [],
            'fixed_versions': [],
            'forwarded': '',
            'found': None,
            'found_date': [],
            'found_versions': [],
            'id': 52436,
            'keywords': 'patch',
            'last_modified': 1639234743,
            'location': 'db-h',
            'log_modified': 1639234743,
            'mergedwith': '',
            'msgid': '<87h7bfrxw9.fsf@web.de>',
            'originator': '"Dr. Reporter" <example@example.com>',
            'owner': '',
            'package': 'guile',
            'pending': 'pending',
            'severity': 'normal',
            'source': 'unknown',
            'subject': '[patch] autoconf: Check for gperf if running from git',
            'summary': '',
            'tags': 'patch',
            'unarchived': '',
        },
    }),
    ('get_usertag-0.xml', None),
    ('newest_bugs-0.xml', []),
    ('newest_bugs-1.xml', [52436]),
    ('newest_bugs-2.xml', [52435, 52436]),
))
def test_parse(filename: str, expected: Any):
    data = (TEST_DATA / filename).read_text()
    result = soap.parse(data)
    assert result == expected