Module lum.odinson.tests.test_docker_api

Classes

class TestDockerAPI (methodName='runTest')

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the init method, the base class init method must always be called. It is important that subclasses should not change the signature of their init method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Expand source code

class TestDockerAPI(unittest.TestCase):
    def setUp(self):
        """special method called before each test.
        See https://docs.python.org/3/library/unittest.html
        """
        self.test_doc = odinson.Document.from_file(TEST_DOC_PATH)
        self.indexdir = tempfile.TemporaryDirectory()
        self.engine = DockerBasedOdinsonAPI(
            local_path=self.indexdir.name, keep_alive=False
        )
        MAX_WAIT = 5
        STEP = 0.5
        ELAPSED = 0
        while ELAPSED < MAX_WAIT:
            try:
                len(self.engine)
            except:
                pass
            time.sleep(STEP)
            ELAPSED += STEP

    def tearDown(self):
        """special method called after each test.
        See https://docs.python.org/3/library/unittest.html
        """
        # NOTE: we must stop the container before destroying the mounted volume
        # close API
        self.engine.close()
        # clean up test index
        self.indexdir.cleanup()

    def test_index_doc(self):
        """engine.index(doc) should store an odinson.Document in the index."""
        self.engine.index(self.test_doc, max_tokens=-1)
        # print(f"Num. docs:\t{len(self.engine)}")
        actual = len(self.engine)
        self.assertTrue(
            actual > 0,
            f"index {self.indexdir.name} did not contain any docs after indexing.  Instead found {actual}",
        )

    def test_update_doc(self):
        """engine.update(doc) should replace an odinson.Document in the index."""
        self.engine.index(self.test_doc, max_tokens=-1)
        # print(f"Num. docs:\t{len(self.engine)}")
        doc2 = self.test_doc.copy(metadata=[])
        res = self.engine.update(doc2, max_tokens=-1)
        self.assertTrue(
            res == True, f"engine.update() should replace doc with the same ID"
        )

    def test_delete_doc(self):
        """engine.delete(doc) should remove an odinson.Document in the index."""
        self.engine.index(self.test_doc, max_tokens=-1)
        self.engine.delete(self.test_doc)
        actual = len(self.engine)
        self.assertTrue(
            actual == 0,
            f"index {self.indexdir.name} should not contain any docs after indexing and deleting the same doc.  Instead found {actual}",
        )

Ancestors

• unittest.case.TestCase

Methods

def setUp(self)

special method called before each test. See https://docs.python.org/3/library/unittest.html

Expand source code

def setUp(self):
    """special method called before each test.
    See https://docs.python.org/3/library/unittest.html
    """
    self.test_doc = odinson.Document.from_file(TEST_DOC_PATH)
    self.indexdir = tempfile.TemporaryDirectory()
    self.engine = DockerBasedOdinsonAPI(
        local_path=self.indexdir.name, keep_alive=False
    )
    MAX_WAIT = 5
    STEP = 0.5
    ELAPSED = 0
    while ELAPSED < MAX_WAIT:
        try:
            len(self.engine)
        except:
            pass
        time.sleep(STEP)
        ELAPSED += STEP

def tearDown(self)

special method called after each test. See https://docs.python.org/3/library/unittest.html

Expand source code

def tearDown(self):
    """special method called after each test.
    See https://docs.python.org/3/library/unittest.html
    """
    # NOTE: we must stop the container before destroying the mounted volume
    # close API
    self.engine.close()
    # clean up test index
    self.indexdir.cleanup()

def test_delete_doc(self)

engine.delete(doc) should remove an odinson.Document in the index.

Expand source code

def test_delete_doc(self):
    """engine.delete(doc) should remove an odinson.Document in the index."""
    self.engine.index(self.test_doc, max_tokens=-1)
    self.engine.delete(self.test_doc)
    actual = len(self.engine)
    self.assertTrue(
        actual == 0,
        f"index {self.indexdir.name} should not contain any docs after indexing and deleting the same doc.  Instead found {actual}",
    )

def test_index_doc(self)

engine.index(doc) should store an odinson.Document in the index.

Expand source code

def test_index_doc(self):
    """engine.index(doc) should store an odinson.Document in the index."""
    self.engine.index(self.test_doc, max_tokens=-1)
    # print(f"Num. docs:\t{len(self.engine)}")
    actual = len(self.engine)
    self.assertTrue(
        actual > 0,
        f"index {self.indexdir.name} did not contain any docs after indexing.  Instead found {actual}",
    )

def test_update_doc(self)

engine.update(doc) should replace an odinson.Document in the index.

Expand source code

def test_update_doc(self):
    """engine.update(doc) should replace an odinson.Document in the index."""
    self.engine.index(self.test_doc, max_tokens=-1)
    # print(f"Num. docs:\t{len(self.engine)}")
    doc2 = self.test_doc.copy(metadata=[])
    res = self.engine.update(doc2, max_tokens=-1)
    self.assertTrue(
        res == True, f"engine.update() should replace doc with the same ID"
    )