Skip to content

Rename BasicUnaryUpdateExpressions and BasicMathTestSuite for naming consistency #338

Description

@YYDan

Description

Two suite scripts are inconsistently named against the rest of the project.

1. BasicUnaryUpdateExpressions is missing the TestSuite suffix. Every other one of the 47 registered suites ends in TestSuite. This is the only exception, and it makes the suite easy to miss in greps, glob patterns and tooling that keys on the naming convention — it was in fact missed in the first pass of this audit for exactly that reason. It should become BasicUnaryUpdateExpressionsTestSuite.

2. BasicMathTestSuite should be BasicMathsTestSuite. House spelling.

Both renames touch the same five places each:

  • the script folder under projects/xUnit/scripts/
  • the .gml file, and the constructor function name inside it
  • the .yy file, and its %Name and name fields
  • the asset entry in projects/xUnit/xUnit.yyp
  • the testFramework.addSuite(...) call in projects/xUnit/objects/objRunner/Create_0.gml

I have checked the rest of the repo: no CI workflow, Python tooling, config file or documentation hardcodes either suite name, and there are no configured --skip-tests patterns referencing them. objRunner/Create_0.gml also carries a single_test_path example pointing at BasicArrayTestSuite, which is unaffected.

One caveat worth noting: test results are keyed by suite name, so any stored result history, published report or Slack statistic will treat the renamed suites as new suites with no prior history. That is acceptable but should not come as a surprise when the first run after the merge lands.

Ordering: land this before #341, the BasicUnaryUpdateExpressions fact-splitting refactor, so that refactor does not have to be replayed across a moved file.

Renaming a script asset is best done through the GameMaker IDE rather than by hand, so the .yy and .yyp entries stay consistent.

Script Name

BasicUnaryUpdateExpressions, BasicMathTestSuite

Steps To The Task

  • Rename BasicUnaryUpdateExpressions to BasicUnaryUpdateExpressionsTestSuite via the GameMaker IDE
  • Rename BasicMathTestSuite to BasicMathsTestSuite via the GameMaker IDE
  • Confirm the constructor function name inside each .gml matches the new asset name
  • Confirm the %Name and name fields in each .yy match, and that xUnit.yyp points at the new paths
  • Update both testFramework.addSuite(...) calls in objRunner/Create_0.gml
  • Grep the repo for any remaining occurrence of the old names before opening the PR
  • Run the full framework on VM and YYC and confirm both suites are still discovered and report their expected test counts
  • Flag to whoever monitors the published reports that these two suites will appear as new entries with no prior history

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

refactorAn improvement to existing test/module code

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions