Add sample unit tests to the starter game template #46

jerargus · 2024-04-16T21:20:55Z

Add some sample unit test to the starter-game-template to demonstrate how testutils.TestFixture can be used to facilitate unit tests.

Specifically:

Add test for the Attack system to verify HP values are reduced.
Add test for the Attack system to verify invalid targets will result in a message error.
Add test for the Spawn system to verify players can be spawned.
Add a "recovery" system that will be run each time Cardinal is restarted.
Add a test for the recovery system to ensure the in-memory go object is re-populated when Cardinal is restarted.
Add an init system that creates some default players on tick 0.

Summary by CodeRabbit

New Features
- Introduced a system to automatically spawn default players with specific attributes at the start of the game.
Bug Fixes
- Standardized initial health points for players to enhance consistency in gameplay.
Tests
- Added tests to ensure default players are spawned correctly and systems like player creation and attacks function as expected.

coderabbitai · 2024-04-16T21:24:24Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update in the cardinal project introduces a more structured approach to initializing the game world, with a focus on player management. It enhances the system for spawning players, ensuring they start with predefined health and nicknames. The changes also include robust testing to verify the functionality of new and existing systems, ensuring that player creation and interactions are handled correctly from the start of the game.

Changes

Files	Changes
`.../init_test.go` `.../system_test.go`	Introduced new test cases to validate the creation and interaction of players, ensuring robustness in player management systems.
`.../main.go` `.../system/default_spawner.go` `.../system/player_spawner.go`	Enhanced player initialization and spawning mechanisms. Introduced `MustInitWorld` and `SpawnDefaultPlayersSystem` for systematic player creation with predefined attributes.

🐇✨
In the land of code, where the bits align,
A rabbit hopped, with a plan so fine.
"Let's spawn players," it said with glee,
"With health and names, as good as can be!"
Through tests and systems, with utmost care,
It crafted a world, quite unique and rare. 🌍🎮
🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

smsunarto · 2024-04-16T21:28:09Z

I think the whole non-ECS recovery stuff is way too implementation-specific and strays away from the purpose of the starter game template to serve as a scaffold for game projects.

If the goal of this is to provide examples or "cookbooks" for a specific edgecases, then we should do this in a separate examples repository.

smsunarto · 2024-04-16T21:29:00Z

cardinal/main.go

+
+// MustInitWorld registers all components, messages, queries, and systems. This initialization happens in a helper
+// function so that this can be used directly in tests.
+func MustInitWorld(w *cardinal.World) {


I don't think we want this, seems like an unnecessary hop

It's to ensure the test setup code matches the code that will eventually be deployed with world cardinal start. If we leave everything in the main function, I don't know how we would inject the test fixture world.

cardinal/system/player_spawner.go

cardinal/system_test.go

jerargus · 2024-04-16T22:59:00Z

@coderabbitai review

zulkhair · 2024-04-18T14:00:09Z

Looks like it would be better if added test target on makefile. so user can just run make test to run unit test

jerargus · 2024-04-18T15:51:35Z

Looks like it would be better if added test target on makefile. so user can just run make test to run unit test

@zulkhair I added a make test target.

smsunarto

Add a github action to run the test

cardinal/system/default_spanwer.go

jerargus added 2 commits April 16, 2024 14:13

Add sample unit tests to the starter game tempalte

e7346a1

Fix helper function comment

ea58c70

jerargus requested review from zulkhair and smsunarto April 16, 2024 21:21

smsunarto reviewed Apr 16, 2024

View reviewed changes

cardinal/system/player_spawner.go Outdated Show resolved Hide resolved

smsunarto reviewed Apr 16, 2024

View reviewed changes

cardinal/system_test.go Outdated Show resolved Hide resolved

Remove recovery example, rename tests

4a9402c

Add make test target to run unit tests

8b4bbf0

zulkhair approved these changes Apr 19, 2024

View reviewed changes

smsunarto requested changes Apr 20, 2024

View reviewed changes

cardinal/system/default_spanwer.go Outdated Show resolved Hide resolved

jerargus added 4 commits April 22, 2024 08:28

fix typo in file name

871737f

Run unit tests as part of CI

ef1af77

typo in github action

c6bb063

Switch to cardina directory before running test

38d16e5

jerargus requested a review from smsunarto April 22, 2024 15:44

smsunarto approved these changes Apr 25, 2024

View reviewed changes

jerargus merged commit 20306e2 into main Apr 25, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sample unit tests to the starter game template #46

Add sample unit tests to the starter game template #46

jerargus commented Apr 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 16, 2024 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

smsunarto commented Apr 16, 2024

smsunarto Apr 16, 2024

jerargus Apr 16, 2024

jerargus commented Apr 16, 2024

zulkhair commented Apr 18, 2024

jerargus commented Apr 18, 2024

smsunarto left a comment

Add sample unit tests to the starter game template #46

Add sample unit tests to the starter game template #46

Conversation

jerargus commented Apr 16, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 16, 2024 • edited Loading

Auto Review Skipped

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

smsunarto commented Apr 16, 2024

smsunarto Apr 16, 2024

Choose a reason for hiding this comment

jerargus Apr 16, 2024

Choose a reason for hiding this comment

jerargus commented Apr 16, 2024

zulkhair commented Apr 18, 2024

jerargus commented Apr 18, 2024

smsunarto left a comment

Choose a reason for hiding this comment

jerargus commented Apr 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 16, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)