Skip to content

#671 rename with failure hint #970

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

Merged
robstoll merged 2 commits into from
Aug 30, 2021
Merged

#671 rename with failure hint #970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2270deb
Apply renaming of `with*FailureHint` -> `withHelpOn*Failure` for issu…
stevenlmcgraw Aug 27, 2021
74d5d92
Merge branch 'master' of github.com:stevenlmcgraw/atrium into #671-re…
stevenlmcgraw Aug 27, 2021
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
75 changes: 69 additions & 6 deletions ...ommon/src/main/kotlin/ch/tutteli/atrium/assertions/builders/descriptiveWithFailureHint.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,22 @@ import ch.tutteli.atrium.reporting.translating.Translatable
* Option to create a [DescriptiveAssertion] like assertion with an additional hint which might be shown if the
* [Descriptive.DescriptionOption.test] fails.
*
* You can use [withFailureHintBasedOnSubject] or [withFailureHintBasedOnDefinedSubject]
* You can use [withHelpOnFailureBasedOnSubject] or [withHelpOnFailureBasedOnDefinedSubject]
* in case your [DescriptiveAssertion] is based on the subject.
*/
fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailure(
failureHintFactory: () -> Assertion
): DescriptiveAssertionWithFailureHint.ShowOption =
DescriptiveAssertionWithFailureHint.ShowOption.create(test, failureHintFactory)

