Skip to content

A community-supported supercharged document management system: scan, index and archive all your documents

1.2 KB
Raw Blame
"""``_DEFAULT_SEARCH_FIELDS`` must stay a subset of the registered public
field names.

Nothing enforced this before: a rename in PUBLIC_FIELDS not mirrored in
``_DEFAULT_SEARCH_FIELDS`` (documents/search/_query.py) would 400 every
unfielded search at request time, since ``index.parse_query``, the
fuzzy clause builder and the CJK bigram widening are handed a field name
the schema no longer has.
"""

from __future__ import annotations

from documents.search._fields import PUBLIC_FIELDS
from documents.search._query import _DEFAULT_SEARCH_FIELDS


class TestDefaultSearchFieldsAreRegistered:
    def test_every_default_search_field_is_a_public_field(self) -> None:
        """
        GIVEN:
            - PUBLIC_FIELDS and _DEFAULT_SEARCH_FIELDS, our own field
              tables
        WHEN:
            - Every name in _DEFAULT_SEARCH_FIELDS is checked against the
              registered public field names
        THEN:
            - Every one is present; a rename in PUBLIC_FIELDS not
              mirrored here would 400 every unfielded search at request
              time
        """
        public_field_names = {f.name for f in PUBLIC_FIELDS}
        assert set(_DEFAULT_SEARCH_FIELDS) <= public_field_names