gordonbanderson / silverstripe-elastica

tests/ElasticaServiceTest.php

<?php

use SilverStripe\Elastica\ElasticaService;
use SilverStripe\Elastica\ReindexTask;
use SilverStripe\Elastica\DeleteIndexTask;
use SilverStripe\Elastica\Searchable;

/**
 * Test the functionality ElasticaService class
 * @package elastica
 */
class ElasticaServiceTest extends ElasticsearchBaseTest {

	public static $fixture_file = 'elastica/tests/lotsOfPhotos.yml';


	public function setUp() {
		parent::setUp();
		$this->service->setTestMode(true);
	}


	public function testCreateIndexInvalidLocale() {
		// fake locale
		$this->service->setLocale('sw_NZ');
		try {
			$this->invokeMethod($this->service, 'createIndex', array());
			$this->assertFalse(true, "Creation of index with unknown locale should have failed");
		} catch (Exception $e) {
			$this->assertTrue(true,"Creation of index with unknown locale failed as expected");
		}


	}


	public function testEnsureMapping() {
		$index = $this->service->getIndex();
		$mapping = $index->getMapping();
		$type = $index->getType('FlickrPhotoTO');
		$record = FlickrPhotoTO::get()->first();
		$mappingBefore = $this->invokeMethod($this->service, 'ensureMapping', array($type, $record));

		$this->assertEquals($mapping['FlickrPhotoTO'], $mappingBefore['FlickrPhotoTO']);

The method assertEquals() does not seem to exist on object<ElasticaServiceTest>.

		// Delete the index
		$task = new DeleteIndexTask($this->service);
		$task->run(null);
		$mappingAfter = $this->invokeMethod($this->service, 'ensureMapping', array($type, $record));
		$this->assertEquals($mappingBefore, $mappingAfter);

The method assertEquals() does not seem to exist on object<ElasticaServiceTest>.

	}


	public function testEnsureIndex() {
		// Check that an index currently exists, it will from setUp method
		$this->assertTrue($this->service->getIndex()->exists());

		// Ensure the index exists when it already exists case
		$this->invokeMethod($this->service, 'ensureIndex', array());
		$this->assertTrue($this->service->getIndex()->exists());

		// Delete and assert that it does not exist
		$this->service->getIndex()->delete();
		$this->assertFalse($this->service->getIndex()->exists());

		// Ensure the index exists when it does not exist case
		$this->invokeMethod($this->service, 'ensureIndex', array());
		$this->assertTrue($this->service->getIndex()->exists());
	}


	public function testShowInSearch() {
		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);

		$fp = Page::get()->first();
		$fp->ShowInSearch = false;
		$fp->write();
		$this->service->getIndex()->refresh();

		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);

		$fp->ShowInSearch = true;
		$fp->write();
		$this->service->getIndex()->refresh();

		$this->checkNumberOfIndexedDocuments($nDocsAtStart);
	}


	public function testUnpublish() {
		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);

		$fp = Page::get()->first();
		$fp->doUnpublish();

		$this->service->getIndex()->refresh();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
	}


	public function testDeleteFromSiteTree() {
		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);

		$fp = Page::get()->first();
		$fp->delete();

		$this->service->getIndex()->refresh();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
	}


	public function testDeleteDataObject() {
		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);

		$fp = FlickrPhotoTO::get()->first();
		$fp->delete();

		$this->service->getIndex()->refresh();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
	}


	public function testBulkIndexing() {
		//Reset the index, so that nothing has been indexed
		$this->service->reset();

		//Number of requests indexing wise made to Elasticsearch server
		$reqs = $this->service->getIndexingRequestCtr();

		$task = new ReindexTask($this->service);

		// null request is fine as no parameters used
		$task->run(null);

		//Check that the number of indexing requests has increased by 2
		$deltaReqs = $this->service->getIndexingRequestCtr() - $reqs;
		//One call is made for each of Page and FlickrPhotoTO
		$this->assertEquals(2,$deltaReqs);

The method assertEquals() does not seem to exist on object<ElasticaServiceTest>.

		// default installed pages plus 100 FlickrPhotoTOs
		$this->checkNumberOfIndexedDocuments(103);
	}

	public function testNonBulkIndexing() {
		//Number of requests indexing wise made to Elasticsearch server
		$reqs = $this->service->getIndexingRequestCtr();
		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);

		//Check index size after each document indexed
		$fp = new FlickrPhotoTO();
		$fp->Title = 'The cat sits on the mat';

The property Title does not exist on object<FlickrPhotoTO>. Since you implemented __set, maybe consider adding a @property annotation.

		$fp->write();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart+1);

		$fp2 = new FlickrPhotoTO();
		$fp2->Title = 'The cat sat on the hat';

The property Title does not exist on object<FlickrPhotoTO>. Since you implemented __set, maybe consider adding a @property annotation.

		$fp2->write();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart+2);

		$fp3 = new FlickrPhotoTO();
		$fp3->Title = 'The bat flew around the cat';

The property Title does not exist on object<FlickrPhotoTO>. Since you implemented __set, maybe consider adding a @property annotation.

		$fp3->write();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart+3);

		//Check that the number of indexing requests has increased by 3
		$deltaReqs = $this->service->getIndexingRequestCtr() - $reqs;
		$this->assertEquals(3,$deltaReqs);

The method assertEquals() does not seem to exist on object<ElasticaServiceTest>.

	}



	/*
	Check for classes that should be there.   Others will possibly exist depending on
	which other modules are installed, hence no array comparison
	 */
	public function testGetIndexedClasses() {
		$this->service->setTestMode(false);

		$indexedClasses = $this->service->getIndexedClasses();

		// Just the non testable classes
		$this->assertContains('Page', $indexedClasses);
		$this->assertContains('SiteTree', $indexedClasses);


		// Get all classes including the test ones
		$this->service->setTestMode(true);
		$indexedClasses = $this->service->getIndexedClasses();
		$this->assertContains('Page', $indexedClasses);
		$this->assertContains('SiteTree', $indexedClasses);
		$this->assertContains('FlickrPhotoTO', $indexedClasses);
		$this->assertContains('FlickrSetTO', $indexedClasses);
		$this->assertContains('FlickrTagTO', $indexedClasses);
		$this->assertContains('SearchableTestPage', $indexedClasses);

	}


	/*
	-------------------------------
	FIXME: The following tests are problematic in that I'm not sure exactly what to check for
	to differentiate between deleted, reset, recreated etc.  It seems that checking an index
	status recreates a virgin copy of the index
	-------------------------------
	 */

	public function testResetIndex() {
		$index = $this->service->getIndex();

$index is not used, you could remove the assignment.

		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);
		$this->service->reset();
		$this->checkNumberOfIndexedDocuments(0);
	}


	public function testDeleteIndex() {
		$index = $this->service->getIndex();
		$this->assertTrue($index->exists());

		// Check the number of documents
		$nDocsAtStart = $this->getNumberOfIndexedDocuments();
		$this->checkNumberOfIndexedDocuments($nDocsAtStart);


		// Delete the index
		$task = new DeleteIndexTask($this->service);

		//null request is fine as no parameters used
		$task->run(null);

		$this->checkNumberOfIndexedDocuments(0);

		//FIXME better options for testing here?
	}


	public function testListIndexes() {
		$message = 'This is a test trace';
		$trace = $this->service->listIndexes($message);
		$this->assertContains('elastica_ss_module_test_en_us', print_r($trace,1));
	}
}