5.5.1 release (#52)

* Fix unit tests for OXID 6.3 * Fix Spelling on new Klarna admin start page * Fix bug related with delivery cost adding up add unit test * add codeception test to check shipping method price * keep calcDeliverycost parent call for compatibility with other modules. * Fix Spelling on new Klarna admin start page english * version 5.5.1 update documentation
FATCHIP-GmbH · Jul 1, 2021 · 0d32160 · 0d32160
1 parent 29d57a2
commit 0d32160
Show file tree

Hide file tree

Showing 22 changed files with 198 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+### 5.5.1
+* Fix spelling on new Klarna admin start page DE/EN
+* Bugfix: Shipping costs add up
+* Update tests to be compatible with OXID 6.3.x
+* Update tests to be compatible with PHPUnit8 as well as older versions.
+
 ### 5.5.0
 * Remove Instant Shopping
 * Backend Rebranding

diff --git a/...ation/klarna-module-for-oxid-de-5.5.0.pdf → ...ation/klarna-module-for-oxid-de-5.5.1.pdf b/...ation/klarna-module-for-oxid-de-5.5.0.pdf → ...ation/klarna-module-for-oxid-de-5.5.1.pdf
diff --git a/...ation/klarna-module-for-oxid-en-5.5.0.pdf → ...ation/klarna-module-for-oxid-en-5.5.1.pdf b/...ation/klarna-module-for-oxid-en-5.5.0.pdf → ...ation/klarna-module-for-oxid-en-5.5.1.pdf
diff --git a/Model/KlarnaBasket.php b/Model/KlarnaBasket.php
@@ -497,9 +497,21 @@ protected function _getKlarnaCheckoutDiscount(Price $oPrice, $iLang = null, $tax
      */
     public function tcklarna_calculateDeliveryCost()
     {
+        $oDeliveryList = oxNew(DeliveryList::class);
+        Registry::set(DeliveryList::class, $oDeliveryList);
+
         return parent::_calcDeliveryCost();
     }
 
+    /**
+     * @throws \OxidEsales\Eshop\Core\Exception\SystemComponentException
+     * @return object
+     */
+    protected function _calcDeliveryCost()
+    {
+        return KlarnaUtils::isKlarnaPaymentsEnabled()?$this->tcklarna_calculateDeliveryCost():parent::_calcDeliveryCost();
+    }
+
     /**
      * Get average of order VAT
      * @return float

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Klarna Checkout and Klarna Payments Module for the OXID eShop
 ### Title: Klarna Checkout and Klarna Payments Module for the OXID eShop
 ### Author: cgrd GmbH, https://www.cgrd.de/oxid-eshop
 ### Prefix: tcklarna
-### Version: 5.5.0
+### Version: 5.5.1
 ### Link: https://www.klarna.com/de/verkaeufer/plattformen-und-partner/oxid/
 ### Mail: oxid@klarna.com
 
@@ -21,11 +21,11 @@ OXID eShop Plugin to integrate Klarna Checkout and Klarna Payments to OXID eShop
 
 In the shop's main folder ( the one with composer.json file) run this command:
 
-  composer require topconcepts/oxid-klarna-6:v5.5.0
+  composer require topconcepts/oxid-klarna-6:v5.5.1
 
 or add the following line within the "require" section to your composer.json file:
 
-  "topconcepts/oxid-klarna-6": "v5.5.0"
+  "topconcepts/oxid-klarna-6": "v5.5.1"
 
 and run 
 
@@ -36,5 +36,5 @@ and run
 
 See folder /Documentation in this package or download latest manuals here:
 
-### In English: https://www.cgrd.de/customer/klarna/docs/klarna-module-for-oxid-en-5.5.0.pdf
-### In German: https://www.cgrd.de/customer/klarna/docs/klarna-module-for-oxid-de-5.5.0.pdf
+### In English: https://www.cgrd.de/customer/klarna/docs/klarna-module-for-oxid-en-5.5.1.pdf
+### In German: https://www.cgrd.de/customer/klarna/docs/klarna-module-for-oxid-de-5.5.1.pdf
diff --git a/Tests/Codeception/Page/Kco.php b/Tests/Codeception/Page/Kco.php
@@ -136,7 +136,7 @@ public function fillKcoUserForm()
      * @param AcceptanceTester $I
      * @throws \Exception
      */
-    public function fillKcoShippingForm() {
+    public function fillKcoShippingForm($shippingMethod = 'UPS 48') {
         $I = $this->user;
         $I->wait(4); // wait for loaders and overlays to be hidden
         $I->click('//*[@id="klarna-checkout-shipping-details"]//*[@id="preview__link"]');
@@ -152,7 +152,7 @@ public function fillKcoShippingForm() {
         $I->switchToIFrame();
         $I->switchToIFrame($this->frames['main']);
         $I->wait(5);
-        $I->selectOption('#SHIPMO-container input[name=radio]', 'UPS 48');
+        $I->selectOption('#SHIPMO-container input[name=radio]', $shippingMethod);
         $I->wait(3);
     }
 

diff --git a/Tests/Codeception/acceptance/CheckoutKCOCest.php b/Tests/Codeception/acceptance/CheckoutKCOCest.php
@@ -248,4 +248,61 @@ public function createAccountAndSubscribe(AcceptanceTester $I)
         $I->seeOrderInDb($klarnaId, $inputDataMapper);
         $I->seeInKlarnaAPI($klarnaId, "AUTHORIZED", true);
     }
+
+    /**
+     * @group KCO_frontend
+     * @param AcceptanceTester $I
+     * @throws \Exception
+     */
+    public function differentShippingMethod(AcceptanceTester $I)
+    {
+        $I->clearShopCache();
+        $I->wantToTest('Checkout with different shipping method');
+        $I->loadKlarnaAdminConfig('KCO');
+        $homePage = $I->openShop();
+        $basket = new Basket($I);
+        $basket->addProductToBasket('05848170643ab0deb9914566391c0c63', 1);
+        $basket->addProductToBasket('058de8224773a1d5fd54d523f0c823e0', 1);
+        $homePage->openMiniBasket();
+        $I->click(Translator::translate('CHECKOUT'));
+        $I->waitForPageLoad();
+        $I->click("//form[@id='select-country-form']//button[@value='DE']");
+        $I->wait(2);
+
+        $kco = new Kco($I);
+        $kco->fillKcoUserForm();
+        $I->wait(2);
+        //Test if shipping method price is correct
+        $I->see('12,90 €');
+        $I->wait(2);
+        //different shipping method
+        $kco->fillKcoShippingForm('UPS Express 24');
+        $I->wait(2);
+        $I->executeJS('document.querySelector("[data-cid=\'button.buy_button\']").click()');
+        $I->wait(2);
+        $I->switchToIFrame(); // navigate back to to main document frame
+        $I->waitForElement('#thankyouPage');
+        $I->waitForPageLoad();
+
+        $billEmail = Fixtures::get('gKCOEmail'); // recall generated and stored email
+        $I->seeInDatabase('oxuser', ['oxusername' => $billEmail, 'oxpassword' => '']);
+        $klarnaId = $I->grabFromDatabase('oxorder', 'TCKLARNA_ORDERID', ['OXBILLEMAIL' => $billEmail]);
+        $I->assertNotEmpty($klarnaId);
+
+        $inputDataMapper = [
+            'sKCOFormPostCode' => 'OXBILLZIP',
+            'sKCOFormGivenName' => 'OXBILLFNAME',
+            'sKCOFormFamilyName' => 'OXBILLLNAME',
+            'sKCOFormStreetName' => 'OXBILLSTREET',
+            'sKCOFormStreetNumber' => 'OXBILLSTREETNR',
+            'sKCOFormCity' => 'OXBILLCITY',
+            'sKCOFormDelPostCode' => 'OXDELZIP',
+            'sKCOFormDelStreetName' => 'OXDELSTREET',
+            'sKCOFormDelStreetNumber' => 'OXDELSTREETNR',
+            'sKCOFormDelCity' => 'OXDELCITY',
+        ];
+
+        $I->seeOrderInDb($klarnaId, $inputDataMapper);
+        $I->seeInKlarnaAPI($klarnaId, "AUTHORIZED", true);
+    }
 }
diff --git a/Tests/Unit/Component/KlarnaBasketComponentTest.php b/Tests/Unit/Component/KlarnaBasketComponentTest.php
@@ -17,7 +17,7 @@
  */
 class KlarnaBasketComponentTest extends ModuleUnitTestCase {
 
-    protected function setUp() {
+    protected function setUp(): void {
         parent::setUp();
     }
 

diff --git a/Tests/Unit/Controller/Admin/KlarnaOrderOverviewTest.php b/Tests/Unit/Controller/Admin/KlarnaOrderOverviewTest.php
@@ -276,20 +276,20 @@ public function captureInSyncDataProvider() {
     }
 
     public function testIsCredentialsValid() {
+        $this->setOrder();
         $controller = $this->getMockBuilder(OrderOverview::class)
             ->setMethods(['getEditObjectId',])
             ->getMock();
         $controller->expects($this->any())->method('getEditObjectId')->willReturn('test');
         $result = $controller->isCredentialsValid();
         $this->assertFalse($result);
 
-        $this->setOrder();
         $this->setModuleConfVar('aKlarnaCreds_DE', '');
         $this->setModuleConfVar('sKlarnaMerchantId', 'smid');
         $this->setModuleConfVar('sKlarnaPassword', 'psw');
         $controller = $this->getMockBuilder(OrderOverview::class)
-        ->setMethods(['getEditObjectId'])
-        ->getMock();
+            ->setMethods(['getEditObjectId'])
+            ->getMock();
         $controller->expects($this->any())->method('getEditObjectId')->willReturn('test');
         $result = $controller->isCredentialsValid();
         $this->assertTrue($result);

diff --git a/Tests/Unit/Controller/KlarnaExpressControllerTest.php b/Tests/Unit/Controller/KlarnaExpressControllerTest.php
@@ -197,7 +197,7 @@ public function testCheckSsl($sslredirect, $expectedResult) {
         $oRequest->expects($this->once())->method('getRequestEscapedParameter')->willReturn($sslredirect);
         $kcoController = oxNew(KlarnaExpressController::class);
         $kcoController->checkSsl($oRequest);
-        $this->assertContains((string)$expectedResult, (string)\oxUtilsHelper::$sRedirectUrl);
+        $this->doAssertContains((string)$expectedResult, (string)\oxUtilsHelper::$sRedirectUrl);
     }
 
     public function checkSslDataProvider() {

diff --git a/Tests/Unit/Controller/KlarnaPaymentControllerTest.php b/Tests/Unit/Controller/KlarnaPaymentControllerTest.php
@@ -55,28 +55,28 @@ public function initDataProvider()
 
         return [
             ['KCO', false, null, 'DE', null,
-             [null, true, $redirectUrl],
+                [null, true, $redirectUrl],
             ],
             ['KP', false, null, 'DE', null,
-             [null, true, null],
+                [null, true, null],
             ],
             ['KCO', false, null, 'AF', null,
-             [null, true, null],
+                [null, true, null],
             ],
             ['KCO', $oUser, null, null, null,
-             [null, true, $redirectUrl],
+                [null, true, $redirectUrl],
             ],
             ['KCO', $oUser, null, null, 'nonKCORequest',
-             [null, true, null],
+                [null, true, null],
             ],
             ['KCO', $oUserAT, 'amazonRef', null, null,
-             ['AT', false, null],
+                ['AT', false, null],
             ],
             ['KCO', $oUserDE, null, null, null,
-             ['DE', true, $redirectUrl],
+                ['DE', true, $redirectUrl],
             ],
             ['KCO', $oUserAF, null, null, null,
-             ['AF', true, null],
+                ['AF', true, null],
             ],
         ];
     }
@@ -110,7 +110,7 @@ public function testRemoveKlarnaPrefix()
     {
         $oPaymentController = oxNew(PaymentController::class);
         $result             = $oPaymentController->removeKlarnaPrefix('Klarna String');
-        $this->assertNotContains('Klarna ', $result);
+        $this->doAssertNotContains('Klarna ', $result);
     }
 
     public function testIncludeKPWidget()
@@ -413,23 +413,23 @@ public function validatePaymentDataProvider()
         return [
             // authorized (requires finalization)
             ['klarna_pay_later', true, null, self::COUNTRIES['DE'],
-             ['KP_data'], 'order'],
+                ['KP_data'], 'order'],
 
             // authorized (token present)
             ['klarna_pay_now', null, 'authToken', self::COUNTRIES['DE'],
-             ['KP_data'], 'order'],
+                ['KP_data'], 'order'],
 
             // error - not available in this country
             ['klarna_pay_now', null, 'authToken', self::COUNTRIES['AF'],
-             ['KP_data'], null],
+                ['KP_data'], null],
 
             // not authorized and no error
             ['klarna_slice_it', null, null, null,
-             ['KP_data'], null],
+                ['KP_data'], null],
 
             // not KP
             ['other', null, null, null,
-            null, 'order']
+                null, 'order']
         ];
     }
 

