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
|
#!/usr/bin/env python
# (C) 2013 by Katerina Barone-Adesi <kat.obsc@gmail.com>
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import os.path
import time
import sys
import tempfile
import osmopy.obscvty as obscvty
import osmopy.osmoutil as osmoutil
# Return true iff all the tests for the given config pass
def test_config(app_desc, config, tmpdir, verbose=True):
try:
test_config_atest(app_desc, config, verify_doc, verbose)
newconfig = copy_config(tmpdir, config)
test_config_atest(app_desc, newconfig, write_config, verbose)
test_config_atest(app_desc, newconfig, token_vty_command, verbose)
return 0
# If there's a socket error, skip the rest of the tests for this config
except IOError:
return 1
def test_config_atest(app_desc, config, run_test, verbose=True):
proc = None
ret = None
try:
cmd = [app_desc[1], "-c", config]
if verbose:
print "Verifying %s, test %s" % (' '.join(cmd), run_test.__name__)
proc = osmoutil.popen_devnull(cmd)
time.sleep(1)
end = app_desc[2]
port = app_desc[0]
vty = obscvty.VTYInteract(end, "127.0.0.1", port)
ret = run_test(vty)
except IOError as se:
print >> sys.stderr, "Failed to verify %s" % ' '.join(cmd)
print >> sys.stderr, "Current directory: %s" % os.getcwd()
print >> sys.stderr, "Error was %s" % se
raise se
finally:
if proc:
osmoutil.end_proc(proc)
return ret
def copy_config(dirname, config):
try:
os.stat(dirname)
except OSError:
os.mkdir(dirname)
else:
remove_tmpdir(dirname)
os.mkdir(dirname)
prefix = os.path.basename(config)
tmpfile = tempfile.NamedTemporaryFile(
dir=dirname, prefix=prefix, delete=False)
tmpfile.write(open(config).read())
tmpfile.close()
# This works around the precautions NamedTemporaryFile is made for...
return tmpfile.name
def write_config(vty):
new_config = vty.enabled_command("write")
return new_config.split(' ')[-1]
# The only purpose of this function is to verify a working vty
def token_vty_command(vty):
vty.command("help")
return True
# This may warn about the same doc missing multiple times, by design
def verify_doc(vty):
xml = vty.command("show online-help")
split_at = "<command"
all_errs = []
for command in xml.split(split_at):
if "(null)" in command:
lines = command.split("\n")
cmd_line = split_at + lines[0]
err_lines = []
for line in lines:
if '(null)' in line:
err_lines.append(line)
all_errs.append(err_lines)
print >> sys.stderr, \
"Documentation error (missing docs): \n%s\n%s\n" % (
cmd_line, '\n'.join(err_lines))
return (len(all_errs), all_errs)
# Skip testing the configurations of anything that hasn't been compiled
def app_exists(app_desc):
cmd = app_desc[1]
return os.path.exists(cmd)
def remove_tmpdir(tmpdir):
files = os.listdir(tmpdir)
for f in files:
os.unlink(os.path.join(tmpdir, f))
os.rmdir(tmpdir)
def check_configs_tested(basedir, app_configs):
configs = []
for root, dirs, files in os.walk(basedir):
for f in files:
if f.endswith(".cfg"):
configs.append(os.path.join(root, f))
for config in configs:
found = False
for app in app_configs:
if config in app_configs[app]:
found = True
if not found:
print >> sys.stderr, "Warning: %s is not being tested" % config
def test_all_apps(apps, app_configs, tmpdir="writtenconfig", verbose=True,
confpath=".", rmtmp=False):
check_configs_tested("doc/examples/", app_configs)
errors = 0
for app in apps:
if not app_exists(app):
print >> sys.stderr, "Skipping app %s (not found)" % app[1]
continue
configs = app_configs[app[3]]
for config in configs:
config = os.path.join(confpath, config)
errors |= test_config(app, config, tmpdir, verbose)
if rmtmp or not errors:
remove_tmpdir(tmpdir)
return errors
if __name__ == '__main__':
import argparse
confpath = "."
wordir = "."
parser = argparse.ArgumentParser()
parser.add_argument("--e1nitb", action="store_true", dest="e1nitb")
parser.add_argument("-v", "--verbose", dest="verbose",
action="store_true", help="verbose mode")
parser.add_argument("-p", "--pythonconfpath", dest="p",
help="searchpath for config")
parser.add_argument("-w", "--workdir", dest="w",
help="Working directory to run in")
args = parser.parse_args()
if args.p:
confpath = args.p
if args.w:
workdir = args.w
osmoappdesc = None
try:
osmoappdesc = osmoutil.importappconf(confpath, "osmoappdesc")
except ImportError as e:
print >> sys.stderr, "osmoappdesc not found, set searchpath with -p"
sys.exit(1)
apps = osmoappdesc.apps
configs = osmoappdesc.app_configs
if args.e1nitb:
configs['nitb'].extend(osmoappdesc.nitb_e1_configs)
os.chdir(workdir)
sys.exit(test_all_apps(apps, configs, confpath=confpath,
verbose=args.verbose))
|
