Tests share module state: add a shared loader that resets modules per test

Open
  • Is something wrong?
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript
Domain
testing

Research direction

Read tests/unit/game-moves.test.js and tests/integration/game-flow.test.js, then inspect the module-level DOM references in js/board.js and js/game.js. Implement the shared loader and position-builder described in the issue, update both test files, and run npm test and npm run lint. Done when consecutive loads are shown to be independent and both test files use the helper.

Written by the indexing model from the issue text.

Description

severity: medium testing

Summary

Each beforeEach builds a new JSDOM and then requires the game modules, but nothing calls jest.resetModules(). A second test in the same file would get the cached modules, which still hold the first test's DOM nodes and game state.

Where

  • tests/unit/game-moves.test.js:6-109, tests/integration/game-flow.test.js:6-116 (about 100 duplicated setup lines each)
  • js/board.js:5, js/game.js:17-18 (DOM nodes captured at module load)
  • js/game.js:27 (reset happens only when history is empty)

Details

This is from reading the code, assuming Jest's default of one module registry per test file; the suite was not run. It is invisible today only because each file holds exactly one test.

Impact

The first contributor who adds a second test to either file gets order-dependent failures or false passes. This blocks the test work in #41 and #42.

Suggested fix

Move the setup into one helper, for example tests/helpers/load-game.js, that calls jest.resetModules(), creates the JSDOM, sets the globals, requires the modules and returns { window, game, board }. Add a position-builder that places pieces on an empty board and sets king positions.

Acceptance criteria

  • Both existing test files use the helper
  • A test proves two consecutive loads are independent
  • A position-builder exists for non-starting positions

Getting started

  • Relevant files: tests/unit/game-moves.test.js, tests/integration/game-flow.test.js
  • How to run tests: npm install, then npm test and npm run lint
  • Related docs: docs/ARCHITECTURE.md, .github/CONTRIBUTING.md

Filed by repo-audit/full-audit at 8a2c86c. Severity: medium. Effort: S. audit-key: testing|tests/unit/game-moves.test.js|beforeEach

Dominant language
JavaScript
Stars
4
Forks
2
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TMHSDigital/Static_Chess

All issues in TMHSDigital/Static_Chess

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.