Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(tests): Restructure HighlightsSpec #259

Merged
merged 2 commits into from
Jun 24, 2023
Merged

(tests): Restructure HighlightsSpec #259

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da29137
Restructure HighlightsSpec.scala
Jun 24, 2023
d52416b
Rename map->config, split value assignment to two lines
Jun 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
212 changes: 108 additions & 104 deletions modules/library/src/test/scala/zio/elasticsearch/HighlightsSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,102 +12,139 @@ import zio.test.{Spec, TestEnvironment, ZIOSpecDefault, assert}
object HighlightsSpec extends ZIOSpecDefault {
def spec: Spec[TestEnvironment, Any] =
suite("Highlight")(
suite("creating Highlight")(
test("successfully create Highlight with only field given without config") {
assert(highlight("day_of_week"))(
suite("constructing")(
test("highlight") {
val highlightObject = highlight(field = "day_of_week")
val highlightWithGlobalConfig =
highlight(field = "day_of_week").withGlobalConfig(field = "type", Str("plain"))
val highlightWithHighlight = highlight(field = "day_of_week").withHighlight(field = "first_name")
val highlightWithMap = highlight(
mihajlo-ra92 marked this conversation as resolved.
Show resolved Hide resolved
field = "day_of_week",
config = Map("type" -> Str("plain"))
)
val highlightWithMapAndGlobalConfig = highlight(
mihajlo-ra92 marked this conversation as resolved.
Show resolved Hide resolved
field = "day_of_week",
config = Map("type" -> Str("plain"))
).withGlobalConfig(field = "pre_tags", Arr(Str("<tag1>")))
val highlightOfStringField = highlight(field = TestSubDocument.stringField)
val highlightOfStringFieldWithHighlight =
highlight(field = TestSubDocument.stringField).withHighlight(TestSubDocument.intField)
val highlightOfStringFieldWithGlobalConfig =
highlight(field = TestSubDocument.stringField).withGlobalConfig("type", value = Str("plain"))
val highlightOfNestedFieldWithGlobalConfig = highlight(field =
TestSubDocument.nestedField / TestNestedField.stringField
).withGlobalConfig("type", value = Str("plain"))

assert(highlightObject)(
equalTo(
Highlights(
fields = Chunk(HighlightField("day_of_week"))
)
)
)
},
test("successfully create Highlight with two fields given without config") {
assert(highlight("day_of_week").withHighlight("first_name"))(
) &&
assert(highlightWithHighlight)(
equalTo(
Highlights(
fields = Chunk(HighlightField("first_name"), HighlightField("day_of_week"))
)
)
)
},
test("successfully create Highlight with only one field given with global config") {
assert(highlight("day_of_week").withGlobalConfig("type", Str("plain")))(
) &&
assert(highlightWithGlobalConfig)(
equalTo(
Highlights(
fields = Chunk(HighlightField("day_of_week")),
config = Map("type" -> Str("plain"))
)
)
)
},
test("successfully create Highlight with only one field given with field config") {
assert(highlight("day_of_week", Map("type" -> Str("plain"))))(
) &&
assert(highlightWithMap)(
equalTo(
Highlights(
fields = Chunk(HighlightField("day_of_week", Map("type" -> Str("plain"))))
)
)
)
},
test("successfully create Highlight with only field given with both global and field config") {
) &&
assert(
highlight("day_of_week", Map("type" -> Str("plain"))).withGlobalConfig("pre_tags", Arr(Str("<tag1>")))
highlightWithMapAndGlobalConfig
)(
equalTo(
Highlights(
fields = Chunk(HighlightField("day_of_week", Map("type" -> Str("plain")))),
config = Map("pre_tags" -> Arr(Str("<tag1>")))
)
)
)
}
),
suite("creating Highlight using accessors from Schema")(
test("successfully create Highlight with only field given without config") {
assert(highlight(TestSubDocument.stringField))(
) &&
assert(highlightOfStringField)(
equalTo(
Highlights(
fields = Chunk(HighlightField("stringField"))
)
)
)
},
test("successfully create Highlight with two fields given without config") {
assert(highlight(TestSubDocument.stringField).withHighlight(TestSubDocument.intField))(
) &&
assert(highlightOfStringFieldWithHighlight)(
equalTo(
Highlights(
fields = Chunk(HighlightField("intField"), HighlightField("stringField"))
)
)
)
},
test("successfully create Highlight with nested field ") {
) &&
assert(
highlight(TestSubDocument.nestedField / TestNestedField.stringField).withGlobalConfig("type", Str("plain"))
highlightOfNestedFieldWithGlobalConfig
)(
equalTo(
Highlights(
fields = Chunk(HighlightField("nestedField.stringField")),
config = Map("type" -> Str("plain"))
)
)
)
},
test("successfully create Highlight with one field given with global config") {
assert(highlight(TestSubDocument.stringField).withGlobalConfig("type", Str("plain")))(
) &&
assert(highlightOfStringFieldWithGlobalConfig)(
equalTo(
Highlights(
fields = Chunk(HighlightField("stringField")),
config = Map("type" -> Str("plain"))
)
)
)

}
),
suite("encoding Highlight as JSON")(
test("properly encode Highlight with only field given without config") {
val highlightObject = highlight("day_of_week")
suite("encoding as JSON")(
test("highlight") {
val highlightObject = highlight(field = "day_of_week")
val highlightWithHighlight = highlight(field = "day_of_week").withHighlight(field = "first_name")
val highlightWithHighlightAndGlobalConfig = highlight(field = "day_of_week")
.withHighlight(field = "first_name")
.withGlobalConfig(field = "type", Str("plain"))
val highlightWithMap =
highlight("day_of_week", config = Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
val highlightWithMapAndHighlight =
highlight("day_of_week", config = Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
.withHighlight(
"first_name",
Map("matched_fields" -> Arr(Str("comment"), Str("comment.plain")), "type" -> Str("fvh"))
)
val highlightWithMapHighlightAndExplicitFieldOrder =
highlight("day_of_week", config = Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
.withHighlight(
"first_name",
Map("matched_fields" -> Arr(Str("comment"), Str("comment.plain")), "type" -> Str("fvh"))
)
.withExplicitFieldOrder
val highlightWithMultipleGlobalConfig =
highlight("day_of_week", Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
.withGlobalConfig("type", Str("fvh"))
.withGlobalConfig("fragment_size", Num(150))
.withHighlight(
field = "first_name",
config = Map("matched_fields" -> Arr(Str("comment"), Str("comment.plain")), "type" -> Str("fvh"))
)
.withHighlight("last_name")

val expected =
"""
|{
Expand All @@ -116,12 +153,7 @@ object HighlightsSpec extends ZIOSpecDefault {
| }
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
},
test("properly encode Highlight with two fields given without config") {
val highlightObject = highlight("day_of_week").withHighlight("first_name")
val expected =
val expectedWithFirstName =
"""
|{
| "fields" : {
Expand All @@ -130,13 +162,7 @@ object HighlightsSpec extends ZIOSpecDefault {
| }
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
},
test("properly encode Highlight with two fields given with global config") {
val highlightObject =
highlight("day_of_week").withHighlight("first_name").withGlobalConfig("type", Str("plain"))
val expected =
val expectedPlainWithFirstName =
"""
|{
| "type" : "plain",
Expand All @@ -146,14 +172,7 @@ object HighlightsSpec extends ZIOSpecDefault {
| }
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
},
test("properly encode Highlight with one field given with both global and field config") {
val highlightObject =
highlight("day_of_week", config = Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
val expected =
val expectedPlainWithRequiredFieldMatch =
"""
|{
| "type" : "plain",
Expand All @@ -164,18 +183,7 @@ object HighlightsSpec extends ZIOSpecDefault {
| }
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
},
test("properly encode Highlight with two fields given with both having global and field config") {
val highlightObject =
highlight("day_of_week", Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
.withHighlight(
"first_name",
Map("matched_fields" -> Arr(Str("comment"), Str("comment.plain")), "type" -> Str("fvh"))
)
val expected =
val expectedPlainWithMatchedFields =
"""
|{
| "type" : "plain",
Expand All @@ -190,21 +198,7 @@ object HighlightsSpec extends ZIOSpecDefault {
| }
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
},
test(
"properly encode Highlight with two fields given with both having global and field config and explicit order"
) {
val highlightObject =
highlight("day_of_week", Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
.withHighlight(
"first_name",
Map("matched_fields" -> Arr(Str("comment"), Str("comment.plain")), "type" -> Str("fvh"))
)
.withExplicitFieldOrder
val expected =
val expectedPlainWithArrayOfFields =
"""
|{
| "type" : "plain",
Expand All @@ -221,21 +215,7 @@ object HighlightsSpec extends ZIOSpecDefault {
| ]
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
},
test("properly encode Highlight with three fields and multiple configurations") {
val highlightObject =
highlight("day_of_week", Map("require_field_match" -> Bool(false)))
.withGlobalConfig("type", Str("plain"))
.withGlobalConfig("type", Str("fvh"))
.withGlobalConfig("fragment_size", Num(150))
.withHighlight(
field = "first_name",
config = Map("matched_fields" -> Arr(Str("comment"), Str("comment.plain")), "type" -> Str("fvh"))
)
.withHighlight("last_name")
val expected =
val expectedFvhType =
"""
|{
| "type" : "fvh",
Expand All @@ -253,7 +233,31 @@ object HighlightsSpec extends ZIOSpecDefault {
|}
|""".stripMargin

assert(highlightObject.toJson)(equalTo(expected.toJson))
assert(highlightObject.toJson)(
equalTo(
expected.toJson
)
) &&
assert(highlightWithHighlight.toJson)(
equalTo(
expectedWithFirstName.toJson
)
) &&
assert(highlightWithHighlightAndGlobalConfig.toJson)(
equalTo(
expectedPlainWithFirstName.toJson
)
) &&
assert(highlightWithMap.toJson)(
equalTo(expectedPlainWithRequiredFieldMatch.toJson)
) &&
assert(highlightWithMapAndHighlight.toJson)(equalTo(expectedPlainWithMatchedFields.toJson)) &&
assert(highlightWithMapHighlightAndExplicitFieldOrder.toJson)(
equalTo(expectedPlainWithArrayOfFields.toJson)
) &&
assert(highlightWithMultipleGlobalConfig.toJson)(
equalTo(expectedFvhType.toJson)
)
}
)
)
Expand Down