trema 0.2.2.1 → 0.2.3

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/yard.i18n"]
+	path = vendor/yard.i18n
+	url = https://github.com/kou/yard

data/.travis.yml

@@ -0,0 +1,13 @@
+script: "rake travis"
+
+rvm:
+  - 1.8.7
+
+branches:
+  only:
+    - master
+    - develop
+
+before_install:
+ - sudo apt-get update
+ - sudo apt-get install libpcap-dev

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--readme README.md
+ruby/trema/**/*.rb
+ruby/trema/**/*.c

data/Gemfile

@@ -9,8 +9,7 @@ gemspec
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "bundler", "~> 1.1.0"
-  gem "cucumber", "~> 1.1.9"
+  gem "cucumber", "~> 1.2.1"
   gem "flay", "~> 1.4.3"
   gem "flog", "~> 2.5.3"
   gem "rake", "~> 0.9.2.2"
@@ -19,6 +18,6 @@ group :development do
   gem "redcarpet", "~> 2.1.0"
   gem "reek", "~> 1.2.8"
   gem "roodi", "~> 2.1.0"
-  gem "rspec", "~> 2.8.0"
+  gem "rspec", "~> 2.11.0"
   gem "yard", "~> 0.7"
 end

data/README.md

@@ -1,43 +1,8 @@
-Trema ![Project status](http://stillmaintained.com/trema/trema.png)
-=====
-An Open Source modular framework for developing OpenFlow controllers in Ruby/C
+Welcome to Trema
+================
 
-
-What's Trema?
--------------
-
-Welcome to the Trema OpenFlow programming framework. The scope of
-Trema is to help developers to easily create their own OpenFlow
-controllers, and NOT aiming at providing a specific OpenFlow
-controller implementation.
-
-
-Getting Started
----------------
-
-Trema requires several third-party software. You can install the
-prerequisites as follows:
-
-    $ sudo apt-get install gcc make ruby ruby-dev irb file libpcap-dev libsqlite3-dev
-
-Download Trema source tree then run its build script:
-
-    $ ./build.rb
-
-NOTE: Trema has been tested ONLY on the following environments:
-
-* Ubuntu 11.10 (i386/amd64, Desktop Edition)
-* Ubuntu 11.04 (i386/amd64, Desktop Edition)
-* Ubuntu 10.10 (i386/amd64, Desktop Edition)
-* Ubuntu 10.04 (i386/amd64, Desktop Edition)
-* Debian GNU/Linux 6.0 (i386/amd64)
-
-It may also run on other GNU/Linux distributions but is not tested and
-NOT SUPPORTED at this moment.
-
-
-What's here?
-------------
+Trema is a OpenFlow controller framework that includes everything
+needed to create OpenFlow controllers in Ruby and C.
 
 This distribution includes all the source code of Trema you need to
 develop your own OpenFlow controllers. The source tree includes basic
@@ -51,85 +16,66 @@ emulates an OpenFlow-based network and end-hosts is provided for
 testing your own controllers. For debugging, a wireshark plug-in to
 diagnose internal data-flows among functional modules is provided.
 
-Please refer to the quick start guide
-(https://github.com/trema/trema/wiki/Quick-start) for details.
+
+Getting Started
+---------------
+
+1.Install the prerequisites at the command prompt:
+
+    $ sudo apt-get install gcc make ruby rubygems ruby-dev irb libpcap-dev libsqlite3-dev
+
+2.Install Trema at the command prompt:
+
+    $ sudo gem install trema
+
+3.Follow the guidelines to start developing your OpenFlow controller. You may find the following resources handy:
+
+* The [Getting Started with Trema](https://github.com/trema/trema/wiki/Quick-start).
+* The [Trema in 10 Minutes Tutorial](http://trema-10min.heroku.com/).
+* The [Trema Tutorial](http://trema-tutorial.heroku.com/).
+* The [Trema Ruby API documents](http://rubydoc.info/github/trema/trema/master/frames).
+* The [Programming Trema Article (in Japanese)](http://gihyo.jp/dev/serial/01/openflow_sd/0007).
 
 
 Meta
 ----
 
-* Ruby API documents: http://rubydoc.info/github/trema/trema/master/frames
+* Web Page: http://trema.github.com/trema/
 * Bugs: https://github.com/trema/trema/issues
 * Mailing List: https://groups.google.com/group/trema-dev
 * Twitter: http://twitter.com/trema_news
-* Web Page: http://trema.github.com/trema/
-
 
-Authors
--------
-
-Please keep the list sorted.
-
-* Kazushi Sugyo
-* Kazuya Suzuki
-* Lei Sun
-* Nick Karanatsios <nickkaranatsios@gmail.com>
-* Shin'ya Zenke
-* Shuji Ishii
-* Sundell Jari <sundell.software@gmail.com>
-* Toshio Koide
-* Yasuhito Takamiya <yasuhito@gmail.com>
-* Yasunobu Chiba
-* Yasunori Nakazawa
 
+Supported Platforms
+-------------------
 
-### Contributors
+Trema has been tested ONLY on the following environments:
 
-Thanks to:
-
-* Initial Helios development team for implementing prototype versions.
-* HIDEyuki Shimonishi for providing much-needed coffee, snacks, and christmas cakes!
-* Anonymous alpha/beta testers for finding potential issues.
+* Ubuntu 12.04, 11.10, 11.04, 10.10, and 10.04 (i386/amd64, Desktop Edition)
+* Debian GNU/Linux 6.0 (i386/amd64)
 
+It may also run on other GNU/Linux distributions but is not tested and
+NOT SUPPORTED at this moment.
 
-License & Terms
----------------
 
-Copyright (C) 2008-2012 NEC Corporation
+Contributors
+------------
 
-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.
+Special thanks to all contributors for submitting patches. A full list of contributors including their patches can be found at:
 
-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.
+https://github.com/trema/trema/contributors
 
 
-### Terms
+Project Status
+--------------
 
-Terms of Contributing to Trema program ("Program")
+* Build Status [![Build Status](https://secure.travis-ci.org/trema/trema.png?branch=develop)](http://travis-ci.org/trema/trema)
+* Dependency Status [![Dependency Status](https://gemnasium.com/trema/trema.png)](https://gemnasium.com/trema/trema)
 
-Please read the following terms before you submit to the Trema project
-("Project") any original works of corrections, modifications,
-additions, patches and so forth to the Program ("Contribution").  By
-submitting the Contribution, you are agreeing to be bound by the
-following terms.  If you do not or cannot agree to any of the terms,
-please do not submit the Contribution:
 
-1. You hereby grant to any person or entity receiving or distributing
-   the Program through the Project a worldwide, perpetual,
-   non-exclusive, royalty free license to use, reproduce, modify,
-   prepare derivative works of, display, perform, sublicense, and
-   distribute the Contribution and such derivative works.
+License
+-------
 
-2. You warrant that you have all rights necessary to submit the
-   Contribution and, to the best of your knowledge, the Contribution
-   does not infringe copyright, patent, trademark, trade secret, or
-   other intellectual property rights of any third parties.
+Trema is released under the GNU General Public License version 2.0:
 
-3. In the event that the Contribution is combined with third parties'
-   programs, you notify to Project maintainers including NEC
-   Corporation ("Maintainers") the author, the license condition, and
-   the name of such third parties' programs.
+* http://www.gnu.org/licenses/gpl-2.0.html

data/Rakefile

@@ -1,6 +1,4 @@
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -24,10 +22,13 @@ require "rubygems"
 require "rake"
 
 task :default do
-  system "./build.rb"
+  sh "./build.rb"
 end
 
 
+task :travis => [ :default, "spec:travis" ]
+
+
 begin
   require "bundler/gem_tasks"
 rescue LoadError
@@ -43,6 +44,12 @@ begin
     spec.pattern = FileList[ "spec/**/*_spec.rb" ]
   end
 
+  RSpec::Core::RakeTask.new( "spec:travis" ) do | spec |
+    spec.pattern = FileList[ "spec/**/*_spec.rb" ]
+    # FIXME: use --tag ~sudo
+    spec.rspec_opts = "--tag nosudo -fs -c"
+  end
+
   RSpec::Core::RakeTask.new( :rcov ) do | spec |
     spec.pattern = "spec/**/*_spec.rb"
     spec.rcov = true
@@ -123,9 +130,9 @@ begin
   require "flay_task"
 
   FlayTask.new do | t |
-    # add directories such as app, bin, spec and test if need be.
     t.dirs = %w( ruby )
     t.threshold = 0
+    t.verbose = true
   end
 rescue LoadError
   $stderr.puts $!.to_s
@@ -142,8 +149,57 @@ begin
   require "yard"
 
   YARD::Rake::YardocTask.new do | t |
+    t.files = [ "ruby/trema/**/*.c", "ruby/trema/**/*.rb" ]
+    t.options = [ "--no-private" ]
     t.options << "--debug" << "--verbose" if $trace
   end
+
+  yardoc_i18n = "./vendor/yard.i18n/bin/yardoc"
+
+  namespace :yard do
+    desc "Generate YARD Documentation in Japanese"
+    task :ja => "yard:po" do
+      sh "#{ yardoc_i18n } --language ja ruby/trema"
+    end
+  end
+
+  locale_base_dir = "locale"
+  locale_dir = "#{ locale_base_dir }/ja"
+  pot = "#{ locale_base_dir }/yard.pot"
+  po = "#{ locale_dir }/yard.po"
+
+  namespace :yard do
+    desc "generate .pot file"
+    task :pot => pot
+
+    desc "Generate .po file"
+    task :po => po
+
+    file pot => FileList[ "ruby/trema/**/*.rb", "ruby/trema/**/*.c" ] do
+      Rake::Task[ "yard:pot:generate" ].invoke
+    end
+
+    namespace :pot do
+      task :generate do
+        sh( yardoc_i18n, "--no-yardopts", "--output", locale_base_dir, "--format", "pot", "ruby/trema" )
+      end
+    end
+
+    directory locale_dir
+    file po => [ locale_dir, pot ] do
+      Rake::Task[ "yard:po:generate" ].invoke
+    end
+
+    namespace :po do
+      task :generate do
+        if File.exist?( po )
+          sh( "msgmerge", "--update", "--sort-by-file", po, pot )
+        else
+          sh( "msginit", "--input", pot, "--output", po, "--locale", "ja.UTF-8" )
+        end
+      end
+    end
+  end
 rescue LoadError
   $stderr.puts $!.to_s
 end

data/Rantfile

@@ -228,6 +228,7 @@ task "vendor:openflow" => Trema.openflow_h
 file Trema.openflow_h => Trema.objects do
   sys.unpack_tgz "#{ Trema.vendor_openflow }.tar.gz", :in => Trema.vendor
   sys.cp_r "#{ Trema.vendor_openflow }/include/openflow", Trema.objects
+  sys "chmod -R +r #{ File.join Trema.objects, "openflow" }"
 end
 
 task "vendor:openflow:distclean" do
@@ -462,7 +463,7 @@ end
 desc "Build switch manager."
 task :switch_manager => Trema::Executables.switch_manager
 file Trema::Executables.switch_manager => switch_manager_objects + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpthread"
 end
 
 
@@ -482,7 +483,7 @@ end
 desc "Build switch."
 task :switch => Trema::Executables.switch
 file Trema::Executables.switch => switch_objects + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpthread"
 end
 
 
@@ -507,7 +508,7 @@ end
 desc "Build packetin filter."
 task :packetin_filter => Trema::Executables.packetin_filter
 file Trema::Executables.packetin_filter => packetin_filter_objects.candidates + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lpthread -lsqlite3 -ldl -lrt"
 end
 
 
@@ -543,7 +544,7 @@ end
 desc "Build tremashark."
 task :tremashark => Trema::Executables.tremashark
 file Trema::Executables.tremashark => tremashark_objects + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap -lpthread"
 end
 
 
@@ -557,7 +558,7 @@ end
 desc "Build packet_capture."
 task :packet_capture => Trema::Executables.packet_capture
 file Trema::Executables.packet_capture => packet_capture_objects + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap -lpthread"
 end
 
 
@@ -570,7 +571,7 @@ end
 desc "Build syslog_relay."
 task :syslog_relay => Trema::Executables.syslog_relay
 file Trema::Executables.syslog_relay => syslog_relay_objects + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap -lpthread"
 end
 
 
@@ -583,7 +584,7 @@ end
 desc "Build stdin_relay."
 task :stdin_relay => Trema::Executables.stdin_relay
 file Trema::Executables.stdin_relay => stdin_relay_objects + [ libtrema ] do | t |
-  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap"
+  sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpcap -lpthread"
 end
 
 
@@ -627,7 +628,7 @@ standalone_examples.each do | each |
   desc "Build #{ each } example."
   task "examples:#{ each }" => target
   file target => objects.candidates + [ libtrema ] do | t |
-    sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt"
+    sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ sys.sp t.prerequisites } -ltrema -lsqlite3 -ldl -lrt -lpthread"
   end
 end
 
@@ -666,7 +667,7 @@ openflow_messages.each do | each |
   target = File.join( openflow_message_objects_dir, each )
   task "examples:openflow_message" => target
   file target => [ File.join( openflow_message_objects_dir, "#{ each }.o" ), libtrema ] do | t |
-    sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ t.source } -ltrema -lsqlite3 -ldl -lrt"
+    sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ t.source } -ltrema -lsqlite3 -ldl -lrt -lpthread"
   end
 end
 
@@ -710,7 +711,7 @@ packetin_filter_config.each do | each |
     packetin_filter_config_utils_o,
     libtrema
   ] do | t |
-    sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ t.source } #{ packetin_filter_config_utils_o } -ltrema -lsqlite3 -ldl -lrt"
+    sys "gcc -L#{ Trema.lib } -o #{ t.name } #{ t.source } #{ packetin_filter_config_utils_o } -ltrema -lsqlite3 -ldl -lrt -lpthread"
   end
 end
 

data/cruise.rb

@@ -2,8 +2,6 @@
 #
 # Unit test & acceptance test runner for Trema.
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -26,7 +24,7 @@
 # threshold.
 #
 
-$coverage_threshold = 74.2
+$coverage_threshold = 68.9
 
 
 ################################################################################
@@ -94,7 +92,7 @@ class Testee
   def name
     File.basename( @path )
   end
-  
+
 
   def lines
     return @lines if @lines != 0
@@ -118,7 +116,7 @@ class Testee
     end
     n
   end
-  
+
 
   def lines_tested
     @lines * @coverage / 100.0
@@ -350,7 +348,7 @@ end
 
 $options.separator ""
 
-$options.on( "-h", "--help" ) do 
+$options.on( "-h", "--help" ) do
   puts $options.to_s
   exit
 end