diff --git a/Tests/Unit/Controller/KlarnaValidationControllerTest.php b/Tests/Unit/Controller/KlarnaValidationControllerTest.php
@@ -18,13 +18,13 @@
 class KlarnaValidationControllerTest extends ModuleUnitTestCase
 {
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
         $this->setModuleConfVar('blKlarnaLoggingEnabled', true, 'bool');
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         parent::tearDown();
         $this->setModuleConfVar('blKlarnaLoggingEnabled', false, 'bool');
@@ -114,7 +114,7 @@ public function testInit_errorsAndLogs()
         $this->assertNotEmpty($result->count());
 
         $this->assertEquals(303, \oxUtilsHelper::$iCode);
-        $this->assertContains('klarnaInvalid=1&MY_ERROR=33&CANT_BUY=10', \oxUtilsHelper::$sRedirectUrl);
+        $this->doAssertContains('klarnaInvalid=1&MY_ERROR=33&CANT_BUY=10', \oxUtilsHelper::$sRedirectUrl);
     }
 
 

diff --git a/Tests/Unit/Core/KlarnaFormatterTest.php b/Tests/Unit/Core/KlarnaFormatterTest.php
@@ -77,7 +77,7 @@ public function testKlarnaToOxidAddress($sKey, $addressData, $expected)
         $result = KlarnaFormatter::klarnaToOxidAddress($addressData, $sKey);
         $sKey === null
             ? $this->assertNull($result)
