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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
|
require 'test_helper'
class ZipFileTest < MiniTest::Test
include CommonZipFileFixture
OK_DELETE_FILE = 'test/data/generated/okToDelete.txt'
OK_DELETE_MOVED_FILE = 'test/data/generated/okToDeleteMoved.txt'
def teardown
::Zip.write_zip64_support = false
end
def test_create_from_scratch_to_buffer
comment = 'a short comment'
buffer = ::Zip::File.add_buffer do |zf|
zf.get_output_stream('myFile') { |os| os.write 'myFile contains just this' }
zf.mkdir('dir1')
zf.comment = comment
end
::File.open(EMPTY_FILENAME, 'wb') { |file| file.write buffer.string }
zfRead = ::Zip::File.new(EMPTY_FILENAME)
assert_equal(comment, zfRead.comment)
assert_equal(2, zfRead.entries.length)
end
def test_create_from_scratch
comment = 'a short comment'
zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
zf.get_output_stream('myFile') { |os| os.write 'myFile contains just this' }
zf.mkdir('dir1')
zf.comment = comment
zf.close
zfRead = ::Zip::File.new(EMPTY_FILENAME)
assert_equal(comment, zfRead.comment)
assert_equal(2, zfRead.entries.length)
end
def test_get_output_stream
entryCount = nil
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
entryCount = zf.size
zf.get_output_stream('newEntry.txt') do |os|
os.write 'Putting stuff in newEntry.txt'
end
assert_equal(entryCount + 1, zf.size)
assert_equal('Putting stuff in newEntry.txt', zf.read('newEntry.txt'))
zf.get_output_stream(zf.get_entry('test/data/generated/empty.txt')) do |os|
os.write 'Putting stuff in data/generated/empty.txt'
end
assert_equal(entryCount + 1, zf.size)
assert_equal('Putting stuff in data/generated/empty.txt', zf.read('test/data/generated/empty.txt'))
custom_entry_args = [ZipEntryTest::TEST_COMMENT, ZipEntryTest::TEST_EXTRA, ZipEntryTest::TEST_COMPRESSED_SIZE, ZipEntryTest::TEST_CRC, ::Zip::Entry::STORED, ZipEntryTest::TEST_SIZE, ZipEntryTest::TEST_TIME]
zf.get_output_stream('entry_with_custom_args.txt', nil, *custom_entry_args) do |os|
os.write 'Some data'
end
assert_equal(entryCount + 2, zf.size)
entry = zf.get_entry('entry_with_custom_args.txt')
assert_equal(custom_entry_args[0], entry.comment)
assert_equal(custom_entry_args[2], entry.compressed_size)
assert_equal(custom_entry_args[3], entry.crc)
assert_equal(custom_entry_args[4], entry.compression_method)
assert_equal(custom_entry_args[5], entry.size)
assert_equal(custom_entry_args[6], entry.time)
zf.get_output_stream('entry.bin') do |os|
os.write(::File.open('test/data/generated/5entry.zip', 'rb').read)
end
end
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_equal(entryCount + 3, zf.size)
assert_equal('Putting stuff in newEntry.txt', zf.read('newEntry.txt'))
assert_equal('Putting stuff in data/generated/empty.txt', zf.read('test/data/generated/empty.txt'))
assert_equal(File.open('test/data/generated/5entry.zip', 'rb').read, zf.read('entry.bin'))
end
end
def test_open_buffer_with_stringio
string_io = StringIO.new File.read('test/data/rubycode.zip')
::Zip::File.open_buffer string_io do |zf|
assert zf.entries.map { |e| e.name }.include?('zippedruby1.rb')
end
end
def test_cleans_up_tempfiles_after_close
zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
zf.get_output_stream('myFile') do |os|
@tempfile_path = os.path
os.write 'myFile contains just this'
end
assert_equal(true, File.exist?(@tempfile_path))
zf.close
assert_equal(false, File.exist?(@tempfile_path))
end
def test_add
srcFile = 'test/data/file2.txt'
entryName = 'newEntryName.rb'
assert(::File.exist?(srcFile))
zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
zf.add(entryName, srcFile)
zf.close
zfRead = ::Zip::File.new(EMPTY_FILENAME)
assert_equal('', zfRead.comment)
assert_equal(1, zfRead.entries.length)
assert_equal(entryName, zfRead.entries.first.name)
AssertEntry.assert_contents(srcFile,
zfRead.get_input_stream(entryName) { |zis| zis.read })
end
def test_recover_permissions_after_add_files_to_archive
srcZip = TEST_ZIP.zip_name
::File.chmod(0664, srcZip)
srcFile = 'test/data/file2.txt'
entryName = 'newEntryName.rb'
assert_equal(::File.stat(srcZip).mode, 0100664)
assert(::File.exist?(srcZip))
zf = ::Zip::File.new(srcZip, ::Zip::File::CREATE)
zf.add(entryName, srcFile)
zf.close
assert_equal(::File.stat(srcZip).mode, 0100664)
end
def test_add_existing_entry_name
assert_raises(::Zip::EntryExistsError) do
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
zf.add(zf.entries.first.name, 'test/data/file2.txt')
end
end
end
def test_add_existing_entry_name_replace
gotCalled = false
replacedEntry = nil
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
replacedEntry = zf.entries.first.name
zf.add(replacedEntry, 'test/data/file2.txt') { gotCalled = true; true }
end
assert(gotCalled)
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_contains(zf, replacedEntry, 'test/data/file2.txt')
end
end
def test_add_directory
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
zf.add(TestFiles::EMPTY_TEST_DIR, TestFiles::EMPTY_TEST_DIR)
end
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
dirEntry = zf.entries.detect { |e| e.name == TestFiles::EMPTY_TEST_DIR + '/' }
assert(dirEntry.directory?)
end
end
def test_remove
entryToRemove, *remainingEntries = TEST_ZIP.entry_names
FileUtils.cp(TestZipFile::TEST_ZIP2.zip_name, TEST_ZIP.zip_name)
zf = ::Zip::File.new(TEST_ZIP.zip_name)
assert(zf.entries.map { |e| e.name }.include?(entryToRemove))
zf.remove(entryToRemove)
assert(!zf.entries.map { |e| e.name }.include?(entryToRemove))
assert_equal(zf.entries.map { |x| x.name }.sort, remainingEntries.sort)
zf.close
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
assert(!zfRead.entries.map { |e| e.name }.include?(entryToRemove))
assert_equal(zfRead.entries.map { |x| x.name }.sort, remainingEntries.sort)
zfRead.close
end
def test_rename
entryToRename, * = TEST_ZIP.entry_names
zf = ::Zip::File.new(TEST_ZIP.zip_name)
assert(zf.entries.map { |e| e.name }.include?(entryToRename))
contents = zf.read(entryToRename)
newName = 'changed entry name'
assert(!zf.entries.map { |e| e.name }.include?(newName))
zf.rename(entryToRename, newName)
assert(zf.entries.map { |e| e.name }.include?(newName))
assert_equal(contents, zf.read(newName))
zf.close
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
assert(zfRead.entries.map { |e| e.name }.include?(newName))
assert_equal(contents, zfRead.read(newName))
zfRead.close
end
def test_rename_with_each
zf_name = 'test_rename_zip.zip'
::File.unlink(zf_name) if ::File.exist?(zf_name)
arr = []
arr_renamed = []
::Zip::File.open(zf_name, ::Zip::File::CREATE) do |zf|
zf.mkdir('test')
arr << 'test/'
arr_renamed << 'Ztest/'
%w(a b c d).each do |f|
zf.get_output_stream("test/#{f}") { |file| file.puts 'aaaa' }
arr << "test/#{f}"
arr_renamed << "Ztest/#{f}"
end
end
zf = ::Zip::File.open(zf_name)
assert_equal(zf.entries.map(&:name), arr)
zf.close
Zip::File.open(zf_name, 'wb') do |z|
z.each do |f|
z.rename(f, "Z#{f.name}")
end
end
zf = ::Zip::File.open(zf_name)
assert_equal(zf.entries.map(&:name), arr_renamed)
zf.close
::File.unlink(zf_name) if ::File.exist?(zf_name)
end
def test_rename_to_existing_entry
oldEntries = nil
::Zip::File.open(TEST_ZIP.zip_name) { |zf| oldEntries = zf.entries }
assert_raises(::Zip::EntryExistsError) do
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
zf.rename(zf.entries[0], zf.entries[1].name)
end
end
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_equal(oldEntries.sort.map { |e| e.name }, zf.entries.sort.map { |e| e.name })
end
end
def test_rename_to_existing_entry_overwrite
oldEntries = nil
::Zip::File.open(TEST_ZIP.zip_name) { |zf| oldEntries = zf.entries }
gotCalled = false
renamedEntryName = nil
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
renamedEntryName = zf.entries[0].name
zf.rename(zf.entries[0], zf.entries[1].name) { gotCalled = true; true }
end
assert(gotCalled)
oldEntries.delete_if { |e| e.name == renamedEntryName }
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_equal(oldEntries.sort.map { |e| e.name },
zf.entries.sort.map { |e| e.name })
end
end
def test_rename_non_entry
nonEntry = 'bogusEntry'
target_entry = 'target_entryName'
zf = ::Zip::File.new(TEST_ZIP.zip_name)
assert(!zf.entries.include?(nonEntry))
assert_raises(Errno::ENOENT) { zf.rename(nonEntry, target_entry) }
zf.commit
assert(!zf.entries.include?(target_entry))
ensure
zf.close
end
def test_rename_entry_to_existing_entry
entry1, entry2, * = TEST_ZIP.entry_names
zf = ::Zip::File.new(TEST_ZIP.zip_name)
assert_raises(::Zip::EntryExistsError) { zf.rename(entry1, entry2) }
ensure
zf.close
end
def test_replace
entryToReplace = TEST_ZIP.entry_names[2]
newEntrySrcFilename = 'test/data/file2.txt'
zf = ::Zip::File.new(TEST_ZIP.zip_name)
zf.replace(entryToReplace, newEntrySrcFilename)
zf.close
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
AssertEntry.assert_contents(newEntrySrcFilename,
zfRead.get_input_stream(entryToReplace) { |is| is.read })
AssertEntry.assert_contents(TEST_ZIP.entry_names[0],
zfRead.get_input_stream(TEST_ZIP.entry_names[0]) { |is| is.read })
AssertEntry.assert_contents(TEST_ZIP.entry_names[1],
zfRead.get_input_stream(TEST_ZIP.entry_names[1]) { |is| is.read })
AssertEntry.assert_contents(TEST_ZIP.entry_names[3],
zfRead.get_input_stream(TEST_ZIP.entry_names[3]) { |is| is.read })
zfRead.close
end
def test_replace_non_entry
entryToReplace = 'nonExistingEntryname'
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_raises(Errno::ENOENT) { zf.replace(entryToReplace, 'test/data/file2.txt') }
end
end
def test_commit
newName = 'renamedFirst'
zf = ::Zip::File.new(TEST_ZIP.zip_name)
oldName = zf.entries.first
zf.rename(oldName, newName)
zf.commit
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
assert(zfRead.entries.detect { |e| e.name == newName } != nil)
assert(zfRead.entries.detect { |e| e.name == oldName }.nil?)
zfRead.close
zf.close
res = system("unzip -t #{TEST_ZIP.zip_name}")
assert_equal(res, true)
end
def test_double_commit(filename = 'test/data/generated/double_commit_test.zip')
::FileUtils.touch('test/data/generated/test_double_commit1.txt')
::FileUtils.touch('test/data/generated/test_double_commit2.txt')
zf = ::Zip::File.open(filename, ::Zip::File::CREATE)
zf.add('test1.txt', 'test/data/generated/test_double_commit1.txt')
zf.commit
zf.add('test2.txt', 'test/data/generated/test_double_commit2.txt')
zf.commit
zf.close
zf2 = ::Zip::File.open(filename)
assert(zf2.entries.detect { |e| e.name == 'test1.txt' } != nil)
assert(zf2.entries.detect { |e| e.name == 'test2.txt' } != nil)
res = system("unzip -t #{filename}")
assert_equal(res, true)
end
def test_double_commit_zip64
::Zip.write_zip64_support = true
test_double_commit('test/data/generated/double_commit_test64.zip')
end
def test_write_buffer
newName = 'renamedFirst'
zf = ::Zip::File.new(TEST_ZIP.zip_name)
oldName = zf.entries.first
zf.rename(oldName, newName)
io = ::StringIO.new('')
buffer = zf.write_buffer(io)
File.open(TEST_ZIP.zip_name, 'wb') { |f| f.write buffer.string }
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
assert(zfRead.entries.detect { |e| e.name == newName } != nil)
assert(zfRead.entries.detect { |e| e.name == oldName }.nil?)
zfRead.close
zf.close
end
# This test tests that after commit, you
# can delete the file you used to add the entry to the zip file
# with
def test_commit_use_zip_entry
FileUtils.cp(TestFiles::RANDOM_ASCII_FILE1, OK_DELETE_FILE)
zf = ::Zip::File.open(TEST_ZIP.zip_name)
zf.add('okToDelete.txt', OK_DELETE_FILE)
assert_contains(zf, 'okToDelete.txt')
zf.commit
File.rename(OK_DELETE_FILE, OK_DELETE_MOVED_FILE)
assert_contains(zf, 'okToDelete.txt', OK_DELETE_MOVED_FILE)
end
# def test_close
# zf = ZipFile.new(TEST_ZIP.zip_name)
# zf.close
# assert_raises(IOError) {
# zf.extract(TEST_ZIP.entry_names.first, "hullubullu")
# }
# end
def test_compound1
renamedName = 'renamedName'
filename_to_remove = ''
begin
zf = ::Zip::File.new(TEST_ZIP.zip_name)
originalEntries = zf.entries.dup
assert_not_contains(zf, TestFiles::RANDOM_ASCII_FILE1)
zf.add(TestFiles::RANDOM_ASCII_FILE1,
TestFiles::RANDOM_ASCII_FILE1)
assert_contains(zf, TestFiles::RANDOM_ASCII_FILE1)
entry_to_rename = zf.entries.find { |entry| entry.name.match('longAscii') }
zf.rename(entry_to_rename, renamedName)
assert_contains(zf, renamedName)
TestFiles::BINARY_TEST_FILES.each do |filename|
zf.add(filename, filename)
assert_contains(zf, filename)
end
assert_contains(zf, originalEntries.last.to_s)
filename_to_remove = originalEntries.map(&:to_s).find { |name| name.match('longBinary') }
zf.remove(filename_to_remove)
assert_not_contains(zf, filename_to_remove)
ensure
zf.close
end
begin
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
assert_contains(zfRead, TestFiles::RANDOM_ASCII_FILE1)
assert_contains(zfRead, renamedName)
TestFiles::BINARY_TEST_FILES.each do |filename|
assert_contains(zfRead, filename)
end
assert_not_contains(zfRead, filename_to_remove)
ensure
zfRead.close
end
end
def test_compound2
begin
zf = ::Zip::File.new(TEST_ZIP.zip_name)
originalEntries = zf.entries.dup
originalEntries.each do |entry|
zf.remove(entry)
assert_not_contains(zf, entry)
end
assert(zf.entries.empty?)
TestFiles::ASCII_TEST_FILES.each do |filename|
zf.add(filename, filename)
assert_contains(zf, filename)
end
assert_equal(zf.entries.sort.map { |e| e.name }, TestFiles::ASCII_TEST_FILES)
zf.rename(TestFiles::ASCII_TEST_FILES[0], 'newName')
assert_not_contains(zf, TestFiles::ASCII_TEST_FILES[0])
assert_contains(zf, 'newName')
ensure
zf.close
end
begin
zfRead = ::Zip::File.new(TEST_ZIP.zip_name)
asciiTestFiles = TestFiles::ASCII_TEST_FILES.dup
asciiTestFiles.shift
asciiTestFiles.each do |filename|
assert_contains(zf, filename)
end
assert_contains(zf, 'newName')
ensure
zfRead.close
end
end
def test_change_comment
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
zf.comment = 'my changed comment'
end
zfRead = ::Zip::File.open(TEST_ZIP.zip_name)
assert_equal('my changed comment', zfRead.comment)
end
def test_preserve_file_order
entryNames = nil
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
entryNames = zf.entries.map { |e| e.to_s }
zf.get_output_stream('a.txt') { |os| os.write 'this is a.txt' }
zf.get_output_stream('z.txt') { |os| os.write 'this is z.txt' }
zf.get_output_stream('k.txt') { |os| os.write 'this is k.txt' }
entryNames << 'a.txt' << 'z.txt' << 'k.txt'
end
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_equal(entryNames, zf.entries.map { |e| e.to_s })
entries = zf.entries.sort_by { |e| e.name }.reverse
entries.each do |e|
zf.remove e
zf.get_output_stream(e) { |os| os.write 'foo' }
end
entryNames = entries.map { |e| e.to_s }
end
::Zip::File.open(TEST_ZIP.zip_name) do |zf|
assert_equal(entryNames, zf.entries.map { |e| e.to_s })
end
end
def test_streaming
fname = ::File.join(::File.expand_path(::File.dirname(__FILE__)), '../README.md')
zname = 'test/data/generated/README.zip'
Zip::File.open(zname, Zip::File::CREATE) do |zipfile|
zipfile.get_output_stream(File.basename(fname)) do |f|
f.puts File.read(fname)
end
end
data = nil
File.open(zname, 'rb') do |f|
Zip::File.open_buffer(f) do |zipfile|
zipfile.each do |entry|
next unless entry.name =~ /README.md/
data = zipfile.read(entry)
end
end
end
assert data
assert data =~ /Simonov/
end
def test_nonexistant_zip
assert_raises(::Zip::Error) do
::Zip::File.open('fake.zip')
end
end
def test_empty_zip
puts `touch empty.zip`
assert_raises(::Zip::Error) do
::Zip::File.open('empty.zip')
end
end
def test_odd_extra_field
entry_count = 0
File.open 'test/data/oddExtraField.zip', 'rb' do |zip_io|
Zip::File.open_buffer zip_io.read do |zip|
zip.each do |zip_entry|
entry_count += 1
end
end
end
assert_equal 13, entry_count
end
def test_open_xls_does_not_raise_type_error
::Zip::File.open('test/data/test.xls')
end
private
def assert_contains(zf, entryName, filename = entryName)
assert(zf.entries.detect { |e| e.name == entryName } != nil, "entry #{entryName} not in #{zf.entries.join(', ')} in zip file #{zf}")
assert_entry_contents(zf, entryName, filename) if File.exist?(filename)
end
def assert_not_contains(zf, entryName)
assert(zf.entries.detect { |e| e.name == entryName }.nil?, "entry #{entryName} in #{zf.entries.join(', ')} in zip file #{zf}")
end
end
|