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
|
# Copyright (c) 2014 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.
""" Module provides tests for log.py module """
from __future__ import absolute_import, division, print_function
import sys
import collections
import threading
import nose.tools as nt
import framework.log as log
from . import utils
TEST_STATE = {'total': 0, 'complete': 0, 'lastlength': 0, 'running': [],
'summary': collections.defaultdict(lambda: 0)}
@utils.nose_generator
def test_initialize():
""" Generate tests for class initializiation """
check_initialize = lambda c, *a: c(*a)
for name, class_ in [('QuiteLog', log.QuietLog),
('VerboseLog', log.VerboseLog)]:
check_initialize.description = "log.{}: class initializes".format(name)
yield check_initialize, class_, TEST_STATE, 'lock' # TODO: use mock
check_initialize.description = "log.LogManager: class initializes"
yield check_initialize, log.LogManager, 'quiet', 100
def test_log_factory_returns_log():
"""log.LogManager.get() returns a BaseLog derived instance"""
logger = log.LogManager('quiet', 100)
log_inst = logger.get()
nt.ok_(isinstance(log_inst, log.BaseLog))
@utils.nose_generator
def test_quietlog_log_state_update():
"""log.QuiteLog.log() updates shared state managed by LogManager"""
logger = log.LogManager('quiet', 100)
log_inst = logger.get()
log_inst.log('pass')
# This lambda is necissary, without it description cannot be set
check = lambda x, y: nt.assert_equal(x, y)
for name, value in [('total', 100), ('summary', {'pass': 1}),
('complete', 1)]:
check.description = \
'log.QuiteLog(): increments state value {0}'.format(name)
yield check, logger._state[name], value
def check_for_output(func, args, file_=sys.stdout):
""" Test that a test produced output to either stdout or stderr
Arguments:
func -- a callable that will produce output
args -- any arguments to be passed to func as a container with a splat
KeywordArguments:
file -- should be either sys.stdout or sys.stderr. default: sys.stdout
"""
# Ensure that the file is empty before running the test
file_.seek(0)
file_.truncate()
func(*args)
# In nose sys.stdout and sys.stderr is a StringIO object, it returns a
# string of everything after the tell.
nt.eq_(file_.read(), '')
@utils.nose_generator
def test_print_when_expected():
""" Generator that creates tests that ensure that methods print
For most logger classes <class>.log() and <class>.summary() should print
something, for some classes <class>.start() should print.
This doesn't try to check what they are printing, just that they are
printing, since 1) the output is very implementation dependent, and 2) it
is subject to change.
"""
# a list of tuples which element 1 is the name of the class and method
# element 2 is a callable, and element 3 is a list of arguments to be
# passed to that callable. it needs to work with the splat operator
printing = []
# Test QuietLog
quiet = log.QuietLog(TEST_STATE, threading.Lock()) # TODO: use mock
printing.append(('QuietLog.log', quiet.log, ['pass']))
printing.append(('QuietLog.summary', quiet.summary, []))
# Test VerboseLog
verbose = log.VerboseLog(TEST_STATE, threading.Lock()) # TODO: use mock
printing.append(('VerboseLog.start', verbose.start, ['a test']))
printing.append(('VerboseLog.log', verbose.log, ['pass']))
printing.append(('VerboseLog.summary', verbose.summary, []))
for name, func, args in printing:
check_for_output.description = "log.{}: produces output".format(name)
yield check_for_output, func, args
def check_no_output(func, args, file_=sys.stdout):
""" file should not be written into
This is the coralary of check_for_ouput, it takes the same arguments and
behaves the same way. See its docstring for more info
"""
# Ensure that the file is empty before running the test
file_.seek(0)
file_.truncate()
func(*args)
file_.seek(-1)
nt.eq_(file_.tell(), 0,
msg='file.tell() is at {}, but should be at 0'.format(file_.tell()))
@utils.nose_generator
def test_noprint_when_expected():
""" Generate tests for methods that shouldn't print
some methods shouldn't print anything, ensure that they don't
"""
# a list of tuples which element 1 is the name of the class and method
# element 2 is a callable, and element 3 is a list of arguments to be
# passed to that callable. it needs to work with the splat operator
printing = []
# Test QuietLog
quiet = log.QuietLog(TEST_STATE, threading.Lock()) # TODO: use mock
printing.append(('QuietLog.start', quiet.start, ['name']))
# Test DummyLog
dummy = log.DummyLog(TEST_STATE, threading.Lock()) # TODO: use mock
printing.append(('DummyLog.start', dummy.start, ['name']))
printing.append(('DummyLog.log', dummy.log, ['pass']))
printing.append(('DummyLog.summary', dummy.summary, []))
for name, func, args in printing:
check_no_output.description = "log.{}: produces no output".format(name)
yield check_no_output, func, args
|
