hitchstory

Executable documentation: Hitchstory is a type-safe StrictYAML python integration testing framework exploring some interesting ideas around this. https://hitchdev.com/hitchstory/ Example: https://hitchdev.com/hitchstory/using/behavior/run-single-na... Source: https://github.com/hitchdev/hitchstory/blob/master/hitch/sto... See also the explanation of self-rewriting tests: https://hitchdev.com/hitchstory/why/rewrite/

The skeleton test-generating-docs example I built to exhibit the framework actually does this. Here's an example: https://github.com/hitchdev/hitchstory/blob/master/examples/... It records a video while running the test and then at the end runs it through FFMPEG to make a smaller, slowed down GIF that can be embedded in the autogenerated docs. It's quite rudimentary though. I've been meaning to try making something more sophisticated and even potentially do additional automated video editing to inject text from the steps or something.

I built a Python/YAML framework around the ability to build these tests and then generate documentation from them. E.g. https://github.com/hitchdev/hitchstory/blob/master/examples%... which generates https://github.com/hitchdev/hitchstory/blob/master/examples%... When you show this stuff to other people and gather feedback - that's essentially what BDD is, too.

I built something like this too: https://github.com/hitchdev/hitchstory/blob/master/examples%...

I took the same "docs are tests and tests are docs" approach with integration testing when I created this library: https://github.com/hitchdev/hitchstory I realized at some point that a test and a how-to guide can and probably should actually be the same thing - not just for doctests (https://docs.python.org/3/library/doctest.html), but for every kind of test. It's not only 2x quicker to combine writing a test with writing docs, the test part and the docs part reinforce the quality of each other: * Tests are more easily understandable when you attach written context - the kind that is used when generating a readable how-to guide. * How to docs are better if they come attached to a guarantee that they're tested, not out of date and not missing crucial details. * Integration test driven development where how-to docs are created as a side ef

I have created a project for easily writing this type of test with YAML: https://github.com/hitchdev/hitchstory I dont think that this type of task is really appropriate for an LLM though. It is better to use hard, prewritten abstractions for the truly deterministic stuff (e.g. click). For other situations where you may need to do subtle trade offs (e.g. choosing an HTML selector for the search bar) an LLM will generally do a bad job.