trema 0.3.16 → 0.3.17

data/features/.nav

@@ -13,7 +13,19 @@
   - dump_flows.feature
   - version.feature
   - help.feature
+- dsl:
+  - switch_port_specifier.feature
 - examples:
+  - switch-event:
+    - README.md
+    - add_forward_entry.feature
+    - delete_forward_entry.feature
+    - dump_forward_entries.feature
+    - set_forward_entries.feature
+    - C-add_forward_entry.feature
+    - C-delete_forward_entry.feature
+    - C-dump_forward_entries.feature
+    - C-set_forward_entries.feature
   - hello_trema.feature
   - list_switches.feature
   - switch_monitor.feature

data/features/dsl/switch_port_specifier.feature

@@ -0,0 +1,15 @@
+@wip
+Feature: Switch Port Specifier
+  By adding a postfix (`:port#`) to the switch's name found in the `link` directive you can specify the exact port number to be used when the link is created.
+
+      vswitch( "switch" ) { dpid 0xabc }
+      vhost "host1"
+      vhost "host2"
+      vhost "host3"
+      link "host1", "switch:1"  # Connects host1 to switch-port #1
+      link "host2", "switch:2"  # Connects host2 to switch-port #2
+      link "host3", "switch:3"  # Connects host3 to switch-port #3
+
+  The reason why this feature required is that if the port number is not explicitly specified, trema randomly determines this. Which might be sufficient for some simple test cases but it is inadequate for other complex test cases.
+
+  Therefore, if you wish to test your controllers rigorously on a configured virtual network you might find the `switch_name:port_number` syntax useful. It is also useful to be able to send packets to destined hosts or switches via the specified ports by using `SendOutPort` actions.

data/features/examples/switch-event/C-add_forward_entry.feature

@@ -0,0 +1,130 @@
+Feature: C function example command "add_forward_entry"
+  
+  Switch Event forwarding configuration command (`add_forward_entry`)
+  is a command to add an event forwarding entry to 
+  Switch Manager and Switch Daemons.
+  
+  Following switch event types can be configured by this command:
+  
+  * vendor
+  * packet_in
+  * port_stat
+  * state_notify
+  
+  This command is a simple usage example for C version of switch event forwarding API.
+  C version API is defined as a group of functions declared in event_forward_interface.h.
+  These functions are used in topology manager to 
+  add itself to packet_in forwarding entry of all existing switch daemons and 
+  switch manager to receive LLDP packets.
+  By adding and removing entry for 'topology' from some switches, it is possible to make 
+  topology manager to map only a subset of the switches managed by trema.
+  
+  Please see README.md for general notes on switch event forwarding API.
+
+  Background: 
+    Given I cd to "../../src/examples/switch_event_config/"
+    And I compile "add_forward_entry.c" into "add_forward_entry"
+    And I compile "dump_forward_entries.c" into "dump_forward_entries"
+
+  Scenario: add_forward_entry Usage
+    When I successfully run `trema run './add_forward_entry -h'`
+    Then the output should contain:
+      """
+      Add OpenFlow Switch Manager/Daemon event forward entry.
+       Both Switch Mgr/Daemon: add_forward_entry -t EVENT_TYPE service_name
+       Only Switch Manager   : add_forward_entry -m -t EVENT_TYPE service_name
+       Only Switch Daemon    : add_forward_entry -s SWITCH_DPID -t EVENT_TYPE service_name
+      
+       EVENT_TYPE:
+        -t, --type={vendor,packet_in,port_status,state_notify} Specify event type.
+      """
+
+  Scenario Outline: Add 'mirror' to All Switch Manager/Daemon's event forwarding entries of packet_in
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './add_forward_entry -t packet_in mirror'`
+    Then the output should contain "Operation Succeeded."
+    And I successfully run `trema run './dump_forward_entries <option> -t packet_in'`
+    And the output should contain "Current service name list:"
+    And the output should match /.*  RepeaterHub.*/
+    And the output should match /.*  mirror.*/
+
+    Examples: 
+      | target | option |
+      | SW MGR | -m     |
+      | SW 0x1 | -s 0x1 |
+      | SW 0x2 | -s 0x2 |
+
+  Scenario Outline: Switch added after event forwarding entry manipulation should also reflect new configuration of Switch Manager.
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    And I successfully run `trema run './add_forward_entry -t packet_in mirror'`
+    And the output should contain "Operation Succeeded."
+    And a file named "switch_event_config_add.conf" with:
+      """
+      vswitch { datapath_id 0x3 }
+      """
+    And I successfully run `trema run -c switch_event_config_add.conf -d`
+    When I successfully run `trema run './dump_forward_entries <option> -t packet_in'`
+    Then the output should contain "Current service name list:"
+    And the output should match /.*  RepeaterHub.*/
+    And the output should match /.*  mirror.*/
+
+    Examples: 
+      | target | option |
+      | SW 0x3 | -s 0x3 |
+      | SW MGR | -m     |
+      | SW 0x1 | -s 0x1 |
+      | SW 0x2 | -s 0x2 |
+
+  Scenario Outline: Add 'mirror' only to Switch Manager's event forwarding entry of packet_in
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './add_forward_entry -m -t packet_in mirror'`
+    Then the output should contain "Updated service name list:"
+    And the output should contain "  RepeaterHub"
+    And the output should contain "  mirror"
+    And I successfully run `trema run './dump_forward_entries -s <switch> -t packet_in'`
+    And the output should match /Current service name list:.*  RepeaterHub/
+    And the output should not match /Current service name list:.*  mirror/
+
+    Examples: 
+      | switch |
+      | 0x1    |
+      | 0x2    |
+
+  Scenario Outline: Add 'mirror' only to Switch Daemon 0x1's event forwarding entries of packet_in
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './add_forward_entry -s 0x1 -t packet_in mirror'`
+    Then the output should contain "Updated service name list:"
+    And the output should contain "  RepeaterHub"
+    And the output should contain "  mirror"
+    And I successfully run `trema run './dump_forward_entries <option> -t packet_in'`
+    And the output should match /Current service name list:.*  RepeaterHub/
+    And the output should not match /Current service name list:.*  mirror/
+
+    Examples: 
+      | target | option |
+      | SW MGR | -m     |
+      | SW 0x2 | -s 0x2 |

data/features/examples/switch-event/C-delete_forward_entry.feature

@@ -0,0 +1,97 @@
+Feature: C function example command "delete_forward_entry"
+  
+  Switch Event forwarding configuration command (`delete_forward_entry`)
+  is a command to delete an event forwarding entry from 
+  Switch Manager and Switch Daemons.
+  
+  Following switch event types can be configured by this command:
+  
+  * vendor
+  * packet_in
+  * port_stat
+  * state_notify
+  
+  This command is a simple usage example for C version of switch event forwarding API.
+  C version API is defined as a group of functions declared in event_forward_interface.h.
+  These functions are used in topology manager to 
+  add itself to packet_in forwarding entry of all existing switch daemons and 
+  switch manager to receive LLDP packets.
+  By adding and removing entry for 'topology' from some switches, it is possible to make 
+  topology manager to map only a subset of the switches managed by trema.
+  
+  Please see README.md for general notes on switch event forwarding API.
+
+  Background: 
+    Given I cd to "../../src/examples/switch_event_config/"
+    And I compile "delete_forward_entry.c" into "delete_forward_entry"
+    And I compile "dump_forward_entries.c" into "dump_forward_entries"
+
+  Scenario: delete_forward_entry Usage
+    When I successfully run `trema run './delete_forward_entry -h'`
+    Then the output should contain:
+      """
+      Delete OpenFlow Switch Manager/Daemon event forward entry.
+       Both Switch Mgr/Daemon: delete_forward_entry -t EVENT_TYPE service_name
+       Only Switch Manager   : delete_forward_entry -m -t EVENT_TYPE service_name
+       Only Switch Daemon    : delete_forward_entry -s SWITCH_DPID -t EVENT_TYPE service_name
+      
+       EVENT_TYPE:
+        -t, --type={vendor,packet_in,port_status,state_notify} Specify event type.
+      """
+
+  Scenario Outline: Delete 'RepeaterHub' from All Switch Manager/Daemon's event forwarding entries of packet_in
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './delete_forward_entry -t packet_in RepeaterHub '`
+    Then the output should contain "Operation Succeeded."
+    And I successfully run `trema run './dump_forward_entries <option> -t packet_in'`
+    And the output should not match /Current service name list:.*  RepeaterHub/
+
+    Examples: 
+      | target | option |
+      | SW MGR | -m     |
+      | SW 0x1 | -s 0x1 |
+      | SW 0x2 | -s 0x2 |
+
+  Scenario Outline: Delete 'RepeaterHub' only from Switch Manager's event forwarding entries of packet_in
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './delete_forward_entry -m -t packet_in RepeaterHub'`
+    Then the output should contain "Updated service name list is empty."
+    And the output should not contain "  RepeaterHub"
+    And I successfully run `trema run './dump_forward_entries -s <switch> -t packet_in'`
+    And the output should match /Current service name list:.*  RepeaterHub/
+
+    Examples: 
+      | switch |
+      | 0x1    |
+      | 0x2    |
+
+  Scenario Outline: Delete 'RepeaterHub' only from Switch Daemon 0x1's event forwarding entries of packet_in
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './delete_forward_entry -s 0x1 -t packet_in RepeaterHub'`
+    Then the output should contain "Updated service name list is empty."
+    And the output should not contain "  RepeaterHub"
+    And I successfully run `trema run './dump_forward_entries <option> -t packet_in'`
+    And the output should match /Current service name list:.*  RepeaterHub/
+
+    Examples: 
+      | target | option |
+      | SW MGR | -m     |
+      | SW 0x2 | -s 0x2 |

