Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-12028

BadApple and AwaitsFix annotations usage



    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Tests
    • Labels:


      There's a long discussion of this topic at SOLR-12016. Here's a summary:

      • BadApple annotations are used for tests that intermittently fail, say < 30% of the time. Tests that fail more often shold be moved to AwaitsFix. This is, of course, a judgement call
      • AwaitsFix annotations are used for tests that, for some reason, the problem can't be fixed immediately. Likely reasons are third-party dependencies, extreme difficulty tracking down, dependency on another JIRA etc.

      Jenkins jobs will typically run with BadApple disabled to cut down on noise. Periodically Jenkins jobs will be run with BadApples enabled so BadApple tests won't be lost and reports can be generated. Tests that run with BadApples disabled that fail require immediate attention.

      The default for developers is that BadApple is enabled.

      If you are working on one of these tests and cannot get the test to fail locally, it is perfectly acceptable to comment the annotation out. You should let the dev list know that this is deliberate.

      This JIRA is a placeholder for BadApple tests to point to between the times they're identified as BadApple and they're either fixed or changed to AwaitsFix or assigned their own JIRA.

      I've assigned this to myself to track so I don't lose track of it. No one person will fix all of these issues, this will be an ongoing technical debt cleanup effort.


        1. SOLR-12016-buildsystem.patch
          4 kB
          Erick Erickson
        2. SOLR-12028.patch
          40 kB
          Erick Erickson
        3. SOLR-12028.patch
          30 kB
          Erick Erickson
        4. SOLR-12028-3-Mar.patch
          31 kB
          Erick Erickson
        5. SOLR-12028-sysprops-reproduce.patch
          3 kB
          Uwe Schindler

          Issue Links



              • Assignee:
                erickerickson Erick Erickson
                erickerickson Erick Erickson
              • Votes:
                0 Vote for this issue
                10 Start watching this issue


                • Created: