fUnit 0.0.3 → 0.1.0

data/docs/html/created.rid

@@ -1 +1 @@
-Sat Apr 15 10:41:36 EDT 2006
+Sat Apr 15 17:13:05 EDT 2006

data/docs/html/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sat Apr 15 10:41:30 EDT 2006</td>
+      <td>Sat Apr 15 17:12:55 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -100,7 +100,7 @@ href="http://rubyforge.org/projects/funit">rubyforge.org/projects/funit</a>
 </ul>
 <h2>Requirements</h2>
 <ol>
-<li>A Fortran 90/95/2003 compiler (set via F9X environment variable)
+<li>A Fortran 90/95/2003 compiler (set via FC environment variable)
 
 </li>
 <li><a href="http://www.ruby-lang.org/">The Ruby language</a> with the <a
@@ -130,7 +130,7 @@ routine that returns viscosity as a function of temperature,
  end module
 </pre>
 <p>
-The tests of this module would be contained in <tt>gas_physicsMT.ftk</tt>,
+The tests of this module would be contained in <tt>gas_physics.fun</tt>,
 and might contain a test like,
 </p>
 <pre>
@@ -153,18 +153,17 @@ command,
  funit gas_physics
 </pre>
 <p>
-which would transform your fragments contained in
-<tt>gas_physicsMT.ftk</tt> into valid Fortran code, create a test runner
-program, compile everything, and run the tests. A sample output would look
-like,
+which would transform your fragments contained in <tt>gas_physics.fun</tt>
+into valid Fortran code, create a test runner program, compile everything,
+and run the tests. A sample output would look like,
 </p>
 <pre>
- parsing gas_physicsMT.ftk
+ parsing gas_physics.fun
  computing dependencies
  locating associated source files and sorting for compilation
  g95 -o TestRunner
    gas_physics.f90 \
-   gas_physicsMT.f90 \
+   gas_physics_fun.f90 \
    TestRunner.f90
 
  gas_physics test suite:
@@ -172,15 +171,18 @@ like,
 </pre>
 <h2>Support</h2>
 <p>
-Send email to funit-support@rubyforge.org or submit a request through <a
-href="http://rubyforge.org/tracker/?group_id=1416">rubyforge.org/tracker/?group_id=1416</a>.
+Send email to <a
+href="mailto:funit-support@rubyforge.org">funit-support@rubyforge.org</a>
+or submit a request through <a
+href="http://rubyforge.org/tracker/?group_id=1416">the tracking system</a>.
 </p>
 <h2>License</h2>
 <p>
 FUnit is released under the NASA Open Source Agreement, which requests
-registration. If you would like to register, send an email to
-funit-support@rubyforge.org with your name, institution (if applicable),
-city, postal code, and country. See <a
+registration. If you would like to register, send an email to <a
+href="mailto:funit-registration@rubyforge.org?subject=fUnit%20Registration">funit-registration@rubyforge.org</a>
+with your name, institution (if applicable), city, postal code, and
+country. See <a
 href="http://funit.rubyforge.org/files/COPYING.html">COPYING</a> for
 details.
 </p>
@@ -209,14 +211,17 @@ framework in <a href="http:www.ruby-lang.org">Ruby</a>.
 <li>Make tests fail gracefully if Fortran compiler is not found.
 
 </li>
-<li>Complete migration rom CamelCase to snake_case for methods and variables.
+<li>Complete migration from CamelCase to snake_case for methods and variables.
+
+</li>
+<li>Use 2-space indentation everywhere.
 
 </li>
 <li>Use &#8216;test&#8217; keyword instead of &#8216;beginTest&#8217; business.
 
 </li>
-<li>Don&#8216;t add to test name during translation to avoid 32 character limit
-trouble.
+<li>Don&#8216;t add to test name during translation to avoid Fortran&#8217;s
+32-character limit on names.
 
 </li>
 <li>Rename assertions to more consistent with other xUnits.
