PHPUnit: added test for Mage_Core_Model_Layout::getBlockSingleton()

.phpstan.dist.neon

@@ -28,7 +28,6 @@ parameters:
         - app/code/core/Mage/Admin/Model/Acl/Assert/Time.php
         - app/code/core/Mage/Api/Model/Acl/Assert/Ip.php
         - app/code/core/Mage/Api/Model/Acl/Assert/Time.php
-        - app/code/core/Mage/Adminhtml/Block/Widget/Grid/Block.php
         - app/code/core/Mage/Core/Model/Mysql4/Design/Theme/Collection.php
         - lib/Varien/Directory/Collection.php
         - lib/Varien/Directory/Factory.php

app/code/core/Mage/Core/Model/Layout.php

@@ -353,9 +353,12 @@ protected function _generateAction($node, $parent)
     }
 
     /**
+     * @codeCoverageIgnore
      * @param string                   $method
      * @param string[]                 $args
      * @throws Mage_Core_Exception
+     * @deprecated
+     * @see Mage_Core_Helper_Security::validateAgainstBlockMethodBlacklist()
      */
     protected function validateAgainstBlacklist(Mage_Core_Block_Abstract $block, $method, array $args)
     {
@@ -503,12 +506,12 @@ protected function _getBlockInstance($block, array $attributes = [])
                 }
             }
             if (class_exists($block, false) || mageFindClassFile($block)) {
-                // phpcs:ignore Ecg.Classes.ObjectInstantiation.DirectInstantiation
                 $block = new $block($attributes);
             }
         }
         if (!$block instanceof Mage_Core_Block_Abstract) {
-            Mage::throwException(Mage::helper('core')->__('Invalid block type: %s', $block));
+            $block = is_object($block) ? get_class($block) : $block;
+            Mage::throwException(Mage::helper('core')->__('Invalid block type: %s (not instance of Mage_Core_Block_Abstract)', $block));
         }
         return $block;
     }
@@ -591,7 +594,7 @@ public function getMessagesBlock()
 
     /**
      * @param string $type
-     * @return Mage_Core_Block_Abstract
+     * @return Mage_Core_Block_Abstract|object
      */
     public function getBlockSingleton($type)
     {
@@ -601,7 +604,6 @@ public function getBlockSingleton($type)
                 Mage::throwException(Mage::helper('core')->__('Invalid block type: %s', $type));
             }
 
