Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add function on EitherAssert for chaining Left and Right into Non Empty Lists

Đang mở
#82 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
kotlin
Lĩnh vực
testing

Hướng nghiên cứu

Bắt đầu bằng cách đọc các API assertion hiện có của EitherAssert và NonEmptyList, sau đó so sánh các shortcut asLeftNel()/asRightNel() được đề xuất với cách tiếp cận trích xuất giá trị thay thế. Kiểm tra xem có cần một giải pháp tương tự cho Raise hay không và định nghĩa các assertion tập trung bao quát các trường hợp sử dụng Either và NonEmptyList được yêu cầu; issue cần có quyết định về thiết kế trước khi triển khai.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

While converting some more tests, I encountered another use case that feels like it could be a bit more accessible.

When you have code that uses NonEmptyLists inside Eithers, it's not terribly idiomatic to get them out in order to assert on them. For example

fun returnsNel(): Either<NonEmptyList<String>, Int> {
    return nonEmptyListOf("error", "other error")
}

@Test
fun assertOverLeftNel() {
    val result = returnsNel()

    // either assert
    assertThat(result).isLeft()
    val unwrappedResult = result.leftOrNull()!!

    // non empty list assert
    assertThat(unwrappedResult).contains("error", "other error")
}

either assert asLeft / containsLeftInstanceOf will give you an object assertion for the NonEmptyList, but there's no easy way to get to the underlying object in order to begin a NonEmptyList assertion. If you just want to do an assertion on the full list using equality you can do a assertThat(result).containsOnLeft(nonEmptyListOf("error", "other error") - but that's it, we're missing many of the other tools for NonEmptyList asserts such as just matching one element, matching on some elements, checking for sorting. I think combining Eithers/raises that then contain NonEmptyLists on the left side is a particularly common usecase in Arrow, see aliases such as EitherNel, and functions like bindNel

This is sort of also a limitation on the base library, as there's not really a super easy way to extract out a property of a complex object and get to its relevant special case assertions, however in practice I think this is particularly a bit more of pain here due to the ubiquitously wrapped nature of Eithers, that try to enforce safety.

I can think of two possible solutions for this, one would be to offer some shortcuts into the special case assertions, something like a asLeftNel() and asRightNel() option that would verify the Either had the appropriate side, was of type NonEmptyList, and launch right into the NonEmptyList assertions. So that would be used something like assertThat(result).asLeftNel().isSorted()

The other option would be a value that allows for assigning from an asLeft or asRight call. This could be a new method, like asLeftValue(), or an extension property on AbstractObjectAssertion like .value

I haven't directly encountered this for Raise, but given the Raise works with all the same orAccumulate patterns, I think it likely makes sense to complete a similar solution there.

At first blush I think I might lean towards the special case for NonEmptyLists of asLeftNel() - but would be open to input on what you think might make the most sense. I'm happy to work towards an implementation if this makes sense to you. Thanks!

Ngôn ngữ chính
Kotlin
Star
13
Fork
6
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của assertj/assertj-arrow-core

Tất cả issue của assertj/assertj-arrow-core

Issue tương tự

Thêm issue về Kotlin

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.