Summary

Add CSFLE/QE examples prose tests to help provide starter code.

Motivation

I often use old PyMongo examples to help test out CSFLE/QE behavior. The examples are copy-paste friendly and help me quickly get working code. These examples are expected to be restored in DOCSP-55314. This ticket proposes adding consistent examples within drivers to be:

• Tested in CI.
• Copy-paste friendly.
• Idempotent.

Adding these examples to the spec may also help serve as added documentation (resolving DRIVERS-1679).

Who is the affected end user?

Examples would be primarily intended for internal users (e.g. docs team, product managers, newer team members).

How does this affect the end user?

Anecdotally: I have heard repeated difficulties getting started with QE. Even internal users familiar with the components have had trouble getting started. This was additionally mentioned as a frequent pain in the Client-Libraries Offsite.

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

Certain?

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

Frustration and difficulty getting started with CSFLE/QE.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

Yes.

Acceptance Criteria

TBD. Initial proposal: For both CSFLE and QE: auto encryption/decryption. Explicit encryption/decryption. Configuring client-side schema maps.

• Add prose tests to the CSFLE/QE spec for getting started examples.