Initial set of Fabric switch test cases
Change-Id: I86fd2b67d3b773aa496f5ef61f1e1fdf51fd9925
diff --git a/Fabric/Doc/CONTRIBUTING.md b/Fabric/Doc/CONTRIBUTING.md
new file mode 100644
index 0000000..bbab966
--- /dev/null
+++ b/Fabric/Doc/CONTRIBUTING.md
@@ -0,0 +1,196 @@
+# How Can I Contribute?
+
+We're always willing to accept good pull requests (PRs). In case you're stuck for ideas on where to start, here are some ideas to get you started.
+
+## Add Missing Test Cases
+
+We welcome any patch that adds a missing test (or improves an existing one, for that matter). In this regard, while they make for heavy reading, the [OpenFlow Specifications](https://www.opennetworking.org/sdn-resources/onf-specifications/openflow) are likely the best places to start. Once you have an idea of a test you'd like to implement just check the [Adding Your Own Test Cases](#adding-or-modifying-tests) section below.
+
+## Bug Fixes
+
+Humans will inevitably write buggy software. If you spot a bug in either a test cases or another element of the framework then either [submit a fix](https://github.com/floodlight/oftest/pulls) or [file a bug](https://github.com/floodlight/oftest/issues).
+
+## Add New Features
+
+Need to modify OFTest to fit a personal need or business requirement? Great! If you think it'll be useful to anyone else then submit a PR for review.
+
+## Documentation & Other Changes
+
+Using OFTest in a unique way? Finding OFTest difficult to set up and wanting to help others avoid your issues? Finding yourself annoyed by a typo in some code/documentation? Submit a pull request!
+
+---
+
+# Making Changes
+
+## Adding or Modifying Tests
+
+OFTest itself uses the `unittest` library, which is part of the Python Standard Library. This means there are some requirements for tests written for OFTest:
+
+ * Each new test case should be its own class.
+ * All tests must inherit from `unittest.TestCase` or an existing test. Most tests will inherit from `oftest.base_tests.SimpleDataPlane`.
+ * Tests must also provide a `runTest` function, which will act as the main routine for all test cases. This is also how OFTest discovers tests.
+ * Tests should use the `unittest` assert cases, defined [here](https://docs.python.org/2/library/unittest.html#assert-methods), as they provide more information to the user about issues that standard the standard `assert`.
+ * Tests may provide a `setUp` and/or `tearDown` function. These will be automatically called by the test framework before/after calling `runTest` respectively. If overriding an existing test be sure to call the super class' `setUp` or `tearDown` functions.
+
+We suggest you look at `basic.py` as a starting point for writing new tests. It's also worth noting these conventions:
+
+ * The first line of the doc string for a file and for a test class is displayed in the list command. Please keep it clear and under 50 characters.
+
+### Coding Style
+
+OFTest uses the Python Standard Style Guide, or [PEP-8](http://www.python.org/dev/peps/pep-0008/). Please ensure all changes abide by this standard.
+
+In addition, when adding new tests, the test file names should be lowercase with underscores and short, meaningful names. Test case class names should be CamelCased and use similarly short, meaningful names.
+
+## Documentation
+
+Any additional documentation added to the repository should be in [GitHub-flavored Markdown](https://help.github.com/articles/github-flavored-markdown/).
+
+---
+
+# Architecture
+
+The directory structure is currently:
+
+ <oftest>
+ `
+ |-- oft
+ |-- docs
+ |-- src
+ | `-- python
+ | `-- oftest
+ |-- tests
+ | `-- test cases for OpenFlow 1.0
+ |-- tests-1.x
+ | `-- test cases for a specific version
+ `-- tools
+
+## Base Test Types
+
+Once installed the components of OFTest are available via import of submodules of `oftest`. Typically, new tests will be written as subclasses of one of the two following tests:
+
+ * The basic protocol test, `SimpleProtocol`, is used for tests that require only communication with the switch over the controller interface
+ * The basic dataplane test, `SimpleDataPlane` is used for tests that require both communication with the switch and the ability to send/receive packets to/from OpenFlow ports.
+
+SimpleProtocol and SimpleDataPlane are defined in `oftest/base_tests.py`.
+
+### Simple Protocol
+
+The essential object provided by inheritance from `SimpleProtocol` (and from `SimpleDataPlane` which is a subclass of `SimpleProtocol`) is `self.controller`. The `setUp` routine ensures a connection has been made to the SUT prior to returning. Thus, in `runTest` you can send messages across the control interface simply by invoking methods of this control object. These may be sent unacknowledged or done as transactions (which are based on the XID in the OpenFlow header):
+
+ import oftest.base_tests as base_tests
+
+ class MyTest(basic.SimpleProtocol):
+ ... # Inside your runTest:
+ self.controller.message_send(msg) # Unacknowledged
+ self.controller.transact(request) # Transaction based on XID
+
+### SimpleDataPlane
+
+`SimpleDataPlane` inherits from `SimpleProtocol`, so you get the controller object as well as the dataplane object, `self.dataplane`.
+
+Sending packets into the switch is done with the `send` member:
+
+ import basic
+
+ class MyDPTest(basic.SimpleDataPlane):
+ ... # Inside your runTest:
+ pkt = simple_tcp_packet()
+ self.dataplane.send(port, str(pkt))
+
+Packets can be received in the following ways:
+
+ * Non-blocking poll:
+
+ (port, pkt, timestamp) = self.dataplane.poll()
+
+ * Blocking poll:
+
+ (port, pkt, timestamp) = self.dataplane.poll(timeout=1)
+
+ For the calls to poll, you may specify a port number in which case only packets received on that port will be returned.
+
+ (port, pkt, timestamp) = self.dataplane.poll(port_number=2, timeout=1)
+
+ * Register a handler:
+
+ self.dataplane.register(handler)
+
+### DataPlaneOnly
+
+Occasionally, it is convenient to be able to send a packet into a switch without connecting to the controller. The DataPlaneOnly class is the parent that allows you to do this. It instantiates a dataplane, but not a controller object. The classes `PacketOnly` and `PacketOnlyTagged` inherit from `DataPlaneOnly` and send packets into the switch.
+
+## Messages
+
+The OpenFlow protocol is represented by a collection of objects inside the `oftest.message` module. In general, each message has its own class. All messages have a header member and data members specific to the message. Certain variable length data is treated specially and is described (TBD).
+
+Here are some examples:
+
+ import oftest.message as message
+ ...
+ request = message.echo_request()
+
+`request` is now an `echo_request` object and can be sent via `self.controller`.transact for example.
+
+ msg = message.packet_out()
+
+`msg` is now a packet_out object. `msg.data` holds the variable length packet data.
+
+ msg.data = str(some_packet_data)
+
+This brings us to one of the important variable length data members, the action list. Each action type has its own class. The action list is also a class with an `add` method which takes an action object.
+
+ import oftest.action as action
+ ...
+ act = action.action_output() # Create a new output action object
+ act.port = egress_port # Set the action's parameter(s)
+ msg.actions.add(act) # The packet out message has an action list member
+
+Another key data class is the match object. TBD: Fill this out.
+
+TBD: Add information about stats objects.
+
+## Packets
+
+OFTest uses [Scapy](http://www.secdev.org/projects/scapy/) for managing packet data, although you may not need to use it directly. In the example below, we use the function `simple_tcp_packet` from `testutils.py` to generate a packet. The the parse function `packet_to_flow_match` is called to generate a flow match based on the packet.
+
+ from testutils import *
+ import oftest.parse as parse
+ import ofp
+ ...
+ pkt = simple_tcp_packet()
+ match = parse.packet_to_flow_match(pkt)
+ match.wildcards &= ~ofp.OFPFW_IN_PORT
+
+This introduces the low level module `ofp`. This provides the base definitions from which OpenFlow messages are inherited and basic OpenFlow defines such as `OFPFW_IN_PORT`. Most enums defined in `openflow.h` are available in this module.
+
+---
+
+# Tips & Tricks
+
+## Making Your Tests Configurable
+
+As described in the [README](README.md#passing-parameters-to-tests), you can test for these parameters by importing `testutils.py` and using the function:
+
+ my_key1 = testutils.test_param_get(self.config, 'key1')
+
+The `config` parameter is the global configuration structure copied into the base tests cases (and usually available in each test file). The routine returns `None` if the key was not assigned in the command line; otherwise it returns the value assigned (`17` in this example).
+
+Note that any test may look at these parameters, so use some care in choosing your parameter keys.
+
+## Adding Support for a New Platform
+
+As described in the [README](README.md#platforms), OFTest provides a method for specifying how packets should be sent/received to/from the switch. The "config files" that enable this are known as "platforms".
+
+You can add your own platform, say `gp104`, by adding a file `gp104.py` to the
+`platforms` directory. This file should define the function `platform_config_update`. This can be enabled using the `--platform=gp104` parameter on the command line. You can also use the `--platform-dir` option to change which directory is searched.
+
+IMPORTANT: The file should define a function `platform_config_update` which takes a configuration dictionary as an argument and updates it for the current run. In particular, it should set up `config["port_map"]` with the proper map from OpenFlow port numbers to OpenFlow interface names.
+
+## Troubleshooting
+
+Normally, all debug output goes to the file `oft.log` in the current directory. You can force the output to appear on the terminal (and set the most verbose debug level) with these parameters added to the oft command:
+
+ --verbose --log-file=[path/to/logfile]
+
+---
diff --git a/Fabric/Doc/command.sh b/Fabric/Doc/command.sh
new file mode 100755
index 0000000..3432392
--- /dev/null
+++ b/Fabric/Doc/command.sh
@@ -0,0 +1,18 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+#sudo ./oft --verbose --default-timeout=6 -i 1@eth1 -i 2@eth2 -i 3@eth3 --disable-ipv6 --switch-ip=192.168.2.2 --host=192.168.2.4 --of-version=1.3 --port=6633 --test-dir=accton --log-dir=log-dir
+sudo ./oft --verbose --default-timeout=6 -i 1@eth1 -i 2@eth2 -i 3@eth3 --disable-ipv6 --switch-ip=192.168.2.197 --host=192.168.2.4 --of-version=1.3 --port=6633 --test-dir=acctonUseDpctl --log-dir=log-dir phase1
\ No newline at end of file
diff --git a/Fabric/Doc/docs/Detailed_Testing_Methodology.txt b/Fabric/Doc/docs/Detailed_Testing_Methodology.txt
new file mode 100644
index 0000000..34922cc
--- /dev/null
+++ b/Fabric/Doc/docs/Detailed_Testing_Methodology.txt
@@ -0,0 +1,1822 @@
+ *********** Conformance Test-suite ****************
+ OF-Switch-1.0.0-TestCases detailed testing methodology
+
+
+
+
+
+**** Openflow protocol messages ****
+
+
+
+1. Features Request
+
+Test Description: Check features request is implemented
+
+Test mode: Automated
+Test Title: FeaturesRequest
+Ports: I (Control Plane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_FEATURES_REQUEST from controller.
+b) Verify OFPT_FEATURES_REPLY is received without errors
+
+
+
+2. Configuration request
+
+Test Description: Check basic get configuration request is implemented
+
+Test mode: Automated
+Test Title: ConfigurationRequest
+Ports: I (Control Plane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_GET_CONFIG_REQUEST
+b) Verify OFPT_GET_CONFIG_REPLY is received without errors.
+
+
+
+3. Modify State (ADD)
+
+Test Description: Check basic Flow ADD request is implemented
+
+Test mode: Automated
+Test Title: ModifyStateAdd
+Ports: 3 (1 Control Plane 2 dataplane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_FLOW_MOD, command = OFPFC_ADD
+b) Send ofp_table_stats request
+c) Verify that active_count=1 in the reply
+
+
+
+
+4. Modify State (DELETE)
+
+Test Description: Check basic Flow Delete request is implemented
+
+Test mode: Automated
+Test Title: ModifyStateDelete
+Ports: 3 (1 Control Plane 2 dataplane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_FLOW_MOD, command = OFPFC_ADD
+b) Send ofp_table_stats request
+c) Verify that active_count=1 in the reply
+d) Send OFPT_FLOW_MOD, command = OFPFC_DELETE
+e) Send ofp_table_stats request
+f) Verify active _count=0 in the reply
+
+
+
+5. Modify State (MODIFY)
+
+Test Description: Check basic Flow Modify request is implemented
+
+Test mode: Automated
+Test Title: ModifyStateModify
+Ports: 3 (1 Control Plane and 2 Dataplane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_FLOW_MOD , command = OFPFC_ADD, action A
+b) Send ofp_table_stats request, Verify active_count=1
+c) Send OFPT_FLOW_MOD , command = OFPFC_MODIFY, action A
+d) Send Test Packet matching the flow
+e) Verify packet implements action A
+
+
+
+6. Read State
+
+Test Description: Check basic Read State is implemented
+
+Test mode: Automated
+Test Title: ReadState
+Ports: 3 (1 Control Plane, 2 dataplane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_FLOW_MOD, command = OFPFC_ADD
+b) Create a OFPC_FLOW_STATS message and send it
+c) Verify switch replies without errors
+
+
+
+7. Send packet
+
+Test Description: Check basic Send-Packet is implemented.
+ Send-Packet: These are used by the controller to send packets out of a specified port on the switch.
+
+Test mode: Automated
+Test Title: SendPacket
+Ports: 5 (1 Control Plane, 4 Dataplane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_PACKET_OUT out message from controller to switch for every dataplane port.
+b) Verify the packet appears on the each dataplane port
+c) Verify sent packet matches the received packet
+
+
+
+8. Barrier Request
+
+Test Description: This test checks that a basic barrier request does not generate an error.
+
+Test mode: Automated
+Test Title: BarrierRequestReply
+Ports: I (Control Plane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_BARRIER_REQUEST
+c) Verify OFPT_BARRIER_REPLY is received on the control plane.
+
+
+
+9. Packet In
+
+Test Description: Check packet_in is implemented. This test just checks that non matched dataplane packets
+ generate a packet_in
+
+Test mode: Automated
+Test Title: PacketIn
+Ports: 2 (1 Control Plane and 1 Dataplane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send a packet to dataplane port , without inserting a flow entry
+b) Verify a OFPT_PACKET_IN is generated on the control plane
+
+
+
+10. Hello
+
+Test Description: This test checks for basic Hello message generation with correct version field.
+
+Test mode: Automated
+Test Title: Hello
+Ports: 1 (Control Plane)
+Initial State: Default (Clear switch state), Connection Setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_HELLO from controller to switch
+b) Verify switch also sends OFPT_HELLO message in response
+c) Verify version field in the hello message is set to Openflow version 1.0.0
+
+
+
+11. Echo
+
+Test Description: This test checks for basic Echo Reply message generation with correct version field with
+ same transaction id.
+
+Test mode: Automated
+Test Title: EchoWithoutBody
+Ports: 1 (Control Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send OFPT_ECHO_REQUEST from the controller side.
+b) Verify switch responds back with OFPT_ECHO_REPLY with same xid.
+c) Verify Openflow version in header is set to Openflow version 1.0.0.
+
+
+
+
+
+**** Detailed controller to switch messages ****
+
+
+
+1. Overlap checking
+
+Test Description: Verify that if overlap check flag is set in the flow entry and an overlapping flow is
+ inserted then an error is generated and switch refuses flow entry
+
+Test mode: Automated
+Test Title: OverlapChecking
+Ports: 3 (1 Control Plane 2 dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test-Notes:
+
+a) Generate Flow F1--> Wildcard All
+b) Send ofp_table_stats request , verify active_count=1
+c) Generate overlapping flow F2 --> Wildcard All Except Ingress Port ( with flag OFPFF_CHECK_OVERLAP set)
+d) Verify that switch generates OFPT_ERROR msg.
+ Type: OFPET_FLOW_MOD_FAILED code : OFPFMFC_OVERLAP
+
+
+
+2. No overlap checking
+
+Test Description: Verify that without overlap check flag set, overlapping flows can be created.
+
+Test mode: Automated
+Test Title: NoOverlapchecking
+Ports: 3 (1 Control Plane, 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Generate Flow F1--> Wildcard All.
+b) Send ofp_table_stats request , verify active_count=1
+e) Generate overlapping flow F2 --> Wildcard All Except Ingress Port ( without flag OFPFF_CHECK_OVERLAP set)
+c) Send a ofp_table_stats request, verify active_count=2
+
+
+
+3. Identical flows
+
+Test Description: Verify that adding two identical flows overwrites the existing one and clears counters
+
+Test mode: Automated
+Test Title: IdenticalFlows
+Ports: 3 (1 Control Plane), (2 dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Generate Flow F1.
+b) Send ofp_table_stats request , verify active_count=1
+b) Increment counters (packet_count, byte_count) by sending a packet matching flow F1.
+C) Send ofp_flow_stats request. Verify flow counters: byte_count and packet_count
+c) Create identical flow F2
+d) Send a ofp_table_stats request, verify active_count=1
+e) Send ofp_flow_stats request. Verify flow counters: byte_count and packet_count are reset
+
+
+
+4. No table to add (Written in oftestNeed to add to conformance Test-Suites)
+
+
+
+5. Never valid port (TBD)
+
+
+
+
+6. Currently not existing port Version A and B (TBD)
+
+
+
+
+7. Emergency flow with timeout values
+
+Test Description: Timeout values are not allowed for emergency flows
+
+Test Title: EmerFlowTimeout
+Test mode: Automated
+Ports: 3 (1 control plane, 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+
+
+Test Notes:
+
+a) Generate a flow F with OFPFF_EMERG set in flag and timeout values assigned.
+b) Verify switch generates an OFPT_ERROR msg, Type: OFPET_FLOW_MOD_FAILED, Code OFPFMFC_BAD_EMERG_TIMEOUT
+
+
+
+8. Missing modify adds
+
+Test Description: If a modify does not match an existing flow, the flow gets added.
+
+Title: MissingModifyAdd
+Test mode: Automated
+Ports:3 (1 control plane,2 Data Plane)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Generate a flow-mod , command OFPC_MODIFY (Note: There should be no flows matching this flow_mod modify command)
+b) Send a ofp_table_stats request, verify active_count=1
+
+
+
+
+9. Modify changes action, preserves counters
+
+Test Description: A modified flow preserves counters
+
+Title: ModifyAction
+Test mode: Automated
+Ports: 4(1 control plane, 3 Dataplane)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Create a flow_mod F-1 with command OFPC_ADD, action A
+b) Send a test Packet matching the flow
+c) Send an ofp_flow_stats request, verify byte_count and packet_count
+e) Create flow_mod with command OFPC_MODIFY ,action A and modify action of flow F-1
+f) Send a ofp_flow_stats request, verify flow counters are preserved
+g) Send test packet, verify it implements action A
+
+
+
+10. Strict Modify changes action, preserves counters
+
+Test Description: Strict Modify Flow also changes action preserves counters
+
+Title: StrictModifyAction
+Test mode: Automated
+Ports: 4(1 control plane, 3 Dataplane)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Create two overlapping flows: F --> Match on all, except one wildcarded (src address). Action A. Priority=100
+ F --> Match on ingress_port = port [0], wildcarded rest. Action A. Priority=10
+b) Send a ofp_table_stats request, verify active_count=2
+c) Send Packet (it would have matched both the flows, since they are overlapping flows but it would match Flow-F1 as it has higher priority.)
+d) Send ofp_flow_stats request for Flow-1 and verify counters packet_count and byte_count
+e) Create flow_mod ,command OFPC_STRICT_MODIFY,match on all except src address ,priority 100 action A
+f) Send test packet , verify action is modified
+g) Send ofp_flow_stats request, verify counters are preserved.
+
+
+
+
+11. Delete non existing flow
+
+Test Description: Request deletion of non-existing flow
+
+Title: DeleteNonexistingFlow
+Test mode: Automated
+Ports: 1(1 control plane)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Issue a delete command, with no flows inserted
+b) Make sure no error is generated on the control plane
+
+
+
+12. Delete flows with and without removed message
+
+Test Description: Check deletion of flows happens and generates messages as configured. i.e. if Send Flow removed messageFlag
+ is set in the flow entry, the flow deletion of that respective flow should generate the flow removed message,
+ vice versa also exists
+
+Test Title: SendFlowRem
+Test mode: Automated
+Ports: 3 (1 control plane, 2 Dataplane)
+Initial State: Connection setup, Default (clear switch state)
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Generate a flow F without OFPFF_SEND_FLOW_REM flag set
+b) Issue a delete command OFPFC_DELETE
+c) Verify that OFPT_FLOW_REMOVED message is not generated.
+c) Generate a flow F with OFPFF_SEND_FLOW_REM flag set
+d) Issue a delete command OFPFC_DELETE
+e) Verify that OFPT_FLOW_REMOVED message is generated
+
+
+
+13. Delete emergency flow
+
+Test Description: Delete emergency flow and verify no message is generated.An emergency flow deletion will not generate
+ flow-removed messages even if Send Flow removed message flag was set during the emergency flow entry.
+
+
+Title: DeleteEmerFlow
+Test mode: Automated
+Ports: 3 (1 control plane, 2 Dataplane)
+Initial State: Connection setup, Clear Switch State (default)
+
+
+Test-Notes:
+
+a) Insert a flow with OFPFF_EMERG flag set.
+b) Delete the added flow with OFPFF_SEND_FLOW_REM flag set
+c) Test successful if no flow removed message is generated.
+
+
+
+14. Delete and verify strict and non-strict
+
+Test Description: Delete and verify strict and non-strict behaviors
+
+This test compares the behavior of delete strict and non-strict.
+Title: StrictVsNonstrict
+Test mode: Automated
+Ports: 3 (1 control plane, 2 dataplane)
+Initial State: Connection setup, Clear Switch State
+
+
+Test-Notes:
+
+a) Insert Flow F with an exact match.
+b) Issue Non-strict Delete command, verify F gets deleted.
+c) Insert F with an exact Match
+d) Issue Strict Delete Command, verify F gets deleted.
+e) Insert Flow T with match on all, except one wildcarded (say src address).
+f) Insert another flow T' with match on ingress_port, wildcarded rest.
+g) Issue Non-strict Delete ( match on ingress_port). Verify T+T' gets deleted.
+h) Insert T and T' again. Issue Strict Delete (match on ingress port), verify only T' gets deleted
+i) Insert T, add Priority P (say 100)
+j) Insert T' add priority (200).
+k) Insert T' again add priority 300 --> T
+l) Issue Non-Strict Delete (match on ingress port). Verify T+T+T gets deleted.
+m) Insert T, T, T again, Issue Strict Delete (match on ingress_port) with priority = 200. Verify only T gets deleted
+
+
+
+15. Delete flows with constraint out_port
+
+Test Description: Delete flows filtered by action output.DELETE and DELETE STRICT commands can be optionally filtered by output port.
+ If the out_port field contains a value other than OFPP_NONE, it introduces a constraint when matching.
+ This constraint is that the rule must contain an output action directed at that port.
+
+Title: Outport1
+Test mode: Automated
+Ports: 3 (1 control plane, 2 Dataplanes)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test-Notes:
+
+a) Insert a flow F with output action = port x
+b) Send a delete command matching flow F ,but out_port =port y
+c) Send a table_stats request , verify no flow gets deleted i.e. active_count=1
+d) Send a delete command matching flow F ,outport = port x
+e) Send a table_stats request, verify flow F gets deleted.
+
+
+
+16. Add, modify flows with constraint output
+
+Test Description: Add, modify flows with outport set. This field is ignored by ADD, MODIFY, and MODIFY STRICT messages.
+
+Title: Outport2
+Test mode: Automated
+Ports: 4 (1 control plane, 3 Data planes)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+Test-Notes:
+
+a) Insert a flow F with action A (output --> port x) , but out_port field in the flow mod set as port y
+b) Send Table_Stats_Request, Verify Flow gets inserted. ( Flow add ignores out_port field)
+c) Modify the action in flow F , action A ( output -->port z ), but out_port field in the flow mod set as port y
+d) Send test packet matching the flow F
+e) Verify packet implements action A (flow modify ignores out_port field)
+
+
+
+17. Verify that idle timeout is implemented
+
+Test Description: Verify that idle timeout is implemented
+
+Title: IdleTimeout
+Test mode: Automated
+Ports: 3 (1 control plane, 2 Dataplanes)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test-Notes:
+
+a) Add a flow with idle timeout set and with OFPP_SEND_FLOW_REM bit set
+b) Verify flow removed message is received.
+c) Verify flow removed reason was idle_timeout
+d) Verify the duration_sec field is 1 sec
+
+
+
+18. Verify that hard timeout is implemented
+
+Test Description: Verify that hard timeout is implemented
+
+Title: HardTimeout
+Test mode: Automated
+Ports: 3 (1 control plane, 2 Dataplanes)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test-Notes:
+
+a) Add a flow with hard timeout =1 set and with OFPP_SEND_FLOW_REM bit set
+b) Verify flow removed message is received.
+c) Verify flow removed reason was hard_timeout
+d) Verify the duration_sec field is 1 sec
+
+
+
+19. Verify that messages are generated as expected
+
+Test Description: Verify that Flow removed messages are generated as expected
+ /* Since flow removed messages being generated when flag is set is already tested in the above tests
+ So here, we test the vice-versa condition.*/
+
+Title: FlowTimeout
+Test mode: Automated
+Ports: 3 (1control plane, 1dataplane)
+Initial State: Connection setup, Clear Switch State
+Test-Field: Mandatory
+
+
+Test-Notes:
+
+a) Generate and install a flow with idle_timeout = 1 set no OFPFF_SEND_FLOW_REM flag set.
+b) Verify no flow removed message is received.
+c) Send table_stats_request message and verify active_count=0
+
+
+
+
+
+*** Actions ***
+
+
+
+1. No Action drops packet
+
+Test Description: If no forward actions are present, the packet is dropped.
+
+Required Action: Drop.
+A flow-entry with no specified action indicates that all matching packets should be dropped.
+Test mode: Automated
+Test Title: NoAction
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send Flow mod message without any action specified
+b) Send N packets matching the flow
+c) Verify packets are not received on any of the dataplane ports
+d) Verify packets are not even sent to the controller
+
+
+
+2. Get supported actions from switch
+
+Test Description: Get the supported actions from switch and make sanity checks.
+ /*When connecting to the controller, a switch indicate which of the Optional Actions it supports*/
+
+Test mode: Automated
+Test Title: Announcement
+Ports: 1 (Control Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send features_request .
+b) Verify response is OFPT_FEATURES_REPLY
+c) Verify reply has supported action list specified
+
+
+
+3. Forward All
+
+Test Description: Packet is sent to all dataplane ports except ingress port when output action.port = OFPP_ALL
+
+Test mode: Automated
+Test Title: ForwardAll
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Install a flow with output action.port = OFPP_ALL.
+b) Verify packets are forwarded to all ports except ingress port.
+
+
+
+4. Forward Controller
+
+Test Description: Packet is sent to controller output.port = OFPP_CONTROLLER
+
+Test mode: Automated
+Test Title: ForwardController
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with action output port = OFPP_CONTROLLER
+b) Send packets matching the flow
+c) Verify packet received on the control plane as a packet_in message
+
+
+
+5. Forward Local (TBD Verification of packet being received at local networking stack)
+
+Test Description: Packet is sent to switchs local networking stack if output.port = OFPP_LOCAL
+
+Test mode: Automated
+Test Title: ForwardLocal
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with action output port = OFPP_LOCAL
+b) Send packets matching the flow
+c) Verify packet received in the switchs local networking stack.
+
+
+
+6. Forward Table
+
+Test Description: Perform actions in flow table. Only for packet-out messages.
+ /*If the output action.port in the packetout message = OFP.TABLE, then the packet implements the action
+ specified in the matching flow of the FLOW-TABLE*/
+
+Test mode: Automated
+Test Title: ForwardTable
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+Test Notes:
+
+a) Insert a flow F with action output.port = egress_port
+b) Send a OFPT_PACKET_OUT message with out port=OFPP_TABLE matching flow F
+c) Verify packet received on egress_port (i.e packetout message implemented the action specified in the matching flow of the Table)
+
+
+
+7. Forward In Port
+
+Test Description: Packet is sent to input port if output.port = OFPP_INPORT
+
+Test mode: Automated
+Test Title: ForwardInport
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+Test Notes:
+
+a) Insert a flow with action output port = OFPP_INPORT
+b) Send packets matching the flow
+c) Verify packet received on all dataplane ports except for input port
+
+
+
+8. Forward Flood
+
+Test Description:Flood the packet along the minimum spanning tree, not including the incoming interface.
+ Packet is sent all the dataplane ports except the input port if output.port = OFPP_FLOOD
+
+Test mode: Automated
+Test Title: Forward_Flood
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+Test Notes:
+
+a) Insert a flow with action output port = OFPP_FLOOD
+b) Send packets matching the flow
+c) Verify packet received on all dataplane ports except for input port
+
+
+
+9. Multiple Ports -- TBD
+
+
+
+
+10. Forward Enqueue --- TBD
+
+
+
+
+11. Set VLAN Id
+
+Test Description: Attach VLAN ID to untagged packet.
+ If no VLAN is present, a new header is added with the specified VLAN ID and priority of zero.
+
+Test mode: Automated
+Test Title: AddVlanId
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_VLAN_VID , vlan_vid = x
+b) Send packet (length = 100 bytes) matching the flow
+b) Verify packet received has vlan id added to it. (I.e length of packet with vid is 104 bytes, dl_vlan_enable = True, dl_vlan= x, dl_vlan_pcp=0)
+
+
+
+12. Modify VLAN Id
+
+Test Description: Modifies Vlan Tag for a tagged packet
+ If a VLAN header already exists, the VLAN ID is replaced with the specified value
+
+Test mode: Automated
+Test Title: ModifyVlanId
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+a) Insert a flow with action = OFPAT_SET_VLAN_VID , vlan_vid = x
+b) Send packet (length = 100 bytes) matching the flow
+c) Verify packet received has vlan id rewritten. (I.e length of 104 bytes, dl_vlan_enable = True, dl_vlan=x)
+
+
+
+13. Add VLAN Priority to an untagged packet
+
+Test Description: Attach VLAN priority to an untagged packet.
+ Since, no VLAN ID is present; a new header is added with the specified priority and a VLAN ID of zero.\
+
+Test mode: Automated
+Test Title: VlanPrio1
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_VLAN_PCP , dl_vlan_pcp =x
+b) Send untagged packet matching the flow
+c) Verify packet received has vlan priority added to it along with a vid value of zero added by default (dl_vlan_enable , dl_vlan = 0 , dl_vlan_pcp =x )
+
+
+
+14. Rewrite existing VLAN priority
+
+Test Description: Modify VLAN priority for a tagged packet.
+
+Test mode: Automated
+Test Title: VlanPrio2
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_VLAN_PCP , dl_vlan_pcp =new_vlan_pcp
+b) Send tagged packet matching the flow (dl_vlan = old_vlan_id , dl_vlan_pcp = old_vlan_pcp)
+c) Verify packet received has vlan id added to it. (dl_vlan_enable , dl_vlan = 0 , dl_vlan_pcp = new_vlan_pcp)
+
+
+
+
+15. Modify L2 Src Address
+
+Test Description: Modify Ethernet Src Address of a packet
+
+Test mode: Automated
+Test Title: ModifyL2Src
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_DL_SRC , dl_src =new_dl_src
+b) Send packet matching the flow (dl_dst = old_dl_src )
+c) Verify packet received has src address rewritten. (dl_src= new_dl_src)
+
+
+
+16. Modify L2 Destination Address
+
+Test Description: Modify Ethernet Destination Address of a packet
+
+Test mode: Automated
+Test Title: ModifyL2Dst
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_DL_DST , dl_dst =new_dl_dst
+b) Send packet matching the flow (dl_dst = old_dl_src )
+c) Verify packet received has destination address rewritten. (dl_src= new_dl_src)
+
+
+
+17. Strip VLAN header (In oftest, need to add in conformance test-suite )
+
+
+
+18. Modify L3 Src Address
+
+Test Description: Modify Network Src Address of a packet
+
+Test mode: Automated
+Test Title: ModifyL3Src
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_NW_SRC , nw_src =new_nw_src
+b) Send packet matching the flow (nw_src = old_nw_src )
+c) Verify packet received has nw address rewritten. (nw_src= new_nw_src)
+
+
+
+19. Modify L3 Dst Address
+
+Test Description: Modify Network Dst Address of a packet
+
+Test mode: Automated
+Test Title: ModifyL3Dst
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_NW_DST , nw_dst =new_nw_dst
+b) Send packet matching the flow (nw_dst = old_nw_dst )
+c) Verify packet received has nw destination address rewritten. (nw_dst= new_nw_dst)
+
+
+
+20. Modify L4 Src Address
+
+Test Description: Modify TCP Source Port of a packet
+
+Test mode: Automated
+Test Title: ModifyL4Src
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_TP_SRC , tcp_sport =new_tcp_sport
+b) Send packet matching the flow (tcp_sport = old_tcp_sport )
+c) Verify packet received has tcp source port rewritten. (tcp_sport = new_tcp_sport)
+
+
+21. Modify L4 Dst Address
+
+Test Description: Modify TCP Destination Port of a packet
+
+Test mode: Automated
+Test Title: ModifyL4Dst
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_TP_DST , tcp_dport =new_tcp_dport
+b) Send packet matching the flow (tcp_dport = old_tcp_dport )
+c) Verify packet received has tcp destination port rewritten. (tcp_sport = new_tcp_sport)
+
+
+
+22. Modify TOS
+
+Test Description: Modify Network Type of service
+
+Test mode: Automated
+Test Title: ModifyTos
+Ports: 3 (1 Control Plane 2 Dataplane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Insert a flow with action = OFPAT_SET_NW_TOS, ip_tos =new_ip_tos
+b) Send packet matching the flow (ip_tos= old_ip_tos)
+c) Verify packet received has tcp destination port rewritten. (ip_tos= new_ip_tos)
+
+
+
+23. Order Not possible -- TBD
+
+
+
+
+24. Sequential execution -- TBD
+
+
+
+
+
+**** Counters ****
+
+
+
+1. Received Packets per Flow
+
+
+Test Description: Verify that packet_count in the Flow_Stats reply increments in accordance with the packets in flow
+
+Test mode: Automated
+Test Tile: PktPerFlow
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow , match = ingress_port
+b) Send N packet matching the flow i.e packets should be sent on ingress_port
+c) Send flow_stats_request for the flow
+d) Verify packet_count = N in the flow_stats_reply
+
+
+
+2. Received Bytes per Flow
+
+
+Test Description: Verify that byte_count in the Flow_Stats reply increments in accordance with the bytes in flow
+
+Test mode: Automated
+Test Tile: BytPerFlow
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow , match = ingress_port
+b) Send N packet matching the flow i.e packets should be sent on ingress_port
+c) Send flow_stats_request for the flow
+d) Verify byte_count = N*(no. of bytes in one packet) in the flow_stats_reply
+
+
+
+3. Duration in sec per Flow
+
+
+Test Description: Verify that duration_sec in the Flow_Stats reply increments in accordance with the time that flow was alive in sec
+
+Test mode: Automated
+Test Tile: DurationPerFlow
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a any flow
+b) Send flow_stats_request for that flow periodically after n sec intervals upto timeout of y
+c) Verify each flow_stats_reply has duration_sec field incrementing as n , 2n , 3n .. y
+
+
+
+4. Duration in nsec per flow
+
+
+Test Description: Verify that duration_nsec in the flow_stats repl increments in accordance with the time flow has been alive in nanoseconds
+beyond duration_sec.
+
+Test mode: Automated
+Test Tile: DurationPerFlow
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert any flow
+b) Send flow_stats_request periodically after n sec intervals upto timeout of y
+c) Verify each flow_stats_reply has duration_sec field incrementing as n , 2n , 3n .. y and read out duration_nsec field ( Verification of nsec field
+is out of scope)
+
+
+
+5. Received packets per port
+
+
+Test Description: Verify that rx_packets in the Port_Stats reply increments in accordance with the packets recieved on that port
+
+Test mode: Automated
+Test Tile: RxPktPerPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match on ingress_port
+b) Send N packets on the ingress_port
+c) Send port_stats request for port=ingress_port
+d) Verify port_stats_reply has rx_packet=N
+
+
+
+
+6. Transmitted packets per port
+
+
+Test Description: Verify that tx_packets in the Port_Stats reply increments in accordance with the packets transmitted from a port
+
+Test mode: Automated
+Test Tile: TxPktPerPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match on ingress_port, action output = egress_port
+b) Send N packets on the ingress_port
+c) Send port_stats request for port=ingress_port
+d) Verify port_stats_reply had tx_packets=N
+
+
+
+7. Received Bytes per port
+
+
+Test Description: Verify that rx_bytes in the Port_Stats reply increments in accordance with the bytes recieved on a port
+
+Test mode: Automated
+Test Tile: RxBytPerPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match on ingress_port, action output = egress_port
+b) Send N packet matching the flow
+c) Send port_stats request for port=ingress_port
+d) Verify port_stats_reply had rx_bytes=N*(no. of bytes in a packet)
+
+
+
+8. Transmitted Bytes per port
+
+
+Test Description: Verify that tx_bytes in the Port_Stats reply increments in accordance with the bytes transmitted from a port
+
+Test mode: Automated
+Test Tile: TxBytPerPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match on ingress_port, action output = egress_port
+b) Send N packet matching the flow
+c) Send port_stats request for port=ingress_port
+d) Verify port_stats_reply had tx_bytes=N*(no. of bytes in a packet)
+
+
+
+9. Recieve Drops per port (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that rx_dropped counters in the Port_Stats reply increments in accordance with the packets dropped by RX
+
+Test mode: Automated
+Test Tile: RxDrops
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+Test Notes :
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has rx_dropped count
+
+
+
+
+
+10. Transmit Drops per port (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that tx_dropped counters in the Port_Stats reply increments in accordance with the packets dropped by TX
+
+Test mode: Automated
+Test Tile: TxDrops
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Manadatory
+
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has tx_dropped count
+
+
+
+
+11. Recieve Errors (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that rx_errors counters in the Port_Stats reply increments in accordance with number of recieved error
+ This is a super-set of more specific receive errors and should be greater than or equal to the sum of all
+ rx_*_err values.
+
+Test mode: Automated
+Test Tile: RxErrors
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has rx_errors count
+
+
+
+12. Transmit Errors (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that tx_errors counters in the Port_Stats reply increments in accordance with number of trasmit errors
+
+Test mode: Automated
+Test Tile: TxErrors
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has tx_errors count
+
+
+
+13. Recieve Frame Errors (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that rx_frm_err counters in the Port_Stats reply increments in accordance with the number of frame alignment errors
+Test mode: Automated
+Test Tile: RxFrameErr
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has rx_frame_err count
+
+
+
+14. Recieve Overrun Errors (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that rx_over_err counters in the Port_Stats reply increments in accordance with the number of with RX overrun
+
+Test mode: Automated
+Test Tile: RxOErr
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has rx_over_err count
+
+
+15. CRC Errors (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that rx_crc_err counters in the Port_Stats reply increments in accordance with the number of crc errors
+
+Test mode: Automated
+Test Tile: RxCrcErr
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Manadatory
+
+
+Test Notes:
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has rx_crc_err count
+
+
+
+16. Collisions (TBD ---> Verification of counter incrementing correctly)
+
+
+Test Description: Verify that collisons counters in the Port_Stats reply increments in accordance with the collisions encountered by the switch
+
+Test mode: Automated
+Test Tile: Collisions
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Send port_stats request for port=ingress_port
+b) Verify port_stats reply has collisions count
+
+
+
+17. Active Entries per Table
+
+
+Test Description: Verify that active_count in the table increments in accordance with the flows inserted in the table
+
+Test mode: Automated
+Test Tile: ActiveCount
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow
+b) Send table_stats_request
+c) Verify active_count=1
+
+
+
+18. Packet Lookup per Table
+
+
+Test Description: Verify that lookup_count in the Table_Stats reply increments in accordance with the number of packets looked up in table
+
+Test mode: Automated
+Test Tile: LookupMatchedCount
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match on ingress_port
+b) Send N packets on ingress_port (matching the flow)
+c) Send N' packets on x port (Not matching the flow)
+d) Send table_stats_request
+e) Verify lookup_count = N+N'
+
+
+
+19. Packets matched per Table
+
+Test Description: Verify that matched_count in the Table_Stats reply increments in accordance with the number of packets matched with the table
+
+Test mode: Automated
+Test Tile: LookupMatchedCount
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match on ingress_port
+b) Send N packets on ingress_port (matching the flow)
+c) Send N' packets on x port (Not matching the flow)
+d) Send table_stats_request
+e) Verify matched_count = N
+
+
+
+
+20. Transmit Packets per Queue
+
+Test Description: Verify that tx_packets in the queue_stats reply increments in accordance with the number of transmitted packets
+
+Test mode: Automated
+Test Tile: TxPktPerQueue
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Send queue_stats request for ports=ofp.OFPP_ALL and queue_ids=ofp.OFPQ_ALL (i.e all ports and all queues)
+b) Send queue_stats request for egress_port[0] and queue_id[0] and note the tx_packets count in the reply
+c) Insert a flow entry with enqueue action , port = egress_port[0] queue_id= queue_id[0]
+d) Send packet matching the flow
+e) Send queue_stats request again, verify tx_packet count incremented
+f) Repeat b , c , d , e for all the queue_ids configured for egress_port[0]
+h) Repeat b , c , d , e , f for all the egress_ports available
+
+
+
+
+21. Transmit Bytes per Queue
+
+Test Description: Verify that tx_bytes in the queue_stats reply increments in accordance with the number of transmitted bytes
+
+Test mode: Automated
+Test Tile: TxBytPerQueue
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+
+Test Notes:
+
+a) Send queue_stats request for ports=ofp.OFPP_ALL and queue_ids=ofp.OFPQ_ALL (i.e all ports and all queues)
+b) Send queue_stats request for egress_port[0] and queue_id[0] and note the tx_bytes count in the reply
+c) Insert a flow entry with enqueue action , port = egress_port[0] queue_id= queue_id[0]
+d) Send packet matching the flow
+e) Send queue_stats request again, verify tx_byte count incremented
+f) Repeat b , c , d , e for all the queue_ids configured for egress_port[0]
+h) Repeat b , c , d , e , f for all the egress_ports available
+
+
+
+22. Transmit Overrun Errors per queue (TBD ----> Verification of tx_error count being incremented correctly)
+
+Test Description: Verify that tx_errors in the queue_stats reply increments in accordance with the number of packets dropped due to overrun.
+Test mode: Automated
+Test Tile: TxErrorPerQueue
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Optional
+
+Test Notes:
+
+
+a) Send queue_stats request for port=egress_port and queue_ids=ofp.OFPQ_ALL
+B) send queue_stats request for egress_port and queue_id[0] (i.e first queue configured for egress_port)
+c) Verify reply has tx_errors count .
+d) Repear b , c for the all queue_ids of egress_port
+
+
+
+
+
+**** Flow matches ****
+
+
+
+1. All Wildcard Match
+
+Test Description: Adding a Flow that matches all the possible fields
+
+Test mode: Automated
+Test Tile: AllWildcardMatch
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with wildcard = OFPFW_ALL (wildcard all fields), action output to egress_port
+b) Send packets with different header fields
+c) Verify all packets match the flow and implement the action specified.
+
+
+2. Single Header Field: Ingress Port
+
+Test Description: Match on Ingress Port and Wildcard rest
+
+Test mode: Automated
+Test Tile: IngressPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = in_port (say port x), action output to egress_port
+b) Send packet on port x
+c) Verify packet was recieved on egress_port
+d) Send packet on port y
+e) Verify PacketIn event was triggered on control plane
+
+
+
+3. Single Header Field: Ethernet Src Address
+
+Test Description: Match on Ethernet Source Address and Wildcard rest
+
+Test mode: Automated
+Test Tile: EthernetSrcAddress
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = dl_src (say x) , action output to egress_port
+b) Send packet wth dl_src = x
+c) Verify packet was recieved on egress_port
+d) Send packet with dl_src = y
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+4. Single Header Field: Ethernet Dst Address
+
+Test Description: Match on Ethernet Destination Address and Wildcard rest
+
+Test mode: Automated
+Test Tile: EthernetDstAddress
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = dl_dst (say x) , action output to egress_port
+b) Send packet wth dl_dst = x
+c) Verify packet was recieved on egress_port
+d) Send packet with dl_dst = y
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+5. Single Header Field: Ethernet Type
+
+Test Description: Match on Ehternet Type and Wildcard rest
+
+Test mode: Automated
+Test Tile: EthernetType
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = dl_type (say x) , action output to egress_port
+b) Send packet wth dl_type = x
+c) Verify packet was recieved on egress_port
+d) Send packet with dl_type = y
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+
+6. Single Header Field: Vlan Id
+
+Test Description: Match on Ingress Port and Wildcard rest
+
+Test mode: Automated
+Test Tile: VlanId
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = dl_vlan (say x) , action output to egress_port
+b) Send a tagged packet with (dl_vlan_enable=True,dl_vlan = x)
+c) Verify packet was recieved on egress_port
+d) Send another tagged packet with (dl_vlan_enable=True,dl_vlan = y )
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+
+7. Single Header Field: Vlan PCP
+
+Test Description: Match on Vlan ID Priority
+
+Test mode: Automated
+Test Tile: VlanPcp
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = dl_vlan_pcp (say x) , action output to egress_port
+b) Send a tagged packet with (dl_vlan_enable=True, dl_vlan = * , dl_vlan_pcp = x)
+c) Verify packet was recieved on egress_port
+b) Send a tagged packet with (dl_vlan_enable=True, dl_vlan = * , dl_vlan_pcp = y)
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+
+
+8. Single Header Field: IP Src Address -------- > (TBD)
+
+Test Description: Match on IP Src Address and Wildcard rest
+
+Test mode: Automated
+Test Tile: IPSrcAddress
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+
+
+9. Single Header Field: IP Dst Address -----------> (TBD)
+
+Test Description: Match on IP Dst Address and Wildcard rest
+
+Test mode: Automated
+Test Tile: IPDstAddress
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+
+
+
+10. Single Header Field: IP protocol---------------> (TBD)
+
+Test Description: Match on IP Protocol and Wildcard rest
+
+Test mode: Automated
+Test Tile: IPprotocol
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+
+
+
+
+11. Single Header Field: IP Tos bits
+
+Test Description: Match on IP Tos bits and Wildcard rest
+
+Test mode: Automated
+Test Tile: IpTos
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = nw_tos (say x) , action output to egress_port
+b) Send a tcp packet with (nw_tos=x)
+c) Verify packet was recieved on egress_port
+b) Send a tcp packet with (nw_tos = y)
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+12. Single Header Field: Transport Source Port
+
+Test Description: Match on Transport Src Port and Wildcard rest
+
+Test mode: Automated
+Test Tile: TcpSrcPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = tp_src (say x) , action output to egress_port
+b) Send a tcp packet with (tp_src=x)
+c) Verify packet was recieved on egress_port
+b) Send a tcp packet with tp_src= y)
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+13. Single Header Field: Transport Destination Port
+
+Test Description: Match on Transport Dst Port and Wildcard rest
+
+Test mode: Automated
+Test Tile: TcpDstPort
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = tp_dst (say x) , action output to egress_port
+b) Send a tcp packet with (tp_dst=x)
+c) Verify packet was recieved on egress_port
+b) Send a tcp packet with tp_dst = y)
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+
+14. Multiple Header Fields: L2
+
+
+Test Description: Match on Ethernet Type, Ethernet Source Address, Ethernet Destination Address and Wildcard rest
+
+Test mode: Automated
+Test Tile: MultipleHeaderFieldL2
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = dl_type (say x), dl_src (say y ), dl_dst (say z), action output to egress_port
+b) Send a eth packet with dl_type (say x), dl_src (say y ), dl_dst (say z)
+c) Verify packet was recieved on egress_port
+b) Send a eth packet with dl_type (say w), dl_src (say v ), dl_dst (say f)
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+15. Multiple Header Fields: L3 ------> TBD
+
+
+
+
+16. Multiple Header Fields: L4
+
+Test Description: Match on Tcp Source Port, Tcp Destination Port
+
+Test mode: Automated
+Test Tile: MultipleHeaderFieldL4
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with match = tp_src (say x), tp_dst (say y )
+b) Send a tcp packet with tp_src (say x), tp_dst (say y )
+c) Verify packet was recieved on egress_port
+b) Send a eth packet with tcp_src (say w), tcp_dst (say v )
+e) Verify PacketIn event was triggered on the control plane
+
+
+
+17. All Header Fields: Exact Match flows
+
+Test Description: Verify exact flow matches are possible
+
+Test mode: Automated
+Test Tile: ExactMatch
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert a flow with exact match, action output to egress_port
+b) Send packet matching the flow
+c) Verify packet received on egress_port
+d) Send a non-matching packet
+e) Verify PacketIn event gets triggered
+
+
+
+18. Exact Match Highest Priority
+
+Test Description: An exact match flow entry has a highest priority compared to other flow entries
+
+Test mode: Automated
+Test Tile: ExactMatchHigh
+POrts: 4 (1 Control Plane 3 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert two overlapping flows:
+ Exact Match (prio = p ) action egress_port
+ Wildacrd All (prio = p+ ) action egress_port2
+b) Send packet matching the flows
+c) Verify packet received on egress_port
+
+
+
+
+19. Wildcard Match Highest Priority
+
+Test Description: If Wildcard flow entries have priority associated with them.
+ Higher priority Wildcard flow overrides the lower priroty Wildcard flow
+
+Test mode: Automated
+Test Tile: WildcardMatchHigh
+POrts: 4 (1 Control Plane 3 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
+
+
+Test Notes:
+
+a) Insert two wildcarded flows :
+ Wildcard All Except ingress (prio = p ) , action = egress_port
+ Wildcard All (prio = p+ ) ,action = egress_port2
+b) Send packet matching the flows
+c) Verify packet is recieved on egress_port2
+
+
+
+20. Fragment TCP Segments ------> TBD
+
+Test Description: Create flow matching on tcp port number. Verify that fragmented packets always match that flow rule.
+
+Test mode: Automated
+Test Tile: FragTcpSeg
+POrts: 3 (1 Control Plane 2 Data Plane)
+Initial State: Default (Clear switch state), Connection setup
+Test-Field: Mandatory
diff --git a/Fabric/Doc/docs/Doxyfile b/Fabric/Doc/docs/Doxyfile
new file mode 100644
index 0000000..85cfc63
--- /dev/null
+++ b/Fabric/Doc/docs/Doxyfile
@@ -0,0 +1,1417 @@
+# Doxyfile 1.5.6
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME =
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
+# and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = YES
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = "../src/python/oftest" "../tests"
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS = "*.py"
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER = "python /usr/bin/doxypy.py"
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hiererachy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW = NONE
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME = FreeSans
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is enabled by default, which results in a transparent
+# background. Warning: Depending on the platform used, enabling this option
+# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
+# become hard to read).
+
+DOT_TRANSPARENT = YES
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = NO
diff --git a/Fabric/Doc/docs/flow_query_test_plan.txt b/Fabric/Doc/docs/flow_query_test_plan.txt
new file mode 100644
index 0000000..22742dc
--- /dev/null
+++ b/Fabric/Doc/docs/flow_query_test_plan.txt
@@ -0,0 +1,378 @@
+
+
+DRAFT TEST PLAN FOR TESTING TOP-HALF OF OpenFlow 1.0 SWITCH
+
+Draft 2 - 23 Apr 2012
+
+
+
+1. GENERAL
+===========
+
+1.1 Test particular implementation, not OpenFlow protocol
+
+This test plan is intended to test the function of those features of an OF
+agent implementation that would be particular to a given switch,
+i.e. semantics of various OF operations are correctly implemented on a given
+switch.
+It is NOT intended to test:
+- syntactic featues, such as badly formed OF protocol messages, etc., nor
+- semantic features that would be common to all implementations, e.g.
+ qualifying on a VLAN id > 4095, an action to set VLAN PCP to a value > 7,
+ etc.
+
+
+2. FLOW ADD
+============
+
+2.5 FLOW ADD 5
+---------------
+
+OVERVIEW
+- Add flows to switch, read back and verify flow configurations
+
+PURPOSE
+- Test acceptance of flow adds
+- Test ability of switch to process additions to flow table in random
+ priority order
+- Test correctness of flow configuration responses
+
+INPUTS
+- NUM_FLOWS: number of flows to define; 0 => maximum number of flows, as
+ determined from switch capabilities
+
+PROCESS
+1. Delete all flows from switch
+2. Generate NUM_FLOWS distinct flow configurations
+3. Send NUM_FLOWS flow adds to switch, for flows generated in step 2 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+4. Verify that no OFPT_ERROR responses were generated by switch
+5. Retrieve flow stats from switch
+6. Compare flow configurations returned by switch
+7. Test PASSED iff all flows sent to switch in step 3 above are returned in
+ step 5 above; else test FAILED
+
+NOTES
+- Will use randomized flow configuration, in an attempt to cover combinations
+ of qualifier wildcarding, qualifier values, actions and action parameters
+
+
+2.5.1 FLOW ADD 5.1
+-------------------
+
+OVERVIEW
+- Verify flow canonicalization
+
+PURPOSE
+- Test that switch properly canonicalizes a given flow definition
+ (canonicalization is defined as wildcarding out qualifiers when antecedent
+ qualifiers are not set correctly, e.g. nw_tos cannot be specified, and hence
+ must be wildcarded, if dl_type is not specified to be 0x0800 (IP))
+
+INPUTS
+None
+
+PROCESS
+1. Delete all flows from switch
+2. Generate 1 flow definition, which is different from its canonicalization
+3. Send flow to switch
+4. Retrieve flow from switch
+5. Compare returned flow to canonical form of defined flow
+7. Test PASSED iff flow received in step 4 above is identical to canonical
+ form of flow defined in step 3 above
+
+
+2.6 FLOW ADD 6
+---------------
+
+OVERVIEW
+- Test flow table capacity
+
+PURPOSE
+- Test switch can accept as many flow definitions as it claims
+- Test generation of OFPET_FLOW_MOD_FAILED/OFPFMFC_ALL_TABLES_FULL
+- Test that attempting to create flows beyond capacity does not corrupt flow
+ table
+
+INPUTS
+None
+
+PROCESS
+1. Delete all flows from switch
+2. Send OFPT_FEATURES_REQUEST to determine switch features
+3. For each table reported by step 2 above, send OFPT_STATS_REQUEST/
+ OFPST_TABLE to determine table features
+4. Generate (N + 1) distinct flow configurations, where N is the flow capacity
+ reported by the switch in steps 2 and 3 above
+ - Flow wildcarding must obey supported wildcards, for each table
+5. Send (N + 1) flow adds to switch, for flows generated in step 4 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+6. Verify that OFPET_FLOW_MOD_FAILED/OFPFMFC_ALL_TABLES_FULL error response
+ was generated by switch, for last flow mod sent
+7. Retrieve flow stats from switch
+8. Compare flow configurations returned by switch
+9. Test PASSED iff:
+ - error message received, for correct flow
+ - last flow definition sent to switch is not in flow table
+ else test FAILED
+
+
+2.7 FLOW ADD 7
+---------------
+
+OVERVIEW
+- Test flow redefinition
+
+PURPOSE
+- Verify that successive flow adds with same priority and match criteria
+ overwrite in flow table
+
+INPUTS
+None
+
+PROCESS
+1. Delete all flows from switch
+2. Generate flow definition F1
+3. Generate flow definition F2, with same key (priority and match) as F1,
+ but with different actions
+4. Send flow adds for F1 and F2 to switch
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+5. Retrieve flow stats from switch
+6. Compare flow configurations returned by switch
+7. Test PASSED iff 1 flow returned by switch, matching configuration of F2,
+ and with counters equal to 0; else test FAILED
+
+
+2.8 FLOW ADD 8
+---------------
+
+OVERVIEW
+- Add overlapping flows to switch, verify that overlapping flows are rejected
+
+PURPOSE
+- Test detection of overlapping flows by switch
+- Test generation of OFPET_FLOW_MOD_FAILED/OFPFMFC_OVERLAP messages
+- Test rejection of overlapping flows
+- Test defining overlapping flows does not corrupt flow table
+
+INPUTS
+None
+
+PROCESS
+1. Delete all flows from switch
+2. Generate flow definition F1
+3. Generate flow definition F2, with key overlapping F1, by wildcarding a
+ qualifier specified in F1
+4. Send flow adds to switch, for flows generated in steps 2 and 3 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 1 (check for overlap)
+4. Verify that OFPET_FLOW_MOD_FAILED/OFPFMFC_OVERLAP error response was
+ generated by switch
+5. Retrieve flow stats from switch
+6. Compare flow configurations returned by switch
+7. Test PASSED iff:
+ - error message received, for overlapping flow
+ - overlapping flow is not in flow table
+ else test FAILED
+
+
+3. FLOW MODIFY
+===============
+
+3.1 FLOW MODIFY 1
+------------------
+
+OVERVIEW
+- Strict modify of single existing flow
+
+PURPOSE
+- Verify that strict flow modify operates only on specified flow
+- Verify that flow is correctly modified
+
+INPUTS
+- NUM_FLOWS: number of flows to define; 0 => maximum number of flows,
+ as determined from switch capabilities
+
+PROCESS
+1. Delete all flows from switch
+2. Generate NUM_FLOWS distinct flow configurations
+3. Send NUM_FLOWS flow adds to switch, for flows generated in step 2 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+4. Pick 1 defined flow F at random
+5. Generate new action list for F
+6. Send flow modify for F to switch
+4. Verify that no OFPT_ERROR responses were generated by switch
+5. Retrieve flow stats from switch
+6. Compare flow configurations returned by switch
+7. Test PASSED iff all flows sent to switch in step 3 and 6 above are
+ returned in step 5 above; else test FAILED
+
+
+3.2 FLOW MODIFY 2
+------------------
+
+OVERVIEW
+- Loose modify of existing flows
+
+PURPOSE
+- Verify that loose flow modify operates only on matching flows
+- Verify that matching flows are correctly modified
+
+INPUTS
+- NUM_FLOWS: number of flows to define; 0 => maximum number of flows, as
+ determined from switch capabilities
+
+PROCESS
+1. Delete all flows from switch
+2. Generate NUM_FLOWS distinct flow configurations
+3. Send NUM_FLOWS flow adds to switch, for flows generated in step 2 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+4. Pick 1 defined flow F at random
+5. Wildcard out 1 qualifier in match of F, creating F', such that F' will
+ match more than 1 existing flow key, and create new actions list A' for F'
+6. Send loose flow modify for F' to switch
+7. Retrieve flow stats from switch
+8. Compare flow configurations returned by switch
+9. Test PASSED iff all flows sent to switch in steps 3 and 6 above, are
+ returned in step 7 above, each with correct (original or modified) action
+ list;
+ else test FAILED
+
+
+3.3 FLOW MODIFY 3
+------------------
+
+OVERVIEW
+- Strict modify of non-existent flow
+
+PRUPOSE
+- Verify that strict modify of a non-existent flow is equivalent to a flow add
+
+INPUTS
+None
+
+PROCESS
+1. Delete all flows from switch
+2. Send strict flow modify to switch
+3. Retrieve flows from switch
+4. Test PASSED iff single flow defined in step 2 above is returned in step 3
+ above; else test FAILED
+
+
+3.3.1 FLOW MODIFY 3_1
+---------------------
+
+OVERVIEW
+- No-op modify
+
+PURPOSE
+- Verify that modify of a flow with new actions same as old ones operates
+ correctly
+
+PARAMETERS
+None
+
+PROCESS
+1. Delete all flows from switch
+2. Send single flow mod, as strict modify, to switch
+3. Verify flow table in switch
+4. Send same flow mod, as strict modify, to switch
+5. Verify flow table in switch
+6. Test PASSED iff flow defined in step 2 and 4 above verified; else FAILED
+
+
+4. FLOW DELETE
+===============
+
+4.1 FLOW DELETE 1
+------------------
+
+OVERVIEW
+- Strict delete of single flows
+
+PURPOSE
+- Verify correct operation of strict delete of single defined flow
+
+INPUTS
+- NUM_FLOWS: Number of flows to define; 0 => maximum number of flows, as
+ determined fro switch capabilities
+
+PROCESS
+1. Delete all flows from switch
+2. Generate NUM_FLOWS distinct flow configurations
+3. Send NUM_FLOWS flow adds to switch, for flows generated in step 2 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+4. Pick 1 defined flow F at random
+5. Send strict flow delete for F to switch
+6. Retrieve flow stats from switch
+7. Compare flow configurations returned by switch
+8. Test PASSED iff all flows sent to switch in step 3 above, less flow
+ removed in step 5 above, are returned in step 5 above; else test FAILED
+
+
+4.2 FLOW DELETE 2
+------------------
+
+OVERVIEW
+- Loose delete of flows
+
+PURPOSE
+- Verify correct operation of loose delete of multiple flows
+
+INPUTS
+- NUM_FLOWS: Number of flows to define; 0 => maximum number of flows, as
+ determined fro switch capabilities
+
+PROCESS
+1. Delete all flows from switch
+2. Generate NUM_FLOWS distinct flow configurations
+3. Send NUM_FLOWS flow adds to switch, for flows generated in step 2 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 0 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+4. Pick 1 defined flow F at random
+5. Wildcard out 1 qualifier in match of F, creating F', such that F' will
+ match more than 1 existing flow key
+6. Send loose flow delete for F' to switch
+7. Retrieve flow stats from switch
+8. Compare flow configurations returned by switch
+9. Test PASSED iff all flows sent to switch in step 3 above, less flows
+ removed in step 6 above (i.e. those that match F'), are returned in step
+ 5 above;
+ else test FAILED
+
+
+4.4 FLOW DELETE 4
+------------------
+
+OVERVIEW
+- Flow removed messages
+
+PURPOSE
+- Verify that switch generates OFPT_FLOW_REMOVED/OFPRR_DELETE response
+ messages when deleting flows that were added with OFPFF_SEND_FLOW_REM flag
+
+INPUTS
+- NUM_FLOWS: Number of flows to define; 0 => maximum number of flows, as
+ determined fro switch capabilities
+
+PROCESS
+1. Delete all flows from switch
+2. Generate NUM_FLOWS distinct flow configurations
+3. Send NUM_FLOWS flow adds to switch, for flows generated in step 2 above
+ - Flow mods with OFPFF_SEND_FLOW_REM = 1 (do not send remove message) and
+ OFPFF_CHECK_OVERLAP = 0 (do not check for overlap)
+4. Pick 1 defined flow F at random
+5. Send strict flow delete for F to switch
+6. Verify that OFPT_FLOW_REMOVED/OFPRR_DELETE message is received from switch
+7. Retrieve flow stats from switch
+8. Compare flow configurations returned by switch
+9. Test PASSED iff all flows sent to switch in step 3 above, less flow
+ removed in step 5 above, are returned in step 5 above; else test FAILED
+
+
diff --git a/Fabric/Doc/docs/images/oftest_arch.png b/Fabric/Doc/docs/images/oftest_arch.png
new file mode 100644
index 0000000..e752d1b
--- /dev/null
+++ b/Fabric/Doc/docs/images/oftest_arch.png
Binary files differ
