UIDGeneratorTest.php

Go to the documentation of this file.

<?php

class UIDGeneratorTest extends MediaWikiTestCase {

    protected function tearDown() {
        // Bug: 44850
        UIDGenerator::unitTestTearDown();
        parent::tearDown();
    }

    public function testTimestampedUID( $method, $digitlen, $bits, $tbits, $hostbits ) {
        $id = call_user_func( array( 'UIDGenerator', $method ) );
        $this->assertEquals( true, ctype_digit( $id ), "UID made of digit characters" );
        $this->assertLessThanOrEqual( $digitlen, strlen( $id ),
            "UID has the right number of digits" );
        $this->assertLessThanOrEqual( $bits, strlen( wfBaseConvert( $id, 10, 2 ) ),
            "UID has the right number of bits" );

        $ids = array();
        for ( $i = 0; $i < 300; $i++ ) {
            $ids[] = call_user_func( array( 'UIDGenerator', $method ) );
        }

        $lastId = array_shift( $ids );

        $this->assertArrayEquals( array_unique( $ids ), $ids, "All generated IDs are unique." );

        foreach ( $ids as $id ) {
            $id_bin = wfBaseConvert( $id, 10, 2 );
            $lastId_bin = wfBaseConvert( $lastId, 10, 2 );

            $this->assertGreaterThanOrEqual(
                substr( $id_bin, 0, $tbits ),
                substr( $lastId_bin, 0, $tbits ),
                "New ID timestamp ($id_bin) >= prior one ($lastId_bin)." );

            if ( $hostbits ) {
                $this->assertEquals(
                    substr( $id_bin, 0, -$hostbits ),
                    substr( $lastId_bin, 0, -$hostbits ),
                    "Host ID of ($id_bin) is same as prior one ($lastId_bin)." );
            }

            $lastId = $id;
        }
    }

    public static function provider_testTimestampedUID() {
        return array(
            array( 'newTimestampedUID128', 39, 128, 46, 48 ),
            array( 'newTimestampedUID128', 39, 128, 46, 48 ),
            array( 'newTimestampedUID88', 27, 88, 46, 32 ),
        );
    }

    public function testUUIDv4() {
        for ( $i = 0; $i < 100; $i++ ) {
            $id = UIDGenerator::newUUIDv4();
            $this->assertEquals( true,
                preg_match( '!^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$!', $id ),
                "UID $id has the right format" );
        }
    }

    public function testRawUUIDv4() {
        for ( $i = 0; $i < 100; $i++ ) {
            $id = UIDGenerator::newRawUUIDv4();
            $this->assertEquals( true,
                preg_match( '!^[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}$!', $id ),
                "UID $id has the right format" );
        }
    }

    public function testRawUUIDv4QuickRand() {
        for ( $i = 0; $i < 100; $i++ ) {
            $id = UIDGenerator::newRawUUIDv4( UIDGenerator::QUICK_RAND );
            $this->assertEquals( true,
                preg_match( '!^[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}$!', $id ),
                "UID $id has the right format" );
        }
    }

    public function testNewSequentialID() {
        $id1 = UIDGenerator::newSequentialPerNodeID( 'test', 32 );
        $id2 = UIDGenerator::newSequentialPerNodeID( 'test', 32 );

        $this->assertType( 'float', $id1, "ID returned as float" );
        $this->assertType( 'float', $id2, "ID returned as float" );
        $this->assertGreaterThan( 0, $id1, "ID greater than 1" );
        $this->assertGreaterThan( $id1, $id2, "IDs increasing in value" );
    }

    public function testNewSequentialIDs() {
        $ids = UIDGenerator::newSequentialPerNodeIDs( 'test', 32, 5 );
        $lastId = null;
        foreach ( $ids as $id ) {
            $this->assertType( 'float', $id, "ID returned as float" );
            $this->assertGreaterThan( 0, $id, "ID greater than 1" );
            if ( $lastId ) {
                $this->assertGreaterThan( $lastId, $id, "IDs increasing in value" );
            }
            $lastId = $id;
        }
    }
}