django_elasticsearch_dsl_drf.tests package

Submodules

django_elasticsearch_dsl_drf.tests.base module

Base tests.

class django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase(methodName='runTest')

Bases: django.test.testcases.TransactionTestCase

Base REST framework test case.

authenticate()

Helper for logging in Genre Coordinator user.

Returns:

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

class django_elasticsearch_dsl_drf.tests.base.BaseTestCase(methodName='runTest')

Bases: django.test.testcases.TransactionTestCase

Base test case.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

django_elasticsearch_dsl_drf.tests.data_mixins module

Data mixins.

class django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Bases: object

Addresses mixin.

classmethod created_addresses()

Create addresses.

Returns:

class django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Bases: object

Books mixin.

classmethod create_books()

Create books.

Returns:

django_elasticsearch_dsl_drf.tests.test_faceted_search module

Test faceted search backend.

class django_elasticsearch_dsl_drf.tests.test_faceted_search.TestFacetedSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test faceted search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_list_results_with_facets()

Test list results with facets.

django_elasticsearch_dsl_drf.tests.test_filtering_common module

Test filtering backend.

class django_elasticsearch_dsl_drf.tests.test_filtering_common.TestFilteringCommon(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin, django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Test filtering common.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_default_filter_lookup()

Test default filter lookup.

Example:

http://localhost:8000/search/books-default-filter-lookup/

?authors=Robin&authors=Luc

test_field_filter_contains()

Test filter contains.

Example:

http://localhost:8000/api/articles/?state__contains=lishe

test_field_filter_endswith()

Test filter endswith.

Example:

http://localhost:8000/api/articles/?state__endswith=lished

test_field_filter_exclude()

Test filter exclude.

Example:

http://localhost:8000/api/articles/?tags__exclude=children

test_field_filter_exists_false()

Test filter exists.

Example:

http://localhost:8000/api/articles/?non_existent__exists=false

test_field_filter_exists_true()

Test filter exists true.

Example:

http://localhost:8000/api/articles/?tags__exists=true

test_field_filter_gt()

Field filter gt.

Example:

http://localhost:8000/api/users/?id__gt=10

Returns:

test_field_filter_gt_with_boost()

Field filter gt with boost.

Example:

http://localhost:8000/api/users/?id__gt=10__2.0

Returns:

test_field_filter_gte()

Field filter gte.

Example:

http://localhost:8000/api/users/?id__gte=10

Returns:

test_field_filter_in()

Test filter in.

Example:

http://localhost:8000/api/articles/?id__in=1__2__3

test_field_filter_isnull_false()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?tags__isnull=false

test_field_filter_isnull_true()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?null_field__isnull=true

test_field_filter_lt()

Field filter lt.

Example:

http://localhost:8000/api/users/?id__lt=10

Returns:

test_field_filter_lt_with_boost()

Field filter lt with boost.

Example:

http://localhost:8000/api/users/?id__lt=10__2.0

Returns:

test_field_filter_lte()

Field filter lte.

Example:

http://localhost:8000/api/users/?id__lte=10

Returns:

test_field_filter_prefix()

Test filter prefix.

Example:

http://localhost:8000/api/articles/?tags__prefix=bio

test_field_filter_range()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67

test_field_filter_range_with_boost()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67__2.0

test_field_filter_term()

Field filter term.

test_field_filter_term_explicit()

Field filter term.

test_field_filter_terms_list()

Test filter terms.

test_field_filter_terms_string()

Test filter terms.

Example:

http://localhost:8000/api/articles/?id__terms=1__2__3

test_field_filter_wildcard()

Test filter wildcard.

Example:

http://localhost:8000/api/articles/?title__wildcard=*elusional*

test_ids_empty_filter()

Test ids filter with empty value. This should not fail.

Example:

http://localhost:8000/api/articles/?ids=

test_ids_filter()

Test ids filter.

Example:

http://localhost:8000/api/articles/?ids=68__64__58 http://localhost:8000/api/articles/?ids=68&ids=64&ids=58

test_nested_field_filter_term()

Nested field filter term.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_various_complex_fields()

Test various complex fields.

Returns:

django_elasticsearch_dsl_drf.tests.test_filtering_geo_spatial module

Test geo-spatial filtering backend.

class django_elasticsearch_dsl_drf.tests.test_filtering_geo_spatial.TestFilteringGeoSpatial(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test filtering geo-spatial.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_geo_bounding_box()

Test field filter geo-bounding-box.

Returns:

test_field_filter_geo_bounding_box_fail_test()

Test field filter geo-bounding-box (fail test).

Returns:

test_field_filter_geo_distance()

Field filter geo-distance.

Example:

http://localhost:8000 /api/publisher/?location__geo_distance=1km__48.8549__2.3000

Returns:

test_field_filter_geo_distance_distance_type_arc()

Field filter geo-distance.

Example:

http://localhost:8000 /api/publisher/?location__geo_distance=1km__48.8549__2.3000__arc

Returns:

test_field_filter_geo_distance_not_enough_args_fail()

Field filter geo-distance. Fail test on not enough args.

Example:

http://localhost:8000 /api/publisher/?location__geo_distance=1km__48.8549

Returns:

test_field_filter_geo_polygon()

Test field filter geo-polygon.

Returns:

test_field_filter_geo_polygon_fail_test()

Test field filter geo-polygon (fail test).

Returns:

test_field_filter_geo_polygon_string_options()

Test field filter geo-polygon.

Returns:

test_field_filter_geo_polygon_string_options_fail_test()

Test field filter geo-polygon (fail test).

Returns:

django_elasticsearch_dsl_drf.tests.test_filtering_global_aggregations module

Test filtering post_filter backend.

class django_elasticsearch_dsl_drf.tests.test_filtering_global_aggregations.TestFilteringGlobalAggregations(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin, django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Test filtering with global aggregations.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_list_results_with_facets()

Test list results with facets.

django_elasticsearch_dsl_drf.tests.test_filtering_nested module

Test nested filtering backend.

class django_elasticsearch_dsl_drf.tests.test_filtering_nested.TestFilteringNested(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test filtering nested.

base_url

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_contains()

Test filter contains.

Example:

http://localhost:8000/api/articles/?state__contains=lishe

test_field_filter_endswith()

Test filter endswith.

Example:

http://localhost:8000/api/articles/?state__endswith=lished

test_field_filter_exclude()

Test filter exclude.

Example:

http://localhost:8000/api/articles/?tags__exclude=children

test_field_filter_exists_false()

Test filter exists.

Example:

http://localhost:8000/api/articles/?non_existent__exists=false

test_field_filter_exists_true()

Test filter exists true.

Example:

http://localhost:8000/api/articles/?tags__exists=true

test_field_filter_in()

Test filter in.

Example:

http://localhost:8000/api/articles/?id__in=1__2__3

test_field_filter_prefix()

Test filter prefix.

Example:

http://localhost:8000/api/articles/?tags__prefix=bio

test_field_filter_range()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67

test_field_filter_range_with_boost()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67__2.0

test_field_filter_term()

Field filter term.

test_field_filter_term_explicit()

Field filter term.

test_field_filter_terms_list()

Test filter terms.

test_field_filter_terms_string()

Test filter terms.

Example:

http://localhost:8000/api/articles/?id__terms=1__2__3

test_field_filter_wildcard()

Test filter wildcard.

Example:

http://localhost:8000/api/articles/?title__wildcard=*elusional*

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

django_elasticsearch_dsl_drf.tests.test_filtering_post_filter module

Test filtering post_filter backend.

class django_elasticsearch_dsl_drf.tests.test_filtering_post_filter.TestFilteringPostFilter(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin, django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Test filtering post_filter.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_contains()

Test filter contains.

Example:

http://localhost:8000/api/articles/?state__contains=lishe

test_field_filter_endswith()

Test filter endswith.

Example:

http://localhost:8000/api/articles/?state__endswith=lished

test_field_filter_exclude()

Test filter exclude.

Example:

http://localhost:8000/api/articles/?tags__exclude=children

test_field_filter_exists_false()

Test filter exists.

Example:

http://localhost:8000/api/articles/?non_existent__exists=false

test_field_filter_exists_true()

Test filter exists true.

Example:

http://localhost:8000/api/articles/?tags__exists=true

test_field_filter_gt()

Field filter gt.

Example:

http://localhost:8000/api/users/?id__gt=10

Returns:

test_field_filter_gt_with_boost()

Field filter gt with boost.

Example:

http://localhost:8000/api/users/?id__gt=10;2.0

Returns:

test_field_filter_gte()

Field filter gte.

Example:

http://localhost:8000/api/users/?id__gte=10

Returns:

test_field_filter_in()

Test filter in.

Example:

http://localhost:8000/api/articles/?id__in=1;2;3

test_field_filter_isnull_false()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?tags__isnull=false

test_field_filter_isnull_true()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?null_field__isnull=true

test_field_filter_lt()

Field filter lt.

Example:

http://localhost:8000/api/users/?id__lt=10

Returns:

test_field_filter_lt_with_boost()

Field filter lt with boost.

Example:

http://localhost:8000/api/users/?id__lt=10;2.0

Returns:

test_field_filter_lte()

Field filter lte.

Example:

http://localhost:8000/api/users/?id__lte=10

Returns:

test_field_filter_prefix()

Test filter prefix.

Example:

http://localhost:8000/api/articles/?tags__prefix=bio

test_field_filter_range()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16;67

test_field_filter_range_with_boost()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16;67;2.0

test_field_filter_term()

Field filter term.

test_field_filter_term_explicit()

Field filter term.

test_field_filter_terms_list()

Test filter terms.

test_field_filter_terms_string()

Test filter terms.

Example:

http://localhost:8000/api/articles/?id__terms=1;2;3

test_field_filter_wildcard()

Test filter wildcard.

Example:

http://localhost:8000/api/articles/?title__wildcard=*elusional*

test_ids_filter()

Test ids filter.

Example:

http://localhost:8000/api/articles/?ids=68;64;58 http://localhost:8000/api/articles/?ids=68&ids=64&ids=58

test_list_results_with_facets()

Test list results with facets.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_various_complex_fields()

Test various complex fields.

Returns:

django_elasticsearch_dsl_drf.tests.test_functional_suggesters module

Test functional suggestions backend.

class django_elasticsearch_dsl_drf.tests.test_functional_suggesters.TestFunctionalSuggesters(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test functional suggesters.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_suggesters_completion()

Test suggesters completion.

test_suggesters_completion_no_args_provided()

Test suggesters completion with no args provided.

django_elasticsearch_dsl_drf.tests.test_helpers module

Test helpers.

class django_elasticsearch_dsl_drf.tests.test_helpers.TestHelpers(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseTestCase

Test helpers.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_filter_by_field()

Filter by field.

django_elasticsearch_dsl_drf.tests.test_highlight module

Test highlight backend.

class django_elasticsearch_dsl_drf.tests.test_highlight.TestHighlight(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test highlight.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_list_results_with_highlights()

Test list results with facets.

django_elasticsearch_dsl_drf.tests.test_more_like_this module

Test more-like-this functionality.

class django_elasticsearch_dsl_drf.tests.test_more_like_this.TestMoreLikeThis(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test suggesters.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_more_like_this()

Test more-like-this.

django_elasticsearch_dsl_drf.tests.test_ordering_common module

Test ordering backend.

class django_elasticsearch_dsl_drf.tests.test_ordering_common.TestOrdering(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test ordering.

static deep_get(dic, keys, default=None)

Returns value at period separated keys in dictionary or default

From https://stackoverflow.com/a/46890853

Parameters:

• dic (dict) – Dictionary to retrieve value from.
• keys (str) – Period separated path of keys
• default (str) – Default value to return if keys not found

Returns:

Value at keys or default

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_address_default_nested_order_by()

test_address_default_order_by()

Test if default ordering on addresses is correct (asc).

test_address_order_by_nested_field_continent_ascending()

Order by field continent.country.name.raw ascending.

test_address_order_by_nested_field_continent_descending()

Order by field continent.country.name.raw descending.

test_address_order_by_nested_field_country_ascending()

Order by field continent.country.name.raw ascending.

test_address_order_by_nested_field_country_descending()

Order by field continent.country.name.raw descending.

test_author_default_order_by()

Author order by default.

test_author_order_by_field_id_ascending()

Order by field name ascending.

test_author_order_by_field_id_descending()

Order by field id descending.

test_author_order_by_field_name_ascending()

Order by field name ascending.

test_author_order_by_field_name_descending()

Order by field name descending.

test_book_default_order_by()

Book order by default.

test_book_order_by_field_id_ascending()

Order by field id ascending.

test_book_order_by_field_id_descending()

Order by field id descending.

test_book_order_by_field_title_ascending()

Order by field title ascending.

test_book_order_by_field_title_descending()

Order by field title descending.

test_book_order_by_non_existent_field()

Order by non-existent field.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

django_elasticsearch_dsl_drf.tests.test_ordering_geo_spatial module

Test geo-spatial ordering filter backend.

class django_elasticsearch_dsl_drf.tests.test_ordering_geo_spatial.TestOrderingGeoSpatial(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test ordering geo-spatial.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_geo_distance()

Field filter geo_distance.

Example:

http://localhost:8000 /api/publisher/?ordering=location;48.85;2.30;km;plane

django_elasticsearch_dsl_drf.tests.test_pagination module

Test pagination.

class django_elasticsearch_dsl_drf.tests.test_pagination.TestPagination(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test pagination.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_pagination()

Test pagination.

django_elasticsearch_dsl_drf.tests.test_pip_helpers module

Test pip_helpers.

class django_elasticsearch_dsl_drf.tests.test_pip_helpers.TestPipHelpers(methodName='runTest')

Bases: unittest.case.TestCase

Test pip_helpers.

pytestmark = [Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

test_check_if_installed()

Test check_if_installed.

Returns:

test_get_installed_packages()

Test get_installed_packages.

Returns:

test_get_installed_packages_with_versions()

Test get_installed_packages.

Returns:

django_elasticsearch_dsl_drf.tests.test_search module

Test search backend.

class django_elasticsearch_dsl_drf.tests.test_search.TestSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_compound_search_boost_by_field()

test_compound_search_by_field()

test_compound_search_by_field_multi_terms()

test_compound_search_by_nested_field()

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_search_boost(url=None, search_field='search')

Search boost.

Returns:

test_search_boost_compound(search_field='search')

test_search_by_field(url=None, search_field='search')

Search by field.

test_search_by_field_multi_terms(url=None, search_field='search')

Search by field, multiple terms.

test_search_by_nested_field(url=None)

Search by field.

django_elasticsearch_dsl_drf.tests.test_search_multi_match module

Test multi match search filter backend.

class django_elasticsearch_dsl_drf.tests.test_search_multi_match.TestMultiMatchSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test multi match search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_search(url=None)

Search.

test_search_boost(url=None)

Search boost.

Returns:

test_search_boost_selected_fields(url=None)

Search boost.

Returns:

test_search_selected_fields(url=None)

Search boost.

Returns:

django_elasticsearch_dsl_drf.tests.test_search_simple_query_string module

Test multi match search filter backend.

class django_elasticsearch_dsl_drf.tests.test_search_simple_query_string.TestSimpleQueryStringSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test simple query string search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_search_boost_selected_fields(url=None)

Search boost.

Returns:

test_search_selected_fields(url=None)

Search boost.

Returns:

test_search_with_quotes(url=None)

Search with quotes.

test_search_with_quotes_alternative()

Test search by field.

Parameters:url – Returns:

test_search_with_quotes_boost(url=None)

Search boost.

Returns:

test_search_with_quotes_boost_alternative()

Search boost.

Returns:

test_search_without_quotes(url=None)

Test search without quotes. This does not work on Elasticsearch 6.x.

Parameters:url – Returns:

test_search_without_quotes_boost(url=None)

Search boost without quotes. Does not work on Elasticsearch 6.x.

Returns:

django_elasticsearch_dsl_drf.tests.test_serializers module

Test serializers.

class django_elasticsearch_dsl_drf.tests.test_serializers.TestSerializers(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test serializers.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

test_serializer_document_equals_to_none()

Test serializer no document specified.

test_serializer_fields_and_exclude()

Test serializer fields and exclude.

test_serializer_meta_del_attr()

Test serializer set attr.

test_serializer_meta_set_attr()

Test serializer set attr.

test_serializer_no_document_specified()

Test serializer no document specified.

django_elasticsearch_dsl_drf.tests.test_suggesters module

Test suggestions backend.

class django_elasticsearch_dsl_drf.tests.test_suggesters.TestContextSuggesters(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test context suggesters.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_suggesters_completion_context()

Test suggesters completion context.

class django_elasticsearch_dsl_drf.tests.test_suggesters.TestSuggesters(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test suggesters.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_nested_fields_suggesters_completion()

Test suggesters completion for nested fields.

test_suggesters_completion()

Test suggesters completion.

test_suggesters_completion_no_args_provided()

Test suggesters completion with no args provided.

test_suggesters_phrase()

Test suggesters phrase.

test_suggesters_term()

Test suggesters term.

class django_elasticsearch_dsl_drf.tests.test_suggesters.TestSuggestersEmptyIndex(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test suggesters on empty index.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_suggesters_on_empty_index()

Test suggesters phrase.

django_elasticsearch_dsl_drf.tests.test_views module

Test views.

class django_elasticsearch_dsl_drf.tests.test_views.TestViews(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test views.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_detail_view()

Test detail view.

test_listing_view()

Test listing view.

django_elasticsearch_dsl_drf.tests.test_wrappers module

Test wrappers.

class django_elasticsearch_dsl_drf.tests.test_wrappers.TestWrappers(methodName='runTest')

Bases: unittest.case.TestCase

Test wrappers.

pytestmark = [Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

test_dict_to_obj()

Test dict_to_obj.

Returns:

test_obj_to_dict()

Test obj_to_dict.

Returns:

test_wrapper_as_json()

Test :Wrapper:`as_json` property.

Module contents

Tests.

class django_elasticsearch_dsl_drf.tests.TestFacetedSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test faceted search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_list_results_with_facets()

Test list results with facets.

class django_elasticsearch_dsl_drf.tests.TestFilteringCommon(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin, django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Test filtering common.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_default_filter_lookup()

Test default filter lookup.

Example:

http://localhost:8000/search/books-default-filter-lookup/

?authors=Robin&authors=Luc

test_field_filter_contains()

Test filter contains.

Example:

http://localhost:8000/api/articles/?state__contains=lishe

test_field_filter_endswith()

Test filter endswith.

Example:

http://localhost:8000/api/articles/?state__endswith=lished

test_field_filter_exclude()

Test filter exclude.

Example:

http://localhost:8000/api/articles/?tags__exclude=children

test_field_filter_exists_false()

Test filter exists.

Example:

http://localhost:8000/api/articles/?non_existent__exists=false

test_field_filter_exists_true()

Test filter exists true.

Example:

http://localhost:8000/api/articles/?tags__exists=true

test_field_filter_gt()

Field filter gt.

Example:

http://localhost:8000/api/users/?id__gt=10

Returns:

test_field_filter_gt_with_boost()

Field filter gt with boost.

Example:

http://localhost:8000/api/users/?id__gt=10__2.0

Returns:

test_field_filter_gte()

Field filter gte.

Example:

http://localhost:8000/api/users/?id__gte=10

Returns:

test_field_filter_in()

Test filter in.

Example:

http://localhost:8000/api/articles/?id__in=1__2__3

test_field_filter_isnull_false()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?tags__isnull=false

test_field_filter_isnull_true()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?null_field__isnull=true

test_field_filter_lt()

Field filter lt.

Example:

http://localhost:8000/api/users/?id__lt=10

Returns:

test_field_filter_lt_with_boost()

Field filter lt with boost.

Example:

http://localhost:8000/api/users/?id__lt=10__2.0

Returns:

test_field_filter_lte()

Field filter lte.

Example:

http://localhost:8000/api/users/?id__lte=10

Returns:

test_field_filter_prefix()

Test filter prefix.

Example:

http://localhost:8000/api/articles/?tags__prefix=bio

test_field_filter_range()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67

test_field_filter_range_with_boost()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67__2.0

test_field_filter_term()

Field filter term.

test_field_filter_term_explicit()

Field filter term.

test_field_filter_terms_list()

Test filter terms.

test_field_filter_terms_string()

Test filter terms.

Example:

http://localhost:8000/api/articles/?id__terms=1__2__3

test_field_filter_wildcard()

Test filter wildcard.

Example:

http://localhost:8000/api/articles/?title__wildcard=*elusional*

test_ids_empty_filter()

Test ids filter with empty value. This should not fail.

Example:

http://localhost:8000/api/articles/?ids=

test_ids_filter()

Test ids filter.

Example:

http://localhost:8000/api/articles/?ids=68__64__58 http://localhost:8000/api/articles/?ids=68&ids=64&ids=58

test_nested_field_filter_term()

Nested field filter term.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_various_complex_fields()

Test various complex fields.

Returns:

class django_elasticsearch_dsl_drf.tests.TestFilteringGeoSpatial(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test filtering geo-spatial.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_geo_bounding_box()

Test field filter geo-bounding-box.

Returns:

test_field_filter_geo_bounding_box_fail_test()

Test field filter geo-bounding-box (fail test).

Returns:

test_field_filter_geo_distance()

Field filter geo-distance.

Example:

http://localhost:8000 /api/publisher/?location__geo_distance=1km__48.8549__2.3000

Returns:

test_field_filter_geo_distance_distance_type_arc()

Field filter geo-distance.

Example:

http://localhost:8000 /api/publisher/?location__geo_distance=1km__48.8549__2.3000__arc

Returns:

test_field_filter_geo_distance_not_enough_args_fail()

Field filter geo-distance. Fail test on not enough args.

Example:

http://localhost:8000 /api/publisher/?location__geo_distance=1km__48.8549

Returns:

test_field_filter_geo_polygon()

Test field filter geo-polygon.

Returns:

test_field_filter_geo_polygon_fail_test()

Test field filter geo-polygon (fail test).

Returns:

test_field_filter_geo_polygon_string_options()

Test field filter geo-polygon.

Returns:

test_field_filter_geo_polygon_string_options_fail_test()

Test field filter geo-polygon (fail test).

Returns:

class django_elasticsearch_dsl_drf.tests.TestFilteringGlobalAggregations(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin, django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Test filtering with global aggregations.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_list_results_with_facets()

Test list results with facets.

class django_elasticsearch_dsl_drf.tests.TestFilteringNested(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test filtering nested.

base_url

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_contains()

Test filter contains.

Example:

http://localhost:8000/api/articles/?state__contains=lishe

test_field_filter_endswith()

Test filter endswith.

Example:

http://localhost:8000/api/articles/?state__endswith=lished

test_field_filter_exclude()

Test filter exclude.

Example:

http://localhost:8000/api/articles/?tags__exclude=children

test_field_filter_exists_false()

Test filter exists.

Example:

http://localhost:8000/api/articles/?non_existent__exists=false

test_field_filter_exists_true()

Test filter exists true.

Example:

http://localhost:8000/api/articles/?tags__exists=true

test_field_filter_in()

Test filter in.

Example:

http://localhost:8000/api/articles/?id__in=1__2__3

test_field_filter_prefix()

Test filter prefix.

Example:

http://localhost:8000/api/articles/?tags__prefix=bio

test_field_filter_range()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67

test_field_filter_range_with_boost()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16__67__2.0

test_field_filter_term()

Field filter term.

test_field_filter_term_explicit()

Field filter term.

test_field_filter_terms_list()

Test filter terms.

test_field_filter_terms_string()

Test filter terms.

Example:

http://localhost:8000/api/articles/?id__terms=1__2__3

test_field_filter_wildcard()

Test filter wildcard.

Example:

http://localhost:8000/api/articles/?title__wildcard=*elusional*

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

class django_elasticsearch_dsl_drf.tests.TestFilteringPostFilter(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin, django_elasticsearch_dsl_drf.tests.data_mixins.BooksMixin

Test filtering post_filter.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_contains()

Test filter contains.

Example:

http://localhost:8000/api/articles/?state__contains=lishe

test_field_filter_endswith()

Test filter endswith.

Example:

http://localhost:8000/api/articles/?state__endswith=lished

test_field_filter_exclude()

Test filter exclude.

Example:

http://localhost:8000/api/articles/?tags__exclude=children

test_field_filter_exists_false()

Test filter exists.

Example:

http://localhost:8000/api/articles/?non_existent__exists=false

test_field_filter_exists_true()

Test filter exists true.

Example:

http://localhost:8000/api/articles/?tags__exists=true

test_field_filter_gt()

Field filter gt.

Example:

http://localhost:8000/api/users/?id__gt=10

Returns:

test_field_filter_gt_with_boost()

Field filter gt with boost.

Example:

http://localhost:8000/api/users/?id__gt=10;2.0

Returns:

test_field_filter_gte()

Field filter gte.

Example:

http://localhost:8000/api/users/?id__gte=10

Returns:

test_field_filter_in()

Test filter in.

Example:

http://localhost:8000/api/articles/?id__in=1;2;3

test_field_filter_isnull_false()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?tags__isnull=false

test_field_filter_isnull_true()

Test filter isnull true.

Example:

http://localhost:8000/api/articles/?null_field__isnull=true

test_field_filter_lt()

Field filter lt.

Example:

http://localhost:8000/api/users/?id__lt=10

Returns:

test_field_filter_lt_with_boost()

Field filter lt with boost.

Example:

http://localhost:8000/api/users/?id__lt=10;2.0

Returns:

test_field_filter_lte()

Field filter lte.

Example:

http://localhost:8000/api/users/?id__lte=10

Returns:

test_field_filter_prefix()

Test filter prefix.

Example:

http://localhost:8000/api/articles/?tags__prefix=bio

test_field_filter_range()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16;67

test_field_filter_range_with_boost()

Field filter range.

Example:

http://localhost:8000/api/users/?age__range=16;67;2.0

test_field_filter_term()

Field filter term.

test_field_filter_term_explicit()

Field filter term.

test_field_filter_terms_list()

Test filter terms.

test_field_filter_terms_string()

Test filter terms.

Example:

http://localhost:8000/api/articles/?id__terms=1;2;3

test_field_filter_wildcard()

Test filter wildcard.

Example:

http://localhost:8000/api/articles/?title__wildcard=*elusional*

test_ids_filter()

Test ids filter.

Example:

http://localhost:8000/api/articles/?ids=68;64;58 http://localhost:8000/api/articles/?ids=68&ids=64&ids=58

test_list_results_with_facets()

Test list results with facets.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_various_complex_fields()

Test various complex fields.

Returns:

class django_elasticsearch_dsl_drf.tests.TestFunctionalSuggesters(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test functional suggesters.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_suggesters_completion()

Test suggesters completion.

test_suggesters_completion_no_args_provided()

Test suggesters completion with no args provided.

class django_elasticsearch_dsl_drf.tests.TestHelpers(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseTestCase

Test helpers.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_filter_by_field()

Filter by field.

class django_elasticsearch_dsl_drf.tests.TestHighlight(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test highlight.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_list_results_with_highlights()

Test list results with facets.

class django_elasticsearch_dsl_drf.tests.TestMultiMatchSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test multi match search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_search(url=None)

Search.

test_search_boost(url=None)

Search boost.

Returns:

test_search_boost_selected_fields(url=None)

Search boost.

Returns:

test_search_selected_fields(url=None)

Search boost.

Returns:

class django_elasticsearch_dsl_drf.tests.TestSimpleQueryStringSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test simple query string search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_search_boost_selected_fields(url=None)

Search boost.

Returns:

test_search_selected_fields(url=None)

Search boost.

Returns:

test_search_with_quotes(url=None)

Search with quotes.

test_search_with_quotes_alternative()

Test search by field.

Parameters:url – Returns:

test_search_with_quotes_boost(url=None)

Search boost.

Returns:

test_search_with_quotes_boost_alternative()

Search boost.

Returns:

test_search_without_quotes(url=None)

Test search without quotes. This does not work on Elasticsearch 6.x.

Parameters:url – Returns:

test_search_without_quotes_boost(url=None)

Search boost without quotes. Does not work on Elasticsearch 6.x.

Returns:

class django_elasticsearch_dsl_drf.tests.TestOrdering(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test ordering.

static deep_get(dic, keys, default=None)

Returns value at period separated keys in dictionary or default

From https://stackoverflow.com/a/46890853

Parameters:

• dic (dict) – Dictionary to retrieve value from.
• keys (str) – Period separated path of keys
• default (str) – Default value to return if keys not found

Returns:

Value at keys or default

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_address_default_nested_order_by()

test_address_default_order_by()

Test if default ordering on addresses is correct (asc).

test_address_order_by_nested_field_continent_ascending()

Order by field continent.country.name.raw ascending.

test_address_order_by_nested_field_continent_descending()

Order by field continent.country.name.raw descending.

test_address_order_by_nested_field_country_ascending()

Order by field continent.country.name.raw ascending.

test_address_order_by_nested_field_country_descending()

Order by field continent.country.name.raw descending.

test_author_default_order_by()

Author order by default.

test_author_order_by_field_id_ascending()

Order by field name ascending.

test_author_order_by_field_id_descending()

Order by field id descending.

test_author_order_by_field_name_ascending()

Order by field name ascending.

test_author_order_by_field_name_descending()

Order by field name descending.

test_book_default_order_by()

Book order by default.

test_book_order_by_field_id_ascending()

Order by field id ascending.

test_book_order_by_field_id_descending()

Order by field id descending.

test_book_order_by_field_title_ascending()

Order by field title ascending.

test_book_order_by_field_title_descending()

Order by field title descending.

test_book_order_by_non_existent_field()

Order by non-existent field.

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

class django_elasticsearch_dsl_drf.tests.TestOrderingGeoSpatial(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test ordering geo-spatial.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up.

test_field_filter_geo_distance()

Field filter geo_distance.

Example:

http://localhost:8000 /api/publisher/?ordering=location;48.85;2.30;km;plane

class django_elasticsearch_dsl_drf.tests.TestPagination(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test pagination.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_pagination()

Test pagination.

class django_elasticsearch_dsl_drf.tests.TestPipHelpers(methodName='runTest')

Bases: unittest.case.TestCase

Test pip_helpers.

pytestmark = [Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

test_check_if_installed()

Test check_if_installed.

Returns:

test_get_installed_packages()

Test get_installed_packages.

Returns:

test_get_installed_packages_with_versions()

Test get_installed_packages.

Returns:

class django_elasticsearch_dsl_drf.tests.TestSearch(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test search.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUp()

Hook method for setting up the test fixture before exercising it.

test_compound_search_boost_by_field()

test_compound_search_by_field()

test_compound_search_by_field_multi_terms()

test_compound_search_by_nested_field()

test_schema_field_not_required()

Test schema fields always not required

test_schema_fields_with_filter_fields_list()

Test schema field generator

test_search_boost(url=None, search_field='search')

Search boost.

Returns:

test_search_boost_compound(search_field='search')

test_search_by_field(url=None, search_field='search')

Search by field.

test_search_by_field_multi_terms(url=None, search_field='search')

Search by field, multiple terms.

test_search_by_nested_field(url=None)

Search by field.

class django_elasticsearch_dsl_drf.tests.TestSerializers(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test serializers.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

test_serializer_document_equals_to_none()

Test serializer no document specified.

test_serializer_fields_and_exclude()

Test serializer fields and exclude.

test_serializer_meta_del_attr()

Test serializer set attr.

test_serializer_meta_set_attr()

Test serializer set attr.

test_serializer_no_document_specified()

Test serializer no document specified.

class django_elasticsearch_dsl_drf.tests.TestSuggesters(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase, django_elasticsearch_dsl_drf.tests.data_mixins.AddressesMixin

Test suggesters.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_nested_fields_suggesters_completion()

Test suggesters completion for nested fields.

test_suggesters_completion()

Test suggesters completion.

test_suggesters_completion_no_args_provided()

Test suggesters completion with no args provided.

test_suggesters_phrase()

Test suggesters phrase.

test_suggesters_term()

Test suggesters term.

class django_elasticsearch_dsl_drf.tests.TestViews(methodName='runTest')

Bases: django_elasticsearch_dsl_drf.tests.base.BaseRestFrameworkTestCase

Test views.

pytestmark = [Mark(name='django_db', args=(), kwargs={}), Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Set up class.

test_detail_view()

Test detail view.

test_listing_view()

Test listing view.

class django_elasticsearch_dsl_drf.tests.TestWrappers(methodName='runTest')

Bases: unittest.case.TestCase

Test wrappers.

pytestmark = [Mark(name='django_db', args=(), kwargs={})]

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

test_dict_to_obj()

Test dict_to_obj.

Returns:

test_obj_to_dict()

Test obj_to_dict.

Returns:

test_wrapper_as_json()

Test :Wrapper:`as_json` property.