trema 0.3.16 → 0.3.17

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

@@ -0,0 +1,142 @@
+Feature: Ruby methods for adding switch event forwarding entry
+  
+  There are three Ruby methods provided for adding switch event forwarding entries:
+  
+  * add_forward_entry_to_all_switches
+  * add_forward_entry_to_switch
+  * add_forward_entry_to_switch_manager
+  
+  These methods can be used by including the Trema::SwitchEvent module
+  in user controller code. 
+  
+  * ** add_forward_entry_to_all_switches event_type, trema_name **
+  
+  This method will add `trema_name` to all existing switches and switch manager's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  * ** add_forward_entry_to_switch dpid, event_type, trema_name **
+  
+  This method will add an entry to a switch specified by `dpid`. 
+  It will add `trema_name` to the switch's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  * ** add_forward_entry_to_switch_manager event_type, trema_name **
+  
+  This method will add `trema_name` to the switch manager's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  ----
+  All the above methods take a result handler as Ruby block, but 
+  can be omitted if checking is not necessary.
+
+  Scenario Outline: add_forward_entry_to_all_switches event_type, trema_name
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      """
+    And a file named "AddEntryToAllTest.rb" with:
+      """
+      class AddEntryToAllTest < Controller
+        include SwitchEvent
+      
+        def switch_ready datapath_id
+          add_forward_entry_to_all_switches <event_type>, "new_controller" do | success |
+            raise "Failed to add forwarding entry to all switches" if not success
+            info "Successfully added a forwarding entry of <event_type>."
+            dump_forward_entries_from_switch datapath_id, <event_type> do | success, services |
+              raise "Failed to dump forwarding entry from a switch" if not success
+              info "Dumping switch #{datapath_id.to_hex}'s forwarding entries of <event_type> : #{services.inspect}"
+            end
+            dump_forward_entries_from_switch_manager <event_type> do | success, services |
+              raise "Failed to dump forwarding entry from the switch manager" if not success
+              info "Dumping switch manager's forwarding entries of <event_type> : #{services.inspect}"
+            end
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./AddEntryToAllTest.rb -c nw_dsl.conf -d`
+    And wait until "AddEntryToAllTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/AddEntryToAllTest.log" should contain:
+      """
+      Successfully added a forwarding entry of <event_type>.
+      """
+    And the file "../../tmp/log/AddEntryToAllTest.log" should contain:
+      """
+      Dumping switch manager's forwarding entries of <event_type> : [<switch_manager_event_list>]
+      """
+    And the file "../../tmp/log/AddEntryToAllTest.log" should contain:
+      """
+      Dumping switch 0x1's forwarding entries of <event_type> : [<switch_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_manager_event_list             | switch_event_list                                       |
+      | :vendor       | "new_controller", "AddEntryToAllTest" | "new_controller", "AddEntryToAllTest"                   |
+      | :packet_in    | "new_controller", "AddEntryToAllTest" | "new_controller", "AddEntryToAllTest"                   |
+      | :port_status  | "new_controller", "AddEntryToAllTest" | "new_controller", "AddEntryToAllTest"                   |
+      | :state_notify | "new_controller", "AddEntryToAllTest" | "new_controller", "AddEntryToAllTest", "switch_manager" |
+
+  Scenario Outline: add_forward_entry_to_switch dpid, event_type, trema_name
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      """
+    And a file named "AddEntryToSwitchDaemonTest.rb" with:
+      """
+      class AddEntryToSwitchDaemonTest < Controller
+        include SwitchEvent
+      
+        def switch_ready datapath_id
+          add_forward_entry_to_switch datapath_id, <event_type>, "new_controller" do | success, services |
+            raise "Failed to add forwarding entry to switch" if not success
+            info "Successfully added a forwarding entry of <event_type> to switch #{datapath_id.to_hex} : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./AddEntryToSwitchDaemonTest.rb -c nw_dsl.conf -d`
+    And wait until "AddEntryToSwitchDaemonTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/AddEntryToSwitchDaemonTest.log" should contain:
+      """
+      Successfully added a forwarding entry of <event_type> to switch 0x1 : [<switch_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_event_list                                                |
+      | :vendor       | "new_controller", "AddEntryToSwitchDaemonTest"                   |
+      | :packet_in    | "new_controller", "AddEntryToSwitchDaemonTest"                   |
+      | :port_status  | "new_controller", "AddEntryToSwitchDaemonTest"                   |
+      | :state_notify | "new_controller", "AddEntryToSwitchDaemonTest", "switch_manager" |
+
+  Scenario Outline: add_forward_entry_to_switch_manager event_type, trema_name
+    Given a file named "AddEntryToSwitchManagerTest.rb" with:
+      """
+      class AddEntryToSwitchManagerTest < Controller
+        include SwitchEvent
+        
+        oneshot_timer_event :test_start, 0
+        def test_start
+          add_forward_entry_to_switch_manager <event_type>, "new_controller" do | success, services |
+            raise "Failed to add forwarding entry to switch manager" if not success
+            info "Successfully added a forwarding entry of <event_type> to switch manager : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./AddEntryToSwitchManagerTest.rb -d`
+    And wait until "AddEntryToSwitchManagerTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/AddEntryToSwitchManagerTest.log" should contain:
+      """
+      Successfully added a forwarding entry of <event_type> to switch manager : [<switch_manager_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_manager_event_list                       |
+      | :vendor       | "new_controller", "AddEntryToSwitchManagerTest" |
+      | :packet_in    | "new_controller", "AddEntryToSwitchManagerTest" |
+      | :port_status  | "new_controller", "AddEntryToSwitchManagerTest" |
+      | :state_notify | "new_controller", "AddEntryToSwitchManagerTest" |

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

@@ -0,0 +1,142 @@
+Feature: Ruby methods for deleting switch event forwarding entry
+  
+  There are three Ruby methods provided for deleting switch event forwarding entries.
+  
+  * delete_forward_entry_from_all_switches
+  * delete_forward_entry_from_switch
+  * delete_forward_entry_from_switch_manager
+  
+  These methods can be used by including the Trema::SwitchEvent module
+  in user controller code. 
+  
+  * ** delete_forward_entry_from_all_switches event_type, trema_name **
+  
+  This method will delete `trema_name` from all existing switches and switch manager's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  * ** delete_forward_entry_from_switch dpid, event_type, trema_name **
+  
+  This method will delete an entry from switch specified by `dpid`. 
+  It will delete `trema_name` from the switch's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  * ** delete_forward_entry_from_switch_manager event_type, trema_name **
+  
+  This method will delete `trema_name` from the switch manager's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  ----
+  All the above methods take a result handler as Ruby block, but 
+  they can be omitted if checking is not necessary.
+
+  Scenario Outline: delete_forward_entry_from_all_switches event_type, trema_name
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      """
+    And a file named "DeleteEntryFromAllTest.rb" with:
+      """
+      class DeleteEntryFromAllTest < Controller
+        include SwitchEvent
+      
+        def switch_ready datapath_id
+          delete_forward_entry_from_all_switches <event_type>, "DeleteEntryFromAllTest" do | success |
+            raise "Failed to delete forwarding entry from all switches" if not success
+            info "Successfully deleted a forwarding entry of <event_type>."
+            dump_forward_entries_from_switch datapath_id, <event_type> do | success, services |
+              raise "Failed to dump forwarding entry from a switch" if not success
+              info "Dumping switch #{datapath_id.to_hex}'s forwarding entries of <event_type> : #{services.inspect}"
+            end
+            dump_forward_entries_from_switch_manager <event_type> do | success, services |
+              raise "Failed to dump forwarding entry from the switch manager" if not success
+              info "Dumping switch manager's forwarding entries of <event_type> : #{services.inspect}"
+            end
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./DeleteEntryFromAllTest.rb -c nw_dsl.conf -d`
+    And wait until "DeleteEntryFromAllTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/DeleteEntryFromAllTest.log" should contain:
+      """
+      Successfully deleted a forwarding entry of <event_type>.
+      """
+    And the file "../../tmp/log/DeleteEntryFromAllTest.log" should contain:
+      """
+      Dumping switch 0x1's forwarding entries of <event_type> : [<switch_event_list>]
+      """
+    And the file "../../tmp/log/DeleteEntryFromAllTest.log" should contain:
+      """
+      Dumping switch manager's forwarding entries of <event_type> : [<switch_manager_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_manager_event_list | switch_event_list |
+      | :vendor       |                           |                   |
+      | :packet_in    |                           |                   |
+      | :port_status  |                           |                   |
+      | :state_notify |                           | "switch_manager"  |
+
+  Scenario Outline: delete_forward_entry_from_switch dpid, event_type, trema_name
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      """
+    And a file named "DeleteFromSwitchDaemonTest.rb" with:
+      """
+      class DeleteFromSwitchDaemonTest < Controller
+        include SwitchEvent
+      
+        def switch_ready datapath_id
+          delete_forward_entry_from_switch datapath_id, <event_type>, "DeleteFromSwitchDaemonTest" do | success, services |
+            raise "Failed to delete forwarding entry from switch" if not success
+            info "Successfully deleted a forwarding entry of <event_type> from switch #{datapath_id.to_hex} : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./DeleteFromSwitchDaemonTest.rb -c nw_dsl.conf -d`
+    And wait until "DeleteFromSwitchDaemonTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/DeleteFromSwitchDaemonTest.log" should contain:
+      """
+      Successfully deleted a forwarding entry of <event_type> from switch 0x1 : [<switch_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_event_list |
+      | :vendor       |                   |
+      | :packet_in    |                   |
+      | :port_status  |                   |
+      | :state_notify | "switch_manager"  |
+
+  Scenario Outline: delete_forward_entry_from_switch_manager event_type, trema_name
+    Given a file named "DeleteFromSwitchManagerTest.rb" with:
+      """
+      class DeleteFromSwitchManagerTest < Controller
+        include SwitchEvent
+      
+        oneshot_timer_event :test_start, 0
+        def test_start
+          delete_forward_entry_from_switch_manager <event_type>, "DeleteFromSwitchManagerTest" do | success, services |
+            raise "Failed to delete forwarding entry from switch manager" if not success
+            info "Successfully deleted a forwarding entry of <event_type> from switch manager : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./DeleteFromSwitchManagerTest.rb -d`
+    And wait until "DeleteFromSwitchManagerTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/DeleteFromSwitchManagerTest.log" should contain:
+      """
+      Successfully deleted a forwarding entry of <event_type> from switch manager : [<switch_manager_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_manager_event_list |
+      | :vendor       |                           |
+      | :packet_in    |                           |
+      | :port_status  |                           |
+      | :state_notify |                           |

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

@@ -0,0 +1,91 @@
+Feature: Ruby methods for dumping switch event forwarding entry
+  
+  There are two Ruby methods provided for dumping switch event forwarding entry.
+  
+  * dump_forward_entries_from_switch
+  * dump_forward_entries_from_switch_manager
+  
+  These methods can be used by including the Trema::SwitchEvent module
+  in user controller code. 
+  
+  * ** dump_forward_entries_from_switch dpid, event_type **
+  
+  This method will dump the forwarding entries of the switch specified by `dpid`. 
+  It will dump the content of the the switch's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  * ** dump_forward_entries_from_switch_manager event_type **
+  
+  This method will dump the content of the the switch manager's 
+  event forwarding entry list of the specified `event_type`.  
+  
+  ----
+  All the above methods take a result handler as Ruby block.
+
+  Scenario Outline: dump_forward_entries_from_switch dpid, event_type
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      event :vendor => "vendor", :packet_in => "packet_in", :port_status => "port_status"
+      """
+    And a file named "DumpSwitchDaemonTest.rb" with:
+      """
+      class DumpSwitchDaemonTest < Controller
+        include SwitchEvent
+      
+        def switch_ready datapath_id
+          dump_forward_entries_from_switch datapath_id, <event_type> do | success, services |
+            raise "Failed to dump forwarding entry from a switch" if not success
+            info "Dumping switch #{datapath_id.to_hex}'s forwarding entries of <event_type> : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./DumpSwitchDaemonTest.rb -c nw_dsl.conf -d`
+    And wait until "DumpSwitchDaemonTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/DumpSwitchDaemonTest.log" should contain:
+      """
+      Dumping switch 0x1's forwarding entries of <event_type> : [<switch_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_event_list                        |
+      | :vendor       | "vendor"                                 |
+      | :packet_in    | "packet_in"                              |
+      | :port_status  | "port_status"                            |
+      | :state_notify | "DumpSwitchDaemonTest", "switch_manager" |
+
+  Scenario Outline: dump_forward_entries_from_switch_manager event_type
+    Given a file named "nw_dsl.conf" with:
+      """
+      event :vendor => "vendor", :packet_in => "packet_in", :port_status => "port_status", :state_notify => "state_notify"
+      """
+    And a file named "DumpSwitchManagerTest.rb" with:
+      """
+      class DumpSwitchManagerTest < Controller
+        include SwitchEvent
+      
+        oneshot_timer_event :test_start, 0
+        def test_start
+          dump_forward_entries_from_switch_manager <event_type> do | success, services |
+            raise "Failed to dump forwarding entry from the switch manager" if not success
+            info "Dumping switch manager's forwarding entries of <event_type> : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./DumpSwitchManagerTest.rb -c nw_dsl.conf -d`
+    And wait until "DumpSwitchManagerTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/DumpSwitchManagerTest.log" should contain:
+      """
+      Dumping switch manager's forwarding entries of <event_type> : [<switch_manager_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_manager_event_list |
+      | :vendor       | "vendor"                  |
+      | :packet_in    | "packet_in"               |
+      | :port_status  | "port_status"             |
+      | :state_notify | "state_notify"            |

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

