Module Test::Unit::Data::ClassMethods
In: lib/test/unit/data.rb

Methods

data   load_data  

Classes and Modules

Class Test::Unit::Data::ClassMethods::Loader

Public Instance methods

This method provides Data-Driven-Test functionality.

Define test data in the test code.

@overload data(label, data, options={})

  @param [String] label specify test case name.
  @param data specify test data.
  @param [Hash] options specify options.
  @option options [Boolean] :keep whether or not to use
    this data in the following test methods

  @example data(label, data)
    data("empty string", [true, ""])
    data("plain string", [false, "hello"])
    def test_empty?(data)
      expected, target = data
      assert_equal(expected, target.empty?)
    end

@overload data(variable, patterns, options={})

  @param [Symbol] variable specify test pattern variable name.
  @param [Array] patterns specify test patterns for the variable.
  @param [Hash] options specify options.
  @option options [Boolean] :keep whether or not to use
    this data in the following test methods
  @option options [Object] :group the test pattern group.
    Test matrix is generated for each test pattern group separately.

  @example data(variable, patterns)
    data(:x, [1, 2, 3])
    data(:y, ["a", "b"])
    def test_patterns(data)
      # 3 * 2 times executed
      # 3: the number of patterns of :x
      # 2: the number of patterns of :y
      p data
        # => {:x => 1, :y => "a"}
        # => {:x => 1, :y => "b"}
        # => {:x => 2, :y => "a"}
        # => {:x => 2, :y => "b"}
        # => {:x => 3, :y => "a"}
        # => {:x => 3, :y => "b"}
    end

  Generates test matrix from variable and patterns pairs.

@overload data(data_set, options={})

  @param [Hash] data_set specify test data as a Hash that
    key is test label and value is test data.
  @param [Hash] options specify options.
  @option options [Boolean] :keep whether or not to use
    this data in the following test methods

  @example data(data_set)
    data("empty string" => [true, ""],
         "plain string" => [false, "hello"])
    def test_empty?(data)
      expected, target = data
      assert_equal(expected, target.empty?)
    end

@overload data(options={}, &block)

  @param [Hash] options specify options.
  @option options [Boolean] :keep whether or not to use
    this data in the following test methods
  @yieldreturn [Hash<String, Object>] return test data set
    as a Hash that key is test label and value is test data.

  @example data(&block)
    data do
      data_set = {}
      data_set["empty string"] = [true, ""]
      data_set["plain string"] = [false, "hello"]
      data_set
    end
    def test_empty?(data)
      expected, target = data
      assert_equal(expected, target.empty?)
    end

@overload data(options={}, &block)

  @param [Hash] options specify options.
  @option options [Boolean] :keep whether or not to use
    this data in the following test methods
  @yieldreturn [Array<Symbol, Array>] return test data set
    as an Array of variable and patterns.

  @example data(&block)
    data do
      patterns = 3.times.to_a
      [:x, patterns]
    end
    data do
      patterns = []
      character = "a"
      2.times.each do
        patterns << character
        character = character.succ
      end
      [:y, patterns]
    end
    def test_patterns(data)
      # 3 * 2 times executed
      # 3: the number of patterns of :x
      # 2: the number of patterns of :y
      p data
        # => {:x => 0, :y => "a"}
        # => {:x => 0, :y => "b"}
        # => {:x => 1, :y => "a"}
        # => {:x => 1, :y => "b"}
        # => {:x => 2, :y => "a"}
        # => {:x => 2, :y => "b"}
    end

  Generates test matrix from variable and patterns pairs.

This method provides Data-Driven-Test functionality.

Load test data from the file. This is shorthand to load test data from file. If you want to load complex file, you can use {data} with block.

@param [String] file_name full path to test data file.

  File format is automatically detected from filename extension.

@raise [ArgumentError] if file_name is not supported file format. @see Loader#load

@example Load data from CSV file

  load_data("/path/to/test-data.csv")
  def test_empty?(data)
    assert_equal(data["expected"], data["target"].empty?)
  end

[Validate]