-            : $this->assertArraySubset($expected, $result);
+            : $this->doAssertArraySubset($expected, $result);
     }
 
     public function klarnaToOxidAddressDataprovider()
@@ -165,4 +165,13 @@ public function addressFormatterDataProvider()
             ['c95a1d97acaebd371851727d1173dcd0', false]
         ];
     }
-}
+
+    protected function doAssertArraySubset($needle, $haystack)
+    {
+        if (method_exists($this, 'assertArraySubsetOxid')) {
+            parent::assertArraySubsetOxid($needle, $haystack);
+        } else {
+            parent::assertArraySubset($needle, $haystack);
+        }
+    }
+}
diff --git a/Tests/Unit/Core/KlarnaPaymentTest.php b/Tests/Unit/Core/KlarnaPaymentTest.php
@@ -148,11 +148,11 @@ public function test__construct($aPost, $results)
 
         $oKlarnaOrder = new  KlarnaPayment($oBasket, $oUser, $aPost);
 
-        $this->assertContains($results['controllerName'], $oKlarnaOrder->refreshUrl);
+        $this->doAssertContains($results['controllerName'], $oKlarnaOrder->refreshUrl);
         $this->assertEquals($results['_sPaymentMethod'], $this->getProtectedClassProperty($oKlarnaOrder, '_sPaymentMethod'));
         $this->assertEquals($results['currencyToCountryMatch'], $this->getProtectedClassProperty($oKlarnaOrder, 'currencyToCountryMatch'));
         $this->assertEquals((bool)$results['error'], $oKlarnaOrder->isError());
