Setup Unit tests #28

renatonascalves · 2022-08-17T13:57:46Z

Pest will inform the available adapters:

...
Running as single site...
ℹ️  To run multisite, pass WP_MULTISITE=1 or set the WP_TESTS_MULTISITE=1 constant.
----
Elasticsearch is up and running, using version: 7.[17]
-- The SearchPress plugin is available! \o/
-- The VIP Enterprise Search plugin is available! \o/
----

Here is how one can run tests per adapter:

VIP Search Adapter

phpunit --testsuite=vip-search
phpunit --group=vip-search

SearchPress Adapter

phpunit --testsuite=searchpress
phpunit --group=searchpress

Note: the recommendation is to use the --testsuite param since one can forget to add the --group to a new unit test file.

srtfisher

💯

composer.json

srtfisher · 2022-08-19T14:32:43Z

tests/adapters/searchpress/test-searchpress-api.php

+ * @subpackage Tests
+ */
+
+it( 'should load the SP version', function () {


This is so cool to see, very glad you kept at it!

tests/bootstrap.php

Co-authored-by: Sean Fisher <[email protected]>

renatonascalves · 2022-08-19T19:39:39Z

@kevinfodness Could you update the branch settings with the new Github Actions?

kevinfodness · 2022-08-19T20:21:20Z

@renatonascalves branch protection rules have been updated.

renatonascalves · 2022-09-19T20:58:16Z

elasticsearch-extensions.php

@@ -15,6 +15,9 @@
 use Elasticsearch_Extensions\Controller;
 use Elasticsearch_Extensions\Registry;

+// Load Composer dependencies.
+require_once __DIR__ . '/vendor/wordpress-autoload.php';


I'm not sure how people are adding/installing this plugin but I'd assume this change would break their sites (in case they pull directly from GitHub).

How would it break their sites? Because they need to run composer install on it?

It should be installed as a plugin via composer, although it could be submoduled, but in any case, needing to run composer install on it is fine.

Cool! Thanks for the confirmation.

But yes, my concern was a site could be using the plugin without using composer. Pulling the latest would cause a fatal error since the vendor folder would not exist.

If we ever get around to publishing this on WordPress.org we will add a step that installs the vendor folder and includes that in what is sent to the WP.org SVN repo (as well as removing some development files that wouldn't be needed in a production install). But for now it's fine to leave as-is. You might want to add a note in the README about needing to run composer install if that's not there already.

kevinfodness

This looks good to me—thanks for putting this together. I'm sure we'll iterate on it as we get into writing tests, but this is a great starting point and enables us to be able to start writing tests for our adapters. 🍣

kevinfodness · 2022-09-20T14:02:05Z

composer.json

 "wpackagist-plugin/elasticpress": "^4.2",
 "yoast/phpunit-polyfills": "^1.0"
 },
 "scripts": {
 "phpcbf": "phpcbf .",
 "phpcs": "phpcs .",
- "phpunit": "phpunit",
+ "phpunit": "@test",


Don't bother aliasing this, just run composer test. That will need to be updated in the GitHub actions for tests as well, if it isn't already.

kevinfodness · 2022-09-20T14:03:25Z

elasticsearch-extensions.php

@@ -15,6 +15,9 @@
 use Elasticsearch_Extensions\Controller;
 use Elasticsearch_Extensions\Registry;

+// Load Composer dependencies.
+require_once __DIR__ . '/vendor/wordpress-autoload.php';


How would it break their sites? Because they need to run composer install on it?

It should be installed as a plugin via composer, although it could be submoduled, but in any case, needing to run composer install on it is fine.

kevinfodness · 2022-09-20T14:04:09Z

phpunit.xml.dist

+ <directory prefix="test-vip-search" suffix=".php">./tests/adapters/vip-search/</directory>
+ </testsuite>
+
+ <testsuite name="plugin">


I like this - a way to run generic tests and also tests for specific adapters.

kevinfodness · 2022-09-20T14:06:35Z

tests/bootstrap.php

- 'pre_option_upload_path',
- function () {
- return ABSPATH . 'wp-content/uploads';
+define( 'ELASTICSEARCH_EXTENSIONS_TESTS_DIR', dirname( __DIR__ ) . '/tests/' );


This is really just __DIR__. Rather than establishing a separate constant here, I'd rather just use __DIR__ below.

kevinfodness · 2022-09-20T14:06:47Z

tests/bootstrap.php

+Mantle\Testing\manager()
+ ->before( function() {
+ // Define bootstrap helper functions.
+ require_once ELASTICSEARCH_EXTENSIONS_TESTS_DIR . '/includes/bootstrap-functions.php';


Example:

Suggested change

require_once ELASTICSEARCH_EXTENSIONS_TESTS_DIR . '/includes/bootstrap-functions.php';

require_once __DIR__ . '/includes/bootstrap-functions.php';

kevinfodness · 2022-09-21T15:33:53Z

@renatonascalves I merged this because the config for required status checks on other PRs expects the status checks defined here. If you'd like to implement my suggestions from code review, you can do so in a separate PR. Thanks again for putting these tests together!

renatonascalves added 30 commits July 28, 2022 09:32

PHPCS: Moving phpcs cache to its folder

b497fb3

Unit tests: set up and bootstrap tests

0173a9e

Unit tests: git clone plugin

41df17c

Unit tests: Cleaning up

b25997c

Unit tests: test GH action

b551d90

Git: ignoring phpunit cache file

b2823f1

PHPCS: skip tests folder temporarily

940f890

Merge branch 'main' into feature/bootstrap-tests

f15f0a7

GH Action: passing validation

4d87f75

GH Action: passing validation

ab6ed9c

GH Actions: test the adapter

a56e0c8

GH Action: final tweak

571dce8

Unit tests: removing composer.lock

28dac20

Trying to add support for Pest

f9402d2

Unit tests: use the Mantle Testkit

ddd3c1a

Unit tests: load WP

5a1f0ef

Github Actions: readding some PHP extensions

d6ee44d

Unit test: remove hardcoded WP setup

b72dc95

Unit tests: minor tweak

a8433b6

Merging latest from main and resolving conflicts

ece6148

Adding Pest support

688a585

Making GH Action happy

3101981

Making GH happy

407ea8f

Making GH happy

ed847a9

Minor tweak

aaf3420

Run tests on the plugin folder

6d5b4af

Minor change

8839a00

Support php extensions

7a5ae13

Make GH happy

db654fd

Ops

d38cd8c

renatonascalves added 9 commits August 17, 2022 09:41

Test

abc1d5c

Install some dependencies directly

d22dc11

Typo

d61b6a5

Trying a different approach

9552795

Using right path for git

54a2038

Test

50e1a40

Testing the mantle install script

dd1512c

Test

c572611

Adding searchpress

242afaa

renatonascalves self-assigned this Aug 17, 2022

srtfisher approved these changes Aug 19, 2022

View reviewed changes

renatonascalves and others added 3 commits August 19, 2022 16:26

Update composer.json

01e8df6

Co-authored-by: Sean Fisher <[email protected]>

Update composer.json

60f2d41

Co-authored-by: Sean Fisher <[email protected]>

Update tests/bootstrap.php

84c3865

Co-authored-by: Sean Fisher <[email protected]>

renatonascalves commented Sep 19, 2022

View reviewed changes

kevinfodness approved these changes Sep 20, 2022

View reviewed changes

kevinfodness merged commit 7c3f89b into main Sep 21, 2022

kevinfodness deleted the feature/setup-unit-tests branch September 21, 2022 15:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup Unit tests #28

Setup Unit tests #28

renatonascalves commented Aug 17, 2022 •

edited

Loading

srtfisher left a comment

srtfisher Aug 19, 2022

renatonascalves commented Aug 19, 2022

kevinfodness commented Aug 19, 2022

renatonascalves Sep 19, 2022

kevinfodness Sep 20, 2022

renatonascalves Sep 20, 2022

kevinfodness Sep 20, 2022

kevinfodness left a comment

kevinfodness Sep 20, 2022

kevinfodness Sep 20, 2022

kevinfodness Sep 20, 2022

kevinfodness Sep 20, 2022

kevinfodness Sep 20, 2022

kevinfodness commented Sep 21, 2022

	require_once ELASTICSEARCH_EXTENSIONS_TESTS_DIR . '/includes/bootstrap-functions.php';
	require_once __DIR__ . '/includes/bootstrap-functions.php';

Setup Unit tests #28

Setup Unit tests #28

Conversation

renatonascalves commented Aug 17, 2022 • edited Loading

srtfisher left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

renatonascalves commented Aug 19, 2022

kevinfodness commented Aug 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinfodness left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinfodness commented Sep 21, 2022

renatonascalves commented Aug 17, 2022 •

edited

Loading