Back to Repositories

Testing Unique ID Generation Implementation in Fluentd

This test suite validates the unique ID generation functionality in Fluentd, focusing on both direct module usage and mixin implementation. It ensures reliable generation of 128-bit unique identifiers and their hexadecimal representation.

Test Coverage Overview

The test suite comprehensively covers unique ID generation and hexadecimal conversion functionality.

Tests direct module usage for generating 128-bit IDs
Verifies hexadecimal conversion of 16-byte IDs to 32-character strings
Validates uniqueness across 100,000 generated IDs
Tests mixin implementation in plugin contexts

Implementation Analysis

The testing approach employs Test::Unit framework with sub-test cases to organize related tests logically.

Test patterns include:

Byte length validation for generated IDs
Format verification using regex patterns
Large-scale uniqueness testing
Mixin functionality verification through dummy plugin class

Technical Details

Testing infrastructure includes:

Test::Unit as the primary testing framework
Custom test environment with dummy plugin class
Fluent::Plugin::Base integration
UniqueId module and mixin implementation
Byte-level and hexadecimal string validation

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Isolation of test cases using sub_test_case blocks
Comprehensive edge case testing with large sample sizes
Clear setup and initialization patterns
Consistent assertion methods
Modular test organization

fluent/fluentd

test/test_unique_id.rb

            
require_relative 'helper'
require 'fluent/plugin/base'
require 'fluent/unique_id'

module UniqueIdTestEnv
  class Dummy < Fluent::Plugin::Base
    include Fluent::UniqueId::Mixin
  end
end

class UniqueIdTest < Test::Unit::TestCase
  sub_test_case 'module used directly' do
    test '.generate generates 128bit length unique id (16bytes)' do
      assert_equal 16, Fluent::UniqueId.generate.bytesize
      ary = []
      100_000.times do
        ary << Fluent::UniqueId.generate
      end
      assert_equal 100_000, ary.uniq.size
    end

    test '.hex dumps 16bytes id into 32 chars' do
      assert_equal 32, Fluent::UniqueId.hex(Fluent::UniqueId.generate).size
      assert(Fluent::UniqueId.hex(Fluent::UniqueId.generate) =~ /^[0-9a-z]{32}$/)
    end
  end

  sub_test_case 'mixin' do
    setup do
      @i = UniqueIdTestEnv::Dummy.new
    end

    test '#generate_unique_id generates 128bit length id (16bytes)' do
      assert_equal 16, @i.generate_unique_id.bytesize
      ary = []
      100_000.times do
        ary << @i.generate_unique_id
      end
      assert_equal 100_000, ary.uniq.size
    end

    test '#dump_unique_id_hex dumps 16bytes id into 32 chars' do
      assert_equal 32, @i.dump_unique_id_hex(@i.generate_unique_id).size
      assert(@i.dump_unique_id_hex(@i.generate_unique_id) =~ /^[0-9a-z]{32}$/)
    end
  end
end