Class: Test::Unit::TestCase

Sets the current test order.

Here are the available order:

:alphabetic

Default. Tests are sorted in alphabetic order.

:random

Tests are sorted in random order.

:defined

Tests are sorted in defined order.

Called after every test case runs. Can be used to tear down fixture information used in test case scope.

Here is an example test case:

class TestMyClass < Test::Unit::TestCase
  class << self
    def shutdown
      #...
    end
  end

  def teardown
    #...
  end

  def test_my_class1
    #...
  end

  def test_my_class2
    #...
  end
end

Here is a call order:

• test_my_class1 (or test_my_class2)

• teardown

• test_my_class2 (or test_my_class1)

• teardown

• shutdown

Note that you should not assume test order. Tests should be worked in any order.

Called before every test case runs. Can be used to set up fixture information used in test case scope.

Here is an example test case:

class TestMyClass < Test::Unit::TestCase
  class << self
    def startup
      #...
    end
  end

  def setup
    #...
  end

  def test_my_class1
    #...
  end

  def test_my_class2
    #...
  end
end

Here is a call order:

• startup

• setup

• test_my_class1 (or test_my_class2)

• setup

• test_my_class2 (or test_my_class1)

Note that you should not assume test order. Tests should be worked in any order.

Defines a sub test case.

This is a syntax sugar. The both of the following codes are the same in meaning:

Standard:

class TestParent < Test::UnitTestCase
  class TestChild < self
    def test_in_child
    end
  end
end

Syntax sugar:

class TestParent < Test::UnitTestCase
  sub_test_case("TestChild") do
    def test_in_child
    end
  end
end

The difference of them are the following:

• ::Test case created by sub_test_case is an anonymous class. So you can't refer the test case by name.

• The class name of class style must follow constant naming rule in Ruby. But the name of test case created by sub_test_case doesn't need to follow the rule. For example, you can use a space in name such as “child test”.

Rolls up all of the test* methods in the fixture into one suite, creating a new instance of the fixture for each method.

Defines a test in declarative syntax or marks following method as a test method.

In declarative syntax usage, the following two test definitions are the almost same:

description "register user"
def test_register_user
  #...
end

test "register user" do
  #...
end

In test method mark usage, the “my_test_method” is treated as a test method:

test
def my_test_method
  assert_equal("call me", ...)
end

Checks whether a test that is matched the query is defined.

Returns whether this individual test passed or not. Primarily for use in teardown so that artifacts can be left behind if the test fails.

This method returns an undefined value.

Notify that the test is passed. Normally, it is not needed because #run calls it automatically. If you want to override #run, it is not a good idea. Please contact test-unit developers. We will help you without your custom #run. For example, we may add a new hook in #run.

This is a public API for developers who extend test-unit.

Called after every test method runs but the test method isn't marked as 'passed'. Can be used to clean up and/or verify tested condition. e.g. Can be used to verify mock.

You can add additional cleanup tasks by the following code:

class TestMyClass < Test::Unit::TestCase
  def cleanup
    #...
  end

  cleanup
  def my_cleanup1
    #...
  end

  cleanup do
    #... # cleanup callback1
  end

  cleanup
  def my_cleanup2
    #...
  end

  cleanup do
    #... # cleanup callback2
  end

  def test_my_class
    #...
  end
end

Here is a call order:

• test_my_class

• cleanup callback2

• my_cleanup2

• cleanup callback1

• my_cleanup1

• cleanup

Returns a label of test data for the test. If the test isn't associated with any test data, it returns nil.

Returns a description for the test. A description will be associated by .test or .description.

Returns a name for the test for no description test.

Returns elapsed time for the test was ran.

Returns a human-readable name for the specific test that this instance of TestCase represents.

This method returns an undefined value.

Notify that a problem is occurred in the test. It means that the test is a failed test. If any failed tests exist in test suites, the test process exits with failure exit status.

This is a public API for developers who extend test-unit.

Runs the individual test method represented by this instance of the fixture, collecting statistics, failures and errors in result.

Called before every test method runs. Can be used to set up fixture information.

You can add additional setup tasks by the following code:

class TestMyClass < Test::Unit::TestCase
  def setup
    #...
  end

  setup
  def my_setup1
    #...
  end

  setup do
    #... # setup callback1
  end

  setup
  def my_setup2
    #...
  end

  setup do
    #... # setup callback2
  end

  def test_my_class
    #...
  end
end

Here is a call order:

• setup

• my_setup1

• setup callback1

• my_setup2

• setup callback2

• test_my_class

Returns a Time at the test was started.

Called after every test method runs. Can be used to tear down fixture information.

You can add additional teardown tasks by the following code:

class TestMyClass < Test::Unit::TestCase
  def teardown
    #...
  end

  teardown
  def my_teardown1
    #...
  end

  teardown do
    #... # teardown callback1
  end

  teardown
  def my_teardown2
    #...
  end

  teardown do
    #... # teardown callback2
  end

  def test_my_class
    #...
  end
end

Here is a call order:

• test_my_class

• teardown callback2

• my_teardown2

• teardown callback1

• my_teardown1

• teardown

Overridden to return #name.