Skip to content

Improve documentation of StopTest #55

Description

@Liam-DeVoe

The expected control flow around StopTest is currently very unclear in the docs.

Here's my description of StopTest from #hegel in the antithesis discord to start:

So, the right mental model for StopTest (which you should really think of as StopTestCase and we should rename) is that the server raises StopTest if it has decided to stop the current test case. The right thing for the client to do is abort the current test case iteration and move on to the next.

The client should not send mark_complete, because the server has already decided that test case is complete and has the right information about how to mark is as complete. For example, the most common (and possibly only?) reason the server raises StopTest is because the test case consumes too much entropy, in which case the right status - which the server knows and the client does not - is OVERRUN.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentwording and content on existing pages

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions