OrderActionsFormTest::buildPaymentGatewayStub() - Code Metrics - Inspection of "Allow onsite payments on the OrderActionsForm." - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#511)

by Roman

created 2016-06-28 20:25 UTC

OrderActionsFormTest::buildPaymentGatewayStub() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	53
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	53
rs	9.5797
cc	1
eloc	31
nc	1
nop	3

How to fix Long Method

<?php

class OrderActionsFormTest extends FunctionalTest
{
    protected static $fixture_file = array(
        'silvershop/tests/fixtures/Pages.yml',
        'silvershop/tests/fixtures/shop.yml',
    );

    protected $order;
    protected $checkoutPage;

    public function setUp()
    {
        parent::setUp();
        ShopTest::setConfiguration();

        // create order from fixture and persist to DB
        $this->order = $this->objFromFixture("Order", "unpaid");
        $this->order->write();

        OrderManipulation::add_session_order($this->order);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        // create checkoug page from fixture and publish it
        $this->checkoutPage = $this->objFromFixture("CheckoutPage", "checkout");
        $this->checkoutPage->publish('Stage', 'Live');

        Config::inst()->update('Payment', 'allowed_gateways', array('Dummy'));
    }

    public function testOffsitePayment()
    {
        Config::inst()->update('GatewayInfo', 'Dummy', array('is_offsite' => true));
        $stubGateway = $this->buildPaymentGatewayStub(true, 'test-' . $this->order->ID, true);
        Injector::inst()->registerService($this->stubGatewayFactory($stubGateway), 'Omnipay\Common\GatewayFactory');

        $ctrl = ModelAsController::controller_for($this->checkoutPage);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $response = Director::test($ctrl->Link('ActionsForm'), array(
            'action_dopayment' => true,
            'OrderID'       => $this->order->ID,
            'PaymentMethod' => 'Dummy'
        ), $this->session());

        // There should be a new payment
        $this->assertEquals(1, $this->order->Payments()->count());

        // The status of the payment should be pending purchase, as there's a redirect to the offsite gateway
        $this->assertEquals('PendingPurchase', $this->order->Payments()->first()->Status);

        // The response we get from submitting the form should be a redirect to the offsite payment form
        $this->assertEquals('http://paymentprovider/test/offsiteform', $response->getHeader('Location'));


    }

    public function testOnsitePayment()
    {
        $stubGateway = $this->buildPaymentGatewayStub(true, 'test-' . $this->order->ID, false);
        Injector::inst()->registerService($this->stubGatewayFactory($stubGateway), 'Omnipay\Common\GatewayFactory');

        $ctrl = ModelAsController::controller_for($this->checkoutPage);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $response = Director::test($ctrl->Link('ActionsForm'), array(
            'action_dopayment' => true,
            'OrderID'       => $this->order->ID,
            'PaymentMethod' => 'Dummy',
            'type' => 'visa',
            'name' => 'Tester Mc. Testerson',
            'number' => '4242424242424242',
            'expiryMonth' => 10,
            'expiryYear' => date('Y') + 1,
            'cvv' => 123
        ), $this->session());

        // There should be a new payment
        $this->assertEquals(1, $this->order->Payments()->count());

        // The status of the payment should be Captured
        $this->assertEquals('Captured', $this->order->Payments()->first()->Status);

        // The response we get from submitting the form should be a redirect to the paid order
        $this->assertEquals($ctrl->Link('order/' . $this->order->ID), $response->getHeader('Location'));

    }

