fUnit 0.0.1

data/lib/funit/functions.rb

@@ -0,0 +1,124 @@
+module Funit
+
+  class Compiler
+
+    attr_reader :name
+
+    def initialize( name=ENV['F9X'] )
+      errorMessage = <<-ENVIRON
+
+Fortran compiler environment variable 'F9X' not set:
+
+ for bourne-based shells: export F9X=lf95 (in .profile)
+      for c-based shells: setenv F9X lf95 (in .login)
+             for windows: set F9X=C:\\Program Files\\lf95 (in autoexec.bat)
+
+      ENVIRON
+      raise(errorMessage) unless @name = name
+    end
+
+  end
+
+  def requestedModules(moduleNames)
+    if (moduleNames.empty?)
+      moduleNames = Dir["*MT.ftk"].each{ |mod| mod.chomp! "MT.ftk" }
+    end
+    moduleNames
+  end
+
+  def ftkExists?(moduleName)
+    File.exists? moduleName+"MT.ftk"
+  end
+
+  def parseCommandLine
+
+    moduleNames = requestedModules(ARGV)
+
+    if moduleNames.empty?
+      raise "   *Error: no test suites found in this directory"
+    end
+
+    moduleNames.each do |mod|
+      unless ftkExists?(mod) 
+        errorMessage = <<-FTKDOESNOTEXIST
+ Error: could not find test suite #{mod}MT.ftk
+ Test suites available in this directory:
+ #{requestedModules([]).join(' ')}
+
+ Usage: #{File.basename $0} [test names (w/o MT.ftk suffix)]
+        FTKDOESNOTEXIST
+        raise errorMessage
+      end
+    end
+
+  end
+
+  def writeTestRunner testSuites
+
+    File.delete("TestRunner.f90") if File.exists?("TestRunner.f90")
+    testRunner = File.new "TestRunner.f90", "w"
+
+    testRunner.puts <<-HEADER
+! TestRunner.f90 - runs Fortran mobility test suites
+!
+! [Dynamically generated by #{File.basename $0} Ruby script #{Time.now}.]
+
+program TestRunner
+
+    HEADER
+
+    testSuites.each { |testSuite| testRunner.puts " use #{testSuite}MT" }
+
+    testRunner.puts <<-DECLARE
+
+ implicit none
+
+ integer :: numTests, numAsserts, numAssertsTested, numFailures
+    DECLARE
+
+    testSuites.each do |testSuite|
+      testRunner.puts <<-TRYIT
+
+ print *, ""
+ print *, "#{testSuite} test suite:"
+ call MT#{testSuite}( numTests, &
+        numAsserts, numAssertsTested, numFailures )
+ print *, "Passed", numAssertsTested, "of", numAsserts, &
+          "possible asserts comprising", &
+           numTests-numFailures, "of", numTests, "tests." 
+      TRYIT
+    end
+
+    testRunner.puts "\n print *, \"\""
+    testRunner.puts "\nend program TestRunner"
+    testRunner.close
+    File.chmod(0444,"TestRunner.f90")
+  end
+
+  def syntaxError( message, testSuite )
+    raise "\n   *Error: #{message} [#{testSuite}MT.ftk:#$.]\n\n"
+  end
+
+  def warning( message, testSuite )
+    $stderr.puts "\n *Warning: #{message} [#{testSuite}MT.ftk:#$.]"
+  end
+
+  def compileTests testSuites
+    require 'fortran_deps'
+
+    puts "computing dependencies"
+    dependencies = Depend.new(['.', '../LibF90', '../PHYSICS_DEPS'])
+    puts "locating associated source files and sorting for compilation"
+    requiredSources = dependencies.required_source_files('TestRunner.f90')
+
+    puts compile = "#{ENV['F9X']} #{ENV['F9X_LDFLAGS']} -o TestRunner \\\n  #{requiredSources.join(" \\\n  ")}"
+
+    raise "Compile failed." unless system(compile)
+
+  end
+
+  # set some regular expressions:
+  $keyword = /(begin|end)(Setup|Teardown|Test)|Is(RealEqual|Equal|False|True|EqualWithin)\(.*\)/i
+  $commentLine = /^\s*!/
+
+end # module Funit

