silverstripe-fulltextsearch/tests/SolrIndexVersionedTest.php

214 lines
8.1 KiB
PHP
Raw Permalink Normal View History

<?php
namespace SilverStripe\FullTextSearch\Tests;
use Apache_Solr_Document;
2017-04-21 02:23:27 +02:00
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\FullTextSearch\Search\Services\SearchableService;
use SilverStripe\ORM\DataObject;
use SilverStripe\FullTextSearch\Search\FullTextSearch;
use SilverStripe\FullTextSearch\Search\SearchIntrospection;
use SilverStripe\FullTextSearch\Search\Indexes\SearchIndex_Recording;
use SilverStripe\FullTextSearch\Solr\Services\Solr3Service;
use SilverStripe\FullTextSearch\Tests\SearchVariantVersionedTest\SearchVariantVersionedTest_Item;
use SilverStripe\FullTextSearch\Tests\SolrIndexVersionedTest\SolrIndexVersionedTest_Object;
use SilverStripe\FullTextSearch\Tests\SolrIndexVersionedTest\SolrVersionedTest_Index;
use SilverStripe\FullTextSearch\Search\Processors\SearchUpdateProcessor;
use SilverStripe\FullTextSearch\Search\Processors\SearchUpdateImmediateProcessor;
use SilverStripe\FullTextSearch\Search\Updaters\SearchUpdater;
use SilverStripe\FullTextSearch\Search\Variants\SearchVariantSubsites;
use SilverStripe\FullTextSearch\Search\Variants\SearchVariantVersioned;
use SilverStripe\Subsites\Model\Subsite;
use SilverStripe\Versioned\Versioned;
2017-04-21 02:23:27 +02:00
2015-11-21 07:19:20 +01:00
class SolrIndexVersionedTest extends SapphireTest
{
protected $usesDatabase = true;
2015-11-21 07:19:20 +01:00
protected $oldMode = null;
2015-11-21 07:19:20 +01:00
protected static $index = null;
protected static $extra_dataobjects = [
SearchVariantVersionedTest_Item::class,
SolrIndexVersionedTest_Object::class,
];
2015-11-21 07:19:20 +01:00
2021-11-02 02:48:12 +01:00
protected function setUp(): void
2015-11-21 07:19:20 +01:00
{
// Need to be set before parent::setUp() since they're executed before the tests start
Config::modify()->set(SearchVariantSubsites::class, 'enabled', false);
2015-11-21 07:19:20 +01:00
parent::setUp();
2015-11-21 07:19:20 +01:00
if (self::$index === null) {
self::$index = singleton(SolrVersionedTest_Index::class);
2015-11-21 07:19:20 +01:00
}
Config::modify()->set(Injector::class, SearchUpdateProcessor::class, [
'class' => SearchUpdateImmediateProcessor::class
]);
2015-11-21 07:19:20 +01:00
FullTextSearch::force_index_list(self::$index);
SearchUpdater::clear_dirty_indexes();
2015-11-21 07:19:20 +01:00
$this->oldMode = Versioned::get_reading_mode();
Versioned::set_stage(Versioned::DRAFT);
2015-11-21 07:19:20 +01:00
}
2021-11-02 02:48:12 +01:00
protected function tearDown(): void
2015-11-21 07:19:20 +01:00
{
Versioned::set_reading_mode($this->oldMode);
parent::tearDown();
}
protected function getServiceMock($setMethods = array())
2015-11-21 07:19:20 +01:00
{
// Setup mock
/** @var SilverStripe\FullTextSearch\Solr\Services\Solr3Service|ObjectProphecy $serviceMock */
$serviceMock = $this->getMockBuilder(Solr3Service::class)
->setMethods($setMethods)
->getMock();
self::$index->setService($serviceMock);
return $serviceMock;
2015-11-21 07:19:20 +01:00
}
/**
* @param DataObject $object Item being added
* @param string $stage
* @return string
*/
protected function getExpectedDocumentId($object, $stage)
2015-11-21 07:19:20 +01:00
{
$id = $object->ID;
$class = DataObject::getSchema()->baseDataClass($object);
2018-06-27 06:50:54 +02:00
return $id . '-' . $class . '-{' . json_encode(SearchVariantVersioned::class) . ':"' . $stage . '"}';
2015-11-21 07:19:20 +01:00
}
/**
* @param string $class
* @param DataObject $object Item being added
* @param string $value Value for class
* @param string $stage Stage updated
* @return Apache_Solr_Document
*/
protected function getSolrDocument($class, $object, $value, $stage)
2015-11-21 07:19:20 +01:00
{
$doc = new Apache_Solr_Document();
$doc->setField('_documentid', $this->getExpectedDocumentId($object, $stage));
$doc->setField('ClassName', $class);
$doc->setField(DataObject::getSchema()->baseDataClass($class) . '_TestText', $value);
$doc->setField('_versionedstage', $stage);
$doc->setField('ID', (int) $object->ID);
$doc->setField('ClassHierarchy', SearchIntrospection::hierarchy($class));
$doc->setFieldBoost('ID', false);
$doc->setFieldBoost('ClassHierarchy', false);
return $doc;
}
public function testPublishing()
{
$classesToSkip = [SearchVariantVersionedTest_Item::class, SolrIndexVersionedTest_Object::class];
Config::modify()->set(SearchableService::class, 'indexing_canview_exclude_classes', $classesToSkip);
Config::modify()->set(SearchableService::class, 'variant_state_draft_excluded', false);
2015-11-21 07:19:20 +01:00
// Check that write updates Stage
Versioned::set_stage(Versioned::DRAFT);
$item = new SearchVariantVersionedTest_Item(array('TestText' => 'Foo'));
2015-11-21 07:19:20 +01:00
$item->write();
$object = new SolrIndexVersionedTest_Object(array('TestText' => 'Bar'));
$object->write();
$doc1 = $this->getSolrDocument(SearchVariantVersionedTest_Item::class, $item, 'Foo', Versioned::DRAFT);
$doc2 = $this->getSolrDocument(SolrIndexVersionedTest_Object::class, $object, 'Bar', Versioned::DRAFT);
// Ensure correct call is made to Solr
$this->getServiceMock(['addDocument', 'commit'])
->expects($this->exactly(2))
->method('addDocument')
->withConsecutive(
[$this->equalTo($doc1)],
[$this->equalTo($doc2)]
);
2015-11-21 07:19:20 +01:00
SearchUpdater::flush_dirty_indexes();
2015-11-21 07:19:20 +01:00
// Check that write updates Live
Versioned::set_stage(Versioned::DRAFT);
$item = new SearchVariantVersionedTest_Item(array('TestText' => 'Foo'));
2015-11-21 07:19:20 +01:00
$item->write();
$item->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$object = new SolrIndexVersionedTest_Object(array('TestText' => 'Bar'));
$object->write();
$object->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$doc1 = $this->getSolrDocument(SearchVariantVersionedTest_Item::class, $item, 'Foo', Versioned::DRAFT);
$doc2 = $this->getSolrDocument(SearchVariantVersionedTest_Item::class, $item, 'Foo', Versioned::LIVE);
$doc3 = $this->getSolrDocument(SolrIndexVersionedTest_Object::class, $object, 'Bar', Versioned::DRAFT);
$doc4 = $this->getSolrDocument(SolrIndexVersionedTest_Object::class, $object, 'Bar', Versioned::LIVE);
// Ensure correct call is made to Solr
$this->getServiceMock(['addDocument', 'commit'])
->expects($this->exactly(4))
->method('addDocument')
->withConsecutive(
[$doc1],
[$doc2],
[$doc3],
[$doc4]
);
2015-11-21 07:19:20 +01:00
SearchUpdater::flush_dirty_indexes();
}
2015-11-21 07:19:20 +01:00
public function testDelete()
{
$classesToSkip = [SearchVariantVersionedTest_Item::class];
Config::modify()->set(SearchableService::class, 'indexing_canview_exclude_classes', $classesToSkip);
Config::modify()->set(SearchableService::class, 'variant_state_draft_excluded', false);
2015-11-21 07:19:20 +01:00
// Delete the live record (not the stage)
Versioned::set_stage(Versioned::DRAFT);
$item = new SearchVariantVersionedTest_Item(array('TestText' => 'Too'));
2015-11-21 07:19:20 +01:00
$item->write();
$item->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
Versioned::set_stage(Versioned::LIVE);
$id = clone $item;
2015-11-21 07:19:20 +01:00
$item->delete();
// Check that only the 'Live' version is deleted
$this->getServiceMock(['addDocument', 'commit', 'deleteById'])
->expects($this->exactly(1))
->method('deleteById')
->with($this->getExpectedDocumentId($id, Versioned::LIVE));
2015-11-21 07:19:20 +01:00
SearchUpdater::flush_dirty_indexes();
2015-11-21 07:19:20 +01:00
// Delete the stage record
Versioned::set_stage(Versioned::DRAFT);
$item = new SearchVariantVersionedTest_Item(array('TestText' => 'Too'));
2015-11-21 07:19:20 +01:00
$item->write();
$item->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$id = clone $item;
2015-11-21 07:19:20 +01:00
$item->delete();
// Check that only the 'Stage' version is deleted
$this->getServiceMock(['addDocument', 'commit', 'deleteById'])
->expects($this->exactly(1))
->method('deleteById')
->with($this->getExpectedDocumentId($id, Versioned::DRAFT));
2015-11-21 07:19:20 +01:00
SearchUpdater::flush_dirty_indexes();
}
}