Testing

{
	"require-dev": {
		"brain/monkey": "^2.7", "php-stubs/wordpress-tests-stubs": "^7.1",
		"phpunit/phpunit": "^9.6", "yoast/phpunit-polyfills": "^4.0"
	},
	"autoload-dev": { "psr-4": { "Lumen\\Catalog\\Tests\\": "tests/" } },
	"config": { "platform": { "php": "7.4.0" } },
	"scripts": { "test": "phpunit" }
}

<?php
// tests/Unit/TestCase.php: base class of the unit suite.
namespace Lumen\Catalog\Tests\Unit;

use Brain\Monkey;
use Brain\Monkey\Functions;
use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
use Yoast\PHPUnitPolyfills\TestCases\TestCase as PolyfillTestCase;

abstract class TestCase extends PolyfillTestCase {

	use MockeryPHPUnitIntegration;

	protected function set_up(): void {
		parent::set_up();
		Monkey\setUp();
		Functions\stubTranslationFunctions();
		Functions\stubEscapeFunctions();
	}

	protected function tear_down(): void {
		Monkey\tearDown();
		parent::tear_down();
	}
}

<?php
// tests/Unit/MetaTest.php: no WordPress, no database.
namespace Lumen\Catalog\Tests\Unit;

use Brain\Monkey\Actions;
use Brain\Monkey\Functions;
use Lumen\Catalog\Meta;
use Lumen\Catalog\Plugin;

/** @covers \Lumen\Catalog\Meta */
final class MetaTest extends TestCase {

	protected function set_up(): void {
		parent::set_up();
		Functions\when( 'sanitize_text_field' )->alias( 'trim' );
	}

	/**
	 * @dataProvider isbn_provider
	 */
	public function test_sanitize_isbn( string $input, string $expected ): void {
		$this->assertSame( $expected, Meta::sanitize_isbn( $input ) );
	}

	public function isbn_provider(): array {
		return array(
			'valid, hyphenated'  => array( '978-1-23456-789-7', '978-1-23456-789-7' ),
			'surrounding spaces' => array( '  978-1-23456-789-7 ', '978-1-23456-789-7' ),
			'not hyphenated'     => array( '9781234567897', '' ),
			'ISBN-10'            => array( '1-23456-789-X', '' ),
		);
	}

	public function test_only_catalogue_editors_may_set_an_isbn(): void {
		Functions\expect( 'user_can' )->once()->with( 3, 'edit_others_lp_books' )->andReturn( false );
		$this->assertFalse( Meta::can_edit_isbn( true, 'lp_isbn', 12, 3 ) );
	}

	public function test_boot_hooks_meta_registration_to_init(): void {
		Actions\expectAdded( 'rest_api_init' )->once();
		Plugin::boot();
		$this->assertSame( 10, has_action( 'init', array( Meta::class, 'register' ) ) );
	}
}

$ docker run --rm -v "$PWD":/app -w /app php:7.4-cli vendor/bin/phpunit --testdox
PHPUnit 9.6.38 by Sebastian Bergmann and contributors.

Meta (Lumen\Catalog\Tests\Unit\Meta)
 ✔ Sanitize isbn with data set "valid, hyphenated"
 ✔ Sanitize isbn with data set "surrounding spaces"
 ✔ Sanitize isbn with data set "not hyphenated"
 ✔ Sanitize isbn with data set "ISBN-10"
 ✔ Only catalogue editors may set an isbn
 ✔ Boot hooks meta registration to init

Time: 00:00.084, Memory: 12.00 MB

OK (6 tests, 8 assertions)

import { defineConfig } from 'vitest/config';

