Add `@DisplayName` to Test Methods in Practice Exercises

[jagdish-15]

📝 Issue Description

This issue aims to add @DisplayName() annotations for every test method in the test files of all practice exercises in the Java track.

🔧 What You Need to Do

1. Skip unsynced exercises:
   Before starting, make sure the exercise is not listed among the ones with unsynced tests in issue #2959.

2. Locate the test file:

   • Go to the exercise folder inside exercises/practice/<exercise-name>/src/test.
   • Open the Java test file (typically named <ExerciseName>Test.java).

3. Find the canonical source:

   • Navigate to the problem-specifications repo.
   • Open the corresponding exercise folder and locate canonical-data.json.

4. Match and annotate tests:

   • The test cases in the .json file are listed in a specific order.
   • Match the tests in the Java file with the ones in canonical-data.json.
   • For each test, copy the "description" and use it as a @DisplayName("") annotation above the corresponding method in the Java test file.

⚠️ Important Guidelines

• Max 15 exercises per PR:
  To avoid large PRs, limit the number of exercises being updated in each PR to a maximum of 15 exercises (less is ok too).

• Do not close this issue via PRs:
  Avoid referencing this issue in your PR with terms like Fixes #XXX or Resolves #XXX, since this would automatically close the issue.

• Avoid reimplemented exercises:
  Make sure you are not copying descriptions from tests that have been reimplemented.

• Need help?
  If you have any questions, feel free to ask in the comments!

---

📋 Checklist of Practice Exercises

• acronym
• affine-cipher
• all-your-base
• allergies
• alphametics
• anagram
• armstrong-numbers
• atbash-cipher
• bank-account
• binary-search-tree
• binary-search
• bob
• book-store
• bottle-song
• bowling
• change
• circular-2buffer
• clock
• collatz-conjecture
• complex-numbers
• connect
• crypto-square
• custom-set
• darts
• diamond
• difference-of-squares
• dnd-character
• dominoes
• dot-dsl
• eliuds-eggs
• error-handling
• etl
• flatten-array
• flower-field
• food-chain
• forth
• game-of-life
• gigasecond
• go-counting
• grade-school
• grains
• grep
• hamming
• hangman
• hello-world
• high-scores
• house
• isbn-verifier
• isogram
• killer-sudoku-helper
• kindergarten-garden
• knapsack
• largest-series-product
• leap
• ledger
• linked-list
• list-ops
• luhn
• markdown
• matching-brackets
• matrix
• mazy-mice
• meetup
• micro-blog
• nth-prime
• nucleotide-count
• ocr-numbers
• palindrome-products
• pangram
• parallel-letter-frequency
• pascals-triangle
• perfect-numbers
• phone-number
• piecing-it-together
• pig-latin
• poker
• pov
• prime-factors
• protein-translation
• proverb
• pythagorean-triplet
• queen-attack
• rail-fence-cipher
• raindrops
• rational-numbers
• react
• rectangles
• relative-distance
• resistor-color-duo
• resistor-color-trio
• resistor-color
• rest-api
• reverse-string
• rna-transcription
• robot-name
• robot-simulator
• roman-numerals
• rotational-cipher
• run-length-encoding
• saddle-points
• satellite
• say
• scrabble-score
• secret-handshake
• series
• sgf-parsing
• sieve
• simple-cipher
• simple-linked-list
• space-age
• spiral-matrix
• square-root
• state-of-tic-tac-toe
• sublist
• sum-of-multiples
• swift-scheduling
• tournament
• transpose
• tree-building
• triangle
• twelve-days
• two-bucket
• two-fer
• variable-length-quantity
• word-count
• word-search
• wordy
• yacht
• zebra-puzzle
• zipper

---

💡 Reference Example

To understand how to properly add @DisplayName annotations based on canonical-data.json, you can refer to the test file in the Swift Scheduling exercise.

It already includes correctly formatted @DisplayName entries matching the test case descriptions, making it a good template for how your test file should look after the changes.

[EmmanuelBerkowicz]

Hi @kahgoh & @jagdish-15

My name is Emmanuel and I'm relatively new to open source contributions. This looks like an excellent opportunity for me to improve my Java skills while contributing to Exercism, which has been incredibly helpful in my TypeScript learning journey.
I'd love to work on this issue and would appreciate being assigned to it. I understand the guidelines about:

• Limiting to max 15 exercises per PR
• Checking the unsynced exercises list in issue 🚨 configlet sync --test found unsynced tests #2959
• Matching test descriptions from canonical-data.json
• Not closing the issue via PR references

I'm planning to start with a smaller batch (maybe 5-10 exercises) for my first PR to get comfortable with the workflow, then continue with additional PRs as needed.
Could you please assign me to this issue? I'm excited to contribute and help improve the Java track's test documentation!
Thanks!

[kahgoh]

Thanks for taking this on @EmmanuelBerkowicz! I have just assigned this one to you.

[EmmanuelBerkowicz]

Hey @kahgoh ,
I've not used IntelliJ CheckStyle before.
It looks like that is the reason my pull request is not going through (ref attached image).
I've restarted my IDE with the plugin installed, and it's not showing anything different.
Is there anything obvious I might have overlooked or can do to push this through?

[kahgoh]

Sorry I'm not familar with the IntelliJ plugin, but I wonder if you need to do something to run it. With Gradle, you should also be to run it with ./gradlew check.

In terms of the error in the CI, this is specific error:

Error: eckstyle] [ERROR] /home/runner/work/java/java/exercises/practice/swift-scheduling/src/test/java/SwiftSchedulingTest.java:131: Line is longer than 120 characters (found 124). [LineLength]

[jagdish-15]

I've also added a few comments on the PR regarding this error!

[EmmanuelBerkowicz]

Thanks guys!
I've committed the suggested change :)

[jagdish-15]

@EmmanuelBerkowicz,
The PR is merged now! You can now start working on other exercises.

[EmmanuelBerkowicz]

hey @jagdish-15 ,
Is this closed?