ElasticsearchFunctionalTestBase

Complexity

Total Complexity

18

Size/Duplication

Total Lines	171
Duplicated Lines	3.51 %

Coupling/Cohesion

Components	2
Dependencies	13

Test Coverage

Coverage

0%

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setUpOnce()	0	9	1
A	assertAttributeHasExactValue()	0	6	2
A	assertAttributesHaveExactValues()	0	11	3
A	assertNumberOfNodes()	0	9	2
A	setUp()	6	58	4
A	publishSiteTree()	0	8	2
A	assertSelectorStartsWithOrEquals()	0	19	2
A	collateSearchResults()	0	10	2

<?php

use SilverStripe\Elastica\ReindexTask;
use SilverStripe\Elastica\ElasticaService;
use SilverStripe\Elastica\ElasticaUtil;


class ElasticsearchFunctionalTestBase extends FunctionalTest {
	public static $ignoreFixtureFileFor = array();

	protected $extraDataObjects = array(
		'SearchableTestPage','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO','FlickrTagTO',
		'SearchableTestFatherPage','SearchableTestGrandFatherPage'
	);


	public function setUpOnce() {
		ElasticaUtil::setPrinterOutput(false);

		$config = Config::inst();
		$config->remove('Injector', 'SilverStripe\Elastica\ElasticaService');
		$constructor = array('constructor' => array('%$Elastica\Client', 'elastica_ss_module_test'));
		$config->update('Injector', 'SilverStripe\Elastica\ElasticaService', $constructor);
		parent::setUpOnce();
	}


	public function setUp() {

setUp uses the super-global variable $_GET which is generally not recommended.

		echo "*************** TEST: ".$this->getName();

The method getName() does not seem to exist on object<ElasticsearchFunctionalTestBase>.

		$cache = SS_Cache::factory('elasticsearch');
		$cache->clean(Zend_Cache::CLEANING_MODE_ALL);
		SS_Cache::set_cache_lifetime('elasticsearch', 3600, 1000);

		// this needs to be called in order to create the list of searchable
		// classes and fields that are available.  Simulates part of a build
		$classes = array('SearchableTestPage','SiteTree','Page','FlickrPhotoTO','FlickrSetTO',
			'FlickrTagTO', 'FlickrAuthorTO');
		$this->requireDefaultRecordsFrom = $classes;

		// add Searchable extension where appropriate
		FlickrSetTO::add_extension('SilverStripe\Elastica\Searchable');
		FlickrPhotoTO::add_extension('SilverStripe\Elastica\Searchable');
		FlickrTagTO::add_extension('SilverStripe\Elastica\Searchable');
		FlickrAuthorTO::add_extension('SilverStripe\Elastica\Searchable');
		SearchableTestPage::add_extension('SilverStripe\Elastica\Searchable');

		// clear the index
		$this->service = Injector::inst()->create('SilverStripe\Elastica\ElasticaService');
		$this->service->setTestMode(true);

		// A previous test may have deleted the index and then failed, so check for this
		if (!$this->service->getIndex()->exists()) {
			$this->service->getIndex()->create();
		}
		$this->service->reset();

		// FIXME - use request getVar instead?
		$_GET['progress'] = 20;
		// load fixtures

		$orig_fixture_file = static::$fixture_file;

		foreach (static::$ignoreFixtureFileFor as $testPattern) {

This code seems to be duplicated across your project.

			$pattern = '/'.$testPattern.'/';
			if (preg_match($pattern, $this->getName())) {

The method getName() does not seem to exist on object<ElasticsearchFunctionalTestBase>.

				static::$fixture_file = null;
			}
		}

		parent::setUp();
		static::$fixture_file = $orig_fixture_file;

		$this->publishSiteTree();

		$this->service->reset();

		// index loaded fixtures
		$task = new ReindexTask($this->service);
		// null request is fine as no parameters used

		$task->run(null);

	}


	private function publishSiteTree() {
		foreach (SiteTree::get()->getIterator() as $page) {
			// temporarily disable Elasticsearch indexing, it will be done in a batch
			$page->IndexingOff = true;

			$page->publish('Stage','Live');
		}
	}


	//---- The HTML for search results is too long to check for, so instead check just the starting text ----

	/**
	 *Assert that the indexth matching css node has a prefix as expected
	 *
	 * Note:   characters are stripped from the content; make sure that your assertions take this into account.
	 *
	 * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
	 * @param array|string $expectedMatches The content of at least one of the matched tags

There is no parameter named $expectedMatches. Was it maybe removed?

	 * @throws PHPUnit_Framework_AssertionFailedError
	 * @return boolean
	 */
	public function assertSelectorStartsWithOrEquals($selector, $index, $expectedPrefix) {
		$items = $this->cssParser()->getBySelector($selector);

		$ctr = 0;
		foreach ($items as $item) {
			$text = strip_tags($item);
			$escaped = str_replace("'", "\'", $text);

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

			$ctr++;
		}

		$ctr = 0;

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

		$item = strip_tags($items[$index]);


		$errorMessage = "Failed to assert that '$item' started with '$expectedPrefix'";
		$this->assertStringStartsWith($expectedPrefix, $item, $errorMessage);

The method assertStringStartsWith() does not seem to exist on object<ElasticsearchFunctionalTestBase>.

		return true;
	}


	/*
	Check all the nodes matching the selector for attribute name = expected value
	 */
	public function assertAttributeHasExactValue($selector, $attributeName, $expectedValue) {

The parameter $attributeName is not used and could be removed.

		$items = $this->cssParser()->getBySelector($selector);
		foreach ($items as $item) {
			$this->assertEquals($expectedValue, $item['value']);

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

		}
	}


	public function assertAttributesHaveExactValues($selector, $expectedValues) {
		$attributeNames = array_keys($expectedValues);
		$items = $this->cssParser()->getBySelector($selector);
		foreach ($items as $item) {
			$actualValues = array();
			foreach ($attributeNames as $attributeName) {
				$actualValues[$attributeName] = (string)$item[$attributeName];
			}
			$this->assertEquals($expectedValues, $actualValues);

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

		}
	}


	public function assertNumberOfNodes($selector, $expectedAmount) {
		$items = $this->cssParser()->getBySelector($selector);
		foreach ($items as $item) {
			$text = strip_tags($item);

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

		}

		$ct = sizeof($items);
		$this->assertEquals($expectedAmount, $ct);

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

	}


	/* Collect an array of all the <ClassName>_<ID> search results, used for checking pagination */
	public function collateSearchResults() {
		$items = $this->cssParser()->getBySelector('div.searchResults .searchResult');
		$result = array();
		foreach ($items as $item) {
			$attr = $item->attributes()->id;
			array_push($result, $attr."");
		}

		return $result;
	}

}