phut 0.7.7 → 0.7.8

data/bin/vhost

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
@@ -10,6 +11,7 @@ require 'phut'
 module Phut
   class VhostDaemon
     # /bin/vhost command
+    # rubocop:disable BlockLength
     module App
       extend GLI::App
 
@@ -18,51 +20,50 @@ module Phut
       desc 'Runs a vhost process'
       command :run do |c|
         desc 'Host name'
-        c.flag [:n, :name]
+        c.flag %i[n name]
         desc 'Network interface'
-        c.flag [:I, :interface]
+        c.flag %i[I interface]
         desc 'IP address'
-        c.flag [:i, :ip_address]
+        c.flag %i[i ip_address]
         desc 'MAC address'
-        c.flag [:m, :mac_address]
+        c.flag %i[m mac_address]
         c.desc 'ARP entries'
-        c.flag [:a, :arp_entries], negatable: false
+        c.flag %i[a arp_entries], negatable: false
         c.desc 'Promisc mode'
-        c.switch [:p, :promisc], negatable: false
+        c.switch %i[p promisc], negatable: false
 
         c.desc 'Location to put pid files'
-        c.flag [:P, :pid_dir], default_value: Phut.pid_dir
+        c.flag %i[P pid_dir], default_value: Phut.pid_dir
         c.desc 'Location to put log files'
-        c.flag [:L, :log_dir], default_value: Phut.log_dir
+        c.flag %i[L log_dir], default_value: Phut.log_dir
         c.desc 'Location to put socket files'
-        c.flag [:S, :socket_dir], default_value: Phut.socket_dir
+        c.flag %i[S socket_dir], default_value: Phut.socket_dir
 
-        c.action do |_global_options, options, _args|
-          fail '--name option is mandatory' if options[:name].nil?
-          fail '--interface option is mandatory' if options[:interface].nil?
-          fail '--ip_address option is mandatory' if options[:ip_address].nil?
-          fail '--mac_address option is mandatory' if options[:mac_address].nil?
-          options[:arp_table] =
-            options[:arp_entries].split(',').
+        c.action do |_global_opts, opts, _args|
+          raise '--name option is mandatory' if opts[:name].nil?
+          raise '--ip_address option is mandatory' if opts[:ip_address].nil?
+          raise '--mac_address option is mandatory' if opts[:mac_address].nil?
+          opts[:arp_table] =
+            (opts[:arp_entries] || '').split(',').
             each_with_object({}) do |each, table|
               ip_address, mac_address = each.split('/')
               table[ip_address] = mac_address
             end
-          VhostDaemon.new(options).run
+          VhostDaemon.new(opts).run
         end
       end
 
       desc 'Terminates a vhost process'
       command :stop do |c|
         desc 'Host name'
-        c.flag [:n, :name]
+        c.flag %i[n name]
         c.desc 'Location to put socket files'
-        c.flag [:S, :socket_dir], default_value: Phut.socket_dir
+        c.flag %i[S socket_dir], default_value: Phut.socket_dir
 
-        c.action do |_global_options, options, _args|
-          fail '--name option is mandatory' if options[:name].nil?
+        c.action do |_global_opts, opts, _args|
+          raise '--name option is mandatory' if opts[:name].nil?
           begin
-            VhostDaemon.process(options[:name], options[:socket_dir]).stop
+            VhostDaemon.process(opts[:name], opts[:socket_dir]).kill
           rescue DRb::DRbConnError
             true # OK
           end
@@ -72,11 +73,11 @@ module Phut
       desc 'Sends UDP packets to destination host'
       command :send_packets do |c|
         desc 'Source host name'
-        c.flag [:s,  :source]
+        c.flag %i[s source]
 
-        c.action do |_global_options, options, _args|
-          fail '--source option is mandatory' if options[:source].nil?
-          VhostDaemon.process(options[:source], options[:socket_dir]).
+        c.action do |_global_opts, opts, _args|
+          raise '--source option is mandatory' if opts[:source].nil?
+          VhostDaemon.process(opts[:source], opts[:socket_dir]).
             send_packets
         end
       end
