Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JonJagger committed Jan 20, 2024
1 parent 533e151 commit 607a4d7
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 55 deletions.
37 changes: 7 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
7 changes: 0 additions & 7 deletions docs/blogs-todo.txt

This file was deleted.

18 changes: 0 additions & 18 deletions docs/code-todo.txt

This file was deleted.

Binary file added docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 607a4d7

Please sign in to comment.