Add `setUserWriteBlockMode` tests by alinaliBQ · Pull Request #658 · documentdb/functional-tests

alinaliBQ · 2026-06-29T22:00:33Z

Add command operator tests for setUserWriteBlockMode. Tests database setUserWriteBlockMode behavior, output collection, syntax, and errors. This PR adds AdminTestCase. Uses helper function force_disable_write_block.
Worked with @vic-tsang to get initial set of tests to work with.

Add compatibility test for setUserWriteBlockMode #433

documentdb-triage-tool · 2026-06-29T22:46:01Z

🤖 Auto-triaged by documentdb-triage-tool.

Applied: compatibility test, enhancement
Project fields suggested: Component test-coverage · Priority P2 · Effort L · Status Needs Review
Confidence: 0.30 (deterministic)

Reasoning

component from path globs (test-coverage, test-framework); effort from diff stats (796+0 LOC, 11 files); LLM failed: Invalid response body while trying to fetch https://api.anthropic.com/v1/messages: Premature close

If a label is wrong, remove it manually and ping @patty-chow so the rules can be tuned. The bot will not re-label items that already have component labels.

manojnks · 2026-07-02T17:32:29Z

+        "DiskUseThresholdExceeded",
+    ]:
+        try:
+            admin.command({"setUserWriteBlockMode": 1, "global": False, "reason": reason})


why will this work not the previous whouldnt work?

This would work because reason is provided. The previous command tries to do it without providing the reason that was used to enable the write block mode.
I added documentation comment for this.

manojnks · 2026-07-02T17:40:29Z

+def test_setUserWriteBlockMode_disable_when_no_block_active(collection):
+    """Test setUserWriteBlockMode global:false when no block is active succeeds."""
+    result = execute_admin_command(collection, {"setUserWriteBlockMode": 1, "global": False})
+    assertSuccessPartial(


should we additional test with actual write whether its blocking or not

sure, added "n": 1 check to ensure insert succeeded and it is not blocking. We also have blocking tests in test_setUserWriteBlockMode_write_block_enforcement.py

manojnks · 2026-07-02T17:46:00Z

+    assertSuccessPartial(
+        result,
+        {"ok": 1.0},
+        msg="setUserWriteBlockMode should be idempotent with same explicit reason",


DiskUseThresholdExceeded add this test case well

Added test_setUserWriteBlockMode_same_reason_disk_threshold_idempotent test

manojnks · 2026-07-02T17:46:18Z

+        result,
+        ILLEGAL_OPERATION_ERROR,
+        msg="setUserWriteBlockMode should reject mismatched reason on disable",
+    )


DiskUseThresholdExceeded this here as well

added test_setUserWriteBlockMode_disable_mismatched_reason_disk_threshold_fails test

manojnks · 2026-07-02T17:47:54Z

+GLOBAL_VALID_TESTS: list[AdminTestCase] = [
+    AdminTestCase(
+        "global_true",
+        command=lambda ctx: {"setUserWriteBlockMode": 1, "global": True},
+        expected={"ok": 1.0},
+        msg="setUserWriteBlockMode should accept global:true",
+    ),
+    AdminTestCase(
+        "global_false",
+        command=lambda ctx: {"setUserWriteBlockMode": 1, "global": False},
+        expected={"ok": 1.0},
+        msg="setUserWriteBlockMode should accept global:false",
+    ),
+]
+
+# Property [Reason Field Valid Values]: setUserWriteBlockMode accepts valid reason enum strings.
+REASON_VALID_TESTS: list[AdminTestCase] = [
+    AdminTestCase(
+        f"reason_{tid}",
+        command=lambda ctx, r=reason: {
+            "setUserWriteBlockMode": 1,
+            "global": True,
+            "reason": r,
+        },
+        expected={"ok": 1.0},
+        msg=f"setUserWriteBlockMode should accept reason:{reason}",
+    )
+    for tid, reason in [
+        ("unspecified", "Unspecified"),
+        ("cluster_migration", "ClusterToClusterMigrationInProgress"),
+        ("disk_threshold", "DiskUseThresholdExceeded"),
+    ]
+]


already tested.

removed GLOBAL_VALID_TESTS and REASON_VALID_TESTS

manojnks · 2026-07-02T17:48:49Z

+        ("disk_threshold", "DiskUseThresholdExceeded"),
+    ]
+]
+


consider write operation as assertion criteria

added reason_null_treated_as_omitted to verify that write can succeed after setUserWriteBlockMode is disabled.

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

alinaliBQ

addressed comments

alinaliBQ · 2026-07-03T19:09:02Z

