test/classes/GitTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use PhpMyAdmin\Git;
   8
   9 use function chdir;
  10 use function file_put_contents;
  11 use function getcwd;
  12 use function is_string;
  13 use function mkdir;
  14 use function mt_getrandmax;
  15 use function random_int;
  16 use function rmdir;
  17 use function sys_get_temp_dir;
  18 use function unlink;
  19
  20 use const DIRECTORY_SEPARATOR;
  21 use const PHP_EOL;
  22
  23 /**
  24  * @covers \PhpMyAdmin\Git
  25  * @group git-revision
  26  */
  27 class GitTest extends AbstractTestCase
  28 {
  29     /** @var Git */
  30     protected $object;
  31
  32     /** @var string */
  33     protected $testDir;
  34
  35     /** @var string */
  36     protected $cwd;
  37
  38     /**
  39      * Sets up the fixture, for example, opens a network connection.
  40      * This method is called before a test is executed.
  41      */
  42     protected function setUp(): void
  43     {
  44         parent::setUp();
  45         parent::setProxySettings();
  46         $this->object = new Git(true);
  47         $this->testDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'gittempdir_' . random_int(0, mt_getrandmax());
  48
  49         unset($_SESSION['git_location']);
  50         unset($_SESSION['is_git_revision']);
  51         $this->cwd = is_string(getcwd()) ? getcwd() : './';
  52         mkdir($this->testDir);
  53         chdir((string) $this->testDir);
  54     }
  55
  56     /**
  57      * Tears down the fixture, for example, closes a network connection.
  58      * This method is called after a test is executed.
  59      */
  60     protected function tearDown(): void
  61     {
  62         chdir((string) $this->cwd);
  63         rmdir($this->testDir);
  64         parent::tearDown();
  65         unset($this->object);
  66     }
  67
  68     /**
  69      * Test for isGitRevision
  70      */
  71     public function testIsGitRevision(): void
  72     {
  73         $_SESSION['git_location'] = '.cachedgitlocation';
  74         $_SESSION['is_git_revision'] = true;
  75
  76         $git_location = '';
  77
  78         $this->assertTrue($this->object->isGitRevision($git_location));
  79
  80         $this->assertFalse($this->object->hasGitInformation());
  81
  82         $this->assertEquals('.cachedgitlocation', $git_location);
  83     }
  84
  85     /**
  86      * Test for isGitRevision
  87      */
  88     public function testIsGitRevisionSkipped(): void
  89     {
  90         $this->object = new Git(false);
  91         $this->assertFalse(
  92             $this->object->isGitRevision($git_location)
  93         );
  94     }
  95
  96     /**
  97      * Test for isGitRevision
  98      *
  99      * @group git-revision
 100      */
 101     public function testIsGitRevisionLocalGitDir(): void
 102     {
 103         $this->assertFalse(
 104             $this->object->isGitRevision()
 105         );
 106
 107         $this->assertFalse($this->object->hasGitInformation());
 108
 109         unset($_SESSION['git_location']);
 110         unset($_SESSION['is_git_revision']);
 111
 112         mkdir('.git');
 113
 114         $this->assertFalse(
 115             $this->object->isGitRevision()
 116         );
 117
 118         $this->assertFalse($this->object->hasGitInformation());
 119
 120         unset($_SESSION['git_location']);
 121         unset($_SESSION['is_git_revision']);
 122
 123         file_put_contents('.git/config', '');
 124
 125         $this->assertTrue($this->object->isGitRevision());
 126
 127         $this->assertFalse($this->object->hasGitInformation());
 128
 129         unlink('.git/config');
 130         rmdir('.git');
 131     }
 132
 133     /**
 134      * Test for isGitRevision
 135      *
 136      * @group git-revision
 137      */
 138     public function testIsGitRevisionExternalGitDir(): void
 139     {
 140         file_put_contents('.git', 'gitdir: ./.customgitdir');
 141         $this->assertFalse(
 142             $this->object->isGitRevision()
 143         );
 144
 145         $this->assertFalse($this->object->hasGitInformation());
 146
 147         unset($_SESSION['git_location']);
 148         unset($_SESSION['is_git_revision']);
 149
 150         mkdir('.customgitdir');
 151
 152         $this->assertTrue($this->object->isGitRevision());
 153
 154         $this->assertFalse($this->object->hasGitInformation());
 155
 156         unset($_SESSION['git_location']);
 157         unset($_SESSION['is_git_revision']);
 158
 159         file_put_contents('.git', 'random data here');
 160
 161         $this->assertFalse(
 162             $this->object->isGitRevision()
 163         );
 164
 165         $this->assertFalse($this->object->hasGitInformation());
 166
 167         unlink('.git');
 168         rmdir('.customgitdir');
 169     }
 170
 171     /**
 172      * Test for checkGitRevision packs folder
 173      *
 174      * @group git-revision
 175      */
 176     public function testCheckGitRevisionPacksFolder(): void
 177     {
 178         mkdir('.git');
 179         file_put_contents('.git/config', '');
 180
 181         $commit = $this->object->checkGitRevision();
 182
 183         $this->assertNull($commit);
 184         $this->assertFalse($this->object->hasGitInformation());
 185
 186         file_put_contents('.git/HEAD', 'ref: refs/remotes/origin/master');
 187
 188         $commit = $this->object->checkGitRevision();
 189
 190         $this->assertNull($commit);
 191
 192         file_put_contents(
 193             '.git/packed-refs',
 194             '# pack-refs with: peeled fully-peeled sorted' . PHP_EOL .
 195             'c1f2ff2eb0c3fda741f859913fd589379f4e4a8f refs/tags/4.3.10' . PHP_EOL .
 196             '^6f2e60343b0a324c65f2d1411bf4bd03e114fb98' . PHP_EOL .
 197             '17bf8b7309919f8ac593d7c563b31472780ee83b refs/remotes/origin/master' . PHP_EOL
 198         );
 199         mkdir('.git/objects/pack', 0777, true);//default = 0777, recursive mode
 200
 201         $commit = $this->object->checkGitRevision();
 202
 203         $this->assertIsArray($commit);
 204         $this->assertArrayHasKey('hash', $commit);
 205         $this->assertEquals('17bf8b7309919f8ac593d7c563b31472780ee83b', $commit['hash']);
 206
 207         $this->assertArrayHasKey('branch', $commit);
 208         $this->assertEquals('master', $commit['branch']);
 209
 210         $this->assertArrayHasKey('message', $commit);
 211         $this->assertIsString($commit['message']);
 212
 213         $this->assertArrayHasKey('is_remote_commit', $commit);
 214         $this->assertIsBool($commit['is_remote_commit']);
 215
 216         $this->assertArrayHasKey('is_remote_branch', $commit);
 217         $this->assertIsBool($commit['is_remote_branch']);
 218
 219         $this->assertArrayHasKey('author', $commit);
 220         $this->assertIsArray($commit['author']);
 221         $this->assertArrayHasKey('name', $commit['author']);
 222         $this->assertArrayHasKey('email', $commit['author']);
 223         $this->assertArrayHasKey('date', $commit['author']);
 224         $this->assertIsString($commit['author']['name']);
 225         $this->assertIsString($commit['author']['email']);
 226         $this->assertIsString($commit['author']['date']);
 227
 228         $this->assertArrayHasKey('committer', $commit);
 229         $this->assertIsArray($commit['committer']);
 230         $this->assertArrayHasKey('name', $commit['committer']);
 231         $this->assertArrayHasKey('email', $commit['committer']);
 232         $this->assertArrayHasKey('date', $commit['committer']);
 233         $this->assertIsString($commit['committer']['name']);
 234         $this->assertIsString($commit['committer']['email']);
 235         $this->assertIsString($commit['committer']['date']);
 236
 237         rmdir('.git/objects/pack');
 238         rmdir('.git/objects');
 239         unlink('.git/packed-refs');
 240         unlink('.git/HEAD');
 241         unlink('.git/config');
 242         rmdir('.git');
 243     }
 244
 245     /**
 246      * Test for checkGitRevision packs folder
 247      *
 248      * @group git-revision
 249      */
 250     public function testCheckGitRevisionRefFile(): void
 251     {
 252         mkdir('.git');
 253         file_put_contents('.git/config', '');
 254
 255         $commit = $this->object->checkGitRevision();
 256
 257         $this->assertNull($commit);
 258         $this->assertFalse($this->object->hasGitInformation());
 259
 260         file_put_contents('.git/HEAD', 'ref: refs/remotes/origin/master');
 261         mkdir('.git/refs/remotes/origin', 0777, true);
 262         file_put_contents('.git/refs/remotes/origin/master', 'c1f2ff2eb0c3fda741f859913fd589379f4e4a8f');
 263         mkdir('.git/objects/pack', 0777, true);//default = 0777, recursive mode
 264         $commit = $this->object->checkGitRevision();
 265
 266         $this->assertNull($commit);
 267         $this->assertFalse($this->object->hasGitInformation());
 268
 269         unlink('.git/refs/remotes/origin/master');
 270         rmdir('.git/refs/remotes/origin');
 271         rmdir('.git/refs/remotes');
 272         rmdir('.git/refs');
 273         rmdir('.git/objects/pack');
 274         rmdir('.git/objects');
 275         unlink('.git/HEAD');
 276         unlink('.git/config');
 277         rmdir('.git');
 278     }
 279
 280     /**
 281      * Test for checkGitRevision with packs as file
 282      *
 283      * @group git-revision
 284      */
 285     public function testCheckGitRevisionPacksFile(): void
 286     {
 287         mkdir('.git');
 288         file_put_contents('.git/config', '');
 289
 290         $commit = $this->object->checkGitRevision();
 291
 292         $this->assertNull($commit);
 293         $this->assertFalse($this->object->hasGitInformation());
 294
 295         file_put_contents('.git/HEAD', 'ref: refs/remotes/origin/master');
 296
 297         $commit = $this->object->checkGitRevision();
 298
 299         $this->assertNull($commit);
 300
 301         file_put_contents(
 302             '.git/packed-refs',
 303             '# pack-refs with: peeled fully-peeled sorted' . PHP_EOL .
 304             'c1f2ff2eb0c3fda741f859913fd589379f4e4a8f refs/tags/4.3.10' . PHP_EOL .
 305             '^6f2e60343b0a324c65f2d1411bf4bd03e114fb98' . PHP_EOL .
 306             '17bf8b7309919f8ac593d7c563b31472780ee83b refs/remotes/origin/master' . PHP_EOL
 307         );
 308         mkdir('.git/objects/info', 0777, true);
 309         file_put_contents(
 310             '.git/objects/info/packs',
 311             'P pack-faea49765800da462c70bea555848cc8c7a1c28d.pack' . PHP_EOL .
 312             '  pack-.pack' . PHP_EOL .
 313             PHP_EOL .
 314             'P pack-420568bae521465fd11863bff155a2b2831023.pack' . PHP_EOL .
 315             PHP_EOL
 316         );
 317
 318         $commit = $this->object->checkGitRevision();
 319
 320         $this->assertIsArray($commit);
 321         $this->assertArrayHasKey('hash', $commit);
 322         $this->assertEquals('17bf8b7309919f8ac593d7c563b31472780ee83b', $commit['hash']);
 323
 324         $this->assertArrayHasKey('branch', $commit);
 325         $this->assertEquals('master', $commit['branch']);
 326
 327         $this->assertArrayHasKey('message', $commit);
 328         $this->assertIsString($commit['message']);
 329
 330         $this->assertArrayHasKey('is_remote_commit', $commit);
 331         $this->assertIsBool($commit['is_remote_commit']);
 332
 333         $this->assertArrayHasKey('is_remote_branch', $commit);
 334         $this->assertIsBool($commit['is_remote_branch']);
 335
 336         $this->assertArrayHasKey('author', $commit);
 337         $this->assertIsArray($commit['author']);
 338         $this->assertArrayHasKey('name', $commit['author']);
 339         $this->assertArrayHasKey('email', $commit['author']);
 340         $this->assertArrayHasKey('date', $commit['author']);
 341         $this->assertIsString($commit['author']['name']);
 342         $this->assertIsString($commit['author']['email']);
 343         $this->assertIsString($commit['author']['date']);
 344
 345         $this->assertArrayHasKey('committer', $commit);
 346         $this->assertIsArray($commit['committer']);
 347         $this->assertArrayHasKey('name', $commit['committer']);
 348         $this->assertArrayHasKey('email', $commit['committer']);
 349         $this->assertArrayHasKey('date', $commit['committer']);
 350         $this->assertIsString($commit['committer']['name']);
 351         $this->assertIsString($commit['committer']['email']);
 352         $this->assertIsString($commit['committer']['date']);
 353
 354         unlink('.git/objects/info/packs');
 355         rmdir('.git/objects/info');
 356         rmdir('.git/objects');
 357         unlink('.git/packed-refs');
 358         unlink('.git/HEAD');
 359         unlink('.git/config');
 360         rmdir('.git');
 361     }
 362
 363     /**
 364      * Test for checkGitRevision
 365      */
 366     public function testCheckGitRevisionSkipped(): void
 367     {
 368         $this->object = new Git(false);
 369         $commit = $this->object->checkGitRevision();
 370
 371         $this->assertNull($commit);
 372
 373         $this->assertFalse($this->object->hasGitInformation());
 374     }
 375
 376     /**
 377      * Test for git infos in session
 378      */
 379     public function testSessionCacheGitFolder(): void
 380     {
 381         $_SESSION['git_location'] = 'customdir/.git';
 382         $_SESSION['is_git_revision'] = true;
 383         $gitFolder = '';
 384         $this->assertTrue($this->object->isGitRevision($gitFolder));
 385
 386         $this->assertEquals($gitFolder, 'customdir/.git');
 387     }
 388
 389     /**
 390      * Test that git folder is not looked up if cached value is false
 391      */
 392     public function testSessionCacheGitFolderNotRevisionNull(): void
 393     {
 394         $_SESSION['is_git_revision'] = false;
 395         $_SESSION['git_location'] = null;
 396         $gitFolder = 'defaultvaluebyref';
 397         $this->assertFalse($this->object->isGitRevision($gitFolder));
 398
 399         // Assert that the value is replaced by cached one
 400         $this->assertEquals($gitFolder, null);
 401     }
 402
 403     /**
 404      * Test that git folder is not looked up if cached value is false
 405      */
 406     public function testSessionCacheGitFolderNotRevisionString(): void
 407     {
 408         $_SESSION['is_git_revision'] = false;
 409         $_SESSION['git_location'] = 'randomdir/.git';
 410         $gitFolder = 'defaultvaluebyref';
 411         $this->assertFalse($this->object->isGitRevision($gitFolder));
 412
 413         // Assert that the value is replaced by cached one
 414         $this->assertEquals($gitFolder, 'randomdir/.git');
 415     }
 416 }