Skip to content

Add @DisplayName annotation to 3 Test files#2980

Closed
Omkarkanherkar wants to merge 1 commit intoexercism:mainfrom
Omkarkanherkar:main
Closed

Add @DisplayName annotation to 3 Test files#2980
Omkarkanherkar wants to merge 1 commit intoexercism:mainfrom
Omkarkanherkar:main

Conversation

@Omkarkanherkar
Copy link
Copy Markdown

Summary

Added @DisplayName annotations to three test files (BinaryTest, TriangleTest, RobotSimulatorTest) for improved readability and alignment with canonical data.

Motivation

This change makes test output more understandable when running with JUnit and aligns with the standard practices across other tracks.

Checklist

  • Manually edited test files.
  • Followed project contribution guidelines.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 3, 2025

This PR touches files which potentially affect the outcome of the tests of an exercise. This will cause all students' solutions to affected exercises to be re-tested.

If this PR does not affect the result of the test (or, for example, adds an edge case that is not worth rerunning all tests for), please add the following to the merge-commit message which will stops student's tests from re-running. Please copy-paste to avoid typos.

[no important files changed]

For more information, refer to the documentation. If you are unsure whether to add the message or not, please ping @exercism/maintainers-admin in a comment. Thank you!

public void singleDeposit() throws BankAccountActionInvalidException {
bankAccount.open();
bankAccount.deposit(100);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’d be preferred if these empty lines were left as-is in each test, no need to remove them.

}

@Disabled("Remove to run test")
@DisplayName("Deposit into account")
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've opened issue #2971 with all the details.

As per the discussion there, the DisplayNames should be aligned exactly with the canonical-data.json in the problem-specifications repo, please make sure to follow that!

Copy link
Copy Markdown
Member

@jagdish-15 jagdish-15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I’ve noticed that the initial PR message mentions three test files, and the title also refers to 3.
However, the actual changes have only been made to one file, and it's not even one of the three mentioned in the message.

Could you clarify what's going on here?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants