d378759d58
* add a new "pipeline" concept - added new Pipeline type which is a series of stages - added a global registry to facilitate plugin architecture - 100% test coverage * Refactor rulesets to provide and use Pipeline * fix copypasta comments * fix lint for unused method * include game over stages in ruleset pipelines * clean up unused private standard methods * remove unused private methods in squad ruleset * remove unused private methods in royale ruleset * refactor: pipeline clone + return next board state * YAGNI: remove unused Append * refactor: improve stage names * add no-op behavior to stages for initial state * refactor: no-op decision within stage functions * remove misleading comment that isn't true * dont bother checking for init in gameover stages * remove redundant test * refactor: provide a combined ruleset/pipeline type * fix: movement no-op for GameOver check IsGameOver needs to run pipeline, move snakes needs to no-op for that * add test coverage * refactor: improve stage names and use constants * add Error method Support error checking before calling Execute() * update naming to be American style * panic when overwriting stages in global registry * rename "Error" method and improve docs * use testify lib for panic assertion * remove redundant food stage * use ruleset-specific logic for game over checks * re-work Pipeline errors * rework errors again * add defensive check for zero length snake * use old logic which checks current state, not next * add warning about how PipelineRuleset checks for game over
280 lines
8.7 KiB
Go
280 lines
8.7 KiB
Go
package rules
|
|
|
|
import (
|
|
"errors"
|
|
"math/rand"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestRoyaleRulesetInterface(t *testing.T) {
|
|
var _ Ruleset = (*RoyaleRuleset)(nil)
|
|
}
|
|
|
|
func TestRoyaleDefaultSanity(t *testing.T) {
|
|
boardState := &BoardState{}
|
|
r := RoyaleRuleset{StandardRuleset: StandardRuleset{HazardDamagePerTurn: 1}, ShrinkEveryNTurns: 0}
|
|
_, err := r.CreateNextBoardState(boardState, []SnakeMove{{"", ""}})
|
|
require.Error(t, err)
|
|
require.Equal(t, errors.New("royale game can't shrink more frequently than every turn"), err)
|
|
|
|
r = RoyaleRuleset{ShrinkEveryNTurns: 1}
|
|
_, err = r.CreateNextBoardState(boardState, []SnakeMove{})
|
|
require.Error(t, err)
|
|
require.Equal(t, errors.New("royale damage per turn must be greater than zero"), err)
|
|
|
|
r = RoyaleRuleset{StandardRuleset: StandardRuleset{HazardDamagePerTurn: 1}, ShrinkEveryNTurns: 1}
|
|
boardState, err = r.CreateNextBoardState(boardState, []SnakeMove{})
|
|
require.NoError(t, err)
|
|
require.Len(t, boardState.Hazards, 0)
|
|
}
|
|
|
|
func TestRoyaleName(t *testing.T) {
|
|
r := RoyaleRuleset{}
|
|
require.Equal(t, "royale", r.Name())
|
|
}
|
|
|
|
func TestRoyaleHazards(t *testing.T) {
|
|
seed := int64(25543234525)
|
|
tests := []struct {
|
|
Width int32
|
|
Height int32
|
|
Turn int32
|
|
ShrinkEveryNTurns int32
|
|
Error error
|
|
ExpectedHazards []Point
|
|
}{
|
|
{Error: errors.New("royale game can't shrink more frequently than every turn")},
|
|
{ShrinkEveryNTurns: 1, ExpectedHazards: []Point{}},
|
|
{Turn: 1, ShrinkEveryNTurns: 1, ExpectedHazards: []Point{}},
|
|
{Width: 3, Height: 3, Turn: 1, ShrinkEveryNTurns: 10, ExpectedHazards: []Point{}},
|
|
{Width: 3, Height: 3, Turn: 9, ShrinkEveryNTurns: 10, ExpectedHazards: []Point{}},
|
|
{
|
|
Width: 3, Height: 3, Turn: 10, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 11, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 19, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 20, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}, {1, 2}, {2, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 31, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}, {1, 1}, {1, 2}, {2, 1}, {2, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 42, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}, {1, 0}, {1, 1}, {1, 2}, {2, 0}, {2, 1}, {2, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 53, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}, {1, 0}, {1, 1}, {1, 2}, {2, 0}, {2, 1}, {2, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 64, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}, {1, 0}, {1, 1}, {1, 2}, {2, 0}, {2, 1}, {2, 2}},
|
|
},
|
|
{
|
|
Width: 3, Height: 3, Turn: 6987, ShrinkEveryNTurns: 10,
|
|
ExpectedHazards: []Point{{0, 0}, {0, 1}, {0, 2}, {1, 0}, {1, 1}, {1, 2}, {2, 0}, {2, 1}, {2, 2}},
|
|
},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
b := &BoardState{
|
|
Turn: test.Turn - 1,
|
|
Width: test.Width,
|
|
Height: test.Height,
|
|
}
|
|
r := RoyaleRuleset{
|
|
StandardRuleset: StandardRuleset{
|
|
HazardDamagePerTurn: 1,
|
|
},
|
|
Seed: seed,
|
|
ShrinkEveryNTurns: test.ShrinkEveryNTurns,
|
|
}
|
|
|
|
_, err := PopulateHazardsRoyale(b, r.Settings(), mockSnakeMoves())
|
|
require.Equal(t, test.Error, err)
|
|
if err == nil {
|
|
// Obstacles should match
|
|
require.Equal(t, test.ExpectedHazards, b.Hazards)
|
|
for _, expectedP := range test.ExpectedHazards {
|
|
wasFound := false
|
|
for _, actualP := range b.Hazards {
|
|
if expectedP == actualP {
|
|
wasFound = true
|
|
break
|
|
}
|
|
}
|
|
require.True(t, wasFound)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRoyalDamageNextTurn(t *testing.T) {
|
|
seed := int64(45897034512311)
|
|
|
|
base := &BoardState{Width: 10, Height: 10, Snakes: []Snake{{ID: "one", Health: 100, Body: []Point{{9, 1}, {9, 1}, {9, 1}}}}}
|
|
r := RoyaleRuleset{StandardRuleset: StandardRuleset{HazardDamagePerTurn: 30}, Seed: seed, ShrinkEveryNTurns: 10}
|
|
m := []SnakeMove{{ID: "one", Move: "down"}}
|
|
|
|
stateAfterTurn := func(prevState *BoardState, turn int32) *BoardState {
|
|
nextState := prevState.Clone()
|
|
nextState.Turn = turn - 1
|
|
_, err := PopulateHazardsRoyale(nextState, r.Settings(), nil)
|
|
require.NoError(t, err)
|
|
nextState.Turn = turn
|
|
return nextState
|
|
}
|
|
|
|
prevState := stateAfterTurn(base, 9)
|
|
next, err := r.CreateNextBoardState(prevState, m)
|
|
require.NoError(t, err)
|
|
require.Equal(t, NotEliminated, next.Snakes[0].EliminatedCause)
|
|
require.Equal(t, int32(99), next.Snakes[0].Health)
|
|
require.Equal(t, Point{9, 0}, next.Snakes[0].Body[0])
|
|
require.Equal(t, 10, len(next.Hazards)) // X = 0
|
|
|
|
prevState = stateAfterTurn(base, 19)
|
|
next, err = r.CreateNextBoardState(prevState, m)
|
|
require.NoError(t, err)
|
|
require.Equal(t, NotEliminated, next.Snakes[0].EliminatedCause)
|
|
require.Equal(t, int32(99), next.Snakes[0].Health)
|
|
require.Equal(t, Point{9, 0}, next.Snakes[0].Body[0])
|
|
require.Equal(t, 20, len(next.Hazards)) // X = 9
|
|
|
|
prevState = stateAfterTurn(base, 20)
|
|
next, err = r.CreateNextBoardState(prevState, m)
|
|
require.NoError(t, err)
|
|
require.Equal(t, NotEliminated, next.Snakes[0].EliminatedCause)
|
|
require.Equal(t, int32(69), next.Snakes[0].Health)
|
|
require.Equal(t, Point{9, 0}, next.Snakes[0].Body[0])
|
|
require.Equal(t, 20, len(next.Hazards))
|
|
|
|
prevState.Snakes[0].Health = 15
|
|
next, err = r.CreateNextBoardState(prevState, m)
|
|
require.NoError(t, err)
|
|
require.Equal(t, EliminatedByOutOfHealth, next.Snakes[0].EliminatedCause)
|
|
require.Equal(t, int32(0), next.Snakes[0].Health)
|
|
require.Equal(t, Point{9, 0}, next.Snakes[0].Body[0])
|
|
require.Equal(t, 20, len(next.Hazards))
|
|
|
|
prevState.Food = append(prevState.Food, Point{9, 0})
|
|
next, err = r.CreateNextBoardState(prevState, m)
|
|
require.NoError(t, err)
|
|
require.Equal(t, Point{9, 0}, next.Snakes[0].Body[0])
|
|
require.Equal(t, NotEliminated, next.Snakes[0].EliminatedCause)
|
|
require.Equal(t, int32(100), next.Snakes[0].Health)
|
|
require.Equal(t, Point{9, 0}, next.Snakes[0].Body[0])
|
|
require.Equal(t, 20, len(next.Hazards))
|
|
}
|
|
|
|
// Checks that hazards get placed
|
|
// also that:
|
|
// - snakes move properly
|
|
// - snake gets health from eating
|
|
// - food gets consumed
|
|
// - health is decreased
|
|
var royaleCaseHazardsPlaced = gameTestCase{
|
|
"Royale Case Hazards Placed",
|
|
&BoardState{
|
|
Width: 10,
|
|
Height: 10,
|
|
Snakes: []Snake{
|
|
{
|
|
ID: "one",
|
|
Body: []Point{{1, 1}, {1, 2}},
|
|
Health: 100,
|
|
},
|
|
{
|
|
ID: "two",
|
|
Body: []Point{{3, 4}, {3, 3}},
|
|
Health: 100,
|
|
},
|
|
{
|
|
ID: "three",
|
|
Body: []Point{},
|
|
Health: 100,
|
|
EliminatedCause: EliminatedByOutOfBounds,
|
|
},
|
|
},
|
|
Food: []Point{{0, 0}, {1, 0}},
|
|
Hazards: []Point{},
|
|
},
|
|
[]SnakeMove{
|
|
{ID: "one", Move: MoveDown},
|
|
{ID: "two", Move: MoveUp},
|
|
{ID: "three", Move: MoveLeft}, // Should be ignored
|
|
},
|
|
nil,
|
|
&BoardState{
|
|
Width: 10,
|
|
Height: 10,
|
|
Snakes: []Snake{
|
|
{
|
|
ID: "one",
|
|
Body: []Point{{1, 0}, {1, 1}, {1, 1}},
|
|
Health: 100,
|
|
},
|
|
{
|
|
ID: "two",
|
|
Body: []Point{{3, 5}, {3, 4}},
|
|
Health: 99,
|
|
},
|
|
{
|
|
ID: "three",
|
|
Body: []Point{},
|
|
Health: 100,
|
|
EliminatedCause: EliminatedByOutOfBounds,
|
|
},
|
|
},
|
|
Food: []Point{{0, 0}},
|
|
Hazards: []Point{{X: 0, Y: 0}, {X: 1, Y: 0}, {X: 2, Y: 0}, {X: 3, Y: 0}, {X: 4, Y: 0}, {X: 5, Y: 0}, {X: 6, Y: 0}, {X: 7, Y: 0}, {X: 8, Y: 0}, {X: 9, Y: 0}},
|
|
},
|
|
}
|
|
|
|
func TestRoyaleCreateNextBoardState(t *testing.T) {
|
|
// add expected hazards to the standard cases that need them
|
|
s1 := standardCaseMoveEatAndGrow.clone()
|
|
s1.expectedState.Hazards = []Point{{X: 0, Y: 0}, {X: 1, Y: 0}, {X: 2, Y: 0}, {X: 3, Y: 0}, {X: 4, Y: 0}, {X: 5, Y: 0}, {X: 6, Y: 0}, {X: 7, Y: 0}, {X: 8, Y: 0}, {X: 9, Y: 0}}
|
|
s2 := standardMoveAndCollideMAD.clone()
|
|
s2.expectedState.Hazards = []Point{{X: 0, Y: 0}, {X: 1, Y: 0}, {X: 2, Y: 0}, {X: 3, Y: 0}, {X: 4, Y: 0}, {X: 5, Y: 0}, {X: 6, Y: 0}, {X: 7, Y: 0}, {X: 8, Y: 0}, {X: 9, Y: 0}}
|
|
|
|
cases := []gameTestCase{
|
|
// inherits these test cases from standard
|
|
standardCaseErrNoMoveFound,
|
|
standardCaseErrZeroLengthSnake,
|
|
*s1,
|
|
*s2,
|
|
royaleCaseHazardsPlaced,
|
|
}
|
|
r := RoyaleRuleset{
|
|
StandardRuleset: StandardRuleset{
|
|
HazardDamagePerTurn: 1,
|
|
},
|
|
ShrinkEveryNTurns: 1,
|
|
}
|
|
rand.Seed(0)
|
|
rb := NewRulesetBuilder().WithParams(map[string]string{
|
|
ParamGameType: GameTypeRoyale,
|
|
ParamHazardDamagePerTurn: "1",
|
|
ParamShrinkEveryNTurns: "1",
|
|
})
|
|
for _, gc := range cases {
|
|
gc.requireValidNextState(t, &r)
|
|
// also test a RulesBuilder constructed instance
|
|
gc.requireValidNextState(t, rb.Ruleset())
|
|
// also test a pipeline with the same settings
|
|
gc.requireValidNextState(t, rb.PipelineRuleset(GameTypeRoyale, NewPipeline(royaleRulesetStages...)))
|
|
}
|
|
}
|