@@ -85,5 +86,6 @@ module Phut
 
       exit run(ARGV)
     end
+    # rubocop:enable BlockLength
   end
 end

data/features/{dsl.feature → dsl/error.feature}

@@ -1,26 +1,28 @@
 Feature: DSL parser
+  @sudo
   Scenario: name conflict (vsiwtch and vswitch)
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
       """ruby
       vswitch { dpid 0xabc }
       vswitch { dpid 0xabc }
       """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then the exit status should not be 0
     And the stderr should contain:
       """
-      The name 0xabc conflicts with vswitch (name = 0xabc, dpid = 0xabc).
+      a Vswitch #<Vswitch name: "0xabc", dpid: 0xabc, openflow_version: 1.0, tcp_port: 6653> already exists
       """
 
+  @sudo
   Scenario: name conflict (vhost and vhost)
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
       """ruby
       vhost { ip '192.168.0.1' }
       vhost { ip '192.168.0.1' }
       """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then the exit status should not be 0
     And the stderr should contain:
       """
-      The name 192.168.0.1 conflicts with vhost (name = 192.168.0.1, IP address = 192.168.0.1).
+      error: 192.168.0.1 is already running
       """

data/features/{dsl_link.feature → dsl/link.feature}

@@ -1,29 +1,29 @@
 Feature: The link directive of phut DSL
   @sudo
   Scenario: link name_a, name_b
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
       """
       vswitch { dpid 0xabc }
       vhost { ip '192.168.0.1' }
       link '0xabc', '192.168.0.1'
       """
-    When I do phut run "network.conf"
-    Then a link is created between "0xabc" and "192.168.0.1"
+    When I do phut run "phut.conf"
+    Then a link between "0xabc" and "192.168.0.1" should be created
 
   @sudo
   Scenario: link alias_a, alias_b
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
       """
       vswitch('my_switch') { dpid 0xabc }
       vhost('host1') { ip '192.168.0.1' }
       link 'my_switch', 'host1'
       """
-    When I do phut run "network.conf"
-    Then a link is created between "my_switch" and "host1"
+    When I do phut run "phut.conf"
+    Then a link between "my_switch" and "host1" should be created
 
   @sudo
   Scenario: connect multiple links to a switch
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
       """
       vswitch { datapath_id 0xabc }
 
@@ -41,11 +41,8 @@ Feature: The link directive of phut DSL
       link '0xabc', 'host2'
       link '0xabc', 'host3'
       """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     And I run `phut show 0xabc`
-    Then a link is created between "0xabc" and "host1"
-    And a link is created between "0xabc" and "host2"
-    And a link is created between "0xabc" and "host3"
-    And the output from "phut show 0xabc" should contain "1(0xabc_1)"
-    And the output from "phut show 0xabc" should contain "2(0xabc_2)"
-    And the output from "phut show 0xabc" should contain "3(0xabc_3)"
+    Then a link between "0xabc" and "host1" should be created
+    And a link between "0xabc" and "host2" should be created
+    And a link between "0xabc" and "host3" should be created

data/features/dsl/netns.feature

