*/ protected static $selectedSniff = ['PHPCSUtils.MessageHelper.AddMessageTest']; /** * Test the addMessage wrapper. * * @dataProvider dataAddMessage * @covers ::addMessage * * @param string $testMarker The comment which prefaces the target token in the test file. * @param bool $isError Whether to test adding an error or a warning. * @param array $expected Expected error details. * * @return void */ public function testAddMessage($testMarker, $isError, $expected) { $tokens = self::$phpcsFile->getTokens(); $stackPtr = $this->getTargetToken($testMarker, \T_CONSTANT_ENCAPSED_STRING); $severity = \mt_rand(5, 10); $expected['severity'] = $severity; $return = MessageHelper::addMessage( self::$phpcsFile, 'Message added. Text: %s', $stackPtr, $isError, self::CODE, [$tokens[$stackPtr]['content']], $severity ); $this->assertTrue($return); $this->verifyRecordedMessages($stackPtr, $isError, $expected); } /** * Data Provider. * * @see testAddMessage() For the array format. * * @return array>> */ public static function dataAddMessage() { return [ 'add-error' => [ 'testMarker' => '/* testAddErrorMessage */', 'isError' => true, 'expected' => [ 'message' => "Message added. Text: 'test 1'", 'source' => self::CODE, 'fixable' => false, ], ], 'add-warning' => [ 'testMarker' => '/* testAddWarningMessage */', 'isError' => false, 'expected' => [ 'message' => "Message added. Text: 'test 2'", 'source' => self::CODE, 'fixable' => false, ], ], ]; } /** * Test the addFixableMessage wrapper. * * @dataProvider dataAddFixableMessage * @covers ::addFixableMessage * * @param string $testMarker The comment which prefaces the target token in the test file. * @param bool $isError Whether to test adding an error or a warning. * @param array $expected Expected error details. * * @return void */ public function testAddFixableMessage($testMarker, $isError, $expected) { $tokens = self::$phpcsFile->getTokens(); $stackPtr = $this->getTargetToken($testMarker, \T_CONSTANT_ENCAPSED_STRING); $severity = \mt_rand(5, 10); $expected['severity'] = $severity; $return = MessageHelper::addFixableMessage( self::$phpcsFile, 'Message added. Text: %s', $stackPtr, $isError, self::CODE, [$tokens[$stackPtr]['content']], $severity ); // Fixable message recording only returns true when the fixer is enabled (=phpcbf). $this->assertFalse($return); $this->verifyRecordedMessages($stackPtr, $isError, $expected); } /** * Data Provider. * * @see testAddFixableMessage() For the array format. * * @return array>> */ public static function dataAddFixableMessage() { return [ 'add-fixable-error' => [ 'testMarker' => '/* testAddFixableErrorMessage */', 'isError' => true, 'expected' => [ 'message' => "Message added. Text: 'test 3'", 'source' => self::CODE, 'fixable' => true, ], ], 'add-fixable-warning' => [ 'testMarker' => '/* testAddFixableWarningMessage */', 'isError' => false, 'expected' => [ 'message' => "Message added. Text: 'test 4'", 'source' => self::CODE, 'fixable' => true, ], ], ]; } /** * Helper method to verify the expected message details. * * @param int $stackPtr The stack pointer on which the error/warning is expected. * @param bool $isError Whether to test adding an error or a warning. * @param array $expected Expected error details. * * @return void */ protected function verifyRecordedMessages($stackPtr, $isError, $expected) { $tokens = self::$phpcsFile->getTokens(); $errors = self::$phpcsFile->getErrors(); $warnings = self::$phpcsFile->getWarnings(); $result = ($isError === true) ? $errors : $warnings; /* * Make sure that no errors/warnings were recorded when the other type is set to be expected. */ if ($isError === true) { $this->assertArrayNotHasKey( $tokens[$stackPtr]['line'], $warnings, 'Expected no warnings on line ' . $tokens[$stackPtr]['line'] . '. At least one found.' ); } else { $this->assertArrayNotHasKey( $tokens[$stackPtr]['line'], $errors, 'Expected no errors on line ' . $tokens[$stackPtr]['line'] . '. At least one found.' ); } /* * Make sure the expected array keys for the errors/warnings are available. */ $this->assertArrayHasKey( $tokens[$stackPtr]['line'], $result, 'Expected a violation on line ' . $tokens[$stackPtr]['line'] . '. None found.' ); $this->assertArrayHasKey( $tokens[$stackPtr]['column'], $result[$tokens[$stackPtr]['line']], 'Expected a violation on line ' . $tokens[$stackPtr]['line'] . ', column ' . $tokens[$stackPtr]['column'] . '. None found.' ); $messages = $result[$tokens[$stackPtr]['line']][$tokens[$stackPtr]['column']]; // Expect one violation. $this->assertCount(1, $messages, 'Expected 1 violation, found: ' . \count($messages)); $violation = $messages[0]; /* * Test the violation details. */ foreach ($expected as $key => $value) { $this->assertSame($value, $violation[$key], \ucfirst($key) . ' comparison failed'); } } }