Summary

When implementing the search index management prose tests, Steve discovered that the existing unified tests for search index management (which cannot be run against Atlas) did not have logic to skip themselves when run against a live Atlas cluster.  This was not an issue in Node because in special environments, Node only runs subsets of our tests.  Python, however, runs all tests and lets the tests skip themselves in environments they should not run in.

Python (and other drivers) that encounter this issue can work around this by adding special logic to skip the search index unified tests when running against an Atlas cluster, but updating the unified tests to have a `runOnRequirement` of `atlas: forbid` (or a similar mechanism) would solve the problem for all drivers.

A `runOnRequirement` of `atlas: forbid/allow` might also be useful in the future.

Motivation

Who is the affected end user?

Drivers engineers.

How does this affect the end user?

Drivers manually skip tests instead of relying on the UTR to skip the tests for them.

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

unknown - this depends on how different drivers implement their special environment testing in CI.  Python encountered this issue, Node did not.

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

Minor inconvenience, drivers need to manually skip tests in certain environments.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

Yes.

Acceptance Criteria

• Add a run on requirement to the UTR that allows/forbids tests when run against Atlas clusters.