framework/main/tests/filter/tests/configuration/classes/class_TestConfigurationLoadableClassesFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Tests\Filter\Configuration\Classes;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filter\Filterable;
   7 use Org\Mxchange\CoreFramework\Request\Requestable;
   8 use Org\Mxchange\CoreFramework\Response\Responseable;
   9 use Org\Mxchange\CoreFramework\Tests\Filter\BaseTestsFilter;
  10
  11 // Import SPL stuff
  12 use \InvalidArgumentException;
  13
  14 /**
  15  * A LoadableClasses filter for tests
  16  *
  17  * @author              Roland Haeder <webmaster@ship-simu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.ship-simu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class TestConfigurationLoadableClassesFilter extends BaseTestsFilter implements Filterable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this filter class
  49          *
  50          * @return      $filterInstance         An instance of this filter class
  51          */
  52         public final static function createTestConfigurationLoadableClassesFilter () {
  53                 // Get a new instance
  54                 $filterInstance = new TestConfigurationLoadableClassesFilter();
  55
  56                 // Return the instance
  57                 return $filterInstance;
  58         }
  59
  60         /**
  61          * Executes the filter with given request and response objects
  62          *
  63          * @param       $requestInstance        An instance of a class with an Requestable interface
  64          * @param       $responseInstance       An instance of a class with an Responseable interface
  65          * @return      void
  66          * @todo        0% done
  67          */
  68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Init counter
  70                 $passed = 0;
  71                 $failed = 0;
  72
  73                 // Loop through all configuration keys
  74                 foreach ($this->getConfigInstance()->getConfigurationArray() as $configKey => $configValue) {
  75                         // Key must end with _class
  76                         if (substr($configKey, -6, 6) != '_class') {
  77                                 // Skip this
  78                                 continue;
  79                         } // END - if
  80
  81                         // Output message
  82                         self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Testing configKey=%s,configValue[%s]=%s', $configKey, gettype($configValue), $configValue));
  83
  84                         // This may throw exceptions
  85                         try {
  86                                 // Is the config entry valid and class is there?
  87                                 if (!is_string($configKey)) {
  88                                         // Is not a string
  89                                         self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('configKey=%s has unexpected type "%s". FAILED', $configKey, gettype($configKey)));
  90
  91                                         // Skip further tests
  92                                         $failed++;
  93                                         continue;
  94                                 } elseif (!class_exists($configValue)) {
  95                                         // Class not found
  96                                         self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Class "%s" not found. FAILED', $configValue));
  97
  98                                         // Skip further tests
  99                                         $failed++;
 100                                         continue;
 101                                 }
 102                         } catch (InvalidArgumentException $e) {
 103                                 // Maybe not conform?
 104                                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Class "%s" failed to load. Message: "%s"', $configValue, $e->getMessage()));
 105
 106                                 // Skip further tests
 107                                 $failed++;
 108                                 continue;
 109                         }
 110
 111                         // class_exists() didn't fail
 112                         self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Class "%s" loaded successfully. OKAY', $configValue));
 113                         $passed++;
 114                 } // END - foreach
 115
 116                 // Output result
 117                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Test result: %d okay, %d failed (%0.02f%% passed)', $passed, $failed, ($passed / ($passed + $failed) * 100)));
 118
 119                 // Implement this!
 120                 $this->partialStub('Please implement this method.');
 121         }
 122
 123 }