知識庫 / Testing RSS 訂閱

assertJson(jsonString)
  .isEqualTo(EXPECTED_JSON_PATH);

Map<String, String> map = new HashMap<>();
map.put("name", "baeldung");

assertJson(map)
  .isEqualToYaml("name: baeldung");

assertYaml("name: baeldung")
  .isEqualTo(map);

assertJson(jsonString)
  .isNotNull()
  .isNotNumber()
  .isObject()
  .containsKey("name");

assertJson(jsonString)
  .at("/topics").hasSize(5);

assertJson(jsonString)
  .at("/isOnline").booleanNode().isTrue();

assertJson(jsonString)
  .at("/name").textContains("ael");

我們還可以通過 <em matches 來使用正則表達式：

assertJson(jsonString)
  .at("/name").matches("[A-Z].+");

此示例斷言name字段以大寫字母開頭。

3.3. 數字節點

對於數字節點，DSL 提供了一些有用的數值比較：

assertJson("{count: 12}")
  .at("/count").isBetween(1, 25);

我們還可以指定我們期望的 Java 數值類型：

assertJson("{height: 6.3}")
  .at("/height").isGreaterThanDouble(6.0);

isEqualTo 方法用於全樹匹配，因此，對於數值相等比較，我們使用 isNumberEqualTo：

assertJson("{height: 6.3}")
  .at("/height").isNumberEqualTo(6.3);

3.4. 數組節點

我們可以使用 <em isArrayContaining</em> 來測試數組的內容。

assertJson(jsonString)
  .at("/topics").isArrayContaining("Scala", "Spring");

這段代碼用於測試給定值的存在，並允許實際數組包含其他項。如果需要更精確的匹配，可以使用isArrayContainingExactlyInAnyOrder：

assertJson(jsonString)
   .at("/topics")
   .isArrayContainingExactlyInAnyOrder("Scala", "Spring", "Java", "Linux", "Kotlin");

我們還可以確保這需要完全按照特定順序執行：

assertJson(ACTUAL_JSON)
  .at("/topics")
  .isArrayContainingExactly("Java", "Spring", "Kotlin", "Scala", "Linux");

這是一種有效的方法，用於驗證包含原始值的數組的內容。當數組包含對象時，我們可能需要使用 isEqualTo 代替。

4. 全樹匹配

雖然我們可以使用多個特定字段的條件來構建斷言，以檢查 JSON 文檔的內容，但我們經常需要將整個文檔與另一個文檔進行比較。

<em>isEqualTo</em> 方法（或 <em>isNotEqualTo</em>）用於比較整個樹。 它可以與 <em>at</em> 方法結合使用，以移動到實際樹的子樹中，然後再進行比較：

assertJson(jsonString)
  .at("/topics")
  .isEqualTo("[ \"Java\", \"Spring\", \"Kotlin\", \"Scala\", \"Linux\" ]");

整棵樹比較在以下情況時可能會遇到問題：JSON 包含的數據是：

• 相同但順序不同
• 包含一些無法預測的值

通過使用一種方法來定製下一次 isEqualTo 操作，在where 處解決這些問題。

4.1. 添加鍵順序約束

以下是兩個看似相同的 JSON 文檔：

String actualJson = "{a:{d:3, c:2, b:1}}";
String expectedJson = "{a:{b:1, c:2, d:3}}";

我們應該注意的是，這並非嚴格的JSON格式。ModelAssert 允許我們使用 JavaScript 語法進行 JSON 表示，以及通常會引用字段名稱的 wire 格式。

這兩個文檔在“a” 鍵下完全相同，但順序不同。對它們的斷言將會失敗，因為 ModelAssert 默認採用嚴格的鍵順序。

通過添加 where 配置，我們可以放寬鍵順序規則：

assertJson(actualJson)
  .where().keysInAnyOrder()
  .isEqualTo(expectedJson);

這允許樹中的任何對象擁有與預期文檔不同的鍵順序，但仍然可以匹配。

可以將此規則限制到特定路徑：

assertJson(actualJson)
  .where()
    .at("/a").keysInAnyOrder()
  .isEqualTo(expectedJson);

這限制了 “keysInAnyOrder” 只到根對象中的 “a” 字段。

自定義比較規則的能力使我們能夠處理許多場景，其中確切的文檔產出無法完全控制或預測。

4.2. 釋放數組約束

如果我們的數組中值的順序可以變化，則可以為整個比較放鬆數組排序約束：

String actualJson = "{a:[1, 2, 3, 4, 5]}";
String expectedJson = "{a:[5, 4, 3, 2, 1]}";

assertJson(actualJson)
  .where().arrayInAnyOrder()
  .isEqualTo(expectedJson);

我們也可以將這個約束限制在一個路徑上，就像我們對 keysInAnyOrder 做了限制一樣。

4.3. 忽略路徑

我們的實際文檔可能包含一些字段，這些字段要麼不感興趣，要麼不可預測。我們可以添加一條規則來忽略這些路徑：

String actualJson = "{user:{name: \"Baeldung\", url:\"http://www.baeldung.com\"}}";
String expectedJson = "{user:{name: \"Baeldung\"}}";

assertJson(actualJson)
  .where()
    .at("/user/url").isIgnored()
  .isEqualTo(expectedJson);

我們應該注意的是，我們表達的路徑始終是相對於實際的 JSON 指針而言的。

實際中，“url” 字段已被忽略。

4.4. 忽略任何 GUID

我們之前僅使用 <em at</em> 來自定義特定文檔位置的比較規則。

<em path</em> 語法允許我們使用通配符描述規則應用的位置。當我們為比較的 <em where</em> 添加 <em at</em> 或 <em path</em> 條件時，我們還可以提供上面列出的任何字段斷言，以替代與預期文檔的並排比較。

String actualJson = "{user:{credentials:[" +
  "{id:\"a7dc2567-3340-4a3b-b1ab-9ce1778f265d\",role:\"Admin\"}," +
  "{id:\"09da84ba-19c2-4674-974f-fd5afff3a0e5\",role:\"Sales\"}]}}";
String expectedJson = "{user:{credentials:" +
  "[{id:\"???\",role:\"Admin\"}," +
  "{id:\"???\",role:\"Sales\"}]}}";

assertJson(actualJson)
  .where()
    .path("user","credentials", ANY, "id").isIgnored()
  .isEqualTo(expectedJson);

assertJson(actualJson)
  .where()
    .path(ANY_SUBTREE, "id").matches(GUID_PATTERN)
  .isEqualTo(expectedJson);

private static <T> WhereDsl<T> idsAreGuids(WhereDsl<T> where) {
    return where.path(ANY_SUBTREE, "id").matches(GUID_PATTERN);
}

assertJson(actualJson)
  .where()
    .configuredBy(where -> idsAreGuids(where))
  .isEqualTo(expectedJson);

Matcher<String> matcher = json()
  .at("/name").hasValue("Baeldung");

MatcherAssert.assertThat(jsonString, json()
  .at("/name").hasValue("Baeldung")
  .at("/topics/1").isText("Spring"));

public interface DataService {
    boolean isUserLoggedIn(String userDetails);
}

@Mock
private DataService mockDataService;

@Test
void givenUserIsOnline_thenIsLoggedIn() {
    given(mockDataService.isUserLoggedIn(argThat(json()
      .at("/isOnline").isTrue()
      .toArgumentMatcher())))
      .willReturn(true);

    assertThat(mockDataService.isUserLoggedIn(jsonString))
      .isTrue();

    verify(mockDataService)
      .isUserLoggedIn(argThat(json()
        .at("/name").isText("Baeldung")
        .toArgumentMatcher()));
}