Simple SMTP plugin

Simple plugin to use SMTP on any WordPress instance.

Configure

Install and go to settings pages to put your SMTP settings.

Development

Every check is a Composer script:

composer lint  # php -l on every file
composer cs    # PHPCS
composer stan  # PHPStan
composer test  # PHPUnit
composer ci    # all of the above, in this order
composer coverage  # PHPUnit with a coverage report for octocov

Layout and coverage

Every file in src/, and the main plugin file, needs a test named after it. tests/Unit/StructureTest.php enforces this and also fails on a test whose source file no longer exists.

composer coverage writes tests/.coverage/clover.xml. In CI, octocov fails the run when line coverage is below 95% or below the last report of main (.octocov.yml).

Tests

composer install brings in WordPress and the WordPress test suite, so the tests only need a MySQL/MariaDB database they are allowed to wipe on every run.

Variable	Default
WP_TESTS_DB_NAME	wordpress_test
WP_TESTS_DB_USER	root
WP_TESTS_DB_PASSWORD	root
WP_TESTS_DB_HOST	mariadb
WP_TESTS_TABLE_PREFIX	wptests_
WP_CORE_DIR	vendor/wordpress

On the local SaaS stack:

docker exec wordpress-docker-mariadb-1 \
  mariadb -uroot -proot -e 'CREATE DATABASE IF NOT EXISTS wordpress_test;'

docker exec -w /var/www/html/wp-content/plugins/wp-simple-smtp \
  wordpress-docker-wordpress-1 composer test

Browser tests

tests/E2E/WpSimpleSmtp.spec.ts covers the plugin end to end against a Mailpit server that requires SMTP authentication: mail WordPress sends on its own, the test email from the settings page, and a password with a quote that keeps working after the settings are saved again.

They need Docker and Node.js:

npm ci
npx playwright install chromium
npm run env:start    # WordPress on :8889, Mailpit on :8026
npm run test:e2e
npm run env:stop