USACE / USACE/cwms-data-api

Rating Metadata DTO objects are missing serialization unit tests

Open
#231 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

The DTO objects for Rating Metadata (i.e. RatingMetadata, RatingMetadataList, TableRating, TransitionalRating, VirtualRating, UsgsStreamRating, ExpressionRating ) are missing unit tests related to serialization. See RatingSpecTest for an example of the type of tests that are missing.
Basically:
Can the types serialize into json
Can the types roundtrip through json
Can the types serialize into xml
Can the types roundtrip through xml
We should also add tests that deserialize from example resources.
Also should test that builder withXXX methods are putting the values in the right places.

Contributor guide

Open the contributing guide

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.

Research direction

Start by reading RatingSpecTest and locating the RatingMetadata, RatingMetadataList, TableRating, TransitionalRating, VirtualRating, UsgsStreamRating, and ExpressionRating DTOs. Add tests for JSON and XML serialization roundtrips, deserialization from example resources, and builder withXXX methods. Done means each listed DTO has coverage for these behaviors.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend-api-design, testing-qa
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.