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
|
#!/usr/bin/python
#
# Copyright (C) 2009, 2010 Lars Wirzenius <liw@liw.fi>
#
# 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
'''Run some black box tests for genbackupdata.'''
import logging
import os
import random
import re
import shutil
import stat
import subprocess
import sys
import tempfile
import traceback
import unittest
class GenbackupdataTestCase(unittest.TestCase):
'''Base class for genbackupdata test cases.
We use the unittest framework even though these are black box tests,
not unit tests. unittest makes implementation of these black box
tests convenient, even though that might not be true for all black
box tests.
This base class provides a fresh environment for each test, and
cleans up afterwards. It provides helpers for doing the usual
backup operations, and for verifyting results.
'''
def setUp(self):
self.tempdir = tempfile.mkdtemp()
self.setUpHook()
def setUpHook(self):
pass
def tearDown(self):
self.tearDownHook()
shutil.rmtree(self.tempdir)
def tearDownHook(self):
pass
def path(self, *relatives):
return os.path.join(self.tempdir, *relatives)
def mkdir(self, dirname):
abs_dirname = os.path.join(self.tempdir, dirname)
os.makedirs(abs_dirname)
return abs_dirname
def runcmd(self, argv, stderr_ignore=None):
'''Run an external command.
If the command fails (non-zero exit), raise an exception.
If stderr_ignore is not None, it must be a string with a
regexp for lines in stderr to ignore.
'''
logging.debug('executing %s' % argv)
p = subprocess.Popen(argv, stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
if stderr_ignore:
lines = [line for line in stderr.splitlines()
if not re.match(stderr_ignore, line)]
stderr = ''.join(lines)
sys.stderr.write(stderr)
if p.returncode != 0:
raise subprocess.CalledProcessError(p.returncode, argv)
return stdout
def genbackupdata(self, args, stderr_ignore=None):
'''Run genbackupdata, with some default arguments.'''
return self.runcmd(['./genbackupdata'] +
args, stderr_ignore=stderr_ignore)
def create_file(self, dirname, relative, contents):
'''Create a new file with the desired contents.'''
pathname = os.path.join(dirname, relative)
logging.debug('creating file %s' % pathname)
f = open(pathname, 'w')
f.write(contents)
f.close()
def remove_file(self, root, relative):
'''Remove a file.'''
pathname = os.path.join(root, relative)
logging.debug('removing file %s' % pathname)
os.remove(pathname)
def create_dir(self, root, pathname):
'''Create a new directory, return name.'''
fullname = os.path.join(root, pathname)
logging.debug('mkdir %s' % fullname)
os.makedirs(fullname)
return fullname
def get_info(self, root, pathname):
'''Get the information about a given file.
Return a tuple (relativepath, stat) where relativepath is the
path relative to root, and stat is the result of os.lstat.
'''
root_base = os.path.basename(root)
del_prefix = root[:-len(root_base)]
if pathname == root:
return None
assert pathname.startswith(root + os.sep), (pathname, root)
return pathname[len(root + os.sep):], os.lstat(pathname)
def find_everything(self, root):
'''Find all filesystem objects inside a directory tree.
Return list of (pathname, stat) tuples. The pathname will be
relative to the root of the directory tree. The stat tuples
will be the result of os.lstat for each pathname.
'''
result = []
for dirname, dirnames, filenames in os.walk(root):
result.append(self.get_info(root, dirname))
for filename in filenames:
pathname = os.path.join(dirname, filename)
result.append(self.get_info(root, pathname))
return [x for x in result if x]
def apparent_size(self, root):
'''Return sum of length of regular files in directory, recursively.'''
size = 0
for dirname, subdirs, filenames in os.walk(self.path(root)):
for filename in filenames:
pathname = self.path(dirname, filename)
st = os.lstat(pathname)
if stat.S_ISREG(st.st_mode):
size += st.st_size
return size
def assert_equal_stat_fields(self, filename, stat1, stat2, fieldname):
field1 = getattr(stat1, fieldname)
field2 = getattr(stat2, fieldname)
self.assertEqual(field1, field2,
'%s stat field %s difference: %s vs %s' %
(filename, fieldname, repr(field1), repr(field2)))
def assert_same_stat(self, name, stat1, stat2):
'''Are two stat results effectively identical?'''
class Fake(object):
def __init__(self, stat_result):
self.st = stat_result
def __getattr__(self, name):
if name == 'st_mtime':
return int(getattr(self.st, name))
else:
return getattr(self.st, name)
self.assert_equal_stat_fields(name, stat1, stat2, 'st_blocks')
self.assert_equal_stat_fields(name, stat1, stat2, 'st_gid')
self.assert_equal_stat_fields(name, stat1, stat2, 'st_mode')
self.assert_equal_stat_fields(name, Fake(stat1), Fake(stat2), 'st_mtime')
self.assert_equal_stat_fields(name, stat1, stat2, 'st_nlink')
self.assert_equal_stat_fields(name, stat1, stat2, 'st_size')
self.assert_equal_stat_fields(name, stat1, stat2, 'st_uid')
def assert_same_contents(self, relative, root1, root2):
'''Verify that file contents has been restored correctly.'''
path1 = os.path.join(root1, relative)
path2 = os.path.join(root2, relative)
self.assertFilesEqual(path1, path2)
def assertFileExists(self, path):
self.assert_(os.path.exists(path), '%s does not exist' % path)
def assertIsRegularFile(self, path):
self.assert_(os.path.isfile(path), '%s is not a regular file' % path)
def assertFilesEqual(self, path1, path2):
'''Verify that file contents are equal.'''
self.assertFileExists(path1)
self.assertFileExists(path2)
self.assertIsRegularFile(path1)
self.assertIsRegularFile(path2)
f1 = open(path1, 'r')
f2 = open(path2, 'r')
data1 = f1.read()
data2 = f2.read()
f1.close()
f2.close()
self.assertEqual(data1, data2,
'contents of %s and %s differ' % (path1, path2))
class GenbackupdataTests(GenbackupdataTestCase):
def test_returns_success_with_help_option(self):
self.genbackupdata(['--help'])
self.assertTrue(True)
def test_creates_requested_amount_of_data(self):
bytes = 12765
self.genbackupdata([self.path('data'), '--create=%d' % bytes])
self.assertEqual(self.apparent_size('data'), bytes)
if __name__ == '__main__':
logging.basicConfig(filename='blackboxtest.log',
level=logging.DEBUG,
format='%(levelname)s: %(message)s')
unittest.main()
|
