fUnit 0.0.2 → 0.0.3

data/docs/html/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Apr 09 00:44:26 EDT 2006</td>
+      <td>Sat Apr 15 10:41:30 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -71,21 +71,40 @@
     <div id="description">
       <h1>FUnit: a Fortran Unit Testing Framework</h1>
 <p>
-FUnit is a unit testing framework for Fortran modules. Unit tests are
-written in Fortran fragments that use a small set of testing-specific
-extensions. FUnit transforms these fragments into valid Fortran code and
-compiles, links, and runs them against the module under test.
+FUnit is a <a href="http://en.wikipedia.org/wiki/Unit_testing">unit
+testing</a> framework for Fortran modules.
 </p>
-<h2>Prerequisites</h2>
-<ol>
-<li>A Fortran 90/95/2003 compiler (set via F9X environment variable)
+<p>
+Unit tests are written in Fortran fragments that use a small set of
+testing-specific keywords and functions. FUnit transforms these fragments
+into valid Fortran code and compiles, links, and runs them against the
+module under test.
+</p>
+<p>
+FUnit is <a
+href="http://www.oreillynet.com/pub/a/network/2005/08/30/ruby-rails-david-heinemeier-hansson.html">opinionated
+software</a> which values convention over configuration. Specifically,
+fUnit requires a Fortran 95 compiler, it only supports testing routines
+contained in modules, it requires tests to be stored along side the code
+under test, and it requires that you follow a specific naming rule for test
+files.
+</p>
+<ul>
+<li>Documentation: <a href="http://funit.rubyforge.org">funit.rubyforge.org</a>
 
 </li>
-<li><a href="http://www.ruby-lang.org/">The Ruby language</a>
+<li>Project Page: <a
+href="http://rubyforge.org/projects/funit">rubyforge.org/projects/funit</a>
 
 </li>
-<li><a href="http://rubyforge.org/projects/rubygems/">RubyGems package
-manager</a>
+</ul>
+<h2>Requirements</h2>
+<ol>
+<li>A Fortran 90/95/2003 compiler (set via F9X environment variable)
+
+</li>
+<li><a href="http://www.ruby-lang.org/">The Ruby language</a> with the <a
+href="http://rubyforge.org/projects/rubygems/">RubyGems package manager</a>
 
 </li>
 </ol>
@@ -93,18 +112,117 @@ manager</a>
 <pre>
  gem install funit
 </pre>
+<h2>Example</h2>
+<p>
+Suppose you have a module in <tt>gas_physics.f90</tt> that contains a
+routine that returns viscosity as a function of temperature,
+</p>
+<pre>
+ module gas_physics
+ ..
+ contains
+   ..
+   function viscosity(temperature)
+     real :: viscosity, temperature
+     viscosity = 2.0e-3 * temperature**1.5
+   end function
+   ..
+ end module
+</pre>
+<p>
+The tests of this module would be contained in <tt>gas_physicsMT.ftk</tt>,
+and might contain a test like,
+</p>
+<pre>
+ ..
+ beginTest viscosity_varies_as_temperature
+  IsRealEqual( 0.0, viscosity(0.0) )
+  IsEqualWithin( 0.7071, viscosity(50.0), 1e-3 )
+ endTest
+ ..
+</pre>
+<p>
+This brief fragment is all you need, the framework provides the rest of the
+trappings to turn this into valid Fortran code.
+</p>
+<p>
+You would run the tests for the <tt>gas_physics</tt> module with the
+command,
+</p>
+<pre>
+ 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,
+</p>
+<pre>
+ parsing gas_physicsMT.ftk
+ computing dependencies
+ locating associated source files and sorting for compilation
+ g95 -o TestRunner
+   gas_physics.f90 \
+   gas_physicsMT.f90 \
+   TestRunner.f90
+
+ gas_physics test suite:
+ Passed 2 of 2 possible asserts comprising 1 of 1 tests.
+</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>.
+</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
+href="http://funit.rubyforge.org/files/COPYING.html">COPYING</a> for
+details.
+</p>
+<h2>A Brief History</h2>
+<p>
+On October 4, 2001, Mike Hill (then of <a
+href="http://www.objectmentor.com/">Object Mentor</a>, now of <a
+href="http://www.industriallogic.com">Industrial Logic</a>) visited NASA
+Langley Research Center in Hampton, Virginia and gave a test-first design
+talk at Institute for Computer and Applied Sciences and Engineering
+(ICASE). Copies of his slides are available at <a
+href="http://www.icase.edu/series/MPP/">icase.edu/series/MPP</a>.
+</p>
+<p>
+Mike spent the afternoon with Bil Kleb, Bill Wood, Karen Bibb, and Mike
+Park reasoning out how we might create a testing framework for Fortran 90
+to use during <a href="http://fun3d.larc.nasa.gov">FUN3D</a> code
+development. By the end of the afternoon we had a working protoype based on
+the macro expansion techniques employed in Mike Hill&#8217;s <a
+href="http://sourceforge.net/projects/cpptestkit">cpptestkit</a>. We
+quickly found C-preprocessor macros to be to restrictive and rewrote the
+framework in <a href="http:www.ruby-lang.org">Ruby</a>.
+</p>
 <h2>To Do</h2>
 <ul>
