diff --git a/README.md b/README.md index 1b960c6..6db4112 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,12 @@ -[![Github Action (main)](https://github.com/kosli-dev/tdd-talk/actions/workflows/main.yml/badge.svg)](https://github.com/kosli-dev/tdd-talk/actions) - -The following blog posts link to this repo: -- [How to strangle old code using Python decorators](https://www.kosli.com/blog/how-to-strangle-old-code-using-python-decorators/) -- [Get Python system-test coverage faster by restarting your server](https://www.kosli.com/blog/getting-python-integration-test-coverage-without-killing-your-gunicorn-server/) -- [How to run your Python Flask server inside a readonly Docker container](https://www.kosli.com/blog/how-to-run-your-python-flask-server-inside-a-readonly-docker-container/) -- ... - -A public demo repo of -- [gunicorn](https://gunicorn.org/) running with multiple workers -- each worker running a simple [Flask](https://flask.palletsprojects.com/en/2.2.x/) web server (with an API) -- the web server scores the [XY Business Game](https://leanpub.com/experientiallearning4sampleexercises) by [Jerry Weinberg](http://jonjagger.blogspot.com/p/jerry-weinberg.html) -- the web server runs inside a read-only Docker container -- system tests with full branch coverage -- unit tests with full branch coverage - +Spike to try out Kosli CLI documentation idea. Work in progress. +After cloning this repo: ``` $ source scripts/shortcuts.sh +$ d +``` -$ rst # Run all System Tests in new server ~10s -$ est # Exec all System Tests in restarted server ~4s -$ rst 04692400 # Run only System Test 04692400 in new server -$ est 04692400 # Exec only System Test 04692400 in restarted server - -$ rut # Run all Unit Tests in new server ~10s -$ eut # Exec all Unit Tests in existing server ~1s -$ rut a2189600 # Run only Unit Test a2189600 in new server -$ eut a2189600 # Exec only Unit Test a2189600 in existing server +If port 80 is available, an html page will load in your default browser. +Hover and click over content to auto scroll related content into view. -$ ctc # gather Combined Test Coverage -$ demo # run a demo server on localhost:80 -$ hup # restart the demo server -$ tid # generate a test id -``` +[Screenshot](docs/screenshot.png) \ No newline at end of file diff --git a/docs/blogs-todo.txt b/docs/blogs-todo.txt deleted file mode 100644 index c42f0f8..0000000 --- a/docs/blogs-todo.txt +++ /dev/null @@ -1,7 +0,0 @@ - -Proposed TDD topics for talks/blogs - -o) combined system and unit tests coverage -o) runner the server as a non root user -o) gathering coverage stats for code and for _tests_ -o) using tests named with a GUID diff --git a/docs/code-todo.txt b/docs/code-todo.txt deleted file mode 100644 index d5a7339..0000000 --- a/docs/code-todo.txt +++ /dev/null @@ -1,18 +0,0 @@ - -# Core -Add combined coverage html report when unit/system tests are run -Fix server-log warning - 'FLASK_ENV' is deprecated and will not be used in Flask 2.3. Use 'FLASK_DEBUG' instead. -Fix server-log warning - The setup method 'add_url_rule' can no longer be called on the blueprint 'api'. It has already been registered at least once, any changes will not be applied consistently. - Make sure all imports, decorators, functions, etc. needed to set up the blueprint are done before registering it. - This warning will become an exception in Flask 2.3. -Add docker layer caching to CI main.yaml -Collect coverage of system tests themselves - Will require coverage combine on the .coverage files from _two_ containers -Run unit tests in parallel and run coverage combine - -# Maybe? -Make t fixture available to both system and unit tests -Document API call - diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..df170f8 Binary files /dev/null and b/docs/screenshot.png differ