Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-64790

Require jstest tags to be documented

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Major - P3 Major - P3
    • None
    • None
    • None
    • None
    • Correctness

    Description

      This ticket is to require tags to be documented, e.g. by having a "tags documentation" file and rejecting a jstest that has an undocumented tag.

      Each test should have a comment above each tag that explains why it's using the tag, but that comment shouldn't need to explain what the tag is for. For example, a test could have "requires_persistence" with comment "This test restarts the tenant migration donor primary", and "requires_persistence" could be documented as "excludes the test from running with the inMemory storage engine."

      This would be especially helpful because we often write new jstests by copying old ones, and it's hard to tell if we should carry over all the existing tags.

      Attachments

        Activity

          People

            devprod-correctness-team@mongodb.com [DO NOT ASSIGN] Backlog - DevProd Correctness
            esha.maharishi@mongodb.com Esha Maharishi (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

            Dates

              Created:
              Updated: