rubyzip 1.1.7 → 1.3.0

data/test/pass_thru_compressor_test.rb

@@ -4,15 +4,14 @@ class PassThruCompressorTest < MiniTest::Test
   include CrcTest
 
   def test_size
-    File.open("test/data/generated/dummy.txt", "wb") {
-        |file|
+    File.open('test/data/generated/dummy.txt', 'wb') do |file|
       compressor = ::Zip::PassThruCompressor.new(file)
 
       assert_equal(0, compressor.size)
 
-      t1 = "hello world"
-      t2 = ""
-      t3 = "bingo"
+      t1 = 'hello world'
+      t2 = ''
+      t3 = 'bingo'
 
       compressor << t1
       assert_equal(compressor.size, t1.size)
@@ -22,7 +21,7 @@ class PassThruCompressorTest < MiniTest::Test
 
       compressor << t3
       assert_equal(compressor.size, t1.size + t2.size + t3.size)
-    }
+    end
   end
 
   def test_crc

data/test/pass_thru_decompressor_test.rb

@@ -12,4 +12,3 @@ class PassThruDecompressorTest < MiniTest::Test
     @file.close
   end
 end
-

data/test/path_traversal_test.rb

@@ -0,0 +1,141 @@
+class PathTraversalTest < MiniTest::Test
+  TEST_FILE_ROOT = File.absolute_path('test/data/path_traversal')
+
+  def setup
+    # With apologies to anyone using these files... but they are the files in
+    # the sample zips, so we don't have much choice here.
+    FileUtils.rm_f '/tmp/moo'
+    FileUtils.rm_f '/tmp/file.txt'
+  end
+
+  def extract_path_traversal_zip(name)
+    Zip::File.open(File.join(TEST_FILE_ROOT, name)) do |zip_file|
+      zip_file.each do |entry|
+        entry.extract
+      end
+    end
+  end
+
+  def in_tmpdir
+    Dir.mktmpdir do |tmp|
+      test_path = File.join(tmp, 'test')
+      Dir.mkdir test_path
+      Dir.chdir test_path do
+        yield test_path
+      end
+    end
+  end
+
+  def test_leading_slash
+    in_tmpdir do
+      extract_path_traversal_zip 'jwilk/absolute1.zip'
+      refute File.exist?('/tmp/moo')
+    end
+  end
+
+  def test_multiple_leading_slashes
+    in_tmpdir do
+      extract_path_traversal_zip 'jwilk/absolute2.zip'
+      refute File.exist?('/tmp/moo')
+    end
+  end
+
+  def test_leading_dot_dot
+    in_tmpdir do
+      extract_path_traversal_zip 'jwilk/relative0.zip'
+      refute File.exist?('../moo')
+    end
+  end
+
+  def test_non_leading_dot_dot_with_existing_folder
+    in_tmpdir do
+      extract_path_traversal_zip 'relative1.zip'
+      assert Dir.exist?('tmp')
+      refute File.exist?('../moo')
+    end
+  end
+
+  def test_non_leading_dot_dot_without_existing_folder
+    in_tmpdir do
+      extract_path_traversal_zip 'jwilk/relative2.zip'
+      refute File.exist?('../moo')
+    end
+  end
+
+  def test_file_symlink
+    in_tmpdir do
+      extract_path_traversal_zip 'jwilk/symlink.zip'
+      assert File.exist?('moo')
+      refute File.exist?('/tmp/moo')
+    end
+  end
+
+  def test_directory_symlink
+    in_tmpdir do
+      # Can't create tmp/moo, because the tmp symlink is skipped.
+      assert_raises Errno::ENOENT do
+        extract_path_traversal_zip 'jwilk/dirsymlink.zip'
+      end
+      refute File.exist?('/tmp/moo')
+    end
+  end
+
+  def test_two_directory_symlinks_a
+    in_tmpdir do
+      # Can't create par/moo because the symlinks are skipped.
+      assert_raises Errno::ENOENT do
+        extract_path_traversal_zip 'jwilk/dirsymlink2a.zip'
+      end
+      refute File.exist?('cur')
+      refute File.exist?('par')
+      refute File.exist?('par/moo')
+    end
+  end
+
+  def test_two_directory_symlinks_b
+    in_tmpdir do
+      # Can't create par/moo, because the symlinks are skipped.
+      assert_raises Errno::ENOENT do
+        extract_path_traversal_zip 'jwilk/dirsymlink2b.zip'
+      end
+      refute File.exist?('cur')
+      refute File.exist?('../moo')
+    end
+  end
+
+  def test_entry_name_with_absolute_path_does_not_extract
+    in_tmpdir do
+      extract_path_traversal_zip 'tuzovakaoff/absolutepath.zip'
+      refute File.exist?('/tmp/file.txt')
+    end
+  end
+
+  def test_entry_name_with_absolute_path_extract_when_given_different_path
+    in_tmpdir do |test_path|
+      zip_path = File.join(TEST_FILE_ROOT, 'tuzovakaoff/absolutepath.zip')
+      Zip::File.open(zip_path) do |zip_file|
+        zip_file.each do |entry|
+          entry.extract(File.join(test_path, entry.name))
+        end
+      end
+      refute File.exist?('/tmp/file.txt')
+    end
+  end
+
+  def test_entry_name_with_relative_symlink
+    in_tmpdir do
+      # Doesn't create the symlink path, so can't create path/file.txt.
+      assert_raises Errno::ENOENT do
+        extract_path_traversal_zip 'tuzovakaoff/symlink.zip'
+      end
+      refute File.exist?('/tmp/file.txt')
+    end
+  end
+
+  def test_entry_name_with_tilde
+    in_tmpdir do
+      extract_path_traversal_zip 'tilde.zip'
+      assert File.exist?('~tilde~')
+    end
+  end
+end

