Skip to content

Add comprehensive tests for Player model functionality #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Birdmannn merged 8 commits into from
Aug 6, 2025
Merged

Add comprehensive tests for Player model functionality #195

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dafbb1b
Add comprehensive tests for Player model functionality
No-bodyq Jul 27, 2025
cec47d7
Add tests for player model and game mechanics
No-bodyq Jul 28, 2025
1860bcc
Refactor player model tests to use flexible mock functions for improv…
No-bodyq Jul 30, 2025
06a7b6b
fmt
No-bodyq Jul 30, 2025
1838e91
Refactor player model tests
No-bodyq Aug 2, 2025
2095295
Refactor player model tests
No-bodyq Aug 2, 2025
786d787
Merge branch 'Prometheus-A:v1' into v1
No-bodyq Aug 3, 2025
a55faac
Refactor player model tests
No-bodyq Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
335 changes: 334 additions & 1 deletion poker-texas-hold-em/contract/src/models/player.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,337 @@ impl ContractAddressDefault of Default<ContractAddress> {

/// TESTS ON PLAYER MODEL
#[cfg(test)]
mod tests {}
mod tests {
use dojo::event::EventStorageTest;
use dojo_cairo_test::WorldStorageTestTrait;
use dojo::model::{ModelStorage, ModelValueStorage, ModelStorageTest};
use dojo::world::{WorldStorage, WorldStorageTrait};
use dojo_cairo_test::{
spawn_test_world, NamespaceDef, TestResource, ContractDefTrait, ContractDef,
};
use poker::models::game::{Game, GameTrait, ShowdownType};
use poker::models::player::{Player, PlayerTrait};
use poker::tests::setup::setup::{CoreContract, deploy_contracts};
use poker::models::base::GameErrors;
use poker::traits::game::get_default_game_params;
use starknet::ContractAddress;
use starknet::testing::{set_account_contract_address, set_contract_address};

use crate::tests::test_actions::tests::{
PLAYER_1, PLAYER_2, PLAYER_3, PLAYER_4, mock_poker_game, mock_player, mock_poker_game_flex,
};

fn mock_allowable_game(ref world: WorldStorage) {
Copy link
Copy Markdown
Collaborator

@Birdmannn Birdmannn Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from here Line167 to Line322, all new mocks would be to refactor the original mock function to take in parameters that target specific fields, and reuse this function.

SO basically all functions mocking the player state must be merged into one player function that takes in the specific parameters you wish to mock.
For all functions mocking the game state, then you must refactor the original function in test_actions.cairo to take in the specific mock parameters and adjust the tests there to pass.

Please, I hope you understand.

let player_1 = mock_player(
PLAYER_1(), 'dub_zn', 2000, 0, 1, (true, 1), false, true, (0, 0), 0x1, 0, false, 1,
);
let player_2 = mock_player(
PLAYER_2(), 'Birdmannn', 5000, 0, 1, (true, 2), false, true, (0, 0), 0x2, 0, false, 1,
);
let player_3 = mock_player(
PLAYER_3(),
'chiscookeke11',
5000,
0,
1,
(false, 1),
false,
true,
(0, 0),
0x3,
0,
false,
1,
Copy link
Copy Markdown
Collaborator

@Birdmannn Birdmannn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example, something like this is repeated. including Line87 and Line88. Don't bother about the public key, you never tested it. This is what I wanted to show you. In the mock_player function you created, what should enter the params are the variables that are actually tested and that they vary for each player

So your function would resemble something like this

fn mock_player(id: ContractAddress, alias: felt252, chips: u256, out: (bool, u16)) -> Player {
    let mut player: Player = Default::default();
    player.id = id;
    player.chips = chips;
    player.alias = alias;
    player.out = out;
    player
}

Implement this type of stuff too when mocking the game.
You see how neat and easy to read that is? That's how it should probably look... I didn't say that is the exact function... I'm not sure if I omitted some fields or parameters

);
mock_poker_game_flex(
ref world,
2,
true,
false,
1,
false,
2,
array![PLAYER_1(), PLAYER_2(), PLAYER_3()],
array![],
Option::Some(PLAYER_1()),
array![],
array![0],
0,
get_default_game_params(),
0,
false,
0,
0,
0,
false,
false,
0,
Option::None,
0,
array![player_1, player_2, player_3],
);
}
Comment on lines +98 to +99
Copy link
Copy Markdown
Collaborator

@Birdmannn Birdmannn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do the same with this function too. It takes in too many default fields... and yes, the pots might not be passed in as a parameter, you can just set the game.pots = array![0] since that is always the case for the pots, and the game.pots must be set like this inside the function because Default::default() makes it an empty array which is not a valid pot.



#[test]
fn test_exit_with_out_true_succeeds() {
Copy link
Copy Markdown
Collaborator

@Birdmannn Birdmannn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅

let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game = world.read_model(1);
let mut player = world.read_model(PLAYER_1());
player.exit(ref game, true);
assert_eq!(
player.out,
(game.id, game.reshuffled),
"Player out should be set to game id and reshuffled",
);
assert_eq!(player.current_bet, 0, "Player current bet should be reset to 0");
assert_eq!(player.is_dealer, false, "Player should not be dealer after exit");
assert_eq!(player.in_round, false, "Player should not be in round after exit");
assert_eq!(player.locked, (false, 0), "Player should be unlocked after exit");
assert_eq!(game.current_player_count, 1, "Game player count should decrease by 1");
}

#[test]
fn test_exit_with_out_false_succeeds() {
Copy link
Copy Markdown
Collaborator

@Birdmannn Birdmannn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅

let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game = world.read_model(1);
let mut player = world.read_model(PLAYER_1());
player.exit(ref game, false);
assert_eq!(player.out, (0, 0), "Player out should be set to game id and reshuffled");
assert_eq!(player.current_bet, 0, "Player current bet should be reset to 0");
assert_eq!(player.is_dealer, false, "Player should not be dealer after exit");
assert_eq!(player.in_round, false, "Player should not be in round after exit");
assert_eq!(player.locked, (false, 0), "Player should be unlocked after exit");
assert_eq!(game.current_player_count, 1, "Game player count should decrease by 1");
}

#[test]
#[should_panic(expected: 'CANNOT EXIT, PLAYER NOT LOCKED')]
fn test_exit_without_lock_fails() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game = world.read_model(1);
let mut player: Player = world.read_model(PLAYER_3());
player.locked = (false, 0);
player.exit(ref game, true);
}

#[test]
fn test_exit_with_splitted_showdown_returns_locked_chips() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game: Game = world.read_model(1);
let mut player: Player = world.read_model(PLAYER_1());
let stake = 1000;
game.params.showdown_type = ShowdownType::Splitted(stake);
player.chips = 2000;
player.locked_chips = stake;
player.exit(ref game, true);
assert_eq!(player.chips, 3000, "Player should get locked chips back");
assert_eq!(player.locked_chips, 0, "Locked chips should be reset to 0");
}