/**
* Option to create a [DescriptiveAssertion] like assertion with an additional hint which might be shown if the
* [Descriptive.DescriptionOption.test] fails.
*
* You can use [withHelpOnFailureBasedOnSubject] or [withHelpOnFailureBasedOnDefinedSubject]
* in case your [DescriptiveAssertion] is based on the subject.
*/
@Deprecated("Use withHelpOnFailure; will be removed with 1.0.0")
fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHint(
failureHintFactory: () -> Assertion
): DescriptiveAssertionWithFailureHint.ShowOption =
Expand All @@ -27,20 +40,50 @@ fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHint(
* which is based on the subject of the expectation and
* which is only shown the subject is defined.
*
* You can use [withFailureHintBasedOnSubject] in case you want to:
* You can use [withHelpOnFailureBasedOnSubject] in case you want to:
* - provide a hint also if the subject is absent.
* - do not show the hint in certain cases even if the subject is defined
*
* Or use [withFailureHint] which does not expect a [subjectProvider] in case your [DescriptiveAssertion] is not based
* Or use [withHelpOnFailure] which does not expect a [subjectProvider] in case your [DescriptiveAssertion] is not based
* on the subject of the expectation.
*/
//TODO if we introduce Record or something else as replacement for Assertion then not but if we keep Assertion
// then move to logic and expect ProofContainer with 0.18.0
fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailureBasedOnDefinedSubject(
expect: Expect<T>,
failureHintFactory: (T) -> Assertion
): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep> {
return withHelpOnFailureBasedOnSubject(expect) {
ifDefined(failureHintFactory)
.ifAbsent {
assertionBuilder.explanatoryGroup
.withWarningType
.withExplanatoryAssertion(Text(SHOULD_NOT_BE_SHOWN_TO_THE_USER_BUG))
.build()
}
}.showOnlyIfSubjectDefined(expect)
}

/**
* Option to create a [DescriptiveAssertion] like assertion with an additional hint
* which is based on the subject of the expectation and
* which is only shown the subject is defined.
*
* You can use [withHelpOnFailureBasedOnSubject] in case you want to:
* - provide a hint also if the subject is absent.
* - do not show the hint in certain cases even if the subject is defined
*
* Or use [withHelpOnFailure] which does not expect a [subjectProvider] in case your [DescriptiveAssertion] is not based
* on the subject of the expectation.
*/
//TODO if we introduce Record or something else as replacement for Assertion then not but if we keep Assertion
// then move to logic and expect ProofContainer with 0.18.0
@Deprecated("Use withHelpOnFailureBasedOnDefinedSubject; will be removed with 1.0.0")
fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHintBasedOnDefinedSubject(
expect: Expect<T>,
failureHintFactory: (T) -> Assertion
): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep> {
return withFailureHintBasedOnSubject(expect) {
return withHelpOnFailureBasedOnSubject(expect) {
Copy link
Owner

@robstoll robstoll Aug 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would delegate to withHelpOnFailureBasedOnDefinedSubject but also fine like this

Copy link
Contributor Author

@stevenlmcgraw stevenlmcgraw Aug 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @robstoll! I can change that if you would like for me to do so - I was just flipping any old with*failureHint method names to the new equivalent on all of the usages I could find to make sure I didn't introduce any unexpected changes. I'll adjust this on your signal.

ifDefined(failureHintFactory)
.ifAbsent {
assertionBuilder.explanatoryGroup
Expand All @@ -56,13 +99,33 @@ fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHintBase
* (which is based on the subject of the expectation)
* which might be shown if the [Descriptive.DescriptionOption.test] fails.
*
* You can use [withFailureHint] which does not expect a [expect] in case your [DescriptiveAssertion] is not based
* You can use [withHelpOnFailure] which does not expect a [expect] in case your [DescriptiveAssertion] is not based
* on the subject of the expectation.
*/
fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailureBasedOnSubject(
expect: Expect<T>,
failureHintSubStep: DescriptiveAssertionWithFailureHint.FailureHintSubjectDefinedOption<T>.() -> Pair<() -> Assertion, (T) -> Assertion>
): DescriptiveAssertionWithFailureHint.ShowOption = withHelpOnFailure {
SubjectBasedOption(
expect,
failureHintSubStep,
DescriptiveAssertionWithFailureHint.FailureHintSubjectDefinedOption.Companion::create
)
}

/**
* Option to create a [DescriptiveAssertion] like assertion with an additional hint
* (which is based on the subject of the expectation)
* which might be shown if the [Descriptive.DescriptionOption.test] fails.
*
* You can use [withHelpOnFailure] which does not expect a [expect] in case your [DescriptiveAssertion] is not based
* on the subject of the expectation.
*/
@Deprecated("Use withHelpOnFailureBasedOnSubject; will be removed with 1.0.0")
fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHintBasedOnSubject(
expect: Expect<T>,
failureHintSubStep: DescriptiveAssertionWithFailureHint.FailureHintSubjectDefinedOption<T>.() -> Pair<() -> Assertion, (T) -> Assertion>
): DescriptiveAssertionWithFailureHint.ShowOption = withFailureHint {
): DescriptiveAssertionWithFailureHint.ShowOption = withHelpOnFailure {
SubjectBasedOption(
expect,
failureHintSubStep,
Expand Down
2 changes: 1 addition & 1 deletion ...trium-core-common/src/main/kotlin/ch/tutteli/atrium/creating/impl/CollectingExpectImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ internal class CollectingExpectImpl<T>(
} else {
allAssertions.add(assertionBuilder.descriptive
.failing
.withFailureHint {
.withHelpOnFailure {
assertionBuilder.explanatoryGroup
.withDefaultType
.withAssertions(
Expand Down
14 changes: 7 additions & 7 deletions ...rc/test/kotlin/ch/tutteli/atrium/assertions/builders/DescriptiveWithBasedOnSubjectSpec.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ class DescriptiveWithBasedOnSubjectSpec : Spek({
.withDescriptionAndRepresentation("what ever", 1)
.build()
},
"withFailureHintBasedOnDefinedSubject" to addDescriptive { expect, builder ->
"withHelpOnFailureBasedOnDefinedSubject" to addDescriptive { expect, builder ->
builder.failing
.withFailureHintBasedOnDefinedSubject(expect) {
.withHelpOnFailureBasedOnDefinedSubject(expect) {
assertionBuilder.explanatory.withExplanation("asdf").build()
}
.withDescriptionAndRepresentation("what ever", 1)
.build()
},
"withFailureHintBasedOnSubject" to addDescriptive { expect, builder ->
"withHelpOnFailureBasedOnSubject" to addDescriptive { expect, builder ->
builder.failing
.withFailureHintBasedOnSubject(expect) {
.withHelpOnFailureBasedOnSubject(expect) {
ifDefined {
assertionBuilder.explanatory.withExplanation("asdf").build()
} ifAbsent {
Expand All @@ -43,7 +43,7 @@ class DescriptiveWithBasedOnSubjectSpec : Spek({
},
"showOnlyIf" to addDescriptive { expect, builder ->
builder.failing
.withFailureHint { assertionBuilder.explanatory.withExplanation("any hint").build() }
.withHelpOnFailure { assertionBuilder.explanatory.withExplanation("any hint").build() }
.showBasedOnSubjectOnlyIf(expect) {
ifDefined {
it < 3
Expand All @@ -54,14 +54,14 @@ class DescriptiveWithBasedOnSubjectSpec : Spek({
},
"showOnlyIfSubjectDefined" to addDescriptive { expect, builder ->
builder.failing
.withFailureHint { assertionBuilder.explanatory.withExplanation("any hint").build() }
.withHelpOnFailure { assertionBuilder.explanatory.withExplanation("any hint").build() }
.showOnlyIfSubjectDefined(expect)
.withDescriptionAndRepresentation("what ever", 1)
.build()
},
"showBasedOnDefinedSubjectOnlyIf" to addDescriptive { expect, builder ->
builder.failing
.withFailureHint { assertionBuilder.explanatory.withExplanation("any hint").build() }
.withHelpOnFailure { assertionBuilder.explanatory.withExplanation("any hint").build() }
.showBasedOnDefinedSubjectOnlyIf(expect) { it < 3 }
.withDescriptionAndRepresentation("what ever", 1)
.build()
Expand Down
4 changes: 2 additions & 2 deletions ...gic-common/src/main/kotlin/ch/tutteli/atrium/logic/impl/DefaultFloatingPointAssertions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package ch.tutteli.atrium.logic.impl
import ch.tutteli.atrium.assertions.Assertion
import ch.tutteli.atrium.assertions.ExplanatoryAssertion
import ch.tutteli.atrium.assertions.builders.assertionBuilder
import ch.tutteli.atrium.assertions.builders.withFailureHintBasedOnDefinedSubject
import ch.tutteli.atrium.assertions.builders.withHelpOnFailureBasedOnDefinedSubject
import ch.tutteli.atrium.core.polyfills.formatFloatingPointNumber
import ch.tutteli.atrium.core.polyfills.fullName
import ch.tutteli.atrium.creating.AssertionContainer
Expand Down Expand Up @@ -74,7 +74,7 @@ internal fun <T : Comparable<T>> toBeWithErrorTolerance(
): Assertion =
assertionBuilder.descriptive
.withTest(container.toExpect()) { absDiff(it) <= tolerance }
.withFailureHintBasedOnDefinedSubject(container.toExpect()) { subject ->
.withHelpOnFailureBasedOnDefinedSubject(container.toExpect()) { subject ->
//TODO 0.18.0 that's not nice in case we use it in an Iterable contains assertion, for instance contains...entry { toBeWithErrorTolerance(x, 0.01) }
//we do not want to see the failure nor the exact check in the 'an entry which...' part
//same problematic applies to feature assertions within an identification lambda
Expand Down
2 changes: 1 addition & 1 deletion ...ogic-common/src/main/kotlin/ch/tutteli/atrium/logic/impl/DefaultIterableLikeAssertions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ class DefaultIterableLikeAssertions : IterableLikeAssertions {
val (element, indices) = pair
assertionBuilder.descriptive
.failing
.withFailureHint {
.withHelpOnFailure {
assertionBuilder.explanatoryGroup
.withDefaultType
.withExplanatoryAssertion(
Expand Down
29 changes: 27 additions & 2 deletions ...rium-logic-jvm/src/main/kotlin/ch/tutteli/atrium/logic/creating/filesystem/hints/hints.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,46 @@ import java.nio.file.Path
import java.nio.file.attribute.*
import java.util.*

inline fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnIOExceptionFailure(
expect: Expect<IoResult<T>>,
crossinline f: (Path, IOException) -> Assertion?
): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep> =
withHelpOnFailureBasedOnDefinedSubject(expect) { result ->
explainForResolvedLink(result.path) { realPath ->
val exception = (result as Failure).exception
f(realPath, exception) ?: hintForIoException(realPath, exception)
}
}

@Deprecated("Use withHelpOnIOExceptionFailure; will be removed with 1.0.0")
inline fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withIOExceptionFailureHint(
expect: Expect<IoResult<T>>,
crossinline f: (Path, IOException) -> Assertion?
): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep> =
withFailureHintBasedOnDefinedSubject(expect) { result ->
withHelpOnFailureBasedOnDefinedSubject(expect) { result ->
explainForResolvedLink(result.path) { realPath ->
val exception = (result as Failure).exception
f(realPath, exception) ?: hintForIoException(realPath, exception)
}
}

fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFileAttributesFailure(
expect: Expect<IoResult<BasicFileAttributes>>
): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep> =
withHelpOnFailureBasedOnDefinedSubject(expect) { result ->
explainForResolvedLink(result.path) { realPath ->
when (result) {
is Success -> describeWas(result.value.fileType)
is Failure -> hintForIoException(realPath, result.exception)
}
}
}

@Deprecated("Use withHelpOnFileAttributesFailure; will be removed with 1.0.0")
fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withFileAttributesFailureHint(
expect: Expect<IoResult<BasicFileAttributes>>
): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep> =
withFailureHintBasedOnDefinedSubject(expect) { result ->
withHelpOnFailureBasedOnDefinedSubject(expect) { result ->
explainForResolvedLink(result.path) { realPath ->
when (result) {
is Success -> describeWas(result.value.fileType)
Expand Down
4 changes: 2 additions & 2 deletions ...ium-logic-jvm/src/main/kotlin/ch/tutteli/atrium/logic/impl/DefaultBigDecimalAssertions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ package ch.tutteli.atrium.logic.impl
import ch.tutteli.atrium.assertions.Assertion
import ch.tutteli.atrium.assertions.builders.assertionBuilder
import ch.tutteli.atrium.assertions.builders.withExplanatoryAssertion
import ch.tutteli.atrium.assertions.builders.withFailureHint
import ch.tutteli.atrium.assertions.builders.withHelpOnFailure
import ch.tutteli.atrium.creating.AssertionContainer
import ch.tutteli.atrium.logic.BigDecimalAssertions
import ch.tutteli.atrium.logic.createDescriptiveAssertion
Expand Down Expand Up @@ -37,7 +37,7 @@ class DefaultBigDecimalAssertions : BigDecimalAssertions {
): Assertion =
assertionBuilder.descriptive
.withTest(container.toExpect()) { it == expected }
.withFailureHint {
.withHelpOnFailure {
assertionBuilder.explanatoryGroup
.withInformationType(withIndent = true)
.withExplanatoryAssertion(
Expand Down
12 changes: 6 additions & 6 deletions logic/atrium-logic-jvm/src/main/kotlin/ch/tutteli/atrium/logic/impl/DefaultPathAssertions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ package ch.tutteli.atrium.logic.impl
import ch.tutteli.atrium.assertions.Assertion
import ch.tutteli.atrium.assertions.builders.assertionBuilder
import ch.tutteli.atrium.assertions.builders.invisibleGroup
import ch.tutteli.atrium.assertions.builders.withFailureHintBasedOnDefinedSubject
import ch.tutteli.atrium.assertions.builders.withHelpOnFailureBasedOnDefinedSubject
import ch.tutteli.atrium.core.None
import ch.tutteli.atrium.core.Some
import ch.tutteli.atrium.creating.AssertionContainer
Expand Down Expand Up @@ -63,7 +63,7 @@ class DefaultPathAssertions : PathAssertions {
changeSubjectToFileAttributes(container, linkOption) { fileAttributesExpect ->
assertionBuilder.descriptive
.withTest(fileAttributesExpect) { it is Success }
.withIOExceptionFailureHint(fileAttributesExpect) { realPath, exception ->
.withHelpOnIOExceptionFailure(fileAttributesExpect) { realPath, exception ->
when (exception) {
// TODO remove group once https://github.com/robstoll/atrium-roadmap/issues/1 is implemented
is NoSuchFileException -> assertionBuilder.explanatoryGroup
Expand All @@ -82,7 +82,7 @@ class DefaultPathAssertions : PathAssertions {
changeSubjectToFileAttributes(container, linkOption) { fileAttributesExpect ->
assertionBuilder.descriptive
.withTest(fileAttributesExpect) { it is Failure && it.exception is NoSuchFileException }
.withFileAttributesFailureHint(fileAttributesExpect)
.withHelpOnFileAttributesFailure(fileAttributesExpect)
.withDescriptionAndRepresentation(DescriptionBasic.NOT_TO, EXIST)
.build()
}
Expand Down Expand Up @@ -130,7 +130,7 @@ class DefaultPathAssertions : PathAssertions {
}.let { checkAccessResultExpect ->
assertionBuilder.descriptive
.withTest(checkAccessResultExpect) { it is Success }
.withIOExceptionFailureHint(checkAccessResultExpect) { realPath, exception ->
.withHelpOnIOExceptionFailure(checkAccessResultExpect) { realPath, exception ->
when (exception) {
is AccessDeniedException -> findHintForProblemWithParent(realPath)
?: assertionBuilder.explanatoryGroup
Expand All @@ -155,7 +155,7 @@ class DefaultPathAssertions : PathAssertions {
) = changeSubjectToFileAttributes(container, linkOption) { fileAttributesExpect ->
assertionBuilder.descriptive
.withTest(fileAttributesExpect) { it is Success && typeTest(it.value) }
.withFileAttributesFailureHint(fileAttributesExpect)
.withHelpOnFileAttributesFailure(fileAttributesExpect)
.withDescriptionAndRepresentation(DescriptionBasic.IS, typeName)
.build()
}
Expand Down Expand Up @@ -204,7 +204,7 @@ class DefaultPathAssertions : PathAssertions {
}.let { expectResult ->
assertionBuilder.descriptive
.withTest(expectResult) { it is Success && it.value.isEmpty() }
.withFailureHintBasedOnDefinedSubject(expectResult) { ioResult ->
.withHelpOnFailureBasedOnDefinedSubject(expectResult) { ioResult ->
explainForResolvedLink(ioResult.path) { realPath ->
when (ioResult) {
is Success -> {
Expand Down