[DRIVERS-2360] Ensure "does not fail" in CSE Prose Test 13 accounts for (no) matching documents Created: 16/Jun/22  Updated: 07/Apr/23  Resolved: 07/Apr/23

Status: Closed
Project: Drivers
Component/s: None
Fix Version/s: None

Type: Improvement Priority: Unknown
Reporter: Ezra Chung Assignee: Ezra Chung
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split to PHPLIB-897 Ensure "does not fail" in CSE Prose T... Closed
split to CDRIVER-4407 Ensure "does not fail" in CSE Prose T... Closed
split to CSHARP-4215 Ensure "does not fail" in CSE Prose T... Closed
split to CXX-2528 Ensure "does not fail" in CSE Prose T... Closed
split to GODRIVER-2462 Ensure "does not fail" in CSE Prose T... Closed
split to JAVA-4651 Ensure "does not fail" in CSE Prose T... Closed
split to MOTOR-982 Ensure "does not fail" in CSE Prose T... Closed
split to NODE-4314 Ensure "does not fail" in CSE Prose T... Closed
split to PYTHON-3306 Ensure "does not fail" in CSE Prose T... Closed
split to RUBY-3029 Ensure "does not fail" in CSE Prose T... Closed
split to RUST-1367 Ensure "does not fail" in CSE Prose T... Closed
Related
is related to DRIVERS-2017 Add ClientEncryption entity and Key M... Closed
Epic Link: Key Management API
Driver Changes: Needed
Quarter: FY23Q2
Downstream Changes Summary:

Ensure implementations of Client Side Encryption Prose Test 13 assert the result of addKeyAltName() operations as specified in 50e26feb.

Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4407 Fixed 1.22.0
CXX-2528 Done 3.8.0
CSHARP-4215 Fixed 2.17.0
GODRIVER-2462 Done
JAVA-4651 Done
NODE-4314 Fixed 4.9.0
MOTOR-982 Duplicate
PYTHON-3306 Duplicate
PHPLIB-897 Fixed 1.15.0
RUBY-3029 Fixed 2.18.0
RUST-1367 Duplicate
SWIFT-1585 Duplicate

 Description   

Summary

The current wording in Client Side Encryption Prose Test 13 requires certain addKeyAltName() operations "does not fail". However, this description does not take into account potential failure to find a matching document to add a keyAltName to, which also satisfies the "does not fail" condition (returning a null value instead of the previous state of the matched key document).

The prose test description should be improved to ensure the addKeyAltName() operations are succeeding because it successfully found and added a keyAltName  to a matching document, not because it did not find a matching document.

Motivation

Who is the affected end user?

Drivers that have implemented, or will implement, CSE Prose Test 13.

How does this affect the end user?

Drivers' implementation of CSE Prose Test 13 will need to assert the result of addKeyAltName() operations include the keyAltName added in a previous operation if they are not already doing so.

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

During implementation, Drivers might construct an incorrect filter argument to addKeyAltName() and fail to correctly test the success conditions intended by the prose test. This is more likely on Drivers that must convert to/from Native UUID Types.

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

Minor.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

Yes.



 Comments   
Comment by Githook User [ 16/Jun/22 ]

Author:

{'name': 'Ezra Chung', 'email': '88335979+eramongodb@users.noreply.github.com', 'username': 'eramongodb'}

Message: DRIVERS-2360 Add assertions that addKeyAltName() added keyAltName without failure (#1256)
Branch: master
https://github.com/mongodb/specifications/commit/50e26febfaa89457716f486e330533336b2cd5b6

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