@@ -0,0 +1,90 @@
+Feature: Ruby methods for setting switch event forwarding entry
+  
+  There are two Ruby methods provided for setting switch event forwarding entry.
+  
+  * set_forward_entries_to_switch
+  * set_forward_entries_to_switch_manager
+  
+  These methods can be used by including the Trema::SwitchEvent module
+  in user controller code. 
+  
+  * ** set_forward_entries_to_switch dpid, event_type, trema_names **
+  
+  This method will set the forwarding entries of the switch specified by `dpid`. 
+  It will replace the switch's 
+  event forwarding entry list of the specified `event_type` 
+  to Array of trema-names specified by `trema_names`. 
+    
+  
+  * ** set_forward_entries_to_switch_manager event_type, trema_names **
+  
+  This method will replace the switch manager's 
+  event forwarding entry list of the specified `event_type`
+  to Array of trema-names specified by `trema_names`. 
+  
+  ----
+  All the above methods take a result handler as Ruby block, but 
+  they can be omitted if checking is not necessary.
+
+  Scenario Outline: set_forward_entries_to_switch dpid, event_type, trema_names
+    Given a file named "nw_dsl.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      """
+    And a file named "SetEntriesToSwitchDaemonTest.rb" with:
+      """
+      class SetEntriesToSwitchDaemonTest < Controller
+        include SwitchEvent
+      
+        def switch_ready datapath_id
+          set_forward_entries_to_switch datapath_id, <event_type>, ["SetEntriesToSwitchDaemonTest","Another"] do | success, services |
+            raise "Failed to set forwarding entry to switch" if not success
+            info "Successfully set a forwarding entries of <event_type> to switch #{datapath_id.to_hex} : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./SetEntriesToSwitchDaemonTest.rb -c nw_dsl.conf -d`
+    And wait until "SetEntriesToSwitchDaemonTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/SetEntriesToSwitchDaemonTest.log" should contain:
+      """
+      Successfully set a forwarding entries of <event_type> to switch 0x1 : [<switch_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_event_list                         |
+      | :vendor       | "SetEntriesToSwitchDaemonTest", "Another" |
+      | :packet_in    | "SetEntriesToSwitchDaemonTest", "Another" |
+      | :port_status  | "SetEntriesToSwitchDaemonTest", "Another" |
+      | :state_notify | "SetEntriesToSwitchDaemonTest", "Another" |
+
+  Scenario Outline: set_forward_entries_to_switch_manager event_type, trema_names
+    Given a file named "SetEntriesToSwitchManagerTest.rb" with:
+      """
+      class SetEntriesToSwitchManagerTest < Controller
+        include SwitchEvent
+      
+        oneshot_timer_event :test_start, 0
+        def test_start
+          set_forward_entries_to_switch_manager <event_type>, ["SetEntriesToSwitchManagerTest","Another"] do | success, services |
+            raise "Failed to set forwarding entry to switch manager" if not success
+            info "Successfully set a forwarding entries of <event_type> to switch manager : #{services.inspect}"
+          end
+        end
+      end
+      """
+    When I successfully run `trema run ./SetEntriesToSwitchManagerTest.rb -d`
+    And wait until "SetEntriesToSwitchManagerTest" is up
+    And *** sleep 1 ***
+    Then the file "../../tmp/log/SetEntriesToSwitchManagerTest.log" should contain:
+      """
+      Successfully set a forwarding entries of <event_type> to switch manager : [<switch_manager_event_list>]
+      """
+
+    Examples: 
+      | event_type    | switch_manager_event_list                  |
+      | :vendor       | "SetEntriesToSwitchManagerTest", "Another" |
+      | :packet_in    | "SetEntriesToSwitchManagerTest", "Another" |
+      | :port_status  | "SetEntriesToSwitchManagerTest", "Another" |
+      | :state_notify | "SetEntriesToSwitchManagerTest", "Another" |