Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2289

Add linting and/or style guide for writing unified YAML spec tests

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Unknown Unknown
    • None
    • Unified Test Runner
    • None
    • Not Needed

    Description

      Summary

      Add a YAML linter (e.g. yamllint) to the GitHub CI pipeline to help enforce some consistency between unified spec test files. Ideally, the linter should be configurable so we can be flexible (e.g. allow objects to be inlined but perhaps up to a certain line length).

      If it's not feasible to add a linter, or if that doesn't address all of our needs, then we should consider writing a style guide for spec tests.

      Motivation

      Who is the affected end user?

      Spec test authors.

      How does this affect the end user?

      There is confusion around how to write spec tests, which can lead to inconsistent formatting between different files. See this comment in mongodb/specifications#1182 for context.

      Is this issue urgent?

      No.

      Is this ticket required by a downstream team?

      No.

      Is this ticket only for tests?

      Yes.

      Attachments

        Activity

          People

            Unassigned Unassigned
            jmikola@mongodb.com Jeremy Mikola
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: