-
-
Notifications
You must be signed in to change notification settings - Fork 36
/
BaseLineTest.php
167 lines (148 loc) · 6.34 KB
/
BaseLineTest.php
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?php
/**
* This file is part of the Dealerdirect PHP_CodeSniffer Standards
* Composer Installer Plugin package.
*
* @copyright 2022 PHPCodeSniffer Composer Installer Contributors
* @license MIT
*/
namespace Dealerdirect\Composer\Plugin\Installers\PHPCodeSniffer\Tests\IntegrationTest;
use Dealerdirect\Composer\Plugin\Installers\PHPCodeSniffer\Tests\PHPCSVersions;
use Dealerdirect\Composer\Plugin\Installers\PHPCodeSniffer\Tests\TestCase;
/**
* Test baseline.
*
* These tests verify:
* - That the plugin can be installed and functions correctly with the full range of supported PHPCS versions.
* While the test is not run against the full range of supported PHPCS version each time, due to the
* random PHPCS version selection, all supported PHPCS versions will be tested over time in CI.
* - That the plugin runs when installed.
* - That the PHPCS native standards are the only recognized standards when no external standards are available.
* - That no `CodeSniffer.conf``file gets created when no external standards are found.
*/
final class BaseLineTest extends TestCase
{
private $composerConfig = array(
'name' => 'phpcs-composer-installer/baseline-test',
'require-dev' => array(
'squizlabs/php_codesniffer' => null,
'dealerdirect/phpcodesniffer-composer-installer' => '*',
),
);
/**
* Set up test environment before each test.
*/
protected function set_up()
{
$this->createTestEnvironment();
}
/**
* Clean up after each test.
*/
protected function tear_down()
{
$this->removeTestEnvironment();
}
/**
* Baseline test for a Composer GLOBAL install.
*
* @dataProvider dataBaseLine
*
* @param string $phpcsVersion PHPCS version to use in this test.
* This version is randomly selected from the PHPCS versions compatible
* with the PHP version used in the test.
* @param array $expectedStnds List of the standards which are expected to be registered.
*
* @return void
*/
public function testBaseLineGlobal($phpcsVersion, $expectedStnds)
{
$config = $this->composerConfig;
$config['require-dev']['squizlabs/php_codesniffer'] = $phpcsVersion;
$this->writeComposerJsonFile($config, static::$tempGlobalPath);
$this->assertComposerValidates(static::$tempGlobalPath);
// Make sure the plugin runs.
$expectedStdOut = $this->willPluginOutputShow() ? 'Running PHPCodeSniffer Composer Installer' : null;
$this->assertExecute(
'composer global install -v --no-ansi',
0, // Expected exit code.
$expectedStdOut, // Expected stdout.
null, // No stderr expectation.
'Failed to install dependencies.'
);
$result = $this->executeCliCommand('"vendor/bin/phpcs" -i', static::$tempGlobalPath);
$this->assertSame(0, $result['exitcode'], 'Exitcode for phpcs -i did not match 0');
$this->assertSame(
$expectedStnds,
$this->standardsPhraseToArray($result['stdout']),
'Installed standards do not match the expected standards.'
);
// Make sure the CodeSniffer.conf file does not get created when no external standards are found.
$this->assertFileDoesNotExist(
static::$tempGlobalPath . '/vendor/squizlabs/php_codesniffer/CodeSniffer.conf'
);
}
/**
* Baseline test for a Composer LOCAL install.
*
* @dataProvider dataBaseLine
*
* @param string $phpcsVersion PHPCS version to use in this test.
* This version is randomly selected from the PHPCS versions compatible
* with the PHP version used in the test.
* @param array $expectedStnds List of the standards which are expected to be registered.
*
* @return void
*/
public function testBaseLineLocal($phpcsVersion, $expectedStnds)
{
$config = $this->composerConfig;
$config['require-dev']['squizlabs/php_codesniffer'] = $phpcsVersion;
$this->writeComposerJsonFile($config, static::$tempLocalPath);
$this->assertComposerValidates(static::$tempLocalPath);
// Make sure the plugin runs.
$expectedStdOut = $this->willPluginOutputShow() ? 'Running PHPCodeSniffer Composer Installer' : null;
$this->assertExecute(
sprintf('composer install -v --no-ansi --working-dir=%s', escapeshellarg(static::$tempLocalPath)),
0, // Expected exit code.
$expectedStdOut, // Expected stdout.
null, // No stderr expectation.
'Failed to install dependencies.'
);
$result = $this->executeCliCommand('"vendor/bin/phpcs" -i', static::$tempLocalPath);
$this->assertSame(0, $result['exitcode'], 'Exitcode for phpcs -i did not match 0');
$this->assertSame(
$expectedStnds,
$this->standardsPhraseToArray($result['stdout']),
'Installed standards do not match the expected standards.'
);
// Make sure the CodeSniffer.conf file does not get created when no external standards are found.
$this->assertFileDoesNotExist(
static::$tempLocalPath . '/vendor/squizlabs/php_codesniffer/CodeSniffer.conf'
);
}
/**
* Data provider.
*
* Note: PHPCS does not display the names of the standards in a fixed order, so the order in which standards
* get displayed may differ depending on the machine/OS on which the tests get run.
* With that in mind, the verification that the PHPCS native standards are the only recognized standards
* is done using a regex instead of an exact match.
* Also see: https://github.com/squizlabs/PHP_CodeSniffer/pull/3539
*
* @return array
*/
public function dataBaseLine()
{
// Get two PHPCS versions suitable for this PHP version + `master` + PHPCS 4.x dev.
$versions = PHPCSVersions::get(2, true, true);
$data = array();
foreach ($versions as $version) {
$data["phpcs $version"] = array(
'phpcsVersion' => $version,
'expectedStnds' => PHPCSVersions::getStandards($version),
);
}
return $data;
}
}