-<li>Make tests so that they fail gracefully if Fortran compiler not found.
+<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>
-<li>Work out RubyGEM packaging kinks.
+<li>Use &#8216;test&#8217; keyword instead of &#8216;beginTest&#8217; business.
 
 </li>
-<li>Change from CamelCase to snake_case.
+<li>Don&#8216;t add to test name during translation to avoid 32 character limit
+trouble.
 
 </li>
-<li>Use &#8216;test&#8217; keyword instead of &#8216;beginTest&#8217; business.
+<li>Rename assertions to more consistent with other xUnits.
+
+</li>
+<li>Add assertions to capture stops and warning messages.
 
 </li>
 <li>Clean up documentation.
@@ -114,6 +232,20 @@ manager</a>
 Veenstra&#8217;s <a
 href="http://www.erikveen.dds.nl/rubyscript2exe/">RubyScript2Exe</a>.
 
+</li>
+<li>Use a makefile instead of a single, ordered command line for compilation.
+
+</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>Wed Apr 05 22:06:56 EDT 2006</td>
+      <td>Thu Apr 13 15:31:36 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,12 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Define Fortran assertion macros
+</p>
+
+    </div>
 
 
    </div>

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

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Apr 09 00:52:33 EDT 2006</td>
+      <td>Thu Apr 13 15:32:36 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -70,7 +70,7 @@
 
     <div id="description">
       <p>
-This scripts finds dependencies for f90 code
+Find Fortran dependencies
 </p>
 
     </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>Sun Apr 09 00:59:16 EDT 2006</td>
+      <td>Thu Apr 13 15:33:45 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,12 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Compile and run the requested tests
+</p>
+
+    </div>
 
 
    </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>Wed Apr 05 21:59:01 EDT 2006</td>
+      <td>Thu Apr 13 15:34:19 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,12 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Create test suite wrapper code
+</p>
+
+    </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>Sun Apr 09 01:00:46 EDT 2006</td>
+      <td>Thu Apr 13 15:30:12 EDT 2006</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,12 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+Define a method to find and run all tests
+</p>
+
+    </div>
 
     <div id="requires-list">
       <h3 class="section-bar">Required files</h3>

data/examples/CFD/FluxFunctionsMT.f90

@@ -1,7 +1,7 @@
 ! FluxFunctionsMT.f90 - a Fortran mobility test suite for FluxFunctions.f90
 !
 ! [dynamically generated from FluxFunctionsMT.ftk
-!  by funit Ruby script Sun Apr 09 01:08:26 EDT 2006]
+!  by funit Ruby script Sun Apr 09 01:22:59 EDT 2006]
 
 module FluxFunctionsMT
 
@@ -20,7 +20,7 @@ module FluxFunctionsMT
  integer :: numAssertsTested  = 0
  integer :: numFailures       = 0
 
-! $Id: FluxFunctionsTS.ftk 91 2001-11-13 20:46:28Z cvs4bk $
+! $Id: FluxFunctionsMT.ftk 139 2006-04-09 05:17:47Z kleb $
 
  real :: leftState, rightState, interfaceFlux
 

data/examples/CFD/FluxFunctionsMT.ftk

@@ -1,4 +1,4 @@
-! $Id: FluxFunctionsTS.ftk 91 2001-11-13 20:46:28Z cvs4bk $
+! $Id: FluxFunctionsMT.ftk 139 2006-04-09 05:17:47Z kleb $
 
  real :: leftState, rightState, interfaceFlux
 

data/examples/CFD/GasModelMT.f90

@@ -1,7 +1,7 @@
 ! GasModelMT.f90 - a Fortran mobility test suite for GasModel.f90
 !
 ! [dynamically generated from GasModelMT.ftk
-!  by funit Ruby script Sun Apr 09 01:08:39 EDT 2006]
+!  by funit Ruby script Sun Apr 09 01:10:35 EDT 2006]
 
 module GasModelMT
 

data/examples/CFD/GasModelMT.ftk

@@ -1,4 +1,4 @@
-! $Id: GasModelTS.ftk 91 2001-11-13 20:46:28Z cvs4bk $
+! $Id: GasModelMT.ftk 139 2006-04-09 05:17:47Z kleb $
 
  real            :: Pressure, Density, Energy
 

data/examples/CFD/TestRunner.f90

@@ -1,18 +1,18 @@
 ! TestRunner.f90 - runs Fortran mobility test suites
 !
-! [Dynamically generated by funit Ruby script Sun Apr 09 01:08:39 EDT 2006.]
+! [Dynamically generated by funit Ruby script Sun Apr 09 01:22:59 EDT 2006.]
 
 program TestRunner
 
- use GasModelMT
+ use FluxFunctionsMT
 
  implicit none
 
  integer :: numTests, numAsserts, numAssertsTested, numFailures
 
  print *, ""
- print *, "GasModel test suite:"
- call MTGasModel( numTests, &
+ print *, "FluxFunctions test suite:"
+ call MTFluxFunctions( numTests, &
         numAsserts, numAssertsTested, numFailures )
  print *, "Passed", numAssertsTested, "of", numAsserts, &
           "possible asserts comprising", &

data/examples/StopWatch/StopWatchMT.f90

@@ -1,7 +1,7 @@
 ! StopWatchMT.f90 - a Fortran mobility test suite for StopWatch.f90
 !
 ! [dynamically generated from StopWatchMT.ftk
-!  by funit Ruby script Sun Apr 09 01:07:09 EDT 2006]
+!  by funit Ruby script Thu Apr 13 17:37:19 EDT 2006]
 
 module StopWatchMT
 

data/examples/StopWatch/TestRunner.f90

@@ -1,6 +1,6 @@
 ! TestRunner.f90 - runs Fortran mobility test suites
 !
-! [Dynamically generated by funit Ruby script Sun Apr 09 01:07:09 EDT 2006.]
+! [Dynamically generated by funit Ruby script Thu Apr 13 17:37:19 EDT 2006.]
 
 program TestRunner
 

data/lib/funit/assertions.rb

@@ -1,3 +1,13 @@
+# Define Fortran assertion macros
+#--
+# Copyright 2006 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 COPYING for details.
+#++
 module Funit
   module Assertions
 

data/lib/funit/fortran_deps.rb

@@ -1,4 +1,14 @@
+# Find Fortran dependencies
+#--
 # This scripts finds dependencies for f90 code
+# Copyright 2006 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 COPYING for details.
+#++
 
 raise "Need Ruby version >= 1.8, current using #{VERSION}" unless String.instance_methods.include? "match"
 
@@ -97,7 +107,7 @@ module Funit
       @parsed.clear
       source_file_dependencies( head_f90 )
       sources = Array.new
-      while !@file_dependencies.empty? do
+      while ! @file_dependencies.empty? do
         no_dependents_pair = @file_dependencies.detect{ |h,d| d == [] }
         no_dependents = no_dependents_pair.first
         sources.push no_dependents

data/lib/funit/functions.rb

@@ -1,3 +1,13 @@
+# Compile and run the requested tests
+#--
+# Copyright 2006 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 COPYING for details.
+#++
 module Funit
 
   class Compiler

data/lib/funit/test_suite.rb

