silverstripe-cms/tests/php/Controllers/CMSPageHistoryControllerTest.php

<?php

namespace SilverStripe\CMS\Tests\Controllers;

use Page;
use SilverStripe\CMS\Controllers\CMSPageHistoryController;
use SilverStripe\CMS\Tests\Controllers\CMSPageHistoryControllerTest\HistoryController;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\HTMLReadonlyField;
use SilverStripe\Dev\Deprecation;
use SilverStripe\Forms\TextField;

class CMSPageHistoryControllerTest extends FunctionalTest
{
    protected static $fixture_file = 'CMSPageHistoryControllerTest.yml';

    protected $versionUnpublishedCheck;
    protected $versionPublishCheck;
    protected $versionUnpublishedCheck2;
    protected $versionPublishCheck2;
    protected $page;

    protected static $extra_controllers = [
        CMSPageHistoryControllerTest\HistoryController::class,
    ];

    protected function setUp(): void
    {
        parent::setUp();

        Deprecation::withNoReplacement(function () {
            Injector::inst()->registerService(
                new CMSPageHistoryController(),
                CMSPageHistoryController::class
            );
        });

        $this->loginWithPermission('ADMIN');

        // creates a series of published, unpublished versions of a page
        $this->page = new Page();
        $this->page->URLSegment = "test";
        $this->page->Content = "new content";
        $this->page->write();
        $this->versionUnpublishedCheck = $this->page->Version; // v1

        $this->page->Content = "some further content";
        $this->page->publishSingle();
        $this->versionPublishCheck = $this->page->Version; // v2

        $this->page->Content = "No, more changes please";
        $this->page->Title = "Changing titles too";
        $this->page->write();
        $this->versionUnpublishedCheck2 = $this->page->Version; // v3

        $this->page->Title = "Final Change";
        $this->page->publishSingle();
        $this->versionPublishCheck2 = $this->page->Version; // v4
    }

    public function testGetEditForm()
    {
        if (Deprecation::isEnabled()) {
            $this->markTestSkipped('Test calls deprecated code');
        }
        $controller = new CMSPageHistoryController();
        $controller->setRequest(Controller::curr()->getRequest());

        // should get the latest version which we cannot rollback to
        $form = $controller->getEditForm($this->page->ID);

        $this->assertTrue($form->Actions()->dataFieldByName('action_doRollback')->isReadonly());

        $this->assertEquals($this->page->ID, $form->Fields()->dataFieldByName('ID')->Value());
        $this->assertEquals($this->versionPublishCheck2, $form->Fields()->dataFieldByName('Version')->Value());

        $this->assertStringContainsString(
            'Currently viewing the latest version',
            $form->Fields()->fieldByName('Root.Main.CurrentlyViewingMessage')->getContent()
        );

        // edit form with a given version
        $form = $controller->getEditForm($this->page->ID, null, $this->versionPublishCheck);
        $this->assertFalse($form->Actions()->dataFieldByName('action_doRollback')->isReadonly());

        $this->assertEquals($this->page->ID, $form->Fields()->dataFieldByName('ID')->Value());
        $this->assertEquals($this->versionPublishCheck, $form->Fields()->dataFieldByName('Version')->Value());
        $this->assertStringContainsString(
            sprintf("Currently viewing version %s.", $this->versionPublishCheck),
            $form->Fields()->fieldByName('Root.Main.CurrentlyViewingMessage')->getContent()
        );

        // check that compare mode updates the message
        $form = $controller->getEditForm($this->page->ID, null, $this->versionPublishCheck, $this->versionPublishCheck2);
        $this->assertStringContainsString(
            sprintf("Comparing versions %s", $this->versionPublishCheck),
            $form->Fields()->fieldByName('Root.Main.CurrentlyViewingMessage')->getContent()
        );

        $this->assertStringContainsString(
            sprintf("and %s", $this->versionPublishCheck2),
            $form->Fields()->fieldByName('Root.Main.CurrentlyViewingMessage')->getContent()
        );
    }

    /**
     * @todo should be less tied to cms theme.
     * @todo check highlighting for comparing pages.
     */
    public function testVersionsForm()
    {
        if (Deprecation::isEnabled()) {
            $this->markTestSkipped('Test calls deprecated code');
        }
        $this->get('admin/pages/legacyhistory/show/' . $this->page->ID);

        $form = $this->cssParser()->getBySelector('#Form_VersionsForm');

        $this->assertEquals(1, count($form ?? []));

        // check the page ID is present
        $hidden = $form[0]->xpath("fieldset/input[@type='hidden']");

        $this->assertThat($hidden, $this->logicalNot($this->isNull()), 'Hidden ID field exists');
        $this->assertEquals($this->page->ID, (int) $hidden[0]->attributes()->value);

        // ensure that all the versions are present in the table and displayed
        $rows = $form[0]->xpath("fieldset/table/tbody/tr");
        $this->assertEquals(4, count($rows ?? []));
    }

    public function testVersionsFormTableContainsInformation()
    {
        if (Deprecation::isEnabled()) {
            $this->markTestSkipped('Test calls deprecated code');
        }
        $this->get('admin/pages/legacyhistory/show/' . $this->page->ID);
        $form = $this->cssParser()->getBySelector('#Form_VersionsForm');
        $rows = $form[0]->xpath("fieldset/table/tbody/tr");

        $expected = [
            ['version' => $this->versionPublishCheck2, 'status' => 'published'],
            ['version' => $this->versionUnpublishedCheck2, 'status' => 'internal'],
            ['version' => $this->versionPublishCheck, 'status' => 'published'],
            ['version' => $this->versionUnpublishedCheck, 'status' => 'internal']
        ];

        // goes the reverse order that we created in setUp()
        $i = 0;
        foreach ($rows as $tr) {
            // data-link must be present for the javascript to load new
            $this->assertStringContainsString($expected[$i]['status'], (string) $tr->attributes()->class);
            $i++;
        }

        // test highlighting
        $this->assertStringContainsString('active', (string) $rows[0]->attributes()->class);
        $this->assertThat((string) $rows[1]->attributes()->class, $this->logicalNot($this->stringContains('active')));
    }

    public function testVersionsFormSelectsUnpublishedCheckbox()
    {
        if (Deprecation::isEnabled()) {
            $this->markTestSkipped('Test calls deprecated code');
        }
        $this->get('admin/pages/legacyhistory/show/' . $this->page->ID);
        $checkbox = $this->cssParser()->getBySelector('#Form_VersionsForm_ShowUnpublished');

        $this->assertThat($checkbox[0], $this->logicalNot($this->isNull()));
        $checked = $checkbox[0]->attributes()->checked ?: '';

        $this->assertThat($checked, $this->logicalNot($this->stringContains('checked')));

        // viewing an unpublished
        $this->get('admin/pages/legacyhistory/show/' . $this->page->ID . '/' . $this->versionUnpublishedCheck);
        $checkbox = $this->cssParser()->getBySelector('#Form_VersionsForm_ShowUnpublished');

        $this->assertThat($checkbox[0], $this->logicalNot($this->isNull()));
        $this->assertEquals('checked', (string) $checkbox[0]->attributes()->checked);
    }

    public function testTransformReadonly()
    {
        if (Deprecation::isEnabled()) {
            $this->markTestSkipped('Test calls deprecated code');
        }
        /** @var CMSPageHistoryController $history */
        $history = new CMSPageHistoryController();
        $history->setRequest(Controller::curr()->getRequest());

        $fieldList = FieldList::create([
            FieldGroup::create('group', [
                TextField::create('childField', 'child field'),
            ]),
            TextField::create('field', 'field', 'My <del>value</del><ins>change</ins>'),
            HiddenField::create('hiddenField', 'hidden field'),
        ]);

        $newList = $history->transformReadonly($fieldList);

        $field = $newList->dataFieldByName('field');
        $this->assertTrue($field instanceof HTMLReadonlyField);
        $this->assertStringContainsString('<ins>', $field->forTemplate());

        $groupField = $newList->fieldByName('group');
        $this->assertTrue($groupField instanceof FieldGroup);

        $childField = $newList->dataFieldByName('childField');
        $this->assertTrue($childField instanceof HTMLReadonlyField);

        $hiddenField = $newList->dataFieldByName('hiddenField');
        $this->assertTrue($hiddenField instanceof HiddenField);
    }
}