phut 0.7.7 → 0.7.8

data/features/shell/vswitch.all.feature

@@ -0,0 +1,26 @@
+Feature: Vswitch.all
+  Background:
+    Given I run `phut -v` interactively
+
+  @sudo
+  Scenario: Vswitch.all #=> []
+    When I type "Vswitch.all"
+    Then the output should contain "[]"
+
+  @sudo
+  Scenario: Vswitch.all #=> [aVswitch]
+    Given I type "Vswitch.create(name: 'firewall', dpid: 0xabc)"
+    When I type "Vswitch.all"
+    Then the output should contain:
+     """
+     [#<Vswitch name: "firewall", dpid: 0xabc, openflow_version: 1.0, tcp_port: 6653>]
+     """
+
+  @sudo
+  Scenario: Vswitch.all #=> [aVswitch]
+    Given I type "Vswitch.create(dpid: 0xabc)"
+    When I type "Vswitch.all"
+    Then the output should contain:
+     """
+     [#<Vswitch name: "0xabc", dpid: 0xabc, openflow_version: 1.0, tcp_port: 6653>]
+     """

data/features/shell/vswitch.create.feature

@@ -0,0 +1,30 @@
+Feature: Vswitch.create
+  Background:
+    Given I run `phut -v` interactively
+
+  @sudo
+  Scenario: Vswitch.create(dpid: ...)
+    When I type "Vswitch.create(dpid: 0xabc)"
+    And sleep 5
+    Then a vswitch named "0xabc" should be running
+
+  @sudo
+  Scenario: Vswitch.create(name: ..., dpid: ...)
+    When I type "Vswitch.create(name: 'firewall', dpid: 0xabc)"
+    And sleep 5
+    Then a vswitch named "firewall" should be running
+
+  @sudo
+  Scenario: Vswitch.create(name: ..., dpid: ..., tcp_port:)
+    When I type "vswitch = Vswitch.create(name: 'firewall', dpid: 0xabc, tcp_port: 99999)"
+    And sleep 5
+    Then a vswitch named "firewall" should be running on port "99999"
+
+  @sudo
+  Scenario: Vswitch.create twice and fail
+    Given I type "Vswitch.create(name: 'firewall', dpid: 0xabc)"
+    When I type "Vswitch.create(dpid: 0xabc)"
+    Then the output should contain:
+     """
+     a Vswitch #<Vswitch name: "firewall", dpid: 0xabc, openflow_version: 1.0, tcp_port: 6653> already exists
+     """

data/features/shell/vswitch.destroy.feature

@@ -0,0 +1,19 @@
+Feature: Vswitch.destroy
+  Background:
+    Given I run `phut -v` interactively
+
+  @sudo
+  Scenario: Vswitch.destroy
+    Given I type "Vswitch.create(dpid: 0xabc)"
+    When I type "Vswitch.destroy('0xabc')"
+    And sleep 5
+    Then a vswitch named "0xabc" should not be running
+
+  @sudo
+  Scenario: Vswitch.destroy #=> error
+    When I type "Vswitch.destroy('no_such_switch')"
+    Then the output should contain:
+     """
+     Vswitch {:name=>"no_such_switch"} not found
+     """
+

data/features/shell/vswitch.destroy_all.feature

@@ -0,0 +1,18 @@
+Feature: Vswitch.destroy_all
+  Background:
+    Given I run `phut -v` interactively
+
+  @sudo
+  Scenario: Vswitch.destroy_all
+    When I type "Vswitch.destroy_all"
+    And I type "Vswitch.all"
+    And sleep 5
+    Then the output should contain "[]"
+
+  @sudo
+  Scenario: Vswitch.destroy_all
+    Given I type "Vswitch.create(dpid: 0xabc)"
+    When I type "Vswitch.destroy_all"
+    And I type "Vswitch.all"
+    And sleep 5
+    Then the output should contain "[]"