@@ -1,3 +1,13 @@
+# Create test suite wrapper code
+#--
+# Copyright 2006 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 COPYING for details.
+#++
 module Funit
 
   include Funit::Assertions

data/lib/funit.rb

@@ -1,3 +1,14 @@
+# Define a method to find and run all tests
+#--
+# Copyright 2006 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 COPYING for details.
+#++
+
 require 'funit/functions'
 require 'funit/fortran_deps'
 require 'funit/assertions'

data/tests/tc_test_suite.rb

@@ -69,6 +69,37 @@ class TestTestSuite < Test::Unit::TestCase
   assert system(@@compileCommand)
  end
 
+ def test_simple_real_equals_assert_works
+  create_FTK_file <<-REQFTK
+ beginTest assert_equals
+  real :: real_var
+  real_var = 1.0
+  IsRealEqual(real_var,1.0)
+ endTest
+  REQFTK
+  Funit::TestSuite.new 'dummyf90test'
+  puts `cat dummyf90testMT.ftk`
+  puts `cat dummyf90testMT.f90`
+  assert system(@@compileCommand)
+ end
+
+ def test_real_equals_assert_works_with_function
+  create_FTK_file <<-REQFTK
+  function balance( left, right)
+   real :: balance
+   real, intent(in) :: left, right
+   balance = 0.5*(left+right)
+  end function balance
+ beginTest assert_equals_for_function
+  IsRealEqual(balance(0.0,0.0),0.0)
+ endTest
+  REQFTK
+  Funit::TestSuite.new 'dummyf90test'
+  puts `cat dummyf90testMT.ftk`
+  puts `cat dummyf90testMT.f90`
+  assert system(@@compileCommand)
+ end
+
  def test_ignore_commented_test
   create_FTK_file "XbeginTest bob\nendTest"
   Funit::TestSuite.new 'dummyf90test'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: fUnit
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2006-04-09 00:00:00 -04:00
+  version: 0.0.3
+date: 2006-04-15 00:00:00 -04:00
 summary: A Fortran Unit Testing Framework
 require_paths: 
   - lib
@@ -22,9 +22,9 @@ has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
     - 
-      - ">"
+      - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: 1.8.1
   version: 
 platform: ruby
 signing_key: 
@@ -36,7 +36,6 @@ files:
   - Rakefile
   - README
   - bin/funit
-  - docs/HISTORY
   - docs/html
   - docs/spiel
   - docs/why
@@ -107,10 +106,8 @@ files:
   - examples/StopWatch/stopwatchmt.mod
   - examples/StopWatch/TestRunner
   - examples/StopWatch/TestRunner.f90
-  - lib/clean
   - lib/funit
   - lib/funit.rb
-  - lib/mklinks
   - lib/funit/assertions.rb
   - lib/funit/fortran_deps.rb
   - lib/funit/functions.rb
@@ -132,5 +129,6 @@ extra_rdoc_files:
 executables: 
   - funit
 extensions: []
-requirements: []
+requirements: 
+  - "Registration appreciated -- see fun3d.larc.nasa.gov"
 dependencies: []

data/docs/HISTORY

@@ -1,20 +0,0 @@
-$Id: HISTORY 112 2006-04-05 11:23:45Z kleb $
-
-A BRIEF HISTORY
-
-On October 4, 2001, Mike Hill of Object Mentor, Inc. visited NASA
-Langley Research Center in Hampton, Virginia and gave a test-first
-design talk at Institute for Computer and Applied Sciences and
-Engineering (ICASE).
-
-Mike spent the afternoon with Bil Kleb, Bill Wood, Karen Bibb,
-and Mike Park reasoning out how we might create a testing framework
-for Fortran 90.  By the end of the afternoon we had a working
-protoype based on the macro expansion techniques employeed in
-Mike's own cpptestkit.
-
-The basic idea is that test routines should easily be written in 
-a psuedo-Fortran style (i.e., very lightweight), processed (via
-the c preproccesor or a script) into valid Fortran90, collected, and
-invoked by a dynamically-created/compiled/ linked/run Fortran90 code
-named testrunner.

data/lib/clean

@@ -1 +0,0 @@
-rm -rf *TS.f90 *.o *.mod TestRunner*

data/lib/mklinks

@@ -1,5 +0,0 @@
-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 .