data/test/samples/example_recursive_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'fileutils'
+require_relative '../../samples/example_recursive'
+
+class ExampleRecursiveTest < MiniTest::Test
+  DIRECTORY_TO_ZIP  = 'test/data/globTest'
+  OUTPUT_DIRECTORY  = 'test/data/example_recursive.zip'
+  TEMP_DIRECTORY    = 'test/data/tmp'
+
+  def setup
+    @generator = ::ZipFileGenerator.new(DIRECTORY_TO_ZIP, OUTPUT_DIRECTORY)
+  end
+
+  def teardown
+    FileUtils.rm_rf TEMP_DIRECTORY
+    FileUtils.rm_f OUTPUT_DIRECTORY
+  end
+
+  def test_write
+    @generator.write
+    unzip
+    assert_equal Dir.entries(DIRECTORY_TO_ZIP).sort, Dir.entries(TEMP_DIRECTORY).sort
+  end
+
+  private
+
+  def unzip(file = OUTPUT_DIRECTORY)
+    Zip::File.open(file) do |zip_file|
+      zip_file.each do |f|
+        file_path = File.join(TEMP_DIRECTORY, f.name)
+        FileUtils.mkdir_p(File.dirname(file_path))
+
+        zip_file.extract(f, file_path) unless File.exist?(file_path)
+      end
+    end
+  end
+end

data/test/settings_test.rb

@@ -1,10 +1,10 @@
 require 'test_helper'
 
 class ZipSettingsTest < MiniTest::Test
-  # TODO Refactor out into common test module
+  # TODO: Refactor out into common test module
   include CommonZipFileFixture
 
-  TEST_OUT_NAME = "test/data/generated/emptyOutDir"
+  TEST_OUT_NAME = 'test/data/generated/emptyOutDir'
 
   def setup
     super
@@ -18,27 +18,26 @@ class ZipSettingsTest < MiniTest::Test
   end
 
   def open_zip(&aProc)
-    assert(aProc != nil)
+    assert(!aProc.nil?)
     ::Zip::File.open(TestZipFile::TEST_ZIP4.zip_name, &aProc)
   end
 
   def extract_test_dir(&aProc)
-    open_zip {
-        |zf|
+    open_zip do |zf|
       zf.extract(TestFiles::EMPTY_TEST_DIR, TEST_OUT_NAME, &aProc)
-    }
+    end
   end
 
   def test_true_on_exists_proc
     Zip.on_exists_proc = true
-    File.open(TEST_OUT_NAME, "w") { |f| f.puts "something" }
+    File.open(TEST_OUT_NAME, 'w') { |f| f.puts 'something' }
     extract_test_dir
     assert(File.directory?(TEST_OUT_NAME))
   end
 
   def test_false_on_exists_proc
     Zip.on_exists_proc = false
-    File.open(TEST_OUT_NAME, "w") { |f| f.puts "something" }
+    File.open(TEST_OUT_NAME, 'w') { |f| f.puts 'something' }
     assert_raises(Zip::DestinationFileExistsError) { extract_test_dir }
   end
 
@@ -47,7 +46,7 @@ class ZipSettingsTest < MiniTest::Test
 
     assert_raises(::Zip::EntryExistsError) do
       ::Zip::File.open(TEST_ZIP.zip_name) do |zf|
-        zf.add(zf.entries.first.name, "test/data/file2.txt")
+        zf.add(zf.entries.first.name, 'test/data/file2.txt')
       end
     end
   end
@@ -59,11 +58,11 @@ class ZipSettingsTest < MiniTest::Test
 
     ::Zip::File.open(TEST_ZIP.zip_name) do |zf|
       replacedEntry = zf.entries.first.name