-            // phpcs:ignore Ecg.Classes.ObjectInstantiation.DirectInstantiation
             $helper = new $className();
             if ($helper) {
                 if ($helper instanceof Mage_Core_Block_Abstract) {

app/locale/en_US/Mage_Core.csv

@@ -175,6 +175,7 @@
 "Invalid URL scheme.","Invalid URL scheme."
 "Invalid base url type","Invalid base url type"
 "Invalid block type: %s","Invalid block type: %s"
+"Invalid block type: %s (not instance of Mage_Core_Block_Abstract)","Invalid block type: %s (not instance of Mage_Core_Block_Abstract)"
 "Invalid block: %s","Invalid block: %s"
 "Invalid connection","Invalid connection"
 "Invalid date","Invalid date"

tests/unit/Mage/Core/Model/LayoutTest.php

@@ -0,0 +1,132 @@
+<?php
+
+/**
+ * OpenMage
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available at https://opensource.org/license/osl-3-0-php
+ *
+ * @category   OpenMage
+ * @package    OpenMage_Tests
+ * @copyright  Copyright (c) 2024 The OpenMage Contributors (https://www.openmage.org)
+ * @license    https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace OpenMage\Tests\Unit\Mage\Core\Model;
+
+use Generator;
+use Mage;
+use Mage_Core_Model_Layout;
+use OpenMage\Tests\Unit\Traits\PhpStormMetaData\BlocksTrait;
+use PHPUnit\Framework\TestCase;
+
+class LayoutTest extends TestCase
+{
+    use BlocksTrait;
+
+    public Mage_Core_Model_Layout $subject;
+
+    public function setUp(): void
+    {
+        Mage::app();
+        $this->subject = Mage::getModel('core/layout');
+    }
+
+    /**
+     * @dataProvider provideCreateBlock
+     * @group Mage_Core
+     * @group Mage_Core_Model
+     */
+    public function testCreateBlock($expectedResult, bool $willReturnBlock, string $type, ?string $name, array $attributes): void
+    {
+        $result = $this->subject->createBlock($type, $name, $attributes);
+
+        if ($willReturnBlock) {
+            $this->assertInstanceOf($expectedResult, $result);
+        } else {
+            $this->assertFalse($result);
+        }
+    }
+
+    public function provideCreateBlock(): Generator
+    {
+        yield 'instance of Mage_Core_Block_Abstract' => [
+            \Mage_Cms_Block_Block::class,
+            true,
+            'cms/block',
+            null,
+            [],
+        ];
+        yield 'not instance of Mage_Core_Block_Abstract' => [
+            false,
+            false,
+            'rule/conditions',
+            null,
+            [],
+        ];
+    }
+
+    /**
+     * @covers Mage_Core_Model_Layout::getBlockSingleton()
+     * @dataProvider provideGetBlockSingleton
+     * @group Mage_Core
+     * @group Mage_Core_Model
+     * @group pr4411
+     */
+    public function testGetBlockSingleton($expectedResult, bool $isAbstractBlock, string $type): void
+    {
+        $result = $this->subject->getBlockSingleton($type);
+
+        $this->assertInstanceOf($expectedResult, $result);
+
+        if ($isAbstractBlock) {
+            $this->assertInstanceOf(\Mage_Core_Block_Abstract::class, $result);
+        } else {
+            $this->assertNotInstanceOf(\Mage_Core_Block_Abstract::class, $result);
+        }
+    }
+
+    public function provideGetBlockSingleton(): Generator
+    {
+        $notInstanceOfMageCoreBlockAbstract = $this->getBlockClassesNotInstanceOfMageCoreBlockAbstract();
+
+        $ignoredClasses = array_merge(
+            $this->getAbstractBlockClasses(),
+            $this->getBlockClassesToMock(),
+            $this->getBlockClassesWithErrors(),
+            $this->getBlockClassesWithSessions(),
+        );
+
+        #$allBlocks = $this->getAllBlockClasses();
+        $allBlocks = [
+            'adminhtml/api_buttons' => \Mage_Adminhtml_Block_Api_Buttons::class,
+            'adminhtml/catalog_category_helper_pricestep' => \Mage_Adminhtml_Block_Catalog_Category_Helper_Pricestep::class,
+        ];
+
+        foreach ($allBlocks as $alias => $className) {
+            if (!in_array($className, $ignoredClasses)) {
+                yield $className => [
+                    $className,
+                    !in_array($className, $notInstanceOfMageCoreBlockAbstract),
+                    $alias,
+                ];
+            }
+        }
+    }
+
+    /**
+     * @covers Mage_Core_Model_Layout::getBlockSingleton()
+     * @group Mage_Core
+     * @group Mage_Core_Model
+     */
+    public function testGetBlockSingletonError(): void
+    {
+        $this->expectException(\Error::class);
+        $this->expectExceptionMessage("Class 'Mage_Invalid_Block_Type' not found");
+
+        $this->subject->getBlockSingleton('invalid/type');
+    }
+}

tests/unit/Mage/Core/Model/WebsiteTest.php

@@ -37,6 +37,7 @@ public function setUp(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testLoad(): void
     {
@@ -46,6 +47,7 @@ public function testLoad(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testLoadConfig(): void
     {
@@ -55,6 +57,7 @@ public function testLoadConfig(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetStoreCollection(): void
     {
@@ -63,6 +66,7 @@ public function testGetStoreCollection(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetGroupCollection(): void
     {
@@ -71,6 +75,7 @@ public function testGetGroupCollection(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetStores(): void
     {
@@ -79,6 +84,7 @@ public function testGetStores(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetStoreIds(): void
     {
@@ -87,6 +93,7 @@ public function testGetStoreIds(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetStoreCodes(): void
     {
@@ -95,6 +102,7 @@ public function testGetStoreCodes(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetStoresCount(): void
     {
@@ -103,6 +111,7 @@ public function testGetStoresCount(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetGroups(): void
     {
@@ -111,6 +120,7 @@ public function testGetGroups(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetGroupIds(): void
     {
@@ -119,6 +129,7 @@ public function testGetGroupIds(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetGroupsCount(): void
     {
@@ -127,6 +138,7 @@ public function testGetGroupsCount(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testGetBaseCurrency(): void
     {
@@ -136,6 +148,7 @@ public function testGetBaseCurrency(): void
 
     //    /**
     //     * @group Mage_Core
+    //     * @group Mage_Core_Model
     //     */
     //    public function testGetDefaultStore(): void
     //    {
@@ -154,6 +167,7 @@ public function testGetDefaultStoresSelect(): void
 
     /**
      * @group Mage_Core
+     * @group Mage_Core_Model
      */
     public function testIsReadOnly(): void
     {