Source of file GoogleSitemapTest.php
Size: 13,005 Bytes - Last Modified: 2021-12-23T10:31:45+00:00
/var/www/docs.ssmods.com/process/src/tests/GoogleSitemapTest.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361 | <?php namespace Wilr\GoogleSitemaps\Tests; use Exception; use SilverStripe\CMS\Model\SiteTree; use SilverStripe\Control\Director; use SilverStripe\Core\Config\Config; use SilverStripe\Dev\FunctionalTest; use SilverStripe\Forms\DropdownField; use SilverStripe\Forms\LiteralField; use SilverStripe\Forms\Tab; use SilverStripe\ORM\DB; use SilverStripe\Versioned\Versioned; use Wilr\GoogleSitemaps\Extensions\GoogleSitemapExtension; use Wilr\GoogleSitemaps\GoogleSitemap; use Wilr\GoogleSitemaps\Tests\Model\OtherDataObject; use Wilr\GoogleSitemaps\Tests\Model\TestDataObject; use Wilr\GoogleSitemaps\Tests\Model\UnviewableDataObject; class GoogleSitemapTest extends FunctionalTest { protected static $fixture_file = 'GoogleSitemapTest.yml'; protected static $extra_dataobjects = [ TestDataObject::class, OtherDataObject::class, UnviewableDataObject::class ]; protected static $extra_extensions = [ GoogleSitemapExtension::class ]; public function setUp() { parent::setUp(); if (class_exists('Page')) { $this->loadFixture($this->resolveFixturePath('GoogleSitemapPageTest.yml')); } GoogleSitemap::clear_registered_dataobjects(); GoogleSitemap::clear_registered_routes(); } public function tearDown() { parent::tearDown(); GoogleSitemap::clear_registered_dataobjects(); GoogleSitemap::clear_registered_routes(); } public function testCanIncludeInGoogleSitemap() { GoogleSitemap::register_dataobject(TestDataObject::class, ''); $unused = $this->objFromFixture(TestDataObject::class, 'UnindexedDataObject'); $this->assertFalse($unused->canIncludeInGoogleSitemap()); $used = $this->objFromFixture(TestDataObject::class, 'DataObjectTest2'); $this->assertTrue($used->canIncludeInGoogleSitemap()); } public function testIndexFileWithCustomRoute() { GoogleSitemap::register_route('/test/'); $response = $this->get('sitemap.xml'); $body = $response->getBody(); $expected = "<loc>". Director::absoluteURL("sitemap.xml/sitemap/GoogleSitemapRoute/1") ."</loc>"; $this->assertEquals(1, substr_count($body, $expected), 'A link to the custom routes exists'); } public function testGetItems() { GoogleSitemap::register_dataobject(TestDataObject::class, ''); $items = GoogleSitemap::get_items(TestDataObject::class, 1); $this->assertEquals(2, $items->count()); $this->assertDOSEquals(array( array("Priority" => "0.2"), array("Priority" => "0.4") ), $items); GoogleSitemap::register_dataobject(OtherDataObject::class); $this->assertEquals(1, GoogleSitemap::get_items(OtherDataObject::class, 1)->count()); GoogleSitemap::register_dataobject(UnviewableDataObject::class); $this->assertEquals(0, GoogleSitemap::get_items(UnviewableDataObject::class, 1)->count()); } public function testGetItemsWithCustomRoutes() { GoogleSitemap::register_routes(array( '/test-route/', '/someother-route/', '/fake-sitemap-route/' )); $items = GoogleSitemap::get_items('GoogleSitemapRoute', 1); $this->assertEquals(3, $items->count()); } public function testAccessingSitemapRootXMLFile() { GoogleSitemap::register_dataobject(TestDataObject::class); GoogleSitemap::register_dataobject(OtherDataObject::class); $response = $this->get('sitemap.xml'); $body = $response->getBody(); // the sitemap should contain <loc> to both those files and not the other // dataobject as it hasn't been registered $expected = "<loc>". Director::absoluteURL( "sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-TestDataObject/1" ) ."</loc>"; $this->assertEquals( 1, substr_count($body, $expected), 'A link to GoogleSitemapTest_DataObject exists' ); $expected = "<loc>". Director::absoluteURL( "sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-OtherDataObject/1" ) ."</loc>"; $this->assertEquals( 1, substr_count($body, $expected), 'A link to GoogleSitemapTest_OtherDataObject exists' ); $expected = "<loc>". Director::absoluteURL( "sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-UnviewableDataObject/2" ) ."</loc>"; $this->assertEquals( 0, substr_count($body, $expected), 'A link to a GoogleSitemapTest_UnviewableDataObject does not exist' ); } public function testLastModifiedDateOnRootXML() { Config::inst()->update(GoogleSitemap::class, 'enabled', true); if (!class_exists('Page')) { $this->markTestIncomplete('No cms module installed, page related test skipped'); } $page = $this->objFromFixture('Page', 'Page1'); $page->publish('Stage', 'Live'); $page->flushCache(); $page2 = $this->objFromFixture('Page', 'Page2'); $page2->publish('Stage', 'Live'); $page2->flushCache(); DB::query("UPDATE \"SiteTree_Live\" SET \"LastEdited\"='2014-03-14 00:00:00' WHERE \"ID\"='".$page->ID."'"); DB::query("UPDATE \"SiteTree_Live\" SET \"LastEdited\"='2014-01-01 00:00:00' WHERE \"ID\"='".$page2->ID."'"); $response = $this->get('sitemap.xml'); $body = $response->getBody(); $expected = '<lastmod>2014-03-14</lastmod>'; $this->assertEquals( 1, substr_count($body, $expected), 'The last mod date should use most recent LastEdited date' ); } public function testIndexFilePaginatedSitemapFiles() { $original = Config::inst()->get('GoogleSitemap', 'objects_per_sitemap'); Config::inst()->update(GoogleSitemap::class, 'objects_per_sitemap', 1); GoogleSitemap::register_dataobject(TestDataObject::class); $response = $this->get('sitemap.xml'); $body = $response->getBody(); $expected = "<loc>". Director::absoluteURL( "sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-TestDataObject/1" ) ."</loc>"; $this->assertEquals( 1, substr_count($body, $expected), 'A link to the first page of GoogleSitemapTest_DataObject exists' ); $expected = "<loc>". Director::absoluteURL( "sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-TestDataObject/2" ) ."</loc>"; $this->assertEquals( 1, substr_count($body, $expected), 'A link to the second page GoogleSitemapTest_DataObject exists' ); Config::inst()->update(GoogleSitemap::class, 'objects_per_sitemap', $original); } public function testRegisterRoutesIncludesAllRoutes() { GoogleSitemap::register_route('/test/'); GoogleSitemap::register_routes(array( '/test/', // duplication should be replaced '/unittests/', '/anotherlink/' ), 'weekly'); $response = $this->get('sitemap.xml/sitemap/GoogleSitemapRoute/1'); $body = $response->getBody(); $this->assertEquals(200, $response->getStatusCode(), 'successful loaded nested sitemap'); $this->assertEquals(3, substr_count($body, "<loc>")); } public function testAccessingNestedSiteMap() { $original = Config::inst()->get('GoogleSitemap', 'objects_per_sitemap'); Config::inst()->update(GoogleSitemap::class, 'objects_per_sitemap', 1); GoogleSitemap::register_dataobject(TestDataObject::class); $response = $this->get('sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-TestDataObject/1'); $body = $response->getBody(); $this->assertEquals(200, $response->getStatusCode(), 'successful loaded nested sitemap'); Config::inst()->update(GoogleSitemap::class, 'objects_per_sitemap', $original); } public function testGetItemsWithPages() { if (!class_exists('Page')) { $this->markTestIncomplete('No cms module installed, page related test skipped'); } $page = $this->objFromFixture('Page', 'Page1'); $page->publish('Stage', 'Live'); $page->flushCache(); $page2 = $this->objFromFixture('Page', 'Page2'); $page2->publish('Stage', 'Live'); $page2->flushCache(); $this->assertDOSContains(array( array('Title' => 'Testpage1'), array('Title' => 'Testpage2') ), GoogleSitemap::inst()->getItems(SiteTree::class), "There should be 2 pages in the sitemap after publishing"); // check if we make a page readonly that it is hidden $page2->CanViewType = 'LoggedInUsers'; $page2->write(); $page2->publish('Stage', 'Live'); $this->logOut(); $this->assertDOSEquals(array( array('Title' => 'Testpage1') ), GoogleSitemap::inst()->getItems(SiteTree::class), "There should be only 1 page, other is logged in only"); } public function testAccess() { Config::inst()->update(GoogleSitemap::class, 'enabled', true); $response = $this->get('sitemap.xml'); $this->assertEquals(200, $response->getStatusCode(), 'Sitemap returns a 200 success when enabled'); $this->assertEquals('application/xml; charset="utf-8"', $response->getHeader('Content-Type')); GoogleSitemap::register_dataobject(TestDataObject::class); $response = $this->get('sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-TestDataObject/1'); $this->assertEquals(200, $response->getStatusCode(), 'Sitemap returns a 200 success when enabled'); $this->assertEquals('application/xml; charset="utf-8"', $response->getHeader('Content-Type')); Config::inst()->update(GoogleSitemap::class, 'enabled', false); $response = $this->get('sitemap.xml'); $this->assertEquals(404, $response->getStatusCode(), 'Sitemap index returns a 404 when disabled'); $response = $this->get('sitemap.xml/sitemap/Wilr-GoogleSitemaps-Tests-Model-TestDataObject/1'); $this->assertEquals(404, $response->getStatusCode(), 'Sitemap file returns a 404 when disabled'); } public function testDecoratorAddsFields() { if (!class_exists("Page")) { $this->markTestIncomplete('No cms module installed, page related test skipped'); } $page = $this->objFromFixture('Page', 'Page1'); $fields = $page->getSettingsFields(); $tab = $fields->fieldByName('Root')->fieldByName('Settings')->fieldByName('GoogleSitemap'); $this->assertInstanceOf(Tab::class, $tab); $this->assertInstanceOf(DropdownField::class, $tab->fieldByName('Priority')); $this->assertInstanceOf(LiteralField::class, $tab->fieldByName('GoogleSitemapIntro')); } public function testGetPriority() { if (!class_exists("Page")) { $this->markTestIncomplete('No cms module installed, page related test skipped'); } $page = $this->objFromFixture('Page', 'Page1'); // invalid field doesn't break google $page->Priority = 'foo'; $this->assertEquals(0.5, $page->getGooglePriority()); // custom value (set as string as db field is varchar) $page->Priority = '0.2'; $this->assertEquals(0.2, $page->getGooglePriority()); // -1 indicates that we should not index this $page->Priority = -1; $this->assertFalse($page->getGooglePriority()); } public function testUnpublishedPage() { if (!class_exists('SilverStripe\CMS\Model\SiteTree')) { $this->markTestSkipped('Test skipped; CMS module required for testUnpublishedPage'); } $orphanedPage = new \SilverStripe\CMS\Model\SiteTree(); $orphanedPage->ParentID = 999999; // missing parent id $orphanedPage->write(); $orphanedPage->publish("Stage", "Live"); $rootPage = new \SilverStripe\CMS\Model\SiteTree(); $rootPage->ParentID = 0; $rootPage->write(); $rootPage->publish("Stage", "Live"); $oldMode = Versioned::get_reading_mode(); Versioned::set_reading_mode('Live'); try { $this->assertEmpty($orphanedPage->hasPublishedParent()); $this->assertEmpty($orphanedPage->canIncludeInGoogleSitemap()); $this->assertNotEmpty($rootPage->hasPublishedParent()); $this->assertNotEmpty($rootPage->canIncludeInGoogleSitemap()); } catch (Exception $ex) { Versioned::set_reading_mode($oldMode); throw $ex; } // finally { Versioned::set_reading_mode($oldMode); // } } } |