-      zf.add(replacedEntry, "test/data/file2.txt")
+      zf.add(replacedEntry, 'test/data/file2.txt')
     end
 
     ::Zip::File.open(TEST_ZIP.zip_name) do |zf|
-      assert_contains(zf, replacedEntry, "test/data/file2.txt")
+      assert_contains(zf, replacedEntry, 'test/data/file2.txt')
     end
   end
 
@@ -71,7 +70,9 @@ class ZipSettingsTest < MiniTest::Test
     test_file = File.join(File.dirname(__FILE__), 'data', 'WarnInvalidDate.zip')
     Zip.warn_invalid_date = false
 
-    ::Zip::File.open(test_file) do |zf|
+    assert_output('', '') do
+      ::Zip::File.open(test_file) do |_zf|
+      end
     end
   end
 
@@ -79,14 +80,16 @@ class ZipSettingsTest < MiniTest::Test
     test_file = File.join(File.dirname(__FILE__), 'data', 'WarnInvalidDate.zip')
     Zip.warn_invalid_date = true
 
-    ::Zip::File.open(test_file) do |zf|
+    assert_output('', /Invalid date\/time in zip entry/) do
+      ::Zip::File.open(test_file) do |_zf|
+      end
     end
   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_entryContents(zf, entryName, filename) if File.exist?(filename)
+    assert_entry_contents(zf, entryName, filename) if File.exist?(filename)
   end
 end

data/test/test_helper.rb

@@ -9,6 +9,11 @@ require 'gentestfiles'
 TestFiles.create_test_files
 TestZipFile.create_test_zips
 
+if defined? JRUBY_VERSION
+  require 'jruby'
+  JRuby.objectspace = true
+end
+
 ::MiniTest.after_run do
   FileUtils.rm_rf('test/data/generated')
 end
@@ -21,7 +26,7 @@ module IOizeString
     count = size unless count
     retVal = slice(@tell, count)
     @tell += count
-    return retVal
+    retVal
   end
 
   def seek(index, offset)
@@ -34,12 +39,12 @@ module IOizeString
     when IO::SEEK_CUR
       newPos = @tell + index
     else
-      raise "Error in test method IOizeString::seek"
+      raise 'Error in test method IOizeString::seek'
     end
-    if (newPos < 0 || newPos >= size)
+    if newPos < 0 || newPos >= size
       raise Errno::EINVAL
     else
-      @tell=newPos
+      @tell = newPos
     end
   end
 
@@ -51,7 +56,7 @@ end
 module DecompressorTests
   # expects @refText, @refLines and @decompressor
 
-  TEST_FILE = "test/data/file1.txt"
+  TEST_FILE = 'test/data/file1.txt'
 
   def setup
     @refText = ''
@@ -59,11 +64,11 @@ module DecompressorTests
     @refLines = @refText.split($/)
   end
 
-  def test_readEverything
+  def test_read_everything
     assert_equal(@refText, @decompressor.sysread)
   end
 
-  def test_readInChunks
+  def test_read_in_chunks
     chunkSize = 5
     while (decompressedChunk = @decompressor.sysread(chunkSize))
       assert_equal(@refText.slice!(0, chunkSize), decompressedChunk)
@@ -71,22 +76,19 @@ module DecompressorTests
     assert_equal(0, @refText.size)
   end
 
-  def test_mixingReadsAndProduceInput
+  def test_mixing_reads_and_produce_input
     # Just some preconditions to make sure we have enough data for this test
     assert(@refText.length > 1000)
     assert(@refLines.length > 40)
 
-
     assert_equal(@refText[0...100], @decompressor.sysread(100))
 
     assert(!@decompressor.input_finished?)
     buf = @decompressor.produce_input
-    assert_equal(@refText[100...(100+buf.length)], buf)
+    assert_equal(@refText[100...(100 + buf.length)], buf)
   end
 end
 
-
-
 module AssertEntry
   def assert_next_entry(filename, zis)
     assert_entry(filename, zis, zis.get_next_entry.name)
@@ -94,33 +96,32 @@ module AssertEntry
 
   def assert_entry(filename, zis, entryName)
     assert_equal(filename, entryName)
-    assert_entryContentsForStream(filename, zis, entryName)
+    assert_entry_contents_for_stream(filename, zis, entryName)
   end
 
