SearchableFieldTest

Complexity

Total Complexity

16

Size/Duplication

Total Lines	139
Duplicated Lines	39.57 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

97.65%

8 Methods

Rating	Name	Duplication	Size	Complexity
A	testCMSFields()	0	14	1
B	testZeroWeight()	28	28	5
B	testNegativeWeight()	27	27	5
A	testDefaultWeight()	0	7	1
A	testPositiveWeight()	0	8	1
A	testHumanReadableSearchable()	0	16	1
A	testCanDelete()	0	4	1
A	testCanCreate()	0	4	1

<?php

/**
 * Test the functionality of the Searchable extension
 * @package elastica
 */
class SearchableFieldTest extends ElasticsearchBaseTest {
	public static $fixture_file = 'elastica/tests/ElasticaTest.yml';

	public function testCMSFields() {
		$sf = new SearchableField();
		$sf->Name = 'TestField';

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

		$sf->ClazzName = 'TestClazz';

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

		$sf->write();

		$fields = $sf->getCMSFields();

		$tab = $this->checkTabExists($fields,'Main');

		//Check fields
		$nf = $this->checkFieldExists($tab, 'Name');
		$this->assertTrue($nf->isDisabled());
	}




	/* Zero weight is pointless as it means not part of the search */
	public function testZeroWeight() {

This method seems to be duplicated in your project.

		$searchPage = $this->objFromFixture('ElasticSearchPage', 'search');
		$lastEdited = $searchPage->LastEdited;

		$extraFields = array('Searchable' => 1, 'SimilarSearchable' => 1, 'Active' => 1,
			'Weight' => 0);
		$esfs = $searchPage->ElasticaSearchableFields();

The method ElasticaSearchableFields() does not exist on DataObject. Did you maybe mean searchableFields()?

		foreach ($esfs as $sf) {
			if ($sf->Name == 'Title' || $sf->Name == 'Description') {
				$esfs->remove($sf);
				$esfs->add($sf, $extraFields);
			}
		}

		try {
			$searchPage->write();
			$this->fail('Searchable fail should have failed to write');
		} catch (ValidationException $e) {
			$this->assertInstanceOf('ValidationException', $e);

The method assertInstanceOf() does not seem to exist on object<SearchableFieldTest>.

			$expected = 'The field SearchableTestPage.Title has a zero weight. ; The field '.
			'SiteTree.Title has a zero weight. ; The field Page.Title has a zero weight. ';
			$this->assertEquals($expected, $e->getMessage());
		}

		//Effectively assert that the search page has not been written by checking LastEdited
		$pageFromDB = DataObject::get_by_id('ElasticSearchPage', $searchPage->ID);
		$this->assertEquals($lastEdited, $pageFromDB->LastEdited);
	}


	/* Weights must be positive */
	public function testNegativeWeight() {

This method seems to be duplicated in your project.

		$searchPage = $this->objFromFixture('ElasticSearchPage', 'search');
		$lastEdited = $searchPage->LastEdited;

		$extraFields = array('Searchable' => 1, 'SimilarSearchable' => 1, 'Active' => 1,
			'Weight' => -1);
		$esfs = $searchPage->ElasticaSearchableFields();

The method ElasticaSearchableFields() does not exist on DataObject. Did you maybe mean searchableFields()?

		foreach ($esfs as $sf) {
			if ($sf->Name == 'Title' || $sf->Name == 'Description') {
				$esfs->remove($sf);
				$esfs->add($sf, $extraFields);
			}
		}

		try {
			$searchPage->write();
			$this->fail('Searchable fail should have failed to write');
		} catch (ValidationException $e) {
			$this->assertInstanceOf('ValidationException', $e);
			$expected = 'The field SearchableTestPage.Title has a negative weight. ; The field '.
			'SiteTree.Title has a negative weight. ; The field Page.Title has a negative weight. ';
			$this->assertEquals($expected, $e->getMessage());
		}
		//Effectively assert that the search page has not been written by checking LastEdited
		$pageFromDB = DataObject::get_by_id('ElasticSearchPage', $searchPage->ID);
		$this->assertEquals($lastEdited, $pageFromDB->LastEdited);
	}


	public function testDefaultWeight() {
		$searchPage = $this->objFromFixture('ElasticSearchPage', 'search');
		//$searchPage->write();

84% of this comment could be valid code. Did you maybe forget this after debugging?

		$sf = $searchPage->ElasticaSearchableFields()->first();

The method ElasticaSearchableFields() does not exist on DataObject. Did you maybe mean searchableFields()?

		$this->assertEquals(1, $sf->Weight);
		$this->assertTrue($sf->ID > 0);
	}


	public function testPositiveWeight() {
		$sf = new SearchableField();
		$sf->Name = 'TestField';

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

		$sf->Weight = 10;

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

		$sf->write();
		$this->assertEquals(10, $sf->Weight);

The property Weight does not exist on object<SearchableField>. Since you implemented __get, maybe consider adding a @property annotation.

		$this->assertTrue($sf->ID > 0);
	}


	public function testHumanReadableSearchable() {

		$searchPage = $this->objFromFixture('ElasticSearchPage', 'search');

		//ensure valid
		$extraFields = array('Searchable' => 1, 'SimilarSearchable' => 1, 'Active' => 1,

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

			'Weight' => 1);
		$sf = $searchPage->ElasticaSearchableFields()->first();

The method ElasticaSearchableFields() does not exist on DataObject. Did you maybe mean searchableFields()?

		$sf->Name = 'TestField';
		$sf->Searchable = false;
		$this->assertEquals('No', $sf->HumanReadableSearchable());
		$sf->Searchable = true;
		$this->assertEquals('Yes', $sf->HumanReadableSearchable());
	}


	// ---- searchable fields are created via a script, so test do not allow creation/deletion ----

	/*
	Ensure CMS users cannot delete searchable fields
	 */
	public function testCanDelete() {
		$sf = new SearchableField();
		$this->assertFalse($sf->canDelete());
	}

	/*
	Ensure CMS users cannot create searchable fields
	 */
	public function testCanCreate() {
		$sf = new SearchableField();
		$this->assertFalse($sf->canCreate());
	}


}