devcreek 0.1

data/test/testresult_spec.rb

@@ -0,0 +1,74 @@
+# testresult_spec.rb
+#
+# Copyright Caleb Powell 2007
+#
+# Licensed under the LGPL, see the file COPYING in the distribution
+
+$LOAD_PATH.push(FileUtils::pwd + '/lib')
+require 'devcreek'
+
+describe DevCreek::TestResult do
+
+  before :each do
+    @test_result = DevCreek::TestResult.new("some_test", "SomeClass")
+  end
+  
+  it "should be initialized with a start time" do
+    @test_result.start.should_not be_nil
+    @test_result.start.should be_an_instance_of(Time)
+  end  
+
+  it "should be initialized with a test name" do
+    @test_result.test_name.should_not be_nil
+    @test_result.test_name.should eql("some_test")
+  end  
+
+  it "should be initialized with a test class" do
+    @test_result.test_class.should_not be_nil
+    @test_result.test_class.should eql("SomeClass")
+  end  
+
+  it "should not be possible to change the name or start time" do
+    lambda{@test_result.name = "foo"}.should raise_error(NoMethodError)
+    lambda{@test_result.start = Time.now}.should raise_error(NoMethodError)
+    lambda{@test_result.has_finished}.should_not raise_error(NoMethodError)
+  end  
+
+  it "should not be initialized with a finish time" do
+    @test_result.finish.should be_nil
+  end  
+
+  it "should have a finish time when I set it" do
+    @test_result.has_finished
+    @test_result.finish.should_not be_nil
+  end  
+  
+  it "should raise an error if I set the finish time more than once" do
+    lambda{@test_result.has_finished}.should_not raise_error
+    lambda{@test_result.has_finished}.should raise_error(ArgumentError, "The finish time cannot be set twice")
+  end  
+  
+  it "should return nil for the elapsed time if the finish time is nil" do
+    @test_result.elapsed_time.should be_nil
+  end  
+
+  it "should calculate the elapsed time if the finish time is set" do
+    @test_result.has_finished
+    @test_result.elapsed_time.should eql(@test_result.finish - @test_result.start)
+  end  
+
+  it "should have a default status of OK" do
+    @test_result.status.should eql(DevCreek::TestResult::OK)
+  end  
+
+  it "should remember a failure" do
+    @test_result.has_a_failure
+    @test_result.status.should eql(DevCreek::TestResult::FAILURE)
+  end  
+  
+  it "should remember an error" do
+    @test_result.has_an_error
+    @test_result.status.should eql(DevCreek::TestResult::ERROR)
+  end  
+
+end

data/test/testsuite_spec.rb