#[test]
#[should_panic(expected: 'GAME PLAYER COUNT SUB')]
fn test_exit_with_zero_player_count_fails() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game: Game = world.read_model(1);
let mut player: Player = world.read_model(PLAYER_1());
game.current_player_count = 0;
player.exit(ref game, true);
}

#[test]
#[should_panic(expected: 'BAD REQUEST')]
fn test_exit_with_invalid_player_fails() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game: Game = world.read_model(1);
let mut player: Player = world.read_model(PLAYER_2());
player.locked = (true, 999);
player.exit(ref game, true);
}

#[test]
fn test_enter_succeeds_new_player() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_allowable_game(ref world);
let mut game: Game = world.read_model(2);
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
let is_full = player.enter(ref game);
assert_eq!(player.locked, (true, game.id), "Player should be locked to game");
assert_eq!(player.in_round, true, "Player should be in round");
assert_eq!(game.current_player_count, 3, "Game player count should increase");
assert_eq!(player.eligible_pots, 1, "Player should be eligible for 1 pot");
assert_eq!(is_full, false, "Game should not be full");
assert_eq!(game.players.len(), 4, "Player should be added to game players");
assert_eq!(*game.players.at(3), PLAYER_4(), "Last player should be PLAYER_4");
}

#[test]
fn test_is_full_returns_true_when_game_full() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_allowable_game(ref world);
let mut game: Game = world.read_model(2);
game.current_player_count = 2;
game.params.max_no_of_players = 3;
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
let is_full = player.enter(ref game);
assert_eq!(is_full, true, "Game should be full after player enters");
assert_eq!(game.current_player_count, 3, "Game should have max players");
}

