lucatume/wp-browser

4.7.1

Changed

• Refresh the bundled WordPress core PHPUnit test includes and the sqlite-database-integration plugin to their latest upstream versions (#809).

Changed

• Refresh the bundled WordPress core PHPUnit test includes and the sqlite-database-integration plugin to their latest upstream versions (#809).

4.7.0

Added

• dev:rebuild command to build the tests/_wordpress installation used by the default configuration, e.g. on a fresh clone or in CI where it is not committed. Documented the default self-contained setup on GitHub Actions, with an example workflow (#807).
• init wpbrowser records the installed WordPress version in the WORDPRESS_VERSION entry of tests/.env; dev:rebuild reuses it (override with --wp-version) so a rebuilt installation matches the version the committed dump.sql was generated from (#807).
• init wpbrowser (plugin and theme projects) writes a tests/_wordpress/.gitignore so the rebuildable WordPress installation is not committed; restore it with dev:rebuild (#807).
• init wpbrowser (plugin and theme projects) writes a tests/Support/Data/.gitignore with !dump.sql so the database fixture is committed even when a global gitignore excludes *.sql (#807).

Fixed

• init wpbrowser set up the default-configuration admin user with the email [email protected]; it now uses [email protected] (#807).
• MySQL server binary download no longer fails with HTTP 403: dev.mysql.com's CDN started blocking the custom user agent, so the downloader now sends a curl/<version> user agent that is allowed through (#808).

Added

• dev:rebuild command to build the tests/_wordpress installation used by the default configuration, e.g. on a fresh clone or in CI where it is not committed. Documented the default self-contained setup on GitHub Actions, with an example workflow (#807).
• init wpbrowser records the installed WordPress version in the WORDPRESS_VERSION entry of tests/.env; dev:rebuild reuses it (override with --wp-version) so a rebuilt installation matches the version the committed dump.sql was generated from (#807).
• init wpbrowser (plugin and theme projects) writes a tests/_wordpress/.gitignore so the rebuildable WordPress installation is not committed; restore it with dev:rebuild (#807).
• init wpbrowser (plugin and theme projects) writes a tests/Support/Data/.gitignore with !dump.sql so the database fixture is committed even when a global gitignore excludes *.sql (#807).

Fixed

• init wpbrowser set up the default-configuration admin user with the email [email protected]; it now uses [email protected] (#807).
• MySQL server binary download no longer fails with HTTP 403: dev.mysql.com's CDN started blocking the custom user agent, so the downloader now sends a curl/<version> user agent that is allowed through (#808).

4.6.1

Fixed

• wp:db:export from a SQLite installation no longer truncates values containing NUL bytes (e.g. serialized objects with protected/private properties): table rows are read with each column cast to BLOB so the SQLite3 extension does not stop at the first NUL byte, and the full value is hex-encoded into the dump.

Fixed

• wp:db:export from a SQLite installation no longer truncates values containing NUL bytes (e.g. serialized objects with protected/private properties): table rows are read with each column cast to BLOB so the SQLite3 extension does not stop at the first NUL byte, and the full value is hex-encoded into the dump.

4.6.0

Changed

• Replace the bundled lucatume\WPBrowser\Opis\Closure\* library with lucatume\WPBrowser\Utils\Packer and lucatume\WPBrowser\Utils\PackedClosure for closure serialization in the IPC pipeline.

Removed

• Drop the bundled includes/opis/closure/ library and its lucatume\WPBrowser\Opis\Closure\ PSR-4 autoload entry.

Fixed

• wp:db:export from a SQLite installation no longer produces a non-importable dump: values are hex-encoded instead of a char(10) concatenation chain that overflowed SQLite's expression-depth limit on values with many newlines (#802).
• The installer no longer fatals when setting up WordPress 7.0: FileRequest binds the $menu, $submenu and $compat admin-menu globals to the global scope before loading the target file, so WordPress 7.0's admin bootstrap does not run uksort() on a null $menu (#804).

Breaking change

• The lucatume\WPBrowser\Opis\Closure\* namespace is no longer autoloaded. None of its classes were part of the documented public API but the namespace was reachable via PSR-4; any consumer that imported or extended them must migrate to lucatume\WPBrowser\Utils\PackedClosure.
• Consumers using --classmap-authoritative Composer installs must run composer install after upgrading to drop the stale classmap entries.

Changed

• Replace the bundled lucatume\WPBrowser\Opis\Closure\* library with lucatume\WPBrowser\Utils\Packer and lucatume\WPBrowser\Utils\PackedClosure for closure serialization in the IPC pipeline.

Removed

• Drop the bundled includes/opis/closure/ library and its lucatume\WPBrowser\Opis\Closure\ PSR-4 autoload entry.

Fixed

• wp:db:export from a SQLite installation no longer produces a non-importable dump: values are hex-encoded instead of a char(10) concatenation chain that overflowed SQLite's expression-depth limit on values with many newlines (#802).
• The installer no longer fatals when setting up WordPress 7.0: FileRequest binds the $menu, $submenu and $compat admin-menu globals to the global scope before loading the target file, so WordPress 7.0's admin bootstrap does not run uksort() on a null $menu (#804).

Breaking change

• The lucatume\WPBrowser\Opis\Closure\* namespace is no longer autoloaded. None of its classes were part of the documented public API but the namespace was reachable via PSR-4; any consumer that imported or extended them must migrate to lucatume\WPBrowser\Utils\PackedClosure.
• Consumers using --classmap-authoritative Composer installs must run composer install after upgrading to drop the stale classmap entries.

4.5.15

Fixed

• Doc-block of wp:db:import command (thanks @sc0ttkclark).

Fixed

• Doc-block of wp:db:import command (thanks @sc0ttkclark).

4.5.14

Fixed

• StubClassFactory issue where mocking of internal classes would incorrectly detect optional constructor parameters.

Fixed

• StubClassFactory issue where mocking of internal classes would incorrectly detect optional constructor parameters.

Changed

• Update Core PHPUnit test suite to latest version.
• Update SQLite database integration plugin from version 2.2.16 to version 2.2.17

Fixed

• Snapshot resolved config in WPFilesystem::_initialize() to preserve absolute paths across tests when _resetConfig() or _reconfigure() is called.

Changed

• Guard setAccessible() Reflection method calls with a PHP_VERSION_ID check to skip the no-op call on PHP >= 8.1. (thanks @BrianHenryIE)
• Update the WordPress Core PHPUnit suite
• Update the SQLite database integration plugin from version 2.2.14 to version 2.2.16

Fixed

• Wording in the default EndToEnd suite configuration files to reflect the nature of the suite.

Fixed

• Anticipate plugins activation and loading in the WPLoader module to ensure pluggable functions overridden in plugins will correctly apply.

Fixed

• Fixed DB_PASSWORD constant not being defined when dbPassword configuration parameter is set to an empty string in WPLoader module, fixes #786.

Fixed

• Updated activatePlugin and deactivatePlugin methods in WPBrowser and WPWebDriver modules to reload the plugins page after activation.

Fixed

• Updated activatePlugin and deactivatePlugin methods in WPBrowser and WPWebDriver modules to use WordPress 6.5+ compatible selectors.

Changed

• Better WPLoader module output in exceptions (thanks @BrianHenryIE).

Fixed

• Restored support for the allow-root configuration parameter in the WPCLI module.

Fixed

• Extensions event subscription to avoid type issues with newer PHP versions.

Added

• The WPLoader module will now attempt resolving the WP_CONTENT_DIR, WP_PLUGIN_DIR, WPMU_PLUGIN_DIR and pluginsFolder configuration parameters from the Codeception root directory if not possible to resolve them from the current working directory. (thanks @BrianHenryIE)

Fixed

• Correctly serialize and unserialize options in the SQLite database implementation.
• Fix Symlinker extension issue where the target link path would be built incorrectly.

Changed

• Support symfony/process and symfony/filesystem version >=7.0.
• Set PHPUnit supported version to <=12.0.0.

Fixed

• Avoid duplicated definition issue in GenerateWPUnit command.
• Update MySQL server class download URLs

Fixed

• Ensure plugin activation is respected indifferent of plugins that might deactivate others during activation.

Added

• Support for PHP 8.4. (thanks @kagg-design)

Fixed

• Check the PID file for the PHP built-in server, MySQL and Chromedriver controllers to make sure the PID maps to an actually running process.

Added

• Support custom binaries for WP-CLI in the WPCLI module.

Fixed

• In WPDb module look up the WPFilesystem module with and without leading slash.

Fixed

• Fallback for missing $_composer_autoload_path file. (thanks @andronocean)

Changed

• Improve LoadSandbox error and messaging (used by the WPLoader module when loadOnly: true) around Codeception early exits. (thanks @andronocean)

Fixed

• Set proper WPTetCase::factory() return type, so IDE autocompletion works (thanks @defunctl).

Fixed

• Ensure the WPLoader module will set the db constants when in loadOnly: true mode.
• The WPLoader module will now set the WPBROWSER_LOAD_ONLY environment variable to 1 when in loadOnly: true and to 0 when in loadOnly: false mode.
• Updated documentation for the WPLoader module to explicitly state that the configFlile parameter will be used both when in loadOnly: true and loadOnly: false modes.

Fixed

• Doc-block namespace in the WPRestApiTestCase class, thanks @TimothyBJacobs.

Fixed

• mysql command output in the MysqlServerController information output.

Added

• Support for PHPUnit 10 and 11.
• The MysqlServerController extension.

Fixed

• Ensure the WPLoader module will initialize correctly when used in loadOnly mode not using the EventDispatcherBridge extension. (thanks @lxbdr)
• Support loading the wpdb class from either the class-wpdb.php file or the wp-db.php one, supporting older versions of WordPress (thanks @BrianHenryIE)
• Read content, plugins and mu-plugins directories paths from the WPLoader configuration parameters correctly.
• In the WPTestCase class, remove attachments created during tests between tests.

Changed

• Updated documentation entry in EndToEnd suite bootstrap file.

Added

• Re-added the Symlinker extension to allow for the symlinking of plugins and themes in place during tests.
• Update setup to use the Symlinker extension.

Fixed

• Disable strict connection ID check for SQLite databases to avoid errors in tests.

Changed

• Better messaging when throwing due to disconnected database.
• Add the WPLoader::beStrictAboutWpdbConnectionId configuration parameter, defaults to true, to throw if db connection changes during setup before class.

Fixed

• Throw on disconnected db in WPTestCase::setUpBeforeClass, iterates over the fix for #720.

Added

• Allow plugins to be loaded from arbitrary absolute or relative paths in the WPLoader module.
• Allow themes to be loaded from arbitrary absolute or relative paths in the WPLoader module.
• Support an array argument for the theme configuration parameter in the WPLoader module to define [parent-theme, child-theme] pairs.

Fixed

• Avoid calling wpdb::db_connect() twice during WPLoader bootstrap. (thanks @calvinalkan)

Changed

• Updated sqlite-integration-plugin and Core PHPUnit suite files.

Changed

• Fix non standard installation handling, hello Bedrock! (#716)

Changed

• Load WordPress at SUITE_BEFORE in the WPLoader module, I had previously changed this to SUITE_INIT but that was causing issues.
• Update Core PHPUnit tests
• Update SQLite plugin.

Changed

• Update init template to scaffold dump file path and example tests correctly (thanks @tarecord).

Added

• The AirplaneMode module, based on the norcross/airplane-mode plugin, to put the website under test in "airplane mode", preventing it from making any network requests during tests.

Added

• lucatume\WPBrowser\Traits\UopzFunctions trait to provide a set of functions to work with the uopz extension; see the documentation for more details.

Changed

• Disable MU update routine in CLI router to speed up test execution.

Changed

• Replace ifsnop/mysqldump-php with druidfi/mysqldump-php for better performance (thanks @staabm).

Changed

• The WPTestCase class will not backup globals and static attributes by default. Version 3 of wp-browser did not backup globals and static attributes by default, this change in version 4 is aligned with that behaviour to ease migration from version 3 to version 4.

Added

• Restored support for the @runInSeparateProcess annotation for test methods. Along with it, improved support for the @dataProvider annotation for test methods used in conjunction with the @runInSeparateProcess annotation to run data provider methods at most once.
• Implemented support for the runTestsInSeparateProcesses annotation for test classes; supporting the @dataProvider annotation ro run data provider methods at most once.
• Added support for the #[RunInSeparateProcess] attribute for test methods and the #[RunTestsInSeparateProcesses] attribute for test classes.
• Migration guide from version 3 to version 3.5 or 4

Fixed

• Search more paths for Chrome binaries on linux (#694, thanks to @iateadonut)

Changed

• List paths searched for Chrome on current platform in debug output

Added

• Print file and line of failure during setup of plugin project, (#694, thanks to @iateadonut)

Fixed

• PHPUnit version 10+ warnings (#692)

Changed

• Updated Core PHPUnit test code from wordpress/wordpress-develop.
• Update SQLite plugin from sqlite-database-integration plugin.

• Improve messaging and documentation around initialization and setup.

Fixed

• Improve router script to speed up localhost server.

Changed

• Update the Core PHPUnit test suite to the latest version.

Added

• The WPLoader::silentlyActivatePlugins configuration parameter to activate plugins without firing the activated_plugin action.

Added

• The WPLoader::skipInstall configuration parameter to skip the WordPress installation when already installed.

Changed

• Updated Core PHPUnit test suite
• Updated SQLite plugin from version 2.1.1 to 2.1.2

Added

• Added the backupGlobals, backupGlobalsExcludeList, backupStaticAttributes, backupStaticAttributesExcludeList to the WPLoader module configuration file to provide a sweeping control over the state snapshot of test cases extending the WPTestCase class. Test cases overriding those properties explicitly will have their values respected.