-  def assert_entryContentsForStream(filename, zis, entryName)
-    File.open(filename, "rb") {
-        |file|
+  def assert_entry_contents_for_stream(filename, zis, entryName)
+    File.open(filename, 'rb') do |file|
       expected = file.read
       actual = zis.read
-      if (expected != actual)
-        if ((expected && actual) && (expected.length > 400 || actual.length > 400))
-          zipEntryFilename=entryName+".zipEntry"
-          File.open(zipEntryFilename, "wb") { |entryfile| entryfile << actual }
+      if expected != actual
+        if (expected && actual) && (expected.length > 400 || actual.length > 400)
+          zipEntryFilename = entryName + '.zipEntry'
+          File.open(zipEntryFilename, 'wb') { |entryfile| entryfile << actual }
           fail("File '#{filename}' is different from '#{zipEntryFilename}'")
         else
           assert_equal(expected, actual)
         end
       end
-    }
+    end
   end
 
-  def AssertEntry.assert_contents(filename, aString)
-    fileContents = ""
-    File.open(filename, "rb") { |f| fileContents = f.read }
-    if (fileContents != aString)
-      if (fileContents.length > 400 || aString.length > 400)
-        stringFile = filename + ".other"
-        File.open(stringFile, "wb") { |f| f << aString }
+  def self.assert_contents(filename, aString)
+    fileContents = ''
+    File.open(filename, 'rb') { |f| fileContents = f.read }
+    if fileContents != aString
+      if fileContents.length > 400 || aString.length > 400
+        stringFile = filename + '.other'
+        File.open(stringFile, 'wb') { |f| f << aString }
         fail("File '#{filename}' is different from contents of string stored in '#{stringFile}'")
       else
         assert_equal(fileContents, aString)
@@ -129,11 +130,11 @@ module AssertEntry
   end
 
   def assert_stream_contents(zis, testZipFile)
-    assert(zis != nil)
+    assert(!zis.nil?)
     testZipFile.entry_names.each do |entryName|
       assert_next_entry(entryName, zis)
     end
-    assert_equal(nil, zis.get_next_entry)
+    assert_nil(zis.get_next_entry)
   end
 
   def assert_test_zip_contents(testZipFile)
@@ -142,27 +143,25 @@ module AssertEntry
     end
   end
 
-  def assert_entryContents(zipFile, entryName, filename = entryName.to_s)
+  def assert_entry_contents(zipFile, entryName, filename = entryName.to_s)
     zis = zipFile.get_input_stream(entryName)
-    assert_entryContentsForStream(filename, zis, entryName)
+    assert_entry_contents_for_stream(filename, zis, entryName)
   ensure
     zis.close if zis
   end
 end
 
-
 module CrcTest
-
   class TestOutputStream
     include ::Zip::IOExtras::AbstractOutputStream
 
     attr_accessor :buffer
 
     def initialize
-      @buffer = ""
+      @buffer = ''
     end
 
-    def << (data)
+    def <<(data)
       @buffer << data
       self
     end
@@ -178,26 +177,23 @@ module CrcTest
   end
 end
 
-
 module Enumerable
   def compare_enumerables(otherEnumerable)
     otherAsArray = otherEnumerable.to_a
-    each_with_index {
-        |element, index|
+    each_with_index do |element, index|
       return false unless yield(element, otherAsArray[index])
-    }
-    return self.size == otherAsArray.size
+    end
+    size == otherAsArray.size
   end
 end
 
-
 module CommonZipFileFixture
   include AssertEntry
 
-  EMPTY_FILENAME = "emptyZipFile.zip"
+  EMPTY_FILENAME = 'emptyZipFile.zip'
 
   TEST_ZIP = TestZipFile::TEST_ZIP2.clone
-  TEST_ZIP.zip_name = "test/data/generated/5entry_copy.zip"
+  TEST_ZIP.zip_name = 'test/data/generated/5entry_copy.zip'
 
   def setup
     File.delete(EMPTY_FILENAME) if File.exist?(EMPTY_FILENAME)
@@ -205,9 +201,7 @@ module CommonZipFileFixture
   end
 end
 
-
 module ExtraAssertions
-
   def assert_forwarded(anObject, method, retVal, *expectedArgs)
     callArgs = nil
     setCallArgsProc = proc { |args| callArgs = args }
@@ -224,5 +218,17 @@ module ExtraAssertions
   ensure
     anObject.instance_eval "undef #{method}; alias #{method} #{method}_org"
   end
+end
 
+module ZipEntryData
+  TEST_ZIPFILE = 'someZipFile.zip'
+  TEST_COMMENT = 'a comment'
+  TEST_COMPRESSED_SIZE = 1234
+  TEST_CRC = 325_324
+  TEST_EXTRA = 'Some data here'
+  TEST_COMPRESSIONMETHOD = ::Zip::Entry::DEFLATED
+  TEST_NAME = 'entry name'
+  TEST_SIZE = 8432
+  TEST_ISDIRECTORY = false
+  TEST_TIME = Time.now
 end