@@ -238,14 +243,6 @@ href="http://www.erikveen.dds.nl/rubyscript2exe/">RubyScript2Exe</a>.
 </li>
 <li>Add a clean option to remove all generated artifacts.
 
-</li>
-<li>Migrate to a new naming convention? E.g., gas_physics.fun -&gt;
-gas_physics_fun.f90
-
-</li>
-<li>Change Fortran envinoment variable from <tt>F9X</tt> to GNU-standard
-<tt>FC</tt>.
-
 </li>
 </ul>
 

data/docs/html/files/lib/funit/assertions_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Apr 13 15:31:36 EDT 2006</td>
+      <td>Sat Apr 15 11:39:27 EDT 2006</td>
     </tr>
     </table>
   </div>

data/docs/html/files/lib/funit/functions_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Apr 13 15:33:45 EDT 2006</td>
+      <td>Sat Apr 15 16:13:09 EDT 2006</td>
     </tr>
     </table>
   </div>

data/docs/html/files/lib/funit/test_suite_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Apr 13 15:34:19 EDT 2006</td>
+      <td>Sat Apr 15 16:53:46 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -75,6 +75,15 @@ Create test suite wrapper code
 
     </div>
 
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+
+      <div class="name-list">
+      funit/assertions&nbsp;&nbsp;
+      funit/functions&nbsp;&nbsp;
+      ftools&nbsp;&nbsp;
+      </div>
+    </div>
 
    </div>
 

data/docs/html/files/lib/funit_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Apr 13 15:30:12 EDT 2006</td>
+      <td>Sat Apr 15 16:31:38 EDT 2006</td>
     </tr>
     </table>
   </div>

data/docs/html/fr_method_index.html

@@ -30,7 +30,7 @@
     <a href="classes/Funit/Depend.html#M000022">dependencies (Funit::Depend)</a><br />
     <a href="classes/Funit/TestSuite.html#M000028">expand (Funit::TestSuite)</a><br />
     <a href="classes/Funit/Depend.html#M000019">fortran_files_within (Funit::Depend)</a><br />
-    <a href="classes/Funit.html#M000003">ftkExists? (Funit)</a><br />
+    <a href="classes/Funit.html#M000003">funit_exists? (Funit)</a><br />
     <a href="classes/Funit/TestSuite.html#M000031">ignoreTest (Funit::TestSuite)</a><br />
     <a href="classes/Funit/Assertions.html#M000013">isequal (Funit::Assertions)</a><br />
     <a href="classes/Funit/Assertions.html#M000012">isequalwithin (Funit::Assertions)</a><br />
@@ -46,7 +46,7 @@
     <a href="classes/Funit.html#M000004">parseCommandLine (Funit)</a><br />
     <a href="classes/Funit.html#M000002">requestedModules (Funit)</a><br />
     <a href="classes/Funit/Depend.html#M000024">required_source_files (Funit::Depend)</a><br />
-    <a href="classes/Funit.html#M000001">runAllFtks (Funit)</a><br />
+    <a href="classes/Funit.html#M000001">run_tests (Funit)</a><br />
     <a href="classes/Funit/Depend.html#M000023">source_file_dependencies (Funit::Depend)</a><br />
     <a href="classes/Funit.html#M000006">syntaxError (Funit)</a><br />
     <a href="classes/Funit/TestSuite.html#M000027">topWrapper (Funit::TestSuite)</a><br />

data/examples/CFD/{FluxFunctionsMT.ftk → FluxFunctions.fun}

@@ -1,4 +1,4 @@
-! $Id: FluxFunctionsMT.ftk 139 2006-04-09 05:17:47Z kleb $
+! $Id: FluxFunctions.fun 150 2006-04-15 21:07:25Z kleb $
 
  real :: leftState, rightState, interfaceFlux
 

data/examples/CFD/{GasModelMT.ftk → GasModel.fun}

