logger.py 14 KB
Newer Older
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# Copyright 2013 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.

"""
This is the logging class for burnin

It supports logging both for the stdout/stderr as well as file logging at the
same time.

The stdout/stderr logger supports verbose levels and colors but the file
logging doesn't (we use the info verbose level for our file logger).

Our loggers have primitive support for handling parallel execution (even though
burnin doesn't support it yet). To do so the stdout/stderr logger prepends the
name of the test under execution to every line it prints. On the other hand the
file logger waits to lock the file, then reads it, prints the message to the
corresponding line and closes the file.


"""

import os
import sys
import os.path
import datetime

import filelocker


# --------------------------------------------------------------------
# Constant variables
LOCK_EXT = ".lock"
SECTION_SEPARATOR = \
    "-- -------------------------------------------------------------------"
SECTION_PREFIX = "-- "
SECTION_RUNNED = "Tests Runned"
SECTION_RESULTS = "Results"
SECTION_NEW = "__ADD_NEW_SECTION__"
SECTION_PASSED = "  * Passed:"
SECTION_FAILED = "  * Failed:"


# --------------------------------------------------------------------
# Helper functions
def _blue(msg):
    """Blue color"""
    return "\x1b[1;34m" + str(msg) + "\x1b[0m"


def _yellow(msg):
    """Yellow color"""
    return "\x1b[33m" + str(msg) + "\x1b[0m"


def _red(msg):
    """Yellow color"""
    return "\x1b[31m" + str(msg) + "\x1b[0m"


def _ts_start(msg):
    """New testsuite color"""
    return "\x1b[35m" + str(msg) + "\x1b[0m"


def _ts_success(msg):
    """Testsuite passed color"""
    return "\x1b[42m" + str(msg) + "\x1b[0m"


def _ts_failure(msg):
    """Testsuite failed color"""
    return "\x1b[41m" + str(msg) + "\x1b[0m"


def _format_message(msg, *args):
    """Format the message using the args"""
    return (msg % args) + "\n"


def _list_to_string(lst, append=""):
    """Convert a list of strings to string

    Append the value given in L{append} in front of all lines
    (except of the first line).

    """
    if isinstance(lst, list):
        return append.join(lst).rstrip('\n')
    else:
        return lst.rstrip('\n')


# --------------------------------------
def _locate_sections(contents):
    """Locate the sections inside the logging file"""
    i = 0
    res = []
    for cnt in contents:
        if SECTION_SEPARATOR in cnt:
            res.append(i+1)
        i += 1
    return res


def _locate_input(contents, section):
    """Locate position to insert text

    Given a section location the next possition to insert text inside that
    section.

    """
    sect_locs = _locate_sections(contents)
    if section == SECTION_NEW:
        # We want to add a new section
        # Just return the position of SECTION_RESULTS
        for obj in sect_locs:
            if SECTION_RESULTS in contents[obj]:
                return obj - 1
    else:
        # We will add our message in this location
        for (index, obj) in enumerate(sect_locs):
            if section in contents[obj]:
                return sect_locs[index+1] - 3

    # We didn't find our section??
    sys.stderr.write("Section %s could not be found in logging file\n"
                     % section)
    sys.exit(1)


def _add_testsuite_results(contents, section, testsuite):
    """Add the given testsuite to results

    Well we know that SECTION_FAILED is the last line and SECTION_PASSED is the
    line before, so we are going to cheat here and use this information.

    """
    if section == SECTION_PASSED:
        line = contents[-2]
        new_line = line.rstrip() + " " + testsuite + ",\n"
        contents[-2] = new_line
    elif section == SECTION_FAILED:
        line = contents[-1]
        new_line = line.rstrip() + " " + testsuite + ",\n"
        contents[-1] = new_line
    else:
        sys.stderr.write("Unknown section %s in _add_testsuite_results\n"
                         % section)
        sys.exit(1)
    return contents


