Pest v2

[davideprevosto]

Hello,

Thank you for sharing this package.

Do you plan to upgrade it and using Pest V2?

Regards

[dingo-d]

Hi!

I was planning to, but the pest v2 requirement is PHP 8.1, so if I'd release v2 it would be limited to PHP 8.1.

I'd have to check out if it would work with my dependencies as intended. Plus WP core itself is not fully compatible with PHP 8.1 yet, so I'm not sure if there would be some underlying issues when running tests.

I'll have to invest some time in testing it out.

[davideprevosto]

If you'd like a beta tester or any help... here I am.

Thank you

[dingo-d]

@davideprevosto I've released v2 alpha version so you can give it a go and report any issues you've found 👍🏼

[davideprevosto]

@dingo-d I am trying to install and use your package.

I run:

vendor/bin/wp-pest setup --help

...and got:

project-type Select whether you want to setup tests for theme or a plugin. Can be "theme" or "plugin"

I understood I can use "theme" or "plugin". I am trying to use your package in one of our plugin, so I run:

vendor/bin/wp-pest setup plugin

I am getting:

[ERROR] Plugin slug must be a string.

Then I understood (I suppose) I have to use:

vendor/bin/wp-pest setup plugin --plugin-slug the-plugin-slug

[dingo-d]

Yeah, it's mentioned in the readme when you run vendor/bin/wp-pest setup --help you'll get

Description:
  Sets up the test suites.

Usage:
  setup [options] [--] <project-type>

Arguments:
  project-type                     Select whether you want to setup tests for theme or a plugin. Can be "theme" or "plugin"

Options:
      --wp-version[=WP-VERSION]    Pass the version of the WordPress you want to test on. [default: "latest"]
      --plugin-slug[=PLUGIN-SLUG]  If you are setting the plugin tests provide the plugin slug.
      --skip-delete                If you are running the setup tests in a CI pipeline, provide this option to skip the deletion step.
  -h, --help                       Display help for the given command. When no command is given display help for the list command
  -q, --quiet                      Do not output any message
  -V, --version                    Display this application version
      --ansi|--no-ansi             Force (or disable --no-ansi) ANSI output
  -n, --no-interaction             Do not ask any interactive question
  -v|vv|vvv, --verbose             Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  This command helps you set up WordPress integration and unit test suites.

I could add which option is required in the help command.

[davideprevosto]

Hello,

I am trying to test one of our custom plugin, using the feature/v2 branch.

The composer.json of our plugin is:

{
    "name": "encodia/name-plugin",
    "type": "wordpress-plugin",
    "license": "proprietary",
    "description": "Description...",
    "authors": [
        {
            "name": "Encodia",
            "email": "info@encodia.it",
            "homepage": "https://www.encodia.it"
        }
    ],
    "autoload": {
        "psr-4": {
            "Encodia\\DigitalQuotation\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tests\\\\": "tests/"
        }
    },
    "minimum-stability": "dev",
    "require": {
        "php": "^8.1",
        "composer/installers": "~2.0",
        "mikehaertl/php-pdftk": "^0.13.0"
    },
    "config": {
        "allow-plugins": {
            "composer/installers": true,
            "pestphp/pest-plugin": true
        }
    },
    "require-dev": {
        "laravel/pint": "^1.10",
        "dingo-d/wp-pest-integration-test-setup": "dev-main"
    },
    "scripts": {
        "lint": "pint",
        "lint:test": "pint --test",
        "test": "vendor/bin/pest"
    }
}

Executing vendor/bin/wp-pest setup plugin --plugin-slug the-plugin-slug I am getting this structure in my plugin project:

Executing vendor/bin/pest I am getting:

❯ vendor/bin/pest
   Pest\Exceptions\TestCaseClassOrTraitNotFound
   The class `Yoast\WPTestUtils\WPIntegration\TestCase` was not found.

Can you put me on the right track? I am missing some basic concepts.

Thank you

[dingo-d]

Hi @davideprevosto, as mentioned in the readme, to run unit tests, you'll need to run:

vendor/bin/pest --group=unit

And in order to run integration tests, you'll need to run

vendor/bin/pest --group=integration

Be careful about the integration tests, as you'll probably have to do some modifications to the test suite in order to run them.

There was also a comment about running integration tests that might help.

[davideprevosto]

I have got the same error even executing:

$ vendor/bin/pest --group=unit

Pest\Exceptions\TestCaseClassOrTraitNotFound
The class `Yoast\WPTestUtils\WPIntegration\TestCase` was not found.