export default defineConfig( {
	oxc: {
		include: /\/src\/.*\.js$/,
		exclude: /node_modules/,
		lang: 'jsx',
		jsx: { runtime: 'automatic' },
	},
	test: {
		include: [ 'src/**/*.test.js' ],
		environment: 'jsdom',
		globals: false,
		restoreMocks: true,
		server: { deps: { inline: [ /@wordpress\// ] } },
	},
} );

// src/blocks/book-card/fixtures.test.js: parses stored markup the way the editor does.
import { beforeAll, describe, expect, it, vi } from 'vitest';
import { parse, registerBlockType, serialize } from '@wordpress/blocks';
import metadata from './block.json';
import save from './save';
import deprecated from './deprecated';

const v1Hidden = `<!-- wp:lumen/book-card {"isbn":"978-1-23456-790-3","showIsbn":false} -->
<article class="wp-block-lumen-book-card"><h3 class="wp-block-lumen-book-card__title">The Glass Orchard</h3></article>
<!-- /wp:lumen/book-card -->`;

const v2 = `<!-- wp:lumen/book-card {"isbn":"978-1-23456-789-7"} -->
<article class="wp-block-lumen-book-card"><figure class="wp-block-lumen-book-card__cover"><img src="/wp-content/uploads/lighthouse-ledger.jpg" alt=""/></figure><h3 class="wp-block-lumen-book-card__title">The Lighthouse Ledger</h3><p class="wp-block-lumen-book-card__isbn">978-1-23456-789-7</p></article>
<!-- /wp:lumen/book-card -->`;

describe( 'lumen/book-card stored markup', () => {
	beforeAll( () => {
		registerBlockType( metadata, { edit: () => null, save, deprecated } );
	} );

	it( 'accepts 0.2.0 markup unchanged', () => {
		const [ block ] = parse( v2 );

		expect( block.isValid ).toBe( true );
		expect( block.attributes.title.toString() ).toBe( 'The Lighthouse Ledger' );
		expect( serialize( [ block ] ) ).toBe( v2 );
	} );

	it( 'migrates a 0.1.0 card with a hidden ISBN to the Compact style', () => {
		const info = vi.spyOn( console, 'info' ).mockImplementation( () => {} );
		const [ block ] = parse( v1Hidden );

		expect( block.isValid ).toBe( true );
		expect( block.attributes.className ).toBe( 'is-style-compact' );
		expect( block.attributes ).not.toHaveProperty( 'showIsbn' );
		expect( serialize( [ block ] ) ).toContain(
			'<p class="wp-block-lumen-book-card__isbn">978-1-23456-790-3</p>'
		);
		expect( info ).toHaveBeenCalled();
	} );
} );

$ npm run test:unit
> wp-scripts test-unit-js
 RUN  v5.0.5 lumen-catalog
 Test Files  1 passed (1)
      Tests  2 passed (2)
   Duration  5.37s (import 62%, transform 31%, environment 6%)

// playwright.config.ts: the @wordpress/scripts defaults, pointed at the 8889 test site.
import { defineConfig, type PlaywrightTestConfig } from '@playwright/test';

// eslint-disable-next-line @typescript-eslint/no-require-imports -- CommonJS without type declarations.
const baseConfig: PlaywrightTestConfig = require( '@wordpress/scripts/config/playwright.config.js' );

export default defineConfig( {
	...baseConfig,
	testDir: './tests/e2e/specs',
	webServer: {
		...baseConfig.webServer,
		command: 'npm run test:env:start',
		port: 8889,
	},
} );

// tests/e2e/specs/book-card.spec.ts: from the inserter to the published page.
import { test, expect } from '@wordpress/e2e-test-utils-playwright';

test.describe( 'Book Card block', () => {
	test.beforeAll( async ( { requestUtils } ) => {
		// The PHPUnit suite reinstalls this site: no active theme, no active plugin.
		await requestUtils.activateTheme( 'twentytwentyfive' );
		await requestUtils.activatePlugin( 'lumen-catalog' );
		await requestUtils.deleteAllPosts();
	} );

	test( 'is inserted, published and rendered', async ( { admin, editor, page } ) => {
		await admin.createNewPost( { title: 'New this autumn' } );
		await editor.insertBlock( {
			name: 'lumen/book-card',
			attributes: { isbn: '978-1-23456-789-7' },
		} );

		const card = editor.canvas.getByRole( 'document', { name: 'Block: Book Card' } );
		await card.getByRole( 'textbox', { name: 'Book title' } ).fill( 'The Lighthouse Ledger' );
		await expect( card.locator( '.wp-block-lumen-book-card__isbn' ) ).toHaveText( '978-1-23456-789-7' );
		const postId = await editor.publishPost();
		await page.goto( `/?p=${ postId }` );
		const published = page.locator( '.wp-block-lumen-book-card' );
		await expect( published.getByRole( 'heading', { level: 3 } ) ).toHaveText( 'The Lighthouse Ledger' );
		await expect( published.locator( '.wp-block-lumen-book-card__isbn' ) ).toHaveText( '978-1-23456-789-7' );
	} );
} );

$ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm run test:e2e
> wp-scripts test-e2e --wp-env-config=.wp-env.test.json
Running 1 test using 1 worker
  ✓  1 [chromium] › tests/e2e/specs/book-card.spec.ts:14:6 › Book Card block › is inserted, published and rendered (2.6s)
  1 passed (6.1s)

# .github/workflows/tests.yml (integration job; the unit and e2e jobs follow the same pattern)
jobs:
  integration:
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        include:
          - { wp: '6.9', php: '7.4' }   # the floor: Requires at least / Requires PHP
          - { wp: '7.1.3', php: '8.3' }
          - { wp: '7.1.3', php: '8.4' }
    env:
      WP_ENV_CORE: WordPress/WordPress#${{ matrix.wp }}
      WP_ENV_PHP_VERSION: ${{ matrix.php }}
    steps:
      - uses: actions/checkout@v7
      - uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
          coverage: none
      - uses: actions/setup-node@v7
        with:
          node-version: 24
          cache: npm
      - run: composer install --no-progress
      - run: npm ci
      - run: npm run test:env:start
      - run: npm run test:integration

$ export WP_ENV_CORE=WordPress/WordPress#6.9 WP_ENV_PHP_VERSION=7.4
$ npm run test:env:start
$ npx wp-env run cli --config=.wp-env.test.json bash -c 'php -r "echo PHP_VERSION;"; echo; wp core version'
7.4.33
6.9
$ npm run test:integration
OK (6 tests, 23 assertions)

$ npx @wp-playground/cli@3.1.61 server --auto-mount --wp=7.1.3 --php=8.3 --port=9400
PHP 8.3  WordPress 7.1.3
Mount <project>/lumen-catalog → /wordpress/wp-content/plugins/lumen-catalog (auto-mount)
Ready! WordPress is running on http://127.0.0.1:9400 (6 workers)