test4requirements 0.1.0.alpha.2 → 0.1.0

data/examples/example_fail_pend_omit.rb

@@ -0,0 +1,58 @@
+=begin rdoc
+Example with pening, omit...
+
+Expected result:
+  Requirements overview:
+  Requirement ok was successfull tested (OK: test_ok(Examples::Test_requirement_small))
+  Requirement pend was unsuccessfull tested (Pending: test_pend(Examples::Test_requirement_small))
+  Requirement fail was unsuccessfull tested (Failure: test_fail(Examples::Test_requirement_small))
+  Requirement omit was unsuccessfull tested (Omission: test_omit(Examples::Test_requirement_small))
+  Requirement no_test was not tested
+  {:ok=>true, :pend=>false, :fail=>false, :omit=>false, :no_test=>nil}
+
+=end
+gem 'test-unit'#, '= 2.1.1'
+
+$:.unshift('../lib')
+require 'test4requirements.rb'
+
+$req = Test4requirements::RequirementList.new('Testrequirements', :ok, :pend, :fail, :omit, :no_test )
+#~ $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
+
+=begin
+Define a user defined action after test execution.
+=end
+$req.do_after_tests{|reqlist|
+  puts reqlist.overview(nil)
+}# if false
+
+#
+module Examples
+=begin rdoc
+Test requirements 
+=end
+  class Test_requirement_small < Test::Unit::TestCase
+    #Following requirements exist, and must be tested sucessfull
+    requirements $req
+    
+    #Test requirement 1.
+    def test_ok()
+      assign_requirement(:ok)  #this test is testing requirement 1
+      assert_equal(2,1+1)
+    end
+    def test_fail()
+      assign_requirement(:fail)  #this test is testing requirement 1
+      assert_equal(3,1+1)
+    end
+    def test_pend()
+      assign_requirement(:pend)  #this test is testing requirement 1
+      pend('X')
+    end  
+    def test_omit()
+      assign_requirement(:omit)  #this test is testing requirement 1
+      omit('X')
+    end
+  end
+end #module Examples
+
+__END__

data/examples/example_small.rb

@@ -0,0 +1,35 @@
+=begin rdoc
+Small example as template for quick test.
+=end
+gem 'test-unit'#, '= 2.1.1'
+
+$:.unshift('../lib')
+require 'test4requirements.rb'
+
+$req = Test4requirements::RequirementList.new('Testrequirements', :req1)
+#~ $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
+
+=begin
+Define a user defined action after test execution.
+=end
+$req.do_after_tests{|reqlist|
+  puts reqlist.overview(nil)
+}
+
+#
+module Examples
+=begin rdoc
+Test requirements 
+=end
+  class Test_requirement_small < Test::Unit::TestCase
+    #Following requirements exist, and must be tested sucessfull
+    requirements $req
+    
+    #Test requirement 1.
+    def test_1()
+      assign_requirement(:req1)  #this test is testing requirement 1
+      assert_equal(2,1+1)
+      assert_equal(2,1+1)
+    end
+  end
+end #module Examples

data/examples/example_test4requirements.rb

@@ -1,62 +1,69 @@
-=begin rdoc
-Some examples, how you can use test4requirements in your test.
-
-Expectes Testresults:
-  req1 successfull
-  req2 tested, but without success
-  req3 no test 
-  req4 successfull
-=end
-gem 'test-unit'#, '= 2.1.1'
-
-$:.unshift('../lib')
-require 'test4requirements.rb'
-
-$req = Test4requirements::RequirementList.new(:req1,:req2,:req3, :req4)
-#~ $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
-#Define a user defined action after test execution.
-$req.do_after_tests{|reqlist|
-  puts reqlist.overview(nil)
-}
-
-=begin rdoc
-Example code
-=end
-module Examples
-=begin rdoc
-Test requirements 1 and 2.
-=end
-  class Test_requirement_1_2 < Test::Unit::TestCase
-    #Following requirements exist, and must be tested sucessfull
-    requirements $req
-    
-    #Test requirement 1.
-    def test_1()
-      assign_requirement(:req1)  #this test is testing requirement 1
-      assert_equal(2,1+1)
-    end
-    #Test requirement 2.
-    def test_2()
-      assign_requirement(:req2)
-      assert_equal(3,1+1)
-    end
-    #Test requirement 3, but without assignment to a requirement
-    def test_3()
-      #no assignment to requirement 3
-      pend 'pend'
-    end
-  end
-
-=begin rdoc
-Test requirement 4.
-=end
-  class Test_requirement_4 < Test::Unit::TestCase
-    #Following requirements exist, and must be tested sucessfull
-    requirements $req
-    #Test requirement 4.
-    def test_4()
-      assign_requirement(:req4)  #this test is testing requirement 4
-      assert_equal(2,1+1)
-    end
-  end
+=begin rdoc
+Some examples, how you can use test4requirements in your test.
+
+The test for the requirements are separated to two classes:
+* Examples::Test_requirement_1_2 and 
+* Examples::Test_requirement_4
+
+
+
+Expectes Testresults:
+  Requirements overview:
+  Requirement req1 was successfull tested (OK: test_1(Examples::Test_requirement_1_2))
+  Requirement req2 was unsuccessfull tested (Failure: test_2(Examples::Test_requirement_1_2))
+  Requirement req3 was not tested
+  Requirement req4 was successfull tested (OK: test_4(Examples::Test_requirement_4))
+  {:req1=>true, :req2=>false, :req3=>nil, :req4=>true}
+
+=end
+gem 'test-unit'#, '= 2.1.1'
+
+$:.unshift('../lib')
+require 'test4requirements.rb'
+
+$req = Test4requirements::RequirementList.new('Testrequirements', :req1,:req2,:req3, :req4)
+#~ $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
+#Define a user defined action after test execution.
+$req.do_after_tests{|reqlist|
+  puts reqlist.overview(nil)
+}
+
+#
+module Examples
+=begin rdoc
+Test requirements 1 and 2.
+=end
+  class Test_requirement_1_2 < Test::Unit::TestCase
+    #Following requirements exist, and must be tested sucessfull
+    requirements $req
+    
+    #Test requirement 1.
+    def test_1()
+      assign_requirement(:req1)  #this test is testing requirement 1
+      assert_equal(2,1+1)
+    end
+    #Test requirement 2.
+    def test_2()
+      assign_requirement(:req2)
+      assert_equal(3,1+1)
+    end
+    #Test requirement 3, but without assignment to a requirement
+    def test_3()
+      #no assignment to requirement 3
+      pend 'pend'
+    end
+  end
+
+=begin rdoc
+Test requirement 4.
+=end
+  class Test_requirement_4 < Test::Unit::TestCase
+    #Following requirements exist, and must be tested sucessfull
+    requirements $req
+    #Test requirement 4.
+    def test_4()
+      assign_requirement(:req4)  #this test is testing requirement 4
+      assert_equal(2,1+1)
+    end
+  end
 end #module Examples

data/examples/example_test4requirements_shoulda.rb

@@ -1,60 +1,64 @@
-=begin rdoc
-Example code
-=end
-
-$:.unshift('../lib')
-gem 'test-unit'#, '= 2.1.1'
-
-require 'test4requirements'
-require 'test4requirements/shoulda'
-#~ require 'shoulda'
-
-$req = Test4requirements::RequirementList.new(:req1,:req2,:req3, :req4, :req5)
-#~ $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
-
-=begin rdoc
-Example code
-=end
-module Examples
-=begin rdoc
-Some examples, how you can use test4requirements with shoulda.
-
-Expected result:
-
-  Requirement req1 was successfull tested (fullfill request 1 (req. of customer X/Examples::Test_with_shoulda))
-  Requirement req2 was unsuccessfull tested (fullfill request 2 (req. of customer X/Examples::Test_with_shoulda))
-  Requirement req3 was successfull tested (request_3 (Examples::_with_shoulda/Examples::Test_with_shoulda))
-  Requirement req4 was successfull tested (request_4 (Examples::_with_shoulda/Examples::Test_with_shoulda))
-  Requirement req5 was not tested
-=end
-  class Test_with_shoulda < Test::Unit::TestCase
-    #Following requirements exist, and must be tested sucessfull
-    requirements $req
-
-    context 'req. of customer X' do
-      #Add requirement as parameter of should
-      should 'fullfill request 1', requirement: :req1  do
-        assert_equal(2,1+1)
-      end
-      #add requirement via requirement command
-      should 'fullfill request 2' do
-        assign_requirement(:req2)  #this test is testing requirement 1
-        assert_equal(3,1+1)
-      end
-    end #context
-
-    #Examples outside a context
-    
-    #Add requirement as parameter of should
-    should 'request_3', requirement: :req3  do
-      assert_equal(2,1+1)
-    end
-    
-    #add requirement via requirement command
-    should 'request_4' do
-      assign_requirement(:req4)  #this test is testing requirement 1
-      assert_equal(2,1+1)
-    end
-
-  end    #MyTest_shoulda
+=begin rdoc
+Example code how to use test4requirements with shoulda.
+
+Defines Examples::Test_with_shoulda 
+
+Expected result:
+
+  Requirements overview:
+  Requirement req1 was successfull tested (OK: fullfill request 1 (req. of customer X/Examples::Test_with_shoulda))
+  Requirement req2 was unsuccessfull tested (Failure: fullfill request 2 (req. of customer X/Examples::Test_with_shoulda))
+  Requirement req3 was successfull tested (OK: request_3 (Examples::_with_shoulda/Examples::Test_with_shoulda))
+  Requirement req4 was successfull tested (OK: request_4 (Examples::_with_shoulda/Examples::Test_with_shoulda))
+  Requirement req5 was not tested
+
+=end
+
+$:.unshift('../lib')
+gem 'test-unit'#, '= 2.1.1'
+
+require 'test4requirements'
+require 'test4requirements/shoulda'
+#~ require 'shoulda'
+
+$req = Test4requirements::RequirementList.new('Testrequirements', :req1,:req2,:req3, :req4, :req5)
+#~ $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
+
+#
+module Examples
+=begin rdoc
+Some examples, how you can use test4requirements with shoulda.
+
+Details see examples/example_test4requirements_shoulda.rb
+=end
+  class Test_with_shoulda < Test::Unit::TestCase
+    #Following requirements exist, and must be tested sucessfull
+    requirements $req
+
+    context 'req. of customer X' do
+      #Add requirement as parameter of should
+      should 'fullfill request 1', requirement: :req1  do
+        assert_equal(2,1+1)
+      end
+      #add requirement via requirement command
+      should 'fullfill request 2' do
+        assign_requirement(:req2)  #this test is testing requirement 1
+        assert_equal(3,1+1)
+      end
+    end #context
+
+    #Examples outside a context
+    
+    #Add requirement as parameter of should
+    should 'request_3', requirement: :req3  do
+      assert_equal(2,1+1)
+    end
+    
+    #add requirement via requirement command
+    should 'request_4' do
+      assign_requirement(:req4)  #this test is testing requirement 1
+      assert_equal(2,1+1)
+    end
+
+  end    #MyTest_shoulda
 end #module Examples

data/examples/test4requirements.rb

@@ -0,0 +1,11 @@
+=begin rdoc
+Example code to show how to use the test4requirements-gem.
+
+The examples:
+* examples/example_small.rb
+* examples/example_test4requirements.rb
+* examples/example_fail_pend_omit.rb
+* examples/example_test4requirements_shoulda.rb
+=end
+module Examples
+end #module Examples

data/lib/test4requirements.rb

@@ -1,98 +1,106 @@
-=begin rdoc
-This gem is based on a 
-{question at stackoverflow}[http://stackoverflow.com/questions/6958586/are-there-any-good-ruby-testing-traceability-solutions]:
-
-:: Are there any gems that'll allow me to implement traceability from my tests back to designs/requirements?
-
-:: i.e.: I want to tag my tests with the name of the requirements they test, and then generate reports of requirements that aren't tested or have failing tests, etc.
-
-:title:test4requirements Unit-Testing with assignment to requirements
-
-=Usage
-  require 'test4requirements.rb'
-
-==Define RequirementList and Requirements
-You must define your requirements and a RequirementList.
-
-You can make it with simple keys and without description:
-  $req = Test4requirements::RequirementList.new(:req1,:req2,:req3, :req4)
-
-You may set an outputter to a logger:
-  $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
-
-
-Or you can define an empty list and assign requirements
-with description etc.
-  $req = Test4requirements::RequirementList.new()
-  $req << Test4requirements::Requirement.new(
-            description: 'What is required',
-            reference: 'Customer Requirement, Version 2011-08-02, page 12'
-        )
-
-==Define your test cases
-
-With Test::Unit::TestCase.requirments you can assign a RequirementList to your tests.
-  class Test_requirement < Test::Unit::TestCase
-    #Following requirements exist, and must be tested sucessfull
-    requirements $req
-    # ...
-  end
-
-A RequirementList can be assigned to multiply TestCase.
-
-==Assign tests to requirements
-Tests can by assigned to a requirement with 
-Test::Unit::TestCase#assign_requirement.
-
-    #Test requirement 1.
-    def test_1()
-      assign_requirement(:req1)  #this test is testing requirement 1
-      assert_equal(2,1+1)
-    end
-
-==Get the result
-
-Unit-Test are executed at_exit. Your results are not available before the tests are ready.
-
-There are three ways to get information.
-
-===Standard reporting
-
-Like the Unit-Test results the requirement-result are written at the end 
-with Test4requirements::RequirementList#overview 
-
-You can influence the output with Test4requirements::RequirementList#report_type= 
-
-===Logger
-There is a logger. You have access to teh logger with Test4requirements::RequirementList#log.
-You can define outputters to the logger, you may log in a file to get more informations.
-You can log to STDOUT, but the logging will be mixed with the test output.
-
-===User defined actions
-Each action must be done at the end of the script.
-You may use Test4requirements::RequirementList#do_after_tests to define an
-action at the end of the script.
-
-=end 
-
-gem 'test-unit'
-=begin
-unittest 2.3.1:
-Test::Unit::Assertions uses Encoding#ascii_compatible?
-Is not defined in ruby 1.9.1 (at least my installation ;) )
-=end
-gem 'test-unit', '<= 2.1.1' if RUBY_VERSION == '1.9.1'
-require 'test/unit'
-
-module Test4requirements
-  VERSION = '0.1.0.alpha.2'
-end
-require 'log4r'
-require_relative 'test4requirements/testcase'
-require_relative 'test4requirements/requirement'
-require_relative 'test4requirements/requirementlist'
-
-#Not loaded by default.
-#require_relative 'test4requirements/shoulda'
-
-
+=begin rdoc
+This gem is based on a 
+{question at stackoverflow}[http://stackoverflow.com/questions/6958586/are-there-any-good-ruby-testing-traceability-solutions]:
+
+:: Are there any gems that'll allow me to implement traceability from my tests back to designs/requirements?
+
+:: i.e.: I want to tag my tests with the name of the requirements they test, and then generate reports of requirements that aren't tested or have failing tests, etc.
+
+:title:test4requirements Unit-Testing with assignment to requirements
+
+=Usage
+  require 'test4requirements.rb'
+
+==Define RequirementList and Requirements
+You must define your requirements and a RequirementList.
+
+You can make it with simple keys and without description:
+  $req = Test4requirements::RequirementList.new(:req1,:req2,:req3, :req4)
+
+You may set an outputter to a logger:
+  $req.log.outputters << Log4r::StdoutOutputter.new('stdout')
+
+
+Or you can define an empty list and assign requirements
+with description etc.
+  $req = Test4requirements::RequirementList.new()
+  $req << Test4requirements::Requirement.new(
+            description: 'What is required',
+            reference: 'Customer Requirement, Version 2011-08-02, page 12'
+        )
+
+==Define your test cases
+
+With Test::Unit::TestCase.requirments you can assign a RequirementList to your tests.
+  class Test_requirement < Test::Unit::TestCase
+    #Following requirements exist, and must be tested sucessfull
+    requirements $req
+    # ...
+  end
+
+A RequirementList can be assigned to multiply TestCase.
+
+==Assign tests to requirements
+Tests can by assigned to a requirement with 
+Test::Unit::TestCase#assign_requirement.
+
+    #Test requirement 1.
+    def test_1()
+      assign_requirement(:req1)  #this test is testing requirement 1
+      assert_equal(2,1+1)
+    end
+
+==Get the result
+
+Unit-Test are executed at_exit. Your results are not available before the tests are ready.
+
+There are three ways to get information.
+
+===Standard reporting
+
+Like the Unit-Test results the requirement-result are written at the end 
+with Test4requirements::RequirementList#overview 
+
+You can influence the output with Test4requirements::RequirementList#report_type= 
+
+===Logger
+There is a logger. You have access to teh logger with Test4requirements::RequirementList#log.
+You can define outputters to the logger, you may log in a file to get more informations.
+You can log to STDOUT, but the logging will be mixed with the test output.
+
+===User defined actions
+Each action must be done at the end of the script.
+You may use Test4requirements::RequirementList#do_after_tests to define an
+action at the end of the script.
+
+
+=Examples
+See examples/test4requirements.rb for some examples.
+
+=Known problems
+==Compatibility
+Ruby 1.9.1 needs test-unit-gem lower equal 2.1.1.
+
+=end 
+
+gem 'test-unit'
+=begin
+unittest 2.3.1:
+Test::Unit::Assertions uses Encoding#ascii_compatible?
+Is not defined in ruby 1.9.1 (at least my installation ;) )
+=end
+gem 'test-unit', '<= 2.1.1' if RUBY_VERSION == '1.9.1'
+require 'test/unit'
+
+module Test4requirements
+  VERSION = '0.1.0'
+end
+require 'log4r'
+require_relative 'test4requirements/testcase'
+require_relative 'test4requirements/requirement'
+require_relative 'test4requirements/requirementlist'
+
+#Not loaded by default.
+#require_relative 'test4requirements/shoulda'
+
+