@@ -0,0 +1,152 @@
+# testsuite_spec.rb
+#
+# Copyright Caleb Powell 2007
+#
+# Licensed under the LGPL, see the file COPYING in the distribution
+
+$LOAD_PATH.push(FileUtils::pwd + '/lib')
+require 'devcreek'
+require 'rexml/document'
+
+describe DevCreek::TestSuite do
+  
+  before :each do
+    @suite = DevCreek::TestSuite.new("TestUnit")
+  end
+  
+  it "should be initialized with framework" do
+    @suite.framework.should eql("TestUnit")
+  end  
+
+  it "should be initialized with an elapsed time of 0.0" do
+    @suite.elapsed_time.should eql(0.0)
+  end  
+  
+  it "should be initialized with a hash called test_results" do
+    @suite.test_results.should be_an_instance_of(Hash)
+  end  
+  
+  it "should be initialized with 0 test runs" do
+    @suite.run_count.should eql(0)
+  end  
+  
+  it "should be initialized with a time stamp" do
+    @suite.start.should_not be_nil
+  end  
+  
+  it "should return a run_count that matches the size of the test_results" do
+    @suite.test_results['a'] = DevCreek::TestResult.new("a", "SomeClass")
+    @suite.test_results['b'] = DevCreek::TestResult.new("b", "SomeClass")
+    @suite.test_results['c'] = DevCreek::TestResult.new("c", "SomeClass")
+    @suite.run_count.should eql(3)
+    @suite.test_results['d'] = DevCreek::TestResult.new("d", "SomeClass")
+    @suite.run_count.should eql(4)
+  end  
+  
+  it "should return a success_count that matches the size of the successful test_results" do
+    @suite.test_results['a'] = DevCreek::TestResult.new("a", "SomeClass")
+    @suite.test_results['b'] = DevCreek::TestResult.new("b", "SomeClass")
+    @suite.test_results['c'] = DevCreek::TestResult.new("c", "SomeClass")
+    @suite.success_count.should eql(3)
+    @suite.failure_count.should eql(0)
+    @suite.error_count.should eql(0)
+  end  
+  
+  it "should return a failure_count that matches the size of the failed test_results" do
+    @suite.test_results['a'] = DevCreek::TestResult.new("a", "SomeClass")
+    @suite.test_results['a'].has_a_failure
+    @suite.test_results['b'] = DevCreek::TestResult.new("b", "SomeClass")
+    @suite.test_results['b'].has_a_failure
+    @suite.test_results['c'] = DevCreek::TestResult.new("c", "SomeClass")
+    @suite.test_results['c'].has_a_failure
+    @suite.failure_count.should eql(3)
+    @suite.success_count.should eql(0)
+    @suite.error_count.should eql(0)
+  end  
+  
+  it "should return a error_count that matches the size of the error test_results" do
+    @suite.test_results['a'] = DevCreek::TestResult.new("a", "SomeClass")
+    @suite.test_results['a'].has_an_error
+    @suite.test_results['b'] = DevCreek::TestResult.new("b", "SomeClass")
+    @suite.test_results['b'].has_an_error
+    @suite.test_results['c'] = DevCreek::TestResult.new("c", "SomeClass")
+    @suite.test_results['c'].has_an_error
+    @suite.error_count.should eql(3)
+    @suite.failure_count.should eql(0)
+    @suite.success_count.should eql(0)
+  end  
+  
+  it "should raise an error if I set the finish time more than once" do
+    lambda{@suite.has_finished}.should_not raise_error
+    lambda{@suite.has_finished}.should raise_error(ArgumentError, "The finish time cannot be set twice")
+  end  
+  
+  it "should return an xml string with the correct core data" do
+    @suite.test_results['a'] = DevCreek::TestResult.new("a", "SomeClass")
+    @suite.test_results['a'].has_finished
+    @suite.has_finished
+    
+    DevCreek::Core.instance().principal = "Skinnard"
+    DevCreek::Core.instance().project= "Foo"
+    
+    doc = REXML::Document.new('<records>' + @suite.to_xml('unique') + '</records>')
+    doc.get_elements('//core.principal').each {|tag| tag.text.should eql("Skinnard") }
+    doc.get_elements('//core.principal').each {|tag| tag.text.should eql("Skinnard") }
+    doc.get_elements('//core.project').each {|tag| tag.text.should eql("Foo") }
+    doc.get_elements('//core.sessionId').each {|tag| tag.text.should eql("unique") }
+    doc.get_elements('//core.timeStamp')[0].text.to_i.should eql(@suite.start.localtime.to_i  * 1000) 
+
+
+    doc.get_elements('//unittest.testCount')[0].text.should eql("1") 
+    doc.get_elements('//unittest.testFramework').size.should_not eql(0)
+    doc.get_elements('//unittest.testFramework').each {|tag| tag.text.should eql(@suite.framework) }
+    doc.get_elements('//unittest.testLanguage').each {|tag| tag.text.should eql("ruby") }
+    doc.get_elements('//unittest.testRunLauncher').each {|tag| tag.text.should eql("manual") }
+    
+    doc.get_elements('//record').size.should eql(4) 
+    doc.get_elements('//unittest.testClass').each {|tag| tag.text.should eql("SomeClass") }
+    doc.get_elements('//core.type')[0].text.should eql("unittest.TestRunStarted") 
+    doc.get_elements('//core.type')[1].text.should eql("unittest.TestStarted") 
+    doc.get_elements('//core.type')[2].text.should eql("unittest.TestEnded") 
+    doc.get_elements('//core.type')[3].text.should eql("unittest.TestRunEnded") 
+  end
+
+  it "should return an xml string with the correct test results" do
+    @suite.test_results['test1(SomeClass)'] = DevCreek::TestResult.new("test1", "SomeClass")
+    @suite.test_results['test1(SomeClass)'].has_finished
+    
+    @suite.test_results['test2(SomeClass)'] = DevCreek::TestResult.new("test2", "SomeClass")
+    @suite.test_results['test2(SomeClass)'].has_a_failure
+    @suite.test_results['test2(SomeClass)'].has_finished
+    
+    @suite.test_results['test1(OtherClass)'] = DevCreek::TestResult.new("test3", "OtherClass")
+    @suite.test_results['test1(OtherClass)'].has_an_error
+    @suite.test_results['test1(OtherClass)'].has_finished
+    @suite.has_finished
+    
+    doc = REXML::Document.new('<records>' + @suite.to_xml('unique') + '</records>')
+    doc.get_elements('//record').size.should eql(8) 
+    doc.get_elements('//unittest.testCount')[0].text.should eql('3') 
+    doc.get_elements('//unittest.errorTotal')[0].text.should eql('1') 
+    doc.get_elements('//unittest.failureTotal')[0].text.should eql('1') 
+    doc.get_elements('//unittest.successTotal')[0].text.should eql('1') 
+    doc.get_elements('//unittest.testClass').size.should eql(6) 
+    doc.get_elements('//unittest.testClass')[0].text.should eql('SomeClass') 
+
+    doc.get_elements('/records/record[unittest.testName=\'test1\']/unittest.testClass').size.should eql(2) 
+    doc.get_elements('/records/record[unittest.testName=\'test1\']/unittest.testClass')[0].text.should eql('SomeClass') 
+    doc.get_elements('/records/record[unittest.testName=\'test1\']/unittest.testClass')[1].text.should eql('SomeClass') 
+    doc.get_elements('/records/record[unittest.testName=\'test1\']/unittest.testStatus')[0].text.should eql('OK') 
+
+    doc.get_elements('/records/record[unittest.testName=\'test2\']/unittest.testClass').size.should eql(2) 
+    doc.get_elements('/records/record[unittest.testName=\'test2\']/unittest.testClass')[0].text.should eql('SomeClass') 
+    doc.get_elements('/records/record[unittest.testName=\'test2\']/unittest.testClass')[1].text.should eql('SomeClass') 
+    doc.get_elements('/records/record[unittest.testName=\'test2\']/unittest.testStatus')[0].text.should eql('FAILURE') 
+
+    doc.get_elements('/records/record[unittest.testName=\'test3\']/unittest.testClass').size.should eql(2) 
+    doc.get_elements('/records/record[unittest.testName=\'test3\']/unittest.testClass')[0].text.should eql('OtherClass') 
+    doc.get_elements('/records/record[unittest.testName=\'test3\']/unittest.testClass')[1].text.should eql('OtherClass') 
+    doc.get_elements('/records/record[unittest.testName=\'test3\']/unittest.testStatus')[0].text.should eql('ERROR') 
+  end
+  
+end

