• Search by Module
• Search by Words
• Search Projects

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• edx-search-master
  • AUTHORS
  • Makefile
  • pycodestyle
  • edxsearch
    • wsgi.py
    • urls.py
    • __init__.py
    • settings.py
  • .coveragerc
  • .pep8
  • search
    • search_engine_base.py
    • result_processor.py
    • elastic.py
    • filter_generator.py
    • views.py
    • urls.py
    • api.py
    • __init__.py
    • utils.py
    • initializer.py
    • tests
      • test_mock_search_engine.py
      • test_search_result_processor.py
      • test_engines.py
      • test_course_discovery.py
      • tests.py
      • test_course_discovery_views.py
      • __init__.py
      • utils.py
      • test_views.py
      • mock_search_engine.py
  • codecov.yml
  • LICENSE
  • manage.py
  • setup.py
  • openedx.yaml
  • pylintrc_tweaks
  • .travis.yml
  • README.md
  • scripts
    • post-pip-compile.sh
  • settings.py
  • pylintrc
  • .gitignore
  • requirements
    • testing.txt
    • base.txt
    • quality.txt
    • quality.in
    • travis.txt
    • pip-tools.in
    • testing.in
    • dev.txt
    • base.in
    • dev.in
    • constraints.txt
    • pip-tools.txt
    • travis.in
  • MANIFEST.in
  • tox.ini

""" Test utilities """

import json
from django.test import Client
from elasticsearch import Elasticsearch, exceptions
from search.search_engine_base import SearchEngine
from search.tests.mock_search_engine import MockSearchEngine
from search.elastic import ElasticSearchEngine


TEST_INDEX_NAME = "test_index"


def post_request(body, course_id=None):
    """ Helper method to post the request and process the response """
    address = '/' if course_id is None else '/{}'.format(course_id)
    response = Client().post(address, body)

    return getattr(response, "status_code", 500), json.loads(getattr(response, "content", None).decode('utf-8'))


def post_discovery_request(body):
    """ Helper method to post the request and process the response """
    address = '/course_discovery/'
    response = Client().post(address, body)

    return getattr(response, "status_code", 500), json.loads(getattr(response, "content", None).decode('utf-8'))


# pylint: disable=too-few-public-methods
class SearcherMixin:
    """ Mixin to provide searcher for the tests """
    _searcher = None

    @property
    def searcher(self):
        """ cached instance of search engine """
        if self._searcher is None:
            self._searcher = SearchEngine.get_search_engine(TEST_INDEX_NAME)
        return self._searcher


# We override ElasticSearchEngine class in order to force an index refresh upon index
# otherwise we often get results from the prior state, rendering the tests less useful
class ForceRefreshElasticSearchEngine(ElasticSearchEngine):
    """
    Override of ElasticSearchEngine that forces the update of the index,
    so that tests can relaibly search right afterward
    """

    def index(self, doc_type, sources, **kwargs):
        kwargs.update({
            "refresh": True
        })
        super(ForceRefreshElasticSearchEngine, self).index(doc_type, sources, **kwargs)

    def remove(self, doc_type, doc_ids, **kwargs):
        kwargs.update({
            "refresh": True
        })
        super(ForceRefreshElasticSearchEngine, self).remove(doc_type, doc_ids, **kwargs)


class ErroringSearchEngine(MockSearchEngine):
    """ Override to generate search engine error to test """

    def search(self,
               query_string=None,
               field_dictionary=None,
               filter_dictionary=None,
               **kwargs):  # pylint: disable=arguments-differ
        raise Exception("There is a problem here")


class ErroringIndexEngine(MockSearchEngine):
    """ Override to generate search engine error to test """

    def index(self, doc_type, sources, **kwargs):  # pylint: disable=unused-argument, arguments-differ
        raise Exception("There is a problem here")


class ErroringElasticImpl(Elasticsearch):
    """ Elasticsearch implementation that throws exceptions"""

    # pylint: disable=unused-argument
    def search(self, **kwargs):  # pylint: disable=arguments-differ
        """ this will definitely fail """
        raise exceptions.ElasticsearchException("This search operation failed")