PKHeX/Tests/PKHeX.Core.Tests/Legality/BreedTests.cs
Kurt 9166d0eb64
Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves

In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.

The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.

The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.

* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 16:15:27 -07:00

93 lines
4 KiB
C#

using System;
using System.Linq;
using FluentAssertions;
using PKHeX.Core;
using Xunit;
using static PKHeX.Core.Move;
using static PKHeX.Core.Species;
using static PKHeX.Core.GameVersion;
namespace PKHeX.Tests.Legality;
public class BreedTests
{
private const int MovesetCount = 4; // Four moves; zeroed empty slots.
private static void GetMoves(Span<Move> moves, Span<int> result)
{
for (int i = 0; i < moves.Length; i++)
result[i] = (int) moves[i];
}
[Theory]
[InlineData(GD, Bulbasaur, 0, Tackle, Growl)]
[InlineData(SI, Igglybuff, 0, FeintAttack, Pound, Curse, ZapCannon)]
[InlineData( C, Igglybuff, 0, FeintAttack, Pound, Flamethrower, Sing)]
[InlineData( B, Heracross, 0, Megahorn, NightSlash, CloseCombat, StoneEdge)]
[InlineData( B, Heracross, 0, Bide, Megahorn, Counter, Reversal)]
[InlineData( B, Heracross, 0, HornAttack, Endure, Megahorn, TakeDown)]
[InlineData( B, Heracross, 0, Endure, Megahorn, FocusPunch, Feint)]
[InlineData( B, Heracross, 0, Megahorn, Reversal, Bulldoze, Fling)]
[InlineData( X, Growlithe, 0, Bite, Roar, FlareBlitz, MorningSun)]
[InlineData(OR, Growlithe, 0, MorningSun, IronTail, Crunch, HeatWave)]
[InlineData(OR, Dratini, 0, Wrap, Leer, DragonDance, ExtremeSpeed)]
[InlineData(OR, Rotom, 0, Astonish, ThunderWave, ThunderShock, ConfuseRay)]
[InlineData(BD, Gible, 0, IronHead, BodySlam, SandTomb, Outrage)]
[InlineData(BD, Gible, 0, IronHead, BodySlam, Outrage, SandTomb)]
[InlineData(BD, Gible, 0, BodySlam, Outrage, SandTomb, DragonBreath)]
public void VerifyBreed(GameVersion game, Species species, int form, params Move[] movelist)
{
var gen = game.GetGeneration();
Span<int> moves = stackalloc int[MovesetCount];
GetMoves(movelist, moves);
var origins = new byte[moves.Length];
var valid = MoveBreed.Validate(gen, (int) species, form, game, moves, origins);
valid.Should().BeTrue();
var x = origins;
if (gen != 2)
x.SequenceEqual(x.OrderBy(z => z)).Should().BeTrue();
else
x.SequenceEqual(x.OrderBy(z => z != (byte)EggSource2.Base)).Should().BeTrue();
}
[Theory]
[InlineData(C, Igglybuff, 0, Charm, DefenseCurl, Sing, Flamethrower)] // invalid push-out order
[InlineData(SH, Honedge, 0, FuryCutter, WideGuard, DestinyBond)] // insufficient move count
[InlineData(OR, Rotom, 0, Discharge, Charge, Trick, ConfuseRay)] // invalid push-out order
[InlineData(OR, Rotom, 0, ThunderWave, ThunderShock, ConfuseRay, Discharge)] // no inheriting levelup
public void CheckBad(GameVersion game, Species species, int form, params Move[] movelist)
{
var gen = game.GetGeneration();
Span<int> moves = stackalloc int[MovesetCount];
GetMoves(movelist, moves);
Span<byte> result = stackalloc byte[moves.Length];
var test = MoveBreed.Validate(gen, (int)species, form, game, moves, result);
test.Should().BeFalse();
}
[Theory]
[InlineData(GD, Bulbasaur, 0, Growl, Tackle)] // swap order, two base moves
[InlineData(UM, Charmander, 0, Ember, BellyDrum, Scratch, Growl)] // swap order, inherit + egg moves
[InlineData(BD, Gible, 0, BodySlam, SandTomb, Outrage, DragonBreath)]
public void CheckFix(GameVersion game, Species species, int form, params Move[] movelist)
{
var gen = game.GetGeneration();
Span<int> moves = stackalloc int[MovesetCount];
GetMoves(movelist, moves);
Span<byte> result = stackalloc byte[moves.Length];
var valid = MoveBreed.Validate(gen, (int)species, form, game, moves, result);
valid.Should().BeFalse();
Span<int> expected = stackalloc int[moves.Length];
var useNew = MoveBreed.GetExpectedMoves(gen, (int)species, form, game, moves, result, expected);
useNew.Should().BeTrue();
// fixed order should be different now.
expected.SequenceEqual(moves).Should().BeFalse();
// nonzero move count should be same
expected.Count(0).Should().Be(moves.Count(0));
}
}