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

CSFLE spec tests should not specify options under an "opts" operation argument

    • Type: Icon: Spec Change Spec Change
    • Resolution: Won't Fix
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: Client Side Encryption
    • None
    • Needed

      Summary

      Quoting Expressing Required and Optional Parameters in the unified test format spec:

      Some specifications group optional parameters for API methods under an options parameter (e.g. options: Optional<UpdateOptions> in the CRUD spec); however, driver APIs vary in how they accept options (e.g. Python's keyword/named arguments, session as either an option or required parameter depending on whether a language supports method overloading). Therefore, test files SHALL declare all required and optional parameters for an API method directly within operation.arguments (e.g. upsert for updateOne is not nested under an options key).

      The CSFLE spec tests do not follow this. For example, createDataKey.yml includes an opts key within the operation's arguments object.

      This was likely an oversight in DRIVERS-2017.

      Motivation

      Is this issue urgent?

      No.

      Is this ticket required by a downstream team?

      No.

      Is this ticket only for tests?

      Yes.

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

              Created:
              Updated:
              Resolved: