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

<?php

namespace SilverStripe\CMS\Tests\Controllers;

use SilverStripe\CMS\BatchActions\CMSBatchAction_Archive;
use SilverStripe\CMS\BatchActions\CMSBatchAction_Publish;
use SilverStripe\CMS\BatchActions\CMSBatchAction_Restore;
use SilverStripe\CMS\BatchActions\CMSBatchAction_Unpublish;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Versioned\Versioned;

/**
 * Tests CMS Specific subclasses of {@see CMSBatchAction}
 */
class CMSBatchActionsTest extends SapphireTest
{
    protected static $fixture_file = 'CMSBatchActionsTest.yml';

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

        $this->logInWithPermission('ADMIN');

        // Tests assume strict hierarchy is enabled
        Config::inst()->set(SiteTree::class, 'enforce_strict_hierarchy', true);

        // published page
        $published = $this->objFromFixture(SiteTree::class, 'published');
        $published->publishSingle();

        // Deleted / archived page
        $archived = $this->objFromFixture(SiteTree::class, 'archived');
        $archived->doArchive(); // should archive all children

        // Unpublished
        $unpublished = $this->objFromFixture(SiteTree::class, 'unpublished');
        $unpublished->publishSingle();
        $unpublished->doUnpublish();

        // Modified
        $modified = $this->objFromFixture(SiteTree::class, 'modified');
        $modified->publishSingle();
        $modified->Title = 'modified2';
        $modified->write();
    }

    /**
     * Test which pages can be published via batch actions
     */
    public function testBatchPublishApplicable()
    {
        $this->logInWithPermission('ADMIN');
        $pages = Versioned::get_including_deleted(SiteTree::class);
        $ids = $pages->column('ID');
        $action = new CMSBatchAction_Publish();

        // Test applicable pages
        $applicable = $action->applicablePages($ids);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'published'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archived'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archivedx'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archivedy'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'unpublished'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'modified'), $applicable);
    }


    /**
     * Test which pages can be unpublished via batch actions
     */
    public function testBatchUnpublishApplicable()
    {
        $this->logInWithPermission('ADMIN');
        $pages = Versioned::get_including_deleted(SiteTree::class);
        $ids = $pages->column('ID');
        $action = new CMSBatchAction_Unpublish();

        // Test applicable page
        $applicable = $action->applicablePages($ids);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'published'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archived'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archivedx'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archivedy'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'unpublished'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'modified'), $applicable);
    }

    /**
     * Test which pages can be archived via delete batch actions
     */
    public function testBatchDeleteApplicable()
    {
        $this->logInWithPermission('ADMIN');
        $pages = Versioned::get_including_deleted(SiteTree::class);
        $ids = $pages->column('ID');
        $action = new CMSBatchAction_Archive();

        // Test applicable pages
        $applicable = $action->applicablePages($ids);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'published'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'archived'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'unpublished'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'modified'), $applicable);
    }

    /**
     * Test restore batch actions
     */
    public function testBatchRestoreApplicable()
    {
        $this->logInWithPermission('ADMIN');
        $pages = Versioned::get_including_deleted(SiteTree::class);
        $ids = $pages->column('ID');
        $action = new CMSBatchAction_Restore();

        // Test applicable pages
        $applicable = $action->applicablePages($ids);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'published'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'archived'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'archivedx'), $applicable);
        $this->assertContains($this->idFromFixture(SiteTree::class, 'archivedy'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'unpublished'), $applicable);
        $this->assertNotContains($this->idFromFixture(SiteTree::class, 'modified'), $applicable);
    }

    public function testBatchRestore()
    {
        $this->logInWithPermission('ADMIN');
        $pages = Versioned::get_including_deleted(SiteTree::class);
        $action = new CMSBatchAction_Restore();
        $archivedID = $this->idFromFixture(SiteTree::class, 'archived');
        $archivedxID = $this->idFromFixture(SiteTree::class, 'archivedx');
        $archivedyID = $this->idFromFixture(SiteTree::class, 'archivedy');

        // Just restore one child
        $list = $pages->filter('ID', $archivedxID);
        $this->assertEquals(1, $list->count());
        $this->assertEquals($archivedID, $list->first()->ParentID);

        // Run restore
        $result = json_decode($action->run($list)->getBody(), true);
        $this->assertEquals(
            [
                $archivedxID => $archivedxID,
            ],
            $result['success']
        );
        $archivedx = SiteTree::get()->byID($archivedxID);
        $this->assertNotNull($archivedx);
        $this->assertEquals(0, $archivedx->ParentID); // Restore to root because parent is unrestored

        // Restore both remaining pages
        $list = $pages
            ->filter('ID', [$archivedID, $archivedyID])
            ->sort('Title');
        $this->assertEquals(2, $list->count());
        $this->assertEquals($archivedID, $list->first()->ParentID); // archivedy
        $this->assertEquals(0, $list->last()->ParentID); // archived (parent)

        // Run restore
        $result = json_decode($action->run($list)->getBody(), true);
        $this->assertEquals(
            [
                // Order of archived is opposite to order items are passed in, as
                // these are sorted by level first
                $archivedID => $archivedID,
                $archivedyID => $archivedyID,
            ],
            $result['success']
        );
        $archived = SiteTree::get()->byID($archivedID);
        $archivedy = SiteTree::get()->byID($archivedyID);
        $this->assertNotNull($archived);
        $this->assertNotNull($archivedy);
        $this->assertEquals($archivedID, $archivedy->ParentID); // Not restored to root, but to the parent
        $this->assertEquals(0, $archived->ParentID); // Root stays root
    }
}