rake-tester 0.0.1

data/HISTORY.markdown

@@ -0,0 +1,7 @@
+# 0.0.1 #
+
+*   Initial release
+*   Automatic compilation and execution
+*   Valgind support
+*   GDB support
+

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2009 Fabian Streitel
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,91 @@
+# rake-tester #
+
+<http://www.github.com/karottenreibe/rake-tester>
+
+An extension of the [rake-compiler][rakecompiler] that allows
+for automatic compilation of C test suites, e.g. using
+[cmockery].
+
+
+## Features/Limitations ##
+
+*   Automatically compiles and executes test suites of
+    arbitrary C testing frameworks
+*   Can batch-execute all suites or selectively run a single suite
+*   Can only compile the tests for your current platform
+*   Thus, no cross compilation of the tests
+*   Support for running the tests with valgrind or gdb
+
+
+## Installation ##
+
+    gem install rake-tester
+
+
+## Usage ##
+
+In the Rakefile:
+
+    require 'rake/extensiontask'
+    require 'rake/extensiontesttask'
+
+    Rake::ExtensionTask.new(...) do |ext|
+        # ... confgure as normal
+
+        ext.test_files          = FileList['test/c/*']
+        ext.test_includes       << '/usr/include/frood_stuff'
+        ext.test_libraries      << 'zaphods_heads'
+        ext.test_lib_folders    << '/usr/lib/floopy'
+    end
+
+Write your tests.
+
+To test everything:
+
+    $ rake test:c
+
+To test one extension:
+
+    $ rake test:c:extension
+
+To execute one test suite:
+
+    $ rake test:c:extension[test_feature]
+
+To use valgrind:
+
+    $ rake test:valgrind:extension[test_feature]
+
+To use gdb:
+
+    $ rake test:gdb:extension[test_feature]
+
+
+## License ##
+
+    Copyright (c) 2009 Fabian Streitel
+
+    Permission is hereby granted, free of charge, to any person
+    obtaining a copy of this software and associated documentation
+    files (the "Software"), to deal in the Software without
+    restriction, including without limitation the rights to use,
+    copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following
+    conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+    OTHER DEALINGS IN THE SOFTWARE.
+
+[rakecompiler]:     http://github.com/luislavena/rake-compiler      "The rake-compile project"
+[cmockery]:         http://code.google.com/p/cmockery/              "The cmockery C testing framework"
+

data/Rakefile

@@ -0,0 +1,30 @@
+
+task :release do
+    sh "vim HISTORY.markdown"
+    sh "vim README.markdown"
+    sh "git commit -a -m 'prerelease adjustments'; true"
+end
+
+require 'jeweler'
+jeweler_tasks = Jeweler::Tasks.new do |gem|
+    gem.name                = 'rake-tester'
+    gem.summary             = 'rake-tester is an extension to the rake-compiler that maintains C test suites'
+    gem.description         = gem.summary
+    gem.email               = 'karottenreibe@gmail.com'
+    gem.homepage            = 'http://github.com/karottenreibe/rake-tester'
+    gem.authors             = ['Fabian Streitel']
+    gem.rubyforge_project   = 'k-gems'
+end
+
+Jeweler::RubyforgeTasks.new
+Jeweler::GemcutterTasks.new
+
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = 'Joker'
+    rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_files.include('ext/**/*.rb')
+end
+

data/lib/rake/extensiontesttask.rb

@@ -0,0 +1,114 @@
+require 'rake/clean'
+require 'rake/extensiontask'
+
+module Rake
+
+    class ExtensionTask
+
+        #
+        # The C files to compile.
+        #
+        attr_accessor :test_files
+
+        #
+        # The folders where includes for the test files are.
+        #
+        # Default: %w{/usr/include /usr/include/google}
+        #
+        attr_accessor :test_includes
+
+        #
+        # The libraries to link against.
+        #
+        # Default: %w{cmockery}
+        #
+        attr_accessor :test_libraries
+
+        #
+        # The folders where the libraries are
+        #
+        # Default: %w{/usr/lib}
+        #
+        attr_accessor :test_lib_folders
+
+        alias_method :initialize_old, :initialize
+
+        def initialize( *args, &block )
+            @test_files       = Array.new
+            @test_includes    = %w{/usr/include /usr/include/google}
+            @test_libraries   = %w{cmockery}
+            @test_lib_folders = %w{/usr/lib}
+
+            initialize_old(*args, &block)
+            init_test_tasks()
+        end
+
+        private
+
+        def init_test_tasks
+            # some stuff we need often later on
+            compile_dir   = "#{@tmp_dir}/test"
+            compile_task  = "compile:#{@name}:test"
+            test_task     = "test:c:#{@name}"
+            valgrind_task = "test:valgrind:#{@name}"
+            gdb_task      = "test:gdb:#{@name}"
+
+            directory compile_dir
+
+            desc "Compile #{@name} tests"
+            task compile_task => ["compile:#{@name}", compile_dir] do
+                # copy the test files into the compilation folder
+                @test_files.each { |file| cp file, compile_dir }
+
+                # start compilation
+                chdir(compile_dir) do
+                    includes = (@test_includes + [
+                        ".",
+                        "../../#{@ext_dir}",
+                        "/usr/include/ruby-#{RUBY_VERSION}",
+                        "/usr/include/ruby-#{RUBY_VERSION}/#{RUBY_PLATFORM}",
+                    ]).map { |l| '-I' + l }.join(' ')
+
+                    # compile the test sources
+                    FileList['*.c'].each do |cfile|
+                        sh "gcc -g #{includes} -c #{cfile}"
+                    end
+
+                    source_objects = FileList["../#{RUBY_PLATFORM}/#{@name}/#{RUBY_VERSION}/*.o"]
+                    libraries      = (@test_libraries + %w{ruby pthread crypto}).map { |l| '-l' + l }.join(' ')
+                    lib_folders    = (@test_lib_folders + %w{/usr/lib .}).map { |l| '-L' + l }.join(' ')
+
+                    # link the executables
+                    FileList['*.o'].each do |ofile|
+                        sh "gcc -g #{lib_folders} #{libraries} #{source_objects} #{ofile} -o #{ofile.ext}"
+                    end
+                end
+            end
+
+            desc "Execute valgrind for a #{@name} test"
+            task valgrind_task, :test, :needs => [compile_task] do |t,args|
+                sh "valgrind --num-callers=50 --error-limit=no --partial-loads-ok=yes --undef-value-errors=no --leak-check=full #{compile_dir}/#{args.test}"
+            end
+
+            desc "Execute gdb for a #{@name} test"
+            task gdb_task, :test, :needs => [compile_task] do |t,args|
+                sh "gdb #{compile_dir}/#{args.test}"
+            end
+
+            desc "Test #{@name}"
+            task test_task, :test, :needs => [compile_task] do |t,args|
+                if args.test
+                    sh "#{compile_dir}/#{args.test}"
+                else
+                    FileList["#{compile_dir}/*.o"].each do |ofile|
+                        sh "#{ofile.ext}"
+                    end
+                end
+            end
+
+            desc "Test all C extensions"
+            task 'test:c' => [test_task]
+        end
+    end
+end
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: rake-tester
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Fabian Streitel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: rake-tester is an extension to the rake-compiler that maintains C test suites
+email: karottenreibe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- HISTORY.markdown
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/rake/extensiontesttask.rb
+has_rdoc: true
+homepage: http://github.com/karottenreibe/rake-tester
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: k-gems
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: rake-tester is an extension to the rake-compiler that maintains C test suites
+test_files: []
+