Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore name of index when fetching settings #823

Merged
merged 1 commit into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Removed
### Fixed
- Fix `Transport.perform_request`'s arguments `timeout` and `ignore` variable usage ([810](https://github.com/opensearch-project/opensearch-py/pull/810))
- Fix `Index.save` not passing through aliases to the underlying index ([823](https://github.com/opensearch-project/opensearch-py/pull/823))
### Security

### Dependencies
Expand Down
17 changes: 13 additions & 4 deletions opensearchpy/_async/helpers/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from opensearchpy._async.helpers.search import AsyncSearch
from opensearchpy._async.helpers.update_by_query import AsyncUpdateByQuery
from opensearchpy.connection.async_connections import get_connection
from opensearchpy.exceptions import IllegalOperation
from opensearchpy.exceptions import IllegalOperation, ValidationException
from opensearchpy.helpers import analysis
from opensearchpy.helpers.utils import merge

Expand Down Expand Up @@ -305,9 +305,18 @@
body = self.to_dict()
settings = body.pop("settings", {})
analysis = settings.pop("analysis", None)
current_settings = (await self.get_settings(using=using))[self._name][
"settings"
]["index"]

# If _name points to an alias, the response object will contain keys with
# the index name(s) the alias points to. If the alias points to multiple
# indices, raise exception as the intention is ambiguous
settings_response = await self.get_settings(using=using)
if len(settings_response) > 1:
raise ValidationException(

Check warning on line 314 in opensearchpy/_async/helpers/index.py

View check run for this annotation

Codecov / codecov/patch

opensearchpy/_async/helpers/index.py#L312-L314

Added lines #L312 - L314 were not covered by tests
"Settings for %s point to multiple indices: %s."
% (self._name, ", ".join(list(settings_response.keys())))
)
current_settings = settings_response.popitem()[1]["settings"]["index"]

Check warning on line 318 in opensearchpy/_async/helpers/index.py

View check run for this annotation

Codecov / codecov/patch

opensearchpy/_async/helpers/index.py#L318

Added line #L318 was not covered by tests

if analysis:
if await self.is_closed(using=using):
# closed index, update away
Expand Down
17 changes: 13 additions & 4 deletions opensearchpy/helpers/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
from opensearchpy.connection.connections import get_connection
from opensearchpy.helpers import analysis

from ..exceptions import IllegalOperation
from ..exceptions import IllegalOperation, ValidationException
from .mapping import Mapping
from .search import Search
from .update_by_query import UpdateByQuery
Expand Down Expand Up @@ -326,9 +326,18 @@
body = self.to_dict()
settings = body.pop("settings", {})
analysis = settings.pop("analysis", None)
current_settings = self.get_settings(using=using)[self._name]["settings"][
"index"
]

# If _name points to an alias, the response object will contain keys with
# the index name(s) the alias points to. If the alias points to multiple
# indices, raise exception as the intention is ambiguous
settings_response = self.get_settings(using=using)
if len(settings_response) > 1:
raise ValidationException(

Check warning on line 335 in opensearchpy/helpers/index.py

View check run for this annotation

Codecov / codecov/patch

opensearchpy/helpers/index.py#L333-L335

Added lines #L333 - L335 were not covered by tests
"Settings for %s point to multiple indices: %s."
% (self._name, ", ".join(list(settings_response.keys())))
)
current_settings = settings_response.popitem()[1]["settings"]["index"]

Check warning on line 339 in opensearchpy/helpers/index.py

View check run for this annotation

Codecov / codecov/patch

opensearchpy/helpers/index.py#L339

Added line #L339 was not covered by tests

if analysis:
if self.is_closed(using=using):
# closed index, update away
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from opensearchpy import Date, Text
from opensearchpy._async.helpers.document import AsyncDocument
from opensearchpy._async.helpers.index import AsyncIndex, AsyncIndexTemplate
from opensearchpy.exceptions import ValidationException
from opensearchpy.helpers import analysis

pytestmark: MarkDecorator = pytest.mark.asyncio
Expand Down Expand Up @@ -117,3 +118,39 @@ async def test_multiple_indices_with_same_doc_type_work(write_client: Any) -> No
assert settings[i]["settings"]["index"]["analysis"] == {
"analyzer": {"my_analyzer": {"type": "custom", "tokenizer": "keyword"}}
}


async def test_index_can_be_saved_through_alias_with_settings(
write_client: Any,
) -> None:
raw_index = AsyncIndex("test-blog", using=write_client)
raw_index.settings(number_of_shards=3, number_of_replicas=0)
raw_index.aliases(**{"blog-alias": {}})
await raw_index.save()

i = AsyncIndex("blog-alias", using=write_client)
i.settings(number_of_replicas=1)
await i.save()

settings = await write_client.indices.get_settings(index="test-blog")
assert "1" == settings["test-blog"]["settings"]["index"]["number_of_replicas"]


async def test_validation_alias_has_many_indices(write_client: Any) -> None:
raw_index_1 = AsyncIndex("test-blog-1", using=write_client)
raw_index_1.settings(number_of_shards=3, number_of_replicas=0)
raw_index_1.aliases(**{"blog-alias": {}})
await raw_index_1.save()

raw_index_2 = AsyncIndex("test-blog-2", using=write_client)
raw_index_2.settings(number_of_shards=3, number_of_replicas=0)
raw_index_2.aliases(**{"blog-alias": {}})
await raw_index_2.save()

i = AsyncIndex("blog-alias", using=write_client)
with pytest.raises(ValidationException) as e:
await i.save()

message, indices = e.value.args[0][:-1].split(": ")
assert message == "Settings for blog-alias point to multiple indices"
assert set(indices.split(", ")) == {"test-blog-1", "test-blog-2"}
41 changes: 41 additions & 0 deletions test_opensearchpy/test_server/test_helpers/test_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@

from typing import Any

import pytest

from opensearchpy import Date, Document, Index, IndexTemplate, Text
from opensearchpy.exceptions import ValidationException
from opensearchpy.helpers import analysis


Expand Down Expand Up @@ -122,3 +125,41 @@ def test_multiple_indices_with_same_doc_type_work(write_client: Any) -> None:
assert settings[j]["settings"]["index"]["analysis"] == {
"analyzer": {"my_analyzer": {"type": "custom", "tokenizer": "keyword"}}
}


def test_index_can_be_saved_through_alias_with_settings(write_client: Any) -> None:
raw_index = Index("test-blog", using=write_client)
raw_index.settings(number_of_shards=3, number_of_replicas=0)
raw_index.aliases(**{"blog-alias": {}})
raw_index.save()

i = Index("blog-alias", using=write_client)
i.settings(number_of_replicas=1)
i.save()

assert (
"1"
== raw_index.get_settings()["test-blog"]["settings"]["index"][
"number_of_replicas"
]
)


def test_validation_alias_has_many_indices(write_client: Any) -> None:
raw_index_1 = Index("test-blog-1", using=write_client)
raw_index_1.settings(number_of_shards=3, number_of_replicas=0)
raw_index_1.aliases(**{"blog-alias": {}})
raw_index_1.save()

raw_index_2 = Index("test-blog-2", using=write_client)
raw_index_2.settings(number_of_shards=3, number_of_replicas=0)
raw_index_2.aliases(**{"blog-alias": {}})
raw_index_2.save()

i = Index("blog-alias", using=write_client)
with pytest.raises(ValidationException) as e:
i.save()

message, indices = e.value.args[0][:-1].split(": ")
assert message == "Settings for blog-alias point to multiple indices"
assert set(indices.split(", ")) == {"test-blog-1", "test-blog-2"}
Loading