Downloaded 24 times
![ModuleManager::module_in
stall
/**
* Includes file with module installation class.
*
* Do not use directly.
*
* @param string $module_class_name module class name - underscore separated
*/
public static final function include_install($module_class_name) {
if(isset(self::$modules_install[$module_class_name])) return true;
$path = self::get_module_dir_path($module_class_name);
$file = self::get_module_file_name($module_class_name);
$full_path = 'modules/' . $path . '/' . $file . 'Install.php';
if (!file_exists($full_path)) return false;
ob_start();
$ret = require_once($full_path);
ob_end_clean();
$x = $module_class_name.'Install';
if(!(class_exists($x, false)) ||
!array_key_exists('ModuleInstall',class_parents($x)))
trigger_error('Module '.$path.': Invalid install file',E_USER_ERROR);
self::$modules_install[$module_class_name] = new $x($module_class_name);
return true;
}](https://image.slidesharecdn.com/yourcodearemytests-150207112956-conversion-gate01/75/Your-code-are-my-tests-38-2048.jpg)
![Testing first condition
<?php
require_once 'include.php';
class ModuleManagerTest extends PHPUnit_Framework_TestCase
{
protected function tearDown()
{
ModuleManager::$modules_install = array ();
}
public function testReturnImmediatelyWhenModuleAlreadyLoaded()
{
$module = 'Foo_Bar';
ModuleManager::$modules_install[$module] = 1;
$result = ModuleManager::include_install($module);
$this->assertTrue($result,
'Expecting that an already installed module returns true');
$this->assertCount(1, ModuleManager::$modules_install,
'Expecting to find 1 module ready for installation');
}
}](https://image.slidesharecdn.com/yourcodearemytests-150207112956-conversion-gate01/75/Your-code-are-my-tests-39-2048.jpg)
![Let’s use the static
$params = array (
'moduleName' => 'Foo_Bar',
'minVersion' => 0,
'maxVersion' => 1,
'maxOk' => true,
);
// We use a static method for this test
$dependency = Dependency::requires_range(
$params['moduleName'],
$params['minVersion'],
$params['maxVersion'],
$params['maxOk']
);
// We use reflection to see if properties are set correctly
$reflectionClass = new ReflectionClass('Dependency');](https://image.slidesharecdn.com/yourcodearemytests-150207112956-conversion-gate01/75/Your-code-are-my-tests-60-2048.jpg)
![Use the reflection to assert
// Let's retrieve the private properties
$moduleName = $reflectionClass->getProperty('module_name');
$moduleName->setAccessible(true);
$minVersion = $reflectionClass->getProperty('version_min');
$minVersion->setAccessible(true);
$maxVersion = $reflectionClass->getProperty('version_max');
$maxVersion->setAccessible(true);
$maxOk = $reflectionClass->getProperty('compare_max');
$maxOk->setAccessible(true);
// Let's assert
$this->assertEquals($params['moduleName'], $moduleName->getValue($dependency),
'Expected value does not match the value set’);
$this->assertEquals($params['minVersion'], $minVersion->getValue($dependency),
'Expected value does not match the value set’);
$this->assertEquals($params['maxVersion'], $maxVersion->getValue($dependency),
'Expected value does not match the value set’);
$this->assertEquals('<=', $maxOk->getValue($dependency),
'Expected value does not match the value set');](https://image.slidesharecdn.com/yourcodearemytests-150207112956-conversion-gate01/75/Your-code-are-my-tests-61-2048.jpg)
Uploaded byMichelangelo van Dam
Your code are my tests
The document discusses best practices for testing legacy PHP code, emphasizing the importance of writing tests, documentation, and fixing bugs. It introduces PHPUnit as a testing framework, detailing its functionalities and providing examples of how to implement tests. Additionally, it highlights common excuses for not testing and encourages developers to take responsibility for code quality through consistent testing efforts.
More Related Content
Your code are my tests
- 1. Your code are mytests How to test legacy code in it2PROFESSIONAL PHP SERVICES
- 2. ADVISORY IN ORDER TOEXPLAIN CERTAIN SITUATIONS YOU MIGHT FACE IN YOUR DEVELOPMENT CAREER, WE WILL BE DISCUSSING THE USAGE OF PRIVATES AND PUBLIC EXPOSURE. IF THESE TOPICS OFFEND OR UPSET YOU, WE WOULD LIKE TO ASK YOU TO LEAVE THIS ROOM NOW. THE SPEAKER NOR THE ORGANISATION CANNOT BE HELD ACCOUNTABLE FOR MENTAL DISTRESS OR ANY FORMS OF DAMAGE YOU MIGHT ENDURE DURING OR AFTER THIS PRESENTATION. FOR COMPLAINTS PLEASE INFORM ORGANISATION AT INFO@IN2IT.BE.
- 3. Michelangelo van Dam PHPConsultant Community Leader President of PHPBenelux Contributor to PHP projects T @DragonBe | F DragonBe https://www.flickr.com/photos/akrabat/8784318813
- 4. Using Social Media? Tagit #mytests http://www.flickr.com/photos/andyofne/4633356197 http://www.flickr.com/photos/andyofne/4633356197
- 5. Why bother withtesting? https://www.flickr.com/photos/vialbost/5533266530
- 6. Most common excuses whydevelopers don’t test • no time • no budget • deliver tests after finish project (never) • devs don’t know how https://www.flickr.com/photos/dasprid/8147986307
- 7. No excuses!!! Crea%ve Commons -‐ h.p://www.flickr.com/photos/akrabat/8421560178
- 8. Responsibility issue • Asa developer, it’s your job to • write code & fixing bugs • add documentation • write & update unit tests
- 9. Pizza principleTopping: your tests Box: your documenta%on Dough: your code
- 10. Benefits of testing •Direct feedback (test fails) • Once a test is made, it will always be tested • Easy to refactor existing code (protection) • Easy to debug: write a test to see if a bug is genuine • Higher confidence and less uncertainty
- 11. Rule of thumb “Wheneveryou are tempted to type something into a print statement or a debugger expression, write it as a test instead.” — Source: Martin Fowler
- 12.
- 13. PHPUnit • PHPUnit isa port of xUnit testing framework • Created by “Sebastian Bergmann” • Uses “assertions” to verify behaviour of “unit of code” • Open source and hosted on GitHub • See https://github.com/sebastianbergmann/phpunit • Can be installed using: • PEAR • PHAR • Composer
- 14. Approach for testing •Instantiate a “unit-of-code” • Assert expected result against actual result • Provide a custom error message
- 15. Available assertions • assertArrayHasKey() •assertClassHasAttribute() • assertClassHasStaticAttribute() • assertContains() • assertContainsOnly() • assertContainsOnlyInstancesOf() • assertCount() • assertEmpty() • assertEqualXMLStructure() • assertEquals() • assertFalse() • assertFileEquals() • assertFileExists() • assertGreaterThan() • assertGreaterThanOrEqual() • assertInstanceOf() • assertInternalType() • assertJsonFileEqualsJsonFile() • assertJsonStringEqualsJsonFile() • assertJsonStringEqualsJsonString() • assertLessThan() • assertLessThanOrEqual() • assertNull() • assertObjectHasAttribute() • assertRegExp() • assertStringMatchesFormat() • assertStringMatchesFormatFile() • assertSame() • assertSelectCount() • assertSelectEquals() • assertSelectRegExp() • assertStringEndsWith() • assertStringEqualsFile() • assertStringStartsWith() • assertTag() • assertThat() • assertTrue() • assertXmlFileEqualsXmlFile() • assertXmlStringEqualsXmlFile() • assertXmlStringEqualsXmlString()
- 16. To protect and to serve
- 17. Data is tainted,ALWAYS Hackers BAD DATA Web Services Stupid users
- 20. OWASP top 10exploits https://www.owasp.org/index.php/Top_10_2013-Top_10
- 21.
- 22. Smallest unit ofcode https://www.flickr.com/photos/toolstop/4546017269
- 23.
- 24. Testing for good /**... */ public function testClassAcceptsValidRequiredArgument() { $expected = $argument = 'Testing PHP Class'; $myClass = new MyClass; $result = $myClass->doSomething($argument); $this->assertSame($expected, $result, 'Expected result differs from actual result'); } /** ... */ public function testClassAcceptsValidOptionalArgument() { $requiredArgument = 'Testing PHP Class'; $optionalArgument = 'Is this not fun?!?'; $expected = $requiredArgument . ' - ' . $optionalArgument; $myClass = new MyClass; $result = $myClass->doSomething($requiredArgument, $optionalArgument); $this->assertSame($expected, $result, 'Expected result differs from actual result'); }
- 25.
- 26. Example: testing payments <?php namespace MyappCommonPayment; class ProcessTest extends PHPUnit_Framework_TestCase { public function testPaymentIsProcessedCorrectly() { $customer = new Customer(/* data for customer */); $transaction = new Transaction(/* data for transaction */); $process = new Process('sale', $customer, $transaction); $process-‐>pay(); $this-‐>assertTrue($process-‐>paymentApproved()); $this-‐>assertEquals('PAY-‐17S8410768582940NKEE66EQ', $process-‐ >getPaymentId()); } }
- 27. We don’t livein a fairy tale! https://www.flickr.com/photos/bertknot/8175214909
- 28. Real code, realapps
- 29.
- 30.
- 31. Where are theTESTS?
- 32. Where are theTESTS?
- 33. Oh noes, notests! https://www.flickr.com/photos/mjhagen/2973212926
- 34.
- 35. How to getabout it?
- 36. Setting up fortesting <phpunit colors="true" stopOnError="true" stopOnFailure="true"> <testsuites> <testsuite name="EPESI admin tests"> <directory phpVersion="5.3.0">tests/admin</directory> </testsuite> <testsuite name="EPESI include tests"> <directory phpVersion="5.3.0">tests/include</directory> </testsuite> <testsuite name="EPESI modules testsuite"> <directory phpVersion="5.3.0">tests/modules</directory> </testsuite> </testsuites> <php> <const name="DEBUG_AUTOLOADS" value="1"/> <const name="CID" value="1234567890123456789"/> </php> <logging> <log type="coverage-html" target="build/coverage" charset="UTF-8"/> <log type="coverage-clover" target="build/logs/clover.xml"/> <log type="junit" target="build/logs/junit.xml"/> </logging> </phpunit>
- 37. ModuleManager • not_loaded_modules • loaded_modules •modules • modules_install • modules_common • root • processing • processed_modules • include_install • include_common • include_main • create_load_priority_array • check_dependencies • satisfy_dependencies • get_module_dir_path • get_module_file_name • list_modules • exists • register • unregister • is_installed • upgrade • downgrade • get_module_class_name • install • uninstall • get_processed_modules • get_load_priority_array • new_instance • get_instance • create_data_dir • remove_data_dir • get_data_dir • load_modules • create_common_cache • create_root • check_access • call_common_methods • check_common_methods • required_modules • reset_cron
- 38.
- 39.
- 40.
- 41.
- 42. Test for secondcondition public function testLoadingNonExistingModuleIsNotExecuted() { $module = 'Foo_Bar'; $result = ModuleManager::include_install($module); $this- >assertFalse($result, 'Expecting failure for loading Foo_Bar'); $this->assertEmpty(ModuleManager::$modules_install, 'Expecting to find no modules ready for installation'); }
- 43.
- 44.
- 45. Test for thirdcondition public function testNoInstallationOfModuleWithoutInstallationClass( ) { $module = 'EssClient_IClient'; $result = ModuleManager::include_install($module); $this- >assertFalse($result, 'Expecting failure for loading Foo_Bar'); $this->assertEmpty(ModuleManager::$modules_install, 'Expecting to find no modules ready for installation'); }
- 46.
- 47.
- 48.
- 49.
- 50.
- 51.
- 52. Look at theglobal coverage
- 53.
- 54.
- 55. Dependency • __construct • get_module_name •get_version_min • get_version_max • is_satisfied_by • requires • requires_exact • requires_at_least • requires_range
- 56.
- 57. Don’t touch myjunk! https://www.flickr.com/photos/caseymultimedia/5412293730
- 58.
- 59.
- 60. Let’s use thestatic $params = array ( 'moduleName' => 'Foo_Bar', 'minVersion' => 0, 'maxVersion' => 1, 'maxOk' => true, ); // We use a static method for this test $dependency = Dependency::requires_range( $params['moduleName'], $params['minVersion'], $params['maxVersion'], $params['maxOk'] ); // We use reflection to see if properties are set correctly $reflectionClass = new ReflectionClass('Dependency');
- 61. Use the reflectionto assert // Let's retrieve the private properties $moduleName = $reflectionClass->getProperty('module_name'); $moduleName->setAccessible(true); $minVersion = $reflectionClass->getProperty('version_min'); $minVersion->setAccessible(true); $maxVersion = $reflectionClass->getProperty('version_max'); $maxVersion->setAccessible(true); $maxOk = $reflectionClass->getProperty('compare_max'); $maxOk->setAccessible(true); // Let's assert $this->assertEquals($params['moduleName'], $moduleName->getValue($dependency), 'Expected value does not match the value set’); $this->assertEquals($params['minVersion'], $minVersion->getValue($dependency), 'Expected value does not match the value set’); $this->assertEquals($params['maxVersion'], $maxVersion->getValue($dependency), 'Expected value does not match the value set’); $this->assertEquals('<=', $maxOk->getValue($dependency), 'Expected value does not match the value set');
- 62.
- 63.
- 64.
- 65. Unit testing isnot difficult!
- 66.
- 67. PHP has allthe tools
- 68. And there aremore roads to Rome
- 69.
- 70.
- 71.
- 72. Contact us in it2PROFESSIONALPHP SERVICES Michelangelo van Dam michelangelo@in2it.be www.in2it.be PHP Consulting - Training - QA
- 73. cfp.phpbenelux.eu Submit your proposalsbefore October 14, 2015
- 74. Thank you Have agreat conference http://www.flickr.com/photos/drewm/3191872515