ElasticsearchBaseTest::setUp() - Code Metrics - Inspection of "MINOR: Added debug to try and diagnose cause of er..." - gordonbanderson/silverstripe-elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev2 ( 88484c...a481f8 )

by Gordon

created 2015-12-30 11:19 UTC

ElasticsearchBaseTest::setUp() B

↳ Parent: Project

Complexity

Conditions	4
Paths	6

Size

Total Lines	50
Code Lines	24

Duplication

Lines	6
Ratio	12 %

Code Coverage

Tests	24
CRAP Score	4.0467

Metric	Value
dl	6
loc	50
ccs	24
cts	28
cp	0.8571
rs	8.8571
cc	4
eloc	24
nc	6
nop	0
crap	4.0467

<?php
use SilverStripe\Elastica\ElasticaUtil;
use SilverStripe\Elastica\ReindexTask;
use SilverStripe\Elastica\ElasticaService;

class ElasticsearchBaseTest extends SapphireTest {

	public static $ignoreFixtureFileFor = array();

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


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

		// 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');


		$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() {
		// no need to index here as it's done when fixtures are loaded during setup method
		$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;


		// 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) {
			$pattern = '/'.$testPattern.'/';
			if (preg_match($pattern, $this->getName())) {
				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);

	}


	protected function devBuild() {
		$task = new \BuildTask();
		// 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');
		}
	}


	public function generateAssertionsFromArray($toAssert) {
		echo '$expected = array('."\n";
		foreach ($toAssert as $key => $value) {
			$escValue = str_replace("'", '\\\'', $value);
			echo "'$key' => '$escValue',\n";
		}
		echo ");\n";
		echo '$this->assertEquals($expected, $somevar);'."\n";
	}


	public function generateAssertionsFromArray1D($toAssert) {
		echo '$expected = array('."\n";
		foreach ($toAssert as $key => $value) {
			$escValue = str_replace("'", '\\\'', $value);
			echo "'$escValue',";
		}
		echo ");\n";
		echo '$this->assertEquals($expected, $somevar);'."\n";
	}


	public function generateAssertionsFromArrayRecurse($toAssert) {
		echo '$expected = ';
			$this->recurseArrayAssertion($toAssert,1, 'FIXME');
		echo '$this->assertEquals($expected, $somevar);'."\n";
	}


	private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
		$prefix = str_repeat("\t",$depth);
		echo "\t{$prefix}'$parentKey' => array(\n";
		$ctr = 0;
		$len = sizeof(array_keys($toAssert));
		foreach ($toAssert as $key => $value) {
			if (is_array($value)) {
				$this->recurseArrayAssertion($value, $depth+1, $key);
			} else {
				$escValue = str_replace("'", '\\\'', $value);
				$comma = ',';
				if ($ctr == $len-1) {
					$comma = '';
				}
				echo "\t\t$prefix'$key' => '$escValue'$comma\n";
			}

			$ctr++;

		}
		echo "\t$prefix),\n";

	}


	/*
	Helper methods for testing CMS fields
	 */
	public function checkTabExists($fields, $tabName) {
		$tab = $fields->findOrMakeTab("Root.{$tabName}");
		$actualTabName = $tab->getName();
		$splits = explode('.', $tabName);
		$size = sizeof($splits);
		$nameToCheck = end($splits);
		$this->assertEquals($actualTabName, $nameToCheck);
		if ($size == 1) {
			$this->assertEquals("Root_${tabName}", $tab->id());
		} else {
			$expected = "Root_{$splits[0]}_set_{$splits[1]}";
			$this->assertEquals($expected, $tab->id());
		}

		return $tab;
	}


	public function checkFieldExists($tab,$fieldName) {
		$fields = $tab->Fields();
		$field = $tab->fieldByName($fieldName);
		$this->assertTrue($field != null);
		return $field;
	}


	/**
	 * From https://jtreminio.com/2013/03/unit-testing-tutorial-part-3-testing-protected-private-methods-coverage-reports-and-crap/
	 * Call protected/private method of a class.
	 *
	 * @param object &$object    Instantiated object that we will run method on.
	 * @param string $methodName Method name to call
	 * @param array  $parameters Array of parameters to pass into method.
	 *
	 * @return mixed Method return.
	 */
	public function invokeMethod(&$object, $methodName, array $parameters = array())
	{
	    $reflection = new \ReflectionClass(get_class($object));
	    $method = $reflection->getMethod($methodName);
	    $method->setAccessible(true);

	    return $method->invokeArgs($object, $parameters);
	}


	public function checkNumberOfIndexedDocuments($expectedAmount) {
		$index = $this->service->getIndex();
		$status = $index->getStatus()->getData();

		$numberDocsInIndex = -1; // flag value for not yet indexed
		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
			error_log('CHECKING NUMBER OF INDEXED DOCUMENTS, SHOULD BE ' . $expectedAmount);
			error_log(print_r($status,1));
			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
			error_log('DOCUMENTS FOUND:'.$numberDocsInIndex)
		}


		$this->assertEquals($expectedAmount,$numberDocsInIndex);
	}

	/*
	Get the number of documents in an index.  It is assumed the index exists, if not the test will fail
	 */
	public function getNumberOfIndexedDocuments() {
		$index = $this->service->getIndex();
		$status = $index->getStatus()->getData();

		$numberDocsInIndex = -1; // flag value for not yet indexed
		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
		}

		$this->assertGreaterThan(-1, $numberDocsInIndex);
		return $numberDocsInIndex;
	}
}


