Merge pull request #27 from wick-ed/patch#811

Allow for forced static calls to original method

CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 1.3.3
+
+## Bugfixes
+
+* Fixed [#811](https://github.com/appserver-io/appserver/issues/811) - Endless recursion on parent::<METHOD> call
+
+## Features
+
+* None
+
 # Version 1.3.2
 
 ## Bugfixes

build.default.properties

@@ -8,7 +8,7 @@
 #--------------------------------------------------------------------------------
 
 # ---- Module Release Settings --------------------------------------------------
-release.version = 1.3.2
+release.version = 1.3.3
 
 # ---- PHPCPD Settings ----------------------------------------------------------
 # Directories

src/Entities/Definitions/FunctionDefinition.php

@@ -356,13 +356,14 @@ public function getAllPostconditions($nonPrivateOnly = false)
      * Will return the header of this function either in calling or in defining manner.
      * String will stop after the closing ")" bracket, so the string can be used for interfaces as well.
      *
-     * @param string  $type   Can be either "call" or "definition"
-     * @param string  $suffix Suffix for the function name
-     * @param boolean $showMe Will mark a method as original by extending it with a suffix
+     * @param string  $type        Can be either "call" or "definition"
+     * @param string  $suffix      Suffix for the function name
+     * @param boolean $showMe      Will mark a method as original by extending it with a suffix
+     * @param boolean $forceStatic Will force static call for call type headers
      *
      * @return  string
      */
-    public function getHeader($type, $suffix = '', $showMe = false)
+    public function getHeader($type, $suffix = '', $showMe = false, $forceStatic = false)
     {
         $header = '';
 
@@ -395,7 +396,7 @@ public function getHeader($type, $suffix = '', $showMe = false)
 
         // If we have to generate code for a call we have to check for either static or normal access
         if ($type === 'call') {
-            if ($this->isStatic === true) {
+            if ($this->isStatic === true || $forceStatic) {
                 $header .= 'self::';
             } else {
                 $header .= '$this->';

src/StreamFilters/ProcessingFilter.php

@@ -122,6 +122,6 @@ public function filter($in, $out, &$consumed, $closing)
     protected function generateCode(FunctionDefinition $functionDefinition)
     {
         // Build up the call to the original function
-        return ReservedKeywords::RESULT . ' = ' . $functionDefinition->getHeader('call', ReservedKeywords::ORIGINAL_FUNCTION_SUFFIX) . ';';
+        return ReservedKeywords::RESULT . ' = ' . $functionDefinition->getHeader('call', ReservedKeywords::ORIGINAL_FUNCTION_SUFFIX, false, true) . ';';
     }
 }

tests/Tests/Data/GeneratorTest/RecursionTestClass1.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * \AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest\RecursionTestClass1
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ *
+ * PHP version 5
+ *
+ * @author    Bernhard Wick <bw@appserver.io>
+ * @copyright 2015 TechDivision GmbH - <info@appserver.io>
+ * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
+ * @link      https://github.com/appserver-io/doppelgaenger
+ * @link      http://www.appserver.io/
+ */
+
+namespace AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest;
+
+/**
+ * Class used to test the safety against an endless recursion introduced by the usage of parent::-calls
+ * in a direct child/parent relationship
+ *
+ * @author    Bernhard Wick <bw@appserver.io>
+ * @copyright 2015 TechDivision GmbH - <info@appserver.io>
+ * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
+ * @link      https://github.com/appserver-io/doppelgaenger
+ * @link      http://www.appserver.io/
+ */
+class RecursionTestClass1
+{
+
+    /**
+     * Method which should not be called recursively more than once
+     *
+     * @return void
+     */
+    public function iDontWantToBeRecursive()
+    {
+    }
+}

tests/Tests/Data/GeneratorTest/RecursionTestClass2.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * \AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest\RecursionTestClass2
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ *
+ * PHP version 5
+ *
+ * @author    Bernhard Wick <bw@appserver.io>
+ * @copyright 2015 TechDivision GmbH - <info@appserver.io>
+ * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
+ * @link      https://github.com/appserver-io/doppelgaenger
+ * @link      http://www.appserver.io/
+ */
+
+namespace AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest;
+
+/**
+ * Class used to test the safety against an endless recursion introduced by the usage of parent::-calls
+ * in a direct child/parent relationship
+ *
+ * @author    Bernhard Wick <bw@appserver.io>
+ * @copyright 2015 TechDivision GmbH - <info@appserver.io>
+ * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
+ * @link      https://github.com/appserver-io/doppelgaenger
+ * @link      http://www.appserver.io/
+ */
+class RecursionTestClass2 extends RecursionTestClass1
+{
+
+    /**
+     * Counter to measure calls
+     *
+     * @var integer $recursionCounter
+     */
+    public $recursionCounter = 0;
+
+    /**
+     * Method which should not be called recursively more than once
+     *
+     * @return void
+     */
+    public function iDontWantToBeRecursive()
+    {
+        // increment the counter
+        $this->recursionCounter ++;
+
+        // stop execution at a point which MUST have been an unwanted recursion
+        if ($this->recursionCounter < 10) {
+            parent::iDontWantToBeRecursive();
+        }
+    }
+}

tests/Tests/Functional/GeneratorTest.php

@@ -24,6 +24,7 @@
 use AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest\CustomProcessingTestClass;
 use AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest\LocalCustomProcessingTestClass;
 use AppserverIo\Doppelgaenger\Tests\Data\TagPlacementTestClass;
+use AppserverIo\Doppelgaenger\Tests\Data\GeneratorTest\RecursionTestClass2;
 
 /**
  * This test covers known generator problems
@@ -40,7 +41,7 @@ class GeneratorTest extends \PHPUnit_Framework_TestCase
     /**
      * Will test if a randomly placed php tag will throw of the generator
      *
-     * @return null
+     * @return void
      */
     public function testPhpTag()
     {
@@ -50,7 +51,7 @@ public function testPhpTag()
     /**
      * Method to test if an around advice is able to proceed the initially called method
      *
-     * @return null
+     * @return void
      */
     public function testProceededMethod()
     {
@@ -68,7 +69,7 @@ public function testProceededMethod()
     /**
      * Method to test if an around advice is able to block the initially called method
      *
-     * @return null
+     * @return void
      */
     public function testBlockedMethod()
     {
@@ -86,7 +87,7 @@ public function testBlockedMethod()
     /**
      * Method to test if an around advice can proceed the advised method AFTER the own logic
      *
-     * @return null
+     * @return void
      */
     public function testAdviceAfterAdvisedOrder()
     {
@@ -104,7 +105,7 @@ public function testAdviceAfterAdvisedOrder()
     /**
      * Method to test if an around advice can proceed the advised method BEFORE the own logic
      *
-     * @return null
+     * @return void
      */
     public function testAdviceBeforeAdvisedOrder()
     {
@@ -122,54 +123,67 @@ public function testAdviceBeforeAdvisedOrder()
     /**
      * Will test if we can enable custom enforcement processing on class level using the @Processing annotation
      *
-     * @return null
+     * @return void
      *
      * @expectedException \AppserverIo\Doppelgaenger\Tests\TestLoggerUsedException
      */
     public function testCustomClassProcessing()
     {
-        $testCase = new CustomProcessingTestClass();
-        $testCase->iHaveNoCustomProcessing();
+        $testClass = new CustomProcessingTestClass();
+        $testClass->iHaveNoCustomProcessing();
     }
 
     /**
      * Will test if we can enable custom enforcement processing on method level using the @Processing annotation
      *
-     * @return null
+     * @return void
      *
      * @expectedException \AppserverIo\Psr\MetaobjectProtocol\Dbc\BrokenPostconditionException
      */
     public function testCustomMethodProcessing()
     {
-        $testCase = new CustomProcessingTestClass();
-        $testCase->iHaveACustomExceptionProcessing();
+        $testClass = new CustomProcessingTestClass();
+        $testClass->iHaveACustomExceptionProcessing();
     }
 
     /**
      * Will test if we can enable custom enforcement processing on method level using the @Processing annotation
      * without any annotation within the class doc block
      *
-     * @return null
+     * @return void
      *
      * @expectedException \AppserverIo\Doppelgaenger\Tests\TestLoggerUsedException
      */
     public function testCustomMethodOnlyProcessing1()
     {
-        $testCase = new LocalCustomProcessingTestClass();
-        $testCase->iHaveACustomLoggingProcessing();
+        $testClass = new LocalCustomProcessingTestClass();
+        $testClass->iHaveACustomLoggingProcessing();
     }
 
     /**
      * Will test if we can enable custom enforcement processing on method level using the @Processing annotation
      * without any annotation within the class doc block
      *
-     * @return null
+     * @return void
      *
      * @expectedException \AppserverIo\Psr\MetaobjectProtocol\Dbc\BrokenPostconditionException
      */
     public function testCustomMethodOnlyProcessing2()
     {
-        $testCase = new LocalCustomProcessingTestClass();
-        $testCase->iHaveACustomExceptionProcessing();
+        $testClass = new LocalCustomProcessingTestClass();
+        $testClass->iHaveACustomExceptionProcessing();
+    }
+
+    /**
+     * Tests if we can catch potential endless recursions based on a call like parent::<METHOD_NAME>
+     *
+     * @return void
+     */
+    public function testEndlessRecursionSafety()
+    {
+        $testClass = new RecursionTestClass2();
+        $testClass->iDontWantToBeRecursive();
+
+        $this->assertEquals(1, $testClass->recursionCounter);
     }
 }