#[test]
#[should_panic(expected: 'PLAYER ALREADY LOCKED')]
fn test_enter_fails_when_player_already_locked() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_allowable_game(ref world);
let mut game: Game = world.read_model(2);
let mut player: Player = world.read_model(PLAYER_1());
player.locked = (true, game.id);
player.enter(ref game);
}

#[test]
#[should_panic(expected: 'GAME NOT INITIALIZED')]
fn test_enter_fails_when_game_not_initialized() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game_flex(
ref world,
3,
Copy link
Copy Markdown
Collaborator

@Birdmannn Birdmannn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

by the way, if the id is not useful in mocking, you can default it to 1 in the mock function, and remove it as a parameter in the function's signature

false,
false,
0,
false,
0,
array![],
array![],
Option::None,
array![],
array![],
0,
get_default_game_params(),
0,
false,
0,
0,
0,
false,
false,
0,
Option::None,
0,
array![],
);
let mut game: Game = world.read_model(3);
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
player.enter(ref game);
}

#[test]
#[should_panic(expected: 'GAME ALREADY ENDED')]
fn test_enter_fails_when_game_ended() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game_flex(
ref world,
4,
false,
true,
0,
false,
0,
array![PLAYER_1()],
array![],
Option::None,
array![],
array![],
0,
get_default_game_params(),
0,
false,
0,
0,
0,
false,
false,
0,
Option::None,
0,
array![],
);
let mut game: Game = world.read_model(4);
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
player.enter(ref game);
}

#[test]
#[should_panic(expected: 'INSUFFICIENT CHIPS')]
fn test_enter_fails_when_insufficient_chips() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_allowable_game(ref world);
let mut game: Game = world.read_model(2);
let stake = 1000;
game.params.showdown_type = ShowdownType::Splitted(stake);
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
player.chips = 0;
player.enter(ref game);
}

#[test]
fn test_refresh_stake_succeeds_with_splitted_showdown() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_allowable_game(ref world);
let mut game: Game = world.read_model(2);
let stake = 1000;
game.params.showdown_type = ShowdownType::Splitted(stake);
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
player.chips = 2000;
let result = player.refresh_stake(ref game);
assert_eq!(result, true, "Refresh stake should succeed");
assert_eq!(player.chips, 1000, "Player chips should be reduced by stake");
assert_eq!(player.locked_chips, 1000, "Locked chips should equal stake");
}

#[test]
fn test_refresh_stake_fails_with_insufficient_chips() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_allowable_game(ref world);
let mut game: Game = world.read_model(2);
let stake = 1000;
game.params.showdown_type = ShowdownType::Splitted(stake);
let mut player: Player = mock_player(
PLAYER_4(), 'Nobody', 5000, 0, 1, (false, 1), false, true, (0, 0), 0x3, 0, false, 1,
);
player.chips = 500;
let result = player.refresh_stake(ref game);
assert_eq!(result, false, "Refresh stake should fail");
}

#[test]
fn test_is_maxed_returns_true_when_player_maxed() {
let (mut world, _) = deploy_contracts(array![CoreContract::Actions]);
mock_poker_game(ref world);
let mut game: Game = world.read_model(1);
let mut player: Player = world.read_model(PLAYER_1());
player.chips = 0;
player.current_bet = 0;
player.eligible_pots = 0;
let result = player.is_maxed(@game);
assert_eq!(result, true, "Player should be maxed");
}
}
Loading
Loading