trema 0.4.7 → 0.4.8

data/lib/trema/dirs.rb

@@ -0,0 +1,14 @@
+require 'tmpdir'
+
+# OpenFlow controller framework.
+module Trema
+  # Default values.
+  module Defaults
+    DEFAULT_LOG_DIR = ENV['TREMA_LOG_DIR'] || Dir.tmpdir
+    DEFAULT_PID_DIR = ENV['TREMA_PID_DIR'] || Dir.tmpdir
+    DEFAULT_SOCKET_DIR = ENV['TREMA_SOCKET_DIR'] || Dir.tmpdir
+  end
+  Defaults.freeze
+
+  include Defaults
+end

data/lib/trema/drb.rb

@@ -0,0 +1,32 @@
+require 'drb'
+require 'phut'
+
+# OpenFlow controller programming framework.
+module Trema
+  def self.trema_process(controller_name, socket_dir)
+    Phut.socket_dir = socket_dir
+    socket_path = File.join(Phut.socket_dir, "trema.#{controller_name}.ctl")
+    unless FileTest.socket?(socket_path)
+      fail %(Controller process "#{controller_name}" does not exist.)
+    end
+    DRbObject.new_with_uri('drbunix:' + socket_path)
+  end
+
+  def self.trema_processes(socket_dir = Phut.socket_dir)
+    Phut.socket_dir = socket_dir
+    Dir.glob(File.join Phut.socket_dir, 'trema.*.ctl').map do |each|
+      DRbObject.new_with_uri('drbunix:' + each)
+    end
+  end
+
+  def self.fetch(name, socket_dir)
+    trema_processes(socket_dir).each do |trema|
+      begin
+        return trema.fetch(name)
+      rescue
+        next
+      end
+    end
+    fail %("#{name}" does not exist.)
+  end
+end

data/lib/trema/logger.rb

@@ -0,0 +1,63 @@
+require 'phut'
+
+module Trema
+  # The default logger.
+  class Logger
+    def initialize(name)
+      @name = name
+      @logger = {}.tap do |list|
+        list[:file] = create_file_logger
+        list[:stdout] = create_stdout_logger
+      end
+    end
+
+    def fatal(message)
+      output :fatal, message
+    end
+
+    def error(message)
+      output :error, message
+    end
+
+    def warn(message)
+      output :warn, message
+    end
+
+    def info(message)
+      output :info, message
+    end
+
+    def debug(message)
+      output :debug, message
+    end
+
+    def level=(level)
+      @logger.values.each { |each| each.__send__ :level=, level }
+    end
+
+    def level
+      @logger[:file].level
+    end
+
+    private
+
+    def output(message_type, message)
+      @logger.values.each { |each| each.__send__ message_type, message }
+      message
+    end
+
+    def create_file_logger
+      ::Logger.new("#{Phut.log_dir}/#{@name}.log").tap do |logger|
+        logger.level = ::Logger::INFO
+      end
+    end
+
+    def create_stdout_logger
+      $stdout.sync = true
+      ::Logger.new($stdout).tap do |logger|
+        logger.formatter = proc { |_sev, _dtm, _name, msg| msg + "\n" }
+        logger.level = ::Logger::INFO
+      end
+    end
+  end
+end

data/lib/trema/monkey_patch/integer.rb

@@ -0,0 +1,8 @@
+require 'trema/monkey_patch/integer/base_conversions'
+require 'trema/monkey_patch/integer/durations'
+
+# Monkey patch for Integer class.
+class Integer
+  include Trema::MonkeyPatch::Integer::BaseConversions
+  include Trema::MonkeyPatch::Integer::Durations
+end

data/lib/trema/monkey_patch/integer/base_conversions.rb

@@ -0,0 +1,12 @@
+module Trema
+  module MonkeyPatch
+    module Integer
+      # to_hex etc.
+      module BaseConversions
+        def to_hex
+          format '%#x', self
+        end
+      end
+    end
+  end
+end

data/lib/trema/monkey_patch/integer/durations.rb

@@ -0,0 +1,12 @@
+module Trema
+  module MonkeyPatch
+    module Integer
+      # sec, hour, etc.
+      module Durations
+        def sec
+          self
+        end
+      end
+    end
+  end
+end

data/lib/trema/switch.rb

