NocList

From Mission Impossible

https://missionimpossiblefanon.fandom.com/wiki/NOC_List

Build a Working Environment

$ python3 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade pip
$ pip install poetry==1.7.1
$ poetry install
$ pip install -e .

Test

Noclist server should not be up and running during testing.

To test, just run pytest.

$ pytest

A coverage report is created in HTML format in the htmlcov folder.

Running the App

Optionally set an environment variables.

NOCLIST_TIMEOUT

The default timeout is 2 seconds.

export NOCLIST_TIMEOUT=1.0

BADSEC_SERVER

The default is http://localhost:8888.

export BADSEC_SERVER=<url>

Start a BADLIST server. This image is not versioned. This app is known to work with the version from May of 2018 (digest c23f36fccfc).

https://hub.docker.com/r/adhocteam/noclist

docker run --rm -p 8888:8888 adhocteam/noclist

Open a new terminal. Send logging to /dev/null.

source venv/bin/activate
python -m src.noclist 2>/dev/null

Debugging output is sent to stderr.

Development

This project uses pre-commit with several quality checks:

• black
• commitizen
• isort
• pyupgrade
• pylint
• mypy
• pytest

These checks must pass before a developer can commit a change.

$ pre-commit install
$ mypy

The developer may also run mypy manually to make sure typing hints are followed.

Design Principals

• Lean on functional programming over object-oriented.
• Avoid global variables.
• Avoid exceptions.
• Use Optional "monad".
• Keep functions small.
• Do not use external libraries unless needed.
• Avoid state in classes.

Other

This project was created based on the templatr template.

https://github.com/openbrian/templatr