[YARN-11429] Improve updateTestDataAutomatically in TestRMWebServicesCapacitySched

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.4.0
• Fix Version/s: 3.4.0
• Component/s: yarn
• Labels: pull-request-available
• Target Version/s: 3.4.0
• Hadoop Flags: Reviewed
• Assignee: Tamas Domok
• Reporter: Tamas Domok
• Created: 10/Feb/23 09:17
• Updated: 25/Jan/24 14:58
• Resolved: 14/Jun/23 13:58

Description

The updateTestDataAutomatically helper function should have a fix json format to be useful.

    String actual = json.toString(2);
    updateTestDataAutomatically(expectedResourceFilename, actual);
    assertEquals(
        prettyPrintJson(getResourceAsString(expectedResourceFilename)),
        prettyPrintJson(actual));

The comparison is working with different json formats which is all right, but updating the test data should be easy, and the git diff should be easily readable by humans.

Something like this could work:

String actual = prettyPrintJson(json.toString(2));
updateTestDataAutomatically(expectedResourceFilename, actual);
assertEquals(
    getResourceAsString(expectedResourceFilename),
    actual);

The json's must be updated unfortunately with the new format.

The defaults shouldn't change here. Maybe we should be even more explicit with the format options:

  private static String prettyPrintJson(String in) throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper
        .writerWithDefaultPrettyPrinter()
        .writeValueAsString(objectMapper.readTree(in));
  }

Issue Links

• links to: GitHub Pull Request #5736