I read the comment and I changed my phpunit.xml as described (can't imagine it, my fault)

<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		 xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
		 bootstrap="vendor/autoload.php"
		 colors="true"
>

...but I am still getting the same error

[dingo-d]

I'll have to investigate this a bit more I didn't get errors about no test case being found when running it 🤔

[davideprevosto]

@dingo-d maybe I am doing something wrong and you're going to waste your time investigating. Sorry about that.
Let me know if I can be helpful in any way.

[dingo-d]

Nah, I need to make sure I didn't miss anything.

Can you share a bit more info about your setup? Like PHP version, Composer version, OS? Maybe give a minimal example so that I can try to recreate the issue.

[davideprevosto]

MacOS 13.6 (22G120)
PHP 8.1.x
Composer version 2.6.3 2023-09-15 09:38:21

composer.json

{
    "name": "encodia/name-plugin",
    "type": "wordpress-plugin",
    "license": "proprietary",
    "description": "Description...",
    "authors": [
        {
            "name": "Encodia",
            "email": "info@encodia.it",
            "homepage": "https://www.encodia.it"
        }
    ],
    "autoload": {
        "psr-4": {
            "Encodia\\DigitalQuotation\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tests\\\\": "tests/"
        }
    },
    "minimum-stability": "dev",
    "require": {
        "php": "^8.1",
        "composer/installers": "~2.0",
        "mikehaertl/php-pdftk": "^0.13.0"
    },
    "config": {
        "allow-plugins": {
            "composer/installers": true,
            "pestphp/pest-plugin": true
        }
    },
    "require-dev": {
        "laravel/pint": "^1.10",
        "dingo-d/wp-pest-integration-test-setup": "dev-main"
    },
    "scripts": {
        "lint": "pint",
        "lint:test": "pint --test",
        "test": "vendor/bin/pest"
    }
}

phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
	<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			 xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
			 bootstrap="vendor/autoload.php"
			 colors="true"
	>
	<testsuites>
		<testsuite name="Unit Test Suite">
			<directory>./tests/Unit/</directory>
		</testsuite>
		<testsuite name="Integration Test Suite">
			<directory>./tests/Integration/</directory>
		</testsuite>
	</testsuites>
	<php>
		<env name="TEST" value="true" force="true" />
		<env name="WP_TESTS_DIR" value="wp/tests/phpunit"/>
		<server name="DB_NAME" value="wp_pest_test_db"/>
		<server name="DB_USER" value="root"/>
		<server name="DB_PASSWORD" value=""/>
		<server name="DB_HOST" value="localhost"/>
	</php>
	<coverage processUncoveredFiles="true">
		<include>
			<directory suffix=".php">./src</directory>
		</include>
		<report>
			<clover outputFile="tests/coverage/clover.xml"/>
			<html outputDirectory="tests/coverage/html" lowUpperBound="50" highLowerBound="90"/>
		</report>
	</coverage>
</phpunit>

vendor/bin/pest --group=unit
Pest\Exceptions\TestCaseClassOrTraitNotFound
The class `Yoast\WPTestUtils\WPIntegration\TestCase` was not found.

[dingo-d]

Since you put the bootstrap="vendor/autoload.php" in your phpunit.xml you should add the

require 'bootstrap.php';

before the use statement in Pest.php file.

I just tried it on my personal project, and I got it to work (both unit and integration tests).

I have these scripts in my composer.json

	...
	"scripts": {
		"test:unit": "@php ./vendor/bin/pest --group=unit",
		"test:integration": "@php ./vendor/bin/pest --group=integration"
	},

I updated the config to this:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
         bootstrap="vendor/autoload.php"
         colors="true"
>
	<testsuites>
		<testsuite name="Unit Test Suite">
			<directory>./tests/Unit/</directory>
		</testsuite>
		<testsuite name="Integration Test Suite">
			<directory>./tests/Integration/</directory>
		</testsuite>
	</testsuites>
	<php>
		<env name="WP_TESTS_DIR" value="wp/tests/phpunit"/>
		<env name="TEST" value="true" force="true"/>
		<server name="DB_NAME" value="wp_pest_test_db"/>
		<server name="DB_USER" value="root"/>
		<server name="DB_PASSWORD" value=""/>
		<server name="DB_HOST" value="localhost"/>
	</php>
	<source>
		<include>
			<directory suffix=".php">./src</directory>
		</include>
	</source>
	<coverage>
		<report>
			<clover outputFile="tests/coverage/clover.xml"/>
			<html outputDirectory="tests/coverage/html" lowUpperBound="50" highLowerBound="90"/>
		</report>
	</coverage>
</phpunit>

[dingo-d]

In your phpunit.xml file replace bootstrap="tests/bootstrap.php" with bootstrap="vendor/autoload.php", and then in your Pest.php file just add require bootstrap.php after opening the PHP tag.

That should solve the issues

[davideprevosto]

@dingo-d thank you for the reminder, unfortunately warnings are still there.

[dingo-d]

Okay, so I've tested my plugin a bit, and this, unfortunately, won't work. At least not for the integration tests for the time being with Pest v2.

The problem is that I didn't update the config correctly for using the correct Integration class (tbh not sure why this worked for me, but I reckon it didn't really work properly).

Once I've made the changes needed, the WordPress test suite started failing, and I forgot that it isn't compatible with PHPUnit 10. I've made a trac ticket about updating it to v10, but I wouldn't hold my breath about when it will be made compatible.

[davideprevosto]

I read your ticket trac, but I am not so confident that they will follow up in a reasonable time.

[dingo-d]

Oh, knowing WordPress, if somebody isn't paid to work on this full-time, this will take a year or two...