data/features/examples/switch-event/C-dump_forward_entries.feature

@@ -0,0 +1,80 @@
+Feature: C function example command "dump_forward_entries"
+  
+  Switch Event forwarding configuration command (`dump_forward_entries`)
+  is a command to dump event forwarding entries of 
+  Switch Manager and Switch Daemons.
+  
+  Following switch event types can be configured by this command:
+  
+  * vendor
+  * packet_in
+  * port_stat
+  * state_notify
+  
+  This command is a simple usage example for C version of switch event forwarding API.
+  C version API is defined as a group of functions declared in event_forward_interface.h.
+  These functions are used in topology manager to 
+  add itself to packet_in forwarding entry of all existing switch daemons and 
+  switch manager to receive LLDP packets.
+  By adding and removing entry for 'topology' from some switches, it is possible to make 
+  topology manager to map only a subset of the switches managed by trema.
+  
+  Please see README.md for general notes on switch event forwarding API.
+
+  Background: 
+    Given I cd to "../../src/examples/switch_event_config/"
+    And I compile "dump_forward_entries.c" into "dump_forward_entries"
+
+  Scenario: dump_forward_entries Usage
+    When I successfully run `trema run './dump_forward_entries -h'`
+    Then the output should contain:
+      """
+      Dump OpenFlow Switch Manager/Daemon event forward entries.
+       Switch Manager: dump_forward_entries -m -t EVENT_TYPE
+       Switch Daemon : dump_forward_entries -s SWITCH_DPID -t EVENT_TYPE
+      
+       EVENT_TYPE:
+        -t, --type={vendor,packet_in,port_status,state_notify} Specify event type.
+      """
+
+  Scenario Outline: Dump Switch Manager's event forwarding entries for each event type
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './dump_forward_entries -m -t <type>'`
+    Then the output should contain "Current service name list:"
+    And the output should contain "  RepeaterHub"
+
+    Examples: 
+      | type         |
+      | vendor       |
+      | packet_in    |
+      | port_status  |
+      | state_notify |
+
+  Scenario Outline: Dump Switch Daemon's event forwarding entries for each event type on each switch
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './dump_forward_entries -s <switch> -t <type>'`
+    Then the output should contain "Current service name list:"
+    And the output should contain "  RepeaterHub"
+
+    Examples: 
+      | switch | type         |
+      | 0x1    | vendor       |
+      | 0x1    | packet_in    |
+      | 0x1    | port_status  |
+      | 0x1    | state_notify |
+      | 0x2    | vendor       |
+      | 0x2    | packet_in    |
+      | 0x2    | port_status  |
+      | 0x2    | state_notify |

data/features/examples/switch-event/C-set_forward_entries.feature