data/features/step_definitions/link_steps.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Then(/^a link between "(.*?)" and "(.*?)" should be created$/) do |namea, nameb|
+  expect(Phut::Link.find(namea, nameb)).not_to be_nil
+end

data/features/step_definitions/netns_steps.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+Then(/^a netns named "(.*?)" should be started$/) do |name|
+  expect(Phut::Netns.find_by!(name: name)).not_to be_nil
+end
+
+Then(/^the IP address of the netns "([^"]*)" should not be set$/) do |name|
+  expect(Phut::Netns.find_by!(name: name).ip_address).to be_nil
+end
+
+Then(/^the IP address of the netns "([^"]*)" should be "([^"]*)"$/) do |name, ip|
+  expect(Phut::Netns.find_by!(name: name).ip_address).to eq ip
+end
+
+Then(/^the MAC address of the netns "([^"]*)" should be "([^"]*)"$/) do |name, mac|
+  expect(Phut::Netns.find_by!(name: name).mac_address).to eq mac
+end
+
+Then(/^the netmask of the netns "([^"]*)" should be "([^"]*)"$/) do |name, netmask|
+  expect(Phut::Netns.find_by!(name: name).netmask).to eq netmask
+end
+
+Then(/^the netns "([^"]*)" have the following route:$/) do |name, table|
+  netns = Phut::Netns.find_by!(name: name)
+  expect(netns.route.net).to eq table.hashes.first['net']
+  expect(netns.route.gateway).to eq table.hashes.first['gateway']
+end
+
+Then(/^the VLAN of the netns "([^"]*)" should be "([^"]*)"$/) do |name, vlan|
+  expect(Phut::Netns.find_by!(name: name).vlan).to eq vlan
+end

data/features/step_definitions/phut_steps.rb

@@ -1,11 +1,8 @@
-require 'phut'
+# frozen_string_literal: true
 
 When(/^I do phut run "(.*?)"$/) do |config_file|
-  @config_file = config_file
-  cd('.') do
-    run_opts = "-P #{@pid_dir} -L #{@log_dir} -S #{@socket_dir}"
-    step %(I run `phut -v run #{run_opts} #{@config_file}`)
-  end
+  run_opts = "-P #{@pid_dir} -L #{@log_dir} -S #{@socket_dir}"
+  step %(I run `phut -v run #{run_opts} #{config_file}`)
 end
 
 When(/^I do phut kill "(.*?)"$/) do |name|
@@ -13,32 +10,6 @@ When(/^I do phut kill "(.*?)"$/) do |name|
   step %(I successfully run `phut -v kill #{run_opts} #{name}`)
 end
 
-When(/^sleep (\d+)$/) do |time|
-  sleep time.to_i
-end
-
-Then(/^a vswitch named "(.*?)" should be running$/) do |name|
-  expect(system("sudo ovs-vsctl br-exists br#{name}")).to be_truthy
-end
-
-# rubocop:disable LineLength
-Then(/^a vswitch named "([^"]*)" \(controller port = (\d+)\) should be running$/) do |name, port_number|
-  step %(a vswitch named "#{name}" should be running)
-  step %(the output should contain "ovs-vsctl set-controller br#{name} tcp:127.0.0.1:#{port_number}")
-end
-# rubocop:enable LineLength
-
-Then(/^a vswitch named "(.*?)" should not be running$/) do |name|
-  expect(system("sudo ovs-vsctl br-exists br#{name}")).to be_falsey
-end
-
-Then(/^a vhost named "(.*?)" launches$/) do |name|
-  step %(a file named "vhost.#{name}.pid" should exist)
-end
-
-Then(/^a link is created between "(.*?)" and "(.*?)"$/) do |name_a, name_b|
-  cd('.') do
-    link = Phut::Parser.new.parse(@config_file).fetch([name_a, name_b].sort)
-    expect(link).to be_up
-  end
+When(/^sleep (\d+)$/) do |second|
+  step "I successfully run `sleep #{second}`"
 end

data/features/step_definitions/vhost_steps.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Then(/^a vhost named "(.*?)" should be running$/) do |name|
+  expect(Phut::Vhost.find_by!(name: name)).to be_running
+end

data/features/step_definitions/vswitch_steps.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Then(/^a vswitch named "([^"]*)" should be running$/) do |name|
+  expect(Phut::Vswitch.find_by(name: name)).not_to be_nil
+end
+
+Then(/^a vswitch named "([^"]*)" should be running on port "([^"]*)"$/) do |name, tcp_port|
+  expect(Phut::Vswitch.find_by!(name: name).tcp_port).to eq tcp_port.to_i
+end
+
+Then(/^a vswitch named "([^"]*)" should not be running$/) do |name|
+  expect(Phut::Vswitch.find_by(name: name)).to be_nil
+end
+
+Then(/^a vswitch named "([^"]*)" \(controller port = (\d+)\) should be running$/) do |name, port_number|
+  expect(Phut::Vswitch.find_by!(name: name).tcp_port).to eq port_number.to_i
+end

data/features/support/env.rb

@@ -1,4 +1,4 @@
-require 'aruba/cucumber'
+# frozen_string_literal: true
 
-require 'coveralls'
-Coveralls.wear_merged!
+require 'aruba/cucumber'
+require 'phut'

data/features/support/hooks.rb

@@ -1,13 +1,27 @@
+# frozen_string_literal: true
+
 require 'phut'
 
 Before do
-  @pid_dir = '.'
-  @log_dir = '.'
-  @socket_dir = '.'
+  Aruba.configure do |config|
+    Dir.chdir(config.working_directory) do
+      @log_dir = './log'
+      @pid_dir = './tmp/pids'
+      @socket_dir = './tmp/sockets'
+
+      FileUtils.mkdir_p(@log_dir) unless File.exist?(@log_dir)
+      FileUtils.mkdir_p(@pid_dir) unless File.exist?(@pid_dir)
+      FileUtils.mkdir_p(@socket_dir) unless File.exist?(@socket_dir)
+
+      Phut.pid_dir = @pid_dir
+      Phut.log_dir = @log_dir
+      Phut.socket_dir = @socket_dir
+    end
+  end
 end
 
 Before('@sudo') do
-  fail 'sudo authentication failed' unless system 'sudo -v'
+  raise 'sudo authentication failed' unless system 'sudo -v'
   @aruba_timeout_seconds = 10
 end
 
@@ -17,17 +31,11 @@ After('@sudo') do
       Phut.pid_dir = @pid_dir
       Phut.log_dir = @log_dir
       Phut.socket_dir = @socket_dir
-      Phut::Parser.new.parse(@config_file).stop
-    end
-  end
-end
-
-Before('@shell') do
-  fail 'sudo authentication failed' unless system 'sudo -v'
-end
 
-After('@shell') do
-  `sudo ovs-vsctl list-br`.split("\n").each do |each|
-    run "sudo ovs-vsctl del-br #{each}"
+      Phut::Vswitch.destroy_all
+      Phut::Vhost.destroy_all
+      Phut::Netns.destroy_all
+      Phut::Link.destroy_all
+    end
   end
 end

data/lib/phut.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'phut/open_vswitch'
 require 'phut/parser'
 require 'phut/setting'
 require 'phut/version'
 require 'phut/vhost_daemon'
+require 'phut/vswitch'

data/lib/phut/finder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module Phut
+  # Defines find_by method
+  module Finder
+    def find_by(queries)
+      queries.inject(all) do |memo, (attr, value)|
+        memo.find_all { |each| each.__send__(attr) == value }
+      end.first
+    end
+
+    def find_by!(queries)
+      name = to_s.demodulize
+      find_by(queries) || raise("#{name} #{queries.inspect} not found")
+    end
+  end
+end

