Skip to content

Commit 8f68af0

Browse files
authored
Tests: declare error codes as constants in the BaseTestCase (#260)
This primarily makes the tests more stable by removing typo-prone, duplicate hard-coded information, but it also fixed a number of line length issues. Co-authored-by: jrfnl <[email protected]>
1 parent c0344b0 commit 8f68af0

File tree

5 files changed

+33
-26
lines changed

5 files changed

+33
-26
lines changed

Tests/BaseTestCase.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ class BaseTestCase extends TestCase
1010
{
1111
const STANDARD_NAME = 'VariableAnalysis';
1212

13+
const REDECLARATION_ERROR_CODE = 'VariableAnalysis.CodeAnalysis.VariableAnalysis.VariableRedeclaration';
14+
const SELF_OUTSIDE_CLASS_ERROR_CODE = 'VariableAnalysis.CodeAnalysis.VariableAnalysis.SelfOutsideClass';
15+
const STATIC_OUSIDE_CLASS_ERROR_CODE = 'VariableAnalysis.CodeAnalysis.VariableAnalysis.StaticOutsideClass';
16+
const UNDEFINED_ERROR_CODE = 'VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable';
17+
const UNSET_ERROR_CODE = 'VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedUnsetVariable';
18+
const UNUSED_ERROR_CODE = 'VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable';
19+
1320
public function prepareLocalFileForSniffs($fixtureFile)
1421
{
1522
$sniffFile = __DIR__ . '/../VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php';

Tests/VariableAnalysisSniff/ArrayAssignmentShortcutTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ public function testArrayAssignmentHasCorrectSniffCodes()
2828
$phpcsFile->process();
2929

3030
$warnings = $phpcsFile->getWarnings();
31-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[21][5][0]['source']);
32-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[27][5][0]['source']);
33-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[28][5][0]['source']);
34-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[29][10][0]['source']);
31+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[21][5][0]['source']);
32+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[27][5][0]['source']);
33+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[28][5][0]['source']);
34+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[29][10][0]['source']);
3535
}
3636
}

Tests/VariableAnalysisSniff/ClosingPhpTagsTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ public function testVariableWarningsHaveCorrectSniffCodesWhenClosingTagsAreUsed(
2626
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
2727
$phpcsFile->process();
2828
$warnings = $phpcsFile->getWarnings();
29-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[6][1][0]['source']);
30-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[8][6][0]['source']);
31-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[13][1][0]['source']);
32-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[16][6][0]['source']);
29+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[6][1][0]['source']);
30+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[8][6][0]['source']);
31+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[13][1][0]['source']);
32+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[16][6][0]['source']);
3333
}
3434
}

Tests/VariableAnalysisSniff/UnsetTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public function testUnsetHasCorrectSniffCodes()
2626
$phpcsFile->process();
2727

2828
$warnings = $phpcsFile->getWarnings();
29-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedUnsetVariable', $warnings[6][7][0]['source']);
30-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedUnsetVariable', $warnings[11][9][0]['source']);
29+
$this->assertSame(self::UNSET_ERROR_CODE, $warnings[6][7][0]['source']);
30+
$this->assertSame(self::UNSET_ERROR_CODE, $warnings[11][9][0]['source']);
3131
}
3232
}

Tests/VariableAnalysisSniff/VariableAnalysisTest.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -552,15 +552,15 @@ public function testCompactWarningsHaveCorrectSniffCodes()
552552
$phpcsFile->process();
553553

554554
$warnings = $phpcsFile->getWarnings();
555-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[2][49][0]['source']);
556-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[7][23][0]['source']);
557-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[10][54][0]['source']);
558-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[14][52][0]['source']);
559-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[19][5][0]['source']);
560-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[23][23][0]['source']);
561-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[26][66][0]['source']);
562-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[36][5][0]['source']);
563-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[36][23][0]['source']);
555+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[2][49][0]['source']);
556+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[7][23][0]['source']);
557+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[10][54][0]['source']);
558+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[14][52][0]['source']);
559+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[19][5][0]['source']);
560+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[23][23][0]['source']);
561+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[26][66][0]['source']);
562+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[36][5][0]['source']);
563+
$this->assertSame(self::UNDEFINED_ERROR_CODE, $warnings[36][23][0]['source']);
564564
}
565565

566566
public function testTraitAllowsThis()
@@ -696,13 +696,13 @@ public function testUnusedParamsHaveCorrectSniffCodes()
696696
$phpcsFile->process();
697697

698698
$warnings = $phpcsFile->getWarnings();
699-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[4][43][0]['source']);
700-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[16][52][0]['source']);
701-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[27][60][0]['source']);
702-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[39][42][0]['source']);
703-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[39][51][0]['source']);
704-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[72][5][0]['source']);
705-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[73][5][0]['source']);
699+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[4][43][0]['source']);
700+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[16][52][0]['source']);
701+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[27][60][0]['source']);
702+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[39][42][0]['source']);
703+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[39][51][0]['source']);
704+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[72][5][0]['source']);
705+
$this->assertSame(self::UNUSED_ERROR_CODE, $warnings[73][5][0]['source']);
706706
}
707707

708708
public function testValidUnusedVariableNamesIgnoresUnusedVariables()

0 commit comments

Comments
 (0)