CrudTest::testCrudDocument() - Code Metrics - Inspection of "Internet document model" - sergeynezbritskiy/nova-poshta-api - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#13)

by Sergey

created 2023-07-19 00:14 UTC

CrudTest::testCrudDocument() A

↳ Parent: CrudTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	60
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	27
c	1
b	0
f	1
dl	0
loc	60
rs	9.488
cc	1
nc	1
nop	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace SergeyNezbritskiy\NovaPoshta\Tests\Integration\Models\InternetDocument;

use PHPUnit\Framework\TestCase;
use SergeyNezbritskiy\NovaPoshta\Models\InternetDocument;
use SergeyNezbritskiy\NovaPoshta\NovaPoshtaApiException;
use SergeyNezbritskiy\NovaPoshta\Tests\AssertEntityByPropertiesTrait;
use SergeyNezbritskiy\NovaPoshta\Tests\ConstantsInterface;
use SergeyNezbritskiy\NovaPoshta\Tests\UsesConnectionTrait;

class CrudTest extends TestCase implements ConstantsInterface
{
    use AssertEntityByPropertiesTrait;
    use UsesConnectionTrait;

    private InternetDocument $model;

    protected function setUp(): void
    {
        date_default_timezone_set('Europe/Kyiv');
        $connection = $this->getConnection();
        $this->model = new InternetDocument($connection);
    }

    /**
     * @throws NovaPoshtaApiException
     */
    public function testCrudDocument(): void
    {

//        $counterpartyModel = new \SergeyNezbritskiy\NovaPoshta\Models\Counterparty($this->getConnection());
//        $addressModel = new \SergeyNezbritskiy\NovaPoshta\Models\Address($this->getConnection());

//        $recipient = $counterpartyModel->savePrivatePerson([
//            'FirstName' => 'Петро',
//            'MiddleName' => 'Григорович',
//            'LastName' => 'Порошенко',
//            'Phone' => 380501112233,
//            'Email' => '[email protected]',
//            'CounterpartyProperty' => Counterparty::COUNTERPARTY_PROPERTY_RECIPIENT,
//        ]); // 4d21c8c7-b88e-11ed-a60f-48df37b921db
        $recipientRef = '4d21c8c7-b88e-11ed-a60f-48df37b921db';

//        $address = $addressModel->save($recipientRef, [
//            'StreetRef' => self::KHRESHCHATYK_STREET_REF,
//            'BuildingNumber' => '20',
//            'Flat' => '12',
//        ]);
        $addressRef = 'cecaac32-25bb-11ee-a60f-48df37b921db';

//        $contactPersons = $counterpartyModel->getCounterpartyContactPersons(self::COUNTERPARTY_REF);
        $senderContactRef = '4d06cbac-b88e-11ed-a60f-48df37b921db';

//        $contactPersons = $counterpartyModel->getCounterpartyContactPersons($recipientRef);
        $recipientContactRef = '45b55250-25bb-11ee-a60f-48df37b921db';

        //create document
        $params = [
            'Sender' => self::COUNTERPARTY_REF,
            'CitySender' => self::CITY_REF_KHARKIV,
            'SenderAddress' => self::ADDRESS_REF_KHARKIV,
            'ContactSender' => $senderContactRef,
            'SendersPhone' => 380505511696,

            'Recipient' => $recipientRef,
            'CityRecipient' => self::CITY_REF_KYIV,
            'RecipientAddress' => $addressRef,
            'ContactRecipient' => $recipientContactRef,
            'RecipientsPhone' => 380505511696,

            'DateTime' => date('d.m.Y'),
            'CargoType' => InternetDocument::CARGO_TYPE_CARGO,
            'Weight' => '0.5',
            'SeatsAmount' => '1',
            'ServiceType' => 'DoorsDoors',
            'PayerType' => 'Recipient',
            'PaymentMethod' => 'Cash',
            'Description' => 'TEST, DO NOT PROCEED WITH THIS'
        ];

        $actualResult = $this->model->save($params);
        $this->assertNotEmpty($actualResult['Ref']);

        //delete document
        $this->deleteDocument($actualResult['Ref']);

        $this->assertDocumentDeleted($actualResult['Ref']);
    }

    /**
     * @param string $ref
     * @param int $attempt
     * @return void
     * @throws NovaPoshtaApiException
     * @SuppressWarninds(PHPMD.ElseExpression)
     */
    private function deleteDocument(string $ref, int $attempt = 1): void
    {
        sleep(5 * $attempt);
        try {
            $this->model->delete($ref);
        } catch (NovaPoshtaApiException $e) {
            $docNotCreatedYet = $e->getMessage() === 'No document changed DeletionMark';
            $attemptsNotExceeded = $attempt <= 3;
            if ($attemptsNotExceeded && $docNotCreatedYet) {
                $this->deleteDocument($ref, ++$attempt);
            } else {
                throw $e;
            }
        }
    }

