tests/phpunit/includes/utils/UIDGeneratorTest.php

   1 <?php
   2
   3 class UIDGeneratorTest extends PHPUnit\Framework\TestCase {
   4
   5         use MediaWikiCoversValidator;
   6
   7         protected function tearDown() {
   8                 // T46850
   9                 UIDGenerator::unitTestTearDown();
  10                 parent::tearDown();
  11         }
  12
  13         /**
  14          * Test that generated UIDs have the expected properties
  15          *
  16          * @dataProvider provider_testTimestampedUID
  17          * @covers UIDGenerator::newTimestampedUID88
  18          * @covers UIDGenerator::getTimestampedID88
  19          * @covers UIDGenerator::newTimestampedUID128
  20          * @covers UIDGenerator::getTimestampedID128
  21          */
  22         public function testTimestampedUID( $method, $digitlen, $bits, $tbits, $hostbits ) {
  23                 $id = call_user_func( [ UIDGenerator::class, $method ] );
  24                 $this->assertEquals( true, ctype_digit( $id ), "UID made of digit characters" );
  25                 $this->assertLessThanOrEqual( $digitlen, strlen( $id ),
  26                         "UID has the right number of digits" );
  27                 $this->assertLessThanOrEqual( $bits, strlen( Wikimedia\base_convert( $id, 10, 2 ) ),
  28                         "UID has the right number of bits" );
  29
  30                 $ids = [];
  31                 for ( $i = 0; $i < 300; $i++ ) {
  32                         $ids[] = call_user_func( [ UIDGenerator::class, $method ] );
  33                 }
  34
  35                 $lastId = array_shift( $ids );
  36
  37                 $this->assertSame( array_unique( $ids ), $ids, "All generated IDs are unique." );
  38
  39                 foreach ( $ids as $id ) {
  40                         // Convert string to binary and pad to full length so we can
  41                         // extract segments
  42                         $id_bin = Wikimedia\base_convert( $id, 10, 2, $bits );
  43                         $lastId_bin = Wikimedia\base_convert( $lastId, 10, 2, $bits );
  44
  45                         $timestamp_bin = substr( $id_bin, 0, $tbits );
  46                         $last_timestamp_bin = substr( $lastId_bin, 0, $tbits );
  47
  48                         $this->assertGreaterThanOrEqual(
  49                                 $last_timestamp_bin,
  50                                 $timestamp_bin,
  51                                 "timestamp ($timestamp_bin) of current ID ($id_bin) >= timestamp ($last_timestamp_bin) " .
  52                                         "of prior one ($lastId_bin)" );
  53
  54                         $hostbits_bin = substr( $id_bin, -$hostbits );
  55                         $last_hostbits_bin = substr( $lastId_bin, -$hostbits );
  56
  57                         if ( $hostbits ) {
  58                                 $this->assertEquals(
  59                                         $hostbits_bin,
  60                                         $last_hostbits_bin,
  61                                         "Host ID ($hostbits_bin) of current ID ($id_bin) is same as host ID ($last_hostbits_bin) " .
  62                                                 "of prior one ($lastId_bin)." );
  63                         }
  64
  65                         $lastId = $id;
  66                 }
  67         }
  68
  69         /**
  70          * [ method, length, bits, hostbits ]
  71          * NOTE: When adding a new method name here please update the covers tags for the tests!
  72          */
  73         public static function provider_testTimestampedUID() {
  74                 return [
  75                         [ 'newTimestampedUID128', 39, 128, 46, 48 ],
  76                         [ 'newTimestampedUID128', 39, 128, 46, 48 ],
  77                         [ 'newTimestampedUID88', 27, 88, 46, 32 ],
  78                 ];
  79         }
  80
  81         /**
  82          * @covers UIDGenerator::newUUIDv1
  83          * @covers UIDGenerator::getUUIDv1
  84          */
  85         public function testUUIDv1() {
  86                 $ids = [];
  87                 for ( $i = 0; $i < 100; $i++ ) {
  88                         $id = UIDGenerator::newUUIDv1();
  89                         $this->assertEquals( true,
  90                                 preg_match( '!^[0-9a-f]{8}-[0-9a-f]{4}-1[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$!', $id ),
  91                                 "UID $id has the right format" );
  92                         $ids[] = $id;
  93
  94                         $id = UIDGenerator::newRawUUIDv1();
  95                         $this->assertEquals( true,
  96                                 preg_match( '!^[0-9a-f]{12}1[0-9a-f]{3}[89ab][0-9a-f]{15}$!', $id ),
  97                                 "UID $id has the right format" );
  98
  99                         $id = UIDGenerator::newRawUUIDv1();
 100                         $this->assertEquals( true,
 101                                 preg_match( '!^[0-9a-f]{12}1[0-9a-f]{3}[89ab][0-9a-f]{15}$!', $id ),
 102                                 "UID $id has the right format" );
 103                 }
 104
 105                 $this->assertEquals( array_unique( $ids ), $ids, "All generated IDs are unique." );
 106         }
 107
 108         /**
 109          * @covers UIDGenerator::newUUIDv4
 110          */
 111         public function testUUIDv4() {
 112                 $ids = [];
 113                 for ( $i = 0; $i < 100; $i++ ) {
 114                         $id = UIDGenerator::newUUIDv4();
 115                         $ids[] = $id;
 116                         $this->assertEquals( true,
 117                                 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 ),
 118                                 "UID $id has the right format" );
 119                 }
 120
 121                 $this->assertEquals( array_unique( $ids ), $ids, 'All generated IDs are unique.' );
 122         }
 123
 124         /**
 125          * @covers UIDGenerator::newRawUUIDv4
 126          */
 127         public function testRawUUIDv4() {
 128                 for ( $i = 0; $i < 100; $i++ ) {
 129                         $id = UIDGenerator::newRawUUIDv4();
 130                         $this->assertEquals( true,
 131                                 preg_match( '!^[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}$!', $id ),
 132                                 "UID $id has the right format" );
 133                 }
 134         }
 135
 136         /**
 137          * @covers UIDGenerator::newRawUUIDv4
 138          */
 139         public function testRawUUIDv4QuickRand() {
 140                 for ( $i = 0; $i < 100; $i++ ) {
 141                         $id = UIDGenerator::newRawUUIDv4( UIDGenerator::QUICK_RAND );
 142                         $this->assertEquals( true,
 143                                 preg_match( '!^[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}$!', $id ),
 144                                 "UID $id has the right format" );
 145                 }
 146         }
 147
 148         /**
 149          * @covers UIDGenerator::newSequentialPerNodeID
 150          */
 151         public function testNewSequentialID() {
 152                 $id1 = UIDGenerator::newSequentialPerNodeID( 'test', 32 );
 153                 $id2 = UIDGenerator::newSequentialPerNodeID( 'test', 32 );
 154
 155                 $this->assertInternalType( 'float', $id1, "ID returned as float" );
 156                 $this->assertInternalType( 'float', $id2, "ID returned as float" );
 157                 $this->assertGreaterThan( 0, $id1, "ID greater than 1" );
 158                 $this->assertGreaterThan( $id1, $id2, "IDs increasing in value" );
 159         }
 160
 161         /**
 162          * @covers UIDGenerator::newSequentialPerNodeIDs
 163          * @covers UIDGenerator::getSequentialPerNodeIDs
 164          */
 165         public function testNewSequentialIDs() {
 166                 $ids = UIDGenerator::newSequentialPerNodeIDs( 'test', 32, 5 );
 167                 $lastId = null;
 168                 foreach ( $ids as $id ) {
 169                         $this->assertInternalType( 'float', $id, "ID returned as float" );
 170                         $this->assertGreaterThan( 0, $id, "ID greater than 1" );
 171                         if ( $lastId ) {
 172                                 $this->assertGreaterThan( $lastId, $id, "IDs increasing in value" );
 173                         }
 174                         $lastId = $id;
 175                 }
 176         }
 177 }