{"id":13316546,"url":"https://github.com/Daomephsta/Saddle","last_synced_at":"2025-03-10T23:32:12.817Z","repository":{"id":93964425,"uuid":"216444128","full_name":"Daomephsta/Saddle","owner":"Daomephsta","description":"A basic JUnit 5 testing harness for Minecraft Forge mods","archived":false,"fork":false,"pushed_at":"2021-02-26T08:21:53.000Z","size":70,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-05T04:18:41.898Z","etag":null,"topics":["junit5","minecraft-forge","minecraft-forge-mod","minecraft-mod"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Daomephsta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-21T00:01:29.000Z","updated_at":"2019-10-27T10:28:47.000Z","dependencies_parsed_at":"2023-03-07T03:30:48.747Z","dependency_job_id":null,"html_url":"https://github.com/Daomephsta/Saddle","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daomephsta%2FSaddle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daomephsta%2FSaddle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daomephsta%2FSaddle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daomephsta%2FSaddle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Daomephsta","download_url":"https://codeload.github.com/Daomephsta/Saddle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242945135,"owners_count":20210756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["junit5","minecraft-forge","minecraft-forge-mod","minecraft-mod"],"created_at":"2024-07-29T18:21:47.649Z","updated_at":"2025-03-10T23:32:12.809Z","avatar_url":"https://github.com/Daomephsta.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Saddle\nA simple test harness for running JUnit 5's Jupiter engine inside Minecraft. It only works with Minecraft Forge at this time.\n\n### Installing Saddle\nSaddle is not available on any maven. You should download one of the [precompiled releases](https://github.com/Daomephsta/Saddle/releases), compile Saddle yourself, or use [JitPack](https://jitpack.io/). Saddle should be added to Gradle's `testImplementation` configuration.\n\n### Creating Saddle Tests\nSaddle tests are created in exactly the same way as Jupiter tests, with the exception that they must be annotated with `io.github.daomephsta.saddle.engine.SaddleTest` instead of `org.junit.jupiter.api.Test`. All other Jupiter annotations work as normal.\n\n### Configuring Test Discovery\nBefore you can run Saddle, you must configure which packages/classes should be included/excluded from test discovery.  \nSaddle is configured by creating a file at the root of your test resources directory named `saddle-config.json`. The format\nis as follows.  \n```\n\u003croot\u003e=\n{\n  \"pre_init\": \u003cPhaseConfiguration\u003e, //Optional\n  \"init\": \u003cPhaseConfiguration\u003e, //Optional\n  \"post_init\": \u003cPhaseConfiguration\u003e //Optional\n}\n\n\u003cPhaseConfiguration\u003e=\n{\n  \"include\": \u003cIncludeSpec[]\u003e, //Optional\n  \"exclude\": \u003cExcludeSpec[]\u003e //Optional\n}\n\n\u003cIncludeSpec[]\u003e=\n[\n  \u003cIncludeSpec\u003e,\n  ...\n]\n\n\u003cIncludeSpec\u003e={\"package\": \"foo.bar\"} || {\"class\": \"foo.bar.Baz\"}\n\n\u003cExcludeSpec[]\u003e=\n[\n  \u003cExcludeSpec\u003e,\n  ...\n]\n\n\u003cExcludeSpec\u003e={\"package\": \"foo.bar\"} || {\"class\": \"foo.bar.Baz\"}\n```\n\n\n### Running Saddle Tests\nRun your mod as usual. Saddle will discover and run Saddle tests according to its configuration. \nIf you want to disable Saddle without uninstalling it, add `-Dsaddle.disable=true` to your VM arguments.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDaomephsta%2FSaddle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDaomephsta%2FSaddle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDaomephsta%2FSaddle/lists"}