Add setQuerySettings tests
#610
There are no files selected for viewing
File renamed without changes.
Empty file.
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,376 @@ | ||
| """Tests for setQuerySettings command behavioral verification. | ||
|
|
||
| Validates that query settings are retrievable via $querySettings aggregation | ||
| stage, removable via removeQuerySettings, and that the response structure | ||
| includes expected fields like queryShapeHash and representativeQuery. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import pytest | ||
|
|
||
| from documentdb_tests.compatibility.tests.core.query_planning.utils.settings_test_case import ( | ||
| SettingsTestCase, | ||
| ) | ||
| from documentdb_tests.compatibility.tests.core.utils.command_test_case import ( | ||
| CommandContext, | ||
| ) | ||
| from documentdb_tests.framework.assertions import assertSuccessPartial | ||
| from documentdb_tests.framework.executor import execute_admin_command | ||
| from documentdb_tests.framework.parametrize import pytest_params | ||
|
|
||
| from .utils.setQuerySettings_common import get_query_settings | ||
|
|
||
| # Property [Response Structure]: setQuerySettings response includes hash, query, and settings. | ||
| SET_QUERY_SETTINGS_RESPONSE_TESTS: list[SettingsTestCase] = [ | ||
| SettingsTestCase( | ||
| "response_contains_hash", | ||
| command=lambda ctx: { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b1": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| }, | ||
| expected={"ok": 1.0}, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b1": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="response should contain queryShapeHash", | ||
| ), | ||
| SettingsTestCase( | ||
| "response_contains_representative_query", | ||
| command=lambda ctx: { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b2": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| }, | ||
| expected={"ok": 1.0}, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b2": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="response should contain representativeQuery", | ||
| ), | ||
| SettingsTestCase( | ||
| "response_settings_echo", | ||
| command=lambda ctx: { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b3": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| }, | ||
| expected=lambda ctx: { | ||
| "ok": 1.0, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| }, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b3": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="response should echo applied settings", | ||
| ), | ||
| ] | ||
|
|
||
|
|
||
| @pytest.mark.admin | ||
| @pytest.mark.replica_set | ||
| @pytest.mark.parametrize("test", pytest_params(SET_QUERY_SETTINGS_RESPONSE_TESTS)) | ||
| def test_setQuerySettings_response(collection, test): | ||
| """Test setQuerySettings response structure.""" | ||
| ctx = CommandContext.from_collection(collection) | ||
| try: | ||
| result = execute_admin_command(collection, test.build_command(ctx)) | ||
| expected = test.build_expected(ctx) | ||
| # Also verify the dynamic fields are present | ||
| if test.id == "response_contains_hash": | ||
| expected["queryShapeHash"] = result.get("queryShapeHash") | ||
| elif test.id == "response_contains_representative_query": | ||
| expected["representativeQuery"] = result.get("representativeQuery") | ||
| assertSuccessPartial(result, expected, msg=test.msg) | ||
| finally: | ||
| for cmd in test.build_cleanup(ctx): | ||
| try: | ||
| execute_admin_command(collection, cmd) | ||
| except Exception: | ||
| pass | ||
|
|
||
|
|
||
| # Property [removeQuerySettings]: settings can be removed by query or hash. | ||
| SET_QUERY_SETTINGS_REMOVE_TESTS: list[SettingsTestCase] = [ | ||
| SettingsTestCase( | ||
| "removeQuerySettings_by_query", | ||
| setup_commands=lambda ctx: [ | ||
| { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b5": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| } | ||
| ], | ||
| command=lambda ctx: { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b5": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| }, | ||
| expected={"ok": 1.0}, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b5": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="removeQuerySettings by query should succeed", | ||
| ), | ||
| SettingsTestCase( | ||
| "removeQuerySettings_by_hash", | ||
| setup_commands=lambda ctx: [ | ||
| { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b6": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| } | ||
| ], | ||
| command=lambda ctx: {"removeQuerySettings": ctx.setup_results[0]["queryShapeHash"]}, | ||
| expected={"ok": 1.0}, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b6": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="removeQuerySettings by hash should succeed", | ||
| ), | ||
| ] | ||
|
|
||
|
|
||
| @pytest.mark.admin | ||
| @pytest.mark.replica_set | ||
| @pytest.mark.parametrize("test", pytest_params(SET_QUERY_SETTINGS_REMOVE_TESTS)) | ||
|
Contributor
Author
There was a problem hiding this comment.
|
||
| def test_setQuerySettings_remove(collection, test): | ||
| """Test removeQuerySettings removes settings.""" | ||
| ctx = CommandContext.from_collection(collection) | ||
| try: | ||
| for cmd in test.build_setup(ctx): | ||
| r = execute_admin_command(collection, cmd) | ||
| ctx.setup_results.append(r) | ||
| result = execute_admin_command(collection, test.build_command(ctx)) | ||
| assertSuccessPartial(result, test.build_expected(ctx), msg=test.msg) | ||
| finally: | ||
| for cmd in test.build_cleanup(ctx): | ||
| try: | ||
| execute_admin_command(collection, cmd) | ||
| except Exception: | ||
| pass | ||
|
|
||
|
|
||
| # Property [$querySettings Retrieval]: settings are visible via $querySettings aggregation stage. | ||
| SET_QUERY_SETTINGS_QS_STAGE_TESTS: list[SettingsTestCase] = [ | ||
| SettingsTestCase( | ||
| "querySettings_stage_retrieval", | ||
| setup_commands=lambda ctx: [ | ||
| { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b4": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| } | ||
| ], | ||
| expected=lambda ctx: {"queryShapeHash": ctx.setup_results[0]["queryShapeHash"]}, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b4": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="$querySettings should return the created setting", | ||
| ), | ||
| SettingsTestCase( | ||
| "querySettings_stage_shows_settings", | ||
| setup_commands=lambda ctx: [ | ||
| { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b9": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| } | ||
| ], | ||
| expected=lambda ctx: { | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| }, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b9": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="$querySettings should include indexHints in settings", | ||
| ), | ||
| SettingsTestCase( | ||
| "querySettings_stage_shows_representative_query", | ||
| setup_commands=lambda ctx: [ | ||
| { | ||
| "setQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b10": 1}, | ||
| "$db": ctx.database, | ||
| }, | ||
| "settings": { | ||
| "indexHints": [ | ||
| { | ||
| "ns": {"db": ctx.database, "coll": ctx.collection}, | ||
| "allowedIndexes": ["_id_"], | ||
| } | ||
| ], | ||
| }, | ||
| } | ||
| ], | ||
| # expected is built dynamically in the runner (self-referential) | ||
| expected=None, | ||
| cleanup=lambda ctx: [ | ||
| { | ||
| "removeQuerySettings": { | ||
| "find": ctx.collection, | ||
| "filter": {"b10": 1}, | ||
| "$db": ctx.database, | ||
| } | ||
| } | ||
| ], | ||
| msg="$querySettings should include representativeQuery", | ||
| ), | ||
| ] | ||
|
|
||
|
|
||
| @pytest.mark.admin | ||
| @pytest.mark.replica_set | ||
| @pytest.mark.parametrize("test", pytest_params(SET_QUERY_SETTINGS_QS_STAGE_TESTS)) | ||
| def test_setQuerySettings_qs_stage(collection, test): | ||
| """Test that settings are visible via $querySettings aggregation stage.""" | ||
| ctx = CommandContext.from_collection(collection) | ||
| try: | ||
| for cmd in test.build_setup(ctx): | ||
| r = execute_admin_command(collection, cmd) | ||
| ctx.setup_results.append(r) | ||
| expected_hash = ctx.setup_results[0]["queryShapeHash"] | ||
| settings = get_query_settings(collection) | ||
| matching = [s for s in settings if s.get("queryShapeHash") == expected_hash] | ||
| entry = matching[0] if matching else {} | ||
| expected = test.build_expected(ctx) | ||
| if expected is None: | ||
| # Self-referential: verify the field exists | ||
| expected = {"representativeQuery": entry.get("representativeQuery")} | ||
| assertSuccessPartial(entry, expected, msg=test.msg) | ||
| finally: | ||
| for cmd in test.build_cleanup(ctx): | ||
| try: | ||
| execute_admin_command(collection, cmd) | ||
| except Exception: | ||
| pass | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like this skeleton is present in most of files. Do we need a shared runner ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you clarify on what you mean by
shared runner? Currently CI is set up to use a shared mongodb instance.According to the style guide, it says the tests should be as standalone as possible and that helper functions that hide the test logic need to be avoided, so we needed to have separate
def test_*functions.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it.