phut 0.7.7 → 0.7.8

data/lib/phut/vsctl.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'phut/shell_runner'
+require 'pio'
+
+module Phut
+  # ovs-vsctl wrapper
+  class Vsctl
+    MAX_BRIDGE_NAME_LENGTH = 15
+
+    extend ShellRunner
+
+    def self.list_br(prefix)
+      sudo('ovs-vsctl list-br').split.each_with_object([]) do |each, list|
+        match = /^#{prefix}(\S+)/.match(each)
+        next unless match
+        name = match[1]
+        vsctl = new(name: name, bridge: prefix + name)
+        list << { name: vsctl.name,
+                  dpid: vsctl.dpid,
+                  openflow_version: vsctl.openflow_version,
+                  tcp_port: vsctl.tcp_port }
+      end
+    end
+
+    include ShellRunner
+
+    attr_reader :name
+    attr_reader :bridge
+
+    def initialize(name:, bridge:)
+      @name = name
+      @bridge = bridge
+    end
+
+    def dpid
+      ('0x' +
+       sudo("ovs-vsctl get bridge #{@bridge} datapath-id").delete('"')).hex
+    end
+
+    def openflow_version
+      case sudo("ovs-ofctl show #{@bridge} -O OpenFlow10,OpenFlow13")
+      when /^OFPT_FEATURES_REPLY \(xid=0x[^\)]+\):/
+        1.0
+      when /^OFPT_FEATURES_REPLY \(OF(\d\.\d)\)/
+        Regexp.last_match(1).to_f
+      else
+        raise "Couldn't identify the OpenFlow version of #{@bridge}"
+      end
+    end
+
+    def add_bridge
+      sudo "ovs-vsctl add-br #{@bridge}"
+      sudo "/sbin/sysctl -w net.ipv6.conf.#{@bridge}.disable_ipv6=1 -q"
+    end
+
+    def delete_bridge
+      sudo "ovs-vsctl del-br #{@bridge}"
+    end
+
+    def openflow_version=(version)
+      sudo "ovs-vsctl set bridge #{@bridge} "\
+           "protocols=OpenFlow#{version.to_s.delete('.')} "
+    rescue
+      raise "Invalid openflow_version: #{version}"
+    end
+
+    def dpid=(dpid)
+      sudo "ovs-vsctl set bridge #{@bridge} "\
+           "other-config:datapath-id=#{fill_zero(dpid)}"
+    end
+
+    def tcp_port
+      controller_info = sudo("ovs-vsctl get-controller #{@bridge}")
+      return if controller_info.empty?
+      controller_info.chomp.split(':').last.to_i
+    end
+
+    def tcp_port=(tcp_port)
+      raise "Invalid tcp_port: #{tcp_port}" if tcp_port.negative?
+      sudo "ovs-vsctl set-controller #{@bridge} "\
+           "tcp:127.0.0.1:#{tcp_port} "\
+           "-- set controller #{@bridge} connection-mode=out-of-band"
+    end
+
+    def delete_controller
+      sudo "ovs-vsctl del-controller #{@bridge}"
+    end
+
+    def set_fail_mode_secure
+      sudo "ovs-vsctl set-fail-mode #{@bridge} secure"
+    end
+
+    def add_port(device)
+      sudo "ovs-vsctl add-port #{@bridge} #{device}"
+      nil
+    end
+
+    def add_numbered_port(port_number, device)
+      add_port device
+      sudo "ovs-vsctl set Interface #{device} "\
+           "ofport_request=#{port_number}"
+      nil
+    end
+
+    def bring_port_up(port_number)
+      sh "sudo ovs-ofctl mod-port #{@bridge} #{port_number} up"
+    end
+
+    def bring_port_down(port_number)
+      sh "sudo ovs-ofctl mod-port #{@bridge} #{port_number} down"
+    end
+
+    def ports
+      sudo("ovs-vsctl list-ports #{@bridge}").split
+    end
+
+    private
+
+    def fill_zero(dpid)
+      hex = format('%x', dpid)
+      '0' * (16 - hex.length) + hex
+    end
+  end
+end

data/lib/phut/vswitch.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'phut/open_vswitch'
+
+# Base module
+module Phut
+  # Open vSwitch controller.
+  class Vswitch < OpenVswitch; end
+  Vswitch.bridge_prefix = 'vsw_'
+end