@@ -0,0 +1,115 @@
+Feature: The netns DSL directive.
+  @sudo
+  Scenario: phut run with "netns(name)"
+    Given a file named "phut.conf" with:
+      """
+      netns('host1')
+      """
+    When I do phut run "phut.conf"
+    Then a netns named "host1" should be started
+
+  @sudo
+  Scenario: ip option (no device)
+    Given a file named "phut.conf" with:
+      """
+      netns('host1') {
+        ip '192.168.0.1'
+      }
+      """
+    When I do phut run "phut.conf"
+    Then a netns named "host1" should be started
+    And the IP address of the netns "host1" should not be set
+
+  @sudo
+  Scenario: ip option
+    Given a file named "phut.conf" with:
+      """
+      netns('host1') {
+        ip '192.168.0.1'
+      }
+      netns('host2') {
+        ip '192.168.0.2'
+      }
+      link 'host1', 'host2'
+      """
+    When I do phut run "phut.conf"
+    Then the IP address of the netns "host1" should be "192.168.0.1"
+    And the IP address of the netns "host2" should be "192.168.0.2"
+
+  @sudo
+  Scenario: netmask option
+    Given a file named "phut.conf" with:
+      """
+      netns('host1') {
+        ip '192.168.0.1'
+        netmask '255.255.255.0'
+      }
+      netns('host2') {
+        ip '192.168.0.2'
+        netmask '255.255.255.128'
+      }
+      link 'host1', 'host2'
+      """
+    When I do phut run "phut.conf"
+    Then the netmask of the netns "host1" should be "255.255.255.0"
+    And the netmask of the netns "host2" should be "255.255.255.128"
+
+  @sudo
+  Scenario: mac option
+    Given a file named "phut.conf" with:
+      """
+      netns('host1') {
+        ip '192.168.0.1'
+        mac '00:00:ba:dc:ab:1e'
+      }
+      netns('host2') {
+        ip '192.168.0.2'
+        mac '00:ac:ce:55:1b:1e'
+      }
+      link 'host1', 'host2'
+      """
+    When I do phut run "phut.conf"
+    Then the MAC address of the netns "host1" should be "00:00:ba:dc:ab:1e"
+    And the MAC address of the netns "host2" should be "00:ac:ce:55:1b:1e"
+
+  @sudo
+  Scenario: route option
+    Given a file named "phut.conf" with:
+      """
+      netns('host1') {
+        ip '192.168.0.1'
+        netmask '255.255.255.0'
+        route net: '0.0.0.0', gateway: '192.168.0.254'
+      }
+      netns('host2') {
+        ip '192.168.1.2'
+        netmask '255.255.255.0'
+        route net: '0.0.0.0', gateway: '192.168.1.254'
+      }
+      link 'host1', 'host2'
+      """
+    When I do phut run "phut.conf"
+    Then the netns "host1" have the following route:
+      |     net |       gateway |
+      | 0.0.0.0 | 192.168.0.254 |
+    And the netns "host2" have the following route:
+      |     net |       gateway |
+      | 0.0.0.0 | 192.168.1.254 |
+
+  @sudo
+  Scenario: vlan option
+    Given a file named "phut.conf" with:
+      """
+      netns('host1') {
+        ip '192.168.0.1'
+        vlan 10
+      }
+      netns('host2') {
+        ip '192.168.1.2'
+        vlan 20
+      }
+      link 'host1', 'host2'
+      """
+    When I do phut run "phut.conf"
+    Then the VLAN of the netns "host1" should be "10"
+    And the VLAN of the netns "host2" should be "20"

data/features/dsl/vhost.feature

@@ -0,0 +1,37 @@
+Feature: The vhost DSL directive.
+  @sudo
+  Scenario: phut run with "vhost { ip ... }"
+    Given a file named "phut.conf" with:
+    """
+    vhost { ip '192.168.0.1' }
+    vhost { ip '192.168.0.2' }
+    link '192.168.0.1', '192.168.0.2'
+    """
+    When I do phut run "phut.conf"
+    Then a vhost named "192.168.0.1" should be running
+    And a vhost named "192.168.0.2" should be running
+
+  @sudo
+  Scenario: phut run with "vhost(alias) { ... }"
+    Given a file named "phut.conf" with:
+    """
+    vhost('host1') { ip '192.168.0.1' }
+    vhost('host2') { ip '192.168.0.2' }
+    link 'host1', 'host2'
+    """
+    When I do phut run "phut.conf"
+    Then a vhost named "host1" should be running
+    And a vhost named "host2" should be running
+
+  @sudo
+  Scenario: phut run with "vhost(alias)"
+    Given a file named "phut.conf" with:
+    """
+    vhost('host1')
+    vhost('host2')
+    link 'host1', 'host2'
+    """
+    When I do phut run "phut.conf"
+    Then a vhost named "host1" should be running
+    And a vhost named "host2" should be running
+

