[DRIVERS-2289] Add linting and/or style guide for writing unified YAML spec tests Created: 22/Apr/22  Updated: 26/Jul/22

Status: Backlog
Project: Drivers
Component/s: Unified Test Runner
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Jeremy Mikola Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Driver Changes: 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.


Generated at Thu Feb 08 08:25:12 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.