Skip to content

Commit 5fdfd89

Browse files
PothercaPotherca
committed
Changes hard-coded values in ApiTest class to use class constants.
1 parent 8312d42 commit 5fdfd89

1 file changed

Lines changed: 55 additions & 88 deletions

File tree

‎tests/unit-tests/ApiTest.php‎

Lines changed: 55 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,13 @@
2525
class ApiTest extends \PHPUnit_Framework_TestCase
2626
{
2727
////////////////////////////////// FIXTURES \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
28-
const MOCK_FILE_PATH = '/path/to/mock/file';
2928
const MOCK_FILE_CONTENTS = 'Mock file contents';
30-
const MOCK_FOLDER_PATH = 'a-directory';
29+
const MOCK_FILE_PATH = '/a-directory/another-file.js';
30+
const MOCK_FOLDER_PATH = 'a-directory/';
31+
const MOCK_PACKAGE = 'mockPackage';
32+
const MOCK_REFERENCE = 'mockReference';
33+
const MOCK_VENDOR = 'mockVendor';
34+
const MOCK_BRANCH = 'mockBranch';
3135

3236
/** @var Api */
3337
private $api;
@@ -49,7 +53,7 @@ protected function setUp()
4953

5054
/////////////////////////////////// TESTS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
5155
/**
52-
* @uses Potherca\Flysystem\Github\Api::exists
56+
*
5357
*/
5458
final public function testApiShouldComplainWhenInstantiatedWithoutClient()
5559
{
@@ -93,20 +97,16 @@ final public function testApiShouldUseValuesFromSettingsWhenAskingClientForFileC
9397

9498
$expected = self::MOCK_FILE_CONTENTS;
9599

96-
$mockVendor = 'vendor';
97-
$mockPackage = 'package';
98-
$mockReference = 'reference';
99-
100100
$this->prepareMockSettings([
101-
'getVendor' => $mockVendor,
102-
'getPackage' => $mockPackage,
103-
'getReference' => $mockReference,
101+
'getVendor' => self::MOCK_VENDOR,
102+
'getPackage' => self::MOCK_PACKAGE,
103+
'getReference' => self::MOCK_REFERENCE,
104104
]);
105105

106106
$this->prepareMockApi(
107107
'download',
108108
$api::API_REPOSITORY,
109-
[$mockVendor, $mockPackage, trim(self::MOCK_FILE_PATH, '/'), $mockReference],
109+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FILE_PATH, '/'), self::MOCK_REFERENCE],
110110
$expected
111111
);
112112

@@ -124,20 +124,16 @@ final public function testApiShouldUseValuesFromSettingsWhenAskingClientIfFileEx
124124

125125
$expected = self::MOCK_FILE_CONTENTS;
126126

127-
$mockVendor = 'vendor';
128-
$mockPackage = 'package';
129-
$mockReference = 'reference';
130-
131127
$this->prepareMockSettings([
132-
'getVendor' => $mockVendor,
133-
'getPackage' => $mockPackage,
134-
'getReference' => $mockReference,
128+
'getVendor' => self::MOCK_VENDOR,
129+
'getPackage' => self::MOCK_PACKAGE,
130+
'getReference' => self::MOCK_REFERENCE,
135131
]);
136132

137133
$this->prepareMockApi(
138134
'exists',
139135
$api::API_REPOSITORY,
140-
[$mockVendor, $mockPackage, trim(self::MOCK_FILE_PATH, '/'), $mockReference],
136+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FILE_PATH, '/'), self::MOCK_REFERENCE],
141137
$expected
142138
);
143139

@@ -187,20 +183,16 @@ final public function testApiShouldUseValuesFromSettingsWhenAskingClientForFileI
187183

188184
$expected = self::MOCK_FILE_CONTENTS;
189185

190-
$mockVendor = 'vendor';
191-
$mockPackage = 'package';
192-
$mockReference = 'reference';
193-
194186
$this->prepareMockSettings([
195-
'getVendor' => $mockVendor,
196-
'getPackage' => $mockPackage,
197-
'getReference' => $mockReference,
187+
'getVendor' => self::MOCK_VENDOR,
188+
'getPackage' => self::MOCK_PACKAGE,
189+
'getReference' => self::MOCK_REFERENCE,
198190
]);
199191

200192
$this->prepareMockApi(
201193
'show',
202194
$api::API_REPOSITORY,
203-
[$mockVendor, $mockPackage, trim(self::MOCK_FILE_PATH, '/'), $mockReference],
195+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FILE_PATH, '/'), self::MOCK_REFERENCE],
204196
$expected
205197
);
206198

