summaryrefslogtreecommitdiffstats
path: root/bin/reproducible_html_packages.py
blob: 31080862509db2c11d1c39c3bc24d70fa4f0062d (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
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
#!/usr/bin/python3
# -*- coding: utf-8 -*-
#
# Copyright © 2015 Mattia Rizzolo <mattia@mapreri.org>
# Based on reproducible_html_packages.sh © 2014 Holger Levsen <holger@layer-acht.org>
# Licensed under GPL-2
#
# Depends: python3
#
# Build rb-pkg pages (the pages that describe the package status)

from reproducible_common import *

html_package_page = Template((tab*2).join(("""
<table class="head">
    <tr>
        <td>
            <span class="avoidwrap">
                <span style="font-size:1.2em;">$package</span> $suite: $version
$status
                <span style="font-size:0.9em;">$build_time:</span>
            </span>
            <span class="avoidwrap">
$links
                <a href="https://tracker.debian.org/$package" target="main">PTS</a>
                <a href="https://bugs.debian.org/src:$package" target="main">BTS</a>
                <a href="https://sources.debian.net/src/$package/$version/" target="main">sources</a>
                <a href="https://sources.debian.net/src/$package/$version/debian/" target="main">debian</a>/<!--
                -->{<a href="https://sources.debian.net/src/$package/$version/debian/changelog" target="main">changelog</a>,<!--
                --><a href="https://sources.debian.net/src/$package/$version/debian/control" target="main">control</a>,<!--
                --><a href="https://sources.debian.net/src/$package/$version/debian/rules" target="main">rules</a>}
            </span>
        </td>
        <td>
${suites_links}
        </td>
        <td style="text-align:right; font-size:0.9em;">
            <a href="/index_notify.html" target="_parent">
                <span class="red" style="font-size:1.5em;" title="Notifications for this packages are enabled. Every status change reproducibly-wise will be emailed to the maintainer">$notify_maintainer</span>
            </a>
            <a href="%s" target="_parent">
                reproducible builds
            </a>
        </td>
    </tr>
</table>
<iframe id="main" name="main" src="${default_view}">
    <p>
        Your browser does not support iframes.
        Use a different one or follow the links above.
    </p>
</iframe>""" % REPRODUCIBLE_URL ).splitlines(True)))


def sizeof_fmt(num):
    for unit in ['B','KB','MB','GB']:
        if abs(num) < 1024.0:
            if unit == 'GB':
                log.error('The size of this file is bigger than 1 GB!')
                log.error('Please check')
            return str(int(round(float("%3f" % num), 0))) + "%s" % (unit)
        num /= 1024.0
    return str(int(round(float("%f" % num), 0))) + "%s" % ('Yi')

def check_package_status(package, suite, nocheck=False):
    """
    This returns a tuple containing status, version and build_date of the last
    version of the package built by jenkins CI
    """
    try:
        query = ('SELECT r.status, r.version, r.build_date, s.notify_maintainer ' +
                 'FROM results AS r JOIN sources AS s ON r.package_id=s.id ' +
                 'WHERE s.name="{pkg}" ' +
                 'AND s.suite="{suite}"').format(pkg=package, suite=suite)
        result = query_db(query)[0]
    except IndexError:
        query = 'SELECT version, notify_maintainer ' + \
                'FROM sources WHERE name="{pkg}" AND suite="{suite}"'
        query = query.format(pkg=package, suite=suite)
        try:
            result = query_db(query)[0]
            if result:
                result = ('untested', str(result[0]), False, result[1])
        except IndexError:
            if nocheck:
                return False
            print_critical_message('This query produces no results: ' + query +
                    '\nThis means there is no available package with the name '
                    + package + '.')
            raise
    status = str(result[0])
    version = str(result[1])
    notify_maint = '⚑' if int(result[3]) == 1 else ''
    if result[2]:
        build_date = 'at ' + str(result[2]) + ' UTC'
    else:
        build_date = '<span style="color:red;font-weight:bold;">UNTESTED</span>'
    return (status, version, build_date, notify_maint)


def gen_status_link_icon(status, icon, suite, arch):
    html = ''
    if status != 'untested':
        html += tab*6 + '<a href="/{suite}/{arch}/index_{status}.html"' + \
                ' target="_parent" title="{status}">\n'
    html += tab*9 + '<img src="/static/{icon}" alt="{status}" />\n'
    if status != 'untested':
        html += tab*8 + '</a>\n'
    return html.format(status=status, icon=icon, suite=suite, arch=arch)


def link_buildlogs(package, eversion, suite, arch):
    html = ''
    log = suite + '/' + arch + '/' + package + '_' + eversion + '.build2.log.gz'
    diff = suite + '/' + arch + '/' + package + '_' + eversion + '.diff.gz'
    if os.access(LOGS_PATH+'/'+log, os.R_OK):
        uri = LOGS_URI + '/' + log
        size = sizeof_fmt(os.stat(LOGS_PATH+'/'+log).st_size)
        html += '<a href="' + uri + '" target="main">build2 (' + size + ')</a>\n'
    if os.access(DIFFS_PATH+'/'+diff, os.R_OK):
        uri = DIFFS_URI + '/' + diff
        html += '<a href="' + uri + '" target="main">diff</a>\n'
    return html


def gen_extra_links(package, version, suite, arch, status):
    eversion = strip_epoch(version)
    notes = NOTES_PATH + '/' + package + '_note.html'
    buildinfo = BUILDINFO_PATH + '/' + suite + '/' + arch + '/' + package + \
                '_' + eversion + '_amd64.buildinfo'
    dbd = DBD_PATH + '/' + suite + '/' + arch + '/' + package + '_' + \
          eversion + '.debbindiff.html'
    dbdtxt = DBDTXT_PATH + '/' + suite + '/' + arch + '/' + package + '_' + \
          eversion + '.debbindiff.txt.gz'

    links = ''
    default_view = ''
    if os.access(notes, os.R_OK):
        url = NOTES_URI + '/' + package + '_note.html'
        links += '<a href="' + url + '" target="main">notes</a>\n'
        default_view = url
    else:
        log.debug('notes not detected at ' + notes)
    if os.access(dbd, os.R_OK):
        url = DBD_URI + '/' + suite + '/' + arch + '/' +  package + '_' + \
              eversion + '.debbindiff.html'
        links += '<a href="' + url + '" target="main">debbindiff</a>\n'
        if not default_view:
            default_view = url
    else:
        log.debug('debbindiff not detetected at ' + dbd)
        if status == 'unreproducible' and not args.ignore_missing_files:
            log.critical(REPRODUCIBLE_URL + '/' + suite + '/' + arch + '/' + package +
                         ' is unreproducible, but without debbindiff output.')
    if os.access(dbdtxt, os.R_OK):
        url = DBDTXT_URI + '/' + suite + '/' + arch + '/' +  package + '_' + \
              eversion + '.debbindiff.txt'
        links += '<a href="' + url + '" target="main">(txt)</a>\n'
        if not default_view:
            default_view = url
    if pkg_has_buildinfo(package, version, suite):
        url = BUILDINFO_URI + '/' + suite + '/' + arch + '/' + package + \
              '_' + eversion + '_amd64.buildinfo'
        links += '<a href="' + url + '" target="main">buildinfo</a>\n'
        if not default_view:
            default_view = url
    elif not args.ignore_missing_files and status not in \
        ('untested', 'blacklisted', 'FTBFS', 'not for us', 'depwait', '404'):
            log.critical('buildinfo not detected at ' + buildinfo)
    rbuild = pkg_has_rbuild(package, version, suite, arch)
    if rbuild:  # being a tuple (rbuild path, size), empty if non existant
        url = RBUILD_URI + '/' + suite + '/' + arch + '/' + package + '_' + \
              eversion + '.rbuild.log'  # apache ignores the trailing .gz
        links +='<a href="' + url + '" target="main">rbuild (' + \
                sizeof_fmt(rbuild[1]) + ')</a>\n'
        if not default_view:
            default_view = url
    elif status not in ('untested', 'blacklisted') and not args.ignore_missing_files:
        log.critical(REPRODUCIBLE_URL  + '/' + suite + '/' + arch + '/' + package +
                     ' didn\'t produce a buildlog, even though it has been built.')
    links += link_buildlogs(package, eversion, suite, arch)
    default_view = '/untested.html' if not default_view else default_view
    return (links, default_view)


def gen_suites_links(package, suite):
    html = ''
    query = 'SELECT s.suite, s.architecture, s.version, r.version, r.status ' + \
            'FROM sources AS s LEFT JOIN results AS r ON r.package_id=s.id ' + \
            'WHERE s.name="{pkg}"'.format(pkg=package)
    results = query_db(query)
    if len(results) < 1:
        print_critical_message('This query produces 0 results:\n' + query)
        raise ValueError
    if len(results) == 1:
        return html
    for i in results:
        # i[0]: suite, i[1]: arch, i[2]: avail version, i[3]: tested version,
        # i[4]: status (i[2] and i[3] will be NULL if untested)
        if i[0] == suite:  # don't link the current suite
            continue
        status = 'untested' if not i[4] else i[4]
        version = i[3] if i[3] else i[2]
        if status == 'unreproducible':
            status = 'FTBR'
        elif status == 'not for us':
            status = 'not_for_us'
        html += '<span class="avoidwrap">\n' + tab
        if status != 'untested':
            prefix = ' <a href="/' + i[0] + '/' + i[1] + '/index_' + status + '.html">'
            suffix = '</a>\n'
        else:
            prefix = ' '
            suffix = '\n'
        icon = prefix + '<img src="/static/{icon}" alt="{status}" title="{status}"/>' + suffix
        html += icon.format(icon=join_status_icon(status)[1], status=status)
        html += tab + ' <a href="' + RB_PKG_URI + '/' + i[0] + '/' + i[1] + \
                '/' + str(package) + '.html" target="_parent">' + i[0] + \
                ':' + version + '</a>\n'
        html += '</span>\n'
    return tab*5 + (tab*7).join(html.splitlines(True))


def gen_packages_html(packages, suite=None, arch=None, no_clean=False, nocheck=False):
    """
    generate the /rb-pkg/package.html page
    packages should be a list
    If suite and/or arch is not passed, then build that packages for all suites
    nocheck is for internal use
    """
    total = len(packages)
    log.debug('Generating the pages of ' + str(total) + ' package(s)')
    if not nocheck and (not suite or not arch):
        nocheck = True
    if nocheck and (not suite or not arch):
        for lsuite in SUITES:
            for larch in ARCHS:
                gen_packages_html(packages, lsuite, larch, True, True)
        if not no_clean:
            purge_old_pages()
        return
    for pkg in sorted(packages):
        pkg = str(pkg)
        try:
            pkgstatus = check_package_status(pkg, suite, nocheck)
            status, version, build_date, notify_maint = pkgstatus
        except TypeError:  # the package is not in the checked suite
            continue
        log.debug('Generating the page of ' + pkg + '/' + suite + '@' + version +
                 ' built at ' + build_date)

        links, default_view = gen_extra_links(pkg, version, suite, arch, status)
        suites_links = gen_suites_links(pkg, suite)
        status, icon = join_status_icon(status, pkg, version)
        status = gen_status_link_icon(status, icon, suite, arch)

        html = html_package_page.substitute(package=pkg,
                                            suite=suite,
                                            status=status,
                                            version=version,
                                            build_time=build_date,
                                            links=links,
                                            notify_maintainer=notify_maint,
                                            suites_links=suites_links,
                                            default_view=default_view)
        destfile = RB_PKG_PATH + '/' + suite + '/' + arch + '/' + pkg + '.html'
        desturl = REPRODUCIBLE_URL + RB_PKG_URI + '/' + suite + '/' + \
                  arch + '/' + pkg + '.html'
        title = pkg + ' - reproducible build results'
        write_html_page(title=title, body=html, destfile=destfile, suite=suite,
                        noheader=True, noendpage=True)
        log.debug("Package page generated at " + desturl)
    if not no_clean:
        purge_old_pages() # housekeep is always good

def gen_all_rb_pkg_pages(suite='unstable', arch='amd64', no_clean=False):
    query = 'SELECT name FROM sources WHERE suite="%s" AND architecture="%s"' % (suite, arch)
    rows = query_db(query)
    pkgs = [str(i[0]) for i in rows]
    log.info('Processing all ' + str(len(pkgs)) + ' package pages for ' + suite + '/' + arch +'.')
    gen_packages_html(pkgs, suite=suite, arch=arch, no_clean=no_clean)

def purge_old_pages():
    for suite in SUITES:
        for arch in ARCHS:
            log.info('Removing old pages from ' + suite + '/' + arch + '.')
            try:
                presents = sorted(os.listdir(RB_PKG_PATH + '/' + suite + '/' +
                                  arch))
            except OSError as e:
                if e.errno != errno.ENOENT:  # that's 'No such file or
                    raise                    # directory' error (errno 17)
                presents = []
            log.debug('page presents: ' + str(presents))
            for page in presents:
                pkg = page.rsplit('.', 1)[0]
                query = 'SELECT s.name ' + \
                    'FROM sources AS s ' + \
                    'WHERE s.name="{name}" ' + \
                    'AND s.suite="{suite}" AND s.architecture="{arch}"'
                query = query.format(name=pkg, suite=suite, arch=arch)
                result = query_db(query)
                if not result: # actually, the query produces no results
                    log.info('There is no package named ' + pkg + ' from ' +
                             suite + '/' + arch + ' in the database. ' +
                             'Removing old page.')
                    os.remove(RB_PKG_PATH + '/' + suite + '/' + arch + '/' +
                              page)