data/lib/funit/test_suite.rb

@@ -0,0 +1,180 @@
+module Funit
+
+  include Funit::Assertions
+
+  class TestSuite < File
+
+    include Funit
+
+    def initialize suiteName
+      @lineNumber = 'blank'
+      @suiteName = suiteName
+      return nil unless ftkExists?(suiteName)
+      File.delete(suiteName+"MT.f90") if File.exists?(suiteName+"MT.f90")
+      super(suiteName+"MT.f90","w")
+      @tests, @setup, @teardown = Array.new, Array.new, Array.new
+      topWrapper
+      expand
+      close
+    end
+
+    def topWrapper
+      puts <<-TOP
+! #{@suiteName}MT.f90 - a Fortran mobility test suite for #{@suiteName}.f90
+!
+! [dynamically generated from #{@suiteName}MT.ftk
+!  by #{File.basename $0} Ruby script #{Time.now}]
+
+module #{@suiteName}MT
+
+ use #{@suiteName}
+
+ implicit none
+
+ private
+
+ public :: MT#{@suiteName}
+
+ logical :: noAssertFailed
+
+ integer :: numTests          = 0
+ integer :: numAsserts        = 0
+ integer :: numAssertsTested  = 0
+ integer :: numFailures       = 0
+
+      TOP
+    end
+
+    def expand
+ 
+      ftkFile = @suiteName+"MT.ftk"
+      $stderr.puts "parsing #{ftkFile}"
+   
+      ftk = IO.readlines(ftkFile)
+      @ftkTotalLines = ftk.length
+
+      while (line = ftk.shift) && line !~ $keyword
+        puts line
+      end
+
+      ftk.unshift line
+
+      puts " contains\n\n"
+
+      while (line = ftk.shift)
+        case line
+        when $commentLine
+          puts line
+        when /beginSetup/i
+          addtoSetup ftk
+        when /beginTeardown/i
+          addtoTeardown ftk
+        when /XbeginTest\s+(\w+)/i
+          ignoreTest($1,ftk)
+        when /beginTest\s+(\w+)/i
+          aTest($1,ftk)
+        when /beginTest/i
+          syntaxError "no name given for beginTest", @suiteName
+        when /end(Setup|Teardown|Test)/i
+          syntaxError "no matching begin#$1 for an #$&", @suiteName
+        when $assertRegEx
+          syntaxError "#$1 assert not in a test block", @suiteName
+        else
+          puts line
+        end
+      end # while
+
+      $stderr.puts "completed #{ftkFile}"
+
+    end
+
+    def addtoSetup ftk
+      while (line = ftk.shift) && line !~ /endSetup/i
+        @setup.push line
+      end
+    end
+
+    def addtoTeardown ftk
+      while (line = ftk.shift) && line !~ /endTeardown/i
+        @teardown.push line
+      end
+    end
+
+    def ignoreTest testName, ftk
+      warning("Ignoring test: #{testName}", @suiteName)
+      line = ftk.shift while line !~ /endTest/i
+    end
+
+    def aTest testName, ftk
+      @testName = testName
+      @tests.push testName
+      syntaxError("test name #@testName not unique",@suiteName) if (@tests.uniq!)
+
+      puts " subroutine Test#{testName}\n\n"
+
+      numOfAsserts = 0
+  
+      while (line = ftk.shift) && line !~ /endTest/i
+        case line
+        when $commentLine
+          puts line
+        when /Is(RealEqual|False|True|EqualWithin|Equal)/i
+          @lineNumber = @ftkTotalLines - ftk.length
+          numOfAsserts += 1
+          puts send( $&.downcase!, line )
+        else
+          puts line
+        end
+      end
+      warning("no asserts in test", @suiteName) if numOfAsserts == 0
+
+      puts "\n  numTests = numTests + 1\n\n"
+      puts " end subroutine Test#{testName}\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 MT#{@suiteName}( nTests, nAsserts, nAssertsTested, nFailures )
+
+  integer :: nTests
+  integer :: nAsserts
+  integer :: nAssertsTested
+  integer :: nFailures
+
+  continue
+      NEXTONE
+
+      @tests.each do |testName|
+        puts "\n  call Setup"
+        puts "  call Test#{testName}"
+        puts "  call Teardown"
+      end
+
+      puts <<-LASTONE
+
+  nTests          = numTests
+  nAsserts        = numAsserts
+  nAssertsTested  = numAssertsTested
+  nFailures       = numFailures
+
+ end subroutine MT#{@suiteName}
+
+end module #{@suiteName}MT
+      LASTONE
+      super
+      File.chmod(0444,@suiteName+"MT.f90")
+    end
+
+  end # class TestSuite
+
+end # module Funit

data/lib/funit.rb

@@ -0,0 +1,25 @@
+require 'funit/functions'
+require 'funit/assertions'
+require 'funit/test_suite'
+
+module Funit
+
+  def runAllFtks
+
+    Compiler.new # a test for compiler env set (remove this later)
+
+    writeTestRunner(testSuites = parseCommandLine)
+
+    # convert each *MT.ftk file into a pure Fortran9x file:
+
+    testSuites.each do |testSuite|
+      testSuiteF90 = TestSuite.new(testSuite)
+    end
+ 
+    compileTests testSuites
+
+    raise "Failed to execute TestRunner" unless system("./TestRunner")
+ 
+  end
+
+end

data/lib/mklinks

@@ -0,0 +1,5 @@
+ln -s ../examples/CFD/GasModel.f90 .
+ln -s ../examples/CFD/GasModelTS.ftk .
+ln -s ../examples/CFD/Gammas.f90 .
+ln -s ../examples/CFD/FluxFunctions.f90 .
+ln -s ../examples/CFD/FluxFunctionsTS.ftk .

data/tests/tc_compile.rb

@@ -0,0 +1,30 @@
+$:.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
+require 'test/unit'
+require 'funit/functions'
+
+class TestCompiler < Test::Unit::TestCase
+
+ def setup
+  @compilerStub = 'dummyCompiler'
+  @oldCompilerName = ENV['F9X']
+ end
+
+ def test_explicit_compiler_name
+  assert_equal @compilerStub, Funit::Compiler.new(@compilerStub).name
+ end
+
+ def test_compiler_name_from_environment
+  ENV['F9X'] = @compilerStub
+  assert_equal @compilerStub, Funit::Compiler.new.name
+ end  
+
+ def test_no_environment_compiler_name
+  ENV['F9X'] = nil
+  assert_raises(RuntimeError) {Funit::Compiler.new}
+ end  
+
+ def teardown
+   ENV['F9X'] = @oldCompilerName
+ end
+
+end

data/tests/tc_fortran_deps.rb

@@ -0,0 +1,167 @@
+$:.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
+require 'test/unit'
+require 'fortran_deps'
+require 'fileutils'
+
+class TestFortranDeps < Test::Unit::TestCase
+
+ def setup
+  Dir.mkdir 'DependenciesFixture'
+  Dir.chdir 'DependenciesFixture'
+  Dir.mkdir 'lib'
+  Dir.chdir 'lib'
+  File.open('solution.f90','w') do |f|
+   f.puts "module solution\nuse area\nend module solution"
+  end
+  Dir.chdir '..'
+  Dir.mkdir 'src'
+  Dir.chdir 'src'
+  File.open('main.F90','w') do |f|
+   f.puts 'program whizzard'
+   f.puts " use grid\n use solution\n use circle"
+   f.puts 'end program whizzard'
+  end
+  File.open('grid.f90','w'){ |f| f.puts "module grid\nuse area\nend module grid" }
+  File.open('shapes.f90','w') do |f|
+   f.puts "module rectangle_fun3d\nend module rectangle_fun3d"
+   f.puts "module circle\n use area\nend module circle"
+  end
+  File.open('area.f90','w'){ |f| f.puts "module area\nend module area" }
+  File.open('externalUse.f90','w') do |f|
+   f.puts "program user\nuse cantFindModule\nend program"
+  end
+  @dep = Depend.new
+ end
+
+ def test_finds_which_modules_a_source_file_uses
+  assert_equal %w[grid solution circle], @dep.modules_used_in( 'main.F90' )
+ end
+
+ def test_finds_modules_defined_in_source_file
+  assert_equal %w[rectangle_fun3d circle], @dep.modules_defined_in( 'shapes.f90' )
+ end
+
+ def test_create_module_definition_hash
+  assert_equal %w[circle rectangle_fun3d],
+               @dep.build_dictionary_of_modules_in( 'shapes.f90' ).keys.sort
+ end
+
+ def test_locating_all_fortran_files_in_search_path
+  files = %w[ ../lib/solution.f90 ./area.f90 ./externalUse.f90
+              ./grid.f90 ./main.F90 ./shapes.f90 ]
+  @dep.fortran_files_within.each do |file|
+   assert files.include?(file)
+  end
+ end
+
+ def test_build_hash_with_source_files
+  f90 = %w[./grid.f90 ../lib/solution.f90 ./shapes.f90 ./area.f90]
+  hash = @dep.build_dictionary_of_modules_in( f90 )
+  assert_equal \
+   %w[./shapes.f90 ./shapes.f90 ./area.f90 ../lib/solution.f90 ./grid.f90].sort,
+   hash.values.sort
+  assert_equal %w[rectangle_fun3d circle area solution grid].sort, hash.keys.sort
+  assert_equal hash , @dep.build_hash_of_modules_in_files_within
+ end
+
+ def test_dependency_generation_elements
+  directoryHash = @dep.build_hash_of_modules_in_files_within
+
+  sourceFile = "main.F90"
+  modules = @dep.modules_used_in( sourceFile )
+  assert_equal %w[grid solution circle], modules
+  
+  newSourceFiles = modules.collect{ |mod| directoryHash[mod] }
+  assert_equal %w[./grid.f90 ../lib/solution.f90 ./shapes.f90], newSourceFiles
+  
+  newModules = newSourceFiles.collect do |file|
+   @dep.modules_used_in( file )
+  end.flatten.uniq
+
+  assert_equal ["area"], newModules
+ end
+
+ def test_makefile_dependency_line_generation
+  sourceFile = "main.F90"
+  makeGolden=String.new <<-GOLDEN
+main.o: main.F90 \\
+ grid.o \\
+ solution.o \\
+ shapes.o
+  GOLDEN
+  assert_equal makeGolden, @dep.makefile_dependency_line(sourceFile)
+ end
+
+ def test_makefile_dependency_recurses_properly
+  makeGolden=String.new <<-GOLDEN
+main.o: main.F90 \\
+ grid.o \\
+ solution.o \\
+ shapes.o
+grid.o: grid.f90 \\
+ area.o
+area.o: area.f90
+solution.f90: ../lib/solution.f90
+\tln -sf ../lib/solution.f90 .
+solution.o: solution.f90 \\
+ area.o
+shapes.o: shapes.f90 \\
+ area.o
+  GOLDEN
+
+  goldSplit = makeGolden.split("\n")
+  testSplit = @dep.dependencies('main.F90').split("\n")
+
+  while (gold = goldSplit.shift) && (test = testSplit.shift)
+   assert_equal gold, test
+  end
+ end
+
+ def test_source_file_dependency_hash
+  @dep.source_file_dependencies('main.F90')
+  assert_equal( 5, @dep.file_dependencies.size )
+  expected = {
+     "./area.f90" => [],
+     "./grid.f90" => ["./area.f90"],
+     "../lib/solution.f90" => ["./area.f90"],
+     "./shapes.f90" => ["./area.f90"],
+     "main.F90" => ["./grid.f90", "../lib/solution.f90", "./shapes.f90"]
+   }
+  assert_equal expected, @dep.file_dependencies
+ end
+
+ def test_finds_required_source_files
+  expected = %w[./area.f90 ./shapes.f90 ../lib/solution.f90 ./grid.f90 ./main.F90]
+  found = @dep.required_source_files('./main.F90')
+  assert_equal expected.size, found.size
+  assert_equal './main.F90', found.last
+  assert_equal './area.f90', found.first
+ end
+
+ def test_finds_required_source_files_unordered
+  @dep.dependencies('main.F90')
+  sources = @dep.source_files
+  expected = %w[ main.F90 grid.f90 area.f90 solution.f90 shapes.f90 ]
+  assert_equal expected.size, sources.size
+  assert_equal 'shapes.f90', sources.last
+  assert_equal 'main.F90', sources.first
+  assert_equal expected, sources
+ end
+
+ def test_can_find_required_source_files_twice
+  files = %w[./main.F90 ./shapes.f90 ./area.f90 ../lib/solution.f90 ./grid.f90]
+  @dep.required_source_files('./main.F90')
+  assert_equal files.sort, @dep.required_source_files('./main.F90').sort
+ end
+
+ def test_recognizes_external_modules
+  file = './externalUse.f90'
+  assert_equal [file], @dep.required_source_files(file).sort
+ end
+
+ def teardown
+  Dir.chdir '../..'
+  FileUtils.rm_rf 'DependenciesFixture'
+ end
+
+end

data/tests/tc_funit.rb

@@ -0,0 +1,104 @@
+$:.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
+require 'test/unit'
+require 'funit'
+require 'ftools'
+
+class TestFunit < Test::Unit::TestCase
+
+ include Funit
+ include Funit::Assertions
+
+ def test_main_driver_compiles
+  writeTestRunner []
+  assert File.exists?("TestRunner.f90")
+  assert system("#{Compiler.new.name} TestRunner.f90")
+  assert File.exists?("a.out")
+ end
+
+ def test_is_equal
+  @suiteName = "dummy"
+  @testName = "dummy"
+  @lineNumber = "dummy"
+  isequal("IsEqual(1.0,m(1,1))")
+  assert_equal '.not.(1.0==m(1,1))', @condition
+ end 
+
+ def test_is_real_equal
+  @suiteName = "dummy"
+  @testName = "dummy"
+  @lineNumber = "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('unitMT.ftk','w') do |f|
+   f.printf "beginTest A\n  IsEqual(5, a)\nendTest\n"
+  end  
+  assert_nothing_raised{runAllFtks}
+ 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('unitMT.ftk','w') do |f|
+   f.printf "beginTest A\n  IsEqual(5, a)\nendTest\n"
+  end  
+  assert_nothing_raised{runAllFtks}
+ end
+
+ def test_requested_modules
+  assert_equal ["asdfga"], requestedModules(["asdfga"])
+  assert_equal ["asd","fga"], requestedModules(["asd","fga"])
+   assert requestedModules([]).empty?
+  modules = %w[ldfdl lmzd]
+  ftks = modules.map{|f| f+'MT.ftk'}.join(' ')
+  system "touch "+ftks
+  assert_equal modules, requestedModules([])
+ end
+
+ def test_FTK_exists
+  moduleName = "ydsbe"
+  File.rm_f(moduleName+"MT.ftk")
+  assert_equal false, ftkExists?(moduleName)
+  system "touch "+moduleName+"MT.ftk"
+  assert ftkExists?(moduleName)
+ 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
+
+end