@@ -0,0 +1,83 @@
+require 'pio'
+
+module Trema
+  # OpenFlow switch.
+  class Switch
+    include Pio
+
+    OPENFLOW_HEADER_LENGTH = 8
+
+    OPENFLOW_MESSAGE_PARSER = {
+      OpenFlow::HELLO => Hello,
+      OpenFlow::ECHO_REQUEST => Echo::Request,
+      OpenFlow::ECHO_REPLY => Echo::Reply,
+      OpenFlow::FEATURES_REPLY => Features::Reply,
+      OpenFlow::PACKET_IN => PacketIn,
+      OpenFlow::PORT_STATUS => PortStatus
+    }
+
+    def initialize(socket)
+      @socket = socket
+    end
+
+    def init
+      exchange_hello_messages
+      exchange_echo_messages
+      exchange_features_messages
+      self
+    end
+
+    def datapath_id
+      fail 'Switch is not initialized.' unless @features_reply
+      @features_reply.datapath_id
+    end
+    alias_method :dpid, :datapath_id
+
+    def write(message)
+      @socket.write message.to_binary
+    end
+
+    def read
+      message_type, binary = read_openflow_binary
+      OPENFLOW_MESSAGE_PARSER.fetch(message_type).read(binary)
+    rescue KeyError
+      raise "Unknown OpenFlow message (message_type = #{message_type})."
+    end
+
+    private
+
+    def exchange_hello_messages
+      fail 'Failed to exchange Hello messages' unless read.is_a?(Hello)
+      write Hello.new
+    end
+
+    def exchange_echo_messages
+      write Echo::Request.new
+      fail 'Failed to exchange Echo messages' unless read.is_a?(Echo::Reply)
+    end
+
+    def exchange_features_messages
+      write Features::Request.new
+      @features_reply = read
+      return if @features_reply.is_a?(Features::Reply)
+      fail 'Failed to exchange Features messages'
+    end
+
+    def read_openflow_binary
+      header_binary = drain(OPENFLOW_HEADER_LENGTH)
+      header = OpenFlowHeaderParser.read(header_binary)
+      body_binary = drain(header.message_length - OPENFLOW_HEADER_LENGTH)
+      fail if (header_binary + body_binary).length != header.message_length
+      [header.message_type, header_binary + body_binary]
+    end
+
+    def drain(length)
+      buffer = ''
+      loop do
+        buffer += @socket.readpartial(length - buffer.length)
+        break if buffer.length == length
+      end
+      buffer
+    end
+  end
+end

data/lib/trema/version.rb

@@ -0,0 +1,5 @@
+# Base module.
+module Trema
+  # gem version.
+  VERSION = '0.4.8'.freeze
+end

data/spec/spec_helper.rb

@@ -1,183 +1,14 @@
-#
-# Copyright (C) 2008-2013 NEC Corporation
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License, version 2, as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-#
-
+require 'simplecov'
 require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'ruby')
