CommentingControllerTest::testHam() - Code Metrics - Inspection of "Merge pull request #141 from helpfulrobot/add-stan..." - silverstripe/silverstripe-comments - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 02d548...e42a4c )

by Damian

created 2016-03-21 04:35 UTC

CommentingControllerTest::testHam() A

↳ Parent: CommentingControllerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	23
Code Lines	15

Duplication

Lines	23
Ratio	100 %

Metric	Value
dl	23
loc	23
rs	9.0856
cc	1
eloc	15
nc	1
nop	0

<?php

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

class YourClass { }

	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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $url = 'CommentingController/approve/' . $comment->ID;
        $url = $st->addToUrl($url, Member::currentUser());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $url = 'CommentingController/ham/' . $comment->ID;
        $url = $st->addToUrl($url, Member::currentUser());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $url = 'CommentingController/spam/' . $comment->ID;
        $url = $st->addToUrl($url, Member::currentUser());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $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);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        $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' => '[email protected]',
				'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' => '[email protected]',
				'Comment' => 'My Comment',
				'ParentID' => $parent->ID,
				'BaseClass' => 'CommentableItem',
			)),
			Comment::get()->filter('Email', '[email protected]')
		);

		// 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' => '[email protected]',
				'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' => '[email protected]',
				'Comment' => 'Making a reply to firstComA',
				'ParentID' => $parent->ID,
				'BaseClass' => 'CommentableItem',
				'ParentCommentID' => $parentComment->ID
		)), $parentComment->ChildComments());


	}
}


1		<?php
2
3		/**
4		* @package comments
5		* @subpackage tests
6		*/
7		class CommentingControllerTest extends FunctionalTest {
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
8
9		public static $fixture_file = 'CommentsTest.yml';
10
11		protected $extraDataObjects = array(
12		'CommentableItem'
13		);
14
15		protected $securityEnabled;
16
17		public function tearDown() {
18		if($this->securityEnabled) {
19		SecurityToken::enable();
20		} else {
21		SecurityToken::disable();
22		}
23		parent::tearDown();
24		}
25
26		public function setUp() {
27		parent::setUp();
28		$this->securityEnabled = SecurityToken::is_enabled();
29		}
30
31	View Code Duplication	public function testApprove() {
		0 ignored issues – show Duplication introduced 2016-03-21 04:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
32		SecurityToken::disable();
33
34		// mark a comment as spam then approve it
35		$this->logInWithPermission('CMS_ACCESS_CommentAdmin');
36		$comment = $this->objFromFixture('Comment', 'firstComA');
37		$comment->markSpam();
38		$st = new Comment_SecurityToken($comment);

silverstripe / silverstripe-comments

Push — master ( 02d548...e42a4c )

CommentingControllerTest::testHam() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like