@@ -234,26 +226,23 @@ final public function testApiShouldReturnMetadataForDirectoryWhenGivenPathIsDire
234226
{
235227
$api = $this->api;
236228

237-
$mockPackage = 'mockPackage';
238-
$mockPath = self::MOCK_FOLDER_PATH;
239-
$mockReference = 'mockReference';
240-
$mockVendor = 'mockVendor';
229+
$mockPath = trim(self::MOCK_FOLDER_PATH, '/');
241230

242231
$expectedUrl = sprintf(
243232
'%s/repos/%s/%s/contents/%s?ref=%s',
244233
$api::GITHUB_API_URL,
245-
$mockVendor,
246-
$mockPackage,
234+
self::MOCK_VENDOR,
235+
self::MOCK_PACKAGE,
247236
$mockPath,
248-
$mockReference
237+
self::MOCK_REFERENCE
249238
);
250239

251240
$expectedHtmlUrl = sprintf(
252241
'%s/%s/%s/blob/%s/%s',
253242
$api::GITHUB_URL,
254-
$mockVendor,
255-
$mockPackage,
256-
$mockReference,
243+
self::MOCK_VENDOR,
244+
self::MOCK_PACKAGE,
245+
self::MOCK_REFERENCE,
257246
$mockPath
258247
);
259248

@@ -276,23 +265,23 @@ final public function testApiShouldReturnMetadataForDirectoryWhenGivenPathIsDire
276265
];
277266

278267
$this->prepareMockSettings([
279-
'getVendor' => $mockVendor,
280-
'getPackage' => $mockPackage,
281-
'getReference' => $mockReference,
268+
'getVendor' => self::MOCK_VENDOR,
269+
'getPackage' => self::MOCK_PACKAGE,
270+
'getReference' => self::MOCK_REFERENCE,
282271
]);
283272

284273
$this->addMocksToClient($this->mockClient, [
285274
Repo::class => [
286275
Contents::class => [
287276
'method' => 'show',
288277
'exactly' => 1,
289-
'with' => ['mockVendor', 'mockPackage', 'a-directory', 'mockReference'],
278+
'with' => [self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FOLDER_PATH, '/'), self::MOCK_REFERENCE],
290279
'willReturn' => [0 => null]
291280
],
292281
Commits::class => [
293282
'method' => 'all',
294283
'exactly' => 3,
295-
'with' => ['mockVendor', 'mockPackage', [
284+
'with' => [self::MOCK_VENDOR, self::MOCK_PACKAGE, [
296285
'sha' => null,
297286
'path' => 'a-directory'
298287
]],
@@ -303,7 +292,7 @@ final public function testApiShouldReturnMetadataForDirectoryWhenGivenPathIsDire
303292
Trees::class => [
304293
'method' => 'show',
305294
'exactly' => 1,
306-
'with' => ['mockVendor', 'mockPackage', 'mockReference'],
295+
'with' => [self::MOCK_VENDOR, self::MOCK_PACKAGE, self::MOCK_REFERENCE],
307296
'willReturn' => $this->loadFixture('repos%2Fpotherca-bot%2Ftest-repository%2Fgit%2Ftrees%2FHEAD'),
308297
],
309298
],
@@ -357,29 +346,23 @@ final public function testApiShouldPassOnExceptionsWhenAskingInfoForFileCausesAn
357346
/**
358347
* @covers ::getDirectoryContents
359348
*
360-
* @uses Potherca\Flysystem\Github\Api::getCreatedTimestamp
361-
*
362349
* @dataProvider provideExpectedMetadata
363350
*
364351
* @param array $data
365352
*/
366353
final public function testApiShouldRetrieveExpectedContentsWhenAskedToGetDirectoryContents($data) {
367354
$api = $this->api;
368355

369-
$mockVendor = 'vendor';
370-
$mockPackage = 'package';
371-
$mockReference = 'reference';
372-
373356
$this->prepareMockSettings([
374-
'getVendor' => $mockVendor,
375-
'getPackage' => $mockPackage,
376-
'getReference' => $mockReference,
357+
'getVendor' => self::MOCK_VENDOR,
358+
'getPackage' => self::MOCK_PACKAGE,
359+
'getReference' => self::MOCK_REFERENCE,
377360
]);
378361

379362
$this->prepareMockApi(
380363
'show',
381364
$api::API_GIT_DATA,
382-
[$mockVendor, $mockPackage, $mockReference, true],
365+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, self::MOCK_REFERENCE, true],
383366
$this->getMockApiTreeResponse($data['truncated'], $api),
384367
Trees::class
385368
);
@@ -407,14 +390,10 @@ final public function testApiShouldUseFileContentsToGuessMimeTypeWhenExtensionUn
407390

408391
$expected = 'image/png';
409392

410-
$mockVendor = 'vendor';
411-
$mockPackage = 'package';
412-
$mockReference = 'reference';
413-
414393
$this->prepareMockSettings([
415-
'getVendor' => $mockVendor,
416-
'getPackage' => $mockPackage,
417-
'getReference' => $mockReference,
394+
'getVendor' => self::MOCK_VENDOR,
395+
'getPackage' => self::MOCK_PACKAGE,
396+
'getReference' => self::MOCK_REFERENCE,
418397
]);
419398

420399
$image = imagecreatetruecolor(1,1);
@@ -427,7 +406,7 @@ final public function testApiShouldUseFileContentsToGuessMimeTypeWhenExtensionUn
427406
$this->prepareMockApi(
428407
'download',
429408
$api::API_REPOSITORY,
430-
[$mockVendor, $mockPackage, trim(self::MOCK_FILE_PATH, '/'), $mockReference],
409+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FILE_PATH, '/'), self::MOCK_REFERENCE],
431410
$contents
432411
);
433412

@@ -449,20 +428,16 @@ final public function testApiShouldGuessMimeTypeCorrectlyWhenGivenPathIsDirector
449428

450429
$expected = $api::MIME_TYPE_DIRECTORY;
451430

452-
$mockVendor = 'vendor';
453-
$mockPackage = 'package';
454-
$mockReference = 'reference';
455-
456431
$this->prepareMockSettings([
457-
'getVendor' => $mockVendor,
458-
'getPackage' => $mockPackage,
459-
'getReference' => $mockReference,
432+
'getVendor' => self::MOCK_VENDOR,
433+
'getPackage' => self::MOCK_PACKAGE,
434+
'getReference' => self::MOCK_REFERENCE,
460435
]);
461436

462437
$this->prepareMockApi(
463438
'trees',
464439
$api::API_GIT_DATA,
465-
[$mockVendor, $mockPackage, self::MOCK_FOLDER_PATH, $mockReference],
440+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FOLDER_PATH, '/'), self::MOCK_REFERENCE],
466441
[0 => [$api::KEY_TYPE => $api::MIME_TYPE_DIRECTORY]]
467442
);
468443

