aboutsummaryrefslogtreecommitdiff
path: root/debdate
blob: f92d371ead00eee755655ee51a0d29986ce46049 (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
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
#!/usr/bin/env python3

# Copyright (C) 2017 Elena Grandi <valhalla@trueelena.org>
# This program is free software. It comes without any warranty, to the
# extent permitted by applicable law. You can redistribute it and/or
# modify it under the terms of the Do What The Fuck You Want To Public
# License, Version 2, as published by Sam Hocevar. See
# http://www.wtfpl.net/ for more details.

# Debian release dates can be found in the package distro-info-data,
# but an hardcoded fallback is included to run this script where such
# package is not available.

import argparse
import csv
import datetime
from dateutil import relativedelta, parser
import math
import unittest

RELEASES = [
    (datetime.date(2019, 7, 6), 'buster'),
    (datetime.date(2017, 6, 17), 'stretch'),
    (datetime.date(2015, 4, 25), 'jessie'),
    (datetime.date(2013, 5, 4), 'wheezy'),
    (datetime.date(2011, 2, 6), 'squeeze'),
    (datetime.date(2009, 2, 14), 'lenny'),
    (datetime.date(2007, 4, 8), 'etch'),
    (datetime.date(2005, 6, 6), 'sarge'),
    (datetime.date(2002, 7, 19), 'woody'),
    (datetime.date(2000, 8, 15), 'potato'),
    (datetime.date(1999, 3, 9), 'slink'),
    (datetime.date(1998, 6, 24), 'hamm'),
    (datetime.date(1997, 7, 2), 'bo'),
    (datetime.date(1996, 12, 12), 'rex'),
    (datetime.date(1996, 6, 17), 'buzz'),
    ]
MSG = "{today} is day {dody} of year {yodr} of the {release}"
FUTURE_MSG = "{today} could be day {dody} of year {yodr} of the {release}"
ERR_MSG = "{isodate} is in the Debianless Age"


class DebDate:
    def __init__(
            self,
            distro_info_file='/usr/share/distro-info/debian.csv',
            nameless_age=datetime.date(1993, 8, 1)):
        self.releases = []
        try:
            with open(distro_info_file) as fp:
                releases = csv.reader(fp, delimiter=',')
                for row in releases:
                    if len(row) > 4:
                        try:
                            date = datetime.datetime.strptime(
                                row[4],
                                '%Y-%m-%d'
                                )
                        except ValueError:
                            pass
                        else:
                            self.releases.append((date.date(), row[1]))
        except FileNotFoundError:
            releases = []
        self.releases.sort(key=lambda x: x[0], reverse=True)
        if not self.releases:
            self.releases = RELEASES.copy()
        if nameless_age:
            self.releases.append((
                nameless_age,
                'Nameless Age'
                ))

    def get_release(self, day):
        data = {}
        today = datetime.date.today()
        if day > today:
            # This is just a fuzzy way to decide whether a date is
            # likely to be after a future release.
            data['certain'] = math.exp((today - day).days / 365.25 )
        else:
            data['certain'] = 1
        if day == today:
            data['today'] = 'Today'
        else:
            data['today'] = day.isoformat()
        for r in self.releases:
            epoch = r[0]
            data['release'] = r[1]
            if day > epoch:
                break
        if day < epoch:
            raise OutsideTimeError(
                "{day} happened before the beginning of time".format(
                    day=day,
                    )
                )
        if day.year == epoch.year:
            data['dody'] = (day - epoch).days
            data['yodr'] = 1
        else:
            data['dody'] = day.timetuple().tm_yday
            data['yodr'] = day.year - epoch.year + 1
        return data


class OutsideTimeError(ValueError):
    """
    Exception raised before the beginning of time
    """


class TestDebDate(unittest.TestCase):
    def setUp(self):
        self.debdates = [
            DebDate(),
            DebDate(distro_info_file='/no/such/file'),
            ]

    def testFirstYearRelease(self):
        for debdate in self.debdates:
            r = debdate.releases[-2]
            d = r[0] + relativedelta.relativedelta(days=10)
            data = debdate.get_release(d)
            self.assertEqual(data['dody'], 10)
            self.assertEqual(data['yodr'], 1)
            self.assertEqual(data['release'], r[1])
            self.assertEqual(data['certain'], 1)

    def testSecondYearRelease(self):
        for debdate in self.debdates:
            r = debdate.releases[-7]
            d = r[0] + relativedelta.relativedelta(years=1)
            data = debdate.get_release(d)
            self.assertEqual(data['dody'], 227)
            self.assertEqual(data['yodr'], 2)
            self.assertEqual(data['release'], r[1])
            self.assertEqual(data['certain'], 1)

    def testJanuarySecondYearRelease(self):
        for debdate in self.debdates:
            r = debdate.releases[-7]
            d = datetime.date(r[0].year + 1, 1, 1)
            data = debdate.get_release(d)
            self.assertEqual(data['dody'], 1)
            self.assertEqual(data['yodr'], 2)
            self.assertEqual(data['release'], r[1])
            self.assertEqual(data['certain'], 1)

    def testPastLatestRelease(self):
        for debdate in self.debdates:
            r = debdate.releases[0]
            d = r[0] + relativedelta.relativedelta(years=5)
            data = debdate.get_release(d)
            # Day Of The Year will change depending on when is the latest
            # release, so we do not check it
            self.assertEqual(data['yodr'], 6)
            self.assertEqual(data['release'], r[1])
            self.assertLess(data['certain'], 1)

    def testBeforeBeginningOfTime(self):
        for debdate in self.debdates:
            r = debdate.releases[-1]
            d = r[0] + relativedelta.relativedelta(days=-1)
            with self.assertRaises(OutsideTimeError):
                debdate.get_release(d)


class Command:
    def setup_parser(self):
        self.parser = argparse.ArgumentParser(
            description='''
            Convert Gregorian dates to Debian Regnal dates
            '''
            )
        self.date_options = self.parser.add_mutually_exclusive_group()
        self.date_options.add_argument(
            '-d', '--date',
            help='A gregorian date',
            default=None,
            type=parser.parse,
            )
        self.date_options.add_argument(
            '-s', '--seconds',
            help='A date as seconds from the Unix Epoch',
            default=None,
            type=int,
            )
        self.parser.set_defaults(func=self.print_date)
        self.subparsers = self.parser.add_subparsers()
        self.test_parser = self.subparsers.add_parser(
            'test',
            help='Run unit tests',
            )
        self.test_parser.set_defaults(func=self.run_tests)

    def run_tests(self, args):
        suite = unittest.TestLoader().loadTestsFromTestCase(TestDebDate)
        unittest.TextTestRunner(verbosity=1).run(suite)

    def print_date(self, args):
        if args.date:
            date = args.date.date()
        elif args.seconds:
            date = datetime.date.fromtimestamp(args.seconds)
        else:
            date = datetime.date.today()
        debdate = DebDate()
        try:
            data = debdate.get_release(date)
        except OutsideTimeError:
            print(ERR_MSG.format(isodate=date.strftime("%Y-%m-%d")))
        else:
            if data['certain'] > 0.14:
                print(MSG.format(**data))
            else:
                print(FUTURE_MSG.format(**data))


    def main(self):
        self.setup_parser()
        args = self.parser.parse_args()
        args.func(args)


if __name__ == '__main__':
    Command().main()