+GLOBAL_VALID_TESTS: list[AdminTestCase] = [
+    AdminTestCase(
+        "global_true",
+        command=lambda ctx: {"setUserWriteBlockMode": 1, "global": True},
+        expected={"ok": 1.0},
+        msg="setUserWriteBlockMode should accept global:true",
+    ),
+    AdminTestCase(
+        "global_false",
+        command=lambda ctx: {"setUserWriteBlockMode": 1, "global": False},
+        expected={"ok": 1.0},
+        msg="setUserWriteBlockMode should accept global:false",
+    ),
+]
+
+# Property [Reason Field Valid Values]: setUserWriteBlockMode accepts valid reason enum strings.
+REASON_VALID_TESTS: list[AdminTestCase] = [
+    AdminTestCase(
+        f"reason_{tid}",
+        command=lambda ctx, r=reason: {
+            "setUserWriteBlockMode": 1,
+            "global": True,
+            "reason": r,
+        },
+        expected={"ok": 1.0},
+        msg=f"setUserWriteBlockMode should accept reason:{reason}",
+    )
+    for tid, reason in [
+        ("unspecified", "Unspecified"),
+        ("cluster_migration", "ClusterToClusterMigrationInProgress"),
+        ("disk_threshold", "DiskUseThresholdExceeded"),
+    ]
+]


removed GLOBAL_VALID_TESTS and REASON_VALID_TESTS

alinaliBQ · 2026-07-03T19:20:41Z

+        "DiskUseThresholdExceeded",
+    ]:
+        try:
+            admin.command({"setUserWriteBlockMode": 1, "global": False, "reason": reason})


This would work because reason is provided. The previous command tries to do it without providing the reason that was used to enable the write block mode.
I added documentation comment for this.

alinaliBQ · 2026-07-03T19:25:49Z

+def test_setUserWriteBlockMode_disable_when_no_block_active(collection):
+    """Test setUserWriteBlockMode global:false when no block is active succeeds."""
+    result = execute_admin_command(collection, {"setUserWriteBlockMode": 1, "global": False})
+    assertSuccessPartial(


sure, added "n": 1 check to ensure insert succeeded and it is not blocking. We also have blocking tests in test_setUserWriteBlockMode_write_block_enforcement.py

alinaliBQ · 2026-07-03T19:26:16Z

+    assertSuccessPartial(
+        result,
+        {"ok": 1.0},
+        msg="setUserWriteBlockMode should be idempotent with same explicit reason",


Added test_setUserWriteBlockMode_same_reason_disk_threshold_idempotent test

alinaliBQ · 2026-07-03T19:26:47Z

+        result,
+        ILLEGAL_OPERATION_ERROR,
+        msg="setUserWriteBlockMode should reject mismatched reason on disable",
+    )


added test_setUserWriteBlockMode_disable_mismatched_reason_disk_threshold_fails test

alinaliBQ · 2026-07-03T19:38:04Z

+        ("disk_threshold", "DiskUseThresholdExceeded"),
+    ]
+]
+


added reason_null_treated_as_omitted to verify that write can succeed after setUserWriteBlockMode is disabled.

alinaliBQ marked this pull request as ready for review June 29, 2026 22:27

alinaliBQ requested a review from a team as a code owner June 29, 2026 22:27

documentdb-triage-tool Bot added compatibility test Compatibility test related enhancement New feature or request labels Jun 29, 2026

manojnks reviewed Jul 2, 2026

View reviewed changes

alinaliBQ added 10 commits July 3, 2026 10:48

initial generated setUserWriteBlockMode tests

270ac43

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

change according to review

3309c88

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

add AdminTestCase

c71149b

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

convert _enforcement.py

6b89217

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

move force_disable_write_block to a common place

ac47795

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

blocked_bulkWrite

8d3a2aa

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

split test cases

c3dcbd4

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

remove duplicate

7ed1d1c

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

fix tests to check results

1e11ebf

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

merge test func

4987209

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

alinaliBQ force-pushed the setUserWriteBlockMode branch from 34389ff to 4987209 Compare July 3, 2026 17:48

alinaliBQ added 2 commits July 3, 2026 12:18

address review comments

1f740b8

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

add reason_null_treated_as_omitted

14de0a6

Signed-off-by: Alina (Xi) Li <Alina.Li@improving.com>

alinaliBQ commented Jul 3, 2026

View reviewed changes

manojnks approved these changes Jul 4, 2026

View reviewed changes

Uh oh!

Conversation

alinaliBQ commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

documentdb-triage-tool Bot commented Jun 29, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alinaliBQ left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alinaliBQ commented Jun 29, 2026 •

edited

Loading