def _write_log_file(file_location, section, message):
    """Write something to our log file

    For this we have to get the lock, read and parse the file add the new
    message and re-write the file.

    """
    # Get the lock
    file_lock = os.path.splitext(file_location)[0] + LOCK_EXT
    with filelocker.lock(file_lock, filelocker.LOCK_EX):
        with open(file_location, "r+") as log_file:
            contents = log_file.readlines()
            if section == SECTION_PASSED or section == SECTION_FAILED:
                # Add testsuite to results
                new_contents = \
                    _add_testsuite_results(contents, section, message)
            else:
                # Add message to its line
                input_loc = _locate_input(contents, section)
                new_contents = \
                    contents[:input_loc] + [message] + contents[input_loc:]
            log_file.seek(0)
            log_file.write("".join(new_contents))


# --------------------------------------------------------------------
# The Log class
class Log(object):
    """Burnin logger

    """
    # ----------------------------------
    def __init__(self, output_dir, verbose=1, use_colors=True,
                 in_parallel=False):
        """Initialize our loggers

        The file to be used by our file logger will be created inside
        the L{output_dir} with name the current timestamp.

        @type output_dir: string
        @param output_dir: the directory to save the output file
        @type verbose: int
        @param verbose: the verbose level to use for stdout/stderr logger
            0: verbose at minimum level (only which test we are running now)
            1: verbose at info level (information about our running test)
            2: verbose at debug level
        @type use_colors: boolean
        @param use_colors: use colors for out stdout/stderr logger
        @type in_parallel: boolean
        @param in_parallel: this signifies that burnin is running in parallel

        """
        self.verbose = verbose
        self.use_colors = use_colors
        self.in_parallel = in_parallel

        # Create file for logging
        output_dir = os.path.expanduser(output_dir)
        if not os.path.exists(output_dir):
            self.debug(None, "Creating directory %s", output_dir)
            os.makedirs(output_dir)
        timestamp = datetime.datetime.strftime(
            datetime.datetime.now(), "%Y%m%d%H%M%S (%a %b %d %Y %H:%M)")
        file_name = timestamp + ".log"
        self.file_location = os.path.join(output_dir, file_name)

        timestamp = datetime.datetime.strftime(
            datetime.datetime.now(), "%a %b %d %Y %H:%M")
        sys.stdout.write("Starting burnin (%s)\n" % timestamp)

        # Create the logging file
        self._create_logging_file(timestamp)

    def _create_logging_file(self, timestamp):
        """Create the logging file"""
        self.debug(None, "Using \"%s\" file for logging", self.file_location)
        with open(self.file_location, 'w') as out_file:
            out_file.write(SECTION_SEPARATOR + "\n")
            out_file.write("%s%s (%s):\n\n\n\n" %
                           (SECTION_PREFIX, SECTION_RUNNED, timestamp))
            out_file.write(SECTION_SEPARATOR + "\n")
            out_file.write("%s%s:\n\n" % (SECTION_PREFIX, SECTION_RESULTS))
            out_file.write(SECTION_PASSED + "\n" + SECTION_FAILED + "\n")

    def __del__(self):
        """Delete the Log object"""
        # Remove the lock file
        file_lock = os.path.splitext(self.file_location)[0] + LOCK_EXT
        try:
            os.remove(file_lock)
        except OSError:
            self.debug(None, "Couldn't delete lock file")

    # ----------------------------------
    # Logging methods
    def debug(self, section, msg, *args):
        """Debug messages (verbose 2)

        We show debug messages only to stdout. The message will be formatted
        using the args.

        """
        msg = "  (DD) " + _list_to_string(msg, append="       ")
        if self.verbose >= 2:
            colored_msg = self._color_message(None, msg, *args)
            self._write_to_stdout(section, colored_msg)

    def log(self, section, msg, *args):
        """Normal messages (verbose 0)"""
        assert section, "Section can not be empty"

        msg = _list_to_string(msg)

        colored_msg = self._color_message(None, msg, *args)
        self._write_to_stdout(section, colored_msg)

        plain_msg = _format_message(msg, *args)
        self._write_to_file(section, plain_msg)

    def info(self, section, msg, *args):
        """Info messages (verbose 1)

        Prepare message and write it to file logger and stdout logger

        """
        assert section, "Section can not be empty"

        msg = "  " + _list_to_string(msg, "  ")
        if self.verbose >= 1:
            colored_msg = self._color_message(None, msg, *args)
            self._write_to_stdout(section, colored_msg)

        plain_msg = _format_message(msg, *args)
        self._write_to_file(section, plain_msg)

    def warning(self, section, msg, *args):
        """Warning messages"""
        assert section, "Section can not be empty"

        msg = "  (WW) " + _list_to_string(msg, "       ")

        colored_msg = self._color_message(_yellow, msg, *args)
        self._write_to_stderr(section, colored_msg)

        plain_msg = _format_message(msg, *args)
        self._write_to_file(section, plain_msg)

    def error(self, section, msg, *args):
        """Error messages"""
        assert section, "Section can not be empty"

        msg = "  (EE) " + _list_to_string(msg, "       ")

        colored_msg = self._color_message(_red, msg, *args)
        self._write_to_stderr(section, colored_msg)

        plain_msg = _format_message(msg, *args)
        self._write_to_file(section, plain_msg)

    def _write_to_stdout(self, section, msg):
        """Write to stdout"""
        if section is not None and self.in_parallel:
            sys.stdout.write(section + ": " + msg)
        else:
            sys.stdout.write(msg)

    def _write_to_stderr(self, section, msg):
        """Write to stderr"""
        if section is not None and self.in_parallel:
            sys.stderr.write(section + ": " + msg)
        else:
            sys.stderr.write(msg)

    def _write_to_file(self, section, msg):
        """Write to file"""
        _write_log_file(self.file_location, section, msg)

    # ----------------------------------
    # Handle testsuites
    def testsuite_start(self, testsuite):
        """Start a new testsuite

        Add a new section in the logging file

        """
        assert testsuite, "Testsuite name can not be emtpy"

        # Add a new section in the logging file
        test_runned = "  * " + testsuite + "\n"
        _write_log_file(self.file_location, SECTION_RUNNED, test_runned)

        new_section_entry = \
            SECTION_SEPARATOR + "\n" + SECTION_PREFIX + testsuite + "\n\n\n\n"
        _write_log_file(self.file_location, SECTION_NEW, new_section_entry)

        # Add new section to the stdout
        msg = "Starting testsuite %s" % testsuite
        colored_msg = self._color_message(_ts_start, msg)
        self._write_to_stdout(None, colored_msg)

    def testsuite_success(self, testsuite):
        """A testsuite has successfully finished

        Update Results

        """
        assert testsuite, "Testsuite name can not be emtpy"

        # Add our testsuite to Results
        _write_log_file(self.file_location, SECTION_PASSED, testsuite)

        # Add success to stdout
        msg = "Testsuite %s passed" % testsuite
        colored_msg = self._color_message(_ts_success, msg)
        self._write_to_stdout(None, colored_msg)

    def testsuite_failure(self, testsuite):
        """A testsuite has failed

        Update Results

        """
        assert testsuite, "Testsuite name can not be emtpy"

        # Add our testsuite to Results
        _write_log_file(self.file_location, SECTION_FAILED, testsuite)

        # Add success to stdout
        msg = "Testsuite %s failed" % testsuite
        colored_msg = self._color_message(_ts_failure, msg)
        self._write_to_stdout(None, colored_msg)

    # ----------------------------------
    # Colors
    def _color_message(self, color_fun, msg, *args):
        """Color a message before printing it

        The color_fun parameter is used when we want the whole message to be
        colored.

        """
        if self.use_colors:
            if callable(color_fun):
                return color_fun((msg % args)) + "\n"
            else:
                args = tuple([_blue(arg) for arg in args])
                return _format_message(msg, *args)
        else:
            return _format_message(msg, *args)