lucatume/wp-browser

Changed

• improve psalm, and other static analysis tools compatibility, in the WPLoader module (thanks @calvinalkan).

Fixed

• handle empty numeric values correctly int he WPCLI module, fixes #528.

Fixed

• in the context of the WPLoader module, construct the PHPMailer instance to throw exceptions.
• remove left-over @since TBD tags from doc-blocks.

Fixed

• correctly escape the database name in the WPDb::createDatabasesIfNotExist method.
• first round of PHP 8.1 compatibility updates.

Changed

• rework the build and test flow to leverage make.

Fixed

• Require file defining functions before calling tests_add_filter function in includes/bootstrap.php.

Fixed

• Correctly load SQL from a file in the WPDb::importSqlDumpFile (thanks @andergmartins).

Fixed

• Pass the configured table prefix to the user capability builder in the WPDb module (thanks @johnbillion).
• Trigger an error when plugins in activePlugins cannot be included or activated in the WPLoader module (thanks @johnbillion).

Fixed

• Avoid core installer failures due to mysqli report defaults on PHP 8.1 (thanks @johnbillion).

Changed

• Introduce the skipPluggables configuration parameter in the WPLoader module to avoid the override of pluggable functions (thanks @johnbillion).

Fixed

• Exit non 0 value on wp db connection error during bootstrap.

Fixed

• Update composer.json to specify the package conflicts with version 2.0 of Codeception modules (thanks @simonhammes).

Fixed

• Update Codeception module suggestions to stick with version ^1.0 and PHP 5.6 compatibility.

Fixed

• Normalize env file parsing to support LF line separators on Windows (thanks @kagg-design).

Fixed

Do not require iconv extension when, and use the intl one if available, when building slugs (thanks @roborourke).

Fixed

• do not redefine wp-config constants when using the WPLoaded module in loadOnly: true mode (thanks @LucasDemea)

Fixed

• correct escaping of the PHP binary in the WithWpCli trait (thanks @joppuyo)

Fixed

• update phpass dependency to use stable mirror (thanks @Luc45 and @bordoni)

• add mirror for the phpass dependency, thanks @bordoni, fixes #523

Fixed

• pass the provided parameters to the actions fired in the replacement wp_set_auth_cookie function, fixes #509

Fixed

• WPDb::getOriginalUrlFromSqlString regex to parse original site URL from dump file (thanks @stracker-phil)
• update WPDb module documentation to improve clarity about populate and cleanup configuration parameters (thanks @calvinalkan)

Fixed

• destination file detection in Symlinker extension (thanks @ryanshoover)

Changed

• Update the WPFilesystem::havePlugin and WPFilesystem::haveMuPlugin methods to take a plugin path without requiring the .php extension (thanks @Luc45).

Fixed

• Smaller text fix in Healthcheck component.

Changed

• Add more tests to cover URL replacement in WPDb module.

Fixed

• Parameter format of the WPDb module seeOptionInDatabase, dontSeeOptionInDatabase, seeSiteOptionInDatabase, dontSeeSiteOptionInDatabase methods to support both name and value or array criteria.

Added

• The WPDb::dontSeeSiteOptionInDatabase method.

Fixed

• Yaml format issue in scaffoled configuration files, thanks @dale42

Fixed

• Compatibility with PHPUnit version 9.5, thanks @Luc45

This version is the first to target Composer version 2 compatibility, while keeping back-compatibility with Composer version 1. The version is marked as breaking, and as such as a Major release, as existing setups that rely on some packages previously bundled with wp-browser might break. I've changed the removed wp-cli/wp-cli-bundle (full wp-cli packages) dependency in favor of the wp-cli/wp-cli one and I've removed the symfony/filesystem dependency in favour of other internal solutions. Read the migration guide here.

Breaking changes

• Removed the WithWpCli::executeBackgroundWpCliCommand method, and, as a consequence, the WPCLI::executeBackgroundWpCliCommand method.
• Removed the symfony/process dependency and replaced it with the mikehaertl/php-shellcommand one; refactor methods that use and accept shell commands.
• Refactor the WPCLI module to build and escape string command lines differently.
• Removed the wp-cli/wp-cli-bundle dependency and replaced it with the wp-cli/wp-cli one.

Fixed

• URL replacement issue in DbDump class

Fixed

• handle more Cookie types in WPBrowser::grabCookiesWithPattern method to avoid errors.

Changed

• change DotEnv suggestion to vlucas/phpdotenv:^4.0 to avoid env vars loading issues.

