File: pybde_test_volume.py

package info (click to toggle)
libbde 20190102-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 13,968 kB
  • sloc: ansic: 214,672; sh: 5,968; makefile: 1,412; python: 434; sed: 16
file content (345 lines) | stat: -rw-r--r-- 9,274 bytes parent folder | download | duplicates (3)
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
#!/usr/bin/env python
#
# Python-bindings volume type test script
#
# Copyright (C) 2011-2019, Joachim Metz <joachim.metz@gmail.com>
#
# Refer to AUTHORS for acknowledgements.
#
# This software is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This software 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 Lesser General Public License
# along with this software.  If not, see <http://www.gnu.org/licenses/>.

import argparse
import os
import sys
import unittest

import pybde


class VolumeTypeTests(unittest.TestCase):
  """Tests the volume type."""

  def test_signal_abort(self):
    """Tests the signal_abort function."""
    bde_volume = pybde.volume()

    bde_volume.signal_abort()

  def test_open(self):
    """Tests the open function."""
    if not unittest.source:
      return

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    bde_volume.open(unittest.source)

    with self.assertRaises(IOError):
      bde_volume.open(unittest.source)

    bde_volume.close()

    with self.assertRaises(TypeError):
      bde_volume.open(None)

    with self.assertRaises(ValueError):
      bde_volume.open(unittest.source, mode="w")

  def test_open_file_object(self):
    """Tests the open_file_object function."""
    if not unittest.source:
      return

    file_object = open(unittest.source, "rb")

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    bde_volume.open_file_object(file_object)

    # TODO: fix
    # with self.assertRaises(IOError):
    #   bde_volume.open_file_object(file_object)

    bde_volume.close()

    # TODO: change IOError into TypeError
    with self.assertRaises(IOError):
      bde_volume.open_file_object(None)

    with self.assertRaises(ValueError):
      bde_volume.open_file_object(file_object, mode="w")

  def test_close(self):
    """Tests the close function."""
    if not unittest.source:
      return

    bde_volume = pybde.volume()

    # TODO: fix
    # with self.assertRaises(IOError):
    #   bde_volume.close()

  def test_open_close(self):
    """Tests the open and close functions."""
    if not unittest.source:
      return

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    # Test open and close.
    bde_volume.open(unittest.source)
    bde_volume.close()

    # Test open and close a second time to validate clean up on close.
    bde_volume.open(unittest.source)
    bde_volume.close()

    file_object = open(unittest.source, "rb")

    # Test open_file_object and close.
    bde_volume.open_file_object(file_object)
    bde_volume.close()

    # Test open_file_object and close a second time to validate clean up on close.
    bde_volume.open_file_object(file_object)
    bde_volume.close()

    # Test open_file_object and close and dereferencing file_object.
    bde_volume.open_file_object(file_object)
    del file_object
    bde_volume.close()

  def test_read_buffer(self):
    """Tests the read_buffer function."""
    if not unittest.source:
      return

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    bde_volume.open(unittest.source)

    file_size = bde_volume.get_size()

    # Test normal read.
    data = bde_volume.read_buffer(size=4096)

    self.assertIsNotNone(data)
    self.assertEqual(len(data), min(file_size, 4096))

    if file_size < 4096:
      data = bde_volume.read_buffer()

      self.assertIsNotNone(data)
      self.assertEqual(len(data), file_size)

    # Test read beyond file size.
    if file_size > 16:
      bde_volume.seek_offset(-16, os.SEEK_END)

      data = bde_volume.read_buffer(size=4096)

      self.assertIsNotNone(data)
      self.assertEqual(len(data), 16)

    with self.assertRaises(ValueError):
      bde_volume.read_buffer(size=-1)

    bde_volume.close()

    # Test the read without open.
    with self.assertRaises(IOError):
      bde_volume.read_buffer(size=4096)

  def test_read_buffer_file_object(self):
    """Tests the read_buffer function on a file-like object."""
    if not unittest.source:
      return

    file_object = open(unittest.source, "rb")

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    bde_volume.open_file_object(file_object)

    file_size = bde_volume.get_size()

    # Test normal read.
    data = bde_volume.read_buffer(size=4096)

    self.assertIsNotNone(data)
    self.assertEqual(len(data), min(file_size, 4096))

    bde_volume.close()

  def test_read_buffer_at_offset(self):
    """Tests the read_buffer_at_offset function."""
    if not unittest.source:
      return

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    bde_volume.open(unittest.source)

    file_size = bde_volume.get_size()

    # Test normal read.
    data = bde_volume.read_buffer_at_offset(4096, 0)

    self.assertIsNotNone(data)
    self.assertEqual(len(data), min(file_size, 4096))

    # Test read beyond file size.
    if file_size > 16:
      data = bde_volume.read_buffer_at_offset(4096, file_size - 16)

      self.assertIsNotNone(data)
      self.assertEqual(len(data), 16)

    with self.assertRaises(ValueError):
      bde_volume.read_buffer_at_offset(-1, 0)

    with self.assertRaises(ValueError):
      bde_volume.read_buffer_at_offset(4096, -1)

    bde_volume.close()

    # Test the read without open.
    with self.assertRaises(IOError):
      bde_volume.read_buffer_at_offset(4096, 0)

  def test_seek_offset(self):
    """Tests the seek_offset function."""
    if not unittest.source:
      return

    bde_volume = pybde.volume()

    if unittest.password:
      bde_volume.set_password(unittest.password)
    if unittest.recovery_password:
      bde_volume.set_recovery_password(
          unittest.recovery_password)

    bde_volume.open(unittest.source)

    file_size = bde_volume.get_size()

    bde_volume.seek_offset(16, os.SEEK_SET)

    offset = bde_volume.get_offset()
    self.assertEqual(offset, 16)

    bde_volume.seek_offset(16, os.SEEK_CUR)

    offset = bde_volume.get_offset()
    self.assertEqual(offset, 32)

    bde_volume.seek_offset(-16, os.SEEK_CUR)

    offset = bde_volume.get_offset()
    self.assertEqual(offset, 16)

    bde_volume.seek_offset(-16, os.SEEK_END)

    offset = bde_volume.get_offset()
    self.assertEqual(offset, file_size - 16)

    bde_volume.seek_offset(16, os.SEEK_END)

    offset = bde_volume.get_offset()
    self.assertEqual(offset, file_size + 16)

    # TODO: change IOError into ValueError
    with self.assertRaises(IOError):
      bde_volume.seek_offset(-1, os.SEEK_SET)

    # TODO: change IOError into ValueError
    with self.assertRaises(IOError):
      bde_volume.seek_offset(-32 - file_size, os.SEEK_CUR)

    # TODO: change IOError into ValueError
    with self.assertRaises(IOError):
      bde_volume.seek_offset(-32 - file_size, os.SEEK_END)

    # TODO: change IOError into ValueError
    with self.assertRaises(IOError):
      bde_volume.seek_offset(0, -1)

    bde_volume.close()

    # Test the seek without open.
    with self.assertRaises(IOError):
      bde_volume.seek_offset(16, os.SEEK_SET)


if __name__ == "__main__":
  argument_parser = argparse.ArgumentParser()

  argument_parser.add_argument(
      "source", nargs="?", action="store", metavar="PATH",
      default=None, help="The path of the source file.")

  argument_parser.add_argument(        
      "-p", dest="password", action="store", metavar="PASSWORD",      
      default=None, help="The password.")     
      
  argument_parser.add_argument(       
      "-r", dest="recovery_password", action="store", metavar="PASSWORD",     
      default=None, help="The recovery password.")

  options, unknown_options = argument_parser.parse_known_args()
  unknown_options.insert(0, sys.argv[0])

  setattr(unittest, "password", options.password)
  setattr(unittest, "source", options.source)
  setattr(unittest, "recovery_password", options.recovery_password)

  unittest.main(argv=unknown_options, verbosity=2)