Scenamatica

このプロジェクトは現在開発中です

このソフトウェアはまだ開発中であり, 機能は API や頻繁に変更される可能性があります。
また, このドキュメントは古くなっている可能性もあります。

概要

Scenamaticaは, PaperMC プラグインに特化したエンドツーエンドのテスト自動化フレームワークです。 YAML で予め定義されたマルチシナリオのテストにより, プラグイン機能の正常性と異常性を自動的に検証します。 Scenamaticaの活用により, リグレッションテストをスピーディに実施でき, PaperMCプラグインの開発にエンジニアが集中できるようになります。
このプロセスにより, プラグインの品質が向上し, ユーザーと開発者, 両者にとってより優れたエクスペリエンスが提供されます。また, 既存の CI/CD パイプラインと統合することで, プラグインの品質を継続的に監視できます。

特徴

世界初の PaperMC プラグインに特化したシナリオテスト
シナリオテストとは, プラグインの操作や出力をシナリオ化し, 問題なく動作するかを確認するテストです。
Scenamatica は, PaperMC プラグインでシナリオテストの自動化を世界初で実現しました。

YAML で定義されたシナリオ
YAML でシナリオを定義することで, シナリオの可読性を高め追加・変更を容易にします。面倒なテストコードを書く必要はないため, プログラマでなくてもテストを追加できます。

CI/CD との統合
GitHub Actions などの CI/CD に統合することで, プラグインの品質を継続的に監視できます。プルリクエストをマージする前にテストの成功を要求できます。

対応環境

要件	要件名	摘要
OS	Windows, Linux, macOS
Java	8 以上	Java 11 以上が推奨されていますが, 最低要件は Java 8 です。
PaperMC	1.13.2, 1.14.x, 1.15.x, 1.16.x, 1.17.x

入門

詳しくは以下のドキュメントを参照してください：

📄️ Scenamatica を使い始める

Scenamatica を使い始めるためのチュートリアルです。

使用方法

詳しくは以下のドキュメントを参照してください：

📄️ Scenamatica を使う

Scenamatica を使う方法について説明しています。

姉妹プロジェクト

TeamKUNPluginManager TeamKUNPluginManager は, わずかなアクションで安全で簡単にインストールを行うフルマネージド統合プラグインマネージャです。 KPM を既存のサーバ管理フローに統合すれば, GitHub 等のリモートリポジトリや HTTP サーバに登録された依存関係を自動で解決し, 単一のフローとしてプラグインをインストールできます。また, KPM はオートメーションされた依存関係ツリーをビルドし不必要なプラグインをわかりやすくリコメンデーションします。
そのため, 本番環境でのサーバアプリケーションパフォーマンスを継続的に監視したり, 依存関係を最適化するための推奨事項と視覚的な手がかりを提供したりして, サーバの管理をより簡単で安全にします。