File: test_job.py

package info (click to toggle)
ppa-dev-tools 0.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,096 kB
  • sloc: python: 5,069; makefile: 3
file content (257 lines) | stat: -rw-r--r-- 9,039 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
#!/usr/bin/env python3
# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-

# Author:  Bryce Harrington <bryce@canonical.com>
#
# Copyright (C) 2022 Bryce W. Harrington
#
# Released under GNU GPLv2 or later, read the file 'LICENSE.GPLv2+' for
# more information.

"""Job class tests."""

import os
import sys

import json
import pytest

sys.path.insert(0, os.path.realpath(
    os.path.join(os.path.dirname(os.path.realpath(__file__)), "..")))

from ppa.job import Job, get_running, get_waiting
from tests.helpers import RequestResponseMock


def test_object():
    """Checks that Job objects can be instantiated."""
    job = Job(0, '', '', '', '')
    assert job


def test_init():
    """Checks the initialization of a Job object."""
    job = Job(0, 'a', 'b', 'c', 'd')
    assert job.number == 0
    assert job.submit_time == 'a'
    assert job.source_package == 'b'
    assert job.series == 'c'
    assert job.arch == 'd'


def test_repr():
    """Checks Job object machine-parsable representation."""
    job = Job(0, 'a', 'b', 'c', 'd')
    assert repr(job) == "Job(source_package='b', series='c', arch='d')"


def test_str():
    """Checks Job object textual presentation."""
    job = Job(0, 'a', 'b', 'c', 'd')
    assert f"{job}" == 'b c (d)'


def test_to_dict():
    """Checks Job object structural representation."""
    job = Job(0, 'a', 'b', 'c', 'd')
    expected_keys = [
        'number', 'submit_time', 'source_package_name',
        'series', 'arch', 'triggers', 'ppas'
    ]
    expected_types = [str, int, list]

    d = job.to_dict()
    assert isinstance(d, dict), f"type of d is {type(d)} not dict"

    # Verify expected keys are present
    assert sorted(d.keys()) == sorted(expected_keys)

    # Verify values are within set of expected types
    for k, v in d.items():
        assert type(v) in expected_types, f"'{k}={v}' is unexpected type {type(v)}"

    # Verify full dict can be written as JSON
    try:
        assert json.dumps(d)
    except UnicodeDecodeError as e:
        assert False, f"Wrong UTF codec detected: {e}"
    except json.JSONDecodeError as e:
        assert False, f"JSON decoding error: {e.msg}, {e.doc}, {e.pos}"


def test_triggers():
    """Checks Job object's triggers."""
    job = Job(0, '', '', '', '', triggers=['a/1', 'b/2'])
    assert job.triggers == ['a/1', 'b/2']


def test_ppas():
    """Checks Job object textual presentation."""
    job = Job(0, '', '', '', '', ppas=['ppa:a/b', 'ppa:c/d'])
    assert job.ppas == ['ppa:a/b', 'ppa:c/d']


@pytest.mark.parametrize('triggers, endswith', [
    (['t/1'], '?release=c&arch=d&package=b&trigger=t%2F1'),
    (['t/2.3'], '?release=c&arch=d&package=b&trigger=t%2F2.3'),
    (['t/2.3-1'], '?release=c&arch=d&package=b&trigger=t%2F2.3-1'),
    (['t/2.3-1ubuntu2'], '?release=c&arch=d&package=b&trigger=t%2F2.3-1ubuntu2'),
    (['t/2.3-1ubuntu2~ppa1'], '?release=c&arch=d&package=b&trigger=t%2F2.3-1ubuntu2~ppa1'),
    (['t/2.3-1ubuntu2+ppa2'], '?release=c&arch=d&package=b&trigger=t%2F2.3-1ubuntu2%2Bppa2'),
    (['t/1', 'u/2'], '?release=c&arch=d&package=b&trigger=t%2F1&trigger=u%2F2'),
])
def test_request_url(triggers, endswith):
    """Checks Job object can create valid URLs for starting the test runs."""
    jobinfo = {
        'triggers': triggers,
        'ppas': ['ppa:a/b', 'ppa:c/d']
    }
    job = Job(0, 'a', 'b', 'c', 'd', jobinfo['triggers'], jobinfo['ppas'])
    assert job.request_url.startswith("https://autopkgtest.ubuntu.com/request.cgi")
    assert job.request_url.endswith(endswith)