data/lib/phut/link.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'phut/netns'
+require 'phut/shell_runner'
+require 'phut/veth'
+
+module Phut
+  # Virtual link
+  class Link
+    def self.all
+      link = Hash.new { [] }
+      Veth.all.each { |each| link[each.link_id] += [each.name] }
+      link.map { |link_id, names| new(names.first, names.second, link_id) }
+    end
+
+    def self.find(end1, end2)
+      all.find { |each| each.ends.map(&:name) == [end1, end2].map(&:to_s).sort }
+    end
+
+    def self.create(end1, end2)
+      new(end1, end2).start
+    end
+
+    def self.destroy_all
+      all.each(&:destroy)
+    end
+
+    include ShellRunner
+
+    attr_reader :ends
+
+    def initialize(name1, name2, link_id = Link.all.size)
+      raise if name1 == name2
+      @ends = [Veth.new(name: name1, link_id: link_id),
+               Veth.new(name: name2, link_id: link_id)].sort
+    end
+
+    def start
+      return self if up?
+      add
+      up
+      self
+    end
+
+    def destroy
+      sudo "ip link delete #{end1} || true"
+      sudo "ip link delete #{end2} || true"
+    end
+    alias stop destroy
+
+    def device(name)
+      ends.find { |each| each.name == name.to_s }
+    end
+
+    def ==(other)
+      ends == other.ends
+    end
+
+    private
+
+    def end1
+      ends.first
+    end
+
+    def end2
+      ends.second
+    end
+
+    def add
+      sudo "ip link add name #{end1.device} type veth peer name #{end2.device}"
+      sudo "/sbin/sysctl -q -w net.ipv6.conf.#{end1.device}.disable_ipv6=1"
+      sudo "/sbin/sysctl -q -w net.ipv6.conf.#{end2.device}.disable_ipv6=1"
+    end
+
+    def up?
+      Link.all.include? self
+    end
+
+    def up
+      sudo "/sbin/ifconfig #{end1.device} up"
+      sudo "/sbin/ifconfig #{end2.device} up"
+    end
+  end
+end

data/lib/phut/netns.rb

@@ -1,48 +1,137 @@
-require 'active_support/core_ext/class/attribute_accessors'
-require 'phut/null_logger'
+# frozen_string_literal: true
+
+require 'phut/finder'
+require 'phut/route'
 require 'phut/shell_runner'
+require 'phut/veth'
 
 module Phut
   # `ip netns ...` command runner
   class Netns
-    cattr_accessor(:all, instance_reader: false) { [] }
+    extend ShellRunner
+    extend Finder
+
+    # rubocop:disable MethodLength
+    # rubocop:disable AbcSize
+    def self.all
+      sh('ip netns list').split("\n").map do |each|
+        name = each.split.first
+        ip_addr_list =
+          sudo("ip netns exec #{name} ip -4 -o addr list").split("\n")
+        mac_addr_list =
+          sudo("ip netns exec #{name} ip -4 -o link list").split("\n")
+        if ip_addr_list.size > 1
+          %r{inet ([^/]+)/(\d+)} =~ ip_addr_list[1]
+          ip_address = Regexp.last_match(1)
+          mask_length = Regexp.last_match(2).to_i
+          netmask = IPAddr.new('255.255.255.255').mask(mask_length).to_s
+          %r{link/ether ((?:[a-f\d]{2}:){5}[a-f\d]{2})}i =~ mac_addr_list[1]
+          new(name: name, ip_address: ip_address, netmask: netmask,
+              mac_address: Regexp.last_match(1))
+        else
+          new(name: name)
+        end
+      end.sort_by(&:name)
+    end
+    # rubocop:enable MethodLength
+    # rubocop:enable AbcSize
 
-    def self.create(options, name, logger = NullLogger.new)
-      new(options, name, logger).tap { |netns| all << netns }
+    def self.create(*args)
+      new(*args).tap(&:run)
     end
 
