phut 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 976e821178942cdc0a5ce7aae154ebbfc0f3f1bd
-  data.tar.gz: de76db53ba5388fb53a75ee06eb55157f8ffd55a
+  metadata.gz: 681a58fd291ea016d0ffc8d56a9c62fb3ab38568
+  data.tar.gz: 48d70fb96ecac1cbddb1868172d4b8a0af0163ed
 SHA512:
-  metadata.gz: 8b633f79a7e4057b6818d75313409ec16207a4ba73dd8a89a1664576caac6f6ac0033e330792b0cd85a690dc5b2c3d24f29a9fb4ee15d87003ed8319a85b23fd
-  data.tar.gz: d2533b9a48e4d5ebe38958ca2fc41076012cbb61cb0387fcca29a56a86565698c7f74abceefedead44917d3a89ab19be1985a3421f036d4ee9ea86a2a3519aba
+  metadata.gz: e2eab81e9e6b03c262a5debdcec17eb12aa3f565e99fcf27f8e904f68f84b0d1fedf1c29e6deee08a6e4e9a471c937fe8a2d9f76e0a9340e9b69009e82b63427
+  data.tar.gz: bb22c24a34980bc1f7b7284b2f81d04efac05e2345bb41bda36deb105c84a69a04108fdf0d1842b6a955eb79d452c3e9a8904aa53b7f2af72a6b3afe4736ecfc

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 ## develop (unreleased)
 
 
+## 0.4.0 (3/19/2015)
+### New features
+* Add `phut show` command.
+
+### Changes
+* [#14](https://github.com/trema/phut/issues/14): Switch port number
+  to which a virtual link is attached is implicitly determined by the
+  ordering of `link` directives in DSL file.
+
+
 ## 0.3.1 (3/17/2015)
 ### Bugs fixed
 * Set switch's dpid before connecting to a controller.
@@ -10,7 +20,8 @@
 
 ## 0.3.0 (3/17/2015)
 ### Changes
-* [#20](https://github.com/trema/phut/pull/20): Use apt installed version of Open vSwitch.
+* [#20](https://github.com/trema/phut/pull/20): Use apt installed
+  version of Open vSwitch.
 
 
 ## 0.2.4 (3/12/2015)

data/Rakefile

@@ -2,9 +2,11 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
 
 require 'rake/clean'
 
+RELISH_PROJECT = 'trema/phut'
+
 task default: :test
 task test: [:spec, :cucumber, :quality]
-task quality: [:rubocop, :reek, :flog]
 task travis: [:spec, 'cucumber:travis', :quality]
+task quality: [:rubocop, :reek, :flog, :flay]
 
 Dir.glob('tasks/*.rake').each { |each| import each }

data/bin/phut

@@ -72,6 +72,14 @@ module Phut
       end
     end
 
+    desc 'Shows information on switch'
+    arg_name 'SWITCH'
+    command :show do |c|
+      c.action do |_global_options, _options, args|
+        system "sudo ovs-ofctl show br#{args[0]}"
+      end
+    end
+
     desc 'Stops a virtual network'
     arg_name 'FILE'
     command :stop do |c|

data/features/dsl_link.feature

@@ -1,22 +1,51 @@
-Feature: The link DSL directive.
+Feature: The link directive of phut DSL
   @sudo
-  Scenario: phut run with "link ..."
+  Scenario: link name_a, name_b
     Given a file named "network.conf" with:
-    """
-    vswitch { dpid '0xabc' }
-    vhost { ip '192.168.0.1' }
-    link '0xabc', '192.168.0.1'
-    """
+      """
+      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"
 
   @sudo
-  Scenario: phut run with "link alias1, alias2"
+  Scenario: link alias_a, alias_b
     Given a file named "network.conf" with:
-    """
-    vswitch('my_switch') { dpid '0xabc' }
-    vhost('host1') { ip '192.168.0.1' }
-    link 'my_switch', 'host1'
-    """
+      """
+      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"
+
+  @sudo
+  Scenario: connect multiple links to a switch
+    Given a file named "network.conf" with:
+      """
+      vswitch { datapath_id 0xabc }
+
+      vhost('host1') {
+        ip '192.168.0.1'
+      }
+      vhost('host2') {
+        ip '192.168.0.2'
+      }
+      vhost('host3') {
+        ip '192.168.0.3'
+      }
+
+      link '0xabc', 'host1'
+      link '0xabc', 'host2'
+      link '0xabc', 'host3'
+      """
+    When I do phut run "network.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)"

data/features/shell.feature

@@ -37,6 +37,7 @@ Feature: Shell
     And I type "vswitch 0xabc"
     When I type "kill 0xabc"
     And I type "quit"
+    And I run `sleep 1`
     Then a vswitch named "0xabc" should not be running
 
   @shell

data/features/step_definitions/phut_steps.rb

@@ -7,11 +7,11 @@ When(/^I do phut run "(.*?)"$/) do |file_name|
 end
 
 Then(/^a vswitch named "(.*?)" should be running$/) do |name|
-  expect(system("sudo ovs-vsctl br-exists #{name}")).to be(true)
+  expect(system("sudo ovs-vsctl br-exists br#{name}")).to be_truthy
 end
 
 Then(/^a vswitch named "(.*?)" should not be running$/) do |name|
-  expect(system("sudo ovs-vsctl br-exists #{name}")).to be(false)
+  expect(system("sudo ovs-vsctl br-exists br#{name}")).to be_falsey
 end
 
 Then(/^a vhost named "(.*?)" launches$/) do |name|
@@ -23,9 +23,7 @@ end
 
 Then(/^a link is created between "(.*?)" and "(.*?)"$/) do |name_a, name_b|
   in_current_dir do
-    link = Phut::Parser.new.parse(@config_file).links.find do |each|
-      each.name_a == name_a && each.name_b == name_b
-    end
+    link = Phut::Parser.new.parse(@config_file).fetch([name_a, name_b].sort)
     expect(link).to be_up
   end
 end

data/lib/phut/configuration.rb

@@ -1,19 +1,41 @@
-require 'forwardable'
 require 'phut/null_logger'
 require 'phut/open_vswitch'
 
 module Phut
   # Parsed DSL data.
   class Configuration
-    extend Forwardable
-
-    def_delegators :@all, :fetch, :[]
+    attr_reader :links
 
     def initialize(logger = NullLogger.new)
       @all = {}
+      @links = []
       @logger = logger
     end
 
+    # rubocop:disable MethodLength
+    def fetch(key)
+      case key
+      when String
+        @all.fetch(key)
+      when Array
+        @links.each do |each|
+          return each if [each.name_a, each.name_b].sort == key.sort
+        end
+        fail "link #{key.join ' '} not found."
+      else
+        fail "Invalid key: #{key.inspect}"
+      end
+    end
+    # rubocop:enable MethodLength
+
+    def find_network_device_by_name(name)
+      @links.each do |each|
+        device = each.find_network_device_by_name(name)
+        return device if device
+      end
+      fail "No network device found for #{name}."
+    end
+
     def vswitches
       @all.values.select { |each| each.is_a? OpenVswitch }
     end
@@ -22,10 +44,6 @@ module Phut
       @all.values.select { |each| each.is_a? Vhost }
     end
 
-    def links
-      @all.values.select { |each| each.is_a? VirtualLink }
-    end
-
     def run
       links.each(&:run)
       vhosts.each { |each| each.run vhosts }
@@ -49,10 +67,8 @@ module Phut
         Vhost.new(attrs[:ip], attrs[:mac], attrs[:promisc], name, @logger)
     end
 
-    # This method smells of :reek:LongParameterList
-    def add_link(name_a, device_a, name_b, device_b)
-      @all[[name_a, name_b]] =
-        VirtualLink.new(name_a, device_a, name_b, device_b, @logger)
+    def add_link(name_a, name_b)
+      @links << VirtualLink.new(name_a, name_b, @logger)
     end
 
     private

data/lib/phut/open_vswitch.rb

@@ -9,12 +9,12 @@ module Phut
 
     attr_reader :dpid
     alias_method :datapath_id, :dpid
-    attr_writer :interfaces
+    attr_reader :network_devices
 
     def initialize(dpid, name = nil, logger = NullLogger.new)
       @dpid = dpid
       @name = name
-      @interfaces = []
+      @network_devices = []
       @logger = logger
     end
 
@@ -26,25 +26,29 @@ module Phut
       "vswitch (name = #{name}, dpid = #{format('%#x', @dpid)})"
     end
 
+    # rubocop:disable MethodLength
     # rubocop:disable AbcSize
     def run
-      sh "sudo ovs-vsctl add-br #{name}"
-      sh "sudo /sbin/sysctl -w net.ipv6.conf.#{name}.disable_ipv6=1 -q"
-      @interfaces.each { |each| sh "sudo ovs-vsctl add-port #{name} #{each}" }
-      sh "sudo ovs-vsctl set bridge #{name} protocols=OpenFlow10" \
-      " other-config:datapath-id=#{dpid_zero_filled}"
-      sh "sudo ovs-vsctl set-controller #{name} tcp:127.0.0.1:6633"\
-         " -- set controller #{name} connection-mode=out-of-band"
-      sh "sudo ovs-vsctl set-fail-mode #{name} secure"
+      sh "sudo ovs-vsctl add-br #{bridge_name}"
+      sh "sudo /sbin/sysctl -w net.ipv6.conf.#{bridge_name}.disable_ipv6=1 -q"
+      @network_devices.each do |each|
+        sh "sudo ovs-vsctl add-port #{bridge_name} #{each}"
+      end
+      sh "sudo ovs-vsctl set bridge #{bridge_name} protocols=OpenFlow10" \
+         " other-config:datapath-id=#{dpid_zero_filled}"
+      sh "sudo ovs-vsctl set-controller #{bridge_name} tcp:127.0.0.1:6633"\
+         " -- set controller #{bridge_name} connection-mode=out-of-band"
+      sh "sudo ovs-vsctl set-fail-mode #{bridge_name} secure"
     rescue
       raise "Open vSwitch (dpid = #{@dpid}) is already running!"
     end
     alias_method :start, :run
+    # rubocop:enable MethodLength
     # rubocop:enable AbcSize
 
     def stop
       fail "Open vSwitch (dpid = #{@dpid}) is not running!" unless running?
-      sh "sudo ovs-vsctl del-br #{name}"
+      sh "sudo ovs-vsctl del-br #{bridge_name}"
     end
     alias_method :shutdown, :stop
 
@@ -54,23 +58,27 @@ module Phut
     end
 
     def bring_port_up(port_number)
-      sh "sudo ovs-ofctl mod-port #{name} #{port_number} up"
+      sh "sudo ovs-ofctl mod-port #{bridge_name} #{port_number} up"
     end
 
     def bring_port_down(port_number)
-      sh "sudo ovs-ofctl mod-port #{name} #{port_number} down"
+      sh "sudo ovs-ofctl mod-port #{bridge_name} #{port_number} down"
     end
 
     def dump_flows
-      `sudo ovs-ofctl dump-flows #{name}`
+      `sudo ovs-ofctl dump-flows #{bridge_name}`
     end
 
     def running?
-      system "sudo ovs-vsctl br-exists #{name}"
+      system "sudo ovs-vsctl br-exists #{bridge_name}"
     end
 
     private
 
+    def bridge_name
+      'br' + name
+    end
+
     def restart
       stop
       start

data/lib/phut/parser.rb

@@ -7,45 +7,42 @@ module Phut
   class Parser
     def initialize(logger = NullLogger.new)
       @config = Configuration.new(logger)
+      @port_number = Hash.new(0)
     end
 
     def parse(file)
       Syntax.new(@config).instance_eval IO.read(file), file
-      assign_vswitch_interfaces
-      assign_vhost_interface
+      connect_links_to_switches
+      connect_links_to_vhosts
       @config
     end
 
     private
 
-    def assign_vswitch_interfaces
-      @config.vswitches.each do |each|
-        each.interfaces = find_interfaces_by_name(each.name)
+    def connect_links_to_switches
+      @config.links.each do |each|
+        maybe_assign_network_device_to_vswitch each
       end
     end
 
-    def assign_vhost_interface
+    def connect_links_to_vhosts
       @config.vhosts.each do |each|
-        each.interface = find_host_interface_by_name(each.name)
+        each.network_device = @config.find_network_device_by_name(each.name)
       end
     end
 
-    def find_interfaces_by_name(name)
-      find_device_by_name(name, :name_a, :device_a) +
-        find_device_by_name(name, :name_b, :device_b)
-    end
-
-    def find_host_interface_by_name(name)
-      find_interfaces_by_name(name).tap do |interface|
-        fail "No link found for host #{name}" if interface.empty?
-        fail "Multiple links connect to host #{name}" if interface.size > 1
-      end.first
+    def maybe_assign_network_device_to_vswitch(link)
+      @config.vswitches.each do |each|
+        switch_name = each.name
+        network_device = link.find_network_device_by_name(switch_name)
+        next unless network_device
+        network_device.port_number = new_port_number(switch_name)
+        each.network_devices << network_device
+      end
     end
 
-    def find_device_by_name(name, name_type, device_type)
-      @config.links.select do |each|
-        each.__send__(name_type) == name
-      end.map(&device_type)
+    def new_port_number(switch_name)
+      @port_number[switch_name] += 1
     end
   end
 end

data/lib/phut/syntax.rb

@@ -71,42 +71,8 @@ module Phut
       end
     end
 
-    # The 'link name_a, name_b' directive.
-    class LinkDirective
-      # Generates an unique Link ID
-      class LinkId
-        def initialize
-          init
-        end
-
-        def init
-          @index = 0
-        end
-
-        def generate
-          @index += 1
-        end
-      end
-
-      LinkIdSingleton = LinkId.new
-
-      def initialize(name_a, name_b, link_id)
-        @attributes = {}
-        @attributes[:name_a] = name_a
-        @attributes[:name_b] = name_b
-        link_id = LinkIdSingleton.generate
-        @attributes[:device_a] = "link#{link_id}-0"
-        @attributes[:device_b] = "link#{link_id}-1"
-      end
-
-      def [](key)
-        @attributes[key]
-      end
-    end
-
     def initialize(config)
       @config = config
-      LinkDirective::LinkIdSingleton.init
     end
 
     def vswitch(alias_name = nil, &block)
@@ -120,9 +86,7 @@ module Phut
     end
 
     def link(name_a, name_b)
-      link_id = @config.links.size
-      attrs = LinkDirective.new(name_a, name_b, link_id)
-      @config.add_link name_a, attrs[:device_a], name_b, attrs[:device_b]
+      @config.add_link name_a, name_b
     end
   end
 end

data/lib/phut/version.rb

@@ -1,4 +1,4 @@
 # Base module.
 module Phut
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end