-$LOAD_PATH.unshift File.expand_path(File.join File.dirname(__FILE__), '..', 'vendor', 'ruby-ifconfig-1.2', 'lib')
-
-
-require 'rspec'
-require 'rspec/autorun'
-require 'pio'
-require 'trema'
-require 'trema/dsl/configuration'
-require 'trema/dsl/context'
-require 'trema/ofctl'
-require 'trema/shell'
-require 'trema/util'
-
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir[ "#{ File.dirname(__FILE__) }/support/**/*.rb"].each do | each |
-  require File.expand_path(each)
-end
-
-
-RSpec.configure do | config |
-  config.expect_with :rspec do | c |
-    # Ensure that 'expect' is used and disable 'should' for consistency
-    c.syntax = :expect
-  end
-end
-
-
-include Trema
-
-
-def controller(name)
-  Trema::App[ name]
-end
-
-
-def vswitch(name)
-  Trema::OpenflowSwitch[ name]
-end
-
-
-def vhost(name)
-  Trema::Host[ name]
-end
-
-
-def send_packets(source, dest, options = {})
-  Trema::Shell.send_packets source, dest, options
-end
-
-
-include Trema::Util
-
-
-class Network
-  def initialize(&block)
-    @context = Trema::DSL::Parser.new.eval(&block)
-  end
-
-
-  def run(controller_class, &test)
-    trema_run controller_class
-    test.call
-  ensure
-    trema_kill
-  end
-
-
-  ################################################################################
-  private
-  ################################################################################
-
-
-  def trema_run(controller_class)
-    controller = controller_class.new
-    unless controller.is_a?(Trema::Controller)
-      fail "#{ controller_class } is not a subclass of Trema::Controller"
-    end
-    Trema::DSL::Context.new(@context).dump
-
-    app_name = controller.name
-    rule = { :port_status => app_name, :packet_in => app_name, :state_notify => app_name }
-    sm = SwitchManager.new(rule, @context.port)
-    sm.no_flow_cleanup = true
-    sm.run!
-
-    @context.links.each do | name, each |
-      each.add!
-    end
-    @context.hosts.each do | name, each |
-      each.run!
-    end
-    @context.switches.each do | name, each |
-      each.run!
-      drop_packets_from_unknown_hosts each
-    end
-    @context.links.each do | name, each |
-      each.up!
-    end
-    @context.hosts.each do | name, each |
-      each.add_arp_entry @context.hosts.values - [each]
-    end
-
-    @th_controller = Thread.start do
-      controller.run!
-    end
-    wait_until_controller_is_up app_name
-  end
-
-
-  def trema_kill
-    cleanup_current_session
-    @th_controller.join if @th_controller
-    wait_until_all_pid_files_are_deleted
-  end
-
-
-  def drop_packets_from_unknown_hosts(switch)
-    ofctl = Trema::Ofctl.new
-    ofctl.add_flow switch, :priority => 0, :actions => 'drop'
-    @context.hosts.each do | name, each |
-      ofctl.add_flow switch, :dl_type => '0x0800', :nw_src => each.ip, :priority => 1, :actions => 'controller'
-    end
-  end
-
-
-  def wait_until_controller_is_up(trema_name, timeout = 10)
-    elapsed = 0
-    loop do
-      fail "Timed out waiting for #{ trema_name }." if elapsed > timeout
-      break if FileTest.exists?(File.join(Trema.pid, "#{ trema_name }.pid"))
-      sleep 0.1
-      elapsed += 0.1
-    end
-    sleep 1
-  end
-
-
-  def wait_until_all_pid_files_are_deleted(timeout = 12)
-    elapsed = 0
-    loop do
-      fail 'Failed to clean up remaining processes.' if elapsed > timeout
-      break if Dir.glob(File.join(Trema.pid, '*.pid')).empty?
-      sleep 0.1
-      elapsed += 0.1
-    end
-    sleep 1
-  end
-end
-
+require 'coveralls'
 
-def network(&block)
-  Network.new(&block)
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+formatters << Coveralls::SimpleCov::Formatter if ENV['COVERALLS_REPO_TOKEN']
+if ENV['CODECLIMATE_REPO_TOKEN']
+  formatters << CodeClimate::TestReporter::Formatter
 end
 
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+SimpleCov.start { add_filter '/vendor/' }
 
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:
+require 'rspec/given'

data/spec/trema/controller_spec.rb

@@ -1,56 +1,7 @@
-#
-# Copyright (C) 2008-2013 NEC Corporation
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License, version 2, as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-#
+require 'trema/controller'
 
-
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-require 'trema'
-
-
-module Trema
-  describe Controller do
-    subject { Controller }
-
-    it { should have_constant :OFPP_MAX }
-    it { should have_constant :OFPP_IN_PORT }
-    it { should have_constant :OFPP_TABLE }
-    it { should have_constant :OFPP_NORMAL }
-    it { should have_constant :OFPP_FLOOD }
-    it { should have_constant :OFPP_ALL }
-    it { should have_constant :OFPP_CONTROLLER }
-    it { should have_constant :OFPP_LOCAL }
-    it { should have_constant :OFPP_NONE }
-
-
-    context '.new' do
-      subject { Controller.new }
-
-      it { should respond_to :critical }
-      it { should respond_to :error }
-      it { should respond_to :warn }
-      it { should respond_to :notice }
-      it { should respond_to :info }
-      it { should respond_to :debug }
-    end
+describe Trema::Controller do
+  describe '::DEFAULT_TCP_PORT' do
+    Then { Trema::Controller::DEFAULT_TCP_PORT == 6653 }
   end
 end
-
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End: