Lucene - Core
  1. Lucene - Core
  2. LUCENE-3067

Lucene test cases do not properly close input and output instances

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: 3.1, 4.0-ALPHA
    • Fix Version/s: None
    • Component/s: general/build, general/test
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      The Lucene tests do not take care to close all file handles. Unless I am missing something, every single instance of Directory, IndexReader, IndexWriter, IndexSearcher, TermPositions, etc. should be wrapped with a try-finally pattern, such that the instance is always closed. Not doing so risks leaving files open, depending on the GC behavior. I believe this causes tests to fail with a "could not delete" exception, inconsistently. I at least observe this on a fast machine with Windows, where deletion is a little more sensitive to open handles. It seems dangerous and undesirable, anyway (again, unless I am missing something). I don't know of another pattern in Java that would actually be safe.

      Some of these objects may just happen to be safe to let dangle in the wind, until the GC reaps, but by the contracts that really can't be allowed. The close methods need to be called to release resources.

      Fixing this appears to alleviate the test failures, but it is hard to tell due to the nondeterministic behavior. I am reluctant to make up the whole patch if this is inaccurate - it is somewhat tedious. The classes involved can be instrumented to expose this problem. (In particular, I would imagine that the finalizer should never be reached without the close() methods being previously invoked.)

        Activity

        Hide
        Robert Muir added a comment -

        Hi Robert, can you provide more information on exactly which tests you are having a problem with?

        All tests wrap Directory instances via MockDirectoryWrapper.
        These Directory instances are themselves registered with LuceneTestCase, and the test will fail if you do not close the Directory.

        Furthermore, you cannot close these Directory instances themselves until open files are closed, as they track open files for this purpose. If you don't close all IndexReaders etc the test will fail.

        Show
        Robert Muir added a comment - Hi Robert, can you provide more information on exactly which tests you are having a problem with? All tests wrap Directory instances via MockDirectoryWrapper. These Directory instances are themselves registered with LuceneTestCase, and the test will fail if you do not close the Directory. Furthermore, you cannot close these Directory instances themselves until open files are closed, as they track open files for this purpose. If you don't close all IndexReaders etc the test will fail.
        Hide
        Robert Ragno added a comment -

        I believe that this is the same issue as later discovered in LUCENE-3583.

        Show
        Robert Ragno added a comment - I believe that this is the same issue as later discovered in LUCENE-3583 .
        Hide
        Uwe Schindler added a comment -

        Robert Ragno: You mean files outside managed "Lucene Directory" instances opened and not properly closed?

        Show
        Uwe Schindler added a comment - Robert Ragno: You mean files outside managed "Lucene Directory" instances opened and not properly closed?

          People

          • Assignee:
            Unassigned
            Reporter:
            Robert Ragno
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Time Tracking

              Estimated:
              Original Estimate - 4h
              4h
              Remaining:
              Remaining Estimate - 4h
              4h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Development