[Dev] Add mockHitCheck util (#3421)

* add mockHitCheck helper

* update docs

src/test/abilities/hustle.test.ts

@@ -8,7 +8,7 @@ import { Moves } from "#enums/moves";
 import { Species } from "#enums/species";
 import Phaser from "phaser";
 import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
-import { SPLASH_ONLY } from "#test/utils/testUtils";
+import { mockHitCheck, SPLASH_ONLY } from "#test/utils/testUtils";
 
 describe("Abilities - Hustle", () => {
   let phaserGame: Phaser.Game;
@@ -44,8 +44,7 @@ describe("Abilities - Hustle", () => {
     vi.spyOn(pikachu, "getBattleStat");
 
     game.doAttack(getMovePosition(game.scene, 0, Moves.TACKLE));
-    await game.phaseInterceptor.to(MoveEffectPhase, false);
+    await mockHitCheck(game, true);
-    vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
     await game.phaseInterceptor.to(DamagePhase);
 
     expect(pikachu.getBattleStat).toHaveReturnedWith(atk * 1.5);

src/test/abilities/libero.test.ts

@@ -2,7 +2,7 @@ import { allMoves } from "#app/data/move.js";
 import { Type } from "#app/data/type.js";
 import { Weather, WeatherType } from "#app/data/weather.js";
 import { PlayerPokemon } from "#app/field/pokemon.js";
-import { MoveEffectPhase, TurnEndPhase } from "#app/phases.js";
+import { TurnEndPhase } from "#app/phases.js";
 import { Abilities } from "#enums/abilities";
 import { BattlerTagType } from "#enums/battler-tag-type";
 import { Biome } from "#enums/biome";
@@ -12,7 +12,7 @@ import Phaser from "phaser";
 import { afterEach, beforeAll, beforeEach, describe, expect, test, vi } from "vitest";
 import GameManager from "#test/utils/gameManager";
 import { getMovePosition } from "#test/utils/gameManagerUtils";
-import { SPLASH_ONLY } from "#test/utils/testUtils";
+import { mockHitCheck, SPLASH_ONLY } from "#test/utils/testUtils";
 
 const TIMEOUT = 20 * 1000;
 
@@ -192,8 +192,7 @@ describe("Abilities - Protean", () => {
       expect(leadPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.TACKLE));
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
+      await mockHitCheck(game, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValueOnce(false);
       await game.phaseInterceptor.to(TurnEndPhase);
 
       const enemyPokemon = game.scene.getEnemyPokemon()!;

src/test/abilities/magic_guard.test.ts

@@ -1,8 +1,8 @@
-import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
 import Phaser from "phaser";
 import GameManager from "#test/utils/gameManager";
 import { Species } from "#enums/species";
-import { TurnEndPhase, MoveEffectPhase } from "#app/phases";
+import { TurnEndPhase } from "#app/phases";
 import { Moves } from "#enums/moves";
 import { ArenaTagType } from "#enums/arena-tag-type";
 import { ArenaTagSide, getArenaTag } from "#app/data/arena-tag";
@@ -11,7 +11,7 @@ import { Abilities } from "#enums/abilities";
 import { WeatherType } from "#app/data/weather.js";
 import { StatusEffect, getStatusEffectCatchRateMultiplier } from "#app/data/status-effect";
 import { BattlerTagType } from "#enums/battler-tag-type";
-import { SPLASH_ONLY } from "#test/utils/testUtils";
+import { mockHitCheck, SPLASH_ONLY } from "#test/utils/testUtils";
 
 const TIMEOUT = 20 * 1000; // 20 sec timeout
 
@@ -258,8 +258,7 @@ describe("Abilities - Magic Guard", () => {
     const leadPokemon = game.scene.getPlayerPokemon()!;
 
     game.doAttack(getMovePosition(game.scene, 0, Moves.HIGH_JUMP_KICK));
-    await game.phaseInterceptor.to(MoveEffectPhase, false);
+    await mockHitCheck(game, false);
-    vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValueOnce(false);
 
     await game.phaseInterceptor.to(TurnEndPhase);
 

src/test/abilities/parental_bond.test.ts

@@ -7,10 +7,10 @@ import { Abilities } from "#enums/abilities";
 import { Moves } from "#enums/moves";
 import { Species } from "#enums/species";
 import Phaser from "phaser";
-import { afterEach, beforeAll, beforeEach, describe, expect, test, vi } from "vitest";
+import { afterEach, beforeAll, beforeEach, describe, expect, test } from "vitest";
 import GameManager from "#test/utils/gameManager";
 import { getMovePosition } from "#test/utils/gameManagerUtils";
-import { SPLASH_ONLY } from "#test/utils/testUtils";
+import { mockHitCheck, SPLASH_ONLY } from "#test/utils/testUtils";
 
 const TIMEOUT = 20 * 1000;
 
@@ -129,10 +129,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.DOUBLE_HIT));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(BerryPhase, false);
 
@@ -175,9 +172,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.ROLLOUT));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase, false);
 
@@ -373,9 +368,7 @@ describe("Abilities - Parental Bond", () => {
       const enemyStartingHp = enemyPokemon.hp;
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.SUPER_FANG));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase);
 
@@ -404,9 +397,7 @@ describe("Abilities - Parental Bond", () => {
       const enemyStartingHp = enemyPokemon.hp;
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.SEISMIC_TOSS));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase);
 
@@ -432,9 +423,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.HYPER_BEAM));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase);
 
@@ -462,9 +451,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.ANCHOR_SHOT));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase);
 
