ElasticSearcherUnitTest::testSimilarGood() - Code Metrics - Inspection of "WIP: Adding debug to diagnose tests" - gordonbanderson/silverstripe-elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev2 ( 7beecf...3e9e50 )

by Gordon

created 2015-12-30 12:19 UTC

ElasticSearcherUnitTest::testSimilarGood() B

↳ Parent: ElasticSearcherUnitTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	24
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Metric	Value
dl	0
loc	24
ccs	0
cts	20
cp	0
rs	8.9714
cc	2
eloc	20
nc	2
nop	0
crap	6

<?php
use SilverStripe\Elastica\ElasticSearcher;
use Elastica\Type;
class ElasticSearcherUnitTest extends ElasticsearchBaseTest {
	public static $fixture_file = 'elastica/tests/lotsOfPhotos.yml';

	public static $ignoreFixtureFileFor = array('testResultsForEmptySearch');

	public function setUp() {
		parent::setUp();
	}

	public function tearDown() {
		parent::tearDown();
	}


	public function testSuggested() {
		$es = new ElasticSearcher();
		$locale = \i18n::default_locale();
		$es->setLocale($locale);
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title' => 1, 'Description' => 1);
		$results = $es->search('New Zealind', $fields, true);
		$this->assertEquals(100, $results->getTotalItems());
		$this->assertEquals('New Zealand', $es->getSuggestedQuery());
	}


	public function testResultsForEmptySearch() {
		$es = new ElasticSearcher();

		$es->hideResultsForEmptySearch();
		$this->assertFalse($es->getShowResultsForEmptySearch());

		$es->showResultsForEmptySearch();
		$this->assertTrue($es->getShowResultsForEmptySearch());
	}


	public function testMoreLikeThisSinglePhoto() {
		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$locale = \i18n::default_locale();
		$es->setLocale($locale);
		$es->setClasses('FlickrPhotoTO');

		$fields = array('Description.standard' => 1, 'Title.standard' => 1);
		$results = $es->moreLikeThis($fp, $fields, true);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$terms = $results->getList()->MoreLikeThisTerms;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

		$fieldNamesReturned = array_keys($terms);
		$fieldNames = array_keys($fields);
		sort($fieldNames);
		sort($fieldNamesReturned);

		$this->assertEquals($fieldNames, $fieldNamesReturned);

		//FIXME - this seems anomolyous, check in more detail
		$expected = array('texas');
		$this->assertEquals($expected, $terms['Title.standard']);

		$expected = array('collection', 'company', 'degolyer', 'everett', 'file', 'high',
			'information', 'new', 'orleans', 'pacific', 'photographs', 'railroad', 'resolution',
			'see', 'southern', 'texas', 'view');



		$actual = $terms['Description.standard'];
		sort($expected);
		sort($actual);


		$this->assertEquals($expected, $actual);
	}



	public function testSimilarNoWeighting() {

		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard', 'Description.standard');
		try {
			$paginated = $es->moreLikeThis($fp, $fields, true);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$this->fail('Query has no weight and thus should have failed');
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('Fields must be of the form fieldname => weight', $e->getMessage());
		}
	}


