trema 0.4.7 → 0.4.8

data/features/.nav

@@ -1,50 +0,0 @@
-- trema_commands:
-  - version_option.feature
-  - help_option.feature
-  - run.feature
-  - kill.feature
-  - up.feature
-  - killall.feature
-  - send_packets.feature
-  - port_up.feature
-  - port_down.feature
-  - show_stats.feature
-  - reset_stats.feature
-  - dump_flows.feature
-  - version.feature
-  - help.feature
-- dsl:
-  - switch_port_specifier.feature
-- examples:
-  - hello_trema.feature
-  - list_switches.feature
-  - switch_monitor.feature
-  - switch_info.feature
-  - patch_panel.feature
-  - packet_in.feature
-  - dumper.feature
-  - repeater_hub.feature
-  - learning_switch.feature
-  - multi_learning_switch.feature
-  - openflow_message.hello.feature
-  - openflow_message.echo.feature
-  - openflow_message.features_request.feature
-  - message.set_config.feature
-  - message.vendor-action.feature
-  - packetin_filter_config.feature
-- switch_event:
-  - 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
-- handlers:
-  - switch_ready.feature
-- core:
-  - switch_manager.feature
-  - packetin_filter.feature
-  - trema-config.feature
-  - get_pid_by_trema_name.feature

data/features/README.md