data/phut.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'phut/version'
@@ -9,46 +11,22 @@ Gem::Specification.new do |gem|
   gem.description = 'A simple network emulator '\
                     'with capabilities similar to mininet.'
 
-  gem.license = 'GPL3'
+  gem.licenses = %w[GPLv2 MIT]
 
   gem.authors = ['Yasuhito Takamiya']
   gem.email = ['yasuhito@gmail.com']
   gem.homepage = 'http://github.com/trema/phut'
 
-  gem.executables = %w(phut vhost)
+  gem.executables = %w[phut vhost]
   gem.files = `git ls-files`.split("\n")
 
   gem.extra_rdoc_files = ['README.md']
-  gem.test_files = `git ls-files -- {spec,features}/*`.split("\n")
+  gem.test_files = `git ls-files -- {test,features}/*`.split("\n")
 
-  gem.required_ruby_version = '>= 2.0.0'
+  gem.required_ruby_version = '>= 2.3.0'
 
-  gem.add_dependency 'activesupport', '~> 4.2', '>= 4.2.5'
-  gem.add_dependency 'gli', '~> 2.13.4'
-  gem.add_dependency 'pio', '~> 0.30.0'
+  gem.add_dependency 'activesupport', '~> 5.1.0'
+  gem.add_dependency 'gli', '~> 2.16.0'
+  gem.add_dependency 'pio', '~> 0.30.2'
   gem.add_dependency 'pry', '~> 0.10.3'
-
-  # Docs
-  gem.add_development_dependency 'relish'
-  gem.add_development_dependency 'yard', '~> 0.8.7.6'
-
-  # Development
-  gem.add_development_dependency 'guard', '~> 2.13.0'
-  gem.add_development_dependency 'guard-bundler', '~> 2.1.0'
-  gem.add_development_dependency 'guard-cucumber', '~> 2.0.0'
-  gem.add_development_dependency 'guard-rspec', '~> 4.6.4'
-  gem.add_development_dependency 'guard-rubocop', '~> 1.2.0'
-
-  # Test
-  gem.add_development_dependency 'aruba', '~> 0.11.2'
-  gem.add_development_dependency 'codeclimate-test-reporter'
-  gem.add_development_dependency 'coveralls', '~> 0.8.10'
-  gem.add_development_dependency 'cucumber', '~> 2.1.0'
-  gem.add_development_dependency 'flay', '~> 2.6.1'
-  gem.add_development_dependency 'flog', '~> 4.3.2'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'reek', '~> 3.7.1'
-  gem.add_development_dependency 'rspec', '~> 3.4.0'
-  gem.add_development_dependency 'rspec-given', '~> 3.7.1'
-  gem.add_development_dependency 'rubocop', '~> 0.35.1'
 end

data/tasks/cucumber.rake

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 begin
   require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new
+  Cucumber::Rake::Task.new do |task|
+    task.cucumber_opts = '--tags ~@wip'
+  end
   Cucumber::Rake::Task.new('cucumber:travis') do |task|
     task.cucumber_opts = '--tags ~@wip --tags ~@sudo --tags ~@shell'
   end

data/tasks/flay.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'rake/tasklib'
   require 'flay'

data/tasks/flog.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'flog'
 
@@ -8,7 +10,7 @@ begin
     threshold = 10
 
     bad_methods = flog.totals.select do |name, score|
