summaryrefslogtreecommitdiff
path: root/bin/gen_calendar_entries_test.py
blob: 70536ba0f0d9c6fb6256390c6f3f53639ccc5aa5 (plain)
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
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT

# Copyright © 2021 Intel Corporation

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

from __future__ import annotations
from unittest import mock
import argparse
import csv
import contextlib
import tempfile
import os
import pathlib
import typing

import pytest

from . import gen_calendar_entries


@contextlib.contextmanager
def mock_csv(data: typing.List[gen_calendar_entries.CalendarRowType]) -> typing.Iterator[None]:
    """Replace the actual CSV data with our test data."""
    with tempfile.TemporaryDirectory() as d:
        c = os.path.join(d, 'calendar.csv')
        with open(c, 'w') as f:
            writer = csv.writer(f)
            writer.writerows(data)

        with mock.patch('bin.gen_calendar_entries.CALENDAR_CSV', pathlib.Path(c)):
            yield


@pytest.fixture(autouse=True, scope='module')
def disable_git_commits() -> None:
    """Mock out the commit function so no git commits are made durring testing."""
    with mock.patch('bin.gen_calendar_entries.commit', mock.Mock()):
        yield


class TestReleaseStart:

    def test_first_is_wednesday(self) -> None:
        d = gen_calendar_entries._calculate_release_start('20', '0')
        assert d.day == 15
        assert d.month == 1
        assert d.year == 2020

    def test_first_is_before_wednesday(self) -> None:
        d = gen_calendar_entries._calculate_release_start('19', '0')
        assert d.day == 16
        assert d.month == 1
        assert d.year == 2019

    def test_first_is_after_wednesday(self) -> None:
        d = gen_calendar_entries._calculate_release_start('21', '0')
        assert d.day == 13
        assert d.month == 1
        assert d.year == 2021


class TestRC:

    ORIGINAL_DATA = [
        ('20.3', '2021-01-13', '20.3.3', 'Dylan Baker', ''),
        ('',     '2021-01-27', '20.3.4', 'Dylan Baker', 'Last planned release of the 20.3.x series'),
    ]

    @pytest.fixture(autouse=True, scope='class')
    def mock_version(self) -> None:
        """Keep the version set at a specific value."""
        with tempfile.TemporaryDirectory() as d:
            v = os.path.join(d, 'version')
            with open(v, 'w') as f:
                f.write('21.0.0-devel\n')

            with mock.patch('bin.gen_calendar_entries.VERSION', pathlib.Path(v)):
                yield

    @pytest.fixture(autouse=True)
    def csv(self) -> None:
        """inject our test data.."""
        with mock_csv(self.ORIGINAL_DATA):
            yield

    def test_basic(self) -> None:
        args: gen_calendar_entries.RCArguments = argparse.Namespace()
        args.manager = "Dylan Baker"
        gen_calendar_entries.release_candidate(args)

        expected = self.ORIGINAL_DATA.copy()
        expected.append(('21.0', '2021-01-13', f'21.0.0-rc1', 'Dylan Baker'))
        expected.append((    '', '2021-01-20', f'21.0.0-rc2', 'Dylan Baker'))
        expected.append((    '', '2021-01-27', f'21.0.0-rc3', 'Dylan Baker'))
        expected.append((    '', '2021-02-03', f'21.0.0-rc4', 'Dylan Baker', 'Or 21.0.0 final.'))

        actual = gen_calendar_entries.read_calendar()

        assert actual == expected


class TestExtend:

    def test_one_release(self) -> None:
        data = [
            ('20.3', '2021-01-13', '20.3.3', 'Dylan Baker', ''),
            ('',     '2021-01-27', '20.3.4', 'Dylan Baker', 'This is the last planned release of the 20.3.x series.'),
        ]

        args: gen_calendar_entries.ExtendArguments = argparse.Namespace()
        args.series = '20.3'
        args.count = 2

        with mock_csv(data):
            gen_calendar_entries.extend(args)
            actual = gen_calendar_entries.read_calendar()

        expected = [
            data[0],
            ('', '2021-01-27', '20.3.4', 'Dylan Baker', ''),
            ('', '2021-02-10', '20.3.5', 'Dylan Baker', ''),
            ('', '2021-02-24', '20.3.6', 'Dylan Baker', 'This is the last planned release of the 20.3.x series.'),
        ]

        assert actual == expected
    def test_one_release(self) -> None:
        data = [
            ('20.3', '2021-01-13', '20.3.3', 'Dylan Baker', ''),
            ('',     '2021-01-27', '20.3.4', 'Dylan Baker', 'This is the last planned release of the 20.3.x series.'),
            ('21.0', '2021-01-13', '21.0.1', 'Dylan Baker', ''),
            ('',     '2021-01-27', '21.0.2', 'Dylan Baker', ''),
            ('',     '2021-02-10', '21.0.3', 'Dylan Baker', ''),
            ('',     '2021-02-24', '21.0.4', 'Dylan Baker', 'This is the last planned release of the 21.0.x series.'),
        ]

        args: gen_calendar_entries.ExtendArguments = argparse.Namespace()
        args.series = '21.0'
        args.count = 1

        with mock_csv(data):
            gen_calendar_entries.extend(args)
            actual = gen_calendar_entries.read_calendar()

        expected = data.copy()
        d = list(data[-1])
        d[-1] = ''
        expected[-1] = tuple(d)
        expected.extend([
            ('',     '2021-03-10', '21.0.5', 'Dylan Baker', 'This is the last planned release of the 21.0.x series.'),
        ])

        assert actual == expected

    def test_rc(self) -> None:
        data = [
            ('20.3', '2021-01-13', '20.3.3', 'Dylan Baker', ''),
            ('',     '2021-01-27', '20.3.4', 'Dylan Baker', 'This is the last planned release of the 20.3.x series.'),
            ('21.0', '2021-01-13', '21.0.0-rc1', 'Dylan Baker', ''),
            ('',     '2021-01-20', '21.0.0-rc2', 'Dylan Baker', gen_calendar_entries.OR_FINAL.format('21.0')),
        ]

        args: gen_calendar_entries.ExtendArguments = argparse.Namespace()
        args.series = '21.0'
        args.count = 2

        with mock_csv(data):
            gen_calendar_entries.extend(args)
            actual = gen_calendar_entries.read_calendar()

        expected = data.copy()
        d = list(expected[-1])
        d[-1] = ''
        expected[-1] = tuple(d)
        expected.extend([
            ('', '2021-01-27', '21.0.0-rc3', 'Dylan Baker', ''),
            ('', '2021-02-03', '21.0.0-rc4', 'Dylan Baker', gen_calendar_entries.OR_FINAL.format('21.0')),
        ])

        assert actual == expected