A tool that allows network engineers to validate common changes and analyze their network using two popular network testing and analysis tools: pyATS and Batfish (TBD). NetCheck is built with a web UI and a RESTful API. The goal is to have full feature parity between the web UI and API, so that the user can interact with it however they wish.
This demo shows how a user can select specific testcases based on their testing requirements. Once testcases are selected, the user fills out the details under each testcase. The details section allows the user to document their expectations for each testcase result. Once the details are completed for each testcase, run the test, and you will see the test results under the 'Results' link.
custom_test_selection.mov
Upon installation, NetCheck works out of the box to help validate common changes and allow you to learn things about your network that you may not known before using the analysis portion of the tool.
The tool is built using Python and multiple Python libraries. Below is a breakdown of the different components used in this project.
The lists below may change in the future. I will try to keep it updated as the tool progresses.
Frontend:
- HTML 5
- Bootstrap CSS
- JavaScript/jQuery/jQuery UI
- htmx
Backend:
- FastAPI
- SQLModel
- SQLite
- pyATS/Genie
- Batfish (TBD)
Currently, there is not a "production-ready" deployment, as this project is not complete. All instructions below are for development purposes only.
- Clone the project repo.
git clone https://github.com/dannywade/netcheck.git
- Setup a Python virtual environment and install the project dependencies.
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
- Start a FastAPI dev server with uvicorn.
uvicorn main:app --reload
- Start a
redisDocker container. This is used to run background jobs.
docker run -it -p 6379:6379 redis
- Once redis is up and running, launch an
rqworker in a new terminal window.
rq worker --with-scheduler
With the FastAPI development web server, redis, and the rq worker running, you are ready to begin development. You can monitor the rq worker queue using the rq info command or using the RQ dashboard. These commands are optional, but very helpful to check on the progress of background jobs.