Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamkun/scenamatica
Let's enhance your PaperMC plugin quality with Scenamatica: YAML-defined scenarios, CI/CD integration
https://github.com/teamkun/scenamatica
bukkit bukkit-plugin papermc papermc-plugin peyang scenario-test scenario-tester scenario-testing spigot spigot-plugin test test-automation testing
Last synced: 21 days ago
JSON representation
Let's enhance your PaperMC plugin quality with Scenamatica: YAML-defined scenarios, CI/CD integration
- Host: GitHub
- URL: https://github.com/teamkun/scenamatica
- Owner: TeamKun
- License: mit
- Created: 2023-03-16T13:41:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T12:32:32.000Z (7 months ago)
- Last Synced: 2024-05-29T04:04:38.815Z (7 months ago)
- Topics: bukkit, bukkit-plugin, papermc, papermc-plugin, peyang, scenario-test, scenario-tester, scenario-testing, spigot, spigot-plugin, test, test-automation, testing
- Language: Java
- Homepage: https://scenamatica.kunlab.org/
- Size: 9.34 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.en.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Enhance PaperMC plugin quality with its automation framework: YAML-defined tests, CI/CD integration.
[日本語/Japanese](README.md)
## Overview
Scenamatica is an end-to-end automation framework for PaperMC plugins, which is the world's first.
It automatically verifies the functionality and abnormality of the plugin through multi-scenario tests defined in YAML.
By utilizing Scenamatica, regression tests can be conducted quickly, allowing engineers to focus on developing PaperMC
plugins.
This process improves the quality of plugins and provides a better experience for both users and developers.
Additionally, by integrating it into existing CI/CD pipelines, plugin quality can be continuously monitored.
## Features
+ Automated scenario testing for PaperMC plugins
Scenario testing is a test to check if the plugin operates and outputs as expected by scenario-izing plugin operation
and output.
Scenamatica realized the automation of scenario testing for PaperMC plugins, which is the world's first.
+ YAML scenario definition
By defining scenarios in YAML, the readability of scenarios is improved and adding/changing scenarios becomes easy.
You don't need to write tedious test code, and even non-Java/Kotlin programmers can add tests.
+ Integration with CI/CD
By integrating with CI/CD such as GitHub Actions, plugin quality can be continuously monitored.
You can require a successful test before merging a pull request.
## Language Support
| Language | In the plugin | In documents |
|:------------|:-------------------|:-------------------|
| 日本語 | :white_check_mark: | :white_check_mark: |
| English(US) | :white_check_mark: | :x: |
| 日本語(関西弁) | :white_check_mark: | :x: |
## Installation and Usage
Please refer to [the documentation](https://scenamatica.kunlab.org) for installation and usage.
## Screenshots