@@ -1,4 +1,4 @@
-! $Id: GasModelMT.ftk 139 2006-04-09 05:17:47Z kleb $
+! $Id: GasModel.fun 150 2006-04-15 21:07:25Z kleb $
 
  real            :: Pressure, Density, Energy
 

data/lib/funit.rb

@@ -15,14 +15,12 @@ require 'funit/assertions'
 require 'funit/test_suite'
 
 module Funit
-  def runAllFtks
-    Compiler.new # a test for compiler env set (remove this later)
+  def run_tests
+    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
+    # convert each *.fun file into a Fortran file:
+    testSuites.each{ |ts| TestSuite.new(ts) }
  
     compileTests testSuites
 

data/lib/funit/assertions.rb

@@ -66,7 +66,7 @@ module Funit
   if (noAssertFailed) then
     if (#@condition) then
       print *, " *#@type failed* in test #@testName &
-                         &[#{@suiteName}MT.ftk:#{@lineNumber.to_s}]"
+                         &[#{@suiteName}.fun:#{@lineNumber.to_s}]"
       print *, "  ", #@message
       print *, ""
       noAssertFailed = .false.

data/lib/funit/functions.rb

@@ -14,14 +14,14 @@ module Funit
 
     attr_reader :name
 
-    def initialize( name=ENV['F9X'] )
+    def initialize( name=ENV['FC'] )
       errorMessage = <<-ENVIRON
 
-Fortran compiler environment variable 'F9X' not set:
+Fortran compiler environment variable 'FC' 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)
+ for bourne-based shells: export FC=lf95 (in .profile)
+      for c-based shells: setenv FC lf95 (in .login)
+             for windows: set FC=C:\\Program Files\\lf95 (in autoexec.bat)
 
       ENVIRON
       raise(errorMessage) unless @name = name
@@ -31,13 +31,13 @@ Fortran compiler environment variable 'F9X' not set:
 
   def requestedModules(moduleNames)
     if (moduleNames.empty?)
-      moduleNames = Dir["*MT.ftk"].each{ |mod| mod.chomp! "MT.ftk" }
+      moduleNames = Dir["*.fun"].each{ |mod| mod.chomp! ".fun" }
     end
     moduleNames
   end
 
-  def ftkExists?(moduleName)
-    File.exists? moduleName+"MT.ftk"
+  def funit_exists?(moduleName)
+    File.exists? moduleName+".fun"
   end
 
   def parseCommandLine
@@ -49,14 +49,14 @@ Fortran compiler environment variable 'F9X' not set:
     end
 
     moduleNames.each do |mod|
-      unless ftkExists?(mod) 
-        errorMessage = <<-FTKDOESNOTEXIST
- Error: could not find test suite #{mod}MT.ftk
+      unless funit_exists?(mod) 
+        errorMessage = <<-FUNITDOESNOTEXIST
+ Error: could not find test suite #{mod}.fun
  Test suites available in this directory:
  #{requestedModules([]).join(' ')}
 
- Usage: #{File.basename $0} [test names (w/o MT.ftk suffix)]
-        FTKDOESNOTEXIST
+ Usage: #{File.basename $0} [test names (w/o .fun suffix)]
+        FUNITDOESNOTEXIST
         raise errorMessage
       end
     end
@@ -69,15 +69,15 @@ Fortran compiler environment variable 'F9X' not set:
     testRunner = File.new "TestRunner.f90", "w"
 
     testRunner.puts <<-HEADER
-! TestRunner.f90 - runs Fortran mobility test suites
+! TestRunner.f90 - runs test suites
 !
-! [Dynamically generated by #{File.basename $0} Ruby script #{Time.now}.]
+! #{File.basename $0} generated this file on #{Time.now}.
 
 program TestRunner
 
     HEADER
 
-    testSuites.each { |testSuite| testRunner.puts " use #{testSuite}MT" }
+    testSuites.each { |testSuite| testRunner.puts " use #{testSuite}_fun" }
 
     testRunner.puts <<-DECLARE
 
@@ -91,7 +91,7 @@ program TestRunner
 
  print *, ""
  print *, "#{testSuite} test suite:"
- call MT#{testSuite}( numTests, &
+ call test_#{testSuite}( numTests, &
         numAsserts, numAssertsTested, numFailures )
  print *, "Passed", numAssertsTested, "of", numAsserts, &
           "possible asserts comprising", &
@@ -106,11 +106,11 @@ program TestRunner
   end
 
   def syntaxError( message, testSuite )
-    raise "\n   *Error: #{message} [#{testSuite}MT.ftk:#$.]\n\n"
+    raise "\n   *Error: #{message} [#{testSuite}.fun:#$.]\n\n"
   end
 
   def warning( message, testSuite )
-    $stderr.puts "\n *Warning: #{message} [#{testSuite}MT.ftk:#$.]"
+    $stderr.puts "\n *Warning: #{message} [#{testSuite}.fun:#$.]"
   end
 
   def compileTests testSuites
@@ -119,7 +119,7 @@ program TestRunner
     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  ")}"
+    puts compile = "#{ENV['FC']} #{ENV['FCFLAGS']} -o TestRunner \\\n  #{requiredSources.join(" \\\n  ")}"
 
     raise "Compile failed." unless system(compile)
   end

data/lib/funit/test_suite.rb

@@ -8,6 +8,11 @@
 # This file is governed by the NASA Open Source Agreement.
 # See COPYING for details.
 #++
+
+require 'funit/assertions'
+require 'funit/functions'
+require 'ftools'
+
 module Funit
 
   include Funit::Assertions
@@ -19,9 +24,9 @@ module 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")
+      return nil unless funit_exists?(suiteName)
+      File.delete(suiteName+".fun") if File.exists?(suiteName+"_fun.f90")
+      super(suiteName+"_fun.f90","w")
       @tests, @setup, @teardown = Array.new, Array.new, Array.new
       topWrapper
       expand
@@ -30,22 +35,22 @@ module Funit
 
     def topWrapper
       puts <<-TOP
-! #{@suiteName}MT.f90 - a Fortran mobility test suite for #{@suiteName}.f90
+! #{@suiteName}_fun.f90 - a unit test suite for #{@suiteName}.f90
 !
-! [dynamically generated from #{@suiteName}MT.ftk
-!  by #{File.basename $0} Ruby script #{Time.now}]
+! #{File.basename $0} generated this file from #{@suiteName}.fun
+! at #{Time.now}
 
-module #{@suiteName}MT
+module #{@suiteName}_fun
 
  use #{@suiteName}
 
  implicit none
 
- private
+ logical :: noAssertFailed
 
- public :: MT#{@suiteName}
+ public :: test_#@suiteName
 
- logical :: noAssertFailed
+ private
 
  integer :: numTests          = 0
  integer :: numAsserts        = 0
@@ -57,32 +62,32 @@ module #{@suiteName}MT
 
     def expand
  
-      ftkFile = @suiteName+"MT.ftk"
-      $stderr.puts "parsing #{ftkFile}"
+      funit_file = @suiteName+".fun"
+      $stderr.print "expanding #{funit_file}..."
    
-      ftk = IO.readlines(ftkFile)
-      @ftkTotalLines = ftk.length
+      funit_contents = IO.readlines(funit_file)
+      @funit_TotalLines = funit_contents.length
 
-      while (line = ftk.shift) && line !~ $keyword
+      while (line = funit_contents.shift) && line !~ $keyword
         puts line
       end
 
-      ftk.unshift line
+      funit_contents.unshift line
 
       puts " contains\n\n"
 
-      while (line = ftk.shift)
+      while (line = funit_contents.shift)
         case line
         when $commentLine
           puts line
         when /beginSetup/i
-          addtoSetup ftk
+          addtoSetup funit_contents
         when /beginTeardown/i
-          addtoTeardown ftk
+          addtoTeardown funit_contents
         when /XbeginTest\s+(\w+)/i
-          ignoreTest($1,ftk)
+          ignoreTest($1,funit_contents)
         when /beginTest\s+(\w+)/i
-          aTest($1,ftk)
+          aTest($1,funit_contents)
         when /beginTest/i
           syntaxError "no name given for beginTest", @suiteName
         when /end(Setup|Teardown|Test)/i
@@ -94,42 +99,42 @@ module #{@suiteName}MT
         end
       end # while
 
-      $stderr.puts "completed #{ftkFile}"
+      $stderr.puts "done."
 
     end
 
-    def addtoSetup ftk
-      while (line = ftk.shift) && line !~ /endSetup/i
+    def addtoSetup funit_contents
+      while (line = funit_contents.shift) && line !~ /endSetup/i
         @setup.push line
       end
     end
 
-    def addtoTeardown ftk
-      while (line = ftk.shift) && line !~ /endTeardown/i
+    def addtoTeardown funit_contents
+      while (line = funit_contents.shift) && line !~ /endTeardown/i
         @teardown.push line
       end
     end
 
-    def ignoreTest testName, ftk
+    def ignoreTest testName, funit_contents
       warning("Ignoring test: #{testName}", @suiteName)
-      line = ftk.shift while line !~ /endTest/i
+      line = funit_contents.shift while line !~ /endTest/i
     end
 
-    def aTest testName, ftk
+    def aTest testName, funit_contents
       @testName = testName
       @tests.push testName
       syntaxError("test name #@testName not unique",@suiteName) if (@tests.uniq!)
 
-      puts " subroutine Test#{testName}\n\n"
+      puts " subroutine #{testName}\n\n"
 
       numOfAsserts = 0
   
-      while (line = ftk.shift) && line !~ /endTest/i
+      while (line = funit_contents.shift) && line !~ /endTest/i
         case line
         when $commentLine
           puts line
         when /Is(RealEqual|False|True|EqualWithin|Equal)/i
-          @lineNumber = @ftkTotalLines - ftk.length
+          @lineNumber = @funit_TotalLines - funit_contents.length
           numOfAsserts += 1
           puts send( $&.downcase!, line )
         else
@@ -139,7 +144,7 @@ module #{@suiteName}MT
       warning("no asserts in test", @suiteName) if numOfAsserts == 0
 
       puts "\n  numTests = numTests + 1\n\n"
-      puts " end subroutine Test#{testName}\n\n"
+      puts " end subroutine #{testName}\n\n"
     end
 
     def close
@@ -154,7 +159,7 @@ module #{@suiteName}MT
 
       puts <<-NEXTONE
 
- subroutine MT#{@suiteName}( nTests, nAsserts, nAssertsTested, nFailures )
+ subroutine test_#{@suiteName}( nTests, nAsserts, nAssertsTested, nFailures )
 
   integer :: nTests
   integer :: nAsserts
@@ -166,7 +171,7 @@ module #{@suiteName}MT
 
       @tests.each do |testName|
         puts "\n  call Setup"
-        puts "  call Test#{testName}"
+        puts "  call #{testName}"
         puts "  call Teardown"
       end
 
@@ -177,12 +182,12 @@ module #{@suiteName}MT
   nAssertsTested  = numAssertsTested
   nFailures       = numFailures
 
- end subroutine MT#{@suiteName}
+ end subroutine test_#{@suiteName}
 
-end module #{@suiteName}MT
+end module #{@suiteName}_fun
       LASTONE
       super
-      File.chmod(0444,@suiteName+"MT.f90")
+      File.chmod(0444,@suiteName+"_fun.f90")
     end
 
   end # class TestSuite