funit 0.9.0

data/lib/funit/compiler.rb

@@ -0,0 +1,33 @@
+module Funit
+
+  ##
+  # Fortran compiler
+
+  class Compiler
+
+    def initialize
+      error_message = <<-COMPILER
+Fortran compiler environment variable 'FC' not set.
+
+For example, if you had the g95 compiler:
+
+      sh: export FC=g95
+     csh: setenv FC g95
+ windows: set FC=C:\\Program Files\\g95
+      COMPILER
+      raise error_message unless ENV['FC']
+    end
+
+  end
+
+end
+
+#--
+# Copyright 2006-2007 United States Government as represented by
+# NASA Langley Research Center. No copyright is claimed in
+# the United States under Title 17, U.S. Code. All Other Rights
+# Reserved.
+#
+# This file is governed by the NASA Open Source Agreement.
+# See License.txt for details.
+#++

data/lib/funit/functions.rb

@@ -0,0 +1,100 @@
+require 'erb'
+
+module Funit
+
+  TEST_RUNNER = ERB.new %q{
+    ! TestRunner.f90 - runs fUnit test suites
+    !
+    ! <%= File.basename $0 %> generated this file on <%= Time.now %>.
+
+    program TestRunner
+      <%= test_suites.inject('') { |result,test_suite| result << "\n  use #{test_suite}_fun" } %>
+
+      implicit none
+
+      integer :: numTests, numAsserts, numAssertsTested, numFailures
+
+      <% test_suites.each do |ts| %>
+      print *, ""
+      print *, "<%= ts %> test suite:"
+      call test_<%= ts %> &
+        ( numTests, numAsserts, numAssertsTested, numFailures )
+      print *, "Passed", numAssertsTested, "of", numAsserts, &
+               "possible asserts comprising",                &
+               numTests-numFailures, "of", numTests, "tests."
+      <% end %>
+      print *, ""
+
+    end program TestRunner
+    }.gsub(/^/,'    '), nil, '<>' # turn off newlines due to <%%>
+
+  def requested_modules(module_names)
+    if (module_names.empty?)
+      module_names = Dir["*.fun"].each{ |mod| mod.chomp! ".fun" }
+    end
+    module_names
+  end
+
+  def funit_exists?(module_name)
+    File.exists? "#{module_name}.fun"
+  end
+
+  def parse_command_line
+
+    module_names = requested_modules(ARGV)
+
+    if module_names.empty?
+      raise "   *Error: no test suites found in this directory"
+    end
+
+    module_names.each do |mod|
+      unless funit_exists?(mod) 
+        error_message = <<-FUNITDOESNOTEXIST
+ Error: could not find test suite #{mod}.fun
+ Test suites available in this directory:
+ #{requested_modules([]).join(' ')}
+
+ Usage: #{File.basename $0} [test names (w/o .fun suffix)]
+        FUNITDOESNOTEXIST
+        raise error_message
+      end
+    end
+
+  end
+
+  def write_test_runner test_suites
+    File.open("TestRunner.f90", "w") do |file|
+      file.puts TEST_RUNNER.result(binding)
+    end
+  end
+
+  def syntax_error( message, test_suite )
+    raise "\n   *Error: #{message} [#{test_suite}.fun:#$.]\n\n"
+  end
+
+  def warning( message, test_suite )
+    $stderr.puts "\n *Warning: #{message} [#{test_suite}.fun:#$.]"
+  end
+
+  def compile_tests test_suites
+    puts "computing dependencies"
+    dependencies = Fortran::Dependencies.new
+    puts "locating associated source files and sorting for compilation"
+    required_sources = dependencies.required_source_files('TestRunner.f90')
+
+    puts compile = "#{ENV['FC']} #{ENV['FCFLAGS']} -o TestRunner \\\n  #{required_sources.join(" \\\n  ")}"
+
+    raise "Compile failed." unless system compile
+  end
+
+end
+
+#--
+# Copyright 2006-2007 United States Government as represented by
+# NASA Langley Research Center. No copyright is claimed in
+# the United States under Title 17, U.S. Code. All Other Rights
+# Reserved.
+#
+# This file is governed by the NASA Open Source Agreement.
+# See License.txt for details.
+#++

data/lib/funit/testsuite.rb