    public function testValidation()
    {
        $validator = new OrderActionsForm_Validator('PaymentMethod');
        $form = new OrderActionsForm(
            ModelAsController::controller_for($this->checkoutPage),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            'ActionsForm',
            $this->order
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
        $validator->setForm($form);
        Form::set_current_action('dopayment');
        $validator->php(array(
            'OrderID'       => $this->order->ID,
            'PaymentMethod' => 'Dummy',
            'type' => 'visa',
            'name' => 'Tester Mc. Testerson',
            'number' => '4242424242424242'
        ));

        $requiredCount = 0;
        foreach ($validator->getErrors() as $error){
            if($error['messageType'] == 'required'){
                $requiredCount++;
            }
        }
        // 3 required fields missing
        $this->assertEquals(3, $requiredCount);

    }

    protected function stubGatewayFactory($stubGateway)
    {
        $factory = $this->getMockBuilder('Omnipay\Common\GatewayFactory')->getMock();

        $factory->expects($this->any())->method('create')->will($this->returnValue($stubGateway));

        return $factory;
    }

    protected function buildPaymentGatewayStub(
        $successValue,
        $transactionReference,
        $isRedirect = true
    ) {
        //--------------------------------------------------------------------------------------------------------------
        // request and response

        $mockResponse = $this->getMockBuilder('Omnipay\Common\Message\AbstractResponse')

            ->disableOriginalConstructor()->getMock();

        $mockResponse->expects($this->any())

            ->method('isSuccessful')->will($this->returnValue($successValue));


        $mockResponse->expects($this->any())

            ->method('isRedirect')->will($this->returnValue($isRedirect));


        $mockResponse->expects($this->any())

            ->method('getRedirectResponse')->will($this->returnValue(

                new \Symfony\Component\HttpFoundation\RedirectResponse('http://paymentprovider/test/offsiteform')
            ));

        $mockResponse->expects($this->any())

            ->method('getTransactionReference')->will($this->returnValue($transactionReference));


        $mockRequest = $this->getMockBuilder('Omnipay\Common\Message\AbstractRequest')

            ->disableOriginalConstructor()->getMock();

        $mockRequest->expects($this->any())

            ->method('send')->will($this->returnValue($mockResponse));


        $mockRequest->expects($this->any())

            ->method('getTransactionReference')->will($this->returnValue($transactionReference));



        //--------------------------------------------------------------------------------------------------------------
        // Build the gateway

        $stubGateway = $this->getMockBuilder('Omnipay\Common\AbstractGateway')

            ->setMethods(array('purchase', 'supportsCompletePurchase', 'getName'))
            ->getMock();

        $stubGateway->expects($this->any())

            ->method('purchase')
            ->will($this->returnValue($mockRequest));



        $stubGateway->expects($this->any())

            ->method('supportsCompletePurchase')
            ->will($this->returnValue($isRedirect));


        return $stubGateway;
    }
}


1			<?php
2
3			class OrderActionsFormTest extends FunctionalTest
4			{
5			protected static $fixture_file = array(
6			'silvershop/tests/fixtures/Pages.yml',
7			'silvershop/tests/fixtures/shop.yml',
8			);
9
10			protected $order;
11			protected $checkoutPage;
12
13			public function setUp()
14			{
15			parent::setUp();
16			ShopTest::setConfiguration();
17
18			// create order from fixture and persist to DB
19			$this->order = $this->objFromFixture("Order", "unpaid");
20			$this->order->write();
21
22			OrderManipulation::add_session_order($this->order);
			0 ignored issues – show Documentation introduced 2016-06-28 20:55 UTC by Report Bug Copy Issue Report `$this->order` is of type `object<DataObject>\|null`, but the function expects a `object<Order>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
23
24			// create checkoug page from fixture and publish it
25			$this->checkoutPage = $this->objFromFixture("CheckoutPage", "checkout");
26			$this->checkoutPage->publish('Stage', 'Live');
27
28			Config::inst()->update('Payment', 'allowed_gateways', array('Dummy'));
29			}
30
31			public function testOffsitePayment()
32			{
33			Config::inst()->update('GatewayInfo', 'Dummy', array('is_offsite' => true));
34			$stubGateway = $this->buildPaymentGatewayStub(true, 'test-' . $this->order->ID, true);
35			Injector::inst()->registerService($this->stubGatewayFactory($stubGateway), 'Omnipay\Common\GatewayFactory');
36
37			$ctrl = ModelAsController::controller_for($this->checkoutPage);
			0 ignored issues – show Documentation introduced 2016-06-28 20:55 UTC by Report Bug Copy Issue Report `$this->checkoutPage` is of type `object<DataObject>\|null`, but the function expects a `object<SiteTree>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
38

silvershop / silvershop-core

Pull Request — 2.0 (#511)

OrderActionsFormTest::buildPaymentGatewayStub() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like