silverstripe-comments/tests/CommentingControllerTest.php

<?php

/**
 * @package comments
 * @subpackage tests
 */
class CommentingControllerTest extends FunctionalTest
{

    public static $fixture_file = 'CommentsTest.yml';

    protected $extraDataObjects = array(
        'CommentableItem'
    );

    protected $securityEnabled;

    public function tearDown()
    {
        if ($this->securityEnabled) {
            SecurityToken::enable();
        } else {
            SecurityToken::disable();
        }
        parent::tearDown();
    }

    public function setUp()
    {
        parent::setUp();
        $this->securityEnabled = SecurityToken::is_enabled();
    }

    public function testApprove()
    {
        SecurityToken::disable();

        // mark a comment as spam then approve it
        $this->logInWithPermission('CMS_ACCESS_CommentAdmin');
        $comment = $this->objFromFixture('Comment', 'firstComA');
        $comment->markSpam();
        $st = new Comment_SecurityToken($comment);
        $url = 'CommentingController/approve/' . $comment->ID;
        $url = $st->addToUrl($url, Member::currentUser());
        $response = $this->get($url);
        $this->assertEquals(200, $response->getStatusCode());
        $comment = DataObject::get_by_id('Comment', $comment->ID);

        // Need to use 0,1 here instead of false, true for SQLite
        $this->assertEquals(0, $comment->IsSpam);
        $this->assertEquals(1, $comment->Moderated);

        // try and approve a non existent comment
        $response = $this->get('CommentingController/approve/100000');
        $this->assertEquals(404, $response->getStatusCode());
    }

    public function testSetGetOwnerController()
    {
        $commController = new CommentingController();
        $commController->setOwnerController(Controller::curr());
        $this->assertEquals(Controller::curr(), $commController->getOwnerController());
        $commController->setOwnerController(null);
        $this->assertNull($commController->getOwnerController());
    }

    public function testHam()
    {
        SecurityToken::disable();

        // mark a comment as spam then ham it
        $this->logInWithPermission('CMS_ACCESS_CommentAdmin');
        $comment = $this->objFromFixture('Comment', 'firstComA');
        $comment->markSpam();
        $st = new Comment_SecurityToken($comment);
        $url = 'CommentingController/ham/' . $comment->ID;
        $url = $st->addToUrl($url, Member::currentUser());
        $response = $this->get($url);
        $this->assertEquals(200, $response->getStatusCode());
        $comment = DataObject::get_by_id('Comment', $comment->ID);

        // Need to use 0,1 here instead of false, true for SQLite
        $this->assertEquals(0, $comment->IsSpam);
        $this->assertEquals(1, $comment->Moderated);

        // try and ham a non existent comment
        $response = $this->get('CommentingController/ham/100000');
        $this->assertEquals(404, $response->getStatusCode());
    }

    public function testSpam()
    {
        // mark a comment as approved then spam it
        $this->logInWithPermission('CMS_ACCESS_CommentAdmin');
        $comment = $this->objFromFixture('Comment', 'firstComA');
        $comment->markApproved();
        $st = new Comment_SecurityToken($comment);
        $url = 'CommentingController/spam/' . $comment->ID;
        $url = $st->addToUrl($url, Member::currentUser());
        $response = $this->get($url);
        $this->assertEquals(200, $response->getStatusCode());
        $comment = DataObject::get_by_id('Comment', $comment->ID);

        // Need to use 0,1 here instead of false, true for SQLite
        $this->assertEquals(1, $comment->IsSpam);
        $this->assertEquals(1, $comment->Moderated);

        // try and spam a non existent comment
        $response = $this->get('CommentingController/spam/100000');
        $this->assertEquals(404, $response->getStatusCode());
    }

    public function testRSS()
    {
        // Delete the newly added children of firstComA so as not to have to recalculate values below
        $this->objFromFixture('Comment', 'firstComAChild1')->delete();
        $this->objFromFixture('Comment', 'firstComAChild2')->delete();
        $this->objFromFixture('Comment', 'firstComAChild3')->delete();

        $item = $this->objFromFixture('CommentableItem', 'first');


        // comments sitewide
        $response = $this->get('CommentingController/rss');
        $this->assertEquals(10, substr_count($response->getBody(), "<item>"), "10 approved, non spam comments on page 1");

        $response = $this->get('CommentingController/rss?start=10');
        $this->assertEquals(4, substr_count($response->getBody(), "<item>"), "3 approved, non spam comments on page 2");

        // all comments on a type
        $response = $this->get('CommentingController/rss/CommentableItem');
        $this->assertEquals(10, substr_count($response->getBody(), "<item>"));

        $response = $this->get('CommentingController/rss/CommentableItem?start=10');
        $this->assertEquals(4, substr_count($response->getBody(), "<item>"), "3 approved, non spam comments on page 2");

        // specific page
        $response = $this->get('CommentingController/rss/CommentableItem/'.$item->ID);
        $this->assertEquals(1, substr_count($response->getBody(), "<item>"));
        $this->assertContains('<dc:creator>FA</dc:creator>', $response->getBody());

        // test accessing comments on a type that doesn't exist
        $response = $this->get('CommentingController/rss/Fake');
        $this->assertEquals(404, $response->getStatusCode());
    }