data/features/{dsl_vswitch.feature → dsl/vswitch.feature}

@@ -1,52 +1,52 @@
 @sudo
 Feature: The vswitch DSL directive.
   Scenario: vswitch { dpid STRING }
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
     """
     vswitch { dpid '0xabc' }
     """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then a vswitch named "0xabc" (controller port = 6653) should be running
 
   Scenario: vswitch { dpid NUMBER }
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
     """
     vswitch { dpid 0xabc }
     """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then a vswitch named "0xabc" (controller port = 6653) should be running
 
   Scenario: vswitch { datapath_id STRING }
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
     """
     vswitch { datapath_id '0xabc' }
     """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then a vswitch named "0xabc" (controller port = 6653) should be running
 
   Scenario: vswitch { datapath_id NUMBER }
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
     """
     vswitch { datapath_id 0xabc }
     """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then a vswitch named "0xabc" (controller port = 6653) should be running
 
   Scenario: vswitch { dpid ...; port NUMBER }
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
     """
     vswitch {
       datapath_id 0xabc
       port 1234
     }
     """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then a vswitch named "0xabc" (controller port = 1234) should be running
 
   Scenario: vswitch(alias) { ... }
-    Given a file named "network.conf" with:
+    Given a file named "phut.conf" with:
     """
     vswitch('my_switch') { datapath_id '0xabc' }
     """
-    When I do phut run "network.conf"
+    When I do phut run "phut.conf"
     Then a vswitch named "my_switch" (controller port = 6653) should be running

data/features/phut_run.feature

@@ -0,0 +1,15 @@
+Feature: phut run command
+  Scenario: pid_dir doesn't exist error
+    When I run `phut run --pid_dir foo phut.conf`
+    Then the exit status should not be 0
+    And the output should contain "error: No such directory: foo"
+
+  Scenario: log_dir doesn't exist error
+    When I run `phut run --log_dir foo phut.conf`
+    Then the exit status should not be 0
+    And the output should contain "error: No such directory: foo"
+
+  Scenario: socket_dir doesn't exist error
+    When I run `phut run --socket_dir foo phut.conf`
+    Then the exit status should not be 0
+    And the output should contain "error: No such directory: foo"

data/features/shell/vswitch#destroy.feature

@@ -0,0 +1,10 @@
+Feature: Vswitch#destroy
+  Background:
+    Given I run `phut -v` interactively
+
+  @sudo
+  Scenario: Vswitch#stop 
+    Given I type "vswitch = Vswitch.create(dpid: 0xabc)"
+    When I type "vswitch.destroy"
+    And sleep 5
+    Then a vswitch named "0xabc" should not be running

data/features/shell/vswitch#ports.feature

@@ -0,0 +1,36 @@
+Feature: Vswitch#ports
+
+  TODO: Vswitch#ports should return an array of Port object
+  that contains its port number
+
+  Background:
+    Given I run `phut -v` interactively
+    And I type "vswitch = Vswitch.create(dpid: 0xabc)"
+
+  @sudo
+  Scenario: Vswitch#ports #=> []
+    When I type "vswitch.ports"
+    And sleep 5
+    Then the output should contain "[]"
+
+  @sudo
+  Scenario: Vswitch#ports
+    Given I type "link = Link.create('a', 'b')"
+    And I type "vswitch.add_port link.device('a')"
+    When I type "vswitch.ports"
+    And sleep 5
+    Then the output should contain:
+     """
+     ["L0_a"]
+     """
+
+  @sudo
+  Scenario: Vswitch#ports
+    Given I type "link = Link.create('a', 'b')"
+    And I type "vswitch.add_numbered_port 2, link.device('a')"
+    When I type "vswitch.ports"
+    And sleep 5
+    Then the output should contain:
+     """
+     ["L0_a"]
+     """