Forem: Elie Hanna

How to Run PHPUnit in a WordPress Plugin on Windows Using LocalWP

Elie Hanna — Thu, 28 Jul 2022 00:03:31 +0000

Requirements
Select Git Bash as the default terminal
Create a new WordPress plugin
Installing WP tests
Install PHPUnit
Install PHPUnit Polyfills
Change the Temp directory
Running our first test

Requirements

Install Local
Install Git Bash for Windows

Select Git Bash as the default terminal

Once Local is installed, click on the hamburger menu on the top left then click on preferences.

Under default apps, make sure that Git Bash is selected as the terminal app.

If you can't select Git Bash, make sure that Git Bash for Windows is installed in this location C:\Program Files\Git

Create a new WordPress plugin

If you do not have a LocalWP site already, you can create one by clicking on the bottom left button in Local and go through the setup wizard, when you are done, you should be taken to your Local WP site dashboard that looks like this:

Now, open the site terminal by clicking on Open Site Shell

Run wp scaffold plugin sample-plugin to create a plugin, this will also add the test files that we need.

Note that if you wish to add the test files to an existing plugin you should run wp scaffold plugin-tests sample-plugin instead.

The file structure of our generated plugin sample-plugin should look like this:

Installing WP tests

Let's dive into our plugin directory with cd wp-content/plugins/sample-plugin and run the install-wp-tests.sh <db-name> <db-user> <db-pass> [db-host] like this:

bin/install-wp-tests.sh wp_tests root root localhost

db-name: this is our test database name that will be used to run tests, it could be anything as long as it's not our site's database name.

db-user, db-pass, db-host: are the values shown in your Local site Database tab:

If this installation ran correctly, you shouldn't see any errors in the Git Bash terminal and you should see two new folders in your %TEMP% directory wordpress and wordpress-tests-lib.

More about the %TEMP% directory below.

You should also see our created wp-tests database if you run:

mysql
show databases;

Install PHPUnit

We are going to install PHPUnit using Composer, LocalWP should come with Composer installed, to install PHPUnit run:

composer require --dev phpunit/phpunit

Install PHPUnit Polyfills

PHPUnit Polyfills are required to create PHPUnit tests in WordPress.

To install them, Run:

composer require --dev yoast/phpunit-polyfills

Change the Temp directory

If you were to run vendor/bin/phpunit now, you would get some errors on the console missing files in directories. This is only an issue on Windows. To fix this open the wordpress-tests-lib/wp-tests-config.php in your Temp directory and edit the constant ABSPATH on line 4 and prepend your %TEMP% directory.

You can find the location of your Temp folder by typing echo %TEMP% on the Windows Terminal:

My Temp folder path is C:\Users\Elie\AppData\Local\Temp so my ABSPATH looks like this:

define( 'ABSPATH', 'C:\Users\Elie\AppData\Local\Temp/wordpress/' );

Running our first test

Our plugin comes with a sample test in tests/test-sample.php, to enable it open phpunit.xml and comment out the line that has the <exclude> tags:

On your Git Bash terminal, run:

vendor/bin/phpunit

You should see OK (1 test, 1 assertion) that means that the sample test was tested successfully!

Setup a Local WordPress Development Environment with Docker that packs WP-CLI and Xdebug

Elie Hanna — Sun, 21 Nov 2021 14:15:16 +0000

WordPress Docker Dev Environment

This post aims to help WordPress developers quickly bootstrap a WordPress Docker development environment with WP-CLI, PHPMyAdmin and Xdebug.

Container Features

Auto install WordPress
PHPMyAdmin
Xdebug
WP-CLI

Prerequisites

Install Docker Desktop
Xdebug

Installation

Clone this repo https://github.com/eliehanna0/WordPress-Docker-Dev-Environment :

git clone https://github.com/eliehanna0/WordPress-Docker-Dev-Environment.git

Let's build and start our docker container, In the root folder of the project, run:

docker-compose up --build

You might have to wait a minute or two the first time you run this for the wordpress image to copy the necessary files.

Meanwhile, the wordpress-installer image waits until WordPress files are ready before automatically installing it.

You will know your installation is complete when you see this message:

That's it, browse to http://localhost/ to check your installed WordPress website, for PHPMyAdmin, go to http://localhost:8080/

Using WP-CLI

There are two ways to run WP-CLI commands in this Docker container.

Using docker-compose exec:

docker-compose exec wordpress wp post list

Or my preferred way, SHH into the container like so:

docker exec -it wordpress /bin/bash

Then run whatever WP-CLI command for instance wp post list

by the way, use exit to return to your terminal from bash

Debugging with PHPStorm

Let us setup PHPStorm to listen to incoming Xdebug connections from our docker container.

Setup Xdebug in PHPStorm

Go to Settings > Languages & Frameworks > PHP > Debug

We are using port 9003 as configured in our xdebug.ini file

Mapping The Server

Navigate to Settings > Languages & Frameworks > PHP > Servers

Add a new server, I named mine WP Docker
Host is localhost port 80
Debugger is Xdebug
Make sure Use path mappings.... is checked ✔️
Map the created wordpress folder to /var/www/html (this folder should have been created by the docker container)
Click OK to save your settings

This is how your settings should look:

Debug Configuration

Go to Run > Edit Configurations...

Add a new configuration and select PHP Remote Debug
Give it a name, mine is WP Docker
Select the server we just created WP Docker
Type an IDE key PHPSTORM (any value will do since we are not filtering by IDE key in our xdebug.ini)
Save your settings

Let us test Xdebug!

I am going to create a breakpoint in an already installed plugin wordpress/wp-content/plugins/hello.php on line 54

On the top right toolbar of PHPStorm, select WP Docker as our configuration and click on Start listetning for PHP debug connections:

Navigate to http://localhost/wp-admin/plugins.php and activate Hello Dolly to see our debugger in action:

To stop listening to Xdebug connections click on the same button:

Roadmap

Integrate Unit tests
Add PHPCS

Contribution

Yes please! https://github.com/eliehanna0/WordPress-Docker-Dev-Environment

Thank You!

Feel free to ask me any questions or offer any suggestions!