    /**
     * @param string $ref
     * @return void
     * @throws NovaPoshtaApiException
     */
    private function assertDocumentDeleted(string $ref): void
    {
        $documents = $this->model->getDocumentList([
            'DateTimeFrom' => date('d.m.Y', strtotime('-2 days')),
            'DateTimeTo' => date('d.m.Y', strtotime('+2 days')),
            'GetFullList' => 1,
            'DateTime' => date('d.m.Y'),
        ], 1);
        foreach ($documents as $document) {
            if ($document['Ref'] === $ref) {
                $this->fail('Failed to delete document.');
            }
        }
        $this->assertTrue(true, 'Just to suppress error that method doesn\'t do any assertions');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SergeyNezbritskiy\NovaPoshta\Tests\Integration\Models\InternetDocument;
6
7			use PHPUnit\Framework\TestCase;
8			use SergeyNezbritskiy\NovaPoshta\Models\InternetDocument;
9			use SergeyNezbritskiy\NovaPoshta\NovaPoshtaApiException;
10			use SergeyNezbritskiy\NovaPoshta\Tests\AssertEntityByPropertiesTrait;
11			use SergeyNezbritskiy\NovaPoshta\Tests\ConstantsInterface;
12			use SergeyNezbritskiy\NovaPoshta\Tests\UsesConnectionTrait;
13
14			class CrudTest extends TestCase implements ConstantsInterface
15			{
16			use AssertEntityByPropertiesTrait;
17			use UsesConnectionTrait;
18
19			private InternetDocument $model;
20
21			protected function setUp(): void
22			{
23			date_default_timezone_set('Europe/Kyiv');
24			$connection = $this->getConnection();
25			$this->model = new InternetDocument($connection);
26			}
27
28			/**
29			* @throws NovaPoshtaApiException
30			*/
31			public function testCrudDocument(): void
32			{
33
34			// $counterpartyModel = new \SergeyNezbritskiy\NovaPoshta\Models\Counterparty($this->getConnection());
35			// $addressModel = new \SergeyNezbritskiy\NovaPoshta\Models\Address($this->getConnection());
36
37			// $recipient = $counterpartyModel->savePrivatePerson([
38			// 'FirstName' => 'Петро',
39			// 'MiddleName' => 'Григорович',
40			// 'LastName' => 'Порошенко',
41			// 'Phone' => 380501112233,
42			// 'Email' => '[email protected]',
43			// 'CounterpartyProperty' => Counterparty::COUNTERPARTY_PROPERTY_RECIPIENT,
44			// ]); // 4d21c8c7-b88e-11ed-a60f-48df37b921db
45			$recipientRef = '4d21c8c7-b88e-11ed-a60f-48df37b921db';
46
47			// $address = $addressModel->save($recipientRef, [
48			// 'StreetRef' => self::KHRESHCHATYK_STREET_REF,
49			// 'BuildingNumber' => '20',
50			// 'Flat' => '12',
51			// ]);
52			$addressRef = 'cecaac32-25bb-11ee-a60f-48df37b921db';
53
54			// $contactPersons = $counterpartyModel->getCounterpartyContactPersons(self::COUNTERPARTY_REF);
55			$senderContactRef = '4d06cbac-b88e-11ed-a60f-48df37b921db';
56
57			// $contactPersons = $counterpartyModel->getCounterpartyContactPersons($recipientRef);
58			$recipientContactRef = '45b55250-25bb-11ee-a60f-48df37b921db';
59
60			//create document
61			$params = [
62			'Sender' => self::COUNTERPARTY_REF,
63			'CitySender' => self::CITY_REF_KHARKIV,
64			'SenderAddress' => self::ADDRESS_REF_KHARKIV,
65			'ContactSender' => $senderContactRef,
66			'SendersPhone' => 380505511696,
67
68			'Recipient' => $recipientRef,
69			'CityRecipient' => self::CITY_REF_KYIV,
70			'RecipientAddress' => $addressRef,
71			'ContactRecipient' => $recipientContactRef,
72			'RecipientsPhone' => 380505511696,
73
74			'DateTime' => date('d.m.Y'),
75			'CargoType' => InternetDocument::CARGO_TYPE_CARGO,
76			'Weight' => '0.5',
77			'SeatsAmount' => '1',
78			'ServiceType' => 'DoorsDoors',
79			'PayerType' => 'Recipient',
80			'PaymentMethod' => 'Cash',
81			'Description' => 'TEST, DO NOT PROCEED WITH THIS'
82			];
83
84			$actualResult = $this->model->save($params);
85			$this->assertNotEmpty($actualResult['Ref']);
86
87			//delete document
88			$this->deleteDocument($actualResult['Ref']);
89
90			$this->assertDocumentDeleted($actualResult['Ref']);
91			}
92
93			/**
94			* @param string $ref
95			* @param int $attempt
96			* @return void
97			* @throws NovaPoshtaApiException
98			* @SuppressWarninds(PHPMD.ElseExpression)
99			*/
100			private function deleteDocument(string $ref, int $attempt = 1): void
101			{
102			sleep(5 * $attempt);
103			try {
104			$this->model->delete($ref);
105			} catch (NovaPoshtaApiException $e) {
106			$docNotCreatedYet = $e->getMessage() === 'No document changed DeletionMark';
107			$attemptsNotExceeded = $attempt <= 3;
108			if ($attemptsNotExceeded && $docNotCreatedYet) {
109			$this->deleteDocument($ref, ++$attempt);
110			} else {
111			throw $e;
112			}
113			}
114			}
115
116			/**
117			* @param string $ref
118			* @return void
119			* @throws NovaPoshtaApiException
120			*/
121			private function assertDocumentDeleted(string $ref): void
122			{
123			$documents = $this->model->getDocumentList([
124			'DateTimeFrom' => date('d.m.Y', strtotime('-2 days')),
125			'DateTimeTo' => date('d.m.Y', strtotime('+2 days')),
126			'GetFullList' => 1,
127			'DateTime' => date('d.m.Y'),
128			], 1);
129			foreach ($documents as $document) {
130			if ($document['Ref'] === $ref) {
131			$this->fail('Failed to delete document.');
132			}
133			}
134			$this->assertTrue(true, 'Just to suppress error that method doesn\'t do any assertions');
135			}
136			}
137

sergeynezbritskiy / nova-poshta-api

Pull Request — master (#13)

CrudTest::testCrudDocument() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like