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
|
# Copyright (C) 2010-2015 Lars Wirzenius
#
# 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 logging
import os
import random
import stat
import sys
import urlparse
import obnamlib
class WrongNumberOfGenerationsForVerify(obnamlib.ObnamError):
msg = 'verify must be given exactly one generation'
class Fail(obnamlib.ObnamError):
msg = '{filename}: {reason}'
class VerifyPlugin(obnamlib.ObnamPlugin):
def enable(self):
self.app.add_subcommand(
'verify', self.verify, arg_synopsis='[DIRECTORY]...')
self.app.settings.integer(
['verify-randomly'],
'verify N files randomly from the backup '
'(default is zero, meaning everything)',
metavar='N')
def verify(self, args):
'''Verify that live data and backed up data match.'''
self.app.settings.require('repository')
self.app.settings.require('client-name')
self.app.settings.require('generation')
if len(self.app.settings['generation']) != 1:
raise WrongNumberOfGenerationsForVerify()
logging.debug(
'verifying generation %s', self.app.settings['generation'])
if not args:
self.app.settings.require('root')
args = self.app.settings['root']
if not args:
logging.debug('no roots/args given, so verifying everything')
args = ['/']
logging.debug('verifying what: %s', repr(args))
self.repo = self.app.get_repository_object()
client_name = self.app.settings['client-name']
self.fs = self.app.fsf.new(args[0])
self.fs.connect()
t = urlparse.urlparse(args[0])
root_url = urlparse.urlunparse((t[0], t[1], '/', t[3], t[4], t[5]))
logging.debug('t: %s', repr(t))
logging.debug('root_url: %s', repr(root_url))
self.fs.reinit(root_url)
self.failed = False
gen_id = self.repo.interpret_generation_spec(
client_name,
self.app.settings['generation'][0])
self.app.ts['done'] = 0
self.app.ts['total'] = 0
self.app.ts['done_bytes'] = 0
self.app.ts['total_bytes'] = 0
self.app.ts['filename'] = ''
if not self.app.settings['quiet']:
self.app.ts.format(
'%ElapsedTime() '
'verifying file %Counter(filename)/%Integer(total) '
'%ByteSize(done_bytes)/%ByteSize(total_bytes) '
'%PercentDone(done_bytes,total_bytes): '
'%Pathname(filename)')
num_randomly = self.app.settings['verify-randomly']
if num_randomly == 0:
self.app.ts['total'] = \
self.repo.get_generation_key(
gen_id, obnamlib.REPO_GENERATION_FILE_COUNT)
self.app.ts['total_bytes'] = \
self.repo.get_generation_key(
gen_id, obnamlib.REPO_GENERATION_TOTAL_DATA)
for filename in self.walk(gen_id, args):
self.app.ts['filename'] = filename
try:
self.verify_metadata(gen_id, filename)
except Fail, e:
self.log_fail(e)
else:
mode = self.repo.get_file_key(
gen_id, filename, obnamlib.REPO_FILE_MODE)
if stat.S_ISREG(mode):
try:
self.verify_regular_file(gen_id, filename)
except Fail, e:
self.log_fail(e)
self.app.ts['done'] += 1
else:
logging.debug('verifying %d files randomly', num_randomly)
self.app.ts['total'] = num_randomly
self.app.ts.notify('finding all files to choose randomly')
filenames = []
for filename in self.walk(gen_id, args):
mode = self.repo.get_file_key(
gen_id, filename, obnamlib.REPO_FILE_MODE)
if stat.S_ISREG(mode):
filenames.append(filename)
chosen = []
for _ in range(min(num_randomly, len(filenames))):
filename = random.choice(filenames)
filenames.remove(filename)
chosen.append(filename)
for filename in chosen:
self.app.ts['filename'] = filename
try:
self.verify_metadata(gen_id, filename)
self.verify_regular_file(gen_id, filename)
except Fail, e:
self.log_fail(e)
self.app.ts['done'] += 1
self.fs.close()
self.repo.close()
self.app.ts.finish()
if self.failed:
sys.exit(1)
print "Verify did not find problems."
def log_fail(self, e):
msg = 'verify failure: %s' % str(e)
logging.error(msg)
if self.app.settings['quiet']:
sys.stderr.write('%s\n' % msg)
else:
self.app.ts.notify(msg)
self.failed = True
def verify_metadata(self, gen_id, filename):
try:
live_data = obnamlib.read_metadata(self.fs, filename)
except OSError, e:
raise Fail(
filename=filename,
reason='missing or inaccessible: %s' % e.strerror)
def X(key, field_name):
v1 = self.repo.get_file_key(gen_id, filename, key)
v2 = getattr(live_data, field_name)
# obnamlib.Metadata stores some fields as None, but
# RepositoryInterface returns 0 or '' instead. Convert
# the value from obnamlib.Metadata accordingly, for comparison.
if key in obnamlib.REPO_FILE_INTEGER_KEYS:
v2 = v2 or 0
else:
v2 = v2 or ''
if v1 != v2:
raise Fail(
filename=filename,
reason='metadata change: %s (%s vs %s)' %
(field_name, repr(v1), repr(v2)))
X(obnamlib.REPO_FILE_MODE, 'st_mode')
X(obnamlib.REPO_FILE_MTIME_SEC, 'st_mtime_sec')
X(obnamlib.REPO_FILE_MTIME_NSEC, 'st_mtime_nsec')
X(obnamlib.REPO_FILE_NLINK, 'st_nlink')
X(obnamlib.REPO_FILE_GROUPNAME, 'groupname')
X(obnamlib.REPO_FILE_USERNAME, 'username')
X(obnamlib.REPO_FILE_SYMLINK_TARGET, 'target')
X(obnamlib.REPO_FILE_XATTR_BLOB, 'xattr')
def verify_regular_file(self, gen_id, filename):
logging.debug('verifying regular %s', filename)
f = self.fs.open(filename, 'r')
chunkids = self.repo.get_file_chunk_ids(gen_id, filename)
if not self.verify_chunks(f, chunkids):
raise Fail(filename=filename, reason='data changed')
data = f.read(1)
if data:
raise Fail(filename=filename, reason='more data at end of file')
f.close()
def verify_chunks(self, f, chunkids):
for chunkid in chunkids:
backed_up = self.repo.get_chunk_content(chunkid)
live_data = f.read(len(backed_up))
self.app.ts['done_bytes'] += len(backed_up)
if backed_up != live_data:
return False
return True
def walk(self, gen_id, args):
'''Iterate over each pathname specified by arguments.
This is a generator.
'''
for arg in args:
_, _, path, _, _ = urlparse.urlsplit(arg)
arg = os.path.normpath(path)
for x in self.repo.walk_generation(gen_id, arg):
yield x
|