-    def self.each(&block)
-      all.each(&block)
+    def self.destroy_all
+      all.each(&:stop)
     end
 
     include ShellRunner
 
     attr_reader :name
-    attr_accessor :network_device
+    attr_reader :ip_address
+    attr_reader :mac_address
 
-    def initialize(options, name, logger)
+    # rubocop:disable ParameterLists
+    def initialize(name:,
+                   ip_address: nil,
+                   mac_address: nil,
+                   netmask: '255.255.255.255',
+                   route: {},
+                   vlan: nil)
       @name = name
-      @options = options
-      @logger = logger
+      @ip_address = ip_address
+      @mac_address = mac_address
+      @netmask = netmask
+      @route = Route.new(net: route[:net], gateway: route[:gateway])
+      @vlan = vlan
     end
+    # rubocop:enable MethodLength
+    # rubocop:enable ParameterLists
 
-    # rubocop:disable AbcSize
     def run
-      sh "sudo ip netns add #{name}"
-      sh "sudo ip link set dev #{network_device} netns #{name}"
-      sh "sudo ip netns exec #{name} ifconfig lo 127.0.0.1"
-      sh "sudo ip netns exec #{name}"\
-         " ifconfig #{network_device} #{ip} netmask #{netmask}"
-      sh "sudo ip netns exec #{name} route add -net #{net} gw #{gateway}"
+      sudo "ip netns add #{name}"
+      sudo "ip netns exec #{name} ifconfig lo 127.0.0.1"
     end
-    # rubocop:enable AbcSize
 
     def stop
-      sh "sudo ip netns delete #{name}"
+      sudo("ip netns pids #{name}").split("\n").each do |each|
+        exec "kill #{each}"
+      end
+      sudo "ip netns delete #{name}"
+    end
+
+    def exec(command)
+      sudo "ip netns exec #{name} #{command}"
+    end
+
+    def device
+      return unless /^\d+: #{Veth::PREFIX}(\d+)_([^:\.]*?)[@:]/ =~
+                    sudo("ip netns exec #{name} ip -o link show")
+      Veth.new(name: $LAST_MATCH_INFO[2], link_id: $LAST_MATCH_INFO[1].to_i)
+    end
+
+    # rubocop:disable MethodLength
+    # rubocop:disable AbcSize
+    def device=(veth)
+      sudo "ip link set dev #{veth} netns #{name}"
+
+      vlan_suffix = @vlan ? ".#{@vlan}" : ''
+      if @vlan
+        sudo "ip netns exec #{name} ip link set #{veth} up"
+        sudo "ip netns exec #{name} "\
+             "ip link add link #{veth} name "\
+             "#{veth}#{vlan_suffix} type vlan id #{@vlan}"
+      end
+      if @mac_address
+        sudo "ip netns exec #{name} "\
+             "ip link set #{veth}#{vlan_suffix} address #{@mac_address}"
+      end
+      sudo "ip netns exec #{name} ip link set #{veth}#{vlan_suffix} up"
+      sudo "ip netns exec #{name} "\
+           "ip addr replace #{@ip_address}/#{@netmask} "\
+           "dev #{veth}#{vlan_suffix}"
+      sudo "ip netns exec #{name} ip link set #{veth}#{vlan_suffix} up"
+
+      @route.add name
+    end
+    # rubocop:enable MethodLength
+    # rubocop:enable AbcSize
+
+    def netmask
+      if %r{inet [^/]+/(\d+) } =~
+         sudo("ip netns exec #{name} ip -o -4 address show dev #{device}")
+        IPAddr.new('255.255.255.255').mask(Regexp.last_match(1).to_i).to_s
+      end
+    end
+
+    def route
+      Route.read name
     end
 
-    def method_missing(message, *_args)
-      @options.__send__ :[], message
+    def vlan
+      if /^\d+: #{device.device}\.(\d+)@/ =~
+         sudo("ip netns exec #{name} ip -o link show")
+        Regexp.last_match(1)
+      end
     end
   end
 end