@pytest.mark.parametrize('json_text, params, expected', [
    (
        # No Jobs returned if nothing is running in autopkgtest
        '',
        {'releases': [], 'sources': None},
        {'repr': '', 'triggers': [], 'ppas': []}
    ),
    (
        # No Jobs returned if nothing is running for the specified PPA
        (
            '{"x": {"x-job-id": {"focal": { "x": ['
            '{"submit-time": "2022-08-19 20:59:01", '
            '"triggers": ["x/1.2.3"], '
            '"ppas": ["ppa:x/x"]}, '
            '1234, '
            '"Log Output Here"'
            '] } } } }'
        ),
        {'releases': [], 'ppa': 'ppa:me/myppa', 'sources': None},
        {'repr': '', 'triggers': [], 'ppas': []}
    ),
    (
        # No Jobs returned if nothing running for the PPA matches the specified release
        (
            '{"x": {"x-job-id": {"focal": { "x": ['
            '{"submit-time": "2022-08-19 20:59:01", '
            '"triggers": ["x/1.2.3"], '
            '"ppas": ["ppa:me/myppa"]}, '
            '1234, '
            '"Log Output Here"'
            '] } } } }'
        ),
        {'releases': ['jammy'], 'ppa': 'ppa:me/myppa', 'sources': None},
        {'repr': '', 'triggers': [], 'ppas': []}
    ),
    (
        # No Jobs returned if nothing running for the PPA matches the specified package
        (
            '{"x": {"x-job-id": {"focal": { "arm64": ['
            '{"submit-time": "2022-08-19 20:59:01", '
            '"triggers": ["x/1.2.3"], '
            '"ppas": ["ppa:me/myppa"]}, '
            '1234, '
            '"Log Output Here"'
            '] } } } }'
        ),
        {'releases': None, 'ppa': 'ppa:me/myppa', 'sources': ['mypackage']},
        {'repr': '', 'triggers': [], 'ppas': []}
    ),
    (
        # Correct Job should be returned for matching criteria
        (
            '{"mypackage": {"x-job-id": {"focal": { "arm64": ['
            '{"submit-time": "2022-08-19 20:59:01", '
            '"triggers": ["x/1.2.3"], '
            '"ppas": ["ppa:me/myppa"]}, '
            '1234, '
            '"Log Output Here"'
            '] } } } }'
        ),
        {'releases': ['focal'], 'ppa': 'ppa:me/myppa', 'sources': None},
        {
            'repr': "Job(source_package='mypackage', series='focal', arch='arm64')",
            'triggers': ["x/1.2.3"],
            'ppas': ["ppa:me/myppa"]
        }
    ),
])
def test_get_running(json_text, params, expected):
    """Checks result of the get_running() command."""
    fake_response = RequestResponseMock(json_text)

    try:
        job = next(get_running(fake_response, **params))
        assert repr(job) == expected['repr']
        assert job.triggers == expected['triggers']
        assert job.ppas == expected['ppas']
    except StopIteration:
        assert expected['repr'] == ''
        assert expected['triggers'] == []
        assert expected['ppas'] == []


@pytest.mark.parametrize('json_text, params, expected', [
    (
        # No Jobs returned if nothing is running in autopkgtest
        "",
        {'releases': [], 'sources': None},
        {'repr': '', 'source_package': [], 'triggers': [], 'ppas': []}
    ),
    (
        # No Jobs returned if nothing is running for the specified PPA
        (
            '{ "ubuntu": { "focal": { "amd64": ['
            ' "a\\n{\\"requester\\":   \\"you\\",'
            '      \\"submit-time\\": \\"2022-08-19 07:37:56\\",'
            '      \\"triggers\\":    [ \\"a/1.2-3\\", \\"b/1-1\\" ] }",'
            ' "b\\n{\\"requester\\":   \\"you\\",'
            '      \\"submit-time\\": \\"2022-08-19 07:37:57\\",'
            '      \\"ppas\\":        [ \\"ppa:x/x\\" ],'
            '      \\"triggers\\":    [ \\"c/3.2-1\\", \\"d/2-2\\" ] }"'
            '] } } }'
        ),
        {'releases': None, 'ppa': 'ppa:me/myppa', 'sources': None},
        {'repr': '', 'source_package': None, 'triggers': [], 'ppas': []}
    ),
    (
        # Correct Job should be returned for matching criteria
        (
            '{ "ubuntu": { "focal": { "amd64": ['
            ' "a\\n{\\"requester\\":   \\"you\\",'
            '      \\"submit-time\\": \\"2022-08-19 07:37:56\\",'
            '      \\"triggers\\":    [ \\"a/1.2-3\\", \\"b/1-1\\" ] }",'
            ' "b\\n{\\"requester\\":   \\"you\\",'
            '      \\"submit-time\\": \\"2022-08-19 07:37:57\\",'
            '      \\"ppas\\":        [ \\"ppa:me/myppa\\" ],'
            '      \\"triggers\\":    [ \\"c/3.2-1\\", \\"d/2-2\\" ] }"'
            '] } } }'
        ),
        {'releases': ['focal'], 'ppa': 'ppa:me/myppa', 'sources': None},
        {
            'repr': "Job(source_package='b', series='focal', arch='amd64')",
            'source_package': 'b',
            'triggers': ['c/3.2-1', 'd/2-2'],
            'ppas': ['ppa:me/myppa']
        }
    ),
])
def test_get_waiting(json_text, params, expected):
    """Checks result of the get_waiting() command."""
    # TODO: I think ppas need to be in "ppa" instead of under "ubuntu" but need to doublecheck.
    fake_response = RequestResponseMock(json_text)
    try:
        job = next(get_waiting(fake_response, **params))
        assert job

        assert repr(job) == expected['repr']
        assert job.source_package == expected['source_package']
        assert job.triggers == expected['triggers']
        assert job.ppas == expected['ppas']
    except StopIteration:
        assert expected['repr'] == ''
        assert expected['triggers'] == []
        assert expected['ppas'] == []