@@ -1,7 +0,0 @@
-## Issues
-
-This documentation is
-[open source](https://github.com/trema/trema/tree/develop/features),
-and a work in progress. If you find it incomplete or confusing, please
-[submit an isssue](https://github.com/trema/trema/issues), or, better
-yet, [a pull request](https://github.com/trema/trema/pulls).

data/features/core/get_pid_by_trema_name.feature

@@ -1,137 +0,0 @@
-Feature: get_pid_by_trema_name()
-  
-  The function get_pid_by_trema_name() returns the PID of the process 
-  specified by its `name` argument. 
-  If the `name` is not found, the function returns -1. 
-  
-      pid_t get_pid_by_trema_name( const char *name )
-  
-  The `name` argument refers to controller process name called *trema-name*. 
-  In the trema framework the trema-name is a unique identifier assigned to 
-  each controller process. 
-  It is determined automatically by the following rules: 
-  
-  **Rule 1:** When you start a Ruby controller:
-  
-      class TopologyController < Controller
-        ...
-      end
-  
-      $ trema run topology-controller.rb
-  
-  then its trema-name is set to "TopologyController", 
-  which is the same as the class name.  
-  
-  **Rule 2:** When you start a C controller:
-  
-      $ trema run topology_controller
-  
-  then its trema-name is set to "topology_controller", 
-  which is same as the executable name.  
-  
-  **Rule 3:** Trema-name can be overwritten using the `-n` or `--name`
-  option given by the `trema run` command. 
-  
-      $ trema run "topology_controller -n topology"
-      $ trema run "topology_controller --name=topology"
-
-  Background: 
-    Given a file named "print_pid.c" with:
-      """
-      #include <stdio.h>
-      #include "trema.h"
-      
-      int
-      main( int argc, char* argv[] ) {
-        init_trema( &argc, &argv );
-        
-        if ( argc >= 2 ) {
-          pid_t pid = get_pid_by_trema_name( argv[ 1 ] );
-          if ( pid == -1 ) {
-            printf( "No such process : %s\n", argv[ 1 ] );
-          }
-          else {
-            printf( "PID of %s = %d\n", argv[ 1 ], pid );
-          }
-        }
-        
-        finalize_trema();
-        return 0;
-      }
-      """
-    And I compile "print_pid.c" into "print_pid"
-    And a file named "c_controller.c" with:
-      """
-      #include "trema.h"
-      
-      int
-      main( int argc, char* argv[] ) {
-        init_trema( &argc, &argv );
-        start_trema();
-        return 0;
-      }
-      """
-    And I compile "c_controller.c" into "c_controller"
-
-  Scenario: Getting the PID of a Ruby controller process with a default name.
-    Given a file named "RubyController.rb" with:
-      """
-      class RubyController < Controller
-      end
-      """
-    And I run `trema run ./RubyController.rb -d`
-    And wait until "RubyController" is up
-    When I run `trema run "./print_pid RubyController"`
-    Then the output should match:
-      """
-      PID of RubyController = \d+
-      """
-
-  Scenario: Getting the PID of a C controller process with a default name.
-    Given I run `trema run "./c_controller" -d`
-    And wait until "c_controller" is up
-    When I run `trema run "./print_pid c_controller"`
-    Then the output should match:
-      """
-      PID of c_controller = \d+
-      """
-
-  Scenario: Getting the PID of a C controller process renamed through CLI option '-n'.
-    Given I run `trema run "./c_controller -n NewName" -d`
-    And wait until "NewName" is up
-    When I run `trema run "./print_pid NewName"`
-    Then the output should match:
-      """
-      PID of NewName = \d+
-      """
-
-  Scenario: Getting the PID of a C controller process renamed through CLI option '--name'.
-    Given I run `trema run "./c_controller --name=NewName" -d`
-    And wait until "NewName" is up
-    When I run `trema run "./print_pid NewName"`
-    Then the output should match:
-      """
-      PID of NewName = \d+
-      """
-
-  @wip
-  Scenario: Getting the PID of a Ruby controller process renamed through CLI option '-n'.
-    Given a file named "RubyController.rb" with:
-      """
-      class RubyController < Controller
-      end
-      """
-    And I run `trema run "./RubyController.rb -n NewName" -d`
-    And wait until "NewName" is up
-    When I run `trema run "./print_pid NewName"`
-    Then the output should match:
-      """
-      PID of NewName = \d+
-      """
-
-  Scenario: Getting the PID of non-existent controller returns an error code -1.
-    When I run `trema run "./print_pid NO_SUCH_TREMA_PROCESS"`
-    Then the output should match:
-      """
-      No such process : NO_SUCH_TREMA_PROCESS
-      """

data/features/core/packetin_filter.feature

@@ -1,55 +0,0 @@
-Feature: packetin_filter help
-
-  As a Trema user
-  I want to see the help message of packetin_filter command
-  So that I can learn how to use packetin_filter
-
-  @wip
-  Scenario: packetin_filter --help
-    When I try to run "./objects/packetin_filter/packetin_filter --help"
-    Then the output should be:
-      """
-      OpenFlow Packet in Filter.
-      Usage: packetin_filter [OPTION]... [PACKETIN-FILTER-RULE]...
-
-        -n, --name=SERVICE_NAME         service name
-        -d, --daemonize                 run in the background
-        -l, --logging_level=LEVEL       set logging level
-        -g, --syslog                    output log messages to syslog
-        -f, --logging_facility=FACILITY set syslog facility
-        -h, --help                      display this help and exit
-
-      PACKETIN-FILTER-RULE:
-        match-type::destination-service-name
-
-      match-type:
-        lldp                            LLDP ethernet frame type and priority is 0x8000
-        packet_in                       any packet and priority is zero
-
-      destination-service-name          destination service name
-      """
-
-  @wip
-  Scenario: packetin_filter -h
-    When I try to run "./objects/packetin_filter/packetin_filter -h"
-    Then the output should be:
-      """
-      OpenFlow Packet in Filter.
-      Usage: packetin_filter [OPTION]... [PACKETIN-FILTER-RULE]...
-
-        -n, --name=SERVICE_NAME         service name
-        -d, --daemonize                 run in the background
-        -l, --logging_level=LEVEL       set logging level
-        -g, --syslog                    output log messages to syslog
-        -f, --logging_facility=FACILITY set syslog facility
-        -h, --help                      display this help and exit
-
-      PACKETIN-FILTER-RULE:
-        match-type::destination-service-name
-
-      match-type:
-        lldp                            LLDP ethernet frame type and priority is 0x8000
-        packet_in                       any packet and priority is zero
-
-      destination-service-name          destination service name
-      """

data/features/core/switch_manager.feature

@@ -1,41 +0,0 @@
-Feature: switch_manager help
-
-  As a Trema user
-  I want to see the help message of switch_manager command
-  So that I can learn how to use switch_manager
-
-  @wip
-  Scenario: switch_manager --help
-    When I try to run "./objects/switch_manager/switch_manager --help"
-    Then the output should be:
-      """
-      OpenFlow Switch Manager.
-      Usage: switch_manager [OPTION]... [-- SWITCH_MANAGER_OPTION]...
-
-        -s, --switch=PATH               the command path of switch
-        -n, --name=SERVICE_NAME         service name
-        -p, --port=PORT                 server listen port (default 6653)
-        -d, --daemonize                 run in the background
-        -l, --logging_level=LEVEL       set logging level
-        -g, --syslog                    output log messages to syslog
-        -f, --logging_facility=FACILITY set syslog facility
-        -h, --help                      display this help and exit
-      """
-
-  @wip
-  Scenario: switch_manager -h
-    When I try to run "./objects/switch_manager/switch_manager -h"
-    Then the output should be:
-      """
-      OpenFlow Switch Manager.
-      Usage: switch_manager [OPTION]... [-- SWITCH_MANAGER_OPTION]...
-
-        -s, --switch=PATH               the command path of switch
-        -n, --name=SERVICE_NAME         service name
-        -p, --port=PORT                 server listen port (default 6653)
-        -d, --daemonize                 run in the background
-        -l, --logging_level=LEVEL       set logging level
-        -g, --syslog                    output log messages to syslog
-        -f, --logging_facility=FACILITY set syslog facility
-        -h, --help                      display this help and exit
-      """

data/features/core/trema-config.feature

@@ -1,55 +0,0 @@
-Feature: trema-config command
-
-  In order to specify C compiler options easily
-  As a developer using Trema
-  I want to use trema-config command
-
-  Scenario: trema-config --cflags
-    When I run `trema-config --cflags`
-    Then the output should match /^-I\S+lib -I\S+openflow$/
-
-  Scenario: trema-config -c
-    When I run `trema-config -c`
-    Then the output should match /^-I\S+lib -I\S+openflow$/
-
-  Scenario: trema-config --libs
-    When I run `trema-config --libs`
-    Then the output should match /^-L\S+lib -l.*/
-
-  Scenario: trema-config -l
-    When I run `trema-config -l`
-    Then the output should match /^-L\S+lib -l.*/
-
-  Scenario: trema-config --cflags --libs
-    When I run `trema-config --cflags --libs`
-    Then the output should match /^-I\S+lib -I\S+openflow -L\S+lib -l.*/
-
-  Scenario: trema-config -c --libs
-    When I run `trema-config -c --libs`
-    Then the output should match /^-I\S+lib -I\S+openflow -L\S+lib -l.*/
-
-  Scenario: trema-config --cflags -l
-    When I run `trema-config --cflags -l`
-    Then the output should match /^-I\S+lib -I\S+openflow -L\S+lib -l.*/
-
-  Scenario: trema-config -c -l
-    When I run `trema-config -c -l`
-    Then the output should match /^-I\S+lib -I\S+openflow -L\S+lib -l.*/
-
-  Scenario: trema-config --help
-    When I run `trema-config --help`
-    Then the output should contain:
-      """
-      Usage: trema-config [OPTIONS ...]
-          -c, --cflags
-          -l, --libs
-      """
-
-  Scenario: trema-config -h
-    When I run `trema-config -h`
-    Then the output should contain:
-      """
-      Usage: trema-config [OPTIONS ...]
-          -c, --cflags
-          -l, --libs
-      """

data/features/dsl/switch_port_specifier.feature

@@ -1,15 +0,0 @@
-@wip @ruby
-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/dumper.feature

@@ -1,35 +0,0 @@
-Feature: "Dumper" sample application
-
-  In order to learn how to dump miscellaneous OpenFlow messages
-  As a developer using Trema
-  I want to execute "Dumper" sample application
-
-  Background:
-    Given a file named "dumper.conf" with:
-      """
-      vswitch("dumper") { datapath_id 0xabc }
-
-      vhost("host1")
-      vhost("host2")
-
-      link "dumper", "host1"
-      link "dumper", "host2"
-      """
-
-  @slow_process @critical @ruby
-  Scenario: Run "Dumper" Ruby example
-    Given I run `trema run ../../src/examples/dumper/dumper.rb -c dumper.conf -d`
-     And wait until "Dumper" is up
-    When I send 1 packet from host1 to host2
-    Then the file "../../tmp/log/Dumper.log" should contain "[switch_ready]"
-     And the file "../../tmp/log/Dumper.log" should contain "[packet_in]"
-     And the file "../../tmp/log/Dumper.log" should contain "datapath_id: 0xabc"
-
-  @slow_process
-  Scenario: Run "Dumper" C example
-    Given I run `trema run ../../objects/examples/dumper/dumper -c dumper.conf -d`
-     And wait until "dumper" is up
-    When I send 1 packet from host1 to host2
-    Then the file "../../tmp/log/dumper.log" should contain "[switch_ready]"
-     And the file "../../tmp/log/dumper.log" should contain "[packet_in]"
-     And the file "../../tmp/log/dumper.log" should contain "datapath_id: 0xabc"

data/features/examples/hello_trema.feature

@@ -1,23 +0,0 @@
-Feature: "Hello Trema!" example
-
-  The "Hello Trema!" example ([trema]/src/examples/hello_trema/) is one
-  of the simplest OpenFlow controller implementation. The basic
-  functionality of this controller is to establish a secure channel connection
-  with an OpenFlow switch and output the "Hello [switch's dpid]!" message.
-
-  This demonstrates a minimum template for Trema applications written in Ruby
-  or C. Hence it's a good starting point to learn about Trema programming.
-
-  Background:
-    Given I cd to "../../src/examples/hello_trema/"
-
-  @slow_process @critical @ruby
-  Scenario: Run the Ruby example
-    When I run `trema run ./hello-trema.rb -c sample.conf` interactively
-    Then the output should contain "Hello 0xabc!" within the timeout period
-
-  @slow_process
-  Scenario: Run the C example
-    Given I compile "hello_trema.c" into "hello_trema"
-    When I run `trema run ./hello_trema -c sample.conf` interactively
-    Then the output should contain "Hello 0xabc!" within the timeout period

data/features/examples/learning_switch.feature

@@ -1,37 +0,0 @@
-Feature: "Learning Switch" sample application
-
-  In order to learn how to implement software L2 switch
-  As a developer using Trema
-  I want to execute "Learning Switch" sample application
-
-  Background:
-    Given a file named "learning_switch.conf" with:
-      """
-      vswitch("learning") { datapath_id "0xabc" }
-
-      vhost("host1") { ip "192.168.0.1" }
-      vhost("host2") { ip "192.168.0.2" }
-
-      link "learning", "host1"
-      link "learning", "host2"
-      """
-
-  @slow_process @ruby
-  Scenario: Run "Learning Switch" Ruby example
-    Given I run `trema run ../../src/examples/learning_switch/learning-switch.rb -c learning_switch.conf -d`
-     And wait until "LearningSwitch" is up
-    When I send 1 packet from host1 to host2
-     And I run `trema show_stats host1 --tx`
-     And I run `trema show_stats host2 --rx`
-    Then the output from "trema show_stats host1 --tx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"
-     And the output from "trema show_stats host2 --rx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"
-
-  @slow_process
-  Scenario: Run "Learning Switch" C example
-    Given I run `trema run ../../objects/examples/learning_switch/learning_switch -c learning_switch.conf -d`
-     And wait until "learning_switch" is up
-    When I send 1 packet from host1 to host2
-     And I run `trema show_stats host1 --tx`
-     And I run `trema show_stats host2 --rx`
-    Then the output from "trema show_stats host1 --tx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"
-     And the output from "trema show_stats host2 --rx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"