SFTtech / SFTtech/openage

API Component and Regression Tests

Open
#1,220 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: api nice new thing ☺ reporting to-discuss
Dominant language
Python
Stars
14.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

The openage API is a complex system of several interacting or interdependent components. We would like to ensure that a set configuration of objects works as expected, i.e. as it is defined in the API definition.

One way to do this would be high-level component tests ingame, either in the engine's editor or via scripting. The testing could involve simple unit tests where expected values are compared with simulation results.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the openage API definition and mapping the interacting components that need coverage. Compare possible tests in the engine editor or through scripting, then define a representative configuration, expected simulation values, and the test entry point; done means those API behaviors are checked by repeatable component or unit tests.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design, game-dev, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.