@@ -472,27 +447,23 @@ final public function testApiShouldGuessMimeTypeCorrectlyWhenGivenPathIsDirector
472447
}
473448

474449
/**
475-
* @uses Potherca\Flysystem\Github\Api::exists
450+
*
476451
*/
477452
final public function testApiShouldUseCredentialsWhenTheyHaveBeenGiven()
478453
{
479454
$api = $this->api;
480455

481-
$mockVendor = 'vendor';
482-
$mockPackage = 'package';
483-
$mockReference = 'reference';
484-
485456
$this->prepareMockSettings([
486-
'getVendor' => $mockVendor,
487-
'getPackage' => $mockPackage,
488-
'getReference' => $mockReference,
457+
'getVendor' => self::MOCK_VENDOR,
458+
'getPackage' => self::MOCK_PACKAGE,
459+
'getReference' => self::MOCK_REFERENCE,
489460
'getCredentials' => ['foo']
490461
]);
491462

492463
$this->prepareMockApi(
493464
'exists',
494465
$api::API_REPOSITORY,
495-
[$mockVendor, $mockPackage, trim(self::MOCK_FILE_PATH, '/'), $mockReference],
466+
[self::MOCK_VENDOR, self::MOCK_PACKAGE, trim(self::MOCK_FILE_PATH, '/'), self::MOCK_REFERENCE],
496467
''
497468
);
498469

@@ -716,21 +687,17 @@ private function prepareFixturesForTimeStamp()
716687
{
717688
date_default_timezone_set('UTC');
718689

719-
$mockVendor = 'vendor';
720-
$mockPackage = 'package';
721-
$mockBranch = 'branch';
722-
723690
$this->prepareMockSettings([
724-
'getVendor' => $mockVendor,
725-
'getPackage' => $mockPackage,
726-
'getBranch' => $mockBranch,
691+
'getVendor' => self::MOCK_VENDOR,
692+
'getPackage' => self::MOCK_PACKAGE,
693+
'getBranch' => self::MOCK_BRANCH,
727694
]);
728695

729696
$apiParameters = [
730-
$mockVendor,
731-
$mockPackage,
697+
self::MOCK_VENDOR,
698+
self::MOCK_PACKAGE,
732699
[
733-
'sha' => $mockBranch,
700+
'sha' => self::MOCK_BRANCH,
734701
'path' => trim(self::MOCK_FILE_PATH, '/')
735702
]
736703

0 commit comments

Comments
 (0)