1		<?php
2		use SilverStripe\Elastica\ElasticaUtil;
3		use SilverStripe\Elastica\ReindexTask;
4		use SilverStripe\Elastica\ElasticaService;
5
6		class ElasticsearchBaseTest extends SapphireTest {
7
8		public static $ignoreFixtureFileFor = array();
9
10		protected $extraDataObjects = array(
11		'SearchableTestPage','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO','FlickrTagTO',
12		'SearchableTestFatherPage','SearchableTestGrandFatherPage','AutoCompleteOption'
13		);
14
15
16		public function setUpOnce() {
17		ElasticaUtil::setPrinterOutput(false);
18
19		// add Searchable extension where appropriate
20		FlickrSetTO::add_extension('SilverStripe\Elastica\Searchable');
21		FlickrPhotoTO::add_extension('SilverStripe\Elastica\Searchable');
22		FlickrTagTO::add_extension('SilverStripe\Elastica\Searchable');
23		FlickrAuthorTO::add_extension('SilverStripe\Elastica\Searchable');
24		SearchableTestPage::add_extension('SilverStripe\Elastica\Searchable');
25
26
27		$config = Config::inst();
28		$config->remove('Injector', 'SilverStripe\Elastica\ElasticaService');
29		$constructor = array('constructor' => array('%$Elastica\Client', 'elastica_ss_module_test'));
30		$config->update('Injector', 'SilverStripe\Elastica\ElasticaService', $constructor);
31		parent::setUpOnce();
32		}
33
34
35	1	public function setUp() {
36		// no need to index here as it's done when fixtures are loaded during setup method
37	1	$cache = SS_Cache::factory('elasticsearch');
38	1	$cache->clean(Zend_Cache::CLEANING_MODE_ALL);
39	1	SS_Cache::set_cache_lifetime('elasticsearch', 3600, 1000);
40
41		// this needs to be called in order to create the list of searchable
42		// classes and fields that are available. Simulates part of a build
43	1	$classes = array('SearchableTestPage','SiteTree','Page','FlickrPhotoTO','FlickrSetTO',
44	1	'FlickrTagTO', 'FlickrAuthorTO');
45	1	$this->requireDefaultRecordsFrom = $classes;
46
47
48		// clear the index
49	1	$this->service = Injector::inst()->create('SilverStripe\Elastica\ElasticaService');
50	1	$this->service->setTestMode(true);
51
52		// A previous test may have deleted the index and then failed, so check for this
53	1	if (!$this->service->getIndex()->exists()) {
54	1	$this->service->getIndex()->create();
55	1	}
56	1	$this->service->reset();
57
58		// FIXME - use request getVar instead?
59	1	$_GET['progress'] = 20;
60		// load fixtures
61
62	1	$orig_fixture_file = static::$fixture_file;
63
64	1	foreach (static::$ignoreFixtureFileFor as $testPattern) {
65		$pattern = '/'.$testPattern.'/';
66		if (preg_match($pattern, $this->getName())) {
67		static::$fixture_file = null;
68		}
69	1	}
70
71	1	parent::setUp();
72	1	static::$fixture_file = $orig_fixture_file;
73
74	1	$this->publishSiteTree();
75
76	1	$this->service->reset();
77
78		// index loaded fixtures
79	1	$task = new ReindexTask($this->service);
80		// null request is fine as no parameters used
81
82	1	$task->run(null);
83
84	1	}
85
86
87		protected function devBuild() {
88		$task = new \BuildTask();
89		// null request is fine as no parameters used
90		$task->run(null);
91		}
92
93
94	1	private function publishSiteTree() {
95	1	foreach (SiteTree::get()->getIterator() as $page) {
96		// temporarily disable Elasticsearch indexing, it will be done in a batch
97	1	$page->IndexingOff = true;
98	1	$page->publish('Stage','Live');
99	1	}
100	1	}
101
102
103		public function generateAssertionsFromArray($toAssert) {
104		echo '$expected = array('."\n";
105		foreach ($toAssert as $key => $value) {
106		$escValue = str_replace("'", '\\\'', $value);
107		echo "'$key' => '$escValue',\n";
108		}
109		echo ");\n";
110		echo '$this->assertEquals($expected, $somevar);'."\n";
111		}
112
113
114		public function generateAssertionsFromArray1D($toAssert) {
115		echo '$expected = array('."\n";
116		foreach ($toAssert as $key => $value) {
117		$escValue = str_replace("'", '\\\'', $value);
118		echo "'$escValue',";
119		}
120		echo ");\n";
121		echo '$this->assertEquals($expected, $somevar);'."\n";
122		}
123
124
125		public function generateAssertionsFromArrayRecurse($toAssert) {
126		echo '$expected = ';
127		$this->recurseArrayAssertion($toAssert,1, 'FIXME');
128		echo '$this->assertEquals($expected, $somevar);'."\n";
129		}
130
131
132		private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
133		$prefix = str_repeat("\t",$depth);
134		echo "\t{$prefix}'$parentKey' => array(\n";
135		$ctr = 0;
136		$len = sizeof(array_keys($toAssert));
137		foreach ($toAssert as $key => $value) {
138		if (is_array($value)) {
139		$this->recurseArrayAssertion($value, $depth+1, $key);
140		} else {
141		$escValue = str_replace("'", '\\\'', $value);
142		$comma = ',';
143		if ($ctr == $len-1) {
144		$comma = '';
145		}
146		echo "\t\t$prefix'$key' => '$escValue'$comma\n";
147		}
148
149		$ctr++;
150
151		}
152		echo "\t$prefix),\n";
153
154		}
155
156
157		/*
158		Helper methods for testing CMS fields
159		*/
160		public function checkTabExists($fields, $tabName) {
161		$tab = $fields->findOrMakeTab("Root.{$tabName}");
162		$actualTabName = $tab->getName();
163		$splits = explode('.', $tabName);
164		$size = sizeof($splits);
165		$nameToCheck = end($splits);
166		$this->assertEquals($actualTabName, $nameToCheck);
167		if ($size == 1) {
168		$this->assertEquals("Root_${tabName}", $tab->id());
169		} else {
170		$expected = "Root_{$splits[0]}_set_{$splits[1]}";
171		$this->assertEquals($expected, $tab->id());
172		}
173
174		return $tab;
175		}
176
177
178		public function checkFieldExists($tab,$fieldName) {
179		$fields = $tab->Fields();
180		$field = $tab->fieldByName($fieldName);
181		$this->assertTrue($field != null);
182		return $field;
183		}
184
185
186		/**
187		* From https://jtreminio.com/2013/03/unit-testing-tutorial-part-3-testing-protected-private-methods-coverage-reports-and-crap/
188		* Call protected/private method of a class.
189		*
190		* @param object &$object Instantiated object that we will run method on.
191		* @param string $methodName Method name to call
192		* @param array $parameters Array of parameters to pass into method.
193		*
194		* @return mixed Method return.
195		*/
196		public function invokeMethod(&$object, $methodName, array $parameters = array())
197		{
198		$reflection = new \ReflectionClass(get_class($object));
199	1	$method = $reflection->getMethod($methodName);
200		$method->setAccessible(true);
201
202		return $method->invokeArgs($object, $parameters);
203		}
204
205
206		public function checkNumberOfIndexedDocuments($expectedAmount) {
207	1	$index = $this->service->getIndex();
208	1	$status = $index->getStatus()->getData();
209
210	1	$numberDocsInIndex = -1; // flag value for not yet indexed
211	1	if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
212	1	error_log('CHECKING NUMBER OF INDEXED DOCUMENTS, SHOULD BE ' . $expectedAmount);
213	1	error_log(print_r($status,1));
214		$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
215	1	error_log('DOCUMENTS FOUND:'.$numberDocsInIndex)
216	1	}
		0 ignored issues – show Bug introduced 2015-12-30 11:37 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected '}' Loading history...
217
218		$this->assertEquals($expectedAmount,$numberDocsInIndex);
219		}
220
221		/*
222	1	Get the number of documents in an index. It is assumed the index exists, if not the test will fail
223	1	*/
224		public function getNumberOfIndexedDocuments() {
225	1	$index = $this->service->getIndex();
226	1	$status = $index->getStatus()->getData();
227	1
228	1	$numberDocsInIndex = -1; // flag value for not yet indexed
229		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
230	1	$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
231	1	}
232
233		$this->assertGreaterThan(-1, $numberDocsInIndex);
234		return $numberDocsInIndex;
235		}
236		}
237

gordonbanderson / silverstripe-elastica

Push — dev2 ( 88484c...a481f8 )

ElasticsearchBaseTest::setUp() B

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like