2.5 KiB
Testing and Debugging
This page discusses the testing and debugging capabilities that come with Dragonflow.
Testing
After installing with devstack, there are a few tests that can be ran to verify Dragonflow was installed correctly.
Fullstack tests
The fullstack tests execute Neutron API commands, and then verifies the pipeline. This is done by creating relevant ports, simulating a plug-vif event, and then passing packets on these ports. The tests verify that packets are received if and only if they are supposed to, and that any necessary modification is done, e.g. replacing L2 addresses in L3 routing.
To run the tests:
> tox -e fullstackIt is possible to have the fullstack tests take authentication information from the environment variable, using e.g. an openrc file, such as provided by devstack or openstack-ansible.
To do so, set the environment variable DF_FULLSTACK_USE_ENV
> export DF_FULLSTACK_USE_ENV=1Debugging
There are a few tools that exist to debug Dragonflow. Most of them are geared towards verifying the pipeline was installed correctly.
> sudo ovs-ofctl dump-flows br-int -O OpenFlow13This command will display the pipeline that has been installed in OVS. See the manual page for ovs-ofctl for more info.
It is worthwhile to note that each flow contains statistics such as how many packets matched this flow, and what is the cumulative size.
> sudo ovs-appctl ofproto/trace br-int <flow>This command will simulate a packet matching the given flow through the pipeline. The perl script in1 can be used to facilitate the use of this tool. The script also recirculates the packet when necessary, e.g. for connection tracking.
> df-dbThis utility will allow to inspect Dragonflow northbound database. You can dump db content, list db tables, list db table keys and print value of the specific key in the table. Use df-db --help to list and get details on supported sub-commands.
> df-modelThis utility will allow to print a representation of the DragonFlow model in different formats. Currently supported formats are: text, PlantUML and JsonSchema (OpenApiSchema 3.0). The output may be sent to the stdout or to a file. * PlantUML output can be visualized using the PlantUML Server2
Use the df-model --help command to get a detailed usage instructions.