@@ -0,0 +1,197 @@
+require 'funit/assertions'
+require 'funit/functions'
+require 'ftools' # FIXME: use fileutils
+
+module Funit
+  
+  include Assertions # FIXME
+
+  ##
+  # Create testsuite wrapper code
+
+  class TestSuite < File
+
+    ASSERTION_PATTERN = /Is(RealEqual|False|True|EqualWithin|Equal)\(.*\)/i
+    KEYWORDS = /(begin|end)(Setup|Teardown|Test)|Is(RealEqual|Equal|False|True|EqualWithin)\(.*\)/i
+    COMMENT_LINE = /^\s*!/
+    
+    include Funit #FIXME
+
+    def initialize suite_name
+      @line_number = 'blank'
+      @suite_name = suite_name
+      return nil unless funit_exists?(suite_name)
+      File.delete(suite_name+"_fun.f90") if File.exists?(suite_name+"_fun.f90")
+      super(suite_name+"_fun.f90","w")
+      @tests, @setup, @teardown = [], [], []
+      top_wrapper
+      expand
+      close
+    end
+
+    def top_wrapper
+      puts <<-TOP
+! #{@suite_name}_fun.f90 - a unit test suite for #{@suite_name}.f90
+!
+! #{File.basename $0} generated this file from #{@suite_name}.fun
+! at #{Time.now}
+
+module #{@suite_name}_fun
+
+ use #{@suite_name}
+
+ implicit none
+
+ logical :: noAssertFailed
+
+ public :: test_#@suite_name
+
+ private
+
+ integer :: numTests          = 0
+ integer :: numAsserts        = 0
+ integer :: numAssertsTested  = 0
+ integer :: numFailures       = 0
+
+      TOP
+    end
+
+    def expand
+      funit_file = @suite_name+".fun"
+      $stderr.print "expanding #{funit_file}..."
+   
+      funit_contents = IO.readlines(funit_file)
+      @funit_total_lines = funit_contents.length
+
+      while (line = funit_contents.shift) && line !~ KEYWORDS
+        puts line
+      end
+
+      funit_contents.unshift line
+
+      puts " contains\n\n"
+
+      while (line = funit_contents.shift)
+        case line
+        when COMMENT_LINE
+          puts line
+        when /beginSetup/i
+          add_to_setup funit_contents
+        when /beginTeardown/i
+          add_to_teardown funit_contents
+        when /XbeginTest\s+(\w+)/i
+          ignore_test($1,funit_contents)
+        when /beginTest\s+(\w+)/i
+          a_test($1,funit_contents)
+        when /beginTest/i
+          syntax_error "no name given for beginTest", @suite_name
+        when /end(Setup|Teardown|Test)/i
+          syntax_error "no matching begin#$1 for an #$&", @suite_name
+        when ASSERTION_PATTERN
+          syntax_error "#$1 assert not in a test block", @suite_name
+        else
+          puts line
+        end
+      end
+      $stderr.puts "done."
+    end
+
+    def add_to_setup funit_contents
+      while (line = funit_contents.shift) && line !~ /endSetup/i
+        @setup.push line
+      end
+    end
+
+    def add_to_teardown funit_contents
+      while (line = funit_contents.shift) && line !~ /endTeardown/i
+        @teardown.push line
+      end
+    end
+
+    def ignore_test test_name, funit_contents
+      warning("Ignoring test: #{test_name}", @suite_name)
+      line = funit_contents.shift while line !~ /endTest/i
+    end
+
+    def a_test test_name, funit_contents
+      @test_name = test_name
+      @tests.push test_name
+      syntax_error("test name #@test_name not unique",@suite_name) if (@tests.uniq!)
+
+      puts " subroutine #{test_name}\n\n"
+
+      num_of_asserts = 0
+  
+      while (line = funit_contents.shift) && line !~ /endTest/i
+        case line
+        when COMMENT_LINE
+          puts line
+        when /Is(RealEqual|False|True|EqualWithin|Equal)/i
+          @line_number = @funit_total_lines - funit_contents.length
+          num_of_asserts += 1
+          puts send( $&.downcase!, line )
+        else
+          puts line
+        end
+      end
+      warning("no asserts in test", @suite_name) if num_of_asserts == 0
+
+      puts "\n  numTests = numTests + 1\n\n"
+      puts " end subroutine #{test_name}\n\n"
+    end
+
+    def close
+      puts "\n subroutine Setup"
+      puts @setup
+      puts "  noAssertFailed = .true."
+      puts " end subroutine Setup\n\n"
+
+      puts "\n subroutine Teardown"
+      puts @teardown
+      puts " end subroutine Teardown\n\n"
+
+      puts <<-NEXTONE
+
+ subroutine test_#{@suite_name}( nTests, nAsserts, nAssertsTested, nFailures )
+
+  integer :: nTests
+  integer :: nAsserts
+  integer :: nAssertsTested
+  integer :: nFailures
+
+  continue
+      NEXTONE
+
+      @tests.each do |test_name|
+        puts "\n  call Setup"
+        puts "  call #{test_name}"
+        puts "  call Teardown"
+      end
+
+      puts <<-LASTONE
+
+  nTests          = numTests
+  nAsserts        = numAsserts
+  nAssertsTested  = numAssertsTested
+  nFailures       = numFailures
+
+ end subroutine test_#{@suite_name}
+
+end module #{@suite_name}_fun
+      LASTONE
+      super
+    end
+
+  end
+
+end
+
+#--
+# Copyright 2006-2007 United States Government as represented by
+# NASA Langley Research Center. No copyright is claimed in
+# the United States under Title 17, U.S. Code. All Other Rights
+# Reserved.
+#
+# This file is governed by the NASA Open Source Agreement.
+# See License.txt for details.
+#++

data/test/test_compiler.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+require 'funit/compiler'
+
+class TestCompiler < Test::Unit::TestCase
+
+  def test_no_environment_compiler_name
+    begin
+      orig_FC = ENV['FC']
+      ENV['FC'] = nil
+      assert_raises(RuntimeError) {Funit::Compiler.new}
+    ensure
+      ENV['FC'] = orig_FC
+    end
+  end  
+
+end

data/test/test_functions.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'funit/functions'
+
+class TestFunctions < Test::Unit::TestCase
+
+  def test_something
+    # FIXME
+  end
+
+end

data/test/test_funit.rb

@@ -0,0 +1,113 @@
+require 'test/unit'
+require 'funit'
+require 'ftools' # FIXME: migrate to fileutils
+
+class TestFunit < Test::Unit::TestCase
+
+  include Funit # FIXME
+  include Funit::Assertions # FIXME
+
+  def setup
+    File.rm_f(*Dir["dummyunit*"])
+    File.rm_f(*Dir["unit*"])
+    File.rm_f(*Dir["ydsbe*"])
+    File.rm_f(*Dir["lmzd*"])
+    File.rm_f(*Dir["ldfdl*"])
+    File.rm_f(*Dir["ydsbe*"])
+    File.rm_f(*Dir["TestRunner*"])
+    File.rm_f(*Dir["a.out"])
+  end
+
+  def teardown
+    File.rm_f(*Dir["dummyunit*"])
+    File.rm_f(*Dir["unit*"])
+    File.rm_f(*Dir["ydsbe*"])
+    File.rm_f(*Dir["lmzd*"])
+    File.rm_f(*Dir["ldfdl*"])
+    File.rm_f(*Dir["ydsbe*"])
+    File.rm_f(*Dir["TestRunner*"])
+    File.rm_f(*Dir["a.out"])
+  end
+
+  def test_main_driver_compiles
+    write_test_runner []
+    assert File.exists?("TestRunner.f90")
+    assert system("#{ENV['FC']} TestRunner.f90")
+    assert File.exists?("a.out")
+  end
+
+  def test_is_equal
+    @suite_name = "dummy"
+    @test_name = "dummy"
+    @line_number = "dummy"
+    isequal("IsEqual(1.0,m(1,1))")
+    assert_equal '.not.(1.0==m(1,1))', @condition
+  end 
+
+  def test_is_real_equal
+    @suite_name = "dummy"
+    @test_name = "dummy"
+    @line_number = "dummy"
+    isrealequal("IsRealEqual(a,b)")
+    ans = <<-EOF
+.not.(a+2*spacing(real(a)).ge.b &
+             .and.a-2*spacing(real(a)).le.b)
+    EOF
+    assert_equal ans.chomp, @condition
+    assert_equal '"b (",b,") is not",a,"within",2*spacing(real(a))', @message
+    isrealequal("IsRealEqual(1.0,m(1,1))")
+    ans = <<-EOF
+.not.(1.0+2*spacing(real(1.0)).ge.m(1,1) &
+             .and.1.0-2*spacing(real(1.0)).le.m(1,1))
+    EOF
+    assert_equal ans.chomp, @condition
+  end
+
+  def test_handles_dependency
+    File.open('unit.f90','w') do |f|
+      f.printf "module unit\n  use unita, only : a\nend module unit\n"
+    end
+    File.open('unita.f90','w') do |f|
+      f.printf "module unita\n  integer :: a = 5\nend module unita\n"
+    end
+    File.open('unit.fun','w') do |f|
+      f.printf "beginTest a_gets_set\n  IsEqual(5, a)\nendTest\n"
+    end
+    assert_nothing_raised{run_tests}
+  end
+
+  def test_embedded_dependencies
+    File.open('unit.f90','w') do |f|
+      f.printf "module unit\n  use unita, only : a\nend module unit\n"
+    end
+    File.open('unita.f90','w') do |f|
+      f.printf "module unita\n  use unitb, only : b \n  integer :: a = b\nend module unita\n"
+    end
+    File.open('unitb.f90','w') do |f|
+      f.printf "module unitb\n  integer,parameter :: b = 5\nend module unitb\n"
+    end
+    File.open('unit.fun','w') do |f|
+      f.printf "beginTest a_gets_set\n  IsEqual(5, a)\nendTest\n"
+    end
+    assert_nothing_raised{run_tests}
+ end
+
+  def test_requested_modules
+    assert_equal ["asdfga"], requested_modules(["asdfga"])
+    assert_equal ["asd","fga"], requested_modules(["asd","fga"])
+    assert requested_modules([]).empty?
+    modules = %w[ldfdl lmzd]
+    funits = modules.map{|f| f+'.fun'}.join(' ')
+    system "touch "+funits
+    assert_equal modules, requested_modules([])
+  end
+
+  def test_funit_exists_method
+    module_name = "ydsbe"
+    File.rm_f(module_name+".fun")
+    assert_equal false, funit_exists?(module_name)
+    system "touch "+module_name+".fun"
+    assert funit_exists?(module_name)
+  end
+
+end