data/test/testtransmitter_spec.rb

@@ -0,0 +1,39 @@
+# testtansmitter_spec.rb
+#
+# Copyright Caleb Powell 2007
+#
+# Licensed under the LGPL, see the file COPYING in the distribution
+
+$LOAD_PATH.push(FileUtils::pwd + '/lib')
+require 'devcreek_transmitter'
+
+describe DevCreek::Transmitter do
+
+  before :each do
+    DevCreek::Core.instance().load(
+      :user => nil,
+      :password => nil,
+      :project => nil
+    )
+  end
+  
+  it "submit method should raise an error if either arguments are invalid" do
+    lambda{DevCreek::Transmitter.submit(nil, nil)}.should raise_error(Exception, "Invalid argument: session_id and xml_data cannot be nil")
+    lambda{DevCreek::Transmitter.submit('a_session_id', nil)}.should raise_error(Exception, "Invalid argument: session_id and xml_data cannot be nil")
+    lambda{DevCreek::Transmitter.submit(nil, '<somexml/>')}.should raise_error(Exception, "Invalid argument: session_id and xml_data cannot be nil")
+  end  
+
+  it "submit method should raise an error if the Core data has not been initialized" do
+    lambda{DevCreek::Transmitter.submit('a_session_id', '<somexml/>')}.should raise_error(Exception, "Core data not initialized")
+    
+    DevCreek::Core.instance().project= 'FooProject'
+    lambda{DevCreek::Transmitter.submit('a_session_id', '<somexml/>')}.should raise_error(Exception, "Core data not initialized")
+
+    DevCreek::Core.instance().user= 'Fred Flintstone'
+    lambda{DevCreek::Transmitter.submit('a_session_id', '<somexml/>')}.should raise_error(Exception, "Core data not initialized")
+
+    DevCreek::Core.instance().password= 'Foobar'
+    lambda{DevCreek::Transmitter.submit('a_session_id', '<somexml/>')}.should_not raise_error(Exception, "Core data not initialized")
+  end  
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: devcreek
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-12-06 00:00:00 -05:00
+summary: The DevCreek gem enables programmers to collect and transmit metrics from their Ruby test framework to a DevCreek server.
+require_paths: 
+- lib
+email: caleb.powell@gmail.com
+homepage: http://rubyforge.org/projects/devcreek/
+rubyforge_project: devcreek
+description: "The DevCreek gem enables programmers to collect and transmit metrics from their Ruby Test::Unit test suites to a DevCreek server. Please visit the DevCreek site (http://devcreek.com/index.html/) for more info.  == FEATURES/PROBLEMS:  Test::Unit is the currently the only supported framework. Rspec support is on it's way ;-)  == SYNOPSIS:  The DevCreek Ruby Gem is library that, when loaded, will automatically listen to and collect metrics from your Test::Unit  unit tests. All you have to do is load the DevCreek library in your code and give it your DevCreek account info so  that it can transmit the metrics to the server. Here is the simplest example of how to load DevCreek:  -------- #Load the devcreek gem require 'rubygems' require 'devcreek'  #set your account info  DevCreek::Core.instance().load_from_yaml(\"#{ENV['HOME']}/.yoursettingsfile.devcreek.yml\")   --------  There are two ways to provide DevCreek with your account settings. The first (as shown above) is to point DevCreek to a  settings file. The 'enabled' attribute tells devcreek whether or not it should actually transmit the metrics that it  collects. The yaml file would like this:  -------- user: your_devcreek_username password: your_devcreek_password project: your_devcreek_project enabled: true --------  The other way to provide DevCreek with your settings is via a hash. So, instead of loading a yaml file, you could do this:  -------- #Load the devcreek gem require 'rubygems' require 'devcreek'  #set your account info  DevCreek::Core.instance().load( :user => 'your_devcreek_username', :password => 'your_devcreek_password', :project => 'your_devcreek_project' :enabled => true )   --------  The first method is preferrable because it allows you to keep your account settings outside of your project (and therefore  your source control tool).  If you only have 1 test file, you can place the code to load devcreek in the test file and your done. However, most projects will have many test files. In this case, you need to make sure that the Ruby interpreter loads devcreek before running the test classes. This can be done via the Ruby '-r' option. For example, assuming your code to load devcreek is in a file called foo.rb, you would run your tests from the command line like this:  ruby -r foo.rb test/test_*  If you run your tests from a Rakefile, then you need to tell rake to include the -r option when it runs the tests (rake runs it's tests in a separate Ruby process). You can do this pretty easily in your Rakefile, like so;  -------- require 'rake/testtask' Rake::TestTask.new('all_tests') do |t| t.ruby_opts = ['-r foo.rb'] t.test_files = ['test/test_*.rb'] end --------   == REQUIREMENTS:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Caleb Powell
+files: 
+- COPYING
+- History.txt
+- Manifest.txt
+- README.txt
+- lib/devcreek.rb
+- lib/devcreek_core.rb
+- lib/devcreek_record_template.rb
+- lib/devcreek_testresult.rb
+- lib/devcreek_testrunnermediator.rb
+- lib/devcreek_testsuite.rb
+- lib/devcreek_transmitter.rb
+- lib/digest_auth.rb
+- test/test_fiction.rb
+- test/testcore_spec.rb
+- test/testresult_spec.rb
+- test/testsuite_spec.rb
+- test/testtransmitter_spec.rb
+test_files: 
+- test/test_fiction.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: