funit-12 0.12.1

data/lib/funit/testsuite.rb

@@ -0,0 +1,211 @@
+require 'funit'
+
+module Funit
+  
+  include Assertions # FIXME
+
+  ##
+  # Create testsuite wrapper code
+
+  class TestSuite < File
+
+    KEYWORDS = Regexp.union(/(end\s+)?(setup|teardown|test)/i,
+                            Assertions::ASSERTION_PATTERN)
+    COMMENT_LINE = /^\s*!/
+    
+    include Funit #FIXME
+
+    def initialize( suite_name, suite_content, wrap_with_module )
+      @line_number = 'blank'
+      @suite_name = suite_name
+      @suite_content = suite_content
+      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 = [], [], []
+      header
+      @wrap_with_module = wrap_with_module
+      module_wrapper if @wrap_with_module
+      top_wrapper
+      expand
+      close
+    end
+
+    def header
+      puts <<-HEADER
+! #{@suite_name}_fun.f90 - a unit test suite for #{@suite_name}.f90
+!
+! #{File.basename $0} generated this file from #{@suite_name}.fun
+
+      HEADER
+    end
+
+    def module_wrapper
+      puts <<-MODULE_WRAPPER
+module #{@suite_name}_mod
+contains
+  include '#@suite_name.f90'
+end module #{@suite_name}_mod
+
+      MODULE_WRAPPER
+    end
+
+    def top_wrapper
+      puts <<-TOP
+module #{@suite_name}_fun
+
+ use #{ @wrap_with_module ? @suite_name+'_mod' : @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
+      $stderr.print "expanding test suite: #{@suite_name}..."
+      funit_contents = @suite_content.split("\n")
+      @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 /^setup/i
+          add_to_setup funit_contents
+        when /^teardown/i
+          add_to_teardown funit_contents
+        when /^Xtest\s+(\w+)/i
+          ignore_test($1,funit_contents)
+        when /^test\s+(\w+)/i
+          a_test($1,funit_contents)
+        when /^test/i
+          syntax_error "no name given for test", @suite_name
+        when /^end\s+(setup|teardown|test)/i
+          syntax_error "no matching #$1 for an #$&", @suite_name
+        when Assertions::ASSERTION_PATTERN
+          syntax_error "#$1 assertion 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 !~ /end\s+setup/i
+        @setup.push line
+      end
+    end
+
+    def add_to_teardown funit_contents
+      while (line = funit_contents.shift) && line !~ /end\s+teardown/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 !~ /end\s+Test/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 !~ /end\s+test/i
+        case line
+        when COMMENT_LINE
+          puts line
+        when Assertions::ASSERTION_PATTERN
+          @line_number = @funit_total_lines - funit_contents.length
+          num_of_asserts += 1
+          puts send( $1.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 funit_setup"
+      puts @setup
+      puts "  noAssertFailed = .true."
+      puts " end subroutine funit_setup\n\n"
+
+      puts "\n subroutine funit_teardown"
+      puts @teardown
+      puts " end subroutine funit_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 funit_setup"
+        puts "  call #{test_name}"
+        puts "  call funit_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/pitch/slides.tex

@@ -0,0 +1,138 @@
+%  pdflatex slides
+
+\documentclass[landscape]{slides}
+\usepackage{url}
+\pagestyle{empty}
+\hoffset 1in
+\begin{document}
+\begin{slide}
+ \begin{center}
+  {\bf\Large F90 Testkit}\\
+  \vspace{0.5in}
+  \begin{minipage}{6.5in}
+    {\bf Goal:} to make Fortran~90 unit/\-mobility/\-developer testing
+    as painless as possible.
+  \end{minipage}
+ \end{center}
+\end{slide}
+\begin{slide}
+  \begin{center}
+    {\bf\Large Why write tests?}\\
+    \vspace{0.5in}
+    \begin{minipage}[t]{3in}
+     \begin{itemize}
+      \item Shame
+      \item Embarrassment
+      \item Speed
+      \item Confidence
+     \end{itemize}
+    \end{minipage}
+    \begin{minipage}[t]{3in}
+     \begin{itemize}
+      \item Trust
+      \item Change
+      \item Documentation
+     \end{itemize}
+    \end{minipage}
+  \end{center}
+\end{slide}
+\begin{slide}
+  \begin{center}
+    {\bf\Large Why write tests first?}\\
+    \vspace{0.5in}
+    \begin{minipage}{3in}
+    \begin{itemize}
+     \item Tests get written
+     \item Succinctness
+     \item Clarity
+     \item Closure
+    \end{itemize}
+    \end{minipage}\\
+    \vspace{1in}
+    \begin{minipage}{5.7in}\raggedright
+      ``No code should be written or changed unless there is a failing
+      test.''
+    \end{minipage}
+  \end{center}
+\end{slide}
+\begin{slide}
+  \begin{center}
+   {\bf\Large How do I add tests to legacy code?}\\
+   \vspace{0.5in}
+   \begin{minipage}{6in}
+    \begin{itemize}
+     \item Fixing Bugs
+      \begin{itemize}
+       \item write test for bug {\small (which fails)}
+       \item write code to satisfy failing test
+       \item write tests/code for similar cases
+      \end{itemize}
+      \vspace{8pt}
+     \item Adding Features
+      \begin{itemize}
+       \item write test for feature {\small (which better fail)}
+       \item write code to satisfy failing test
+      \end{itemize}
+      \vspace{8pt}
+     \item Refactoring ``Bad Smells''
+      \begin{itemize}
+       \item write tests to cover existing code
+       \item update/add tests for new structure
+       \item change code to satisfy failing tests
+      \end{itemize}
+    \end{itemize}
+   \end{minipage}
+  \end{center}
+\end{slide}
+\begin{slide}
+  \begin{center}
+    {\bf\Large Crazy enough to learn more?}\\
+    \vspace{0.5in}
+    \begin{minipage}{6in}
+     \begin{itemize}
+      \item \url{http://c2.com/cgi/wiki?UnitTests}\\[-10pt]
+      \item \url{http://xprogramming.com/software.htm}
+     \end{itemize}
+    \end{minipage}
+  \end{center}
+\end{slide}
+\begin{slide}
+  \begin{center}
+    {\bf\Large Want to try F90 testkit?}\\
+    \vspace{0.5in}
+    \begin{minipage}{9in}
+     \begin{itemize}
+      \item Have your SA install Ruby {\small(or install it yourself)}\\[5pt]
+       \hspace*{1em}\url{http://www.ruby-lang.org/}\\[5pt]
+      \item Check out the FTK repository\\[5pt]
+       \hspace*{1em}\verb+cvs -d :pserver:[username]@abnode3:/usr/local/cvsroot \+\\
+       \hspace*{1em}\verb+checkout -P FTK+\\[5pt]
+       where \verb+[username]+ is your CVS username on \verb+abnode3+
+     \end{itemize}
+    \end{minipage}
+  \end{center}
+\end{slide}
+\begin{slide}
+  \begin{center}
+    {\bf\Large Who does what?}\\
+    \vspace{0.5in}
+    {\bf You:}
+    \begin{minipage}[t]{6.5in}\raggedright
+     \begin{enumerate}
+      \item Create testsuite file, e.g., \verb+RoutineTS.ftk+
+      \item Write test in Fortran with embedded assert macros, .e.g,
+        \verb+IsTrue(x>2)+
+      \item Run testsuite {\small (it should fail)}
+      \item Write \verb+Routine.f90+ to satisfy test
+     \end{enumerate}
+     \vspace{10pt}
+     Repeat steps 2, 3, and 4 until your objective is met.
+    \end{minipage}\\
+    \vspace{0.8in}
+   {\bf It:}
+   \begin{minipage}[t]{6in}\raggedright
+   Translates, compiles, links, and runs tests.
+   \end{minipage}
+  \end{center}
+\end{slide}
+\end{document}

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.delete 'FC'
+      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,125 @@
+require 'test/unit'
+require 'funit'
+require 'ftools' # FIXME: migrate to fileutils
+
+class TestFunit < Test::Unit::TestCase
+
+  alias_method :tu_assert_equal, :assert_equal # avoid collision with test/unit
+
+  include Funit # FIXME
+  include Funit::Assertions # FIXME
+
+  def setup
+    File.rm_f(*Dir["dummyunit*"])
+    File.rm_f(*Dir["unit*"])
+    File.rm_f(*Dir["another*"])
+    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*"])
+  end
+
+  def teardown
+    File.rm_f(*Dir["dummyunit*"])
+    File.rm_f(*Dir["unit*"])
+    File.rm_f(*Dir["another*"])
+    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*"])
+  end
+
+  def test_empty_test_runner_created_and_compilable
+    write_test_runner []
+    assert File.exists?("TestRunner.f90"), 'TestRunner.f90 not created.'
+    compile_tests []
+    assert File.exists?("makeTestRunner"), 'makeTestRunner.f90 not created.'
+    assert system("make -f makeTestRunner"), 'make -f makeTestRunner failed.'
+    assert File.exists?("TestRunner"), 'TestRunner executable not created.'
+  end
+
+  def test_is_equal
+    @suite_name = "dummy"
+    @test_name = "dummy"
+    @line_number = "dummy"
+    assert_equal("AssertEqual(1.0,m(1,1))")
+    tu_assert_equal '.not.(1.0==m(1,1))', @condition
+  end
+
+  def test_is_real_equal
+    @suite_name = "dummy"
+    @test_name = "dummy"
+    @line_number = "dummy"
+    assert_real_equal("AssertRealEqual(a,b)")
+    ans = <<-EOF
+.not.( (a &\n        +2*spacing(real(a)) ) &\n        .ge. &\n        (b) &\n            .and. &\n     (a &\n      -2*spacing(real(a)) ) &\n      .le. &\n       (b) )
+    EOF
+    tu_assert_equal ans.chomp, @condition
+    tu_assert_equal %|"b (", &\n b, &\n  ") is not", &\n a,&\n "within", &\n  2*spacing(real(a))|, @message
+    assert_real_equal("AssertRealEqual(1.0,m(1,1))")
+    ans = <<-EOF
+.not.( (1.0 &\n        +2*spacing(real(1.0)) ) &\n        .ge. &\n        (m(1,1)) &\n            .and. &\n     (1.0 &\n      -2*spacing(real(1.0)) ) &\n      .le. &\n       (m(1,1)) )
+    EOF
+    tu_assert_equal ans.chomp, @condition
+  end
+
+  def test_should_accommodate_use_dependency_at_least_one_level_deep
+    File.open('unit.f90','w') do |f|
+      f.puts "module unit\n use another, only : a\nend module unit"
+    end
+    File.open('another.f90','w') do |f|
+      f.puts "module another\n integer :: a = 5\nend module another"
+    end
+    File.open('unit.fun','w') do |f|
+      f.puts "test_suite unit\ntest a_gets_set\nAssert_Equal(5,a)\nend test\nend test_suite"
+    end
+    assert_nothing_raised{run_tests}
+  end
+
+  def test_should_accommodate_doubly_embedded_use_dependencies
+    File.open('unit.f90','w') do |f|
+      f.puts "module unit\n use unita, only : a\nend module unit"
+    end
+    File.open('unita.f90','w') do |f|
+      f.puts "module unita\n use unitb, only : b\n integer :: a = b\nend module unita"
+    end
+    File.open('unitb.f90','w') do |f|
+      f.puts "module unitb\n integer, parameter :: b = 5\nend module unitb"
+    end
+    File.open('unit.fun','w') do |f|
+      f.puts "begin test_suite unit\ntest a_gets_set\n Assert_Equal(5, a)\nend test\nend test_suite"
+    end
+    assert_nothing_raised{run_tests}
+ end
+
+  def test_should_accommodate_cap_F_extensions
+    File.open('unit.F90','w') do |f|
+      f.puts "module unit\n integer :: a = 1\nend module unit"
+    end
+    File.open('unit.fun','w') do |f|
+      f.puts "begin test_suite unit\ntest a_gets_set\n Assert_Equal(1, a)\nend test\nend test_suite"
+    end
+    assert_nothing_raised{run_tests}
+ end
+
+  def test_requested_modules
+    tu_assert_equal ["asdfga"], requested_modules(["asdfga"])
+    tu_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
+    tu_assert_equal modules, requested_modules([])
+  end
+
+  def test_funit_exists_method
+    module_name = "ydsbe"
+    File.rm_f(module_name+".fun")
+    tu_assert_equal false, funit_exists?(module_name)
+    system "touch "+module_name+".fun"
+    assert funit_exists?(module_name)
+  end
+
+end