@@ -494,9 +481,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.SMACK_DOWN));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase);
 
@@ -523,9 +508,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.U_TURN));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(MoveEffectPhase);
       expect(leadPokemon.turnData.hitCount).toBe(2);
@@ -549,9 +532,7 @@ describe("Abilities - Parental Bond", () => {
       expect(enemyPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.WAKE_UP_SLAP));
-
+      await mockHitCheck(game, true);
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(true);
 
       await game.phaseInterceptor.to(DamagePhase);
 

src/test/abilities/protean.test.ts

@@ -2,7 +2,7 @@ import { allMoves } from "#app/data/move.js";
 import { Type } from "#app/data/type.js";
 import { Weather, WeatherType } from "#app/data/weather.js";
 import { PlayerPokemon } from "#app/field/pokemon.js";
-import { MoveEffectPhase, TurnEndPhase } from "#app/phases.js";
+import { TurnEndPhase } from "#app/phases.js";
 import { Abilities } from "#enums/abilities";
 import { BattlerTagType } from "#enums/battler-tag-type";
 import { Biome } from "#enums/biome";
@@ -12,7 +12,7 @@ import Phaser from "phaser";
 import { afterEach, beforeAll, beforeEach, describe, expect, test, vi } from "vitest";
 import GameManager from "#test/utils/gameManager";
 import { getMovePosition } from "#test/utils/gameManagerUtils";
-import { SPLASH_ONLY } from "#test/utils/testUtils";
+import { mockHitCheck, SPLASH_ONLY } from "#test/utils/testUtils";
 
 const TIMEOUT = 20 * 1000;
 
@@ -192,8 +192,7 @@ describe("Abilities - Protean", () => {
       expect(leadPokemon).not.toBe(undefined);
 
       game.doAttack(getMovePosition(game.scene, 0, Moves.TACKLE));
-      await game.phaseInterceptor.to(MoveEffectPhase, false);
+      await mockHitCheck(game, false);
-      vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValueOnce(false);
       await game.phaseInterceptor.to(TurnEndPhase);
 
       const enemyPokemon = game.scene.getEnemyPokemon()!;

src/test/abilities/sweet_veil.test.ts

@@ -1,14 +1,14 @@
-import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
 import Phaser from "phaser";
 import GameManager from "#test/utils/gameManager";
 import { Species } from "#enums/species";
-import { CommandPhase, MoveEffectPhase, MovePhase, TurnEndPhase } from "#app/phases";
+import { CommandPhase, MovePhase, TurnEndPhase } from "#app/phases";
 import { Moves } from "#enums/moves";
 import { getMovePosition } from "#test/utils/gameManagerUtils";
 import { BattlerTagType } from "#app/enums/battler-tag-type.js";
 import { Abilities } from "#app/enums/abilities.js";
 import { BattlerIndex } from "#app/battle.js";
-import { SPLASH_ONLY } from "#test/utils/testUtils";
+import { mockHitCheck, SPLASH_ONLY } from "#test/utils/testUtils";
 
 describe("Abilities - Sweet Veil", () => {
   let phaserGame: Phaser.Game;
@@ -80,13 +80,11 @@ describe("Abilities - Sweet Veil", () => {
     game.doAttack(getMovePosition(game.scene, 1, Moves.SPLASH));
 
     // First pokemon move
-    await game.phaseInterceptor.to(MoveEffectPhase, false);
+    await mockHitCheck(game, true);
-    vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValueOnce(true);
 
     // Second pokemon move
     await game.phaseInterceptor.to(MovePhase, false);
-    await game.phaseInterceptor.to(MoveEffectPhase, false);
+    await mockHitCheck(game, true);
-    vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValueOnce(true);
 
     expect(game.scene.getPlayerField().some(p => !!p.getTag(BattlerTagType.DROWSY))).toBe(true);
 

src/test/utils/testUtils.ts

@@ -3,7 +3,7 @@ import i18next, { type ParseKeys } from "i18next";
 import { vi } from "vitest";
 import GameManager from "./gameManager";
 import { BattlerIndex } from "#app/battle.js";
-import { TurnStartPhase } from "#app/phases.js";
+import { MoveEffectPhase, TurnStartPhase } from "#app/phases.js";
 
 /** Ready to use array of Moves.SPLASH x4 */
 export const SPLASH_ONLY = [Moves.SPLASH, Moves.SPLASH, Moves.SPLASH, Moves.SPLASH];
@@ -54,3 +54,19 @@ export async function mockTurnOrder(game: GameManager, order: BattlerIndex[]): P
 
   vi.spyOn(game.scene.getCurrentPhase() as TurnStartPhase, "getOrder").mockReturnValue(order);
 }
+
+/**
+ * Intercepts `MoveEffectPhase` and mocks the hitCheck's return value {@linkcode MoveEffectPhase.hitCheck}.
+ * Used to force a move to either hit or miss.
+ * Note that this uses `mockReturnValue()`, meaning it will also apply to a
+ * succeeding `MoveEffectPhase` immediately following the first one
+ * (in the case of a multi-target move)
+ *
+ * @param {GameManager} game The GameManager instance
+ * @param shouldHit Whether the move should hit
+ */
+export async function mockHitCheck(game: GameManager, shouldHit: boolean): Promise<void> {
+  await game.phaseInterceptor.to(MoveEffectPhase, false);
+
+  vi.spyOn(game.scene.getCurrentPhase() as MoveEffectPhase, "hitCheck").mockReturnValue(shouldHit);
+}