Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/tests/Tools/CodeHacking/CodeHackerTestHook.php

33 lines
678 B
PHP
Raw Normal View History

Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
<?php
Fix code sniffer errors in CodeHacker and related classes.
2020-04-16 13:03:15 +00:00
/**
* CodeHackerTestHook class file.
*
Fixed package tag usage
2020-08-05 16:36:24 +00:00
* @package WooCommerce\Testing
Fix code sniffer errors in CodeHacker and related classes.
2020-04-16 13:03:15 +00:00
*/
Move testing tools to the tests/Tools directory The testing tools (only the code hacker at this time) have been moved from 'src' to 'tests/Tools', since many opcode cache plugins load the whole src folder in production. Also, an extra autoloader is set in the tests bootstrap so that the 'tests/Tools' directory corresponds, using PSR4, to the 'Automattic\WooCommerce\Testing\Tools' namespace.
2020-05-18 09:31:59 +00:00
namespace Automattic\WooCommerce\Testing\Tools\CodeHacking;
All code hacking files moved to src\Testing folder.
2020-04-13 07:32:19 +00:00
Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
use PHPUnit\Runner\BeforeTestHook;
/**
Code hacker resdesign for single-load of code files. The code hacker as originally designed, as a mechanism that allowed to enable hacks at the individual test level, is flawed because it assumes that code files are loaded before each test, but actually the PHP engine loads code files only once. Therefore this commit redesigns it so that the two existing main hacks, the functions mocker and the static methods hacker, are applied to all the relevant functions and classes at bootstrap time, and mocks for each individual function/method can be registered at the beginning of each test. See README for the full details.
2020-06-02 08:08:24 +00:00
* Helper to use the CodeHacker class in PHPUnit. To use, add this to phpunit.xml:
Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
*
* <extensions>
All code hacking files moved to src\Testing folder.
2020-04-13 07:32:19 +00:00
* <extension class="CodeHackerTestHook" />
Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
* </extensions>
*/
Code hacker resdesign for single-load of code files. The code hacker as originally designed, as a mechanism that allowed to enable hacks at the individual test level, is flawed because it assumes that code files are loaded before each test, but actually the PHP engine loads code files only once. Therefore this commit redesigns it so that the two existing main hacks, the functions mocker and the static methods hacker, are applied to all the relevant functions and classes at bootstrap time, and mocks for each individual function/method can be registered at the beginning of each test. See README for the full details.
2020-06-02 08:08:24 +00:00
final class CodeHackerTestHook implements BeforeTestHook {
Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
Small improvements in the code hacker - Convert a hardcoded number to a constant - Add more information to an exception message - Remove unnecessary PHPCS disabling - Throw exception on PHP<7.0
2020-05-18 08:07:20 +00:00
/**
* Runs before each test.
*
* @param string $test "TestClass::TestMethod".
*
* @throws \ReflectionException Thrown by execute_before_methods.
*/
Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
public function executeBeforeTest( string $test ): void {
Code hacker resdesign for single-load of code files. The code hacker as originally designed, as a mechanism that allowed to enable hacks at the individual test level, is flawed because it assumes that code files are loaded before each test, but actually the PHP engine loads code files only once. Therefore this commit redesigns it so that the two existing main hacks, the functions mocker and the static methods hacker, are applied to all the relevant functions and classes at bootstrap time, and mocks for each individual function/method can be registered at the beginning of each test. See README for the full details.
2020-06-02 08:08:24 +00:00
CodeHacker::reset_hacks();
Barebones implementation of a code hacker for unit tests. The "code hacker" is a class that hooks on filesystem events (using stream_wrapper_unregister) in order to allow for dynamically modifying the content of PHP code files while they are loaded. The code hacker class allows registering hacks, which are functions that take source code as input and return the modified code. A hack can be a standalone function or a class with a "hack" method. A few hacks are provided off the shelf. One allows mocking standalone PHP functions (WP, WOO or not), another one allows mocking static methods, and there's the one that removes the "final" qualifier from a class definition. This helps unit testing stuff that would otherwise be quite hard to test.
2020-04-09 14:32:40 +00:00
}
}
Fix code sniffer errors in CodeHacker and related classes.
2020-04-16 13:03:15 +00:00