Visual Studio Code を使ってローカルで WordPress プラグインの PHPUnit を実行してみよう

WordPress plugin を PHPUnit でテストするためには、
WordPress, PHPUnit のインストールの他に Subversion 、
そして MySQL 等のデータベースが必要になります。
この環境構築には時間がかかります。
この記事では Visual Studio Code と Docker Desktop を利用して
環境構築の手順をスキップします。

なお、Visual Studio Code 以外のエディター・IDE を使いたい場合は
Docker のみを使って PHPUnit を実行することもできます。

ローカルでの PHPUnit 実行方法

ダウンロードはこちらです。

WordPress plugin のプロジェクトディレクトリーを
コンテナーにマウントするために、ファイル共有の設定を行います。
これを行わないと、エラーが発生します。

git clone https://github.com/yukihiko-shinoda/docker-compose-phpunit-wordpress-plugin.git

クローンしたディレクトリーに移動し、Visual Studio Code を起動します。

Windows の GUI を使う場合は次のように操作します:

フォルダーの余白を右クリック → [Open with Code] をクリック

Visual Studio Code が起動したら、
拡張機能の推奨に関する通知ダイアログが表示されます。

[Install All] ボタンをクリックします。(その他の通知は一旦放置します。)

拡張機能のインストールが完了したら、.env ファイルを作成します:

すると、.env ファイルがタブで開くので、
PATH_TO_INDIVIDUAL_PLUGIN_DIRECTORY キーを設定します。
値は WordPress plugin のプロジェクトのディレクトリーを指すようにします。

例:

PATH_TO_INDIVIDUAL_PLUGIN_DIRECTORY=../plugins/staticpress2019

そして、ファイルを保存します。

左下隅のクイックアクションステータスバーの項目をクリックし、
[Remote-Containers: Reopen in Container] をクリックします。

[Open Workspace] ボタンをクリック

すると、WordPress plugin のプロジェクトファイルや
WordPress のライブラリーを参照できるようになります。
PHP ファイルを開くとコードの解析が始まります。

コードの解析が終わったら、PHP のコードに正しい警告が表示されます。

それでは、ターミナルを開きましょう。

そうしたら、PHPUnit や PHP_CodeSniffer が実行できます。

次のように入力します:

phpunit

または:

phpcs

そして Enter キーを入力すると、結果が表示されます。

再起動の前に、データベースコンテナーを削除する必要があります。

docker stop database && docker rm database

.env ファイルに次のキーを追加します。

例:

DOCKER_IMAGE_PHPUNIT=futureys/phpunit-wordpress-plugin:4.3.22-php7.1.33-apache-buster
MYSQL_VERSION=5.6

レガシー環境用のイメージは
Docker Hubのリポジトリー: futureys/phpunit-wordpress-plugin
から選択できます。

もし必要なタグのイメージがなければ、
GitHub の Issues から筆者に注文してください。

注文の際は、次の内容を教えてください:

イメージはマトリックス・ビルドで作成しているので、
開発・ビルドにかかる時間やコストの観点から、
できるだけイメージの種類を減らしたいためです。

WordPress plugin のプロジェクトを既に初期化しましたか？
初期化された WordPress plugin のプロジェクトには
次のファイルが含まれているはずです:

もしこれらのファイルが存在しない場合は
まず WordPress プラグインの初期化を行いましょう。