dnas

DNAS Code Details

Running and Testing DNAS

sudo apt-get install --no-install-recommends -y virtualenv

DATA_DIR="/opt/dnas_data/"
APP_DIR="/opt/dnas/"
VENV_DIR="./venv/"

cd "$APP_DIR"

if [ ! -d "$VENV_DIR" ]
then
    python3 -m virtualenv venv
fi
# Shellcheck can't follow "source" imports:
# shellcheck disable=SC1091
source venv/bin/activate

Redis

To run the code natively (not inside a container) a Redis instance is required. The best way is to spin up the existing redis container:

cd /opt/dnas
source venv/bin/activate
cd docker/
docker compose up -d dnas_redis

If you really need/want to, you can use the steps below to spin up a stand-alone Redis container. Note that DNAS expects to authenticate to Redis so set a password, and update the Redis hostname in redis_auth.py:

docker run -d -p 6379:6379 --name redis redis:latest
docker exec -it redis_dnas redis-cli
> CONFIG SET requirepass abc123
> CONFIG REWRITE

Python & PyPy

To run the DNAS code natively in Python3 outside of the container, install the required Python modules:

cd /opt/dnas/
source venv/bin/activate
cd ./dnas/
python3 -m pip install -r requirements.txt

The code is developed in Python3 but the DNAS container actually uses PyPy3 to run faster. The following commands manually install PyPy3 and the required modules in PyPy, to manually run the code outside of a container:

cd /opt/dnas/
source venv/bin/activate
cd ./dnas/

#pypy="https://downloads.python.org/pypy/pypy3.8-v7.3.7-aarch64.tar.bz2"
pypy_url="https://downloads.python.org/pypy/pypy3.8-v7.3.7-linux64.tar.bz2"
pypy_tar="$(basename $pypy_url)"
pypy_dir="${pypy_tar/.tar.bz2/}/"
wget "$pypy_url"
tar -xf $(basename "$pypy_tar")
rm $(basename "$pypy_tar")
sudo mv "$pypy_dir" /opt/

/opt/"$pypy_dir"/bin/pypy3 -m ensurepip
/opt/"$pypy_dir"/bin/pypy3 -mpip install --upgrade pip
/opt/"$pypy_dir"/bin/pypy3 -mpip install -r requirements.txt

Testing

Tox is used to provide linting (black and isort), type checking (mypy), and run unit tests (pyetst):

cd /opt/dnas/
source venv/bin/activate
python3 -m pip install tox
tox

Coding Style

Merge requests need to maintain the existing coding style¹ for consistency:

• Stringageddon: Currently all values from MRT files are strings so that there is a single uniform data type (AS Numbers are strings, IP prefixes are strings, AS paths are list of strings etc.).
• All Redis keys are also strings.

Footnotes

1. In the loosest sense ↩