-        $results['error'] && $this->assertContains($results['error'], $oKlarnaOrder->getError()[0]);
+        $results['error'] && $this->doAssertContains($results['error'], $oKlarnaOrder->getError()[0]);
         $this->assertEquals($results['reauthorizeRequired'], $this->getSessionParam('reauthorizeRequired'));
         $this->assertEquals($results['sessionValid'], $oKlarnaOrder->isSessionValid());
 

diff --git a/Tests/Unit/Core/KlarnaUtilsTest.php b/Tests/Unit/Core/KlarnaUtilsTest.php
@@ -49,7 +49,7 @@ public function testCalculateOrderAmountsPricesAndTaxes_1()
             ->getMock();
         $item->expects($this->exactly(2))->method('isBundle')->willReturn(false);
         $item->expects($this->once())->method('getUnitPrice')->willReturn($price);
-        $item->expects($this->once())->method('getArticle')->willReturn($article);
+        $item->expects($this->exactly(2))->method('getArticle')->willReturn($article);
         $item->expects($this->once())->method('getRegularUnitPrice')->willReturn($priceUnit);
         $result = KlarnaUtils::calculateOrderAmountsPricesAndTaxes($item, true);
         $expected = [

diff --git a/Tests/Unit/Model/KlarnaBasketTest.php b/Tests/Unit/Model/KlarnaBasketTest.php
@@ -37,6 +37,51 @@ public function testSetKlarnaOrderLang($iLang)
         $this->assertEquals($iLang, $result);
     }
 