    // This is returning a 404 which looks logical code wise but also a bit weird.
    // Test module on a clean install and check what the actual URL is first
/*    public function testReply() {
        $this->logInWithPermission('CMS_ACCESS_CommentAdmin');
        $comment = $this->objFromFixture('Comment', 'firstComA');
        $item = $this->objFromFixture('CommentableItem', 'first');

        $st = new Comment_SecurityToken($comment);
        $url = 'CommentingController/reply/' . $item->ID.'?ParentCommentID=' . $comment->ID;
        error_log($url);
        $response = $this->get($url);
        error_log(print_r($response,1));

        $this->assertEquals(200, $response->getStatusCode());

    }
*/
/*
    public function testCommentsFormLoadMemberData() {
        Config::inst()->update('CommentableItem', 'comments', array(
            'use_preview' => false
        ));
        $this->logInAs('visitor');
        SecurityToken::disable();
        $parent = $this->objFromFixture('CommentableItem', 'first');
        $parent->CommentsRequireLogin = true;
        $parent->PostingRequiredPermission = true;
        //$parent->write();
        $commController = new CommentingController();
        $commController->setOwnerRecord($parent);

        $form = $commController->CommentsForm();
        $commentsFields = $form->Fields()->first()->FieldList();
        $expected = array('Name', 'Email', 'URL', 'Comment', 'PreviewComment');
        CommentTestHelper::assertFieldNames($this, $expected, $commentsFields);
    }
*/

    public function testCommentsFormUsePreview()
    {
        // test with preview on
        Config::inst()->update('CommentableItem', 'comments', array(
            'use_preview' => true
        ));

        $this->objFromFixture('Comment', 'firstComAChild1')->delete();
        $this->objFromFixture('Comment', 'firstComAChild2')->delete();
        $this->objFromFixture('Comment', 'firstComAChild3')->delete();

        SecurityToken::disable();
        $this->autoFollowRedirection = false;
        $parent = $this->objFromFixture('CommentableItem', 'first');
        $commController = new CommentingController();
        $commController->setOwnerRecord($parent);

        $form = $commController->CommentsForm();
        $commentsFields = $form->Fields()->first()->FieldList();
        $expected = array('Name', 'Email', 'URL', 'Comment', 'PreviewComment');
        CommentTestHelper::assertFieldNames($this, $expected, $commentsFields);

        // Turn off preview.  Assert lack of preview field
        Config::inst()->update('CommentableItem', 'comments', array(
            'use_preview' => false
        ));
        $form = $commController->CommentsForm();
        $commentsFields = $form->Fields()->first()->FieldList();
        $expected = array('Name', 'Email', 'URL', 'Comment');
        CommentTestHelper::assertFieldNames($this, $expected, $commentsFields);
    }

    public function testCommentsForm()
    {
        // Delete the newly added children of firstComA so as not to change this test
        $this->objFromFixture('Comment', 'firstComAChild1')->delete();
        $this->objFromFixture('Comment', 'firstComAChild2')->delete();
        $this->objFromFixture('Comment', 'firstComAChild3')->delete();

        SecurityToken::disable();
        $this->autoFollowRedirection = false;
        $parent = $this->objFromFixture('CommentableItem', 'first');

        // Test posting to base comment
        $response = $this->post('CommentingController/CommentsForm',
            array(
                'Name' => 'Poster',
                'Email' => 'guy@test.com',
                'Comment' => 'My Comment',
                'ParentID' => $parent->ID,
                'BaseClass' => 'CommentableItem',
                'action_doPostComment' => 'Post'
            )
        );
        $this->assertEquals(302, $response->getStatusCode());
        $this->assertStringStartsWith('CommentableItem_Controller#comment-', $response->getHeader('Location'));
        $this->assertDOSEquals(
            array(array(
                'Name' => 'Poster',
                'Email' => 'guy@test.com',
                'Comment' => 'My Comment',
                'ParentID' => $parent->ID,
                'BaseClass' => 'CommentableItem',
            )),
            Comment::get()->filter('Email', 'guy@test.com')
        );

        // Test posting to parent comment
        $parentComment = $this->objFromFixture('Comment', 'firstComA');
        $this->assertEquals(0, $parentComment->ChildComments()->count());

        $response = $this->post(
            'CommentingController/reply/'.$parentComment->ID,
            array(
                'Name' => 'Test Author',
                'Email' => 'test@test.com',
                'Comment' => 'Making a reply to firstComA',
                'ParentID' => $parent->ID,
                'BaseClass' => 'CommentableItem',
                'ParentCommentID' => $parentComment->ID,
                'action_doPostComment' => 'Post'
            )
        );
        $this->assertEquals(302, $response->getStatusCode());
        $this->assertStringStartsWith('CommentableItem_Controller#comment-', $response->getHeader('Location'));
        $this->assertDOSEquals(array(array(
            'Name' => 'Test Author',
                'Email' => 'test@test.com',
                'Comment' => 'Making a reply to firstComA',
                'ParentID' => $parent->ID,
                'BaseClass' => 'CommentableItem',
                'ParentCommentID' => $parentComment->ID
        )), $parentComment->ChildComments());
    }
}