@@ -0,0 +1,85 @@
+Feature: C function example command "set_forward_entries"
+  
+  Switch Event forwarding configuration command (`set_forward_entries`)
+  is a command to replace event forwarding entries of 
+  Switch Manager and Switch Daemons.
+  
+  Following switch event types can be configured by this command:
+  
+  * vendor
+  * packet_in
+  * port_stat
+  * state_notify
+  
+  This command is a simple usage example for C version of switch event forwarding API.
+  C version API is defined as a group of functions declared in event_forward_interface.h.
+  These functions are used in topology manager to 
+  add itself to packet_in forwarding entry of all existing switch daemons and 
+  switch manager to receive LLDP packets.
+  By adding and removing entry for 'topology' from some switches, it is possible to make 
+  topology manager to map only a subset of the switches managed by trema.
+  
+  Please see README.md for general notes on switch event forwarding API.
+
+  Background: 
+    Given I cd to "../../src/examples/switch_event_config/"
+    And I compile "set_forward_entries.c" into "set_forward_entries"
+    And I compile "dump_forward_entries.c" into "dump_forward_entries"
+
+  Scenario: set_forward_entries Usage
+    When I successfully run `trema run './set_forward_entries -h'`
+    Then the output should contain:
+      """
+      Set OpenFlow Switch Manager/Daemon event forward entries.
+       Switch Manager: set_forward_entries -m -t EVENT_TYPE service_name1,service_name2,...
+       Switch Daemon : set_forward_entries -s SWITCH_DPID -t EVENT_TYPE service_name1,service_name2,...
+      
+       EVENT_TYPE:
+        -t, --type={vendor,packet_in,port_status,state_notify} Specify event type.
+      """
+
+  Scenario Outline: Replace Switch Manager's event forwarding entries of packet_in to 'mirror' and 'filter'
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './set_forward_entries -m -t packet_in mirror,filter'`
+    Then the output should contain "Updated service name list:"
+    And the output should contain "  mirror"
+    And the output should contain "  filter"
+    And the output should not contain "  RepeaterHub"
+    And I successfully run `trema run './dump_forward_entries -s <switch> -t packet_in'`
+    And the output should match /Current service name list:.*  RepeaterHub/
+    And the output should not match /Current service name list:.*  mirror/
+    And the output should not match /Current service name list:.*  filter/
+
+    Examples: 
+      | switch |
+      | 0x1    |
+      | 0x2    |
+
+  Scenario Outline: Replace Switch Daemon 0x1's event forwarding entries of packet_in to 'mirror' and 'filter'
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      """
+    And I successfully run `trema run ../repeater_hub/repeater-hub.rb -c nw_dsl.conf -d`
+    And wait until "RepeaterHub" is up
+    When I successfully run `trema run './set_forward_entries -s 0x1 -t packet_in mirror,filter'`
+    Then the output should contain "Updated service name list:"
+    And the output should contain "  mirror"
+    And the output should contain "  filter"
+    And the output should not contain "  RepeaterHub"
+    And I successfully run `trema run './dump_forward_entries <option> -t packet_in'`
+    And the output should match /Current service name list:.*  RepeaterHub/
+    And the output should not match /Current service name list:.*  mirror.*/
+    And the output should not match /Current service name list:.*  filter.*/
+
+    Examples: 
+      | target | option |
+      | SW MGR | -m     |
+      | SW 0x2 | -s 0x2 |

data/features/examples/switch-event/README.md

@@ -0,0 +1,40 @@
+# Switch Event forwarding API
+
+This API controls the forwarding of certain type of Openflow messages received from a switch to a specified controller. 
+The processes responsible for this are Switch Manager and Switch Daemons.   
+
+This API can be used for: 
+
+* Diagnosing a controller environment:
+    * Check which controller is handling the messages from a certain switch. 
+    * Forward a copy of a message to another user-defined controller 
+      for debug level logging, etc. 
+* Dynamically change configuration to:
+    * Add/Remove a controller on a running network setup. 
+    * Replace a running controller with another controller. 
+
+Switch events, are OpenFlow messages sent from switches on various types of events,
+and forwarded to controllers based on the event forwarding entries of each Switch Daemon. 
+Initial forwarding entries of a Switch Daemon derived from the
+forwarding entries of the Switch Manager, when a switch first connects to trema. 
+
+In other words, configuring a Switch Daemon changes the behavior of
+existing connected switches, and configuring a Switch Manager changes the behavior
+of switches that may connect later on. 
+
+Following switch event types can be forwarded by this API: 
+
+* :vendor
+* :packet_in
+* :port_stat
+* :state_notify
+
+Note that this API only change where each event is forwarded, 
+and it will **not** emulate any switch events, which normally occur when a 
+switch is connected to or disconnected from a controller.
+
+* switch_ready event will **not** be generated by adding an entry to an existing switch.
+* disconnected event will **not** be generated by removing an entry from an existing switch.
+
+Please see the YARD generated document for method details.
+