Change wording on a chaos experiment execution that finds a weakness from "failed" to "complete"

[chaostoolkit]

Change wording on a chaos experiment execution that finds a weakness from "failed" to "complete"

[Lawouach]

This should be discussed as part of the API I think http://chaostoolkit.org/reference/api/journal/#format

[ksolie]

Will this affect how the notifications work? I'm assuming there will need to be a change to the event filter to something like run-weakness instead of run-failed

[Lawouach]

Hey @ksolie, that's a good catch.

I'm tempted to consider the wording @russmiles is considering to be about the narrative of the log output. Event wise, I'm not sure we can emit an event that says "weakness found", but certainly something saying "didn't go according to plan" which I thought failed would convey better.

thoughts?

[ksolie]

After looking at it closer I agree with you

[Lawouach]

We have been talking about this and we have settled for "deviated" rather than "failed".

Looking at the code, there is a risk of breaking compatibility here. The displayed text comes from the status we set in the journal. While we could add a if-statement when we are ine "failed" mode so that we display "deviated" instead (not pretty but easy enough). We would also change the wording entirely in the journal but there is a risk that we start confusing downstreams when they anticipated failed and we return deviated (vice versa).

So my take is to remain simple here and we can enhance our specification in the future to accomodate those differences.

[Lawouach]

Hey @ksolie, would you mind having a look at the following PRs as well please, since you were interested in this issue:

chaostoolkit/chaostoolkit-lib#56
#78

Cheers

[Lawouach]

I think the changes are backwrad compatible and are only additive.

[ksolie]

They LGTM

[Lawouach]

Thanks!