+    /**
+     *
+     */
+    public function testTcklarna_calculateDeliveryCost()
+    {
+        $oBasket = $this->getMockBuilder(Basket::class)->setMethods(['getAdditionalServicesVatPercent'])->getMock();
+        $oBasket->expects($this->once())->method('getAdditionalServicesVatPercent')->willReturn(7.00);
+        $this->setConfigParam('blDeliveryVatOnTop', true);
+        $oBasket->setDeliveryPrice('price already set');
+
+        $result = $oBasket->tcklarna_calculateDeliveryCost();
+        $this->assertEquals('price already set', $result);
+
+
+        $oBasket->setDeliveryPrice(null);
+        $this->setConfigParam('blCalculateDelCostIfNotLoggedIn', false);
+
+        $result = $oBasket->tcklarna_calculateDeliveryCost();
+        $this->assertTrue($result instanceof Price);
+        $this->assertTrue($result->isNettoMode());
+        $this->assertEquals(0, $result->getVat());
+        $this->assertEquals(0, $result->getBruttoPrice());
+        $this->assertEquals(0, $result->getNettoPrice());
+        $this->assertEquals(0, $result->getVatValue());
+
+
+        $this->setConfigParam('blDeliveryVatOnTop', false);
+        $oUser = oxNew(User::class);
+        $oUser->load('oxdefaultadmin');
+        $oBasket->setBasketUser($oUser);
+        $oDelivery = oxNew(Delivery::class);
+        $oPrice    = oxNew(Price::class);
+        $oPrice->setPrice(100.00);
+        $oDelivery->setDeliveryPrice($oPrice);
+        $oDeliveryList = $this->getMockBuilder(DeliveryList::class)->setMethods(['getDeliveryList'])->getMock();
+        $oDeliveryList->expects($this->once())->method('getDeliveryList')->willReturn([$oDelivery]);
+        UtilsObject::setClassInstance(DeliveryList::class, $oDeliveryList);
+
+        $result = $oBasket->tcklarna_calculateDeliveryCost();
+        $this->assertTrue($result instanceof Price);
+        $this->assertEquals(7, $result->getVat());
+        $this->assertEquals(100, $result->getBruttoPrice());
+        $this->assertEquals(6.54, $result->getVatValue());
+    }
+
     /**
      *
      * @dataProvider KlarnaPaymentDeliveryDataProvider

diff --git a/Tests/Unit/Model/KlarnaUserPaymentTest.php b/Tests/Unit/Model/KlarnaUserPaymentTest.php
@@ -27,7 +27,7 @@ public function testGetBadgeUrl($payId, $expectedResult, $notUsed)
 
         $result = $userPaymentModel->getBadgeUrl();
 
-        $this->assertContains($expectedResult, $result);
+        $this->doAssertContains($expectedResult, $result);
     }
 
     public function paymentDataProvider()