1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Test\Integrity;
/**
* A test that enforces composer.lock is up to date with composer.json
*/
class ComposerLockTest extends \PHPUnit\Framework\TestCase
{
/**
* @return string
*/
public function testLockFileExists()
{
$lockFilePath = BP . '/composer.lock';
$this->assertLockFileExists($lockFilePath);
return $lockFilePath;
}
/**
* @depends testLockFileExists
* @param string $lockFilePath
* @return string
*/
public function testLockFileReadable($lockFilePath)
{
$this->assertLockFileReadable($lockFilePath);
return $lockFilePath;
}
/**
* @depends testLockFileReadable
* @param string $lockFilePath
* @return string
*/
public function testLockFileContainsJson($lockFilePath)
{
$lockFileContent = file_get_contents($lockFilePath);
$this->assertLockFileContainsValidJson($lockFileContent);
return $lockFileContent;
}
/**
* @depends testLockFileContainsJson
* @param string $lockFileContent
*/
public function testUpToDate($lockFileContent)
{
$lockData = json_decode($lockFileContent, true);
$composerFilePath = BP . '/composer.json';
$this->assertLockDataRelevantToComposerFile($lockData, $composerFilePath);
}
/**
* @param string $lockFilePath
*/
private function assertLockFileExists($lockFilePath)
{
$this->assertFileExists($lockFilePath, 'composer.lock file does not exist');
}
/**
* @param string $lockFilePath
*/
private function assertLockFileReadable($lockFilePath)
{
if (!is_readable($lockFilePath)) {
$this->fail('composer.lock file is not readable');
}
}
/**
* @param string $lockFileContent
*/
private function assertLockFileContainsValidJson($lockFileContent)
{
$this->assertJson($lockFileContent, 'composer.lock file does not contains valid json');
}
/**
* @param array $lockData
* @param string $composerFilePath
*/
private function assertLockDataRelevantToComposerFile(array $lockData, $composerFilePath)
{
if (isset($lockData['content-hash'])) {
$this->assertLockDataRelevantToMeaningfulComposerConfig($lockData, $composerFilePath);
} else if (isset($lockData['hash'])) {
$this->assertLockDataRelevantToFullComposerConfig($lockData, $composerFilePath);
} else {
$this->fail('composer.lock does not linked to composer.json data');
}
}
/**
* @param array $lockData
* @param string $composerFilePath
*/
private function assertLockDataRelevantToMeaningfulComposerConfig(array $lockData, $composerFilePath)
{
$contentHashCalculator = 'Composer\Package\Locker::getContentHash';
if (!is_callable($contentHashCalculator)) {
$this->markTestSkipped('Unable to check composer.lock file by content hash');
}
$composerContentHash = call_user_func($contentHashCalculator, file_get_contents($composerFilePath));
$this->assertSame(
$composerContentHash,
$lockData['content-hash'],
'composer.lock file is not up to date (composer.json file was modified)'
);
}
/**
* @param array $lockData
* @param string $composerFilePath
*/
private function assertLockDataRelevantToFullComposerConfig(array $lockData, $composerFilePath)
{
$composerFileHash = hash_file('md5', $composerFilePath);
$this->assertSame(
$composerFileHash,
$lockData['hash'],
'composer.lock file is not up to date (composer.json file was modified)'
);
}
}