aboutsummaryrefslogtreecommitdiff
path: root/potpourri/validation-status-sql.py
blob: 646d7d9b2e200c5439981fb399bb7c2ed78cec8f (plain) (blame)
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
#!/usr/bin/env python

# $Id$
#
# Copyright (C) 2013-2014 Dragon Research Labs ("DRL")
# Portions copyright (C) 2011-2012  Internet Systems Consortium ("ISC")
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notices and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND DRL AND ISC DISCLAIM ALL
# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL DRL OR
# ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
# DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
# OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.

"""
Parse rcynic XML output, stuff the data that validation_status script
would print into an SQL database for subsequent analysis.
"""

import os
import sys
import time
import mailbox
import sqlite3
import argparse
import lxml.etree
import subprocess

class Parser(object):

    @staticmethod
    def main():
        parser = argparse.ArgumentParser(
            description     = __doc__,
            formatter_class = argparse.ArgumentDefaultsHelpFormatter)
        group = parser.add_mutually_exclusive_group(required = True)
        group.add_argument("--mailbox", "--mb",
                           help = "Maildir mailbox containing rcynic XML output")
        group.add_argument("--tarballs",
                           help = "directory tree of tar files containing containing rcynic XML output")
        parser.add_argument("--database", "--db",
                            default = "validation-status-sql.db",
                            help = "SQLite3 database")
        parser.add_argument("--path-within-tarball",
                            default = "var/rcynic/data/rcynic.xml",
                            help = "rcynic.xml path name within tarball(s)")
        parser.add_argument("--tar-extensions", nargs = "+",
                            default = ".tar .tar.gz .tgz .tar.bz2 .tbz .tar.xz .txz".split(),
                            help = "extensions to recognize as indicating tar files")
        args = parser.parse_args()
        if args.mailbox:
            ParserMailbox(args)
        else:
            ParserTarball(args)

    def __init__(self, args):
        self.args = args
        self.init_sql()
        self.init_hook()
        self.index1()
        self.parsed = 1
        for self.current, self.iterval in enumerate(self.iterator, 1):
            self.parse_xml()
        if self.parsed > 1:
            sys.stderr.write("\n")
        self.index2()
        self.db.close()


    def init_sql(self):
        creating = not os.path.exists(self.args.database)
        self.db = sqlite3.connect(self.args.database)
        self.db.text_factory = str
        self.db.executescript('''
          PRAGMA foreign_keys  = off;
          PRAGMA synchronous   = off;
          PRAGMA count_changes = off;
          ''')

        if creating:
            self.db.executescript('''
                CREATE TABLE sessions (
                      session_id      INTEGER PRIMARY KEY NOT NULL,
                      session         DATETIME NOT NULL,
                      handle          TEXT NOT NULL
                );

                CREATE TABLE uris (
                      uri_id          INTEGER PRIMARY KEY NOT NULL,
                      uri             TEXT NOT NULL
                );

                CREATE TABLE codes (
                      code_id         INTEGER PRIMARY KEY NOT NULL,
                      code            TEXT NOT NULL
                );

                CREATE TABLE generations (
                      generation_id   INTEGER PRIMARY KEY NOT NULL,
                      generation      TEXT NOT NULL
                );

                CREATE TABLE events (
                      id              INTEGER PRIMARY KEY NOT NULL,
                      timestamp       DATETIME NOT NULL,
                      session_id      INTEGER NOT NULL REFERENCES sessions    (session_id)      ON DELETE RESTRICT ON UPDATE RESTRICT,
                      generation_id   INTEGER NOT NULL REFERENCES generations (generation_id)   ON DELETE RESTRICT ON UPDATE RESTRICT,
                      code_id         INTEGER NOT NULL REFERENCES codes       (code_id)         ON DELETE RESTRICT ON UPDATE RESTRICT,
                      uri_id          INTEGER NOT NULL REFERENCES uris        (uri_id)          ON DELETE RESTRICT ON UPDATE RESTRICT
                );

                CREATE VIEW status AS
                     SELECT id, handle, session, timestamp, generation, code, uri
                     FROM               events
                     NATURAL JOIN       sessions
                     NATURAL JOIN       uris
                     NATURAL JOIN       codes
                     NATURAL JOIN       generations;
                ''')


    def index1(self):
        self.db.executescript('''
          CREATE UNIQUE INDEX IF NOT EXISTS sessions_index         ON sessions     (session);
          CREATE UNIQUE INDEX IF NOT EXISTS handles_index          ON sessions     (handle);
          CREATE UNIQUE INDEX IF NOT EXISTS uris_index             ON uris         (uri);
          CREATE UNIQUE INDEX IF NOT EXISTS codes_index            ON codes        (code);
          CREATE UNIQUE INDEX IF NOT EXISTS generations_index      ON generations  (generation);
          ''')


    def index2(self):
        self.db.executescript('''
          CREATE UNIQUE INDEX IF NOT EXISTS events_index           ON events       (uri_id, timestamp, code_id, generation_id);
          ''')


    def string_id(self, table, value):
        field = table.rstrip("s")
        try:
            return self.db.execute("SELECT %s_id FROM %s WHERE %s = ?" % (field, table, field), (value,)).fetchone()[0]
        except:
            return self.db.execute("INSERT INTO %s (%s) VALUES (?)" % (table, field), (value,)).lastrowid


    def parse_xml(self):
        sys.stderr.write("\r%s %d/%d/%d...%s   " % ("|\\-/"[self.current & 3],
                                                    self.current, self.parsed, self.total, self.handle))
        if self.db.execute("SELECT handle FROM sessions WHERE handle = ?", (self.handle,)).fetchone():
            return
        xml = self.read_xml()
        with self.db:
            session_id = self.db.execute("INSERT INTO sessions (session, handle) VALUES (strftime('%s', ?), ?)",
                                         (xml.get("date"), self.handle)).lastrowid
            self.db.executemany("INSERT INTO events (session_id, timestamp, generation_id, code_id, uri_id) "
                                "VALUES (?, strftime('%s', ?), ?, ?, ?)",
                                ((session_id,
                                  x.get("timestamp"),
                                  self.string_id("generations", x.get("generation", "none")),
                                  self.string_id("codes",       x.get("status")),
                                  self.string_id("uris",        x.text.strip()))
                                 for x in xml.findall("validation_status")))
        self.parsed += 1


class ParserTarball(Parser):

    def init_hook(self):
        self.total = 0
        for fn in self.iter_tarball_names():
            self.total += 1
        self.iterator = self.iter_tarball_names()

    @property
    def handle(self):
        return self.iterval

    def read_xml(self):
        return lxml.etree.ElementTree(
            file = subprocess.Popen(("tar", "Oxf", self.iterval, self.args.path_within_tarball),
                                    stdout = subprocess.PIPE).stdout).getroot()

    def iter_tarball_names(self):
        if os.path.isdir(self.args.tarballs):
            for root, dirs, files in os.walk(self.args.tarballs):
                for fn in files:
                    if any(fn.endswith(ext) for ext in self.args.tar_extensions):
                        yield os.path.join(root, fn)
        else:
            yield self.args.tarballs


class ParserMailbox(Parser):

    def init_hook(self):
        self.mb = mailbox.Maildir(self.args.mailbox, factory = None, create = False)
        self.total = len(self.mb)
        self.iterator = self.mb.iterkeys()

    @property
    def handle(self):
        return self.mb[self.iterval].get("Message-ID")

    def read_xml(self):
        return lxml.etree.XML(self.mb[self.iterval].get_payload())


if __name__ == "__main__":
    try:
        Parser.main()
    except KeyboardInterrupt:
        pass