https://github.com/eomielan/routing-protocols

Implementation of the link state and distance vector routing protocols
https://github.com/eomielan/routing-protocols

Last synced: about 2 months ago
JSON representation

Implementation of the link state and distance vector routing protocols

• Host: GitHub
• URL: https://github.com/eomielan/routing-protocols
• Owner: eomielan
• Created: 2024-08-16T06:07:10.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-18T04:43:19.000Z (4 months ago)
• Last Synced: 2024-08-18T05:22:29.813Z (4 months ago)
• Language: Python
• Homepage:
• Size: 166 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Routing Protocols

## Overview

This project is a Python implementation of the link state and distance vector routing protocols. There are two separate programs: one that implements the link state protocol, and one that implements the distance vector protocol. Both programs read and use the same file format for the network’s topology as well as the same format for messages to send.

## Instructions

1. Run `chmod +x dvr.sh lsr.sh` to make the scripts executable.

2. Run `python3 -m venv myenv` and then `source myenv/bin/activate` to start a virtual environment.

3. Run `pip install -r requirements.txt` in the virtual environment to install dependencies.

4. To start a simulation, run one of the following commands:

    #### Distance Vector Routing Protocol

    ```

    ./dvr.sh    [outputFile]

    ```

    Example:

    ```

    ./dvr.sh topology.txt message.txt changes.txt

    ```

    #### Link State Routing Protocol:

    ```

    ./lsr.sh    [outputFile]

    ```

    Example:

    ```

    ./lsr.sh topology.txt message.txt changes.txt

    ```

5. Run `pytest` to run the tests.

    

    **NOTE:** The tests require `dos2unix` to run on Linux. If you do not already have this package installed please run:

    ```bash

    sudo apt-get update

    sudo apt-get install dos2unix

    ```

6. Run `deactivate` to stop the virtual environment.

## Testing

We used [Pytest](https://docs.pytest.org/en/8.0.x/), a Python testing framework, to test our code. These test files can be found in the `test` directory.

To run the test suite:

1. Complete the first three steps in the instructions to ensure Pytest is installed.

2. In the command line, run `pytest` to start the test suite.

Note that you can run the test suite from the root or `test` directory.