[DRIVERS-2259] Test case descriptions should have unique names within the same file Created: 31/Mar/22  Updated: 26/Jul/22

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

Type: Spec Change 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

Ensuring that each test case description has a unique name within the test file will ensure that we can uniquely identify test cases within a test suite (e.g. by considering the test case description alongside the test file description or, if that is not sufficiently unique, the test file path). Uniquely identifying tests is helpful when drivers need to skip certain tests (see: mongo-php-library).

Since this is not something we can enforce in the schema, SHOULD terminology would be most appropriate (per: Design Rationale).

Motivation

Who is the affected end user?

Drivers.

How does this affect the end user?

This guidance is already followed today but we do not explicitly document it.

How likely is it that this problem or use case will occur?

There is nothing preventing this from happening today.

If the problem does occur, what are the consequences and how severe are they?

This would be a minor annoyance for drivers that rely on uniquely identifying tests, as they might need to identify tests by some other label instead (e.g. combining description plus some offset within the test file).

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:07 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.