-      !(/##{flog.no_method}$/ =~ name) && score > threshold
+      /##{flog.no_method}$/ !~ name && score > threshold
     end
     bad_methods.sort { |a, b| a[1] <=> b[1] }.reverse_each do |name, score|
       printf "%8.1f: %s\n", score, name

data/tasks/gem.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   unless Dir.glob(File.join(__dir__, '../*.gemspec')).empty?
     require 'bundler/gem_tasks'

data/tasks/minitest.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/tasks/reek.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'reek/rake/task'
   Reek::Rake::Task.new do |t|

data/tasks/rubocop.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new

data/tasks/yard.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'yard'
   YARD::Rake::YardocTask.new do |t|

data/test/phut/link_test.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/access'
+require 'minitest/autorun'
+require 'phut/link'
+
+module Phut
+  class LinkTest < Minitest::Test
+    def test_link_all
+      assert Link.all.empty?
+
+      Link.create :switch1, :switch2
+      assert_equal 1, Link.all.size
+      assert_equal %w[switch1 switch2], Link.all.first.ends.map(&:name)
+
+      Link.create :host1, :host2
+      assert_equal 2, Link.all.size
+      assert_equal %w[host1 host2], Link.all.second.ends.map(&:name)
+    end
+
+    def test_link_find
+      assert_nil Link.find(:switch1, :switch2)
+
+      link = Link.create(:switch1, :switch2)
+      assert_equal link, Link.find(:switch1, :switch2)
+      assert_equal link, Link.find(:switch2, :switch1)
+      assert_equal link, Link.find('switch1', 'switch2')
+      assert_equal link, Link.find('switch2', 'switch1')
+    end
+
+    def test_start
+      link = Link.new(:switch1, :switch2)
+      link.start
+
+      assert_equal link, Link.all.first
+      assert_equal link, link.start
+    end
+
+    def test_destroy
+      link = Link.create(:switch1, :switch2)
+
+      link.destroy
+      assert Link.all.empty?
+    end
+
+    def test_ends
+      link = Link.create(:switch1, :switch2)
+
+      assert_equal 2, link.ends.size
+      assert_equal 'switch1', link.ends.first.name
+      assert_equal 'switch2', link.ends.second.name
+    end
+
+    def test_device
+      link1 = Link.create(:switch1, :switch2)
+      link2 = Link.create(:host1, :host2)
+
+      assert_equal 'L0_switch1', link1.device(:switch1).to_s
+      assert_equal 'L0_switch1', link1.device('switch1').to_s
+      assert_equal 'L0_switch2', link1.device(:switch2).to_s
+      assert_equal 'L0_switch2', link1.device('switch2').to_s
+
+      assert_equal 'L1_host1', link2.device(:host1).to_s
+      assert_equal 'L1_host1', link2.device('host1').to_s
+      assert_equal 'L1_host2', link2.device(:host2).to_s
+      assert_equal 'L1_host2', link2.device('host2').to_s
+
+      assert_nil link1.device(:firewall)
+    end
+
+    private
+
+    def setup
+      log_dir = File.expand_path('../../log', __dir__)
+      Phut.logger = ::Logger.new("#{log_dir}/test.log")
+    end
+
+    def teardown
+      `ifconfig -a`.split("\n").each do |each|
+        next unless /^(#{Veth::PREFIX}\S+)/ =~ each
+        system "sudo ip link delete #{Regexp.last_match(1)} 2>/dev/null"
+      end
+    end
+  end
+end

data/test/phut/netns_test.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/access'
+require 'minitest/autorun'
+require 'phut/link'
+require 'phut/netns'
+
+module Phut
+  class NetnsTest < Minitest::Test
+    def test_netns_all
+      assert Netns.all.empty?
+
+      link = Link.create('host1', 'host2')
+
+      host1 = Netns.create(name: 'host1', ip_address: '192.168.0.1')
+      host1.device = link.device('host1')
+      assert_equal 1, Netns.all.size
+      assert_equal 'host1', Netns.all.first.name
+      assert_equal '192.168.0.1', Netns.all.first.ip_address
+
+      host2 = Netns.create(name: 'host2', ip_address: '192.168.0.1')
+      host2.device = link.device('host2')
+      assert_equal 2, Netns.all.size
+      assert_equal 'host2', Netns.all.second.name
+      assert_equal '192.168.0.1', Netns.all.second.ip_address
+    end
+
+    def test_netns_create
+      netns = Netns.create(name: 'netns',
+                           ip_address: '192.168.8.6',
+                           netmask: '255.255.255.0',
+                           route: { net: '0.0.0.0', gateway: '192.168.8.1' })
+      assert_equal 'netns', netns.name
+      assert_equal '192.168.8.6', netns.ip_address
+    end
+
+    def test_device
+      link = Link.create('host', 'switch')
+      netns = Netns.create(name: 'netns', ip_address: '192.168.0.1')
+
+      netns.device = link.device('host')
+
+      assert_equal 'host', netns.device.name
+    end
+
+    private
+
+    def setup
+      Netns.destroy_all
+      Link.destroy_all
+    end
+
+    def teardown
+      Netns.destroy_all
+      Link.destroy_all
+    end
+  end
+end

data/test/phut/open_vswitch_test.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'phut/open_vswitch'
+
+module Phut
+  class OpenVswitchTest < Minitest::Test
+    def test_open_vswitch_all
+      assert OpenVswitch.all.empty?
+
+      OpenVswitch.create(dpid: 0xc001)
+      assert_equal 1, OpenVswitch.all.size
+      assert_equal 0xc001, OpenVswitch.all.first.dpid
+      assert_equal '0xc001', OpenVswitch.all.first.name
+      assert_equal '0xc001', OpenVswitch.all.first.bridge
+      assert_equal 1.0, OpenVswitch.all.first.openflow_version
+      assert_equal 6653, OpenVswitch.all.first.tcp_port
+
+      OpenVswitch.create(dpid: 0xdad1)
+      assert_equal 2, OpenVswitch.all.size
+      assert_equal 0xdad1, OpenVswitch.all.second.dpid
+      assert_equal '0xdad1', OpenVswitch.all.second.name
+      assert_equal '0xdad1', OpenVswitch.all.second.bridge
+      assert_equal 1.0, OpenVswitch.all.second.openflow_version
+      assert_equal 6653, OpenVswitch.all.second.tcp_port
+    end
+
+    def test_open_vswitch_create_with_dpid
+      vswitch = OpenVswitch.create(dpid: 0xc001)
+      assert_equal 0xc001, vswitch.dpid
+      assert_equal '0xc001', vswitch.name
+      assert_equal '0xc001', vswitch.bridge
+      assert_equal 1.0, vswitch.openflow_version
+      assert_equal 6653, vswitch.tcp_port
+
+      assert_raises(RuntimeError) do
+        OpenVswitch.create(dpid: 0xc001)
+      end
+    end
+
+    def test_open_vswitch_create_with_name_and_dpid
+      vswitch = OpenVswitch.create(name: 'dadi', dpid: 0xc001)
+      assert_equal 0xc001, vswitch.dpid
+      assert_equal 'dadi', vswitch.name
+      assert_equal 'dadi', vswitch.bridge
+      assert_equal 1.0, vswitch.openflow_version
+      assert_equal 6653, vswitch.tcp_port
+
+      assert_raises(RuntimeError) do
+        OpenVswitch.create(name: 'dadi', dpid: 0xc001)
+      end
+    end
+
+    def test_open_vswitch_create_exceptions
+      assert_raises(RuntimeError) do
+        OpenVswitch.create(dpid: 0xdad1, name: '1234567890123456')
+      end
+
+      assert_raises(RuntimeError) do
+        OpenVswitch.create(dpid: 0xdad1, openflow_version: 999)
+      end
+
+      assert_raises(RuntimeError) do
+        OpenVswitch.create(dpid: 0xdad1, tcp_port: -999)
+      end
+    end
+
+    def test_open_vswitch_find_by
+      OpenVswitch.create(dpid: 0xc001)
+      vswitch = OpenVswitch.find_by(dpid: 0xc001)
+      assert_equal '0xc001', vswitch.name
+      assert_equal 0xc001, vswitch.dpid
+    end
+
+    def test_open_vswitch_destroy
+      OpenVswitch.create(dpid: 0xc001)
+      OpenVswitch.destroy('0xc001')
+      assert OpenVswitch.all.empty?
+    end
+
+    def test_open_vswitch_destroy_all
+      OpenVswitch.create(dpid: 0xc001)
+      OpenVswitch.destroy_all
+      assert OpenVswitch.all.empty?
+    end
+
+    def test_new
+      assert_raises(NoMethodError) do
+        OpenVswitch.new
+      end
+    end
+
+    def test_destroy
+      vswitch = OpenVswitch.create(dpid: 0xc001)
+      vswitch.destroy
+      assert OpenVswitch.all.empty?
+    end
+
+    def test_stop
+      vswitch = OpenVswitch.create(dpid: 0xc001)
+      vswitch.stop
+      assert vswitch.tcp_port.nil?
+    end
+
+    def test_dump_flows
+      vswitch = OpenVswitch.create(dpid: 0xc001)
+      assert_equal '', vswitch.dump_flows
+    end
+
+    def test_add_port
+      vswitch = OpenVswitch.create(dpid: 0xc001)
+      vswitch.add_port 'port1'
+      assert_equal ['port1'], vswitch.ports
+    end
+
+    private
+
+    def teardown
+      `sudo ovs-vsctl list-br`.chomp.split.each do |each|
+        next unless /^#{OpenVswitch.bridge_prefix}/ =~ each
+        system "sudo ovs-vsctl del-br #{each}"
+      end
+    end
+  end
+end