file_provider = new Provider\FakeFileProvider(); } /** * @return string[] * @psalm-return array */ public static function getAllIssues() { return array_filter( array_map( /** * @param string $file_name * * @return string */ function ($file_name) { return substr($file_name, 0, -4); }, scandir(dirname(__DIR__) . '/src/Psalm/Issue') ), /** * @param string $issue_name * * @return bool */ function ($issue_name) { return !empty($issue_name) && $issue_name !== 'MethodIssue' && $issue_name !== 'PropertyIssue' && $issue_name !== 'ClassIssue' && $issue_name !== 'CodeIssue' && $issue_name !== 'PsalmInternalError'; } ); } /** * @param Config $config * * @return \Psalm\Internal\Analyzer\ProjectAnalyzer */ private function getProjectAnalyzerWithConfig(Config $config) { $p = new \Psalm\Internal\Analyzer\ProjectAnalyzer( $config, new \Psalm\Internal\Provider\Providers( $this->file_provider, new Provider\FakeParserCacheProvider() ) ); $p->setPhpVersion('7.3'); return $p; } /** * @return void */ public function testBarebonesConfig() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( (string)getcwd(), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); } /** * @return void */ public function testIgnoreProjectDirectory() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); } /** * @return void */ public function testIgnoreMissingProjectDirectory() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertFalse($config->isInProjectDirs(realpath('does/not/exist/FileAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); } /** * @return void */ public function testIgnoreSymlinkedProjectDirectory() { @unlink(__DIR__ . '/symlinktest/ignored/b'); $no_symlinking_error = 'symlink(): Cannot create symlink, error code(1314)'; $last_error = error_get_last(); $check_symlink_error = ! is_array($last_error) || ! isset($last_error['message']) || $no_symlinking_error !== $last_error['message']; @symlink(__DIR__ . '/symlinktest/a', __DIR__ . '/symlinktest/ignored/b'); if ($check_symlink_error) { $last_error = error_get_last(); if (is_array($last_error) && isset($last_error['message']) && $no_symlinking_error === $last_error['message']) { $this->markTestSkipped($no_symlinking_error); return; } } $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('tests/AnnotationTest.php'))); $this->assertFalse($config->isInProjectDirs(realpath('tests/symlinktest/a/ignoreme.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); unlink(__DIR__ . '/symlinktest/ignored/b'); } /** * @return void */ public function testIgnoreWildcardProjectDirectory() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); } /** * @return void */ public function testIgnoreWildcardFiles() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'))); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); } /** * @return void */ public function testIgnoreWildcardFilesInWildcardFolder() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Visitor/ReflectorVisitor.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php'))); $this->assertTrue($config->isInProjectDirs(realpath('examples/plugins/StringChecker.php'))); } /** * @return void */ public function testIgnoreWildcardFilesInAllPossibleWildcardFolders() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php'))); $this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Visitor/ReflectorVisitor.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php'))); $this->assertFalse($config->isInProjectDirs(realpath('examples/StringAnalyzer.php'))); } /** * @return void */ public function testIssueHandler() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('tests/ConfigTest.php'))); $this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Type.php'))); } /** * @return void */ public function testIssueHandlerWithCustomErrorLevels() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); $config = $this->project_analyzer->getConfig(); $this->assertSame( 'info', $config->getReportingLevelForFile( 'MissingReturnType', realpath('src/Psalm/Type.php') ) ); $this->assertSame( 'error', $config->getReportingLevelForFile( 'MissingReturnType', realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php') ) ); $this->assertSame( 'suppress', $config->getReportingLevelForClass( 'UndefinedClass', 'Psalm\Badger' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForClass( 'UndefinedClass', 'Psalm\BadActor' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForClass( 'UndefinedClass', 'Psalm\GoodActor' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForClass( 'UndefinedClass', 'Psalm\MagicFactory' ) ); $this->assertSame( 'error', $config->getReportingLevelForClass( 'UndefinedClass', 'Psalm\Bodger' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForMethod( 'UndefinedMethod', 'Psalm\Bodger::find1' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForMethod( 'UndefinedMethod', 'Psalm\Bodger::find2' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForMethod( 'UndefinedMethod', 'Psalm\Badger::find2' ) ); $this->assertSame( 'error', $config->getReportingLevelForProperty( 'UndefinedMethod', 'Psalm\Bodger::$find3' ) ); $this->assertSame( 'error', $config->getReportingLevelForProperty( 'UndefinedMethod', 'Psalm\Bodger::$find4' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForMethod( 'UndefinedFunction', 'fooBar' ) ); $this->assertSame( 'suppress', $config->getReportingLevelForMethod( 'UndefinedFunction', 'foobar' ) ); } /** * @return void */ public function testAllPossibleIssues() { $all_possible_handlers = implode( ' ', array_map( /** * @param string $issue_name * * @return string */ function ($issue_name) { if ($issue_name === 'ParseError' || $issue_name === 'PluginIssue') { return ''; } return '<' . $issue_name . ' errorLevel="suppress" />' . "\n"; }, self::getAllIssues() ) ); $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' . $all_possible_handlers . ' ' ) ); } /** * @expectedException \Psalm\Exception\ConfigException * @expectedExceptionMessage This element is not expected * * @return void */ public function testImpossibleIssue() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( Config::loadFromXML( dirname(__DIR__), ' ' ) ); } /** * @expectedException \Psalm\Exception\CodeException * @expectedExceptionMessage MissingReturnType * * @return void */ public function testRequireVoidReturnTypeExists() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @return void */ public function testDoNotRequireVoidReturnTypeExists() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @return void */ public function testMethodCallMemoize() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'getFoo()) { if ($a->getFoo()->getBar()) { $a->getFoo()->getBar()->bat(); } }' ); $this->analyzeFile($file_path, new Context()); } /** * @return void */ public function testThing() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'foo($b = 5); echo $b;' ); $this->analyzeFile($file_path, new Context()); } /** * @return void */ public function testExitFunctions() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @return void */ public function testAllowedEchoFunction() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @expectedException \Psalm\Exception\CodeException * @expectedExceptionMessage ForbiddenCode * @return void */ public function testForbiddenEchoFunctionViaFunctions() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @expectedException \Psalm\Exception\CodeException * @expectedExceptionMessage ForbiddenEcho * @return void */ public function testForbiddenEchoFunctionViaFlag() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @return void */ public function testAllowedVarExportFunction() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @expectedException \Psalm\Exception\CodeException * @expectedExceptionMessage ForbiddenCode * @return void */ public function testForbiddenVarExportFunction() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @expectedException \Psalm\Exception\CodeException * @expectedExceptionMessage InvalidCatch * @return void */ public function testValidThrowInvalidCatch() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @expectedException \Psalm\Exception\CodeException * @expectedExceptionMessage InvalidThrow * @return void */ public function testInvalidThrowValidCatch() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @return void */ public function testValidThrowValidCatch() { $this->project_analyzer = $this->getProjectAnalyzerWithConfig( TestConfig::loadFromXML( dirname(__DIR__), ' ' ) ); $file_path = getcwd() . '/src/somefile.php'; $this->addFile( $file_path, 'analyzeFile($file_path, new Context()); } /** * @return void */ public function testTemplatedFiles() { foreach (['1.xml', '2.xml', '3.xml', '4.xml', '5.xml', '6.xml', '7.xml', '8.xml'] as $file_name) { Config::loadFromXMLFile( realpath(dirname(__DIR__) . '/assets/config_levels/' . $file_name), dirname(__DIR__) ); } } }