Fixed

• avoid deleting the whole plugins folder when havePlugin is used to create single file plugins (thanks @Luc45)

Added

• the logOut(string|bool $redirectTo) method to the WPBrowser and WPWebDriver modules (thanks @gabe-connolly)

Fixed

• restore full phpstan lvl 8 coverage

Changed

• rename the rmkdir function to mkdirp for clarity and resemblance with the WordPress one.

Fixed

• an issue where the recurseRemoveDir function would leave empty directories behind, fixes #447

Added

• the mkdirp function to scaffold nested directory structures and files

Fixed

• remove version block on symfony/filesystem dependency, fixes #440

Added

• the WPDb::importSql method to allow importing custom SQL strings in the database during tests

Fixed

• avoid deprecation notices when loading MockPHPMailer, fixes #436

Added

• the WPDb::havePostThumbnailInDatabase and WPDb::dontHavePostThumbnailInDatabase methods, fixes #434

Fixed

• URL replacement function in WPDb module that would incorrectly handling the replacement of localhost:port URLs, fixes #430

Fixed

• return type of WPLoader::factory method to ensure IDE type-hinting will work correctly (thanks @Luc45)

Fixed

• typos and spacing in documentation (thanks @cliffordp)
• environment file parsing for empty values, fixes #427

Fixed

• An issue where additional required plugins would not be correctly parsed during the init wpbrowser command, fixes #424

Fixed

• An issue where users created during tests would not be have the correct editing and layout meta set, fixes #422, thanks @ryanshoover

Fixed

• ensure $_SERVER['REQUEST_TIME'] and $_SERVER['REQUEST_TIME_FLOAT'] are correctly set when running tests based on the Codeception\Test\WPTestCase class, fixes #417

Added

• support, in WPTestCase, for the @runInSeparateProcess annotation to run test methods in separate PHP processes; fixes #410

Fixed

• Codeception required version erroneously set in prev version of composer.json file

Added

• check in the codecept init wpbrowser command to check and report missing Codeception 4.0 to the user during initialization, fixes #412

Changed

• refactoring to pass phpstan level 1 and 2 checks.

Fixed

• an issue with .env files handling that, when the vlucas/phpdotenv package is not required, would incorrectly set up the test environment.

Changed

• some refactoring to pass phpstan level 0 checks.

Added

• the WPDb.letCron configuration parameter to control whether wp-cron processes should be allowed to spawn during tests or not (new default).

Fixed

• the WPDb module will set up the database to prevent wp-cron requests from being spawned during tests, fixes #363.
• env file parsing issues reported, fixes #398.

Changed

• following changes to how the WPDb module sets up the database at the start of tests (and between tests), wp-cron process will not be spawned during tests unless the WPDb.letCron configuration parameter is set to true.

Fixed

• added Dotenv\Dotenv polyfill class to avoid back-compatibility issues w/ projects not requiring vlucas/phpdotenv explicitly and using env files for tests configuration.

Fixed

• add function_exists check to avoid redefinition issues when wp-browser is used in two related packages (thanks @cliffordp)

Fixed

• README.md file updates (thanks @szepeviktor)
• src/tad/scripts fixes and refactorings (thanks @szepeviktor)
• cron and admin AJAX query vars handling (thanks @Luc45)

Removed

• gumlet/php-image-resize package requirement; runtime image modification in the WPDb::haveAttachmentInDatabase method will require it at runtime.
• vlucas/phpdotenv package requirement; wp-browser will not use it internally, but Codeception will keep requiring it for dynamic parameter configuration.

Fixed

• initialization environment vars in the Wpbrowser template providing functions for the codecept init wpbrowser command

Fixed

• support for Unix sockets in WPDB and WPLoader modules

Changed

• the codecept init wpbrowser will now scaffold the suites to support both classic MySQL hosts like 1.2.3.4:3306, container-type hosts like db and Unix socket hosts like localhost:/var/mysql.sock

Fixed

• PHP 5.6 incompatibility issues introduced in version 2.4.0, fixes #372

Added

• set the admin_email_lifespan option value to prevent showing the administration email verification in the WPDb module, after the database is imported; fixes #358
• WPDb::EVENT_AFTER_DB_PREPARE action after an imported datababse is prepared by applying quality-of-testing-life " patches" to the database

Added

• clearer messaging for missing Codeception 4.0 modules in wp-browser modules requiring it, fixes #365 and #360