phut 0.1.0

data/README.md

@@ -0,0 +1,49 @@
+phut
+====
+
+[![Build Status](http://img.shields.io/travis/trema/phut/develop.svg?style=flat)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/trema/phut.svg?style=flat)][codeclimate]
+[![Coverage Status](http://img.shields.io/codeclimate/coverage/github/trema/phut.svg?style=flat)][coveralls]
+[![Dependency Status](http://img.shields.io/gemnasium/trema/phut.svg?style=flat)][gemnasium]
+[![Gitter chat](http://img.shields.io/badge/GITTER-phut-blue.svg?style=flat)][gitter]
+
+Virtual network in seconds
+
+[travis]: http://travis-ci.org/trema/phut
+[codeclimate]: https://codeclimate.com/github/trema/phut
+[coveralls]: https://coveralls.io/r/trema/phut
+[gemnasium]: https://gemnasium.com/trema/phut
+[gitter]: https://gitter.im/trema/phut
+
+
+Install
+-------
+
+```
+$ git clone https://github.com/trema/phut.git
+$ cd phut
+$ bundle install
+```
+
+
+Play
+----
+
+With Phut network DSL, you can describe the network topology in which
+your OpenFlow controller is executed.
+
+```ruby
+# phut.conf
+# One virtual switch + two virtual hosts.
+vswitch { dpid 0xabc }
+vhost 'host1'
+vhost 'host2'
+link '0xabc', 'host1'
+link '0xabc', 'host2'
+```
+
+Then you can pass the network configuration to `phut run`.
+
+```
+$ bundle exec phut run phut.conf
+```

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rake/clean'
+
+task default: [:openvswitch, :vhost]
+task test: [:spec, :cucumber, :quality]
+task quality: [:rubocop, :reek, :flog]
+task travis: [:spec, 'cucumber:travis', :quality]
+
+Dir.glob('tasks/*.rake').each { |each| import each }

data/bin/phut

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'gli'
+require 'logger'
+require 'phut'
+require 'pry'
+
+$stdout.sync = true
+
+module Phut
+  # /bin/phut command
+  module App
+    extend GLI::App
+
+    program_desc 'Virtual network in seconds'
+
+    version Phut::VERSION
+
+    desc 'Be verbose'
+    switch [:v, :verbose], negatable: false
+
+    command :shell do |c|
+      c.action do |_global_options, _options, _args|
+        Pry.prompt =
+          [
+            proc { 'phut> ' },
+            proc { 'phut* ' }
+          ]
+        Pry::Commands.block_command 'pid_dir' do |dir|
+          Phut.pid_dir = dir
+        end
+        Pry::Commands.block_command 'log_dir' do |dir|
+          Phut.log_dir = dir
+        end
+        Pry::Commands.block_command 'socket_dir' do |dir|
+          Phut.socket_dir = dir
+        end
+        Pry::Commands.block_command 'vswitch' do |dpid|
+          Phut::OpenVswitch.new(dpid).run
+        end
+        Pry::Commands.block_command 'kill' do |dpid|
+          Phut::OpenVswitch.new(dpid).shutdown
+        end
+        pry
+      end
+    end
+
+    desc 'Starts a virtual network'
+    arg_name 'FILE'
+    command :run do |c|
+      c.desc 'Location to put pid files'
+      c.flag [: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.desc 'Location to put socket files'
+      c.flag [:s, :socket_dir], default_value: Phut.socket_dir
+
+      c.action do |global_options, options, args|
+        stdout_logger = Logger.new($stderr).tap do |logger|
+          logger.formatter = proc { |_sev, _dtm, _name, msg| msg + "\n" }
+          logger.level = global_options[:verbose] ? Logger::DEBUG : Logger::INFO
+        end
+        Phut.pid_dir = options[:pid_dir]
+        Phut.log_dir = options[:log_dir]
+        Phut.socket_dir = options[:socket_dir]
+        Phut::Parser.new(stdout_logger).parse(args[0]).run
+      end
+    end
+
+    desc 'Stops a virtual network'
+    arg_name 'FILE'
+    command :stop do |c|
+      c.desc 'Location to put pid files'
+      c.flag [: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.desc 'Location to put socket files'
+      c.flag [:s, :socket_dir], default_value: Phut.socket_dir
+
+      c.action do |global_options, _options, args|
+        stdout_logger = Logger.new($stderr).tap do |logger|
+          logger.formatter = proc { |_sev, _dtm, _name, msg| msg + "\n" }
+          logger.level = global_options[:verbose] ? Logger::DEBUG : Logger::INFO
+        end
+        Phut::Parser.new(stdout_logger).parse(args[0]).stop
+      end
+    end
+
+    command :kill do |c|
+      c.action do |_global_options, _options, args|
+        args.each { |each| Phut::OpenVswitch.new(each).shutdown }
+      end
+    end
+
+    pre do |global, _command, _options, _args|
+      if global[:version]
+        puts "#{exe_name} version #{version_string}"
+        exit_now! nil, 0
+      end
+      true
+    end
+
+    default_command :shell
+
+    exit run(ARGV)
+  end
+end

data/features/dsl.feature

@@ -0,0 +1,26 @@
+Feature: DSL parser
+  Scenario: name conflict (vsiwtch and vswitch)
+    Given a file named "network.conf" with:
+    """
+    vswitch { dpid 0xabc }
+    vswitch { dpid 0xabc }
+    """
+    When I do phut run "network.conf"
+    Then the exit status should not be 0
+    And the stderr should contain:
+    """
+    The name 0xabc conflicts with vswitch (name = 0xabc, dpid = 0xabc).
+    """
+
+  Scenario: name conflict (vhost and vhost)
+    Given a file named "network.conf" with:
+    """
+    vhost { ip '192.168.0.1' }
+    vhost { ip '192.168.0.1' }
+    """
+    When I do phut run "network.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 = 192.168.0.1).
+    """

data/features/dsl_link.feature

@@ -0,0 +1,22 @@
+Feature: The link DSL directive.
+  @sudo
+  Scenario: phut run with "link ..."
+    Given a file named "network.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"
+
+  @sudo
+  Scenario: phut run with "link alias1, alias2"
+    Given a file named "network.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"

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 "network.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 "network.conf"
+    Then a vhost named "192.168.0.1" launches
+    And a vhost named "192.168.0.2" launches
+
+  @sudo
+  Scenario: phut run with "vhost(alias) { ... }"
+    Given a file named "network.conf" with:
+    """
+    vhost('host1') { ip '192.168.0.1' }
+    vhost('host2') { ip '192.168.0.2' }
+    link 'host1', 'host2'
+    """
+    When I do phut run "network.conf"
+    Then a vhost named "host1" launches
+    And a vhost named "host2" launches
+
+  @sudo
+  Scenario: phut run with "vhost(alias)"
+    Given a file named "network.conf" with:
+    """
+    vhost('host1')
+    vhost('host2')
+    link 'host1', 'host2'
+    """
+    When I do phut run "network.conf"
+    Then a vhost named "host1" launches
+    And a vhost named "host2" launches
+

data/features/dsl_vswitch.feature

@@ -0,0 +1,45 @@
+Feature: The vswitch DSL directive.
+  @sudo
+  Scenario: phut run with "vswitch { dpid STRING }"
+    Given a file named "network.conf" with:
+    """
+    vswitch { dpid '0xabc' }
+    """
+    When I do phut run "network.conf"
+    Then a vswitch named "0xabc" launches
+
+  @sudo
+  Scenario: phut run with "vswitch { dpid NUMBER }"
+    Given a file named "network.conf" with:
+    """
+    vswitch { dpid 0xabc }
+    """
+    When I do phut run "network.conf"
+    Then a vswitch named "0xabc" launches
+
+  @sudo
+  Scenario: phut run with "vswitch { datapath_id STRING }"
+    Given a file named "network.conf" with:
+    """
+    vswitch { datapath_id '0xabc' }
+    """
+    When I do phut run "network.conf"
+    Then a vswitch named "0xabc" launches
+
+  @sudo
+  Scenario: phut run with "vswitch { datapath_id NUMBER }"
+    Given a file named "network.conf" with:
+    """
+    vswitch { datapath_id 0xabc }
+    """
+    When I do phut run "network.conf"
+    Then a vswitch named "0xabc" launches
+
+  @sudo
+  Scenario: phut run with "vswitch(alias) { ... }"
+    Given a file named "network.conf" with:
+    """
+    vswitch('my_switch') { datapath_id '0xabc' }
+    """
+    When I do phut run "network.conf"
+    Then a vswitch named "my_switch" launches

data/features/phut.feature

@@ -0,0 +1,5 @@
+Feature: phut command
+
+  Scenario: phut --version
+    When I successfully run `phut --version`
+    Then the output should match /\d+\.\d+\.\d+/

data/features/shell.feature

@@ -0,0 +1,40 @@
+Feature: Shell
+  Background:
+    Given I run `phut -v` interactively
+    And I type "pid_dir '.'"
+    And I type "log_dir '.'"
+    And I type "socket_dir '.'"
+
+  @shell
+  Scenario: vswitch NUMBER
+    When I type "vswitch 0xabc"
+    And I type "quit"
+    Then a file named "open_vswitch.0xabc.pid" should exist
+    And a file named "open_vswitch.0xabc.log" should exist
+
+  @shell
+  Scenario: vswitch STRING
+    When I type "vswitch '0xabc'"
+    And I type "quit"
+    Then a file named "open_vswitch.0xabc.pid" should exist
+    And a file named "open_vswitch.0xabc.log" should exist
+
+  @shell
+  Scenario: vswitch twice and fail
+    And I type "vswitch 0xabc"
+    When I type "vswitch 0xabc"
+    And I type "quit"
+    Then the output should contain "already running!"
+
+  @shell
+  Scenario: Kill and .pid is deleted
+    And I type "vswitch 0xabc"
+    When I type "kill 0xabc"
+    And I type "quit"
+    Then a file named "open_vswitch.0xabc.pid" should not exist
+
+  @shell
+  Scenario: Kill without run and fail
+    When I type "kill 0xabc"
+    And I type "quit"
+    Then the output should contain "Open vSwitch (dpid = 0xabc) is not running!"

data/features/step_definitions/phut_steps.rb

@@ -0,0 +1,30 @@
+require 'phut'
+
+When(/^I do phut run "(.*?)"$/) do |file_name|
+  @config_file = file_name
+  run_opts = "-p #{@pid_dir} -l #{@log_dir} -s #{@socket_dir}"
+  step %(I run `phut -v run #{run_opts} #{@config_file}`)
+end
+
+Then(/^a vswitch named "(.*?)" launches$/) do |name|
+  in_current_dir do
+    pid_file = File.join(File.expand_path(@pid_dir), "open_vswitch.#{name}.pid")
+    step %(a file named "#{pid_file}" should exist)
+  end
+end
+
+Then(/^a vhost named "(.*?)" launches$/) do |name|
+  in_current_dir do
+    pid_file = File.join(File.expand_path(@pid_dir), "phost.#{name}.pid")
+    step %(a file named "#{pid_file}" should exist)
+  end
+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
+    expect(link).to be_up
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'aruba/cucumber'
+
+require 'coveralls'
+Coveralls.wear_merged!

data/features/support/hooks.rb

@@ -0,0 +1,34 @@
+require 'phut'
+
+Before do
+  @pid_dir = '.'
+  @log_dir = '.'
+  @socket_dir = '.'
+end
+
+Before('@sudo') do
+  fail 'sudo authentication failed' unless system 'sudo -v'
+  @aruba_timeout_seconds = 10
+end
+
+Before('@shell') do
+  fail 'sudo authentication failed' unless system 'sudo -v'
+end
+
+After('@sudo') do
+  in_current_dir 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
+
+After('@shell') do
+  in_current_dir do
+    Dir.glob(File.join(Dir.getwd, '*.pid')).each do |each|
+      pid = IO.read(each).to_i
+      run "sudo kill #{pid}"
+    end
+  end
+end

data/lib/phut.rb

@@ -0,0 +1,5 @@
+require 'phut/cli'
+require 'phut/open_vswitch'
+require 'phut/parser'
+require 'phut/setting'
+require 'phut/version'

data/lib/phut/cli.rb

@@ -0,0 +1,61 @@
+require 'phut/null_logger'
+require 'phut/setting'
+require 'phut/shell_runner'
+
+module Phut
+  # cli command wrapper.
+  class Cli
+    include ShellRunner
+
+    def initialize(host, logger = NullLogger.new)
+      @host = host
+      @logger = logger
+    end
+
+    def send_packets(dest, options = {})
+      n_pkts = options[:n_pkts]
+      sh [executable,
+          "-i #{@host.interface} send_packets",
+          "--ip_dst #{dest.ip}",
+          "--ip_src #{@host.ip}",
+          '--tp_src 1',
+          '--tp_dst 1',
+          '--pps 1',
+          '--length 22',
+          n_pkts ? "--n_pkts=#{n_pkts}" : '--duration 1'].join(' ')
+    end
+
+    def show_tx_stats
+      puts stats(:tx)
+    end
+
+    def show_rx_stats
+      puts stats(:rx)
+    end
+
+    def add_arp_entry(other)
+      sh "sudo #{executable} -i #{@host.interface} add_arp_entry " \
+         "--ip_addr #{other.ip} --mac_addr #{other.mac}"
+    end
+
+    def set_ip_and_mac_address
+      sh "sudo #{executable} -i #{@host.interface} set_host_addr " \
+         "--ip_addr #{@host.ip} --ip_mask #{@host.netmask} " \
+         "--mac_addr #{@host.mac}"
+    end
+
+    def enable_promisc
+      sh "sudo #{executable} -i #{@host.interface} enable_promisc"
+    end
+
+    private
+
+    def executable
+      "#{Phut.root}/vendor/phost/src/cli"
+    end
+
+    def stats(type)
+      `sudo #{executable} -i #{@host.interface} show_stats --#{type}`
+    end
+  end
+end