netdiff 0.4

Install stable version from pypi

Install from pypi:

pip install netdiff

Install development version

Install tarball:

pip install https://github.com/ninuxorg/netdiff/tarball/master

Alternatively you can install via pip using git:

pip install -e git+git://github.com/ninuxorg/netdiff#egg=netdiff

If you want to contribute, install your cloned fork:

git clone git@github.com:<your_fork>/netdiff.git
cd netdiff
python setup.py develop

Basic Usage Example

Calculate diff of an OLSR 0.6.x topology:

from netdiff import OlsrParser
from netdiff import diff

old = OlsrParser('./stored-olsr.json')
new = OlsrParser('telnet://127.0.0.1:9090')
diff(old, new)

In alternative, you may also use the subtraction operator:

from netdiff import OlsrParser
from netdiff import diff

old = OlsrParser('./stored-olsr.json')
new = OlsrParser('telnet://127.0.0.1:9090')
old - new

The output will be an ordered dictionary with three keys:

• added

• removed

• changed

Each key will contain a dict compatible with the NetJSON NetworkGraph format representing respectively:

• the nodes and links that have been added to the topology

• the nodes and links that have been removed from the topology

• links that are present in both topologies but their weight changed

If no changes are present, keys will contain None.

So if between old and new there are no changes, the result will be:

{
    "added": None
    "removed": None,
    "changed": None
}

While if there are changes, the result will look like:

{
    "added": {
        "type": "NetworkGraph",
        "protocol": "OLSR",
        "version": "0.6.6",
        "revision": "5031a799fcbe17f61d57e387bc3806de",
        "metric": "ETX",
        "nodes": [
            {
                "id": "10.150.0.7"
            },
            {
                "id": "10.150.0.6"
            }
        ],
        "links": [
            {
                "source": "10.150.0.3",
                "target": "10.150.0.7",
                "weight": 1.50390625
            },
            {
                "source": "10.150.0.3",
                "target": "10.150.0.6",
                "weight": 1.0
            }
        ]
    },
    "removed": {
        "type": "NetworkGraph",
        "protocol": "OLSR",
        "version": "0.6.6",
        "revision": "5031a799fcbe17f61d57e387bc3806de",
        "metric": "ETX",
        "nodes": [
            {
                "id": "10.150.0.8"
            }
        ],
        "links": [
            {
                "source": "10.150.0.7",
                "target": "10.150.0.8",
                "weight": 1.0
            }
        ]
    },
    "changed": {
        "type": "NetworkGraph",
        "protocol": "OLSR",
        "version": "0.6.6",
        "revision": "5031a799fcbe17f61d57e387bc3806de",
        "metric": "ETX",
        "nodes": [],
        "links": [
            {
                "source": "10.150.0.3",
                "target": "10.150.0.2",
                "weight": 1.0
            }
        ]
    }
}

Parsers

Parsers are classes that extend netdiff.base.BaseParser and implement a parse method which is in charge of converting a python data structure into networkx.Graph object.

Parsers also have a json method which returns valid NetJSON output.

The available parsers are:

• netdiff.OlsrParser: parser for the olsrd jsoninfo plugin

• netdiff.BatmanParser: parser for the batman-advanced alfred tool

• netdiff.Bmx6Parser: parser for the BMX6 b6m tool

• netdiff.CnmlParser: parser for CNML 0.1

• netdiff.NetJsonParser: parser for the NetworkGraph NetJSON object.

from netdiff import BatmanParser
BatmanParser('./my-stored-topology.json')

from netdiff import NetJsonParser
url = 'https://raw.githubusercontent.com/interop-dev/netjson/master/examples/network-graph.json'
NetJsonParser(url)

from netdiff import OlsrParser
OlsrParser('telnet://127.0.1:8080', timeout=5)

from netdiff import NetJsonParser
OlsrParser('https://myserver.mydomain.com/topology.json', verify=False)

NetJSON output

Netdiff parsers can return a valid NetJSON NetworkGraph object:

from netdiff import OlsrParser

olsr = OlsrParser('telnet://127.0.0.1:9090')

# will return a dict
olsr.json(dict=True)

# will return a JSON formatted string
print(olsr.json(indent=4))

Output:

{
    "type": "NetworkGraph",
    "protocol": "OLSR",
    "version": "0.6.6",
    "revision": "5031a799fcbe17f61d57e387bc3806de",
    "metric": "ETX",
    "nodes": [
        {
            "id": "10.150.0.3"
        },
        {
            "id": "10.150.0.2"
        },
        {
            "id": "10.150.0.4"
        }
    ],
    "links": [
        {
            "source": "10.150.0.3",
            "target": "10.150.0.2",
            "weight": 2.4
        },
        {
            "source": "10.150.0.3",
            "target": "10.150.0.4",
            "weight": 1.0
        }
    ]
}

Exceptions

All the exceptions are subclasses of netdiff.exceptions.NetdiffException.

Running tests

Install your forked repo:

git clone git://github.com/<your_fork>/netdiff
cd netdiff/
python setup.py develop

Install test requirements:

pip install -r requirements-test.txt

Run tests with:

./runtests.py

Alternatively, you can use the nose command (which has a ton of available options):

nosetests
nosetests tests.test_olsr  # run only olsr related tests
nosetests tests/test_olsr.py  # variant form of the previous command
nosetests tests.test_olsr:TestOlsrParser  # variant form of the previous command
nosetests tests.test_olsr:TestOlsrParser.test_parse  # run specific test

See test coverage with:

coverage run --source=netdiff runtests.py && coverage report

Contributing

1. Join the ninux-dev mailing list

2. Fork this repo and install it

3. Follow PEP8, Style Guide for Python Code

4. Write code

5. Write tests for your code

6. Ensure all tests pass

7. Ensure test coverage is not under 90%

8. Document your changes

9. Send pull request