	public function testSimilarWeightingNotNumeric() {

		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 4, 'Description.standard' => 'not numeric');
		try {
			$paginated = $es->moreLikeThis($fp, $fields, true);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$this->fail('Query has non numeric weight and thus should have failed');
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('Fields must be of the form fieldname => weight', $e->getMessage());
		}
	}


	public function testSimilarToNonSearchable() {

		$m = Member::get()->first(); // this is not by default Searchable

		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 4, 'Description.standard' => 2);
		try {
			$paginated = $es->moreLikeThis($m, $fields, true);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$this->fail('Querying for a non searchable object, thus should have failed');
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('Objects of class Member are not searchable', $e->getMessage());
		}
	}

	public function testSimilarGood() {
		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
		$paginated = $es->moreLikeThis($fp, $fields, true);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		foreach($results as $result) {
function someFunction() {
    $x = 5;
    echo $x;
}
			error_log('RESULT:' . $result->Title);
		}

		$this->assertEquals(32, $paginated->getTotalItems());
		$results = $paginated->getList()->toArray();
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Railroad Station, Stockdale, Texas]", $results[0]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Railroad Station, Taft, Texas]", $results[1]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Railroad Station, Sierra Blanca, Texas]", $results[2]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Freight Station, Waxahachie, Texas]", $results[3]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Passenger Station, Waxahachie, Texas]", $results[4]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific, Tower No. 63, Mexia, Texas]", $results[5]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific, Eakin Street Yard Office, Dallas, Texas]", $results[6]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific Locomotive Scrap Line, Englewood Yards, Houston, Texas]", $results[7]->Title);
		$this->assertEquals("[Texas and New Orleans, Southern Pacific, Switchman's Tower, San Antonio, Texas]", $results[8]->Title);
		$this->assertEquals("Flash Light view in new Subterranean", $results[9]->Title);
	}


	// if this is not set to unbounded, zero, a conditional is triggered to add max doc freq to the request
	public function testSimilarChangeMaxDocFreq() {
		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setMaxDocFreq(4);
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
		$paginated = $es->moreLikeThis($fp, $fields, true);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$this->assertEquals(14, $paginated->getTotalItems());
		$results = $paginated->getList()->toArray();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$this->makeCode($paginated);
	}


	public function testSimilarNullFields() {
		$fp = $this->objFromFixture('FlickrPhotoTO', 'photo0076');
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		try {
			$paginated = $es->moreLikeThis($fp, null, true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('Fields cannot be null', $e->getMessage());
		}
	}


	public function testSimilarNullItem() {
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title.standard' => 1, 'Description.standard' => 1);

		try {
			$paginated = $es->moreLikeThis(null, $fields, true);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		} catch (InvalidArgumentException $e) {
			$this->assertEquals('A searchable item cannot be null', $e->getMessage());
		}
	}



	public function testHighlightsAsIfCMSEdited() {
		$es = new ElasticSearcher();
		$locale = \i18n::default_locale();
		$es->setLocale($locale);
		$es->setClasses('FlickrPhotoTO');

		$filter = array('ClazzName' => 'FlickrPhotoTO', 'Name' => 'Title');
		$titleField = SearchableField::get()->filter($filter)->first();
		$titleField->ShowHighlights = true;
		$titleField->write();

		$filter = array('ClazzName' => 'FlickrPhotoTO', 'Name' => 'Description');
		$nameField = SearchableField::get()->filter($filter)->first();
		$nameField->ShowHighlights = true;
		$nameField->write();

		$fields = array('Title' => 1, 'Description' => 1);
		$query = 'New Zealand';
		$paginated = $es->search($query, $fields);
		$ctr = 0;

		foreach ($paginated->getList()->toArray() as $result) {
			$ctr++;
			foreach ($result->SearchHighlightsByField->Description_standard->getIterator() as $highlight) {
				$snippet = $highlight->Snippet;
				$snippet = strtolower($snippet);
				$wordFound = false;
				$lcquery = explode(' ', strtolower($query));
				foreach ($lcquery as $part) {
					$bracketed = '<strong class="hl">' . $part . '</strong>';
					if (strpos($snippet, $bracketed) > 0) {
						$wordFound = true;
					}
				}
				$this->assertTrue($wordFound, 'Highlight should have been found');
			}
		}
	}


	public function testHighlightPassingFields() {
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$es->setHighlightedFields(array('Title', 'Title.standard', 'Description'));

		$fields = array('Title' => 1, 'Description' => 1);
		$query = 'New Zealand';
		$paginated = $es->search($query, $fields);
		$ctr = 0;

		foreach ($paginated->getList()->toArray() as $result) {
			$ctr++;

			foreach ($result->SearchHighlightsByField->Description->getIterator() as $highlight) {
				$snippet = $highlight->Snippet;
				$snippet = strtolower($snippet);
				$wordFound = false;
				$lcquery = explode(' ', strtolower($query));
				foreach ($lcquery as $part) {
					$bracketed = '<strong class="hl">' . $part . '</strong>';
					if (strpos($snippet, $bracketed) > 0) {
						$wordFound = true;
					}
				}
				$this->assertTrue($wordFound, 'Highlight should have been found');
			}
		}
	}


	public function testAutoCompleteGood() {
		$es = new ElasticSearcher();
		$es->setClasses('FlickrPhotoTO');
		$fields = array('Title' => 1, 'Description' => 1);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$query = 'Lond';
		$results = $es->autocomplete_search($query, 'Title');
		$this->assertEquals(7, $results->getTotalItems());
		foreach ($results->toArray() as $result) {
			$this->assertTrue(strpos($result->Title, $query) > 0);
		}
	}


	private function makeCode($paginated) {

		$results = $paginated->getList()->toArray();
		$ctr = 0;
		echo '$result = $paginated->getList()->toArray();' . "\n";
		foreach ($results as $result) {
			echo '$this->assertEquals("' . $result->Title . '", $results[' . $ctr . ']->Title);' . "\n";
			$ctr++;
		}
	}

}


1			<?php
2			use SilverStripe\Elastica\ElasticSearcher;
3			use Elastica\Type;
4			class ElasticSearcherUnitTest extends ElasticsearchBaseTest {
5			public static $fixture_file = 'elastica/tests/lotsOfPhotos.yml';
6
7			public static $ignoreFixtureFileFor = array('testResultsForEmptySearch');
8
9			public function setUp() {
10			parent::setUp();
11			}
12
13			public function tearDown() {
14			parent::tearDown();
15			}
16
17
18			public function testSuggested() {
19			$es = new ElasticSearcher();
20			$locale = \i18n::default_locale();
21			$es->setLocale($locale);
22			$es->setClasses('FlickrPhotoTO');
23			$fields = array('Title' => 1, 'Description' => 1);
24			$results = $es->search('New Zealind', $fields, true);
25			$this->assertEquals(100, $results->getTotalItems());
26			$this->assertEquals('New Zealand', $es->getSuggestedQuery());
27			}
28
29
30			public function testResultsForEmptySearch() {
31			$es = new ElasticSearcher();
32
33			$es->hideResultsForEmptySearch();
34			$this->assertFalse($es->getShowResultsForEmptySearch());
35
36			$es->showResultsForEmptySearch();
37			$this->assertTrue($es->getShowResultsForEmptySearch());
38			}
39
40

gordonbanderson / silverstripe-elastica

Push — dev2 ( 7beecf...3e9e50 )

ElasticSearcherUnitTest::testSimilarGood() B

Complexity

Size

Duplication

Code Coverage

Available Fixes

Duplication Side-by-Side

Filter issues like