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
|
#!/usr/bin/env python
from __future__ import print_function
from argparse import ArgumentParser
from datetime import datetime
import re
from deploy_stack import (
boot_context,
tear_down,
update_env,
)
from jujupy import (
jes_home_path,
make_client,
yaml_loads,
)
from utility import add_basic_testing_arguments
__metaclass__ = type
FILL_TIMEOUT = '8m'
class LogRotateError(Exception):
''' LogRotate test Exception base class. '''
def __init__(self, message):
super(LogRotateError, self).__init__(message)
def test_debug_log(client, timeout=180, lines=100):
"""After doing log rotation, we should be able to see debug-log output."""
out = client.get_juju_output("debug-log", "--lines={}".format(lines),
"--limit={}".format(lines), timeout=timeout)
content = out.splitlines()
if len(content) != lines:
raise LogRotateError("We expected {} lines of output, got {}".format(
lines, len(content)))
def test_unit_rotation(client):
"""Tests unit log rotation."""
# TODO: as part of testing that when a unit sending lots of logs triggers
# unit log rotation, we should also test that all-machines.log and future
# logsink.log get rotated.
# It would also be possible to test that the logs database doesn't grow too
# large.
test_rotation(client,
"/var/log/juju/unit-fill-logs-0.log",
"unit-fill-logs-0",
"fill-unit",
"unit-size",
"megs=300")
# TODO: either call test_debug_log here or add a new assess entry for it.
def test_machine_rotation(client):
"""Tests machine log rotation."""
test_rotation(client,
"/var/log/juju/machine-1.log",
"machine-1",
"fill-machine",
"machine-size", "megs=300", "machine=1")
def test_rotation(client, logfile, prefix, fill_action, size_action, *args):
"""A reusable help for testing log rotation.log
Deploys the fill-logs charm and uses it to fill the machine or unit log and
test that the logs roll over correctly.
"""
# the rotation point should be 300 megs, so let's make sure we hit that.hit
# we'll obviously already have some data in the logs, so adding exactly
# 300megs should do the trick.
# we run do_fetch here so that we wait for fill-logs to finish.
client.action_do_fetch("fill-logs/0", fill_action, FILL_TIMEOUT, *args)
out = client.action_do_fetch("fill-logs/0", size_action)
action_output = yaml_loads(out)
# Now we should have one primary log file, and one backup log file.
# The backup should be approximately 300 megs.
# The primary should be below 300.
check_log0(logfile, action_output)
check_expected_backup("log1", prefix, action_output)
# we should only have one backup, not two.
check_for_extra_backup("log2", action_output)
# do it all again, this should generate a second backup.
client.action_do_fetch("fill-logs/0", fill_action, FILL_TIMEOUT, *args)
out = client.action_do_fetch("fill-logs/0", size_action)
action_output = yaml_loads(out)
# we should have two backups.
check_log0(logfile, action_output)
check_expected_backup("log1", prefix, action_output)
check_expected_backup("log2", prefix, action_output)
check_for_extra_backup("log3", action_output)
# one more time... we should still only have 2 backups and primary
client.action_do_fetch("fill-logs/0", fill_action, FILL_TIMEOUT, *args)
out = client.action_do_fetch("fill-logs/0", size_action)
action_output = yaml_loads(out)
check_log0(logfile, action_output)
check_expected_backup("log1", prefix, action_output)
check_expected_backup("log2", prefix, action_output)
# we should have two backups.
check_for_extra_backup("log3", action_output)
def check_for_extra_backup(logname, action_output):
"""Check that there are no extra backup files left behind."""
log = action_output["results"]["result-map"].get(logname)
if log is None:
# this is correct
return
# log exists.
name = log.get("name")
if name is None:
name = "(no name)"
raise LogRotateError("Extra backup log after rotation: " + name)
def check_expected_backup(key, logprefix, action_output):
"""Check that there the expected backup files exists and is close to 300MB.
"""
log = action_output["results"]["result-map"].get(key)
if log is None:
raise LogRotateError(
"Missing backup log '{}' after rotation.".format(key))
backup_pattern = "/var/log/juju/%s-(.+?)\.log" % logprefix
log_name = log["name"]
matches = re.match(backup_pattern, log_name)
if matches is None:
raise LogRotateError(
"Rotated log '%s' does not match pattern '%s'." %
(log_name, backup_pattern))
size = int(log["size"])
if size < 299 or size > 301:
raise LogRotateError(
"Backup log '%s' should be ~300MB, but is %sMB." %
(log_name, size))
dt = matches.groups()[0]
dt_pattern = "%Y-%m-%dT%H-%M-%S.%f"
try:
# note - we have to use datetime's strptime because time's doesn't
# support partial seconds.
dt = datetime.strptime(dt, dt_pattern)
except Exception:
raise LogRotateError(
"Log for %s has invalid datetime appended: %s" % (log_name, dt))
def check_log0(expected, action_output):
"""Check that log0 exists and is not over 299MB"""
log = action_output["results"]["result-map"].get("log0")
if log is None:
raise LogRotateError("No log returned from size action.")
name = log["name"]
if name != expected:
raise LogRotateError(
"Wrong unit name: Expected: %s, actual: %s" % (expected, name))
size = int(log["size"])
if size > 299:
raise LogRotateError(
"Log0 too big. Expected < 300MB, got: %sMB" % size)
def parse_args(argv=None):
"""Parse all arguments."""
parser = add_basic_testing_arguments(
ArgumentParser(description='Test log rotation.'))
parser.add_argument(
'agent',
help='Which agent log rotation to test.',
choices=['machine', 'unit'])
return parser.parse_args(argv)
def make_client_from_args(args):
client = make_client(
args.juju_bin, args.debug, args.env, args.temp_env_name)
update_env(
client.env, args.temp_env_name, series=args.series,
bootstrap_host=args.bootstrap_host, agent_url=args.agent_url,
agent_stream=args.agent_stream, region=args.region)
jes_enabled = client.is_jes_enabled()
if jes_enabled:
client.env.juju_home = jes_home_path(client.env.juju_home,
args.temp_env_name)
tear_down(client, jes_enabled)
return client
def main():
args = parse_args()
client = make_client_from_args(args)
with boot_context(args.temp_env_name, client,
bootstrap_host=args.bootstrap_host,
machines=args.machine, series=args.series,
agent_url=args.agent_url, agent_stream=args.agent_stream,
log_dir=args.logs, keep_env=args.keep_env,
upload_tools=args.upload_tools,
region=args.region):
client.juju("deploy", ('local:trusty/fill-logs',))
if args.agent == "unit":
test_unit_rotation(client)
if args.agent == "machine":
test_machine_rotation(client)
if __name__ == '__main__':
main()
|