YOURLS test suite for plugins

プラグイン用の YOURLS テスト スイート

あなたのプラグインのための PHPUnit ツール。

について

プラグイン用の YOURLS テスト スイートは、標準の PHPUnit テストを使用して YOURLS プラグインをテストするツールです。

このツールは、コマンド ライン ツールと PHPUnit フレームワークの基本的な知識を前提としています。

使用法

0. テストを備えたプラグインを用意する
   YOURLS プラグインの単体テストの作成に関する短いハウツー ガイドを参照してください。

1. プラグイン用の YOURLS テスト スイートをインストールする
   my-cool-plugin/内:

   $ git clone https://github.com/YOURLS/YOURLS-test-suite-for-plugins test-suite

2. YOURLS テスト スイートとテスト データベースをインストールする

   $ bash test-suite/src/install-test-suite.sh < db-name > < db-user > < db-password > [db-host, default localhost] [YOURLS version, default master]

   例:

   $ bash test-suite/src/install-test-suite.sh yourlstest root " "
   $ bash test-suite/src/install-test-suite.sh yourlstest mydbuser mydbpassword mysql.myserver.com:666 1.8.2

3. プラグイン単体テストを実行する
   単体テストを作成したら、実行します。

   $ phpunit -c ./test-suite/src/phpunit.xml

   期待される結果は次のようなものになります:

   $ phpunit -c ./test-suite/src/phpunit.xml
   YOURLS installed, starting PHPUnit
   
   Plugin Loaded : My cool plugin by Joe (my-cool-plugin/plugin.php)
   
   PHPUnit 9.5.2 by Sebastian Bergmann and contributors.
   
   ......                                                              3 / 3 (100%)
   
   Time: 00:00.007, Memory: 22.00 MB
   
   OK (3 tests, 6 assertions)
   $

4. テストを自動化する
   Github リポジトリで、プラグイン コードが変更されたとき、または YOURLS の新しいバージョンが利用可能になったときにテストを自動的に実行するように Github アクションを設定します。ワークフローガイドを参照してください。

ライセンス

無料ソフトウェア。やりたいことは何でもしてください。 YOURLS は MIT ライセンスに基づいてリリースされています。